ncp.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2016, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef NCP_H_
#define NCP_H_

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

#ifdef __cplusplus
extern "C" {
#endif

void otNcpInit(otInstance *aInstance);

otError otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen);

//-----------------------------------------------------------------------------------------
// Peek/Poke memory access control delegates

typedef bool (*otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount);

otError otNcpRegisterPeekPokeDelagates(otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
                                       otNcpDelegateAllowPeekPoke aAllowPokeDelegate);

//-----------------------------------------------------------------------------------------
// Legacy network APIs

#define OT_NCP_LEGACY_ULA_PREFIX_LENGTH    8   


typedef void (*otNcpHandlerStartLegacy)(void);

typedef void (*otNcpHandlerStopLegacy)(void);

typedef void (*otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress);

typedef void (*otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix);

typedef struct otNcpLegacyHandlers
{
    otNcpHandlerStartLegacy         mStartLegacy;         
    otNcpHandlerStopLegacy          mStopLegacy;          
    otNcpHandlerJoinLegacyNode      mJoinLegacyNode;      
    otNcpHandlerSetLegacyUlaPrefix  mSetLegacyUlaPrefix;  
} otNcpLegacyHandlers;

void otNcpHandleLegacyNodeDidJoin(const otExtAddress *aExtAddr);

void otNcpHandleDidReceiveNewLegacyUlaPrefix(const uint8_t *aUlaPrefix);

void otNcpRegisterLegacyHandlers(const otNcpLegacyHandlers *aHandlers);

void otNcpPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list ap);

#ifdef __cplusplus
}  // extern "C"
#endif

#endif