| /* |
| * 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 ip6 functions for the OpenThread library. |
| */ |
| |
| #ifndef OPENTHREAD_IP6_H_ |
| #define OPENTHREAD_IP6_H_ |
| |
| #include "openthread/message.h" |
| #include <platform/radio.h> |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /** |
| * @defgroup api API |
| * @brief |
| * This module includes the application programming interface to the OpenThread stack. |
| * |
| * @{ |
| * |
| * @defgroup execution Execution |
| * @defgroup commands Commands |
| * @defgroup config Configuration |
| * @defgroup diags Diagnostics |
| * @defgroup messages Message Buffers |
| * @defgroup ip6 IPv6 |
| * @defgroup udp UDP |
| * @defgroup coap CoAP |
| * |
| * @} |
| * |
| */ |
| |
| /** |
| * @addtogroup diags Diagnostics |
| * |
| * @brief |
| * This module includes functions that expose internal state. |
| * |
| * @{ |
| * |
| */ |
| |
| /** |
| * This function pointer is called when an IEEE 802.15.4 frame is received. |
| * |
| * @note This callback is called after FCS processing and @p aFrame may not contain the actual FCS that was received. |
| * |
| * @note This callback is called before IEEE 802.15.4 security processing and mSecurityValid in @p aFrame will |
| * always be false. |
| * |
| * @param[in] aFrame A pointer to the received IEEE 802.15.4 frame. |
| * @param[in] aContext A pointer to application-specific context. |
| * |
| */ |
| typedef void (*otLinkPcapCallback)(const RadioPacket *aFrame, void *aContext); |
| |
| /** |
| * This function registers a callback to provide received raw IEEE 802.15.4 frames. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[in] aPcapCallback A pointer to a function that is called when receiving an IEEE 802.15.4 link frame or |
| * NULL to disable the callback. |
| * @param[in] aCallbackContext A pointer to application-specific context. |
| * |
| */ |
| void otSetLinkPcapCallback(otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext); |
| |
| /** |
| * This function indicates whether or not promiscuous mode is enabled at the link layer. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * |
| * @retval true Promiscuous mode is enabled. |
| * @retval false Promiscuous mode is not enabled. |
| * |
| */ |
| bool otIsLinkPromiscuous(otInstance *aInstance); |
| |
| /** |
| * This function enables or disables the link layer promiscuous mode. |
| * |
| * @note Promiscuous mode may only be enabled when the Thread interface is disabled. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[in] aPromiscuous true to enable promiscuous mode, or false otherwise. |
| * |
| * @retval kThreadError_None Successfully enabled promiscuous mode. |
| * @retval kThreadError_InvalidState Could not enable promiscuous mode because |
| * the Thread interface is enabled. |
| * |
| */ |
| ThreadError otSetLinkPromiscuous(otInstance *aInstance, bool aPromiscuous); |
| |
| /** |
| * @} |
| * |
| */ |
| |
| /** |
| * @addtogroup ip6 IPv6 |
| * |
| * @brief |
| * This module includes functions that control IPv6 communication. |
| * |
| * @{ |
| * |
| */ |
| |
| /** |
| * Get the list of IPv6 multicast addresses subscribed to the Thread interface. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * |
| * @returns A pointer to the first Network Interface Multicast Address. |
| */ |
| const otNetifMulticastAddress *otGetMulticastAddresses(otInstance *aInstance); |
| |
| /** |
| * Subscribe the Thread interface to a Network Interface Multicast Address. |
| * |
| * The passed in instance @p aAddress will be copied by the Thread interface. The Thread interface only |
| * supports a fixed number of externally added multicast addresses. See OPENTHREAD_CONFIG_MAX_EXT_MULTICAST_IP_ADDRS. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[in] aAddress A pointer to an IP Address. |
| * |
| * @retval kThreadErrorNone Successfully subscribed to the Network Interface Multicast Address. |
| * @retval kThreadError_InvalidArgs The IP Address indicated by @p aAddress is invalid address. |
| * @retval kThreadError_NoBufs The Network Interface is already storing the maximum allowed external multicast addresses. |
| */ |
| ThreadError otSubscribeMulticastAddress(otInstance *aInstance, const otIp6Address *aAddress); |
| |
| /** |
| * Unsubscribe the Thread interface to a Network Interface Multicast Address. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[in] aAddress A pointer to an IP Address. |
| * |
| * @retval kThreadErrorNone Successfully unsubscribed to the Network Interface Multicast Address. |
| * @retval kThreadError_InvalidArgs The IP Address indicated by @p aAddress is an internal address. |
| * @retval kThreadError_NotFound The IP Address indicated by @p aAddress was not found. |
| */ |
| ThreadError otUnsubscribeMulticastAddress(otInstance *aInstance, const otIp6Address *aAddress); |
| |
| /** |
| * Check if multicast promiscuous mode is enabled on the Thread interface. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * |
| * @sa otEnableMulticastPromiscuousMode |
| * @sa otDisableMulticastPromiscuousMode |
| */ |
| bool otIsMulticastPromiscuousModeEnabled(otInstance *aInstance); |
| |
| /** |
| * Enable multicast promiscuous mode on the Thread interface. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * |
| * @sa otIsMulticastPromiscuousModeEnabled |
| * @sa otDisableMulticastPromiscuousMode |
| */ |
| void otEnableMulticastPromiscuousMode(otInstance *aInstance); |
| |
| /** |
| * Disable multicast promiscuous mode on the Thread interface. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * |
| * @sa otIsMulticastPromiscuousModeEnabled |
| * @sa otEnableMulticastPromiscuousMode |
| */ |
| void otDisableMulticastPromiscuousMode(otInstance *aInstance); |
| |
| /** |
| * This function pointer is called to create IPv6 IID during SLAAC procedure. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[inout] aAddress A pointer to structure containing IPv6 address for which IID is being created. |
| * @param[inout] aContext A pointer to creator-specific context. |
| * |
| * @retval kThreadError_None Created valid IID for given IPv6 address. |
| * @retval kThreadError_Ipv6AddressCreationFailure Creation of valid IID for given IPv6 address failed. |
| * |
| */ |
| typedef ThreadError(*otSlaacIidCreate)(otInstance *aInstance, otNetifAddress *aAddress, void *aContext); |
| |
| /** |
| * Update all automatically created IPv6 addresses for prefixes from current Network Data with SLAAC procedure. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[inout] aAddresses A pointer to an array of automatically created IPv6 addresses. |
| * @param[in] aNumAddresses The number of slots in aAddresses array. |
| * @param[in] aIidCreate A pointer to a function that is called to create IPv6 IIDs. |
| * @param[in] aContext A pointer to data passed to aIidCreate function. |
| * |
| */ |
| void otSlaacUpdate(otInstance *aInstance, otNetifAddress *aAddresses, uint32_t aNumAddresses, |
| otSlaacIidCreate aIidCreate, void *aContext); |
| |
| /** |
| * Create random IID for given IPv6 address. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[inout] aAddress A pointer to structure containing IPv6 address for which IID is being created. |
| * @param[in] aContext A pointer to unused data. |
| * |
| * @retval kThreadError_None Created valid IID for given IPv6 address. |
| * |
| */ |
| ThreadError otCreateRandomIid(otInstance *aInstance, otNetifAddress *aAddresses, void *aContext); |
| |
| /** |
| * Create IID for given IPv6 address using extended MAC address. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[inout] aAddress A pointer to structure containing IPv6 address for which IID is being created. |
| * @param[in] aContext A pointer to unused data. |
| * |
| * @retval kThreadError_None Created valid IID for given IPv6 address. |
| * |
| */ |
| ThreadError otCreateMacIid(otInstance *aInstance, otNetifAddress *aAddresses, void *aContext); |
| |
| /** |
| * Create semantically opaque IID for given IPv6 address. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[inout] aAddress A pointer to structure containing IPv6 address for which IID is being created. |
| * @param[inout] aContext A pointer to a otSemanticallyOpaqueIidGeneratorData structure. |
| * |
| * @retval kThreadError_None Created valid IID for given IPv6 address. |
| * @retval kThreadError_Ipv6AddressCreationFailure Could not create valid IID for given IPv6 address. |
| * |
| */ |
| ThreadError otCreateSemanticallyOpaqueIid(otInstance *aInstance, otNetifAddress *aAddresses, void *aContext); |
| |
| /** |
| * Allocate a new message buffer for sending an IPv6 message. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[in] aLinkSecurityEnabled TRUE if the message should be secured at Layer 2 |
| * |
| * @returns A pointer to the message buffer or NULL if no message buffers are available. |
| * |
| * @sa otFreeMessage |
| */ |
| otMessage otNewIp6Message(otInstance *aInstance, bool aLinkSecurityEnabled); |
| |
| /** |
| * This function pointer is called when an IPv6 datagram is received. |
| * |
| * @param[in] aMessage A pointer to the message buffer containing the received IPv6 datagram. |
| * @param[in] aContext A pointer to application-specific context. |
| * |
| */ |
| typedef void (*otReceiveIp6DatagramCallback)(otMessage aMessage, void *aContext); |
| |
| /** |
| * This function registers a callback to provide received IPv6 datagrams. |
| * |
| * By default, this callback does not pass Thread control traffic. See otSetReceiveIp6DatagramFilterEnabled() to |
| * change the Thread control traffic filter setting. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[in] aCallback A pointer to a function that is called when an IPv6 datagram is received or |
| * NULL to disable the callback. |
| * @param[in] aCallbackContext A pointer to application-specific context. |
| * |
| * @sa otIsReceiveIp6DatagramFilterEnabled |
| * @sa otSetReceiveIp6DatagramFilterEnabled |
| * |
| */ |
| void otSetReceiveIp6DatagramCallback(otInstance *aInstance, otReceiveIp6DatagramCallback aCallback, |
| void *aCallbackContext); |
| |
| /** |
| * This function indicates whether or not Thread control traffic is filtered out when delivering IPv6 datagrams |
| * via the callback specified in otSetReceiveIp6DatagramCallback(). |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * |
| * @returns TRUE if Thread control traffic is filtered out, FALSE otherwise. |
| * |
| * @sa otSetReceiveIp6DatagramCallback |
| * @sa otSetReceiveIp6DatagramFilterEnabled |
| * |
| */ |
| bool otIsReceiveIp6DatagramFilterEnabled(otInstance *aInstance); |
| |
| /** |
| * This function sets whether or not Thread control traffic is filtered out when delivering IPv6 datagrams |
| * via the callback specified in otSetReceiveIp6DatagramCallback(). |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[in] aEnabled TRUE if Thread control traffic is filtered out, FALSE otherwise. |
| * |
| * @sa otSetReceiveIp6DatagramCallback |
| * @sa otIsReceiveIp6DatagramFilterEnabled |
| * |
| */ |
| void otSetReceiveIp6DatagramFilterEnabled(otInstance *aInstance, bool aEnabled); |
| |
| /** |
| * This function sends an IPv6 datagram via the Thread interface. |
| * |
| * @param[in] aInstance A pointer to an OpenThread instance. |
| * @param[in] aMessage A pointer to the message buffer containing the IPv6 datagram. |
| * |
| */ |
| ThreadError otSendIp6Datagram(otInstance *aInstance, otMessage aMessage); |
| |
| /** |
| * @} |
| * |
| */ |
| |
| #ifdef __cplusplus |
| } // extern "C" |
| #endif |
| |
| #endif // OPENTHREAD_IP6_H_ |
