mirror of https://github.com/ARMmbed/mbed-os.git
270 lines
9.0 KiB
C
270 lines
9.0 KiB
C
/*
|
|
* Copyright (c) 2018-2019, Arm Limited and affiliates.
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef WS_COMMON_DEFINES_H_
|
|
#define WS_COMMON_DEFINES_H_
|
|
|
|
#define WH_IE_ELEMENT_HEADER_LENGTH 3
|
|
|
|
/* Header IE Sub elements */
|
|
#define WH_IE_UTT_TYPE 1 /**< Unicast Timing and Frame type information */
|
|
#define WH_IE_BT_TYPE 2 /**< Broadcast timing information */
|
|
#define WH_IE_FC_TYPE 3 /**< Flow Control for Extended Direct Frame Exchange */
|
|
#define WH_IE_RSL_TYPE 4 /**< Received Signal Level information */
|
|
#define WH_IE_MHDS_TYPE 5 /**< MHDS information for mesh routing */
|
|
#define WH_IE_VH_TYPE 6 /**< Vendor header information */
|
|
#define WH_IE_EA_TYPE 9 /**< Eapol Auhtenticator EUI-64 header information */
|
|
|
|
#define WS_WP_NESTED_IE 4 /**< WS nested Payload IE element'selement could include mltiple sub payload IE */
|
|
|
|
#define WS_WP_SUB_IE_ELEMENT_HEADER_LENGTH 2
|
|
|
|
/* Payload IE sub elements in side WS_WP_NESTED_IE */
|
|
#define WP_PAYLOAD_IE_US_TYPE 1 /**< Unicast Schedule information */
|
|
#define WP_PAYLOAD_IE_BS_TYPE 2 /**< Broadcast Schedule information */
|
|
#define WP_PAYLOAD_IE_VP_TYPE 3 /**< Vendor Payload information */
|
|
#define WP_PAYLOAD_IE_PAN_TYPE 4 /**< PAN Information */
|
|
#define WP_PAYLOAD_IE_NETNAME_TYPE 5 /**< Network Name information */
|
|
#define WP_PAYLOAD_IE_PAN_VER_TYPE 6 /**< Pan configuration version */
|
|
#define WP_PAYLOAD_IE_GTKHASH_TYPE 7 /**< GTK Hash information */
|
|
|
|
/* WS frame types to WH_IE_UTT_TYPE */
|
|
#define WS_FT_PAN_ADVERT 0 /**< PAN Advert */
|
|
#define WS_FT_PAN_ADVERT_SOL 1 /**< PAN Advert Solicit */
|
|
#define WS_FT_PAN_CONF 2 /**< PAN Config */
|
|
#define WS_FT_PAN_CONF_SOL 3 /**< PAN Config Solicit */
|
|
#define WS_FT_DATA 4 /**< data type inside MPX */
|
|
#define WS_FT_ACK 5 /**< Enhanced ACK */
|
|
#define WS_FT_EAPOL 6 /**< EAPOL message inside MPX */
|
|
|
|
|
|
/**
|
|
* @brief ws_pan_information_t PAN information
|
|
*/
|
|
typedef struct ws_pan_information_s {
|
|
uint16_t pan_size; /**< Number devices connected to Border Router. */
|
|
uint16_t routing_cost; /**< ETX to border Router. */
|
|
uint16_t pan_version; /**< Pan configuration version will be updatd by Border router at PAN. */
|
|
bool use_parent_bs: 1; /**< 1 for force to follow parent broadcast schedule. 0 node may define own schedule. */
|
|
bool rpl_routing_method: 1; /**< 1 when RPL routing is selected and 0 when L2 routing. */
|
|
unsigned version: 3; /**< Pan version support. */
|
|
} ws_pan_information_t;
|
|
|
|
/**
|
|
* @brief ws_hopping_schedule_t Chanel hopping schedule information
|
|
*/
|
|
typedef struct ws_hopping_schedule_s {
|
|
uint8_t fhss_uc_dwell_interval;
|
|
uint8_t fhss_bc_dwell_interval;
|
|
uint8_t regulatory_domain; /**< PHY regulatory domain default to "KR" 0x09 */
|
|
uint8_t operating_class; /**< PHY operating class default to 1 */
|
|
uint8_t operating_mode; /**< PHY operating mode default to "1b" symbol rate 50, modulation index 1 */
|
|
uint8_t channel_plan; /**< 0: use regulatory domain values 1: application defined plan */
|
|
uint8_t uc_channel_function; /**< 0: Fixed channel, 1:TR51CF, 2: Direct Hash, 3: Vendor defined */
|
|
uint8_t bc_channel_function; /**< 0: Fixed channel, 1:TR51CF, 2: Direct Hash, 3: Vendor defined */
|
|
uint8_t channel_spacing; /**< derived from regulatory domain. 0:200k, 1:400k, 2:600k, 3:100k */
|
|
uint8_t number_of_channels; /**< derived from regulatory domain */
|
|
uint8_t clock_drift;
|
|
uint8_t timing_accurancy;
|
|
uint16_t uc_fixed_channel;
|
|
uint16_t bc_fixed_channel;
|
|
uint16_t fhss_bsi;
|
|
uint32_t fhss_broadcast_interval;
|
|
uint32_t channel_mask[8];
|
|
uint_fast24_t ch0_freq; // Default should be derived from regulatory domain
|
|
} ws_hopping_schedule_t;
|
|
|
|
/**
|
|
* @brief ws_utt_ie_t WS UTT-IE
|
|
*/
|
|
typedef struct ws_utt_ie {
|
|
uint8_t message_type;
|
|
uint_fast24_t ufsi;
|
|
} ws_utt_ie_t;
|
|
|
|
/**
|
|
* @brief ws_bt_ie_t WS BT-IE read
|
|
*/
|
|
typedef struct ws_bt_ie {
|
|
uint16_t broadcast_slot_number;
|
|
uint_fast24_t broadcast_interval_offset;
|
|
} ws_bt_ie_t;
|
|
|
|
|
|
/**
|
|
* @brief ws_channel_plan_zero_t WS channel plan 0 define domain and class
|
|
*/
|
|
typedef struct ws_channel_plan_zero {
|
|
uint8_t regulator_domain;
|
|
uint8_t operation_class;
|
|
} ws_channel_plan_zero_t;
|
|
|
|
/**
|
|
* @brief ws_channel_plan_one_t WS channel plan 1 define ch0, spasing and channel count
|
|
*/
|
|
typedef struct ws_channel_plan_one {
|
|
uint_fast24_t ch0;
|
|
unsigned channel_spacing: 4;
|
|
uint16_t number_of_channel;
|
|
} ws_channel_plan_one_t;
|
|
|
|
/**
|
|
* @brief ws_channel_function_zero_t WS function 0 fixed channel
|
|
*/
|
|
typedef struct ws_channel_function_zero {
|
|
uint16_t fixed_channel;
|
|
} ws_channel_function_zero_t;
|
|
|
|
/**
|
|
* @brief ws_channel_function_three_t WS function 3 vendor spesific channel hop
|
|
*/
|
|
typedef struct ws_channel_function_three {
|
|
uint8_t channel_hop_count;
|
|
uint8_t *channel_list;
|
|
} ws_channel_function_three_t;
|
|
|
|
/**
|
|
* @brief ws_us_ie_t WS US-IE read
|
|
*/
|
|
typedef struct ws_us_ie {
|
|
uint8_t dwell_interval;
|
|
uint8_t clock_drift;
|
|
uint8_t timing_accurancy;
|
|
unsigned channel_plan: 3;
|
|
unsigned channel_function: 3;
|
|
unsigned excluded_channel_ctrl: 2;
|
|
union {
|
|
ws_channel_plan_zero_t zero;
|
|
ws_channel_plan_one_t one;
|
|
} plan;
|
|
union {
|
|
ws_channel_function_zero_t zero;
|
|
ws_channel_function_three_t three;
|
|
} function;
|
|
} ws_us_ie_t;
|
|
|
|
/**
|
|
* @brief ws_bs_ie_t WS BS-IE read
|
|
*/
|
|
typedef struct ws_bs_ie {
|
|
uint32_t broadcast_interval;
|
|
uint16_t broadcast_schedule_identifier;
|
|
uint8_t dwell_interval;
|
|
uint8_t clock_drift;
|
|
uint8_t timing_accurancy;
|
|
unsigned channel_plan: 3;
|
|
unsigned channel_function: 3;
|
|
unsigned excluded_channel_ctrl: 2;
|
|
union {
|
|
ws_channel_plan_zero_t zero;
|
|
ws_channel_plan_one_t one;
|
|
} plan;
|
|
union {
|
|
ws_channel_function_zero_t zero;
|
|
ws_channel_function_three_t three;
|
|
} function;
|
|
} ws_bs_ie_t;
|
|
|
|
|
|
#define MPX_KEY_MANAGEMENT_ENC_USER_ID 0x0001 /**< MPX Key management user ID */
|
|
#define MPX_LOWPAN_ENC_USER_ID 0xA0ED /**< MPX Lowpan User Id */
|
|
|
|
#define WS_FAN_VERSION_1_0 1
|
|
|
|
#define WS_NEIGHBOR_LINK_TIMEOUT 2200
|
|
#define WS_NEIGHBOR_TEMPORARY_LINK_MIN_TIMEOUT_LARGE 520
|
|
#define WS_NEIGHBOR_TEMPORARY_LINK_MIN_TIMEOUT_SMALL 260
|
|
#define WS_NEIGHBOR_NUD_TIMEOUT WS_NEIGHBOR_LINK_TIMEOUT / 2
|
|
|
|
#define WS_NEIGBOR_ETX_SAMPLE_MAX 3
|
|
#define WS_NEIGHBOUR_MAX_CANDIDATE_PROBE 5
|
|
|
|
#define WS_PROBE_INIT_BASE_SECONDS 8
|
|
|
|
#define WS_NUD_RAND_PROBABILITY 1
|
|
|
|
#define WS_NUD_RANDOM_SAMPLE_LENGTH WS_NEIGHBOR_NUD_TIMEOUT / 2
|
|
|
|
#define WS_NUD_RANDOM_COMPARE (WS_NUD_RAND_PROBABILITY*WS_NUD_RANDOM_SAMPLE_LENGTH) / 100
|
|
|
|
#define WS_ETX_MIN_SAMPLE_COUNT 4
|
|
|
|
#define WS_ETX_MAX_UPDATE 1024
|
|
|
|
#define WS_ETX_MIN_WAIT_TIME 60
|
|
|
|
#define WS_RPL_PARENT_CANDIDATE_MAX 5
|
|
#define WS_RPL_SELECTED_PARENT_MAX 2
|
|
|
|
#define WS_CERTIFICATE_RPL_PARENT_CANDIDATE_MAX 8
|
|
#define WS_CERTIFICATE_RPL_SELECTED_PARENT_MAX 3
|
|
|
|
/**
|
|
* Wi-sun spesific non-preferred prefix policy label
|
|
*/
|
|
|
|
#define WS_NON_PREFFRED_LABEL 36
|
|
|
|
/*
|
|
* Threshold (referenced to DEVICE_MIN_SENS) above which a neighbor node may be considered for inclusion into candidate parent set
|
|
*/
|
|
#define CAND_PARENT_THRESHOLD 10
|
|
/*
|
|
* Hysteresis factor to be applied to CAND_PARENT_THRESHOLD when admitting or dropping nodes from the candidate parent set.
|
|
*/
|
|
#define CAND_PARENT_HYSTERISIS 3
|
|
|
|
/*
|
|
* value when send the first RPL DIS in 100ms ticks. Value is randomized between timeout/2 - timeout
|
|
*/
|
|
#define WS_RPL_DIS_INITIAL_TIMEOUT 600
|
|
/*
|
|
* value when send subsequent RPL DIS in 100 ms tics. Value is randomized between timeout/2 - timeout
|
|
*/
|
|
#define WS_RPL_DIS_TIMEOUT 1800
|
|
|
|
/*
|
|
* MAC Ack wait duration in symbols. 2-FSK modulation used -> 1 bit per symbol.
|
|
*/
|
|
#define WS_ACK_WAIT_SYMBOLS 800
|
|
|
|
/*
|
|
* Tack max time in milliseconds.
|
|
*/
|
|
#define WS_TACK_MAX_MS 5
|
|
|
|
// With FHSS we need to check CCA twice on TX channel
|
|
#define WS_NUMBER_OF_CSMA_PERIODS 2
|
|
// Interval between two CCA checks
|
|
#define WS_CSMA_MULTI_CCA_INTERVAL 1000
|
|
|
|
/* Default FHSS timing information
|
|
*
|
|
*/
|
|
#define WS_FHSS_UC_DWELL_INTERVAL 255;
|
|
#define WS_FHSS_BC_INTERVAL 1020;
|
|
#define WS_FHSS_BC_DWELL_INTERVAL 255;
|
|
|
|
/*
|
|
* EAPOL relay and PAE authenticator socket settings
|
|
*/
|
|
#define EAPOL_RELAY_SOCKET_PORT 10253
|
|
#define BR_EAPOL_RELAY_SOCKET_PORT 10255
|
|
#define PAE_AUTH_SOCKET_PORT 10254
|
|
|
|
#endif /* WS_COMMON_DEFINES_H_ */
|