include/openthread/ncp.h

/*
 *  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.
 */

/**
 * @file
 * @brief
 *  This file defines the top-level functions for the OpenThread NCP module.
 */

#ifndef NCP_H_
#define NCP_H_

#include <openthread/types.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @addtogroup api-ncp
 *
 * @brief
 *   This module includes functions that control the Thread stack's execution.
 *
 * @{
 *
 */

/**
 * Initialize the NCP.
 *
 * @param[in]  aInstance  The OpenThread instance structure.
 *
 */
void otNcpInit(otInstance *aInstance);

/**
 * @brief Send data to the host via a specific stream.
 *
 * This function attempts to send the given data to the host
 * using the given aStreamId. This is useful for reporting
 * error messages, implementing debug/diagnostic consoles,
 * and potentially other types of datastreams.
 *
 * The write either is accepted in its entirety or rejected.
 * Partial writes are not attempted.
 *
 * @param[in]  aStreamId  A numeric identifier for the stream to write to.
 *                        If set to '0', will default to the debug stream.
 * @param[in]  aDataPtr   A pointer to the data to send on the stream.
 *                        If aDataLen is non-zero, this param MUST NOT be NULL.
 * @param[in]  aDataLen   The number of bytes of data from aDataPtr to send.
 *
 * @retval OT_ERROR_NONE         The data was queued for delivery to the host.
 * @retval OT_ERROR_BUSY         There are not enough resources to complete this
 *                               request. This is usually a temporary condition.
 * @retval OT_ERROR_INVALID_ARGS The given aStreamId was invalid.
*/
otError otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen);

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

/**
 * Defines delegate (function pointer) type to control behavior of peek/poke operation.
 *
 * This delegate function is called to decide whether to allow peek or poke of a specific memory region. It is used
 * if NCP support for peek/poke commands is enabled.
 *
 * @param[in] aAddress    Start address of memory region.
 * @param[in] aCount      Number of bytes to peek or poke.
 *
 * @returns  TRUE to allow peek/poke of the given memory region, FALSE otherwise.
 *
 */
typedef bool (*otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount);

/**
 * This method registers peek/poke delegate functions with NCP module.
 *
 * The delegate functions are called by NCP module to decide whether to allow peek or poke of a specific memory region.
 * If the delegate pointer is set to NULL, it allows peek/poke operation for any address.
 *
 * @param[in] aAllowPeekDelegate      Delegate function pointer for peek operation.
 * @param[in] aAllowPokeDelegate      Delegate function pointer for poke operation.
 *
 * @retval OT_ERROR_NONE              Successfully registered delegate functions.
 * @retval OT_ERROR_DISABLED_FEATURE  Peek/Poke feature is disabled (by a build-time configuration option).
 *
 */
otError otNcpRegisterPeekPokeDelagates(otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
                                       otNcpDelegateAllowPeekPoke aAllowPokeDelegate);

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

#define OT_NCP_LEGACY_ULA_PREFIX_LENGTH    8   ///< Legacy ULA size (in bytes)

/**
 * Defines handler (function pointer) type for starting legacy network
 *
 * Invoked to start the legacy network.
 *
 */
typedef void (*otNcpHandlerStartLegacy)(void);

/**
 * Defines handler (function pointer) type for stopping legacy network
 *
 * Invoked to stop the legacy network.
 *
 */
typedef void (*otNcpHandlerStopLegacy)(void);

/**
 * Defines handler (function pointer) type for initiating joining process.
 *
 * @param[in] aExtAddress   A pointer to the extended address for the node to join
 *                          or NULL if desired to join any neighboring node.
 *
 * Invoked to initiate a legacy join procedure to any or a specific node.
 *
 */
typedef void (*otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress);

/**
 * Defines handler (function pointer) type for setting the legacy ULA prefix.
 *
 * @param[in] aUlaPrefix   A pointer to buffer containing the legacy ULA prefix.
 *
 * Invoked to set the legacy ULA prefix.
 *
 */
typedef void (*otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix);

/**
 * Defines a struct containing all the legacy handlers (function pointers).
 *
 */
typedef struct otNcpLegacyHandlers
{
    otNcpHandlerStartLegacy         mStartLegacy;         ///< Start handler
    otNcpHandlerStopLegacy          mStopLegacy;          ///< Stop handler
    otNcpHandlerJoinLegacyNode      mJoinLegacyNode;      ///< Join handler
    otNcpHandlerSetLegacyUlaPrefix  mSetLegacyUlaPrefix;  ///< Set ULA handler
} otNcpLegacyHandlers;

/**
 * This callback is invoked by the legacy stack to notify that a new
 * legacy node did join the network.
 */
void otNcpHandleLegacyNodeDidJoin(const otExtAddress *aExtAddr);

/**
 * This callback is invoked by the legacy stack to notify that the
 * legacy ULA prefix has changed.
 */
void otNcpHandleDidReceiveNewLegacyUlaPrefix(const uint8_t *aUlaPrefix);

/**
 * This method registers a set of legacy handlers with NCP.
 *
 * The set of handlers provided by the struct @p aHandlers are used by
 * NCP code to start/stop legacy network.
 * The @p aHandlers can be NULL to disable legacy support on NCP.
 * Individual handlers in the given handlers struct can also be NULL.
 *
 * @param[in] aHandlers    A pointer to a handler struct.
 *
 */
void otNcpRegisterLegacyHandlers(const otNcpLegacyHandlers *aHandlers);

/**
 * @}
 *
 */

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

#endif