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 RX FIFO buffer.

#include <rail_types.h>

Data Fields

RAIL_RxPacketStatus_t packetStatus
 Packet status of this packet.
 
uint16_t packetBytes
 Number of packet data bytes available to read in this packet.
 
uint16_t firstPortionBytes
 Number of bytes in first portion.
 
uint8_t * firstPortionData
 Pointer to first portion of packet data containing firstPortionBytes number of bytes.
 
uint8_t * lastPortionData
 Pointer to last portion of packet, if any; NULL otherwise.

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

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

Note
Because the RX 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 1949 of file rail_types.h.

Field Documentation

◆ firstPortionBytes

uint16_t RAIL_RxPacketInfo_t::firstPortionBytes

Number of bytes in first portion.

Definition at line 1953 of file rail_types.h.

Referenced by RAIL_CopyRxPacket().

◆ firstPortionData

uint8_t* RAIL_RxPacketInfo_t::firstPortionData

Pointer to first portion of packet data containing firstPortionBytes number of bytes.

Definition at line 1954 of file rail_types.h.

Referenced by RAIL_CopyRxPacket().

◆ lastPortionData

uint8_t* RAIL_RxPacketInfo_t::lastPortionData

Pointer to last portion of packet, if any; NULL otherwise.

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

Definition at line 1957 of file rail_types.h.

Referenced by RAIL_CopyRxPacket().

◆ packetBytes

uint16_t RAIL_RxPacketInfo_t::packetBytes

Number of packet data bytes available to read in this packet.

Definition at line 1951 of file rail_types.h.

Referenced by RAIL_CopyRxPacket().

◆ packetStatus

RAIL_RxPacketStatus_t RAIL_RxPacketInfo_t::packetStatus

Packet status of this packet.

Definition at line 1950 of file rail_types.h.


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