nrf_802154_const.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017, 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_CONST_H_
#define NRF_802154_CONST_H_
 
#define RAW_LENGTH_OFFSET 0 
#define RAW_PAYLOAD_OFFSET 1 
 
#define ACK_HEADER_WITH_PENDING 0x12 
#define ACK_HEADER_WITHOUT_PENDING 0x02 
 
#define ACK_REQUEST_OFFSET 1 
#define ACK_REQUEST_BIT (1 << 5) 
 
#define ASN_IN_NONCE_BIT 0x40 
 
#define DEST_ADDR_TYPE_OFFSET 2 
#define DEST_ADDR_TYPE_MASK 0x0c 
#define DEST_ADDR_TYPE_EXTENDED 0x0c 
#define DEST_ADDR_TYPE_NONE 0x00 
#define DEST_ADDR_TYPE_SHORT 0x08 
#define DEST_ADDR_OFFSET 6 
 
#define DSN_OFFSET 3 
#define DSN_SUPPRESS_OFFSET 2 
#define DSN_SUPPRESS_BIT 0x01 
 
#define FRAME_COUNTER_SUPPRESS_BIT 0x20 
 
#define FRAME_PENDING_OFFSET 1 
#define FRAME_PENDING_BIT (1 << 4) 
 
#define FRAME_TYPE_OFFSET 1 
#define FRAME_TYPE_MASK 0x07 
#define FRAME_TYPE_ACK 0x02 
#define FRAME_TYPE_BEACON 0x00 
#define FRAME_TYPE_COMMAND 0x03 
#define FRAME_TYPE_DATA 0x01 
#define FRAME_TYPE_EXTENDED 0x07 
#define FRAME_TYPE_FRAGMENT 0x06 
#define FRAME_TYPE_MULTIPURPOSE 0x05 
 
#define FRAME_VERSION_OFFSET 2 
#define FRAME_VERSION_MASK 0x30 
#define FRAME_VERSION_0 0x00 
#define FRAME_VERSION_1 0x10 
#define FRAME_VERSION_2 0x20 
#define FRAME_VERSION_3 0x30 
 
#define IE_HEADER_LENGTH_MASK 0x3f 
#define IE_PRESENT_OFFSET 2 
#define IE_PRESENT_BIT 0x02 
 
#define KEY_ID_MODE_0 0 
#define KEY_ID_MODE_1 1 
#define KEY_ID_MODE_2 2 
#define KEY_ID_MODE_3 3 
 
#define KEY_ID_MODE_MASK 0x18 
#define KEY_ID_MODE_BIT_OFFSET 3 
#define KEY_ID_MODE_0_MASK 0 
#define KEY_ID_MODE_1_MASK 0x08 
#define KEY_ID_MODE_2_MASK 0x10 
#define KEY_ID_MODE_3_MASK 0x18 
 
#define KEY_SRC_KEY_ID_MODE_0_SIZE 0 
#define KEY_SRC_KEY_ID_MODE_1_SIZE 0 
#define KEY_SRC_KEY_ID_MODE_2_SIZE 4 
#define KEY_SRC_KEY_ID_MODE_3_SIZE 8 
 
#define KEY_IDX_SIZE 1 
 
#define MAC_CMD_COMMAND_ID_SIZE 1 
#define MAC_CMD_ASSOC_REQ 0x01 
#define MAC_CMD_ASSOC_RESP 0x02 
#define MAC_CMD_DISASSOC_NOTIFY 0x03 
#define MAC_CMD_DATA_REQ 0x04 
#define MAC_CMD_PANID_CONFLICT 0x05 
#define MAC_CMD_ORPHAN_NOTIFY 0x06 
#define MAC_CMD_BEACON_REQ 0x07 
#define MAC_CMD_COORD_REALIGN 0x08 
#define MAC_CMD_GTS_REQUEST 0x09 
 
#define PAN_ID_COMPR_OFFSET 1 
#define PAN_ID_COMPR_MASK 0x40 
 
#define PAN_ID_OFFSET 4 
 
#define PHR_OFFSET 0 
#define PHR_LENGTH_MASK 0x7f 
 
#define PSDU_OFFSET 1 
 
#define SECURITY_ENABLED_OFFSET 1 
#define SECURITY_ENABLED_BIT 0x08 
#define SECURITY_LEVEL_MASK 0x07 
#define SECURITY_LEVEL_NONE 0x00 
#define SECURITY_LEVEL_MIC_32 0x01 
#define SECURITY_LEVEL_MIC_64 0x02 
#define SECURITY_LEVEL_MIC_128 0x03 
#define SECURITY_LEVEL_ENC_MIC_32 0x05 
#define SECURITY_LEVEL_ENC_MIC_64 0x06 
#define SECURITY_LEVEL_ENC_MIC_128 0x07 
#define SECURITY_LEVEL_MIC_LEVEL_MASK 0x03 
 
#define SRC_ADDR_TYPE_EXTENDED 0xc0 
#define SRC_ADDR_TYPE_NONE 0x00 
#define SRC_ADDR_TYPE_MASK 0xc0 
#define SRC_ADDR_TYPE_OFFSET 2 
#define SRC_ADDR_TYPE_SHORT 0x80 
 
#define SRC_ADDR_OFFSET_SHORT_DST 8 
#define SRC_ADDR_OFFSET_EXTENDED_DST 14 
 
#define DSN_SIZE 1 
#define FCF_SIZE 2 
#define FCS_SIZE 2 
#define FRAME_COUNTER_SIZE 4 
#define IE_HEADER_SIZE 2 
#define IMM_ACK_LENGTH 5 
#define KEY_ID_MODE_1_SIZE 1 
#define KEY_ID_MODE_2_SIZE 5 
#define KEY_ID_MODE_3_SIZE 9 
#define MAX_PACKET_SIZE 127 
#define MIC_32_SIZE 4 
#define MIC_64_SIZE 8 
#define MIC_128_SIZE 16 
#define PAN_ID_SIZE 2 
#define PHR_SIZE 1 
#define SECURITY_CONTROL_SIZE 1 
 
#define AES_CCM_KEY_SIZE 16 
 
#define EXTENDED_ADDRESS_SIZE 8 
#define SHORT_ADDRESS_SIZE 2 
 
#define TURNAROUND_TIME 192UL 
#define CCA_TIME 128UL 
#define ACK_IFS TURNAROUND_TIME 
#define UNIT_BACKOFF_PERIOD (TURNAROUND_TIME + CCA_TIME) 
 
#define PHY_US_PER_SYMBOL 16 
#define PHY_SYMBOLS_PER_OCTET 2 
#define PHY_SHR_SYMBOLS 10 
 
#define PHY_MIN_RECEIVER_SENSITIVITY -85 
 
#define ED_RESULT_MAX 0xff 
 
#define BROADCAST_ADDRESS ((uint8_t[SHORT_ADDRESS_SIZE]) {0xff, 0xff}) 
 
#define MIN_SIFS_PERIOD_US 192 
#define MIN_LIFS_PERIOD_US 640 
#define MAX_SIFS_FRAME_SIZE 18 
 
#define NRF_802154_RESERVED_CSMACA_ID (UINT32_MAX - 2) 
#define NRF_802154_RESERVED_DTX_ID (UINT32_MAX - 3) 
 
#define IE_VENDOR_ID 0x00 
#define IE_VENDOR_SIZE_MIN 3 
#define IE_VENDOR_OUI_OFFSET 0 
 
#define IE_VENDOR_THREAD_SUBTYPE_OFFSET 3 
#define IE_VENDOR_THREAD_DATA_OFFSET 4 
#define IE_VENDOR_THREAD_OUI 0xeab89b 
#define IE_VENDOR_THREAD_SIZE_MIN 4 
 
#define IE_VENDOR_THREAD_ACK_PROBING_ID 0x00 
#define IE_VENDOR_THREAD_ACK_SIZE_MIN 5 
#define IE_VENDOR_THREAD_ACK_SIZE_MAX 6 
#define IE_VENDOR_THREAD_RSSI_TOKEN 0x01 
#define IE_VENDOR_THREAD_MARGIN_TOKEN 0x02 
#define IE_VENDOR_THREAD_LQI_TOKEN 0x03 
#define IE_VENDOR_THREAD_RSSI_FLOOR -130 
#define IE_VENDOR_THREAD_MARGIN_FLOOR 0 
#define IE_VENDOR_THREAD_RSSI_CEIL 0 
#define IE_VENDOR_THREAD_MARGIN_CEIL 130 
#define IE_VENDOR_THREAD_CST_ID 0x02 
#define IE_VENDOR_THREAD_CST_SIZE 8 
#define IE_CSL_SYMBOLS_PER_UNIT 10 
#define IE_CSL_PERIOD_MAX 0xffff 
#define IE_CSL_SIZE_MIN 4 
#define IE_CSL_ID 0x1a 
 
#define IE_HT1 0x7e 
#define IE_HT2 0x7f 
#define IE_LENGTH_MASK 0x7f 
#define IE_LENGTH_OFFSET 0x00 
#define IE_ID_OFFSET_0 0x00 
#define IE_ID_OFFSET_1 0x01 
#define IE_DATA_OFFSET 0x02 
#define IE_HEADER_ELEMENT_ID_OFFSET 0x07 
 
typedef enum
{
 REQ_ORIG_HIGHER_LAYER,
 REQ_ORIG_CORE,
 REQ_ORIG_RSCH,
 REQ_ORIG_CSMA_CA,
 REQ_ORIG_ACK_TIMEOUT,
 REQ_ORIG_DELAYED_TRX,
 REQ_ORIG_IFS,
} req_originator_t;
 
#endif // NRF_802154_CONST_H_