Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

NetIF_GetTxDataAlignPtr()

Get an aligned pointer into a transmit application data buffer.

...

net_if.h/net_if.c

Prototype

...

Arguments

if_nbr

Network interface number to get a transmit application buffer's aligned data pointer.

...

Pointer to variable that will receive the return error code from this function :

NET_IF_ERR_NONE
NET_IF_ERR_NULL_PTR
NET_IF_ERR_INVALID_IF
NET_IF_ERR_ALIGN_NOT_AVAIL
NET_ERR_INIT_INCOMPLETE
NET_ERR_INVALID_TRANSACTION
NET_OS_ERR_LOCK

Returned Value

Pointer to aligned transmit application data buffer address, if no errors.

...

For any single read/write of data to/from application data buffers and network buffer data areas, optimal alignment occurs if, and only if, all of the following conditions are true:

...

In other words, the modulus of the specific read/write address in the application data buffer with the CPU's data word size must be equal to the modulus of the specific read/write address in the network buffer data area with the CPU's data word size.

This condition might not be satisfied whenever:

Data is read/written to/from fragmented packets

...