RAIL_RxPacketInfo_t Struct Reference

Basic information about a packet being received or already completed and awaiting processing, including memory pointers to its data in the circular receive FIFO buffer.

#include < rail_types.h >

Data Fields

RAIL_RxPacketStatus_t packetStatus
The packet status of this packet.
uint16_t packetBytes
The number of packet data bytes available to read in this packet.
uint16_t firstPortionBytes
The number of bytes in the first portion.
uint8_t * firstPortionData
The pointer to the first portion of packet data containing firstPortionBytes number of bytes.
uint8_t * lastPortionData
The pointer to the last portion of a packet, if any; NULL otherwise.
RAIL_AddrFilterMask_t filterMask
A bitmask representing which address filter(s) this packet has passed.

Basic information about a packet being received or already completed and awaiting processing, including memory pointers to its data in the circular receive FIFO buffer.

This packet information refers to remaining packet data that has not already been consumed by RAIL_ReadRxFifo() .

Note
Because the receive FIFO buffer is circular, a packet might start near the end of the buffer and wrap around to the beginning of the buffer to finish, hence the distinction between the first and last portions. Packets that fit without wrapping only have a first portion (firstPortionBytes == packetBytes and lastPortionData will be NULL).

Definition at line 2892 of file rail_types.h .

Field Documentation

filterMask

RAIL_AddrFilterMask_t RAIL_RxPacketInfo_t::filterMask

A bitmask representing which address filter(s) this packet has passed.

Will be 0 when not filtering or if packet info is retrieved before filtering has completed. It's undefined on platforms lacking RAIL_SUPPORTS_ADDR_FILTER_MASK

Definition at line 2904 of file rail_types.h .

firstPortionBytes

uint16_t RAIL_RxPacketInfo_t::firstPortionBytes

The number of bytes in the first portion.

Definition at line 2896 of file rail_types.h .

firstPortionData

uint8_t* RAIL_RxPacketInfo_t::firstPortionData

The pointer to the first portion of packet data containing firstPortionBytes number of bytes.

Definition at line 2897 of file rail_types.h .

lastPortionData

uint8_t* RAIL_RxPacketInfo_t::lastPortionData

The pointer to the last portion of a packet, if any; NULL otherwise.

The number of bytes in this portion is packetBytes - firstPortionBytes.

Definition at line 2900 of file rail_types.h .

packetBytes

uint16_t RAIL_RxPacketInfo_t::packetBytes

The number of packet data bytes available to read in this packet.

Definition at line 2894 of file rail_types.h .

packetStatus

RAIL_RxPacketStatus_t RAIL_RxPacketInfo_t::packetStatus

The packet status of this packet.

Definition at line 2893 of file rail_types.h .


The documentation for this struct was generated from the following file:
  • common/ rail_types.h