Modules#

Wi-SUN API type definitions#

Enumerations#

enum

sl_wisun_device_type_t {

SL_WISUN_ROUTER = 0

SL_WISUN_LFN = 1

SL_WISUN_BORDER_ROUTER = 2

}

Enumerations for device type.

enum

sl_wisun_network_size_t {

SL_WISUN_NETWORK_SIZE_AUTOMATIC = 0

SL_WISUN_NETWORK_SIZE_SMALL = 1

SL_WISUN_NETWORK_SIZE_MEDIUM = 2

SL_WISUN_NETWORK_SIZE_LARGE = 3

SL_WISUN_NETWORK_SIZE_TEST = 4

SL_WISUN_NETWORK_SIZE_CERTIFICATION = 5

}

Enumerations for network size.

enum

sl_wisun_ip_address_type_t {

SL_WISUN_IP_ADDRESS_TYPE_LINK_LOCAL = 0

SL_WISUN_IP_ADDRESS_TYPE_GLOBAL = 1

SL_WISUN_IP_ADDRESS_TYPE_BORDER_ROUTER = 2

SL_WISUN_IP_ADDRESS_TYPE_PRIMARY_PARENT = 3

SL_WISUN_IP_ADDRESS_TYPE_SECONDARY_PARENT = 4

}

Enumerations for IP address type.

enum

sl_wisun_socket_protocol_t {

SL_WISUN_SOCKET_PROTOCOL_UDP = 0

SL_WISUN_SOCKET_PROTOCOL_TCP = 1

SL_WISUN_SOCKET_PROTOCOL_ICMP = 2

}

Enumerations for socket protocol.

enum

sl_wisun_certificate_option_t {

SL_WISUN_CERTIFICATE_OPTION_NONE = 0

SL_WISUN_CERTIFICATE_OPTION_APPEND = 1

SL_WISUN_CERTIFICATE_OPTION_IS_REF = 2

SL_WISUN_CERTIFICATE_OPTION_HAS_KEY = 4

}

Enumerations for certificate options.

enum

sl_wisun_private_key_option_t {

SL_WISUN_PRIVATE_KEY_OPTION_NONE = 0

SL_WISUN_PRIVATE_KEY_OPTION_IS_REF = 1

}

Enumerations for private key options.

enum

sl_wisun_socket_event_mode_t {

SL_WISUN_SOCKET_EVENT_MODE_INDICATION = 0

SL_WISUN_SOCKET_EVENT_MODE_POLLING = 1

}

Enumerations for socket event mode.

enum

sl_wisun_socket_option_t {

SL_WISUN_SOCKET_OPTION_EVENT_MODE = 0

SL_WISUN_SOCKET_OPTION_MULTICAST_GROUP = 1

SL_WISUN_SOCKET_OPTION_SEND_BUFFER_LIMIT = 2

SL_WISUN_SOCKET_OPTION_EDFE_MODE = 3

SL_WISUN_SOCKET_OPTION_UNICAST_HOP_LIMIT = 4

SL_WISUN_SOCKET_OPTION_MULTICAST_HOP_LIMIT = 5

}

Enumerations for socket option.

enum

sl_wisun_statistics_type_t {

SL_WISUN_STATISTICS_TYPE_PHY = 0

SL_WISUN_STATISTICS_TYPE_MAC = 1

SL_WISUN_STATISTICS_TYPE_FHSS = 2

SL_WISUN_STATISTICS_TYPE_WISUN = 3

SL_WISUN_STATISTICS_TYPE_NETWORK = 4

SL_WISUN_STATISTICS_TYPE_REGULATION = 5

}

Enumerations for statistics type.

enum

sl_wisun_regulatory_domain_t {

SL_WISUN_REGULATORY_DOMAIN_WW = 0

SL_WISUN_REGULATORY_DOMAIN_NA = 1

SL_WISUN_REGULATORY_DOMAIN_JP = 2

SL_WISUN_REGULATORY_DOMAIN_EU = 3

SL_WISUN_REGULATORY_DOMAIN_CN = 4

SL_WISUN_REGULATORY_DOMAIN_IN = 5

SL_WISUN_REGULATORY_DOMAIN_MX = 6

SL_WISUN_REGULATORY_DOMAIN_BZ = 7

SL_WISUN_REGULATORY_DOMAIN_AZ = 8

SL_WISUN_REGULATORY_DOMAIN_NZ = 8

SL_WISUN_REGULATORY_DOMAIN_KR = 9

SL_WISUN_REGULATORY_DOMAIN_PH = 10

SL_WISUN_REGULATORY_DOMAIN_MY = 11

SL_WISUN_REGULATORY_DOMAIN_HK = 12

SL_WISUN_REGULATORY_DOMAIN_SG = 13

SL_WISUN_REGULATORY_DOMAIN_TH = 14

SL_WISUN_REGULATORY_DOMAIN_VN = 15

SL_WISUN_REGULATORY_DOMAIN_APP = 255

}

Enumerations for regulatory domain.

enum

sl_wisun_operating_class_t {

SL_WISUN_OPERATING_CLASS_1 = 1

SL_WISUN_OPERATING_CLASS_2 = 2

SL_WISUN_OPERATING_CLASS_3 = 3

SL_WISUN_OPERATING_CLASS_4 = 4

SL_WISUN_OPERATING_CLASS_5 = 5

SL_WISUN_OPERATING_CLASS_APP = 255

}

Enumerations for operating class.

enum

sl_wisun_operating_mode_t {

SL_WISUN_OPERATING_MODE_1A = 0x1a

SL_WISUN_OPERATING_MODE_1B = 0x1b

SL_WISUN_OPERATING_MODE_2A = 0x2a

SL_WISUN_OPERATING_MODE_2B = 0x2b

SL_WISUN_OPERATING_MODE_3 = 0x03

SL_WISUN_OPERATING_MODE_4A = 0x4a

SL_WISUN_OPERATING_MODE_4B = 0x4b

SL_WISUN_OPERATING_MODE_5 = 0x05

}

Enumerations for operating mode.

enum

sl_wisun_multicast_group_action_t {

SL_WISUN_MULTICAST_GROUP_ACTION_JOIN = 0

SL_WISUN_MULTICAST_GROUP_ACTION_LEAVE = 1

}

Enumerations for multicast group action.

enum

sl_wisun_channel_spacing_t {

SL_WISUN_CHANNEL_SPACING_100KHZ = 0

SL_WISUN_CHANNEL_SPACING_200KHZ = 1

SL_WISUN_CHANNEL_SPACING_400KHZ = 2

SL_WISUN_CHANNEL_SPACING_600KHZ = 3

SL_WISUN_CHANNEL_SPACING_250KHZ = 4

SL_WISUN_CHANNEL_SPACING_800KHZ = 5

SL_WISUN_CHANNEL_SPACING_1200KHZ = 6

}

Enumerations for channel spacing.

enum

sl_wisun_join_state_t {

SL_WISUN_JOIN_STATE_DISCONNECTED = 0

SL_WISUN_JOIN_STATE_SELECT_PAN = 1

SL_WISUN_JOIN_STATE_AUTHENTICATE = 2

SL_WISUN_JOIN_STATE_ACQUIRE_PAN_CONFIG = 3

SL_WISUN_JOIN_STATE_CONFIGURE_ROUTING = 4

SL_WISUN_JOIN_STATE_OPERATIONAL = 5

SL_WISUN_JOIN_STATE_PARENT_SELECT = 41

SL_WISUN_JOIN_STATE_DHCP = 42

SL_WISUN_JOIN_STATE_EARO = 43

SL_WISUN_JOIN_STATE_DAO = 44

}

Enumerations for join state.

enum

sl_wisun_network_update_flags_t {

SL_WISUN_NETWORK_UPDATE_FLAGS_GLOBAL_IP = 0

SL_WISUN_NETWORK_UPDATE_FLAGS_PRIMARY_PARENT = 1

SL_WISUN_NETWORK_UPDATE_FLAGS_SECONDARY_PARENT = 2

}

Enumerations for network update flags.

enum

sl_wisun_phy_config_type_t {

SL_WISUN_PHY_CONFIG_FAN10 = 0

SL_WISUN_PHY_CONFIG_FAN11 = 1

SL_WISUN_PHY_CONFIG_EXPLICIT = 2

SL_WISUN_PHY_CONFIG_IDS = 3

}

Enumerations for channel plan.

enum

sl_wisun_lfn_profile_t {

SL_WISUN_LFN_PROFILE_TEST = 0

SL_WISUN_LFN_PROFILE_BALANCED = 1

SL_WISUN_LFN_PROFILE_ECO = 2

}

Enumeration for LFN configuration profile.

enum

sl_wisun_neighbor_type_t {

SL_WISUN_NEIGHBOR_TYPE_PRIMARY_PARENT = 0

SL_WISUN_NEIGHBOR_TYPE_SECONDARY_PARENT = 1

SL_WISUN_NEIGHBOR_TYPE_CHILD = 2

}

Enumeration for RPL neighbor types.

enum

sl_wisun_trace_group_t {

SL_WISUN_TRACE_GROUP_MAC = 0

SL_WISUN_TRACE_GROUP_NW = 1

SL_WISUN_TRACE_GROUP_LLC = 2

SL_WISUN_TRACE_GROUP_6LO = 3

SL_WISUN_TRACE_GROUP_IPV6 = 4

SL_WISUN_TRACE_GROUP_TCP = 5

SL_WISUN_TRACE_GROUP_UDP = 6

SL_WISUN_TRACE_GROUP_ICMP = 7

SL_WISUN_TRACE_GROUP_DHCP = 8

SL_WISUN_TRACE_GROUP_MPL = 9

SL_WISUN_TRACE_GROUP_DNS = 10

SL_WISUN_TRACE_GROUP_RPL = 11

SL_WISUN_TRACE_GROUP_TRIC = 12

SL_WISUN_TRACE_GROUP_WS = 15

SL_WISUN_TRACE_GROUP_BOOT = 16

SL_WISUN_TRACE_GROUP_WSR = 17

SL_WISUN_TRACE_GROUP_WSBR = 18

SL_WISUN_TRACE_GROUP_SEC = 19

SL_WISUN_TRACE_GROUP_TIME = 20

SL_WISUN_TRACE_GROUP_NEIGH = 21

SL_WISUN_TRACE_GROUP_STAT = 22

SL_WISUN_TRACE_GROUP_BUFF = 23

SL_WISUN_TRACE_GROUP_ADDR = 24

SL_WISUN_TRACE_GROUP_MON = 25

SL_WISUN_TRACE_GROUP_SOCK = 26

SL_WISUN_TRACE_GROUP_DENY = 27

SL_WISUN_TRACE_GROUP_ETX = 28

SL_WISUN_TRACE_GROUP_FHSS = 29

SL_WISUN_TRACE_GROUP_ROUT = 30

SL_WISUN_TRACE_GROUP_EVLP = 31

SL_WISUN_TRACE_GROUP_NVM = 32

SL_WISUN_TRACE_GROUP_CRYPTO = 33

SL_WISUN_TRACE_GROUP_RF = 34

Sl_WISUN_TRACE_GROUP_WSIE = 35

SL_WISUN_TRACE_GROUP_CONFIG = 36

SL_WISUN_TRACE_GROUP_TIM_SRV = 37

SL_WISUN_TRACE_GROUP_INT = 63

SL_WISUN_TRACE_GROUP_COUNT = 64

}

Enumeration for trace group.

enum

sl_wisun_trace_level_t {

SL_WISUN_TRACE_LEVEL_NONE = 0

SL_WISUN_TRACE_LEVEL_ERROR = 1

SL_WISUN_TRACE_LEVEL_WARN = 2

SL_WISUN_TRACE_LEVEL_INFO = 3

SL_WISUN_TRACE_LEVEL_DEBUG = 4

}

Enumerations for trace level.

enum

sl_wisun_regulation_t {

SL_WISUN_REGULATION_NONE = 0

SL_WISUN_REGULATION_ARIB = 1

}

Enumerations for regional regulation.

enum

sl_wisun_mode_switch_mode_t {

SL_WISUN_MODE_SWITCH_DISABLED = 0

SL_WISUN_MODE_SWITCH_ENABLED = 1

SL_WISUN_MODE_SWITCH_DEFAULT = 2

}

Enumeration for Mode Switch mode.

enum

sl_wisun_regulation_tx_level_t {

SL_WISUN_REGULATION_TX_LEVEL_LOW = 0

SL_WISUN_REGULATION_TX_LEVEL_WARNING = 1

SL_WISUN_REGULATION_TX_LEVEL_ALERT = 2

}

Enumeration for regional regulation transmission level.

enum

sl_wisun_unicast_tx_mode_t {

SL_WISUN_UNICAST_TX_MODE_DEFAULT = 0

SL_WISUN_UNICAST_TX_MODE_SLOT = 1

}

Enumeration for unicast transmission mode.

enum

sl_wisun_channel_exclusion_mode_t {

SL_WISUN_CHANNEL_EXCLUSION_MODE_BY_RANGE = 1

SL_WISUN_CHANNEL_EXCLUSION_MODE_BY_MASK = 2

}

Enumeration for channel exlusion modes.

Typedefs#

typedef uint32_t

sl_wisun_socket_id_t

ID used identify a socket.

Variables#

const sl_wisun_mac_address_t

sl_wisun_broadcast_mac

Broadcast MAC address.

Macros#

#define

SL_WISUN_NETWORK_NAME_SIZE 32

Maximum size of the Wi-SUN network name.

#define

SL_WISUN_MAC_ADDRESS_SIZE 8

Size of a MAC address.

#define

SL_WISUN_IP_ADDRESS_SIZE 16

Size of an IPv6 address.

#define

SL_WISUN_CHANNEL_MASK_SIZE 32

Size of a channel mask.

#define

SL_WISUN_FILTER_BITFIELD_SIZE ((SL_WISUN_TRACE_GROUP_COUNT + 7) / 8)

Size of the filter bitfield.

#define

SL_WISUN_ADVERT_FRAGMENT_DISABLE UINT32_MAX

Maximum fragment duration. Disables advert fragmentation.

#define

SL_WISUN_MAX_PHY_MODE_ID_COUNT 15

Maximum number of PhyModeId allowed in POM-IE.

#define

SL_WISUN_CHANNEL_SPACING_100HZ SL_WISUN_CHANNEL_SPACING_100KHZ

Channel spacing 100 kHz for backward compatibility.

#define

SL_WISUN_CHANNEL_SPACING_200HZ SL_WISUN_CHANNEL_SPACING_200KHZ

Channel spacing 200 kHz for backward compatibility.

#define

SL_WISUN_CHANNEL_SPACING_400HZ SL_WISUN_CHANNEL_SPACING_400KHZ

Channel spacing 400 kHz for backward compatibility.

#define

SL_WISUN_CHANNEL_SPACING_600HZ SL_WISUN_CHANNEL_SPACING_600KHZ

Channel spacing 600 kHz for backward compatibility.

#define

SL_WISUN_INVALID_SOCKET_ID 255

Socket ID value for an invalid socket.

Enumeration Documentation#

sl_wisun_device_type_t#

sl_wisun_device_type_t

Enumerations for device type.

Enumerator
SL_WISUN_ROUTER	FFN Router.
SL_WISUN_LFN	LFN Router (experimental, for evaluation purposes only)
SL_WISUN_BORDER_ROUTER	Border Router.

Definition at line 59 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_network_size_t#

sl_wisun_network_size_t

Enumerations for network size.

Enumerator
SL_WISUN_NETWORK_SIZE_AUTOMATIC	Determine the size from PAN advertisements.
SL_WISUN_NETWORK_SIZE_SMALL	Small size (less than 100 nodes)
SL_WISUN_NETWORK_SIZE_MEDIUM	Medium size (100 to 800 nodes)
SL_WISUN_NETWORK_SIZE_LARGE	Large size (800 to 1500 nodes)
SL_WISUN_NETWORK_SIZE_TEST	Test network (a few nodes)
SL_WISUN_NETWORK_SIZE_CERTIFICATION	Certification configuration.

Definition at line 69 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_ip_address_type_t#

sl_wisun_ip_address_type_t

Enumerations for IP address type.

Enumerator
SL_WISUN_IP_ADDRESS_TYPE_LINK_LOCAL	Device link-local address.
SL_WISUN_IP_ADDRESS_TYPE_GLOBAL	Device global unicast address.
SL_WISUN_IP_ADDRESS_TYPE_BORDER_ROUTER	Border router global unicast address.
SL_WISUN_IP_ADDRESS_TYPE_PRIMARY_PARENT	Link-local address of the primary parent.
SL_WISUN_IP_ADDRESS_TYPE_SECONDARY_PARENT	Link-local address of the secondary parent.

Definition at line 85 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_socket_protocol_t#

sl_wisun_socket_protocol_t

Enumerations for socket protocol.

Enumerator
SL_WISUN_SOCKET_PROTOCOL_UDP	User Datagram Protocol (UDP)
SL_WISUN_SOCKET_PROTOCOL_TCP	Transmission Control Protocol (TCP)
SL_WISUN_SOCKET_PROTOCOL_ICMP	Internet Control Message Protocol (ICMP)

Definition at line 99 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_certificate_option_t#

sl_wisun_certificate_option_t

Enumerations for certificate options.

Enumerator
SL_WISUN_CERTIFICATE_OPTION_NONE	Empty option.
SL_WISUN_CERTIFICATE_OPTION_APPEND	Certificate is appended to a chain.
SL_WISUN_CERTIFICATE_OPTION_IS_REF	Certificate data will remain in scope.
SL_WISUN_CERTIFICATE_OPTION_HAS_KEY	Certificate has a private key.

Definition at line 109 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_private_key_option_t#

sl_wisun_private_key_option_t

Enumerations for private key options.

Enumerator
SL_WISUN_PRIVATE_KEY_OPTION_NONE	Empty option.
SL_WISUN_PRIVATE_KEY_OPTION_IS_REF	Private key data will remain in scope.

Definition at line 121 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_socket_event_mode_t#

sl_wisun_socket_event_mode_t

Enumerations for socket event mode.

Enumerator
SL_WISUN_SOCKET_EVENT_MODE_INDICATION	Received data is sent in an indication.
SL_WISUN_SOCKET_EVENT_MODE_POLLING	The amount of received data is sent in an indication.

Definition at line 129 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_socket_option_t#

sl_wisun_socket_option_t

Enumerations for socket option.

Enumerator
SL_WISUN_SOCKET_OPTION_EVENT_MODE	Option for socket event mode.
SL_WISUN_SOCKET_OPTION_MULTICAST_GROUP	Option for multicast group.
SL_WISUN_SOCKET_OPTION_SEND_BUFFER_LIMIT	Option for send buffer limit.
SL_WISUN_SOCKET_OPTION_EDFE_MODE	Option to enable/disable Extended Directed Frame Exchange mode.
SL_WISUN_SOCKET_OPTION_UNICAST_HOP_LIMIT	Option to set socket unicast hop limit.
SL_WISUN_SOCKET_OPTION_MULTICAST_HOP_LIMIT	Option to set socket multicast hop limit.

Definition at line 137 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_statistics_type_t#

sl_wisun_statistics_type_t

Enumerations for statistics type.

Enumerator
SL_WISUN_STATISTICS_TYPE_PHY	PHY/RF statistics.
SL_WISUN_STATISTICS_TYPE_MAC	MAC statistics.
SL_WISUN_STATISTICS_TYPE_FHSS	Frequency hopping statistics.
SL_WISUN_STATISTICS_TYPE_WISUN	Wi-SUN statistics.
SL_WISUN_STATISTICS_TYPE_NETWORK	6LoWPAN/IP stack statistics
SL_WISUN_STATISTICS_TYPE_REGULATION	Regional regulation.

Definition at line 153 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_regulatory_domain_t#

sl_wisun_regulatory_domain_t

Enumerations for regulatory domain.

Enumerator
SL_WISUN_REGULATORY_DOMAIN_WW	World-wide (2.4 GHz)
SL_WISUN_REGULATORY_DOMAIN_NA	North America.
SL_WISUN_REGULATORY_DOMAIN_JP	Japan.
SL_WISUN_REGULATORY_DOMAIN_EU	Europe.
SL_WISUN_REGULATORY_DOMAIN_CN	China.
SL_WISUN_REGULATORY_DOMAIN_IN	India.
SL_WISUN_REGULATORY_DOMAIN_MX	Mexico.
SL_WISUN_REGULATORY_DOMAIN_BZ	Brazil.
SL_WISUN_REGULATORY_DOMAIN_AZ	Australia.
SL_WISUN_REGULATORY_DOMAIN_NZ	New Zealand.
SL_WISUN_REGULATORY_DOMAIN_KR	South Korea.
SL_WISUN_REGULATORY_DOMAIN_PH	Philippines.
SL_WISUN_REGULATORY_DOMAIN_MY	Malaysia.
SL_WISUN_REGULATORY_DOMAIN_HK	Hong Kong.
SL_WISUN_REGULATORY_DOMAIN_SG	Singapore.
SL_WISUN_REGULATORY_DOMAIN_TH	Thailand.
SL_WISUN_REGULATORY_DOMAIN_VN	Vietnam.
SL_WISUN_REGULATORY_DOMAIN_APP	Application-specific domain.

Definition at line 169 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_operating_class_t#

sl_wisun_operating_class_t

Enumerations for operating class.

Enumerator
SL_WISUN_OPERATING_CLASS_1	Operating class# 1.
SL_WISUN_OPERATING_CLASS_2	Operating class# 2.
SL_WISUN_OPERATING_CLASS_3	Operating class# 3.
SL_WISUN_OPERATING_CLASS_4	Operating class# 4.
SL_WISUN_OPERATING_CLASS_5	Operating class# 5.
SL_WISUN_OPERATING_CLASS_APP	Application-specific class.

Definition at line 209 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_operating_mode_t#

sl_wisun_operating_mode_t

Enumerations for operating mode.

Enumerator
SL_WISUN_OPERATING_MODE_1A	Operating mode# 1a.
SL_WISUN_OPERATING_MODE_1B	Operating mode# 1b.
SL_WISUN_OPERATING_MODE_2A	Operating mode# 2a.
SL_WISUN_OPERATING_MODE_2B	Operating mode# 2b.
SL_WISUN_OPERATING_MODE_3	Operating mode# 3.
SL_WISUN_OPERATING_MODE_4A	Operating mode# 4a.
SL_WISUN_OPERATING_MODE_4B	Operating mode# 4b.
SL_WISUN_OPERATING_MODE_5	Operating mode# 5.

Definition at line 225 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_multicast_group_action_t#

sl_wisun_multicast_group_action_t

Enumerations for multicast group action.

Enumerator
SL_WISUN_MULTICAST_GROUP_ACTION_JOIN	Join a multicast group.
SL_WISUN_MULTICAST_GROUP_ACTION_LEAVE	Leave a multicast group.

Definition at line 245 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_channel_spacing_t#

sl_wisun_channel_spacing_t

Enumerations for channel spacing.

Enumerator
SL_WISUN_CHANNEL_SPACING_100KHZ	100 kHz
SL_WISUN_CHANNEL_SPACING_200KHZ	200 kHz
SL_WISUN_CHANNEL_SPACING_400KHZ	400 kHz
SL_WISUN_CHANNEL_SPACING_600KHZ	600 kHz
SL_WISUN_CHANNEL_SPACING_250KHZ	250 kHz
SL_WISUN_CHANNEL_SPACING_800KHZ	800 kHz
SL_WISUN_CHANNEL_SPACING_1200KHZ	1200 kHz

Definition at line 253 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_join_state_t#

sl_wisun_join_state_t

Enumerations for join state.

Enumerator
SL_WISUN_JOIN_STATE_DISCONNECTED	Join state 0: Disconnected.
SL_WISUN_JOIN_STATE_SELECT_PAN	Join state 1: Select PAN.
SL_WISUN_JOIN_STATE_AUTHENTICATE	Join state 2: Authenticate.
SL_WISUN_JOIN_STATE_ACQUIRE_PAN_CONFIG	Join state 3: Acquire PAN config.
SL_WISUN_JOIN_STATE_CONFIGURE_ROUTING	Join state 4: Configure routing.
SL_WISUN_JOIN_STATE_OPERATIONAL	Join state 5: Operational.
SL_WISUN_JOIN_STATE_PARENT_SELECT	Join state 4: Preferred parent selection.
SL_WISUN_JOIN_STATE_DHCP	Join state 4: DHCP address acquisition.
SL_WISUN_JOIN_STATE_EARO	Join state 4: Address registration.
SL_WISUN_JOIN_STATE_DAO	Join state 4: DAO registration.

Definition at line 283 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_network_update_flags_t#

sl_wisun_network_update_flags_t

Enumerations for network update flags.

Enumerator
SL_WISUN_NETWORK_UPDATE_FLAGS_GLOBAL_IP	Global IP modification flag bit.
SL_WISUN_NETWORK_UPDATE_FLAGS_PRIMARY_PARENT	Primary Parent modification flag bit.
SL_WISUN_NETWORK_UPDATE_FLAGS_SECONDARY_PARENT	Secondary parent modification flag bit.

Definition at line 307 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_phy_config_type_t#

sl_wisun_phy_config_type_t

Enumerations for channel plan.

Enumerator
SL_WISUN_PHY_CONFIG_FAN10	FAN1.0 configuration.
SL_WISUN_PHY_CONFIG_FAN11	FAN1.1 configuration.
SL_WISUN_PHY_CONFIG_EXPLICIT	Explicit configuration.
SL_WISUN_PHY_CONFIG_IDS	Specific RAIL channel configuration.

Definition at line 317 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_lfn_profile_t#

sl_wisun_lfn_profile_t

Enumeration for LFN configuration profile.

Enumerator
SL_WISUN_LFN_PROFILE_TEST	Profile for test usage, best performance but highest power consumption.
SL_WISUN_LFN_PROFILE_BALANCED	Profile providing balance between power consumption and performance.
SL_WISUN_LFN_PROFILE_ECO	Profile optimized for low power consumption.

Definition at line 329 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_neighbor_type_t#

sl_wisun_neighbor_type_t

Enumeration for RPL neighbor types.

Enumerator
SL_WISUN_NEIGHBOR_TYPE_PRIMARY_PARENT	Primary parent.
SL_WISUN_NEIGHBOR_TYPE_SECONDARY_PARENT	Secondary parent.
SL_WISUN_NEIGHBOR_TYPE_CHILD	Child.

Definition at line 662 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_trace_group_t#

sl_wisun_trace_group_t

Enumeration for trace group.

Enumerator
SL_WISUN_TRACE_GROUP_MAC	Mac.
SL_WISUN_TRACE_GROUP_NW	Network.
SL_WISUN_TRACE_GROUP_LLC	LLC.
SL_WISUN_TRACE_GROUP_6LO	6lowpan
SL_WISUN_TRACE_GROUP_IPV6	IPV6.
SL_WISUN_TRACE_GROUP_TCP	TCP.
SL_WISUN_TRACE_GROUP_UDP	UDP.
SL_WISUN_TRACE_GROUP_ICMP	ICMP.
SL_WISUN_TRACE_GROUP_DHCP	DHCP.
SL_WISUN_TRACE_GROUP_MPL	MPL.
SL_WISUN_TRACE_GROUP_DNS	DNS.
SL_WISUN_TRACE_GROUP_RPL	RPL.
SL_WISUN_TRACE_GROUP_TRIC	Trickle.
SL_WISUN_TRACE_GROUP_WS	Wi-SUN Stack.
SL_WISUN_TRACE_GROUP_BOOT	Wi-SUN Bootstrap.
SL_WISUN_TRACE_GROUP_WSR	Wi-SUN Router.
SL_WISUN_TRACE_GROUP_WSBR	Border router.
SL_WISUN_TRACE_GROUP_SEC	Security.
SL_WISUN_TRACE_GROUP_TIME	Time and timers.
SL_WISUN_TRACE_GROUP_NEIGH	Neighbor.
SL_WISUN_TRACE_GROUP_STAT	Statistics.
SL_WISUN_TRACE_GROUP_BUFF	Dynamic Buffer.
SL_WISUN_TRACE_GROUP_ADDR	Address Manipulation.
SL_WISUN_TRACE_GROUP_MON	Monitoring.
SL_WISUN_TRACE_GROUP_SOCK	Socket.
SL_WISUN_TRACE_GROUP_DENY	Deny list.
SL_WISUN_TRACE_GROUP_ETX	ETX.
SL_WISUN_TRACE_GROUP_FHSS	FHSS.
SL_WISUN_TRACE_GROUP_ROUT	Routing table.
SL_WISUN_TRACE_GROUP_EVLP	Event loop.
SL_WISUN_TRACE_GROUP_NVM	NVM.
SL_WISUN_TRACE_GROUP_CRYPTO	Crypto.
SL_WISUN_TRACE_GROUP_RF	Wi-SUN RF Driver.
Sl_WISUN_TRACE_GROUP_WSIE	Wi-SUN IE.
SL_WISUN_TRACE_GROUP_CONFIG	Configuration.
SL_WISUN_TRACE_GROUP_TIM_SRV	Timer service.
SL_WISUN_TRACE_GROUP_INT	Internal usage.
SL_WISUN_TRACE_GROUP_COUNT	Max number of trace group in this enum.

Definition at line 712 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_trace_level_t#

sl_wisun_trace_level_t

Enumerations for trace level.

Enumerator
SL_WISUN_TRACE_LEVEL_NONE	No trace.
SL_WISUN_TRACE_LEVEL_ERROR	Error only.
SL_WISUN_TRACE_LEVEL_WARN	Warning + error.
SL_WISUN_TRACE_LEVEL_INFO	Info + warning + error.
SL_WISUN_TRACE_LEVEL_DEBUG	Debug + info + warning + error.

Definition at line 755 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_regulation_t#

sl_wisun_regulation_t

Enumerations for regional regulation.

Enumerator
SL_WISUN_REGULATION_NONE	No regulation.
SL_WISUN_REGULATION_ARIB	ARIB, can only be used with JP regulatory domain.

Definition at line 778 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_mode_switch_mode_t#

sl_wisun_mode_switch_mode_t

Enumeration for Mode Switch mode.

Enumerator
SL_WISUN_MODE_SWITCH_DISABLED	Mode switch is not allowed.
SL_WISUN_MODE_SWITCH_ENABLED	Mode switch is allowed for all unicast data frames. Specified PhyModeId is used.
SL_WISUN_MODE_SWITCH_DEFAULT	Mode switch is allowed for all unicast data frames. Default PhyModeId is used.

Definition at line 792 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_regulation_tx_level_t#

sl_wisun_regulation_tx_level_t

Enumeration for regional regulation transmission level.

Thresholds are define with sl_wisun_set_regulation_tx_thresholds.

Enumerator
SL_WISUN_REGULATION_TX_LEVEL_LOW	Transmission duration is compliant with regional regulation.
SL_WISUN_REGULATION_TX_LEVEL_WARNING	Transmission duration is above warning threshold.
SL_WISUN_REGULATION_TX_LEVEL_ALERT	Transmission duration is above alert threshold.

Definition at line 803 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_unicast_tx_mode_t#

sl_wisun_unicast_tx_mode_t

Enumeration for unicast transmission mode.

Enumerator
SL_WISUN_UNICAST_TX_MODE_DEFAULT	Default unicast transmission.
SL_WISUN_UNICAST_TX_MODE_SLOT	Allow unicast transmission only on a slot.

Definition at line 813 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

sl_wisun_channel_exclusion_mode_t#

sl_wisun_channel_exclusion_mode_t

Enumeration for channel exlusion modes.

Enumerator
SL_WISUN_CHANNEL_EXCLUSION_MODE_BY_RANGE	Channels are excluded by range if possible (3 ranges maximum), otherwise channels will be excluded by mask.
SL_WISUN_CHANNEL_EXCLUSION_MODE_BY_MASK	Channels are excluded by mask.

Definition at line 824 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

Typedef Documentation#

sl_wisun_socket_id_t#

typedef uint32_t sl_wisun_socket_id_t

ID used identify a socket.

Definition at line 656 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

Variable Documentation#

sl_wisun_broadcast_mac#

const sl_wisun_mac_address_t sl_wisun_broadcast_mac

Broadcast MAC address.

Definition at line 821 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

Macro Definition Documentation#

SL_WISUN_NETWORK_NAME_SIZE#

#define SL_WISUN_NETWORK_NAME_SIZE

Value:

Maximum size of the Wi-SUN network name.

Definition at line 44 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

SL_WISUN_MAC_ADDRESS_SIZE#

#define SL_WISUN_MAC_ADDRESS_SIZE

Value:

Size of a MAC address.

Definition at line 46 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

SL_WISUN_IP_ADDRESS_SIZE#

#define SL_WISUN_IP_ADDRESS_SIZE

Value:

Size of an IPv6 address.

Definition at line 48 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

SL_WISUN_CHANNEL_MASK_SIZE#

#define SL_WISUN_CHANNEL_MASK_SIZE

Value:

Size of a channel mask.

Definition at line 50 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

SL_WISUN_FILTER_BITFIELD_SIZE#

#define SL_WISUN_FILTER_BITFIELD_SIZE

Value:

((SL_WISUN_TRACE_GROUP_COUNT + 7) / 8)

Size of the filter bitfield.

Definition at line 52 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

SL_WISUN_ADVERT_FRAGMENT_DISABLE#

#define SL_WISUN_ADVERT_FRAGMENT_DISABLE

Value:

UINT32_MAX

Maximum fragment duration. Disables advert fragmentation.

Definition at line 54 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

SL_WISUN_MAX_PHY_MODE_ID_COUNT#

#define SL_WISUN_MAX_PHY_MODE_ID_COUNT

Value:

Maximum number of PhyModeId allowed in POM-IE.

Definition at line 56 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

SL_WISUN_CHANNEL_SPACING_100HZ#

#define SL_WISUN_CHANNEL_SPACING_100HZ

Value:

SL_WISUN_CHANNEL_SPACING_100KHZ

Channel spacing 100 kHz for backward compatibility.

Definition at line 271 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

SL_WISUN_CHANNEL_SPACING_200HZ#

#define SL_WISUN_CHANNEL_SPACING_200HZ

Value:

SL_WISUN_CHANNEL_SPACING_200KHZ

Channel spacing 200 kHz for backward compatibility.

Definition at line 274 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

SL_WISUN_CHANNEL_SPACING_400HZ#

#define SL_WISUN_CHANNEL_SPACING_400HZ

Value:

SL_WISUN_CHANNEL_SPACING_400KHZ

Channel spacing 400 kHz for backward compatibility.

Definition at line 277 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

SL_WISUN_CHANNEL_SPACING_600HZ#

#define SL_WISUN_CHANNEL_SPACING_600HZ

Value:

SL_WISUN_CHANNEL_SPACING_600KHZ

Channel spacing 600 kHz for backward compatibility.

Definition at line 280 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h

SL_WISUN_INVALID_SOCKET_ID#

#define SL_WISUN_INVALID_SOCKET_ID

Value:

Socket ID value for an invalid socket.

Definition at line 659 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/wisun/stack/inc/sl_wisun_types.h