137 lines
6.7 KiB
C
137 lines
6.7 KiB
C
/*
|
|
* Copyright (c) 2020 - 2021, Nordic Semiconductor ASA
|
|
* All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*
|
|
* 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 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.
|
|
*
|
|
* 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 NRF_802154_TYPES_H__
|
|
#define NRF_802154_TYPES_H__
|
|
|
|
#include <stdint.h>
|
|
|
|
/**
|
|
* @defgroup nrf_802154_types Type definitions used in the 802.15.4 driver
|
|
* @{
|
|
* @ingroup nrf_802154
|
|
* @brief Definitions of types used in the 802.15.4 driver.
|
|
*/
|
|
|
|
/**
|
|
* @brief Errors reported during the frame transmission.
|
|
*/
|
|
typedef uint8_t nrf_802154_tx_error_t;
|
|
|
|
#define NRF_802154_TX_ERROR_NONE 0x00 // !< There is no transmit error.
|
|
#define NRF_802154_TX_ERROR_BUSY_CHANNEL 0x01 // !< CCA reported busy channel before the transmission.
|
|
#define NRF_802154_TX_ERROR_INVALID_ACK 0x02 // !< Received ACK frame is other than expected.
|
|
#define NRF_802154_TX_ERROR_NO_MEM 0x03 // !< No receive buffer is available to receive an ACK.
|
|
#define NRF_802154_TX_ERROR_TIMESLOT_ENDED 0x04 // !< Radio timeslot ended during the transmission procedure.
|
|
#define NRF_802154_TX_ERROR_NO_ACK 0x05 // !< ACK frame was not received during the timeout period.
|
|
#define NRF_802154_TX_ERROR_ABORTED 0x06 // !< Procedure was aborted by another operation.
|
|
#define NRF_802154_TX_ERROR_TIMESLOT_DENIED 0x07 // !< Transmission did not start due to a denied timeslot request.
|
|
#define NRF_802154_TX_ERROR_TIMEOUT 0x08 // !< Timeout specified for a transmission has been reached.
|
|
|
|
/**
|
|
* @brief Possible errors during the frame reception.
|
|
*/
|
|
typedef uint8_t nrf_802154_rx_error_t;
|
|
|
|
#define NRF_802154_RX_ERROR_NONE 0x00 // !< There is no receive error.
|
|
#define NRF_802154_RX_ERROR_INVALID_FRAME 0x01 // !< Received a malformed frame.
|
|
#define NRF_802154_RX_ERROR_INVALID_FCS 0x02 // !< Received a frame with an invalid checksum.
|
|
#define NRF_802154_RX_ERROR_INVALID_DEST_ADDR 0x03 // !< Received a frame with a mismatched destination address.
|
|
#define NRF_802154_RX_ERROR_RUNTIME 0x04 // !< Runtime error occurred (for example, CPU was held for too long).
|
|
#define NRF_802154_RX_ERROR_TIMESLOT_ENDED 0x05 // !< Radio timeslot ended during the frame reception.
|
|
#define NRF_802154_RX_ERROR_ABORTED 0x06 // !< Procedure was aborted by another operation.
|
|
#define NRF_802154_RX_ERROR_DELAYED_TIMESLOT_DENIED 0x07 // !< Delayed reception request was rejected due to a denied timeslot request.
|
|
#define NRF_802154_RX_ERROR_DELAYED_TIMEOUT 0x08 // !< Delayed reception timeslot ended.
|
|
#define NRF_802154_RX_ERROR_INVALID_LENGTH 0x09 // !< Received a frame with invalid length.
|
|
#define NRF_802154_RX_ERROR_DELAYED_ABORTED 0x0A // !< Delayed operation in the ongoing state was aborted by other request.
|
|
|
|
/**
|
|
*/
|
|
typedef uint8_t nrf_802154_ed_error_t;
|
|
|
|
#define NRF_802154_ED_ERROR_ABORTED 0x01 // !< Procedure was aborted by another operation.
|
|
|
|
/**
|
|
* @brief Possible errors during the CCA procedure.
|
|
*/
|
|
typedef uint8_t nrf_802154_cca_error_t;
|
|
|
|
#define NRF_802154_CCA_ERROR_ABORTED 0x01 // !< Procedure was aborted by another operation.
|
|
|
|
/**
|
|
* @brief Methods of source address matching.
|
|
*
|
|
* You can use one of the following methods that can be set during the initialization phase
|
|
* by calling @ref nrf_802154_src_matching_method:
|
|
* - For Thread: @ref NRF_802154_SRC_ADDR_MATCH_THREAD -- The pending bit is set only for the addresses found in the list.
|
|
* - For Zigbee: @ref NRF_802154_SRC_ADDR_MATCH_ZIGBEE -- The pending bit is cleared only for the short addresses found in the list.\n
|
|
* This method does not set pending bit in non-command and non-data-request frames.
|
|
* - For standard-compliant implementation: @ref NRF_802154_SRC_ADDR_MATCH_ALWAYS_1 -- The pending bit is always set to 1.\n
|
|
* This requires an empty data frame with AR set to 0 to be transmitted immediately afterwards.
|
|
*/
|
|
typedef uint8_t nrf_802154_src_addr_match_t;
|
|
|
|
#define NRF_802154_SRC_ADDR_MATCH_THREAD 0x00 // !< Implementation for the Thread protocol.
|
|
#define NRF_802154_SRC_ADDR_MATCH_ZIGBEE 0x01 // !< Implementation for the Zigbee protocol.
|
|
#define NRF_802154_SRC_ADDR_MATCH_ALWAYS_1 0x02 // !< Standard compliant implementation.
|
|
|
|
/**
|
|
* @brief Capabilites of nrf 802.15.4 radio driver
|
|
*
|
|
* Possible values:
|
|
* - @ref NRF_802154_CAPABILITY_CSMA,
|
|
* - @ref NRF_802154_CAPABILITY_DELAYED_TX,
|
|
* - @ref NRF_802154_CAPABILITY_DELAYED_RX,
|
|
* - @ref NRF_802154_CAPABILITY_ACK_TIMEOUT,
|
|
* - @ref NRF_802154_CAPABILITY_ANT_DIVERSITY,
|
|
* - @ref NRF_802154_CAPABILITY_IFS,
|
|
* - @ref NRF_802154_CAPABILITY_TIMESTAMP
|
|
*
|
|
*/
|
|
typedef uint32_t nrf_802154_capabilities_t;
|
|
|
|
#define NRF_802154_CAPABILITY_CSMA (1UL << 0UL) // !< CSMA-CA supported
|
|
#define NRF_802154_CAPABILITY_DELAYED_TX (1UL << 1UL) // !< TX at specified time supported
|
|
#define NRF_802154_CAPABILITY_DELAYED_RX (1UL << 2UL) // !< RX at specified time supported
|
|
#define NRF_802154_CAPABILITY_ACK_TIMEOUT (1UL << 3UL) // !< ACK timeout supported
|
|
#define NRF_802154_CAPABILITY_ANT_DIVERSITY (1UL << 4UL) // !< Antenna diversity supported
|
|
#define NRF_802154_CAPABILITY_IFS (1UL << 5UL) // !< Inter-frame spacing supported
|
|
#define NRF_802154_CAPABILITY_TIMESTAMP (1UL << 6UL) // !< Frame timestamping supported
|
|
|
|
/**
|
|
*@}
|
|
**/
|
|
|
|
#endif // NRF_802154_TYPES_H__
|