0.01.00
ncp.h File Reference

This file defines the top-level functions for the OpenThread NCP module. More...

#include <openthread/types.h>
#include <stdarg.h>

Go to the source code of this file.

Classes

struct  otNcpLegacyHandlers
 Defines a struct containing all the legacy handlers (function pointers). More...
 

Macros

#define OT_NCP_LEGACY_ULA_PREFIX_LENGTH   8
 Legacy ULA size (in bytes)
 

Typedefs

typedef bool(* otNcpDelegateAllowPeekPoke) (uint32_t aAddress, uint16_t aCount)
 Defines delegate (function pointer) type to control behavior of peek/poke operation. More...
 
typedef void(* otNcpHandlerStartLegacy) (void)
 Defines handler (function pointer) type for starting legacy network. More...
 
typedef void(* otNcpHandlerStopLegacy) (void)
 Defines handler (function pointer) type for stopping legacy network. More...
 
typedef void(* otNcpHandlerJoinLegacyNode) (const otExtAddress *aExtAddress)
 Defines handler (function pointer) type for initiating joining process. More...
 
typedef void(* otNcpHandlerSetLegacyUlaPrefix) (const uint8_t *aUlaPrefix)
 Defines handler (function pointer) type for setting the legacy ULA prefix. More...
 
typedef struct otNcpLegacyHandlers otNcpLegacyHandlers
 Defines a struct containing all the legacy handlers (function pointers).
 

Functions

void otNcpInit (otInstance *aInstance)
 Initialize the NCP. More...
 
otError otNcpStreamWrite (int aStreamId, const uint8_t *aDataPtr, int aDataLen)
 Send data to the host via a specific stream. More...
 
otError otNcpRegisterPeekPokeDelagates (otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)
 This method registers peek/poke delegate functions with NCP module. More...
 
void otNcpHandleLegacyNodeDidJoin (const otExtAddress *aExtAddr)
 This callback is invoked by the legacy stack to notify that a new legacy node did join the network. More...
 
void otNcpHandleDidReceiveNewLegacyUlaPrefix (const uint8_t *aUlaPrefix)
 This callback is invoked by the legacy stack to notify that the legacy ULA prefix has changed. More...
 
void otNcpRegisterLegacyHandlers (const otNcpLegacyHandlers *aHandlers)
 This method registers a set of legacy handlers with NCP. More...
 
void otNcpPlatLogv (otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list ap)
 Callback to write the OpenThread Log to the NCP Spinel Tunnel. More...
 

Detailed Description

This file defines the top-level functions for the OpenThread NCP module.