adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

net: pkt: Add API documentation for net_pkt_get_len

Browse source 
net_pkt_get_len() was commonly used yet not documented, move the
function out of the doxygen-ignored section of the header and add
a doxygen API description for the function so that it's rendered in
the documentation properly.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
This commit is contained in:
Robert Lubos 2025-01-22 14:05:55 +01:00 committed by Benjamin Cabé
parent 085df8bd1e
commit 225b587a90
1 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
include/zephyr/net/net_pkt.h
View file

@ -1257,11 +1257,6 @@ static inline void net_pkt_set_stats_tick(struct net_pkt *pkt, uint32_t tick)
#endif /* CONFIG_NET_PKT_TXTIME_STATS_DETAIL || #endif /* CONFIG_NET_PKT_TXTIME_STATS_DETAIL ||
CONFIG_NET_PKT_RXTIME_STATS_DETAIL */ CONFIG_NET_PKT_RXTIME_STATS_DETAIL */
static inline size_t net_pkt_get_len(struct net_pkt *pkt)
{
return net_buf_frags_len(pkt->frags);
}
static inline uint8_t *net_pkt_data(struct net_pkt *pkt) static inline uint8_t *net_pkt_data(struct net_pkt *pkt)
{ {
return pkt->frags->data; return pkt->frags->data;
@ -2476,6 +2471,18 @@ static inline int net_pkt_write_le16(struct net_pkt *pkt, uint16_t data)
*/ */
size_t net_pkt_remaining_data(struct net_pkt *pkt); size_t net_pkt_remaining_data(struct net_pkt *pkt);
/**
* @brief Get the total amount of bytes stored in a packet.
*
* @param pkt Network packet
*
* @return Total amount of bytes stored in a packet.
*/
static inline size_t net_pkt_get_len(struct net_pkt *pkt)
{
return net_buf_frags_len(pkt->frags);
}
/** /**
* @brief Update the overall length of a packet * @brief Update the overall length of a packet
* *