#include <stdint.h>
#include <string.h>

Include dependency graph for rf_mailbox.h:

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

Data Structures
struct	dataQueue_t
	Type definition for a data queue. More...

Macros
RF mode values
Defines used to indicate mode of operation to radio core.
#define	RF_MODE_AUTO 0x00

#define	RF_MODE_BLE 0x00

#define	RF_MODE_IEEE_15_4 0x00

#define	RF_MODE_PROPRIETARY_2_4 0x00

#define	RF_MODE_PROPRIETARY RF_MODE_PROPRIETARY_2_4

#define	RF_MODE_MULTIPLE 0x00

CPE interrupt definitions
Interrupt masks for the CPE interrupt in RDBELL.
#define	IRQN_COMMAND_DONE 0
	Radio operation command finished. More...

#define	IRQN_LAST_COMMAND_DONE 1
	Last radio operation command in a chain finished. More...

#define	IRQN_FG_COMMAND_DONE 2
	FG level Radio operation command finished. More...

#define	IRQN_LAST_FG_COMMAND_DONE 3
	Last FG level radio operation command in a chain finished. More...

#define	IRQN_TX_DONE 4
	Packet transmitted. More...

#define	IRQN_TX_ACK 5
	ACK packet transmitted. More...

#define	IRQN_TX_CTRL 6
	Control packet transmitted. More...

#define	IRQN_TX_CTRL_ACK 7
	Acknowledgement received on a transmitted control packet. More...

#define	IRQN_TX_CTRL_ACK_ACK 8
	Acknowledgement received on a transmitted control packet, and acknowledgement transmitted for that packet. More...

#define	IRQN_TX_RETRANS 9
	Packet retransmitted. More...

#define	IRQN_TX_ENTRY_DONE 10
	Tx queue data entry state changed to Finished. More...

#define	IRQN_TX_BUFFER_CHANGED 11
	A buffer change is complete. More...

#define	IRQN_COMMAND_STARTED 12
	A radio operation command has gone into active state. More...

#define	IRQN_FG_COMMAND_STARTED 13
	FG level radio operation command has gone into active state. More...

#define	IRQN_PA_CHANGED 14
	PA is changed. More...

#define	IRQN_RX_OK 16
	Packet received with CRC OK, payload, and not to be ignored. More...

#define	IRQN_RX_NOK 17
	Packet received with CRC error. More...

#define	IRQN_RX_IGNORED 18
	Packet received with CRC OK, but to be ignored. More...

#define	IRQN_RX_EMPTY 19
	Packet received with CRC OK, not to be ignored, no payload. More...

#define	IRQN_RX_CTRL 20
	Control packet received with CRC OK, not to be ignored. More...

#define	IRQN_RX_CTRL_ACK 21
	Control packet received with CRC OK, not to be ignored, then ACK sent. More...

#define	IRQN_RX_BUF_FULL 22
	Packet received that did not fit in the Rx queue. More...

#define	IRQN_RX_ENTRY_DONE 23
	Rx queue data entry changing state to Finished. More...

#define	IRQN_RX_DATA_WRITTEN 24
	Data written to partial read Rx buffer. More...

#define	IRQN_RX_N_DATA_WRITTEN 25
	Specified number of bytes written to partial read Rx buffer. More...

#define	IRQN_RX_ABORTED 26
	Packet reception stopped before packet was done. More...

#define	IRQN_RX_COLLISION_DETECTED 27
	A collision was indicated during packet reception. More...

#define	IRQN_SYNTH_NO_LOCK 28
	The synth has gone out of lock after calibration. More...

#define	IRQN_MODULES_UNLOCKED 29
	As part of the boot process, the CM0 has opened access to RF core modules and memories. More...

#define	IRQN_BOOT_DONE 30
	The RF core CPU boot is finished. More...

#define	IRQN_INTERNAL_ERROR 31
	Internal error observed. More...

#define	IRQ_COMMAND_DONE (1U << IRQN_COMMAND_DONE)

#define	IRQ_LAST_COMMAND_DONE (1U << IRQN_LAST_COMMAND_DONE)

#define	IRQ_FG_COMMAND_DONE (1U << IRQN_FG_COMMAND_DONE)

#define	IRQ_LAST_FG_COMMAND_DONE (1U << IRQN_LAST_FG_COMMAND_DONE)

#define	IRQ_TX_DONE (1U << IRQN_TX_DONE)

#define	IRQ_TX_ACK (1U << IRQN_TX_ACK)

#define	IRQ_TX_CTRL (1U << IRQN_TX_CTRL)

#define	IRQ_TX_CTRL_ACK (1U << IRQN_TX_CTRL_ACK)

#define	IRQ_TX_CTRL_ACK_ACK (1U << IRQN_TX_CTRL_ACK_ACK)

#define	IRQ_TX_RETRANS (1U << IRQN_TX_RETRANS)

#define	IRQ_TX_ENTRY_DONE (1U << IRQN_TX_ENTRY_DONE)

#define	IRQ_TX_BUFFER_CHANGED (1U << IRQN_TX_BUFFER_CHANGED)

#define	IRQ_COMMAND_STARTED (1U << IRQN_COMMAND_STARTED)

#define	IRQ_FG_COMMAND_STARTED (1U << IRQN_FG_COMMAND_STARTED)

#define	IRQ_PA_CHANGED (1U << IRQN_PA_CHANGED)

#define	IRQ_RX_OK (1U << IRQN_RX_OK)

#define	IRQ_RX_NOK (1U << IRQN_RX_NOK)

#define	IRQ_RX_IGNORED (1U << IRQN_RX_IGNORED)

#define	IRQ_RX_EMPTY (1U << IRQN_RX_EMPTY)

#define	IRQ_RX_CTRL (1U << IRQN_RX_CTRL)

#define	IRQ_RX_CTRL_ACK (1U << IRQN_RX_CTRL_ACK)

#define	IRQ_RX_BUF_FULL (1U << IRQN_RX_BUF_FULL)

#define	IRQ_RX_ENTRY_DONE (1U << IRQN_RX_ENTRY_DONE)

#define	IRQ_RX_DATA_WRITTEN (1U << IRQN_RX_DATA_WRITTEN)

#define	IRQ_RX_N_DATA_WRITTEN (1U << IRQN_RX_N_DATA_WRITTEN)

#define	IRQ_RX_ABORTED (1U << IRQN_RX_ABORTED)

#define	IRQ_RX_COLLISION_DETECTED (1U << IRQN_RX_COLLISION_DETECTED)

#define	IRQ_SYNTH_NO_LOCK (1U << IRQN_SYNTH_NO_LOCK)

#define	IRQ_MODULES_UNLOCKED (1U << IRQN_MODULES_UNLOCKED)

#define	IRQ_BOOT_DONE (1U << IRQN_BOOT_DONE)

#define	IRQ_INTERNAL_ERROR (1U << IRQN_INTERNAL_ERROR)

CMDSTA values
Values returned in result byte of CMDSTA
#define	CMDSTA_Pending 0x00
	The command has not yet been parsed. More...

#define	CMDSTA_Done 0x01
	Command successfully parsed. More...

#define	CMDSTA_IllegalPointer 0x81
	The pointer signaled in CMDR is not valid. More...

#define	CMDSTA_UnknownCommand 0x82
	The command number in the command structure is unknown. More...

#define	CMDSTA_UnknownDirCommand 0x83
	command is not a direct command More...

#define	CMDSTA_ContextError 0x85
	where it is not supported More...

#define	CMDSTA_SchedulingError 0x86
	while another operation was already running in the RF core More...

#define	CMDSTA_ParError 0x87
	on submission. More...

#define	CMDSTA_QueueError 0x88
	not supported by the queue in its current state More...

#define	CMDSTA_QueueBusy 0x89
	was busy More...

Macros for sending direct commands
Direct command with no parameter
#define	CMDR_DIR_CMD(cmdId) (((cmdId) << 16) \| 1)

#define	CMDR_DIR_CMD_1BYTE(cmdId, par) (((cmdId) << 16) \| ((par) << 8) \| 1)
	Direct command with 1-byte parameter. More...

#define	CMDR_DIR_CMD_2BYTE(cmdId, par) (((cmdId) << 16) \| ((par) & 0xFFFC) \| 1)
	Direct command with 2-byte parameter. More...

Definitions for trigger types
#define	TRIG_NOW 0
	Triggers immediately. More...

#define	TRIG_NEVER 1
	Never trigs. More...

#define	TRIG_ABSTIME 2
	Trigs at an absolute time. More...

#define	TRIG_REL_SUBMIT 3
	Trigs at a time relative to the command was submitted. More...

#define	TRIG_REL_START 4
	Trigs at a time relative to the command started. More...

#define	TRIG_REL_PREVSTART 5
	Trigs at a time relative to the previous command in the chain started. More...

#define	TRIG_REL_FIRSTSTART 6
	Trigs at a time relative to the first command in the chain started. More...

#define	TRIG_REL_PREVEND 7
	Trigs at a time relative to the previous command in the chain ended. More...

#define	TRIG_REL_EVT1 8
	Trigs at a time relative to the context defined "Event 1". More...

#define	TRIG_REL_EVT2 9
	Trigs at a time relative to the context defined "Event 2". More...

#define	TRIG_EXTERNAL 10
	Trigs at an external event to the radio timer. More...

#define	TRIG_PAST_BM 0x80
	trigger happened in the past More...

Definitions for conditional execution
#define	COND_ALWAYS 0
	Always run next command (except in case of Abort) More...

#define	COND_NEVER 1
	Never run next command. More...

#define	COND_STOP_ON_FALSE 2
	False. More...

#define	COND_STOP_ON_TRUE 3
	False. More...

#define	COND_SKIP_ON_FALSE 4
	commands if it returned False More...

#define	COND_SKIP_ON_TRUE 5
	command if it returned False More...

Operation not finished
#define	IDLE 0x0000
	Operation not started. More...

#define	PENDING 0x0001
	Start of command is pending. More...

#define	ACTIVE 0x0002
	Running. More...

#define	SKIPPED 0x0003
	Operation skipped due to condition in another command. More...

Operation finished normally
#define	DONE_OK 0x0400
	Operation ended normally. More...

#define	DONE_COUNTDOWN 0x0401
	Counter reached zero. More...

#define	DONE_RXERR 0x0402
	Operation ended with CRC error. More...

#define	DONE_TIMEOUT 0x0403
	Operation ended with timeout. More...

#define	DONE_STOPPED 0x0404
	Operation stopped after CMD_STOP command. More...

#define	DONE_ABORT 0x0405
	Operation aborted by CMD_ABORT command. More...

#define	DONE_FAILED 0x0406
	Scheduled immediate command failed. More...

Operation finished with error
#define	ERROR_PAST_START 0x0800
	The start trigger occurred in the past. More...

#define	ERROR_START_TRIG 0x0801
	Illegal start trigger parameter. More...

#define	ERROR_CONDITION 0x0802
	Illegal condition for next operation. More...

#define	ERROR_PAR 0x0803
	Error in a command specific parameter. More...

#define	ERROR_POINTER 0x0804
	Invalid pointer to next operation. More...

#define	ERROR_CMDID 0x0805
	operation command More...

#define	ERROR_WRONG_BG 0x0806
	FG level command not compatible with running BG level command. More...

#define	ERROR_NO_SETUP 0x0807
	Operation using Rx or Tx attempted without CMD_RADIO_SETUP. More...

#define	ERROR_NO_FS 0x0808
	Operation using Rx or Tx attempted without frequency synth configured. More...

#define	ERROR_SYNTH_PROG 0x0809
	Synthesizer calibration failed. More...

#define	ERROR_TXUNF 0x080A
	Tx underflow observed. More...

#define	ERROR_RXOVF 0x080B
	Rx overflow observed. More...

#define	ERROR_NO_RX 0x080C
	Attempted to access data from Rx when no such data was yet received. More...

#define	ERROR_PENDING 0x080D
	Command submitted in the future with another command at different level pending. More...

Data entry types
#define	DATA_ENTRY_TYPE_GEN 0
	General type: Tx entry or single element Rx entry. More...

#define	DATA_ENTRY_TYPE_MULTI 1
	Multi-element Rx entry type. More...

#define	DATA_ENTRY_TYPE_PTR 2
	Pointer entry type. More...

#define	DATA_ENTRY_TYPE_PARTIAL 3

Data entry statuses
@
#define	DATA_ENTRY_PENDING 0
	Entry not yet used. More...

#define	DATA_ENTRY_ACTIVE 1
	Entry in use by radio CPU. More...

#define	DATA_ENTRY_BUSY 2
	Entry being updated. More...

#define	DATA_ENTRY_FINISHED 3
	Radio CPU is finished accessing the entry. More...

#define	DATA_ENTRY_UNFINISHED 4
	Radio CPU is finished accessing the entry, but packet could not be finished. More...

Macros for RF register override
Macro for ADI half-size value-mask combination
#define	ADI_VAL_MASK(addr, mask, value)

#define	HW_REG_OVERRIDE(addr, val) ((((uintptr_t) (addr)) & 0xFFFC) \| ((uint32_t)(val) << 16))
	32-bit write of 16-bit value More...

#define	ADI_REG_OVERRIDE(adiNo, addr, val)
	ADI register, full-size write. More...

#define	ADI_2REG_OVERRIDE(adiNo, addr, val, addr2, val2)
	2 ADI registers, full-size write More...

#define	ADI_HALFREG_OVERRIDE(adiNo, addr, mask, val)
	ADI register, half-size read-modify-write. More...

#define	ADI_2HALFREG_OVERRIDE(adiNo, addr, mask, val, addr2, mask2, val2)
	2 ADI registers, half-size read-modify-write More...

#define	SW_REG_OVERRIDE(cmd, field, val) (3 \| ((_POSITION_##cmd##_##field) << 4) \| ((uint32_t)(val) << 16))
	16-bit SW register as defined in radio_par_def.txt More...

#define	SW_REG_IND_OVERRIDE(cmd, field, offset, val)
	SW register as defined in radio_par_def.txt with added index (for use with registers > 16 bits). More...

#define	SW_REG_BYTE_OVERRIDE(cmd, field, val)
	8-bit SW register as defined in radio_par_def.txt More...

#define	SW_REG_2BYTE_OVERRIDE(cmd, field, val0, val1)
	Two 8-bit SW registers as defined in radio_par_def.txt; the one given by field and the next byte. More...

#define	SW_REG_MASK_OVERRIDE(cmd, field, offset, mask, val)

#define	HW16_ARRAY_OVERRIDE(addr, length) (1 \| (((uintptr_t) (addr)) & 0xFFFC) \| ((uint32_t)(length) << 16))

#define	HW32_ARRAY_OVERRIDE(addr, length)

#define	HW16_MASK_ARRAY_OVERRIDE(addr, length) (0x20000001 \| (((uintptr_t) (addr)) & 0xFFFC) \| ((uint32_t)(length) << 16))

#define	HW32_MASK_ARRAY_OVERRIDE(addr, length) (0x60000001 \| (((uintptr_t) (addr)) & 0xFFFC) \| ((uint32_t)(length) << 16))

#define	HW16_MASK_VAL(mask, val) ((mask) << 16 \| (val))

#define	ADI_ARRAY_OVERRIDE(adiNo, addr, bHalfSize, length)

#define	SW_ARRAY_OVERRIDE(cmd, firstfield, length)

#define	MCE_RFE_OVERRIDE(mceCfg, mceRomBank, mceMode, rfeCfg, rfeRomBank, rfeMode)

#define	HPOSC_OVERRIDE(freqOffset) (0x000B \| ((freqOffset) << 16))

#define	TX20_POWER_OVERRIDE(tx20Power) (0x002B \| (((uint32_t) tx20Power) << 10))

#define	TX_STD_POWER_OVERRIDE(txPower) (0x022B \| (((uint32_t) txPower) << 10))

#define	MCE_RFE_SPLIT_OVERRIDE(mceRxCfg, mceTxCfg, rfeRxCfg, rfeTxCfg) (0x003B \| ((mceRxCfg) << 12) \| ((mceTxCfg) << 17) \| ((rfeRxCfg) << 22) \| ((rfeTxCfg) << 27))

#define	CENTER_FREQ_OVERRIDE(centerFreq, flags)

#define	MOD_TYPE_OVERRIDE(modType, deviation, stepSz, flags)

#define	NEW_OVERRIDE_SEGMENT(address)

#define	END_OVERRIDE 0xFFFFFFFF
	End of string for override register. More...

#define	ADI_ADDR_VAL(addr, value) ((((addr) & 0x7F) << 8) \| ((value) & 0xFF))
	ADI address-value pair. More...

#define	ADI_ADDR_VAL_MASK(addr, mask, value) ((((addr) & 0x7F) << 8) \| ADI_VAL_MASK(addr, mask, value))

#define	LOWORD(value) ((value) & 0xFFFF)
	Low half-word. More...

#define	HIWORD(value) ((value) >> 16)
	High half-word. More...

Typedefs
typedef uint32_t	ratmr_t
	Type definition for RAT. More...

Macro Definition Documentation

§ RF_MODE_AUTO

#define RF_MODE_AUTO 0x00

§ RF_MODE_BLE

#define RF_MODE_BLE 0x00

§ RF_MODE_IEEE_15_4

#define RF_MODE_IEEE_15_4 0x00

§ RF_MODE_PROPRIETARY_2_4

#define RF_MODE_PROPRIETARY_2_4 0x00

§ RF_MODE_PROPRIETARY

#define RF_MODE_PROPRIETARY RF_MODE_PROPRIETARY_2_4

§ RF_MODE_MULTIPLE

#define RF_MODE_MULTIPLE 0x00

§ IRQN_COMMAND_DONE

#define IRQN_COMMAND_DONE 0

Radio operation command finished.

§ IRQN_LAST_COMMAND_DONE

#define IRQN_LAST_COMMAND_DONE 1

Last radio operation command in a chain finished.

§ IRQN_FG_COMMAND_DONE

#define IRQN_FG_COMMAND_DONE 2

FG level Radio operation command finished.

§ IRQN_LAST_FG_COMMAND_DONE

#define IRQN_LAST_FG_COMMAND_DONE 3

Last FG level radio operation command in a chain finished.

§ IRQN_TX_DONE

#define IRQN_TX_DONE 4

Packet transmitted.

§ IRQN_TX_ACK

#define IRQN_TX_ACK 5

ACK packet transmitted.

§ IRQN_TX_CTRL

#define IRQN_TX_CTRL 6

Control packet transmitted.

§ IRQN_TX_CTRL_ACK

#define IRQN_TX_CTRL_ACK 7

Acknowledgement received on a transmitted control packet.

§ IRQN_TX_CTRL_ACK_ACK

#define IRQN_TX_CTRL_ACK_ACK 8

Acknowledgement received on a transmitted control packet, and acknowledgement transmitted for that packet.

§ IRQN_TX_RETRANS

#define IRQN_TX_RETRANS 9

Packet retransmitted.

§ IRQN_TX_ENTRY_DONE

#define IRQN_TX_ENTRY_DONE 10

Tx queue data entry state changed to Finished.

§ IRQN_TX_BUFFER_CHANGED

#define IRQN_TX_BUFFER_CHANGED 11

A buffer change is complete.

§ IRQN_COMMAND_STARTED

#define IRQN_COMMAND_STARTED 12

A radio operation command has gone into active state.

§ IRQN_FG_COMMAND_STARTED

#define IRQN_FG_COMMAND_STARTED 13

FG level radio operation command has gone into active state.

§ IRQN_PA_CHANGED

#define IRQN_PA_CHANGED 14

PA is changed.

§ IRQN_RX_OK

#define IRQN_RX_OK 16

Packet received with CRC OK, payload, and not to be ignored.

§ IRQN_RX_NOK

#define IRQN_RX_NOK 17

Packet received with CRC error.

§ IRQN_RX_IGNORED

#define IRQN_RX_IGNORED 18

Packet received with CRC OK, but to be ignored.

§ IRQN_RX_EMPTY

#define IRQN_RX_EMPTY 19

Packet received with CRC OK, not to be ignored, no payload.

§ IRQN_RX_CTRL

#define IRQN_RX_CTRL 20

Control packet received with CRC OK, not to be ignored.

§ IRQN_RX_CTRL_ACK

#define IRQN_RX_CTRL_ACK 21

Control packet received with CRC OK, not to be ignored, then ACK sent.

§ IRQN_RX_BUF_FULL

#define IRQN_RX_BUF_FULL 22

Packet received that did not fit in the Rx queue.

§ IRQN_RX_ENTRY_DONE

#define IRQN_RX_ENTRY_DONE 23

Rx queue data entry changing state to Finished.

§ IRQN_RX_DATA_WRITTEN

#define IRQN_RX_DATA_WRITTEN 24

Data written to partial read Rx buffer.

§ IRQN_RX_N_DATA_WRITTEN

#define IRQN_RX_N_DATA_WRITTEN 25

Specified number of bytes written to partial read Rx buffer.

§ IRQN_RX_ABORTED

#define IRQN_RX_ABORTED 26

Packet reception stopped before packet was done.

§ IRQN_RX_COLLISION_DETECTED

#define IRQN_RX_COLLISION_DETECTED 27

A collision was indicated during packet reception.

§ IRQN_SYNTH_NO_LOCK

#define IRQN_SYNTH_NO_LOCK 28

The synth has gone out of lock after calibration.

§ IRQN_MODULES_UNLOCKED

#define IRQN_MODULES_UNLOCKED 29

As part of the boot process, the CM0 has opened access to RF core modules and memories.

§ IRQN_BOOT_DONE

#define IRQN_BOOT_DONE 30

The RF core CPU boot is finished.

§ IRQN_INTERNAL_ERROR

#define IRQN_INTERNAL_ERROR 31

Internal error observed.

§ IRQ_COMMAND_DONE

#define IRQ_COMMAND_DONE (1U << IRQN_COMMAND_DONE)

§ IRQ_LAST_COMMAND_DONE

#define IRQ_LAST_COMMAND_DONE (1U << IRQN_LAST_COMMAND_DONE)

§ IRQ_FG_COMMAND_DONE

#define IRQ_FG_COMMAND_DONE (1U << IRQN_FG_COMMAND_DONE)

§ IRQ_LAST_FG_COMMAND_DONE

#define IRQ_LAST_FG_COMMAND_DONE (1U << IRQN_LAST_FG_COMMAND_DONE)

§ IRQ_TX_DONE

#define IRQ_TX_DONE (1U << IRQN_TX_DONE)

§ IRQ_TX_ACK

#define IRQ_TX_ACK (1U << IRQN_TX_ACK)

§ IRQ_TX_CTRL

#define IRQ_TX_CTRL (1U << IRQN_TX_CTRL)

§ IRQ_TX_CTRL_ACK

#define IRQ_TX_CTRL_ACK (1U << IRQN_TX_CTRL_ACK)

§ IRQ_TX_CTRL_ACK_ACK

#define IRQ_TX_CTRL_ACK_ACK (1U << IRQN_TX_CTRL_ACK_ACK)

§ IRQ_TX_RETRANS

#define IRQ_TX_RETRANS (1U << IRQN_TX_RETRANS)

§ IRQ_TX_ENTRY_DONE

#define IRQ_TX_ENTRY_DONE (1U << IRQN_TX_ENTRY_DONE)

§ IRQ_TX_BUFFER_CHANGED

#define IRQ_TX_BUFFER_CHANGED (1U << IRQN_TX_BUFFER_CHANGED)

§ IRQ_COMMAND_STARTED

#define IRQ_COMMAND_STARTED (1U << IRQN_COMMAND_STARTED)

§ IRQ_FG_COMMAND_STARTED

#define IRQ_FG_COMMAND_STARTED (1U << IRQN_FG_COMMAND_STARTED)

§ IRQ_PA_CHANGED

#define IRQ_PA_CHANGED (1U << IRQN_PA_CHANGED)

§ IRQ_RX_OK

#define IRQ_RX_OK (1U << IRQN_RX_OK)

§ IRQ_RX_NOK

#define IRQ_RX_NOK (1U << IRQN_RX_NOK)

§ IRQ_RX_IGNORED

#define IRQ_RX_IGNORED (1U << IRQN_RX_IGNORED)

§ IRQ_RX_EMPTY

#define IRQ_RX_EMPTY (1U << IRQN_RX_EMPTY)

§ IRQ_RX_CTRL

#define IRQ_RX_CTRL (1U << IRQN_RX_CTRL)

§ IRQ_RX_CTRL_ACK

#define IRQ_RX_CTRL_ACK (1U << IRQN_RX_CTRL_ACK)

§ IRQ_RX_BUF_FULL

#define IRQ_RX_BUF_FULL (1U << IRQN_RX_BUF_FULL)

§ IRQ_RX_ENTRY_DONE

#define IRQ_RX_ENTRY_DONE (1U << IRQN_RX_ENTRY_DONE)

§ IRQ_RX_DATA_WRITTEN

#define IRQ_RX_DATA_WRITTEN (1U << IRQN_RX_DATA_WRITTEN)

§ IRQ_RX_N_DATA_WRITTEN

#define IRQ_RX_N_DATA_WRITTEN (1U << IRQN_RX_N_DATA_WRITTEN)

§ IRQ_RX_ABORTED

#define IRQ_RX_ABORTED (1U << IRQN_RX_ABORTED)

§ IRQ_RX_COLLISION_DETECTED

#define IRQ_RX_COLLISION_DETECTED (1U << IRQN_RX_COLLISION_DETECTED)

§ IRQ_SYNTH_NO_LOCK

#define IRQ_SYNTH_NO_LOCK (1U << IRQN_SYNTH_NO_LOCK)

§ IRQ_MODULES_UNLOCKED

#define IRQ_MODULES_UNLOCKED (1U << IRQN_MODULES_UNLOCKED)

§ IRQ_BOOT_DONE

#define IRQ_BOOT_DONE (1U << IRQN_BOOT_DONE)

§ IRQ_INTERNAL_ERROR

#define IRQ_INTERNAL_ERROR (1U << IRQN_INTERNAL_ERROR)

§ CMDSTA_Pending

#define CMDSTA_Pending 0x00

The command has not yet been parsed.

§ CMDSTA_Done

#define CMDSTA_Done 0x01

Command successfully parsed.

§ CMDSTA_IllegalPointer

#define CMDSTA_IllegalPointer 0x81

The pointer signaled in CMDR is not valid.

§ CMDSTA_UnknownCommand

#define CMDSTA_UnknownCommand 0x82

The command number in the command structure is unknown.

§ CMDSTA_UnknownDirCommand

#define CMDSTA_UnknownDirCommand 0x83

command is not a direct command

The command number for a direct command is unknown, or the

§ CMDSTA_ContextError

#define CMDSTA_ContextError 0x85

where it is not supported

An immediate or direct command was issued in a context

§ CMDSTA_SchedulingError

#define CMDSTA_SchedulingError 0x86

while another operation was already running in the RF core

A radio operation command was attempted to be scheduled

§ CMDSTA_ParError

#define CMDSTA_ParError 0x87

on submission.

There were errors in the command parameters that are parsed

§ CMDSTA_QueueError

#define CMDSTA_QueueError 0x88

not supported by the queue in its current state

An operation on a data entry queue was attempted that was

§ CMDSTA_QueueBusy

#define CMDSTA_QueueBusy 0x89

was busy

An operation on a data entry was attempted while that entry

§ CMDR_DIR_CMD

#define CMDR_DIR_CMD ( cmdId ) (((cmdId) << 16) | 1)

§ CMDR_DIR_CMD_1BYTE

#define CMDR_DIR_CMD_1BYTE	(	cmdId,
		par
	)	(((cmdId) << 16) \| ((par) << 8) \| 1)

Direct command with 1-byte parameter.

§ CMDR_DIR_CMD_2BYTE

#define CMDR_DIR_CMD_2BYTE	(	cmdId,
		par
	)	(((cmdId) << 16) \| ((par) & 0xFFFC) \| 1)

Direct command with 2-byte parameter.

§ TRIG_NOW

#define TRIG_NOW 0

Triggers immediately.

§ TRIG_NEVER

#define TRIG_NEVER 1

Never trigs.

§ TRIG_ABSTIME

#define TRIG_ABSTIME 2

Trigs at an absolute time.

§ TRIG_REL_SUBMIT

#define TRIG_REL_SUBMIT 3

Trigs at a time relative to the command was submitted.

§ TRIG_REL_START

#define TRIG_REL_START 4

Trigs at a time relative to the command started.

§ TRIG_REL_PREVSTART

#define TRIG_REL_PREVSTART 5

Trigs at a time relative to the previous command in the chain started.

§ TRIG_REL_FIRSTSTART

#define TRIG_REL_FIRSTSTART 6

Trigs at a time relative to the first command in the chain started.

§ TRIG_REL_PREVEND

#define TRIG_REL_PREVEND 7

Trigs at a time relative to the previous command in the chain ended.

§ TRIG_REL_EVT1

#define TRIG_REL_EVT1 8

Trigs at a time relative to the context defined "Event 1".

§ TRIG_REL_EVT2

#define TRIG_REL_EVT2 9

Trigs at a time relative to the context defined "Event 2".

§ TRIG_EXTERNAL

#define TRIG_EXTERNAL 10

Trigs at an external event to the radio timer.

§ TRIG_PAST_BM

#define TRIG_PAST_BM 0x80

trigger happened in the past

Bitmask for setting pastTrig bit in order to trig immediately if

§ COND_ALWAYS

#define COND_ALWAYS 0

Always run next command (except in case of Abort)

§ COND_NEVER

#define COND_NEVER 1

Never run next command.

§ COND_STOP_ON_FALSE

#define COND_STOP_ON_FALSE 2

False.

Run next command if this command returned True, stop if it returned

§ COND_STOP_ON_TRUE

#define COND_STOP_ON_TRUE 3

False.

Stop if this command returned True, run next command if it returned

§ COND_SKIP_ON_FALSE

#define COND_SKIP_ON_FALSE 4

commands if it returned False

Run next command if this command returned True, skip a number of

§ COND_SKIP_ON_TRUE

#define COND_SKIP_ON_TRUE 5

command if it returned False

Skip a number of commands if this command returned True, run next

§ IDLE

#define IDLE 0x0000

Operation not started.

§ PENDING

#define PENDING 0x0001

Start of command is pending.

§ ACTIVE

#define ACTIVE 0x0002

Running.

§ SKIPPED

#define SKIPPED 0x0003

Operation skipped due to condition in another command.

§ DONE_OK

#define DONE_OK 0x0400

Operation ended normally.

§ DONE_COUNTDOWN

#define DONE_COUNTDOWN 0x0401

Counter reached zero.

§ DONE_RXERR

#define DONE_RXERR 0x0402

Operation ended with CRC error.

§ DONE_TIMEOUT

#define DONE_TIMEOUT 0x0403

Operation ended with timeout.

§ DONE_STOPPED

#define DONE_STOPPED 0x0404

Operation stopped after CMD_STOP command.

§ DONE_ABORT

#define DONE_ABORT 0x0405

Operation aborted by CMD_ABORT command.

§ DONE_FAILED

#define DONE_FAILED 0x0406

Scheduled immediate command failed.

§ ERROR_PAST_START

#define ERROR_PAST_START 0x0800

The start trigger occurred in the past.

§ ERROR_START_TRIG

#define ERROR_START_TRIG 0x0801

Illegal start trigger parameter.

§ ERROR_CONDITION

#define ERROR_CONDITION 0x0802

Illegal condition for next operation.

§ ERROR_PAR

#define ERROR_PAR 0x0803

Error in a command specific parameter.

§ ERROR_POINTER

#define ERROR_POINTER 0x0804

Invalid pointer to next operation.

§ ERROR_CMDID

#define ERROR_CMDID 0x0805

operation command

Next operation has a command ID that is undefined or not a radio

§ ERROR_WRONG_BG

#define ERROR_WRONG_BG 0x0806

FG level command not compatible with running BG level command.

§ ERROR_NO_SETUP

#define ERROR_NO_SETUP 0x0807

Operation using Rx or Tx attempted without CMD_RADIO_SETUP.

§ ERROR_NO_FS

#define ERROR_NO_FS 0x0808

Operation using Rx or Tx attempted without frequency synth configured.

§ ERROR_SYNTH_PROG

#define ERROR_SYNTH_PROG 0x0809

Synthesizer calibration failed.

§ ERROR_TXUNF

#define ERROR_TXUNF 0x080A

Tx underflow observed.

§ ERROR_RXOVF

#define ERROR_RXOVF 0x080B

Rx overflow observed.

§ ERROR_NO_RX

#define ERROR_NO_RX 0x080C

Attempted to access data from Rx when no such data was yet received.

§ ERROR_PENDING

#define ERROR_PENDING 0x080D

Command submitted in the future with another command at different level pending.

§ DATA_ENTRY_TYPE_GEN

#define DATA_ENTRY_TYPE_GEN 0

General type: Tx entry or single element Rx entry.

§ DATA_ENTRY_TYPE_MULTI

#define DATA_ENTRY_TYPE_MULTI 1

Multi-element Rx entry type.

§ DATA_ENTRY_TYPE_PTR

#define DATA_ENTRY_TYPE_PTR 2

Pointer entry type.

§ DATA_ENTRY_TYPE_PARTIAL

#define DATA_ENTRY_TYPE_PARTIAL 3

Partial read entry type

§ DATA_ENTRY_PENDING

#define DATA_ENTRY_PENDING 0

Entry not yet used.

§ DATA_ENTRY_ACTIVE

#define DATA_ENTRY_ACTIVE 1

Entry in use by radio CPU.

§ DATA_ENTRY_BUSY

#define DATA_ENTRY_BUSY 2

Entry being updated.

§ DATA_ENTRY_FINISHED

#define DATA_ENTRY_FINISHED 3

Radio CPU is finished accessing the entry.

§ DATA_ENTRY_UNFINISHED

#define DATA_ENTRY_UNFINISHED 4

Radio CPU is finished accessing the entry, but packet could not be finished.

§ ADI_VAL_MASK

#define ADI_VAL_MASK	(	addr,
		mask,
		value
	)

Value:

(((addr) & 1) ? (((mask) & 0x0F) | (((value) & 0x0F) << 4)) : \

((((mask) & 0x0F) << 4) | ((value) & 0x0F)))

§ HW_REG_OVERRIDE

#define HW_REG_OVERRIDE	(	addr,
		val
	)	((((uintptr_t) (addr)) & 0xFFFC) \| ((uint32_t)(val) << 16))

32-bit write of 16-bit value

§ ADI_REG_OVERRIDE

#define ADI_REG_OVERRIDE	(	adiNo,
		addr,
		val
	)

Value:

(2 | ((uint32_t)(val) << 16) | \

(((addr) & 0x3F) << 24) | (((adiNo) ? 1U : 0) << 31))

ADI register, full-size write.

§ ADI_2REG_OVERRIDE

#define ADI_2REG_OVERRIDE	(	adiNo,
		addr,
		val,
		addr2,
		val2
	)

Value:

(2 | ((uint32_t)(val2) << 2) | (((addr2) & 0x3F) << 10) | ((uint32_t)(val) << 16) | \

(((addr) & 0x3F) << 24) | (((adiNo) ? 1U : 0) << 31))

2 ADI registers, full-size write

§ ADI_HALFREG_OVERRIDE

#define ADI_HALFREG_OVERRIDE	(	adiNo,
		addr,
		mask,
		val
	)

Value:

(2 | (ADI_VAL_MASK(addr, mask, val) << 16) | \

(((addr) & 0x3F) << 24) | (1U << 30) | (((adiNo) ? 1U : 0) << 31))

ADI_VAL_MASK

#define ADI_VAL_MASK(addr, mask, value)

Definition: rf_mailbox.h:279

ADI register, half-size read-modify-write.

§ ADI_2HALFREG_OVERRIDE

#define ADI_2HALFREG_OVERRIDE	(	adiNo,
		addr,
		mask,
		val,
		addr2,
		mask2,
		val2
	)

Value:

(2 | (ADI_VAL_MASK(addr2, mask2, val2) << 2) | (((addr2) & 0x3F) << 10) | \

(ADI_VAL_MASK(addr, mask, val) << 16) | (((addr) & 0x3F) << 24) | (1U << 30) | (((adiNo) ? 1U : 0) << 31))

ADI_VAL_MASK

#define ADI_VAL_MASK(addr, mask, value)

Definition: rf_mailbox.h:279

2 ADI registers, half-size read-modify-write

§ SW_REG_OVERRIDE

#define SW_REG_OVERRIDE	(	cmd,
		field,
		val
	)	(3 \| ((_POSITION_##cmd##_##field) << 4) \| ((uint32_t)(val) << 16))

16-bit SW register as defined in radio_par_def.txt

§ SW_REG_IND_OVERRIDE

#define SW_REG_IND_OVERRIDE	(	cmd,
		field,
		offset,
		val
	)

Value:

(3 | \

(((_POSITION_##cmd##_##field) + ((offset) << 1)) << 4) | ((uint32_t)(val) << 16))

SW register as defined in radio_par_def.txt with added index (for use with registers > 16 bits).

§ SW_REG_BYTE_OVERRIDE

#define SW_REG_BYTE_OVERRIDE	(	cmd,
		field,
		val
	)

Value:

(0x8003 | ((_POSITION_##cmd##_##field) << 4) | \

(((uint32_t)(val) & 0xFF) << 16))

8-bit SW register as defined in radio_par_def.txt

§ SW_REG_2BYTE_OVERRIDE

#define SW_REG_2BYTE_OVERRIDE	(	cmd,
		field,
		val0,
		val1
	)

Value:

(3 | (((_POSITION_##cmd##_##field) & 0xFFFE) << 4) | \

(((uint32_t)(val0) << 16) & 0x00FF0000) | ((uint32_t)(val1) << 24))

Two 8-bit SW registers as defined in radio_par_def.txt; the one given by field and the next byte.

§ SW_REG_MASK_OVERRIDE

#define SW_REG_MASK_OVERRIDE	(	cmd,
		field,
		offset,
		mask,
		val
	)

Value:

(0x8003 | \

((_POSITION_##cmd##_##field + (offset)) << 4) | (((uint32_t)(val) & 0xFF) << 16) | (((uint32_t)(mask) & 0xFF) << 24))

§ HW16_ARRAY_OVERRIDE

#define HW16_ARRAY_OVERRIDE	(	addr,
		length
	)	(1 \| (((uintptr_t) (addr)) & 0xFFFC) \| ((uint32_t)(length) << 16))

§ HW32_ARRAY_OVERRIDE

#define HW32_ARRAY_OVERRIDE	(	addr,
		length
	)

Value:

(1 | (((uintptr_t) (addr)) & 0xFFFC) | \

((uint32_t)(length) << 16) | (1U << 30))

§ HW16_MASK_ARRAY_OVERRIDE

#define HW16_MASK_ARRAY_OVERRIDE	(	addr,
		length
	)	(0x20000001 \| (((uintptr_t) (addr)) & 0xFFFC) \| ((uint32_t)(length) << 16))

§ HW32_MASK_ARRAY_OVERRIDE

#define HW32_MASK_ARRAY_OVERRIDE	(	addr,
		length
	)	(0x60000001 \| (((uintptr_t) (addr)) & 0xFFFC) \| ((uint32_t)(length) << 16))

§ HW16_MASK_VAL

#define HW16_MASK_VAL	(	mask,
		val
	)	((mask) << 16 \| (val))

§ ADI_ARRAY_OVERRIDE

#define ADI_ARRAY_OVERRIDE	(	adiNo,
		addr,
		bHalfSize,
		length
	)

Value:

(1 | ((((addr) & 0x3F) << 2)) | \

((!!(bHalfSize)) << 8) | ((!!(adiNo)) << 9) | ((uint32_t)(length) << 16) | (2U << 30))

§ SW_ARRAY_OVERRIDE

#define SW_ARRAY_OVERRIDE	(	cmd,
		firstfield,
		length
	)

Value:

(1 | (((_POSITION_##cmd##_##firstfield)) << 2) | \

((uint32_t)(length) << 16) | (3U << 30))

§ MCE_RFE_OVERRIDE

#define MCE_RFE_OVERRIDE	(	mceCfg,
		mceRomBank,
		mceMode,
		rfeCfg,
		rfeRomBank,
		rfeMode
	)

Value:

(7 | ((mceCfg & 2) << 3) | ((rfeCfg & 2) << 4) |\
    ((mceCfg & 1) << 6) | (((mceRomBank) & 0x0F) << 7) | \
    ((rfeCfg & 1) << 11) | (((rfeRomBank) & 0x0F) << 12) | \
    (((mceMode) & 0x00FF) << 16) | (((rfeMode) & 0x00FF) << 24))

§ HPOSC_OVERRIDE

#define HPOSC_OVERRIDE ( freqOffset ) (0x000B | ((freqOffset) << 16))

§ TX20_POWER_OVERRIDE

#define TX20_POWER_OVERRIDE ( tx20Power ) (0x002B | (((uint32_t) tx20Power) << 10))

§ TX_STD_POWER_OVERRIDE

#define TX_STD_POWER_OVERRIDE ( txPower ) (0x022B | (((uint32_t) txPower) << 10))

§ MCE_RFE_SPLIT_OVERRIDE

#define MCE_RFE_SPLIT_OVERRIDE	(	mceRxCfg,
		mceTxCfg,
		rfeRxCfg,
		rfeTxCfg
	)	(0x003B \| ((mceRxCfg) << 12) \| ((mceTxCfg) << 17) \| ((rfeRxCfg) << 22) \| ((rfeTxCfg) << 27))

§ CENTER_FREQ_OVERRIDE

#define CENTER_FREQ_OVERRIDE	(	centerFreq,
		flags
	)

Value:

(0x004B | ((flags & 0x03) << 18) | \

((centerFreq) << 20))

§ MOD_TYPE_OVERRIDE

#define MOD_TYPE_OVERRIDE	(	modType,
		deviation,
		stepSz,
		flags
	)

Value:

(0x005B | ((flags & 0x01) << 15) | \

((modType) << 16) | ((deviation) << 19) |((stepSz) << 30) )

§ NEW_OVERRIDE_SEGMENT

#define NEW_OVERRIDE_SEGMENT ( address )

Value:

(((((uintptr_t)(address)) & 0x03FFFFFC) << 6) | 0x000F | \
   (((((uintptr_t)(address) >> 24) == 0x20) ? 0x01 : \
     (((uintptr_t)(address) >> 24) == 0x21) ? 0x02 : \
     (((uintptr_t)(address) >> 24) == 0xA0) ? 0x03 : \
     (((uintptr_t)(address) >> 24) == 0x00) ? 0x04 : \
     (((uintptr_t)(address) >> 24) == 0x10) ? 0x05 : \
     (((uintptr_t)(address) >> 24) == 0x11) ? 0x06 : \
     (((uintptr_t)(address) >> 24) == 0x40) ? 0x07 : \
     (((uintptr_t)(address) >> 24) == 0x50) ? 0x08 : \
     0x09) << 4))

§ END_OVERRIDE

#define END_OVERRIDE 0xFFFFFFFF

End of string for override register.

§ ADI_ADDR_VAL

#define ADI_ADDR_VAL	(	addr,
		value
	)	((((addr) & 0x7F) << 8) \| ((value) & 0xFF))

ADI address-value pair.

§ ADI_ADDR_VAL_MASK

#define ADI_ADDR_VAL_MASK	(	addr,
		mask,
		value
	)	((((addr) & 0x7F) << 8) \| ADI_VAL_MASK(addr, mask, value))

§ LOWORD

#define LOWORD ( value ) ((value) & 0xFFFF)

Low half-word.

§ HIWORD

#define HIWORD ( value ) ((value) >> 16)

High half-word.

Typedef Documentation

§ ratmr_t

typedef uint32_t ratmr_t

Type definition for RAT.

Data Structures

Macros

Typedefs

Macro Definition Documentation

§ RF_MODE_AUTO

§ RF_MODE_BLE

§ RF_MODE_IEEE_15_4

§ RF_MODE_PROPRIETARY_2_4

§ RF_MODE_PROPRIETARY

§ RF_MODE_MULTIPLE

§ IRQN_COMMAND_DONE

§ IRQN_LAST_COMMAND_DONE

§ IRQN_FG_COMMAND_DONE

§ IRQN_LAST_FG_COMMAND_DONE

§ IRQN_TX_DONE

§ IRQN_TX_ACK

§ IRQN_TX_CTRL

§ IRQN_TX_CTRL_ACK

§ IRQN_TX_CTRL_ACK_ACK

§ IRQN_TX_RETRANS

§ IRQN_TX_ENTRY_DONE

§ IRQN_TX_BUFFER_CHANGED

§ IRQN_COMMAND_STARTED

§ IRQN_FG_COMMAND_STARTED

§ IRQN_PA_CHANGED

§ IRQN_RX_OK

§ IRQN_RX_NOK

§ IRQN_RX_IGNORED

§ IRQN_RX_EMPTY

§ IRQN_RX_CTRL

§ IRQN_RX_CTRL_ACK

§ IRQN_RX_BUF_FULL

§ IRQN_RX_ENTRY_DONE

§ IRQN_RX_DATA_WRITTEN

§ IRQN_RX_N_DATA_WRITTEN

§ IRQN_RX_ABORTED

§ IRQN_RX_COLLISION_DETECTED

§ IRQN_SYNTH_NO_LOCK

§ IRQN_MODULES_UNLOCKED

§ IRQN_BOOT_DONE

§ IRQN_INTERNAL_ERROR

§ IRQ_COMMAND_DONE

§ IRQ_LAST_COMMAND_DONE

§ IRQ_FG_COMMAND_DONE

§ IRQ_LAST_FG_COMMAND_DONE

§ IRQ_TX_DONE

§ IRQ_TX_ACK

§ IRQ_TX_CTRL

§ IRQ_TX_CTRL_ACK

§ IRQ_TX_CTRL_ACK_ACK

§ IRQ_TX_RETRANS

§ IRQ_TX_ENTRY_DONE

§ IRQ_TX_BUFFER_CHANGED

§ IRQ_COMMAND_STARTED

§ IRQ_FG_COMMAND_STARTED

§ IRQ_PA_CHANGED

§ IRQ_RX_OK

§ IRQ_RX_NOK

§ IRQ_RX_IGNORED

§ IRQ_RX_EMPTY

§ IRQ_RX_CTRL

§ IRQ_RX_CTRL_ACK

§ IRQ_RX_BUF_FULL

§ IRQ_RX_ENTRY_DONE

§ IRQ_RX_DATA_WRITTEN

§ IRQ_RX_N_DATA_WRITTEN

§ IRQ_RX_ABORTED

§ IRQ_RX_COLLISION_DETECTED

§ IRQ_SYNTH_NO_LOCK

§ IRQ_MODULES_UNLOCKED

§ IRQ_BOOT_DONE

§ IRQ_INTERNAL_ERROR

§ CMDSTA_Pending

§ CMDSTA_Done

§ CMDSTA_IllegalPointer

§ CMDSTA_UnknownCommand

§ CMDSTA_UnknownDirCommand

§ CMDSTA_ContextError

§ CMDSTA_SchedulingError

§ CMDSTA_ParError