GNRC LoRaWAN internal header. More...

Detailed Description

GNRC LoRaWAN internal header.

Author: Jose Ignacio Alamos jose..nosp@m.alam.nosp@m.os@ha.nosp@m.w-ha.nosp@m.mburg.nosp@m..de

Definition in file gnrc_lorawan_internal.h.

#include <stdio.h>
#include <string.h>
#include "iolist.h"
#include "net/lora.h"
#include "net/lorawan/hdr.h"
#include "net/gnrc/pktbuf.h"
#include "net/netdev.h"
#include "net/loramac.h"

Include dependency graph for gnrc_lorawan_internal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	lorawan_buffer_t
	buffer helper for parsing and constructing LoRaWAN packets. More...

struct	mlme_lorawan_join_t
	MLME Join Request data. More...

struct	mlme_link_req_confirm_t
	MLME Link Check confirmation data. More...

struct	mcps_data_t
	MCPS data. More...

struct	gnrc_lorawan_mcps_t
	MCPS service access point descriptor. More...

struct	gnrc_lorawan_mlme_t
	MLME service access point descriptor. More...

struct	gnrc_lorawan_key_ctx_t
	GNRC LoRaWAN key context struct. More...

struct	gnrc_lorawan_t
	GNRC LoRaWAN mac descriptor. More...

struct	gnrc_lorawan_persistent_state_t
	LoRaWAN state that needs to be preserved across reboots. More...

#define	MSG_TYPE_TIMEOUT (0x3457)
	Timeout message type.

#define	MTYPE_MASK 0xE0
	MHDR mtype mask.

#define	MTYPE_JOIN_REQUEST 0x0
	Join Request type.

#define	MTYPE_JOIN_ACCEPT 0x1
	Join Accept type.

#define	MTYPE_UNCNF_UPLINK 0x2
	Unconfirmed uplink type.

#define	MTYPE_UNCNF_DOWNLINK 0x3
	Unconfirmed downlink type.

#define	MTYPE_CNF_UPLINK 0x4
	Confirmed uplink type.

#define	MTYPE_CNF_DOWNLINK 0x5
	Confirmed downlink type.

#define	MTYPE_REJOIN_REQ 0x6
	Re-join request type.

#define	MTYPE_PROPIETARY 0x7
	Proprietary frame type.

#define	MAJOR_MASK 0x3
	Major mtype mask.

#define	MAJOR_LRWAN_R1 0x0
	LoRaWAN R1 version type.

#define	MINOR_LRWAN 0x1
	Minor LoRaWAN version of device.

#define	JOIN_REQUEST_SIZE (23U)
	Join Request size in bytes.

#define	MIC_SIZE (4U)
	MIC size in bytes.

#define	CFLIST_SIZE (16U)
	Channel Frequency list size in bytes.

#define	GNRC_LORAWAN_MAX_CHANNELS (16U)
	Maximum number of channels.

#define	LORAWAN_STATE_IDLE (0)
	MAC state machine in idle.

#define	LORAWAN_STATE_RX_1 (1)
	MAC state machine in RX1.

#define	LORAWAN_STATE_RX_2 (2)
	MAC state machine in RX2.

#define	LORAWAN_STATE_TX (3)
	MAC state machine in TX.

#define	LORAWAN_STATE_JOIN (4)
	MAC state machine in Join.

#define	GNRC_LORAWAN_DIR_UPLINK (0U)
	uplink frame direction

#define	GNRC_LORAWAN_DIR_DOWNLINK (1U)
	downlink frame direction

#define	GNRC_LORAWAN_BACKOFF_WINDOW_TICK (3600000000LL)
	backoff expire tick in usecs (set to 1 second)

#define	GNRC_LORAWAN_BACKOFF_BUDGET_1 (36000000LL)
	budget of time on air during the first hour

#define	GNRC_LORAWAN_BACKOFF_BUDGET_2 (36000000LL)
	budget of time on air between 1-10 hours after boot

#define	GNRC_LORAWAN_BACKOFF_BUDGET_3 (8700000LL)
	budget of time on air every 24 hours

#define	GNRC_LORAWAN_MLME_OPTS_LINK_CHECK_REQ (1 << 0)
	Internal Link Check request flag.

#define	GNRC_LORAWAN_MLME_OPTS_REKEY_IND_REQ (1 << 1)
	Internal Rekey Indication flag.

#define	GNRC_LORAWAN_CID_SIZE (1U)
	size of Command ID in FOps

#define	GNRC_LORAWAN_CID_LINK_CHECK_ANS (0x02)
	Link Check CID.

#define	GNCR_LORAWAN_REKEY_IND_SIZE (1U)
	RekeyInd MAC command size.

#define	GNCR_LORAWAN_CID_REKEY_CONF (0x0B)
	Reykey Confirmation CID.

#define	GNRC_LORAWAN_FOPT_LINK_CHECK_ANS_SIZE (3U)
	size of Link check answer

#define	GNRC_LORAWAN_FOPT_REKEY_CONF_SIZE (2U)
	size of Rekey confirmation

#define	GNRC_LORAWAN_JOIN_DELAY_U32_MASK (0x1FFFFF)
	mask for detecting overflow in frame counter

#define	GNRC_LORAWAN_MAX_PAYLOAD_1 (59U)
	max MAC payload in DR0, DR1 and DR2

#define	GNRC_LORAWAN_MAX_PAYLOAD_2 (123U)
	max MAC payload in DR3

#define	GNRC_LORAWAN_MAX_PAYLOAD_3 (250U)
	max MAC payload above DR3

#define	GNRC_LORAWAN_CFLIST_ENTRY_SIZE (3U)
	size of Channel Frequency list

#define	GNRC_LORAWAN_JOIN_ACCEPT_MAX_SIZE (33U)
	max size of Join Accept frame

#define	GNRC_LORAWAN_BACKOFF_STATE_1 (0U)
	backoff state during the first hour after boot

#define	GNRC_LORAWAN_BACKOFF_STATE_2 (1U)
	backoff state between 1-10 hours after boot

#define	GNRC_LORAWAN_BACKOFF_STATE_3 (2U)
	backoff state past 11 hours after boot

#define	GNRC_LORAWAN_BACKOFF_TIME_1 (1U)
	duration of first backoff state (in hours)

#define	GNRC_LORAWAN_BACKOFF_TIME_2 (10U)
	duration of second backoff state (in hours)

#define	GNRC_LORAWAN_BACKOFF_TIME_3 (24U)
	duration of third backoff state (in hours)

#define	GNRC_LORAWAN_APP_NONCE_SIZE (3U)
	App Nonce size.

#define	GNRC_LORAWAN_JOIN_NONCE_SIZE (3U)
	Join nonce size.

#define	GNRC_LORAWAN_NET_ID_SIZE (3U)
	Net ID size.

#define	GNRC_LORAWAN_DEV_NONCE_SIZE (2U)
	Dev Nonce size.

#define	GNRC_LORAWAN_FOPTS_MAX_SIZE (15U)
	Maximum size of Fopts field.

#define	GNRC_LORAWAN_FPORT_SIZE (1U)
	Size of the Fport field.

#define	GNRC_LORAWAN_STATE_FLASHPAGE_NUM (FLASHPAGE_NUMOF - 0x4)
	Flashpage number where to store state.

#define	GNRC_LORAWAN_INITIALIZED_MARKER (0x52f94f54U)
	Persistent state initialized marker.

#define	MHDR_MIC_BUF_SIZE
	Size of the internal MHDR-MIC buffer. More...

enum	mlme_join_req_type_t { REJOIN_REQ_0 , REJOIN_REQ_1 , REJOIN_REQ_2 , JOIN_REQ = 0xFF }
	MLME Join Request type. More...

void	gnrc_lorawan_encrypt_payload (iolist_t iolist, const le_uint32_t dev_addr, uint32_t fcnt, uint8_t dir, const uint8_t *appskey)
	Encrypts LoRaWAN payload. More...

void	gnrc_lorawan_encrypt_fopts (uint8_t fopts, size_t len, const le_uint32_t dev_addr, uint32_t fcnt, bool afcnt, uint8_t dir, const uint8_t *key)
	Encrypts FOpts field. More...

void	gnrc_lorawan_decrypt_join_accept (const uint8_t key, uint8_t pkt, int has_clist, uint8_t *out)
	Decrypts join accept message. More...

void	gnrc_lorawan_generate_session_keys (const uint8_t join_nonce, const uint8_t dev_nonce, const uint8_t joineui, gnrc_lorawan_t mac)
	Generate LoRaWAN session keys. More...

void	gnrc_lorawan_generate_lifetime_session_keys (const uint8_t deveui, const uint8_t nwkkey, uint8_t jsintkey, uint8_t jsenckey)
	Generate LoRaWAN 1.1x lifetime session keys. More...

int	gnrc_lorawan_set_dr (gnrc_lorawan_t *mac, uint8_t datarate)
	Set datarate for the next transmission. More...

size_t	gnrc_lorawan_build_uplink (gnrc_lorawan_t mac, iolist_t payload, int confirmed_data, uint8_t port)
	build uplink frame More...

uint8_t	gnrc_lorawan_pick_channel (gnrc_lorawan_t *mac)
	pick a random available LoRaWAN channel More...

uint8_t	gnrc_lorawan_build_options (gnrc_lorawan_t mac, lorawan_buffer_t buf)
	Build fopts header. More...

void	gnrc_lorawan_process_fopts (gnrc_lorawan_t mac, uint8_t fopts, size_t size)
	Process an fopts frame. More...

void	gnrc_lorawan_calculate_join_req_mic (const uint8_t buf, size_t len, uint8_t key, le_uint32_t *out)
	Calculate join-request Message Integrity Code. More...

void	gnrc_lorawan_calculate_join_acpt_mic (const uint8_t buf, size_t len, gnrc_lorawan_t mac, le_uint32_t *out)
	Calculate join-accept Message Integrity Code. More...

void	gnrc_lorawan_calculate_mic_uplink (iolist_t frame, uint16_t conf_fcnt, gnrc_lorawan_t mac, le_uint32_t *out)
	Calculate Message Integrity Code for an uplink MCPS message. More...

void	gnrc_lorawan_calculate_mic_downlink (const le_uint32_t dev_addr, uint32_t fcnt, uint16_t conf_fcnt, iolist_t frame, const uint8_t snwksintkey, le_uint32_t out)
	Calculate Message Integrity Code for downlink MCPS message. More...

size_t	gnrc_lorawan_build_hdr (uint8_t mtype, le_uint32_t dev_addr, uint32_t fcnt, uint8_t ack, uint8_t fopts_length, lorawan_buffer_t buf)
	Build a MCPS LoRaWAN header. More...

void	gnrc_lorawan_mcps_process_downlink (gnrc_lorawan_t mac, uint8_t psdu, size_t size)
	Process an MCPS downlink message (confirmable or non comfirmable) More...

void	gnrc_lorawan_channels_init (gnrc_lorawan_t *mac)
	Init regional channel settings. More...

void	gnrc_lorawan_reset (gnrc_lorawan_t *mac)
	Reset MAC parameters. More...

void	gnrc_lorawan_send_pkt (gnrc_lorawan_t mac, iolist_t psdu, uint8_t dr, uint32_t chan)
	Send a LoRaWAN packet. More...

void	gnrc_lorawan_mlme_process_join (gnrc_lorawan_t mac, uint8_t data, size_t size)
	Process join accept message. More...

void	gnrc_lorawan_mlme_no_rx (gnrc_lorawan_t *mac)
	Inform the MAC layer that no packet was received during reception. More...

void	gnrc_lorawan_event_no_rx (gnrc_lorawan_t *mac)
	Mac callback for no RX. More...

void	gnrc_lorawan_event_retrans_timeout (gnrc_lorawan_t *mac)
	Mac callback for retransmission timeout event. More...

uint8_t	gnrc_lorawan_region_mac_payload_max (uint8_t datarate)
	Get the maximum MAC payload (M value) for a given datarate. More...

void	gnrc_lorawan_mlme_backoff_expire_cb (gnrc_lorawan_t *mac)
	MLME Backoff expiration tick. More...

void	gnrc_lorawan_process_pkt (gnrc_lorawan_t mac, iolist_t pkt)
	Process and dispatch a full LoRaWAN packet. More...

void	gnrc_lorawan_open_rx_window (gnrc_lorawan_t *mac)
	Open a reception window. More...

void	gnrc_lorawan_perform_save (gnrc_lorawan_t *mac)
	save internal MAC state in non-volatile storage and shutdown the MAC layer gracefully. More...

static int	gnrc_lorawan_mac_acquire (gnrc_lorawan_t *mac)
	Acquire the MAC layer. More...

static void	gnrc_lorawan_mac_release (gnrc_lorawan_t *mac)
	Release the MAC layer. More...

void	gnrc_lorawan_set_rx2_dr (gnrc_lorawan_t *mac, uint8_t rx2_dr)
	Set the datarate of the second reception window. More...

void	gnrc_lorawan_trigger_join (gnrc_lorawan_t *mac)
	Trigger the transmission of the Join Request packet. More...

void	gnrc_lorawan_store_dev_nonce (uint8_t *dev_nonce)
	Store DevNonce in flash memory. More...

static bool	gnrc_lorawan_optneg_is_set (const gnrc_lorawan_t *mac)
	Check whether OptNeg bit is set. More...

static void	gnrc_lorawan_set_optneg (gnrc_lorawan_t *mac, uint8_t optneg)
	Set OptNeg bit in the MAC descriptor. More...

static uint8_t *	gnrc_lorawan_get_jsintkey (const gnrc_lorawan_t *mac)
	Get the join session integrity key from the MAC descriptor. More...

static uint8_t *	gnrc_lorawan_get_jsenckey (const gnrc_lorawan_t *mac)
	Get the join session encryption key from the MAC descriptor. More...

static uint32_t	gnrc_lorawan_get_afcnt_down (const gnrc_lorawan_t *mac)
	Get the application downlink frame counter from the MAC descriptor. More...

static void	gnrc_lorawan_set_afcnt_down (gnrc_lorawan_t *mac, uint32_t afcnt_down)
	Set the application downlink frame counter in the MAC descriptor. More...

static uint32_t	gnrc_lorawan_get_last_fcnt_down (const gnrc_lorawan_t *mac)
	Get the last downlink frame counter from the MAC descriptor. More...

static void	gnrc_lorawan_set_last_fcnt_down (gnrc_lorawan_t *mac, uint32_t last_fcnt_down)
	Set the last downlink frame counter in the MAC descriptor. More...

static uint8_t *	gnrc_lorawan_mlme_join_get_appkey (const mlme_lorawan_join_t *mlme_join)
	Get the app key from the MLME join request data. More...

static void	gnrc_lorawan_mlme_join_set_appkey (mlme_lorawan_join_t mlme_join, uint8_t key)
	Se the app key in the MLME join request data. More...

Macro Definition Documentation

◆ MHDR_MIC_BUF_SIZE

#define MHDR_MIC_BUF_SIZE

Value:

                           (sizeof(lorawan_hdr_t) + \
                           GNRC_LORAWAN_FOPTS_MAX_SIZE + \
                           GNRC_LORAWAN_FPORT_SIZE + \
                           MIC_SIZE)

Size of the internal MHDR-MIC buffer.

Definition at line 120 of file gnrc_lorawan_internal.h.

Enumeration Type Documentation

◆ mlme_join_req_type_t

enum mlme_join_req_type_t

MLME Join Request type.

Enumerator
REJOIN_REQ_0	Rejoin-request type 0.
REJOIN_REQ_1	Rejoin-request type 1.
REJOIN_REQ_2	Rejoin-request type 2.
JOIN_REQ	Join-request type.

Definition at line 150 of file gnrc_lorawan_internal.h.

Function Documentation

◆ gnrc_lorawan_build_hdr()

size_t gnrc_lorawan_build_hdr	(	uint8_t	mtype,
		le_uint32_t *	dev_addr,
		uint32_t	fcnt,
		uint8_t	ack,
		uint8_t	fopts_length,
		lorawan_buffer_t *	buf
	)

Build a MCPS LoRaWAN header.

Parameters

[in]	mtype	the MType of the header
[in]	dev_addr	the Device Address
[in]	fcnt	frame counter
[in]	ack	true if ACK bit is set
[in]	fopts_length	the length of the FOpts field
[out]	buf	destination buffer of the hdr

Returns: the size of the header

◆ gnrc_lorawan_build_options()

uint8_t gnrc_lorawan_build_options	(	gnrc_lorawan_t *	mac,
		lorawan_buffer_t *	buf
	)

Build fopts header.

Parameters

[in]	mac	pointer to MAC descriptor
[out]	buf	destination buffer of fopts. If NULL, this function just returns the size of the expected fopts frame.

Returns: size of the fopts frame

◆ gnrc_lorawan_build_uplink()

size_t gnrc_lorawan_build_uplink	(	gnrc_lorawan_t *	mac,
		iolist_t *	payload,
		int	confirmed_data,
		uint8_t	port
	)

build uplink frame

Parameters

[in]	mac	pointer to MAC descriptor
[in]	payload	packet containing payload
[in]	confirmed_data	true if confirmed frame
[in]	port	MAC port

Returns: full LoRaWAN frame including payload; NULL if packet buffer is full. payload is released

◆ gnrc_lorawan_calculate_join_acpt_mic()

void gnrc_lorawan_calculate_join_acpt_mic	(	const uint8_t *	buf,
		size_t	len,
		gnrc_lorawan_t *	mac,
		le_uint32_t *	out
	)

Calculate join-accept Message Integrity Code.

Parameters

[in]	buf	pointer to the frame
[in]	len	length of the frame
[in]	mac	pointer to MAC descriptor
[out]	out	calculated MIC

◆ gnrc_lorawan_calculate_join_req_mic()

void gnrc_lorawan_calculate_join_req_mic	(	const uint8_t *	buf,
		size_t	len,
		uint8_t *	key,
		le_uint32_t *	out
	)

Calculate join-request Message Integrity Code.

Parameters

[in]	buf	pointer to the frame
[in]	len	length of the frame
[in]	key	key to be used to calculate the MIC
[out]	out	calculated MIC

◆ gnrc_lorawan_calculate_mic_downlink()

void gnrc_lorawan_calculate_mic_downlink	(	const le_uint32_t *	dev_addr,
		uint32_t	fcnt,
		uint16_t	conf_fcnt,
		iolist_t *	frame,
		const uint8_t *	snwksintkey,
		le_uint32_t *	out
	)

Calculate Message Integrity Code for downlink MCPS message.

Parameters

[in]	dev_addr	the Device Address
[in]	fcnt	frame counter
[in]	conf_fcnt	frame counter value of confirmed uplink frame
[in]	frame	pointer to the PSDU frame (without MIC)
[in]	snwksintkey	pointer to serving network session integrity key
[out]	out	calculated MIC

◆ gnrc_lorawan_calculate_mic_uplink()

void gnrc_lorawan_calculate_mic_uplink	(	iolist_t *	frame,
		uint16_t	conf_fcnt,
		gnrc_lorawan_t *	mac,
		le_uint32_t *	out
	)

Calculate Message Integrity Code for an uplink MCPS message.

Parameters

[in]	frame	pointer to the PSDU frame (without MIC)
[in]	conf_fcnt	frame counter value of confirmed uplink frame. Always zero if using LoRaWAN 1.0x
[in]	mac	pointer to MAC descriptor
[out]	out	calculated MIC

◆ gnrc_lorawan_channels_init()

void gnrc_lorawan_channels_init ( gnrc_lorawan_t * mac )

Init regional channel settings.

   Intended to be called upon initialization

Parameters

[in] mac pointer to the MAC descriptor

◆ gnrc_lorawan_decrypt_join_accept()

void gnrc_lorawan_decrypt_join_accept	(	const uint8_t *	key,
		uint8_t *	pkt,
		int	has_clist,
		uint8_t *	out
	)

Decrypts join accept message.

Parameters

[in]	key	key to be used in the decryption
[in]	pkt	pointer to Join Accept MAC component (next byte after the MHDR)
[in]	has_clist	true if the Join Accept frame has CFList
[out]	out	buffer where the decryption is stored

◆ gnrc_lorawan_encrypt_fopts()

void gnrc_lorawan_encrypt_fopts	(	uint8_t *	fopts,
		size_t	len,
		const le_uint32_t *	dev_addr,
		uint32_t	fcnt,
		bool	afcnt,
		uint8_t	dir,
		const uint8_t *	key
	)

Encrypts FOpts field.

Note: This function is also used for decrypting the FOpts field. The LoRaWAN server encrypts the packet using decryption, so the end device only needs to implement encryption; This function is used only in LoRaWAN 1.1

Parameters

[in]	fopts	pointer to fopts
[in]	len	length of fopts
[in]	dev_addr	device address
[in]	fcnt	frame counter
[in]	afcnt	flag indicating if aFCntDown is used
[in]	dir	direction of the packet (0 if uplink, 1 if downlink)
[in]	key	pointer to key

◆ gnrc_lorawan_encrypt_payload()

void gnrc_lorawan_encrypt_payload	(	iolist_t *	iolist,
		const le_uint32_t *	dev_addr,
		uint32_t	fcnt,
		uint8_t	dir,
		const uint8_t *	appskey
	)

Encrypts LoRaWAN payload.

Note: This function is also used for decrypting a LoRaWAN packet. The LoRaWAN server encrypts the packet using decryption, so the end device only needs to implement encryption

Parameters

[in]	iolist	pointer to the MSDU frame
[in]	dev_addr	device address
[in]	fcnt	frame counter
[in]	dir	direction of the packet (0 if uplink, 1 if downlink)
[in]	appskey	pointer to the Application Session Key

◆ gnrc_lorawan_event_no_rx()

void gnrc_lorawan_event_no_rx ( gnrc_lorawan_t * mac )

Mac callback for no RX.

Parameters

[in] mac pointer to the MAC descriptor

◆ gnrc_lorawan_event_retrans_timeout()

void gnrc_lorawan_event_retrans_timeout ( gnrc_lorawan_t * mac )

Mac callback for retransmission timeout event.

Parameters

[in] mac pointer to the MAC descriptor

◆ gnrc_lorawan_generate_lifetime_session_keys()

void gnrc_lorawan_generate_lifetime_session_keys	(	const uint8_t *	deveui,
		const uint8_t *	nwkkey,
		uint8_t *	jsintkey,
		uint8_t *	jsenckey
	)

Generate LoRaWAN 1.1x lifetime session keys.

Called in order to derive JSIntKey and JSEncKey.

LoRaWAN specification 1.1 section 6.1.1.4

Parameters

[in]	deveui	pointer to the join_nonce of the Join Accept message
[in]	nwkkey	pointer to the Network key
[out]	jsintkey	pointer to the Join session integrity key
[out]	jsenckey	pointer to the Join session encryption key

◆ gnrc_lorawan_generate_session_keys()

void gnrc_lorawan_generate_session_keys	(	const uint8_t *	join_nonce,
		const uint8_t *	dev_nonce,
		const uint8_t *	joineui,
		gnrc_lorawan_t *	mac
	)

Generate LoRaWAN session keys.

Intended to be called after a successful Join Request in order to generate AppSKey, SNwkSIntKey, FNwkSIntKey and NwkSEncKey

Parameters

[in]	join_nonce	pointer to the join_nonce of the Join Accept message
[in]	dev_nonce	pointer to the dev_nonce buffer
[in]	joineui	pointer to the Join EUI. NULL if LoRaWAN 1.0x
[in,out]	mac	pointer to the LoRaWAN mac descriptor

◆ gnrc_lorawan_get_afcnt_down()

static uint32_t gnrc_lorawan_get_afcnt_down ( const gnrc_lorawan_t * mac )

inlinestatic

Get the application downlink frame counter from the MAC descriptor.

This getter function exists to allow if (IS_USED(...)) constructs in the LoRaWAN code in order to increase code coverage.

Parameters

[in] mac pointer to the MAC descriptor

Returns: application downlink frame counter

Definition at line 710 of file gnrc_lorawan_internal.h.

◆ gnrc_lorawan_get_jsenckey()

static uint8_t* gnrc_lorawan_get_jsenckey ( const gnrc_lorawan_t * mac )

inlinestatic

Get the join session encryption key from the MAC descriptor.

This getter function exists to allow if (IS_USED(...)) constructs in the LoRaWAN code in order to increase code coverage.

Parameters

[in] mac pointer to the MAC descriptor

Returns: pointer to join session encryption key

Definition at line 691 of file gnrc_lorawan_internal.h.

◆ gnrc_lorawan_get_jsintkey()

static uint8_t* gnrc_lorawan_get_jsintkey ( const gnrc_lorawan_t * mac )

inlinestatic

Get the join session integrity key from the MAC descriptor.

This getter function exists to allow if (IS_USED(...)) constructs in the LoRaWAN code in order to increase code coverage.

Parameters

[in] mac pointer to the MAC descriptor

Returns: pointer to join session integrity key

Definition at line 672 of file gnrc_lorawan_internal.h.

◆ gnrc_lorawan_get_last_fcnt_down()

static uint32_t gnrc_lorawan_get_last_fcnt_down ( const gnrc_lorawan_t * mac )

inlinestatic

Get the last downlink frame counter from the MAC descriptor.

This getter function exists to allow if (IS_USED(...)) constructs in the LoRaWAN code in order to increase code coverage.

Parameters

[in] mac pointer to the MAC descriptor

Definition at line 747 of file gnrc_lorawan_internal.h.

◆ gnrc_lorawan_mac_acquire()

static int gnrc_lorawan_mac_acquire ( gnrc_lorawan_t * mac )

inlinestatic

Acquire the MAC layer.

Parameters

[in] mac pointer to the MAC descriptor

Returns: true on success; false if MAC is already acquired

Definition at line 578 of file gnrc_lorawan_internal.h.

◆ gnrc_lorawan_mac_release()

static void gnrc_lorawan_mac_release ( gnrc_lorawan_t * mac )

inlinestatic

Release the MAC layer.

Parameters

[in] mac pointer to the MAC descriptor

Definition at line 591 of file gnrc_lorawan_internal.h.

◆ gnrc_lorawan_mcps_process_downlink()

void gnrc_lorawan_mcps_process_downlink	(	gnrc_lorawan_t *	mac,
		uint8_t *	psdu,
		size_t	size
	)

Process an MCPS downlink message (confirmable or non comfirmable)

Parameters

[in]	mac	pointer to the MAC descriptor
[in]	psdu	pointer to the downlink PSDU
[in]	size	size of the PSDU

◆ gnrc_lorawan_mlme_backoff_expire_cb()

void gnrc_lorawan_mlme_backoff_expire_cb ( gnrc_lorawan_t * mac )

MLME Backoff expiration tick.

   Must be called once an hour (right after calling @ref
   gnrc_lorawan_init) in order to maintain the Time On Air budget.

Parameters

[in] mac pointer to the MAC descriptor

◆ gnrc_lorawan_mlme_join_get_appkey()

static uint8_t* gnrc_lorawan_mlme_join_get_appkey ( const mlme_lorawan_join_t * mlme_join )

inlinestatic

Get the app key from the MLME join request data.

This getter function exists to allow if (IS_USED(...)) constructs in the LoRaWAN code in order to increase code coverage.

Parameters

[in] mlme_join pointer to the MLME join request data

Returns: pointer to the app key

Definition at line 784 of file gnrc_lorawan_internal.h.

◆ gnrc_lorawan_mlme_join_set_appkey()

static void gnrc_lorawan_mlme_join_set_appkey	(	mlme_lorawan_join_t *	mlme_join,
		uint8_t *	key
	)

inlinestatic

Se the app key in the MLME join request data.

This getter function exists to allow if (IS_USED(...)) constructs in the LoRaWAN code in order to increase code coverage.

Parameters

[in]	mlme_join	pointer to the MLME join request data
[in]	key	pointer to the app key

Definition at line 804 of file gnrc_lorawan_internal.h.

◆ gnrc_lorawan_mlme_no_rx()

void gnrc_lorawan_mlme_no_rx ( gnrc_lorawan_t * mac )

Inform the MAC layer that no packet was received during reception.

   To be called when the radio reports "NO RX" after the second reception
   window

Parameters

[in] mac pointer to the MAC descriptor

◆ gnrc_lorawan_mlme_process_join()

void gnrc_lorawan_mlme_process_join	(	gnrc_lorawan_t *	mac,
		uint8_t *	data,
		size_t	size
	)

Process join accept message.

Parameters

[in]	mac	pointer to the MAC descriptor
[in]	data	the Join Accept packet
[in]	size	size of the Join Accept packet

◆ gnrc_lorawan_open_rx_window()

void gnrc_lorawan_open_rx_window ( gnrc_lorawan_t * mac )

Open a reception window.

   This is called by the MAC layer on timeout event.

Parameters

[in] mac pointer to the MAC descriptor

◆ gnrc_lorawan_optneg_is_set()

static bool gnrc_lorawan_optneg_is_set ( const gnrc_lorawan_t * mac )

inlinestatic

Check whether OptNeg bit is set.

When using LoRaWAN 1.1x the OptNeg bit indicates whether the Network Server implements the LoRaWAN1.0 protocol version (unset) or 1.1 and later (set).

This getter function exists to allow if (IS_USED(...)) constructs in the LoRaWAN code in order to increase code coverage.

Parameters

[in] mac pointer to the MAC descriptor

Returns: true if OptNeg bit is set; false if OptNeg bit is unset

Definition at line 631 of file gnrc_lorawan_internal.h.

◆ gnrc_lorawan_perform_save()

void gnrc_lorawan_perform_save ( gnrc_lorawan_t * mac )

save internal MAC state in non-volatile storage and shutdown the MAC layer gracefully.

Parameters

mac

◆ gnrc_lorawan_pick_channel()

uint8_t gnrc_lorawan_pick_channel ( gnrc_lorawan_t * mac )

pick a random available LoRaWAN channel

Parameters

[in] mac pointer to the MAC descriptor

Returns: index of free channel inside channel array

◆ gnrc_lorawan_process_fopts()

void gnrc_lorawan_process_fopts	(	gnrc_lorawan_t *	mac,
		uint8_t *	fopts,
		size_t	size
	)

Process an fopts frame.

Parameters

[in]	mac	pointer to MAC descriptor
[in]	fopts	pointer to fopts frame
[in]	size	size of fopts frame

◆ gnrc_lorawan_process_pkt()

void gnrc_lorawan_process_pkt	(	gnrc_lorawan_t *	mac,
		iolist_t *	pkt
	)

Process and dispatch a full LoRaWAN packet.

   Intended to be called right after reception from the radio

Parameters

[in]	mac	pointer to the MAC descriptor
[in]	pkt	the received packet

◆ gnrc_lorawan_region_mac_payload_max()

uint8_t gnrc_lorawan_region_mac_payload_max ( uint8_t datarate )

Get the maximum MAC payload (M value) for a given datarate.

Note: This function is region specific

Parameters

[in] datarate datarate

Returns: the maximum allowed size of the packet

◆ gnrc_lorawan_reset()

void gnrc_lorawan_reset ( gnrc_lorawan_t * mac )

Reset MAC parameters.

Note: This doesn't affect backoff timers variables.

Parameters

[in] mac pointer to the MAC layer

◆ gnrc_lorawan_send_pkt()

void gnrc_lorawan_send_pkt	(	gnrc_lorawan_t *	mac,
		iolist_t *	psdu,
		uint8_t	dr,
		uint32_t	chan
	)

Send a LoRaWAN packet.

Parameters

[in]	mac	pointer to the MAC descriptor
[in]	psdu	the psdu frame to be sent
[in]	dr	the datarate used for the transmission
[in]	chan	the channel used for transmission

◆ gnrc_lorawan_set_afcnt_down()

static void gnrc_lorawan_set_afcnt_down	(	gnrc_lorawan_t *	mac,
		uint32_t	afcnt_down
	)

inlinestatic

Set the application downlink frame counter in the MAC descriptor.

This getter function exists to allow if (IS_USED(...)) constructs in the LoRaWAN code in order to increase code coverage.

Parameters

[in]	mac	pointer to the MAC descriptor
[in]	afcnt_down	application downlink frame counter

Definition at line 729 of file gnrc_lorawan_internal.h.

◆ gnrc_lorawan_set_dr()

int gnrc_lorawan_set_dr	(	gnrc_lorawan_t *	mac,
		uint8_t	datarate
	)

Set datarate for the next transmission.

Parameters

[in]	mac	pointer to the MAC descriptor
[in]	datarate	desired datarate

Returns: 0 on success; -EINVAL if datarate is not available in the current region

◆ gnrc_lorawan_set_last_fcnt_down()

static void gnrc_lorawan_set_last_fcnt_down	(	gnrc_lorawan_t *	mac,
		uint32_t	last_fcnt_down
	)

inlinestatic

Set the last downlink frame counter in the MAC descriptor.

This getter function exists to allow if (IS_USED(...)) constructs in the LoRaWAN code in order to increase code coverage.

Parameters

[in]	mac	pointer to the MAC descriptor
[in]	last_fcnt_down	last downlink frame counter

Definition at line 766 of file gnrc_lorawan_internal.h.

◆ gnrc_lorawan_set_optneg()

static void gnrc_lorawan_set_optneg	(	gnrc_lorawan_t *	mac,
		uint8_t	optneg
	)

inlinestatic

Set OptNeg bit in the MAC descriptor.

When using LoRaWAN 1.1x the OptNeg bit indicates whether the Network Server implements the LoRaWAN1.0 protocol version (unset) or 1.1 and later (set).

This setter function exists to allow if (IS_USED(...)) constructs in the LoRaWAN code in order to increase code coverage.

Parameters

[in]	mac	pointer to the MAC descriptor
[in]	optneg	OptNeg bit

Definition at line 653 of file gnrc_lorawan_internal.h.

◆ gnrc_lorawan_set_rx2_dr()

void gnrc_lorawan_set_rx2_dr	(	gnrc_lorawan_t *	mac,
		uint8_t	rx2_dr
	)

Set the datarate of the second reception window.

Parameters

[in]	mac	pointer to the MAC descriptor
[in]	rx2_dr	datarate of RX2

◆ gnrc_lorawan_store_dev_nonce()

void gnrc_lorawan_store_dev_nonce ( uint8_t * dev_nonce )

Store DevNonce in flash memory.

Parameters

[in] dev_nonce pointer to the DevNonce

◆ gnrc_lorawan_trigger_join()

void gnrc_lorawan_trigger_join ( gnrc_lorawan_t * mac )

Trigger the transmission of the Join Request packet.

Parameters

[in] mac pointer to the MAC descriptor

Detailed Description

Data Structures

Macro Definition Documentation

◆ MHDR_MIC_BUF_SIZE

Enumeration Type Documentation

◆ mlme_join_req_type_t

Function Documentation

◆ gnrc_lorawan_build_hdr()

◆ gnrc_lorawan_build_options()

◆ gnrc_lorawan_build_uplink()

◆ gnrc_lorawan_calculate_join_acpt_mic()

◆ gnrc_lorawan_calculate_join_req_mic()

◆ gnrc_lorawan_calculate_mic_downlink()

◆ gnrc_lorawan_calculate_mic_uplink()

◆ gnrc_lorawan_channels_init()

◆ gnrc_lorawan_decrypt_join_accept()

◆ gnrc_lorawan_encrypt_fopts()

◆ gnrc_lorawan_encrypt_payload()

◆ gnrc_lorawan_event_no_rx()

◆ gnrc_lorawan_event_retrans_timeout()

◆ gnrc_lorawan_generate_lifetime_session_keys()

◆ gnrc_lorawan_generate_session_keys()

◆ gnrc_lorawan_get_afcnt_down()

◆ gnrc_lorawan_get_jsenckey()

◆ gnrc_lorawan_get_jsintkey()

◆ gnrc_lorawan_get_last_fcnt_down()

◆ gnrc_lorawan_mac_acquire()

◆ gnrc_lorawan_mac_release()

◆ gnrc_lorawan_mcps_process_downlink()

◆ gnrc_lorawan_mlme_backoff_expire_cb()

◆ gnrc_lorawan_mlme_join_get_appkey()

◆ gnrc_lorawan_mlme_join_set_appkey()

◆ gnrc_lorawan_mlme_no_rx()

◆ gnrc_lorawan_mlme_process_join()

◆ gnrc_lorawan_open_rx_window()

◆ gnrc_lorawan_optneg_is_set()

◆ gnrc_lorawan_perform_save()

◆ gnrc_lorawan_pick_channel()

◆ gnrc_lorawan_process_fopts()

◆ gnrc_lorawan_process_pkt()

◆ gnrc_lorawan_region_mac_payload_max()

◆ gnrc_lorawan_reset()

◆ gnrc_lorawan_send_pkt()

◆ gnrc_lorawan_set_afcnt_down()

◆ gnrc_lorawan_set_dr()

◆ gnrc_lorawan_set_last_fcnt_down()

◆ gnrc_lorawan_set_optneg()

◆ gnrc_lorawan_set_rx2_dr()

◆ gnrc_lorawan_store_dev_nonce()

◆ gnrc_lorawan_trigger_join()