Lines Matching full:packet

18  * @brief Single producer, single consumer packet buffer API
19  * @defgroup spsc_buf SPSC (Single producer, single consumer) packet buffer API
24 /**@defgroup SPSC_PBUF_FLAGS SPSC packet buffer flags
30  * It shall be used only when packet buffer is shared between two cores as on a single
56 /** @brief Maximum packet length. */
59 /** @brief First part of packet buffer control block.
62  * by the reader. If packet is shared between to cores then data changed by
76 /** @brief Remaining part of a packet buffer when cache is used.
87 /** @brief Remaining part of a packet buffer when cache is not used. */
94  * @brief Single producer, single consumer packet buffer
96  * The SPSC packet buffer implements lightweight unidirectional packet buffer
116  * each packet is prefixed with 2 byte length header, longest possible packet is
121  * @return Packet buffer capacity.
129  * @brief Initialize the packet buffer.
131  * This function initializes the packet buffer on top of a dedicated
150  * @brief Write specified amount of data to the packet buffer.
165  * @brief Allocate space in the packet buffer.
168  * the packet buffer. An internal padding is added at the end of the buffer, if
170  * change the state of the buffer so if after allocation packet is not needed
173  * Allocated buffer must be committed (@ref spsc_pbuf_commit) to make the packet
176  * Packet buffer ensures that allocated buffers are 32 bit word aligned.
195  * @brief Commit packet to the buffer.
197  * Commit a packet which was previously allocated (@ref spsc_pbuf_alloc).
201  * @param len	Packet length. Must be equal or less than the length used for allocation.
206  * @brief Read specified amount of data from the packet buffer.
225  * @brief Claim packet from the buffer.
227  * It claims a single packet from the buffer in the order of the commitment
228  * by the @ref spsc_pbuf_commit function. The first committed packet will be claimed first.
230  * Claimed packet must be freed using the @ref spsc_pbuf_free function.
232  * @note If data cache is used, cache is invalidate on the packet.
234  * @param[in] pb	A buffer from which packet will be claimed.
235  * @param[in,out] buf	A location where claimed packet address is written.
239  * @retval positive packet length.
244  * @brief Free the packet to the buffer.
246  * Packet must be claimed (@ref spsc_pbuf_claim) before it can be freed.
248  * @param pb	A packet buffer from which packet was claimed.
249  * @param len	Claimed packet length.
254  * @brief Get maximum utilization of the packet buffer.
259  * @param pb	A packet buffer.