239 lines
10 KiB
C
239 lines
10 KiB
C
/**
|
|
* Copyright (c) 2015 - 2019, Nordic Semiconductor ASA
|
|
*
|
|
* 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, except as embedded into a Nordic
|
|
* Semiconductor ASA integrated circuit in a product or a software update for
|
|
* such product, 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 Nordic Semiconductor ASA nor the names of its
|
|
* contributors may be used to endorse or promote products derived from this
|
|
* software without specific prior written permission.
|
|
*
|
|
* 4. This software, with or without modification, must only be used with a
|
|
* Nordic Semiconductor ASA integrated circuit.
|
|
*
|
|
* 5. Any software provided in binary form under this license must not be reverse
|
|
* engineered, decompiled, modified and/or disassembled.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
|
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA 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
|
|
*
|
|
* @defgroup ipv6_medium IPv6 Medium
|
|
* @{
|
|
* @ingroup iot_sdk_common
|
|
* @brief IPv6 Medium Interface.
|
|
*
|
|
* @details Implementation-agnostic interface of the physical transport that
|
|
* facilitates IPv6 traffic.
|
|
*/
|
|
|
|
#ifndef IPV6_MEDIUM_H__
|
|
#define IPV6_MEDIUM_H__
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "ipv6_medium_platform.h"
|
|
#include "iot_defines.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define EUI_48_SIZE 6 /**< Size of a 48-bit Extended Unique Identifier in bytes. */
|
|
|
|
#define IPV6_MEDIUM_ID_ANY 0x00 /**< Indicates invalid physical transport type. */
|
|
#define IPV6_MEDIUM_ID_BLE 0x01 /**< Indicates that the physical transport is BLE. */
|
|
#define IPV6_MEDIUM_ID_802154 0x02 /**< Indicates that the physical transport is 802.15.4. */
|
|
|
|
#define IPV6_MEDIUM_EVT_CONN_DOWN 0x01 /**< Indicates that a connection is established. */
|
|
#define IPV6_MEDIUM_EVT_CONN_UP 0x02 /**< Indicates that a connection is torn down. */
|
|
#define IPV6_MEDIUM_EVT_CONNECTABLE_MODE_ENTER 0x01 /**< Indicates that the medium entered connectable mode. */
|
|
#define IPV6_MEDIUM_EVT_CONNECTABLE_MODE_EXIT 0x02 /**< Indicates that the medium exited connectable mode. */
|
|
#define IPV6_MEDIUM_EVT_MAC_ADDRESS_CHANGED 0x03 /**< Indicates that the device has a new MAC address. */
|
|
#define IPV6_MEDIUM_EVT_PHY_SPECIFIC 0xFF /**< Indicates miscellaneous event from the physical layer. */
|
|
|
|
/**@brief IPv6 medium instance identifier type. */
|
|
typedef uint32_t ipv6_medium_instance_id_t;
|
|
|
|
/**@brief Type of IPv6 medium type. */
|
|
typedef uint8_t ipv6_medium_type_t;
|
|
|
|
/**@brief IPv6 medium instance type. */
|
|
typedef struct
|
|
{
|
|
ipv6_medium_instance_id_t ipv6_medium_instance_id;
|
|
ipv6_medium_type_t ipv6_medium_instance_type;
|
|
} ipv6_medium_instance_t;
|
|
|
|
/**@brief EUI-48 value type. */
|
|
typedef struct
|
|
{
|
|
uint8_t identifier[EUI_48_SIZE]; /**< 48-bit identifier. */
|
|
} eui48_t;
|
|
|
|
/**@brief Type of IPv6 medium event parameters. */
|
|
typedef struct
|
|
{
|
|
ipv6_medium_instance_t ipv6_medium_instance_id;
|
|
uint8_t ipv6_medium_evt_id;
|
|
ipv6_medium_cb_params_union_t medium_specific;
|
|
} ipv6_medium_evt_t;
|
|
|
|
/**@brief Type of IPv6 medium error parameters. */
|
|
typedef struct
|
|
{
|
|
ipv6_medium_instance_t ipv6_medium_instance_id;
|
|
uint32_t error_label;
|
|
ipv6_medium_err_params_union_t medium_specific;
|
|
} ipv6_medium_error_t;
|
|
|
|
/**@brief IPv6 medium event handler type. */
|
|
typedef void (*ipv6_medium_evt_handler_t)(ipv6_medium_evt_t * p_ipv6_medium_evt);
|
|
|
|
/**@brief IPv6 medium error handler type. */
|
|
typedef void (*ipv6_medium_error_handler_t)(ipv6_medium_error_t * p_ipv6_medium_error);
|
|
|
|
#ifdef COMMISSIONING_ENABLED
|
|
/**@brief Commissioning mode control commands. */
|
|
typedef enum
|
|
{
|
|
CMD_IDENTITY_MODE_EXIT = 0x00,
|
|
CMD_IDENTITY_MODE_ENTER = 0x01
|
|
} mode_control_cmd_t;
|
|
|
|
/**@brief Commissioning: Identity mode control callback function type. */
|
|
typedef void (*commissioning_id_mode_cb_t)(mode_control_cmd_t control_command);
|
|
|
|
/**@brief Commissioning: Power off on failure control callback function type. */
|
|
typedef void (*commissioning_poweroff_cb_t)(bool do_poweroff_on_failure);
|
|
#endif // COMMISSIONING_ENABLED
|
|
|
|
/**@brief Structure for initialization parameters of the IPv6 medium. */
|
|
typedef struct
|
|
{
|
|
ipv6_medium_evt_handler_t ipv6_medium_evt_handler;
|
|
ipv6_medium_error_handler_t ipv6_medium_error_handler;
|
|
#ifdef COMMISSIONING_ENABLED
|
|
commissioning_id_mode_cb_t commissioning_id_mode_cb;
|
|
commissioning_poweroff_cb_t commissioning_power_off_cb;
|
|
#endif // COMMISSIONING_ENABLED
|
|
} ipv6_medium_init_params_t;
|
|
|
|
/**@brief Function for initializing the IPv6 medium.
|
|
*
|
|
* @details Initializes the IPv6 medium module.
|
|
* Performs all setup necessary that is specific to the implementation.
|
|
*
|
|
* @param[in] p_init_param Pointer to the initialization parameters.
|
|
* @param[in] desired_medium_type Value of the desired medium type.
|
|
* @param[out] p_new_medium_instance Pointer to the new medium instance initialized.
|
|
*
|
|
* @retval NRF_SUCCESS If initialization was successful. Otherwise, a propagated
|
|
* error code is returned.
|
|
*
|
|
*/
|
|
uint32_t ipv6_medium_init(ipv6_medium_init_params_t * p_init_param,
|
|
ipv6_medium_type_t desired_medium_type,
|
|
ipv6_medium_instance_t * p_new_medium_instance);
|
|
|
|
/**@brief Function for entering connectible mode.
|
|
*
|
|
* @details Requests the IPv6 medium to enter connectible mode.
|
|
*
|
|
* @param[in] ipv6_medium_instance_id Specifies the IPv6 medium instance.
|
|
*
|
|
* @retval NRF_SUCCESS If the procedure was successful. Otherwise, a propagated
|
|
* error code is returned.
|
|
*
|
|
*/
|
|
uint32_t ipv6_medium_connectable_mode_enter(ipv6_medium_instance_id_t ipv6_medium_instance_id);
|
|
|
|
/**@brief Function for exiting connectible mode.
|
|
*
|
|
* @details Requests the IPv6 medium to exit connectible mode.
|
|
*
|
|
* @param[in] ipv6_medium_instance_id Specifies the IPv6 medium instance.
|
|
*
|
|
* @retval NRF_SUCCESS If the procedure was successful. Otherwise, a propagated
|
|
* error code is returned.
|
|
*
|
|
*/
|
|
uint32_t ipv6_medium_connectable_mode_exit(ipv6_medium_instance_id_t ipv6_medium_instance_id);
|
|
|
|
/**@brief Function for getting the 48-bit Extended Unique Identifier.
|
|
*
|
|
* @param[in] ipv6_medium_instance_id Specifies the IPv6 medium instance.
|
|
* @param[out] p_ipv6_medium_eui48 Pointer to the EUI-48 value.
|
|
*
|
|
* @retval NRF_SUCCESS If the procedure was successful. Otherwise, a propagated
|
|
* error code is returned.
|
|
*
|
|
*/
|
|
uint32_t ipv6_medium_eui48_get(ipv6_medium_instance_id_t ipv6_medium_instance_id,
|
|
eui48_t * p_ipv6_medium_eui48);
|
|
|
|
/**@brief Function for setting the 48-bit Extended Unique Identifier.
|
|
*
|
|
* @param[in] ipv6_medium_instance_id Specifies the IPv6 medium instance.
|
|
* @param[in] p_ipv6_medium_eui48 Pointer to the EUI-48 value.
|
|
*
|
|
* @retval NRF_SUCCESS If the procedure was successful. Otherwise, a propagated
|
|
* error code is returned.
|
|
*
|
|
*/
|
|
uint32_t ipv6_medium_eui48_set(ipv6_medium_instance_id_t ipv6_medium_instance_id,
|
|
eui48_t * p_ipv6_medium_eui48);
|
|
|
|
/**@brief Function for getting the 64-bit Extended Unique Identifier.
|
|
*
|
|
* @param[in] ipv6_medium_instance_id Specifies the IPv6 medium instance.
|
|
* @param[out] p_ipv6_medium_eui64 Pointer to the EUI-64 value.
|
|
*
|
|
* @retval NRF_SUCCESS If the procedure was successful. Otherwise, a propagated
|
|
* error code is returned.
|
|
*
|
|
*/
|
|
uint32_t ipv6_medium_eui64_get(ipv6_medium_instance_id_t ipv6_medium_instance_id,
|
|
eui64_t * p_ipv6_medium_eui64);
|
|
|
|
/**@brief Function for setting the 64-bit Extended Unique Identifier.
|
|
*
|
|
* @param[in] ipv6_medium_instance_id Specifies the IPv6 medium instance.
|
|
* @param[in] p_ipv6_medium_eui64 Pointer to the EUI-64 value.
|
|
*
|
|
* @retval NRF_SUCCESS If the procedure was successful. Otherwise, a propagated
|
|
* error code is returned.
|
|
*
|
|
*/
|
|
uint32_t ipv6_medium_eui64_set(ipv6_medium_instance_id_t ipv6_medium_instance_id,
|
|
eui64_t * p_ipv6_medium_eui64);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // IPV6_MEDIUM_H__
|
|
|
|
/** @} */
|