Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
net_buf.h
Go to the documentation of this file.
1
4
5/*
6 * Copyright (c) 2015 Intel Corporation
7 *
8 * SPDX-License-Identifier: Apache-2.0
9 */
10#ifndef ZEPHYR_INCLUDE_NET_BUF_H_
11#define ZEPHYR_INCLUDE_NET_BUF_H_
12
13#include <stddef.h>
14#include <zephyr/types.h>
15#include <zephyr/sys/util.h>
16#include <zephyr/kernel.h>
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
31
32/* Alignment needed for various parts of the buffer definition */
33#if CONFIG_NET_BUF_ALIGNMENT == 0
34#define __net_buf_align __aligned(sizeof(void *))
35#else
36#define __net_buf_align __aligned(CONFIG_NET_BUF_ALIGNMENT)
37#endif
38
48#define NET_BUF_SIMPLE_DEFINE(_name, _size) \
49 uint8_t net_buf_data_##_name[_size]; \
50 struct net_buf_simple _name = { \
51 .data = net_buf_data_##_name, \
52 .len = 0, \
53 .size = _size, \
54 .__buf = net_buf_data_##_name, \
55 }
56
67#define NET_BUF_SIMPLE_DEFINE_STATIC(_name, _size) \
68 static __noinit uint8_t net_buf_data_##_name[_size]; \
69 static struct net_buf_simple _name = { \
70 .data = net_buf_data_##_name, \
71 .len = 0, \
72 .size = _size, \
73 .__buf = net_buf_data_##_name, \
74 }
75
92
99
102
106 uint8_t *__buf;
107};
108
125#define NET_BUF_SIMPLE(_size) \
126 ((struct net_buf_simple *)(&(struct { \
127 struct net_buf_simple buf; \
128 uint8_t data[_size]; \
129 }) { \
130 .buf.size = _size, \
131 }))
132
142static inline void net_buf_simple_init(struct net_buf_simple *buf,
143 size_t reserve_head)
144{
145 if (!buf->__buf) {
146 buf->__buf = (uint8_t *)buf + sizeof(*buf);
147 }
148
149 buf->data = buf->__buf + reserve_head;
150 buf->len = 0U;
151}
152
163 void *data, size_t size);
164
172static inline void net_buf_simple_reset(struct net_buf_simple *buf)
173{
174 buf->len = 0U;
175 buf->data = buf->__buf;
176}
177
188void net_buf_simple_clone(const struct net_buf_simple *original,
189 struct net_buf_simple *clone);
190
202void *net_buf_simple_add(struct net_buf_simple *buf, size_t len);
203
216void *net_buf_simple_add_mem(struct net_buf_simple *buf, const void *mem,
217 size_t len);
218
231
243
255
267
279
291
303
315
327
339
351
363
375
386void *net_buf_simple_remove_mem(struct net_buf_simple *buf, size_t len);
387
399
411
423
435
447
459
471
483
495
507
519
531
543
555void *net_buf_simple_push(struct net_buf_simple *buf, size_t len);
556
569void *net_buf_simple_push_mem(struct net_buf_simple *buf, const void *mem,
570 size_t len);
571
582
593
603
614
625
636
647
658
669
680
691
702
713
725void *net_buf_simple_pull(struct net_buf_simple *buf, size_t len);
726
738void *net_buf_simple_pull_mem(struct net_buf_simple *buf, size_t len);
739
751
763
775
787
799
811
823
835
847
859
871
883
895
905static inline uint8_t *net_buf_simple_tail(const struct net_buf_simple *buf)
906{
907 return buf->data + buf->len;
908}
909
919static inline size_t net_buf_simple_headroom(const struct net_buf_simple *buf)
920{
921 return buf->data - buf->__buf;
922}
923
933static inline size_t net_buf_simple_tailroom(const struct net_buf_simple *buf)
934{
935 return buf->size - net_buf_simple_headroom(buf) - buf->len;
936}
937
947static inline uint16_t net_buf_simple_max_len(const struct net_buf_simple *buf)
948{
949 return buf->size - net_buf_simple_headroom(buf);
950}
951
965
974static inline void net_buf_simple_save(const struct net_buf_simple *buf,
976{
977 state->offset = (uint16_t)net_buf_simple_headroom(buf);
978 state->len = buf->len;
979}
980
990static inline void net_buf_simple_restore(struct net_buf_simple *buf,
992{
993 buf->data = buf->__buf + state->offset;
994 buf->len = state->len;
995}
996
1006#define NET_BUF_EXTERNAL_DATA BIT(0)
1007
1015struct net_buf {
1018
1021
1053 union {
1055 atomic_t ref_word;
1057 struct {
1058#if defined(CONFIG_BIG_ENDIAN)
1059 /* atomic_t is typedef'd as long (BUILD_ASSERTed in
1060 * lib/net_buf/buf.c); on a 64-bit big-endian build
1061 * the byte struct needs 4 bytes of padding so that
1062 * `ref` lands on the least-significant byte of
1063 * ref_word.
1064 */
1065#if (__SIZEOF_LONG__ == 8)
1067 uint8_t _ref_word_pad[4];
1069#endif
1072
1075
1077 uint8_t flags;
1078
1080 uint8_t ref;
1081#else
1084
1087
1090
1093#endif
1094 };
1095 };
1096
1100 union {
1101 /* The ABI of this struct must match net_buf_simple */
1102 struct {
1105
1108
1111
1116 uint8_t *__buf;
1117 };
1118
1120 struct net_buf_simple b;
1122 };
1123
1125 uint8_t user_data[] __net_buf_align;
1126};
1127
1129
1130struct net_buf_data_cb {
1131 uint8_t * __must_check (*alloc)(struct net_buf *buf, size_t *size,
1132 k_timeout_t timeout);
1133 uint8_t * __must_check (*ref)(struct net_buf *buf, uint8_t *data);
1134 void (*unref)(struct net_buf *buf, uint8_t *data);
1135};
1136
1137struct net_buf_data_alloc {
1138 const struct net_buf_data_cb *cb;
1139 void *alloc_data;
1140 size_t max_alloc_size;
1141 size_t alignment;
1142};
1143
1145
1153 struct k_lifo free;
1154
1157
1160
1163
1166
1167#if defined(CONFIG_NET_BUF_POOL_USAGE)
1169 atomic_t avail_count;
1170
1172 const uint16_t pool_size;
1173
1175 uint16_t max_used;
1176
1178 const char *name;
1179#endif /* CONFIG_NET_BUF_POOL_USAGE */
1180
1182 void (*const destroy)(struct net_buf *buf);
1183
1185 const struct net_buf_data_alloc *alloc;
1186
1188 struct net_buf * const __bufs;
1189};
1190
1192#define NET_BUF_POOL_USAGE_INIT(_pool, _count) \
1193 IF_ENABLED(CONFIG_NET_BUF_POOL_USAGE, (.avail_count = ATOMIC_INIT(_count),)) \
1194 IF_ENABLED(CONFIG_NET_BUF_POOL_USAGE, (.max_used = 0,)) \
1195 IF_ENABLED(CONFIG_NET_BUF_POOL_USAGE, (.name = STRINGIFY(_pool),))
1196
1197#define NET_BUF_POOL_INITIALIZER(_pool, _alloc, _bufs, _count, _ud_size, _destroy) \
1198 { \
1199 .free = Z_LIFO_INITIALIZER(_pool.free), \
1200 .lock = { }, \
1201 .buf_count = _count, \
1202 .uninit_count = _count, \
1203 .user_data_size = _ud_size, \
1204 NET_BUF_POOL_USAGE_INIT(_pool, _count) \
1205 .destroy = _destroy, \
1206 .alloc = _alloc, \
1207 .__bufs = (struct net_buf *)_bufs, \
1208 }
1209
1210#define _NET_BUF_ARRAY_DEFINE(_name, _count, _ud_size) \
1211 struct _net_buf_##_name { uint8_t b[sizeof(struct net_buf)]; \
1212 uint8_t ud[_ud_size]; } __net_buf_align; \
1213 BUILD_ASSERT(_ud_size <= UINT8_MAX); \
1214 BUILD_ASSERT(offsetof(struct net_buf, user_data) == \
1215 offsetof(struct _net_buf_##_name, ud), "Invalid offset"); \
1216 BUILD_ASSERT(__alignof__(struct net_buf) == \
1217 __alignof__(struct _net_buf_##_name), "Invalid alignment"); \
1218 BUILD_ASSERT(sizeof(struct _net_buf_##_name) == \
1219 ROUND_UP(sizeof(struct net_buf) + _ud_size, __alignof__(struct net_buf)), \
1220 "Size cannot be determined"); \
1221 static struct _net_buf_##_name _net_buf_##_name[_count] __noinit
1222
1223extern const struct net_buf_data_alloc net_buf_heap_alloc;
1225
1253#define NET_BUF_POOL_HEAP_DEFINE(_name, _count, _ud_size, _destroy) \
1254 _NET_BUF_ARRAY_DEFINE(_name, _count, _ud_size); \
1255 static STRUCT_SECTION_ITERABLE(net_buf_pool, _name) = \
1256 NET_BUF_POOL_INITIALIZER(_name, &net_buf_heap_alloc, \
1257 _net_buf_##_name, _count, _ud_size, \
1258 _destroy)
1259
1261
1262struct net_buf_pool_fixed {
1263 uint8_t *data_pool;
1264};
1265
1266extern const struct net_buf_data_cb net_buf_fixed_cb;
1267
1269
1298#define NET_BUF_POOL_FIXED_DEFINE(_name, _count, _data_size, _ud_size, _destroy) \
1299 _NET_BUF_ARRAY_DEFINE(_name, _count, _ud_size); \
1300 static uint8_t __noinit net_buf_data_##_name[_count][_data_size] __net_buf_align; \
1301 static const struct net_buf_pool_fixed net_buf_fixed_##_name = { \
1302 .data_pool = (uint8_t *)net_buf_data_##_name, \
1303 }; \
1304 static const struct net_buf_data_alloc net_buf_fixed_alloc_##_name = { \
1305 .cb = &net_buf_fixed_cb, \
1306 .alloc_data = (void *)&net_buf_fixed_##_name, \
1307 .max_alloc_size = _data_size, \
1308 }; \
1309 static STRUCT_SECTION_ITERABLE(net_buf_pool, _name) = \
1310 NET_BUF_POOL_INITIALIZER(_name, &net_buf_fixed_alloc_##_name, \
1311 _net_buf_##_name, _count, _ud_size, \
1312 _destroy)
1313
1315extern const struct net_buf_data_cb net_buf_var_cb;
1317
1342#define NET_BUF_POOL_VAR_DEFINE(_name, _count, _data_size, _ud_size, _destroy) \
1343 _NET_BUF_ARRAY_DEFINE(_name, _count, _ud_size); \
1344 K_HEAP_DEFINE(net_buf_mem_pool_##_name, _data_size); \
1345 static const struct net_buf_data_alloc net_buf_data_alloc_##_name = { \
1346 .cb = &net_buf_var_cb, \
1347 .alloc_data = &net_buf_mem_pool_##_name, \
1348 .max_alloc_size = 0, \
1349 }; \
1350 static STRUCT_SECTION_ITERABLE(net_buf_pool, _name) = \
1351 NET_BUF_POOL_INITIALIZER(_name, &net_buf_data_alloc_##_name, \
1352 _net_buf_##_name, _count, _ud_size, \
1353 _destroy)
1354
1385#define NET_BUF_POOL_VAR_ALIGN_DEFINE(_name, _count, _data_size, _ud_size, \
1386 _destroy, _align) \
1387 _NET_BUF_ARRAY_DEFINE(_name, _count, _ud_size); \
1388 K_HEAP_DEFINE(net_buf_mem_pool_##_name, _data_size); \
1389 static const struct net_buf_data_alloc net_buf_data_alloc_##_name = { \
1390 .cb = &net_buf_var_cb, \
1391 .alloc_data = &net_buf_mem_pool_##_name, \
1392 .max_alloc_size = 0, \
1393 .alignment = _align, \
1394 }; \
1395 static STRUCT_SECTION_ITERABLE(net_buf_pool, _name) = \
1396 NET_BUF_POOL_INITIALIZER(_name, &net_buf_data_alloc_##_name, \
1397 _net_buf_##_name, _count, _ud_size, \
1398 _destroy)
1399
1421#define NET_BUF_POOL_DEFINE(_name, _count, _size, _ud_size, _destroy) \
1422 NET_BUF_POOL_FIXED_DEFINE(_name, _count, _size, _ud_size, _destroy)
1423
1432
1445int net_buf_id(const struct net_buf *buf);
1446
1447#if defined(CONFIG_NET_BUF_POOL_USAGE) || defined(__DOXYGEN__)
1461static inline size_t net_buf_get_available(struct net_buf_pool *pool)
1462{
1463 return (size_t)atomic_get(&pool->avail_count);
1464}
1465
1475static inline size_t net_buf_get_max_used(struct net_buf_pool *pool)
1476{
1477 return (size_t)pool->max_used;
1478}
1479#endif /* defined(CONFIG_NET_BUF_POOL_USAGE) || defined(__DOXYGEN__) */
1480
1495#if defined(CONFIG_NET_BUF_LOG)
1496struct net_buf * __must_check net_buf_alloc_fixed_debug(struct net_buf_pool *pool,
1497 k_timeout_t timeout,
1498 const char *func,
1499 int line);
1500#define net_buf_alloc_fixed(_pool, _timeout) \
1501 net_buf_alloc_fixed_debug(_pool, _timeout, __func__, __LINE__)
1502#else
1503struct net_buf * __must_check net_buf_alloc_fixed(struct net_buf_pool *pool,
1504 k_timeout_t timeout);
1505#endif
1506
1510static inline struct net_buf * __must_check net_buf_alloc(struct net_buf_pool *pool,
1511 k_timeout_t timeout)
1512{
1513 return net_buf_alloc_fixed(pool, timeout);
1514}
1515
1531#if defined(CONFIG_NET_BUF_LOG)
1532struct net_buf * __must_check net_buf_alloc_len_debug(struct net_buf_pool *pool,
1533 size_t size,
1534 k_timeout_t timeout,
1535 const char *func,
1536 int line);
1537#define net_buf_alloc_len(_pool, _size, _timeout) \
1538 net_buf_alloc_len_debug(_pool, _size, _timeout, __func__, __LINE__)
1539#else
1540struct net_buf * __must_check net_buf_alloc_len(struct net_buf_pool *pool,
1541 size_t size,
1542 k_timeout_t timeout);
1543#endif
1544
1564#if defined(CONFIG_NET_BUF_LOG)
1565struct net_buf * __must_check net_buf_alloc_with_data_debug(struct net_buf_pool *pool,
1566 void *data, size_t size,
1567 k_timeout_t timeout,
1568 const char *func, int line);
1569#define net_buf_alloc_with_data(_pool, _data_, _size, _timeout) \
1570 net_buf_alloc_with_data_debug(_pool, _data_, _size, _timeout, \
1571 __func__, __LINE__)
1572#else
1573struct net_buf * __must_check net_buf_alloc_with_data(struct net_buf_pool *pool,
1574 void *data, size_t size,
1575 k_timeout_t timeout);
1576#endif
1577
1587static inline void net_buf_destroy(struct net_buf *buf)
1588{
1589 struct net_buf_pool *pool = net_buf_pool_get(buf->pool_id);
1590
1591 if (buf->__buf) {
1592 if (!(buf->flags & NET_BUF_EXTERNAL_DATA)) {
1593 pool->alloc->cb->unref(buf, buf->__buf);
1594 }
1595 buf->__buf = NULL;
1596 }
1597
1598 k_lifo_put(&pool->free, buf);
1599}
1600
1608void net_buf_reset(struct net_buf *buf);
1609
1618void net_buf_simple_reserve(struct net_buf_simple *buf, size_t reserve);
1619
1626void net_buf_slist_put(sys_slist_t *list, struct net_buf *buf);
1627
1635struct net_buf * __must_check net_buf_slist_get(sys_slist_t *list);
1636
1644#if defined(CONFIG_NET_BUF_LOG)
1645void net_buf_unref_debug(struct net_buf *buf, const char *func, int line);
1646#define net_buf_unref(_buf) \
1647 net_buf_unref_debug(_buf, __func__, __LINE__)
1648#else
1649void net_buf_unref(struct net_buf *buf);
1650#endif
1651
1659struct net_buf * __must_check net_buf_ref(struct net_buf *buf);
1660
1674struct net_buf * __must_check net_buf_clone(struct net_buf *buf,
1675 k_timeout_t timeout);
1676
1684static inline void * __must_check net_buf_user_data(const struct net_buf *buf)
1685{
1686 return (void *)buf->user_data;
1687}
1688
1698int net_buf_user_data_copy(struct net_buf *dst, const struct net_buf *src);
1699
1708static inline void net_buf_reserve(struct net_buf *buf, size_t reserve)
1709{
1710 net_buf_simple_reserve(&buf->b, reserve);
1711}
1712
1724static inline void *net_buf_add(struct net_buf *buf, size_t len)
1725{
1726 return net_buf_simple_add(&buf->b, len);
1727}
1728
1741static inline void *net_buf_add_mem(struct net_buf *buf, const void *mem,
1742 size_t len)
1743{
1744 return net_buf_simple_add_mem(&buf->b, mem, len);
1745}
1746
1758static inline uint8_t *net_buf_add_u8(struct net_buf *buf, uint8_t val)
1759{
1760 return net_buf_simple_add_u8(&buf->b, val);
1761}
1762
1773static inline void net_buf_add_le16(struct net_buf *buf, uint16_t val)
1774{
1775 net_buf_simple_add_le16(&buf->b, val);
1776}
1777
1788static inline void net_buf_add_be16(struct net_buf *buf, uint16_t val)
1789{
1790 net_buf_simple_add_be16(&buf->b, val);
1791}
1792
1803static inline void net_buf_add_le24(struct net_buf *buf, uint32_t val)
1804{
1805 net_buf_simple_add_le24(&buf->b, val);
1806}
1807
1818static inline void net_buf_add_be24(struct net_buf *buf, uint32_t val)
1819{
1820 net_buf_simple_add_be24(&buf->b, val);
1821}
1822
1833static inline void net_buf_add_le32(struct net_buf *buf, uint32_t val)
1834{
1835 net_buf_simple_add_le32(&buf->b, val);
1836}
1837
1848static inline void net_buf_add_be32(struct net_buf *buf, uint32_t val)
1849{
1850 net_buf_simple_add_be32(&buf->b, val);
1851}
1852
1863static inline void net_buf_add_le40(struct net_buf *buf, uint64_t val)
1864{
1865 net_buf_simple_add_le40(&buf->b, val);
1866}
1867
1878static inline void net_buf_add_be40(struct net_buf *buf, uint64_t val)
1879{
1880 net_buf_simple_add_be40(&buf->b, val);
1881}
1882
1893static inline void net_buf_add_le48(struct net_buf *buf, uint64_t val)
1894{
1895 net_buf_simple_add_le48(&buf->b, val);
1896}
1897
1908static inline void net_buf_add_be48(struct net_buf *buf, uint64_t val)
1909{
1910 net_buf_simple_add_be48(&buf->b, val);
1911}
1912
1923static inline void net_buf_add_le64(struct net_buf *buf, uint64_t val)
1924{
1925 net_buf_simple_add_le64(&buf->b, val);
1926}
1927
1938static inline void net_buf_add_be64(struct net_buf *buf, uint64_t val)
1939{
1940 net_buf_simple_add_be64(&buf->b, val);
1941}
1942
1953static inline void *net_buf_remove_mem(struct net_buf *buf, size_t len)
1954{
1955 return net_buf_simple_remove_mem(&buf->b, len);
1956}
1957
1968static inline uint8_t net_buf_remove_u8(struct net_buf *buf)
1969{
1970 return net_buf_simple_remove_u8(&buf->b);
1971}
1972
1983static inline uint16_t net_buf_remove_le16(struct net_buf *buf)
1984{
1985 return net_buf_simple_remove_le16(&buf->b);
1986}
1987
1998static inline uint16_t net_buf_remove_be16(struct net_buf *buf)
1999{
2000 return net_buf_simple_remove_be16(&buf->b);
2001}
2002
2013static inline uint32_t net_buf_remove_be24(struct net_buf *buf)
2014{
2015 return net_buf_simple_remove_be24(&buf->b);
2016}
2017
2028static inline uint32_t net_buf_remove_le24(struct net_buf *buf)
2029{
2030 return net_buf_simple_remove_le24(&buf->b);
2031}
2032
2043static inline uint32_t net_buf_remove_le32(struct net_buf *buf)
2044{
2045 return net_buf_simple_remove_le32(&buf->b);
2046}
2047
2058static inline uint32_t net_buf_remove_be32(struct net_buf *buf)
2059{
2060 return net_buf_simple_remove_be32(&buf->b);
2061}
2062
2073static inline uint64_t net_buf_remove_le40(struct net_buf *buf)
2074{
2075 return net_buf_simple_remove_le40(&buf->b);
2076}
2077
2088static inline uint64_t net_buf_remove_be40(struct net_buf *buf)
2089{
2090 return net_buf_simple_remove_be40(&buf->b);
2091}
2092
2103static inline uint64_t net_buf_remove_le48(struct net_buf *buf)
2104{
2105 return net_buf_simple_remove_le48(&buf->b);
2106}
2107
2118static inline uint64_t net_buf_remove_be48(struct net_buf *buf)
2119{
2120 return net_buf_simple_remove_be48(&buf->b);
2121}
2122
2133static inline uint64_t net_buf_remove_le64(struct net_buf *buf)
2134{
2135 return net_buf_simple_remove_le64(&buf->b);
2136}
2137
2148static inline uint64_t net_buf_remove_be64(struct net_buf *buf)
2149{
2150 return net_buf_simple_remove_be64(&buf->b);
2151}
2152
2164static inline void *net_buf_push(struct net_buf *buf, size_t len)
2165{
2166 return net_buf_simple_push(&buf->b, len);
2167}
2168
2181static inline void *net_buf_push_mem(struct net_buf *buf, const void *mem,
2182 size_t len)
2183{
2184 return net_buf_simple_push_mem(&buf->b, mem, len);
2185}
2186
2195static inline void net_buf_push_u8(struct net_buf *buf, uint8_t val)
2196{
2197 net_buf_simple_push_u8(&buf->b, val);
2198}
2199
2209static inline void net_buf_push_le16(struct net_buf *buf, uint16_t val)
2210{
2211 net_buf_simple_push_le16(&buf->b, val);
2212}
2213
2223static inline void net_buf_push_be16(struct net_buf *buf, uint16_t val)
2224{
2225 net_buf_simple_push_be16(&buf->b, val);
2226}
2227
2237static inline void net_buf_push_le24(struct net_buf *buf, uint32_t val)
2238{
2239 net_buf_simple_push_le24(&buf->b, val);
2240}
2241
2251static inline void net_buf_push_be24(struct net_buf *buf, uint32_t val)
2252{
2253 net_buf_simple_push_be24(&buf->b, val);
2254}
2255
2265static inline void net_buf_push_le32(struct net_buf *buf, uint32_t val)
2266{
2267 net_buf_simple_push_le32(&buf->b, val);
2268}
2269
2279static inline void net_buf_push_be32(struct net_buf *buf, uint32_t val)
2280{
2281 net_buf_simple_push_be32(&buf->b, val);
2282}
2283
2293static inline void net_buf_push_le40(struct net_buf *buf, uint64_t val)
2294{
2295 net_buf_simple_push_le40(&buf->b, val);
2296}
2297
2307static inline void net_buf_push_be40(struct net_buf *buf, uint64_t val)
2308{
2309 net_buf_simple_push_be40(&buf->b, val);
2310}
2311
2321static inline void net_buf_push_le48(struct net_buf *buf, uint64_t val)
2322{
2323 net_buf_simple_push_le48(&buf->b, val);
2324}
2325
2335static inline void net_buf_push_be48(struct net_buf *buf, uint64_t val)
2336{
2337 net_buf_simple_push_be48(&buf->b, val);
2338}
2339
2349static inline void net_buf_push_le64(struct net_buf *buf, uint64_t val)
2350{
2351 net_buf_simple_push_le64(&buf->b, val);
2352}
2353
2363static inline void net_buf_push_be64(struct net_buf *buf, uint64_t val)
2364{
2365 net_buf_simple_push_be64(&buf->b, val);
2366}
2367
2379static inline void *net_buf_pull(struct net_buf *buf, size_t len)
2380{
2381 return net_buf_simple_pull(&buf->b, len);
2382}
2383
2395static inline void *net_buf_pull_mem(struct net_buf *buf, size_t len)
2396{
2397 return net_buf_simple_pull_mem(&buf->b, len);
2398}
2399
2410static inline uint8_t net_buf_pull_u8(struct net_buf *buf)
2411{
2412 return net_buf_simple_pull_u8(&buf->b);
2413}
2414
2425static inline uint16_t net_buf_pull_le16(struct net_buf *buf)
2426{
2427 return net_buf_simple_pull_le16(&buf->b);
2428}
2429
2440static inline uint16_t net_buf_pull_be16(struct net_buf *buf)
2441{
2442 return net_buf_simple_pull_be16(&buf->b);
2443}
2444
2455static inline uint32_t net_buf_pull_le24(struct net_buf *buf)
2456{
2457 return net_buf_simple_pull_le24(&buf->b);
2458}
2459
2470static inline uint32_t net_buf_pull_be24(struct net_buf *buf)
2471{
2472 return net_buf_simple_pull_be24(&buf->b);
2473}
2474
2485static inline uint32_t net_buf_pull_le32(struct net_buf *buf)
2486{
2487 return net_buf_simple_pull_le32(&buf->b);
2488}
2489
2500static inline uint32_t net_buf_pull_be32(struct net_buf *buf)
2501{
2502 return net_buf_simple_pull_be32(&buf->b);
2503}
2504
2515static inline uint64_t net_buf_pull_le40(struct net_buf *buf)
2516{
2517 return net_buf_simple_pull_le40(&buf->b);
2518}
2519
2530static inline uint64_t net_buf_pull_be40(struct net_buf *buf)
2531{
2532 return net_buf_simple_pull_be40(&buf->b);
2533}
2534
2545static inline uint64_t net_buf_pull_le48(struct net_buf *buf)
2546{
2547 return net_buf_simple_pull_le48(&buf->b);
2548}
2549
2560static inline uint64_t net_buf_pull_be48(struct net_buf *buf)
2561{
2562 return net_buf_simple_pull_be48(&buf->b);
2563}
2564
2575static inline uint64_t net_buf_pull_le64(struct net_buf *buf)
2576{
2577 return net_buf_simple_pull_le64(&buf->b);
2578}
2579
2590static inline uint64_t net_buf_pull_be64(struct net_buf *buf)
2591{
2592 return net_buf_simple_pull_be64(&buf->b);
2593}
2594
2604static inline size_t net_buf_tailroom(const struct net_buf *buf)
2605{
2606 return net_buf_simple_tailroom(&buf->b);
2607}
2608
2618static inline size_t net_buf_headroom(const struct net_buf *buf)
2619{
2620 return net_buf_simple_headroom(&buf->b);
2621}
2622
2632static inline uint16_t net_buf_max_len(const struct net_buf *buf)
2633{
2634 return net_buf_simple_max_len(&buf->b);
2635}
2636
2646static inline uint8_t *net_buf_tail(const struct net_buf *buf)
2647{
2648 return net_buf_simple_tail(&buf->b);
2649}
2650
2657
2669void net_buf_frag_insert(struct net_buf *parent, struct net_buf *frag);
2670
2685struct net_buf *net_buf_frag_add(struct net_buf *head, struct net_buf *frag);
2686
2696#if defined(CONFIG_NET_BUF_LOG)
2697struct net_buf *net_buf_frag_del_debug(struct net_buf *parent,
2698 struct net_buf *frag,
2699 const char *func, int line);
2700#define net_buf_frag_del(_parent, _frag) \
2701 net_buf_frag_del_debug(_parent, _frag, __func__, __LINE__)
2702#else
2703struct net_buf *net_buf_frag_del(struct net_buf *parent, struct net_buf *frag);
2704#endif
2705
2721size_t net_buf_linearize(void *dst, size_t dst_len,
2722 const struct net_buf *src, size_t offset, size_t len);
2723
2738typedef struct net_buf * __must_check (*net_buf_allocator_cb)(k_timeout_t timeout,
2739 void *user_data);
2740
2762size_t net_buf_append_bytes(struct net_buf *buf, size_t len,
2763 const void *value, k_timeout_t timeout,
2764 net_buf_allocator_cb allocate_cb, void *user_data);
2765
2780size_t net_buf_data_match(const struct net_buf *buf, size_t offset, const void *data, size_t len);
2781
2797static inline struct net_buf *net_buf_skip(struct net_buf *buf, size_t len)
2798{
2799 while (buf && len--) {
2800 net_buf_pull_u8(buf);
2801 if (!buf->len) {
2802 buf = net_buf_frag_del(NULL, buf);
2803 }
2804 }
2805
2806 return buf;
2807}
2808
2819static inline size_t net_buf_frags_len(const struct net_buf *buf)
2820{
2821 size_t bytes = 0;
2822
2823 while (buf) {
2824 bytes += buf->len;
2825 buf = buf->frags;
2826 }
2827
2828 return bytes;
2829}
2830
2834
2835#ifdef __cplusplus
2836}
2837#endif
2838
2839#endif /* ZEPHYR_INCLUDE_NET_BUF_H_ */
long atomic_t
Definition atomic_types.h:15
atomic_val_t atomic_get(const atomic_t *target)
Atomic get.
#define k_lifo_put(lifo, data)
Add an element to a LIFO queue.
Definition kernel.h:3204
void net_buf_simple_clone(const struct net_buf_simple *original, struct net_buf_simple *clone)
Clone buffer state, using the same data buffer.
static void net_buf_simple_init(struct net_buf_simple *buf, size_t reserve_head)
Initialize a net_buf_simple object.
Definition net_buf.h:142
struct net_buf * net_buf_frag_last(struct net_buf *frags)
Find the last fragment in the fragment list.
static uint64_t net_buf_pull_be40(struct net_buf *buf)
Remove and convert 40 bits from the beginning of the buffer.
Definition net_buf.h:2530
static void net_buf_add_be64(struct net_buf *buf, uint64_t val)
Add 64-bit value at the end of the buffer.
Definition net_buf.h:1938
uint8_t net_buf_simple_pull_u8(struct net_buf_simple *buf)
Remove a 8-bit value from the beginning of the buffer.
uint16_t net_buf_simple_remove_le16(struct net_buf_simple *buf)
Remove and convert 16 bits from the end of the buffer.
static uint64_t net_buf_remove_le48(struct net_buf *buf)
Remove and convert 48 bits from the end of the buffer.
Definition net_buf.h:2103
struct net_buf * net_buf_frag_add(struct net_buf *head, struct net_buf *frag)
Add a new fragment to the end of a chain of bufs.
void net_buf_simple_reserve(struct net_buf_simple *buf, size_t reserve)
Initialize buffer with the given headroom.
void net_buf_simple_push_u8(struct net_buf_simple *buf, uint8_t val)
Push 8-bit value to the beginning of the buffer.
static void net_buf_add_be24(struct net_buf *buf, uint32_t val)
Add 24-bit value at the end of the buffer.
Definition net_buf.h:1818
struct net_buf * net_buf_alloc_len(struct net_buf_pool *pool, size_t size, k_timeout_t timeout)
Allocate a new variable length buffer from a pool.
void net_buf_reset(struct net_buf *buf)
Reset buffer.
struct net_buf_pool * net_buf_pool_get(int id)
Looks up a pool based on its ID.
void * net_buf_simple_add(struct net_buf_simple *buf, size_t len)
Prepare data to be added at the end of the buffer.
uint64_t net_buf_simple_pull_be48(struct net_buf_simple *buf)
Remove and convert 48 bits from the beginning of the buffer.
uint32_t net_buf_simple_pull_be32(struct net_buf_simple *buf)
Remove and convert 32 bits from the beginning of the buffer.
void net_buf_simple_push_be48(struct net_buf_simple *buf, uint64_t val)
Push 48-bit value to the beginning of the buffer.
struct net_buf * net_buf_slist_get(sys_slist_t *list)
Get a buffer from a list.
struct net_buf * net_buf_ref(struct net_buf *buf)
Increment the reference count of a buffer.
uint64_t net_buf_simple_remove_le40(struct net_buf_simple *buf)
Remove and convert 40 bits from the end of the buffer.
static struct net_buf * net_buf_skip(struct net_buf *buf, size_t len)
Skip N number of bytes in a net_buf.
Definition net_buf.h:2797
static void * net_buf_add(struct net_buf *buf, size_t len)
Prepare data to be added at the end of the buffer.
Definition net_buf.h:1724
static void net_buf_add_le24(struct net_buf *buf, uint32_t val)
Add 24-bit value at the end of the buffer.
Definition net_buf.h:1803
static uint64_t net_buf_pull_le40(struct net_buf *buf)
Remove and convert 40 bits from the beginning of the buffer.
Definition net_buf.h:2515
uint32_t net_buf_simple_pull_le32(struct net_buf_simple *buf)
Remove and convert 32 bits from the beginning of the buffer.
void net_buf_simple_add_le32(struct net_buf_simple *buf, uint32_t val)
Add 32-bit value at the end of the buffer.
static uint64_t net_buf_pull_be64(struct net_buf *buf)
Remove and convert 64 bits from the beginning of the buffer.
Definition net_buf.h:2590
static void net_buf_push_be64(struct net_buf *buf, uint64_t val)
Push 64-bit value to the beginning of the buffer.
Definition net_buf.h:2363
static uint64_t net_buf_remove_le64(struct net_buf *buf)
Remove and convert 64 bits from the end of the buffer.
Definition net_buf.h:2133
static void net_buf_simple_reset(struct net_buf_simple *buf)
Reset buffer.
Definition net_buf.h:172
uint32_t net_buf_simple_pull_be24(struct net_buf_simple *buf)
Remove and convert 24 bits from the beginning of the buffer.
uint32_t net_buf_simple_pull_le24(struct net_buf_simple *buf)
Remove and convert 24 bits from the beginning of the buffer.
int net_buf_user_data_copy(struct net_buf *dst, const struct net_buf *src)
Copy user data from one to another buffer.
uint32_t net_buf_simple_remove_le24(struct net_buf_simple *buf)
Remove and convert 24 bits from the end of the buffer.
void net_buf_simple_push_le16(struct net_buf_simple *buf, uint16_t val)
Push 16-bit value to the beginning of the buffer.
static void net_buf_push_be40(struct net_buf *buf, uint64_t val)
Push 40-bit value to the beginning of the buffer.
Definition net_buf.h:2307
static struct net_buf * net_buf_alloc(struct net_buf_pool *pool, k_timeout_t timeout)
Definition net_buf.h:1510
static void net_buf_add_be32(struct net_buf *buf, uint32_t val)
Add 32-bit value at the end of the buffer.
Definition net_buf.h:1848
uint64_t net_buf_simple_remove_le64(struct net_buf_simple *buf)
Remove and convert 64 bits from the end of the buffer.
static uint64_t net_buf_remove_le40(struct net_buf *buf)
Remove and convert 40 bits from the end of the buffer.
Definition net_buf.h:2073
void net_buf_simple_add_le48(struct net_buf_simple *buf, uint64_t val)
Add 48-bit value at the end of the buffer.
static uint16_t net_buf_remove_be16(struct net_buf *buf)
Remove and convert 16 bits from the end of the buffer.
Definition net_buf.h:1998
void net_buf_simple_add_be24(struct net_buf_simple *buf, uint32_t val)
Add 24-bit value at the end of the buffer.
static uint32_t net_buf_pull_le32(struct net_buf *buf)
Remove and convert 32 bits from the beginning of the buffer.
Definition net_buf.h:2485
static uint32_t net_buf_pull_be32(struct net_buf *buf)
Remove and convert 32 bits from the beginning of the buffer.
Definition net_buf.h:2500
struct net_buf * net_buf_frag_del(struct net_buf *parent, struct net_buf *frag)
Delete existing fragment from a chain of bufs.
uint64_t net_buf_simple_remove_be64(struct net_buf_simple *buf)
Remove and convert 64 bits from the end of the buffer.
static void net_buf_add_be16(struct net_buf *buf, uint16_t val)
Add 16-bit value at the end of the buffer.
Definition net_buf.h:1788
static void net_buf_add_le40(struct net_buf *buf, uint64_t val)
Add 40-bit value at the end of the buffer.
Definition net_buf.h:1863
size_t net_buf_append_bytes(struct net_buf *buf, size_t len, const void *value, k_timeout_t timeout, net_buf_allocator_cb allocate_cb, void *user_data)
Append data to a list of net_buf.
void * net_buf_simple_push(struct net_buf_simple *buf, size_t len)
Prepare data to be added to the start of the buffer.
static uint16_t net_buf_max_len(const struct net_buf *buf)
Check maximum net_buf::len value.
Definition net_buf.h:2632
void net_buf_simple_push_le48(struct net_buf_simple *buf, uint64_t val)
Push 48-bit value to the beginning of the buffer.
void net_buf_simple_add_le40(struct net_buf_simple *buf, uint64_t val)
Add 40-bit value at the end of the buffer.
struct net_buf * net_buf_alloc_fixed(struct net_buf_pool *pool, k_timeout_t timeout)
Allocate a new fixed buffer from a pool.
static uint64_t net_buf_pull_be48(struct net_buf *buf)
Remove and convert 48 bits from the beginning of the buffer.
Definition net_buf.h:2560
void net_buf_simple_add_be40(struct net_buf_simple *buf, uint64_t val)
Add 40-bit value at the end of the buffer.
uint64_t net_buf_simple_pull_le48(struct net_buf_simple *buf)
Remove and convert 48 bits from the beginning of the buffer.
void net_buf_slist_put(sys_slist_t *list, struct net_buf *buf)
Put a buffer into a list.
static void net_buf_push_be16(struct net_buf *buf, uint16_t val)
Push 16-bit value to the beginning of the buffer.
Definition net_buf.h:2223
static uint32_t net_buf_remove_be24(struct net_buf *buf)
Remove and convert 24 bits from the end of the buffer.
Definition net_buf.h:2013
static void net_buf_add_be40(struct net_buf *buf, uint64_t val)
Add 40-bit value at the end of the buffer.
Definition net_buf.h:1878
static uint8_t net_buf_pull_u8(struct net_buf *buf)
Remove a 8-bit value from the beginning of the buffer.
Definition net_buf.h:2410
static void net_buf_destroy(struct net_buf *buf)
Destroy buffer from custom destroy callback.
Definition net_buf.h:1587
static size_t net_buf_simple_tailroom(const struct net_buf_simple *buf)
Check buffer tailroom.
Definition net_buf.h:933
void net_buf_simple_push_le40(struct net_buf_simple *buf, uint64_t val)
Push 40-bit value to the beginning of the buffer.
static uint16_t net_buf_simple_max_len(const struct net_buf_simple *buf)
Check maximum net_buf_simple::len value.
Definition net_buf.h:947
void net_buf_simple_push_le64(struct net_buf_simple *buf, uint64_t val)
Push 64-bit value to the beginning of the buffer.
void net_buf_simple_add_le64(struct net_buf_simple *buf, uint64_t val)
Add 64-bit value at the end of the buffer.
uint64_t net_buf_simple_pull_le64(struct net_buf_simple *buf)
Remove and convert 64 bits from the beginning of the buffer.
static void * net_buf_push_mem(struct net_buf *buf, const void *mem, size_t len)
Copies the given number of bytes to the start of the buffer.
Definition net_buf.h:2181
static uint64_t net_buf_pull_le48(struct net_buf *buf)
Remove and convert 48 bits from the beginning of the buffer.
Definition net_buf.h:2545
void net_buf_simple_init_with_data(struct net_buf_simple *buf, void *data, size_t size)
Initialize a net_buf_simple object with data.
void net_buf_simple_push_be16(struct net_buf_simple *buf, uint16_t val)
Push 16-bit value to the beginning of the buffer.
void * net_buf_simple_remove_mem(struct net_buf_simple *buf, size_t len)
Remove data from the end of the buffer.
static void net_buf_push_le48(struct net_buf *buf, uint64_t val)
Push 48-bit value to the beginning of the buffer.
Definition net_buf.h:2321
static uint32_t net_buf_pull_le24(struct net_buf *buf)
Remove and convert 24 bits from the beginning of the buffer.
Definition net_buf.h:2455
void net_buf_simple_push_le32(struct net_buf_simple *buf, uint32_t val)
Push 32-bit value to the beginning of the buffer.
static uint8_t * net_buf_add_u8(struct net_buf *buf, uint8_t val)
Add (8-bit) byte at the end of the buffer.
Definition net_buf.h:1758
static void net_buf_push_be24(struct net_buf *buf, uint32_t val)
Push 24-bit value to the beginning of the buffer.
Definition net_buf.h:2251
static void net_buf_push_le24(struct net_buf *buf, uint32_t val)
Push 24-bit value to the beginning of the buffer.
Definition net_buf.h:2237
static void net_buf_reserve(struct net_buf *buf, size_t reserve)
Initialize buffer with the given headroom.
Definition net_buf.h:1708
static uint64_t net_buf_remove_be64(struct net_buf *buf)
Remove and convert 64 bits from the end of the buffer.
Definition net_buf.h:2148
struct net_buf * net_buf_alloc_with_data(struct net_buf_pool *pool, void *data, size_t size, k_timeout_t timeout)
Allocate a new buffer from a pool but with external data pointer.
static uint32_t net_buf_pull_be24(struct net_buf *buf)
Remove and convert 24 bits from the beginning of the buffer.
Definition net_buf.h:2470
void net_buf_simple_add_be64(struct net_buf_simple *buf, uint64_t val)
Add 64-bit value at the end of the buffer.
static void net_buf_add_be48(struct net_buf *buf, uint64_t val)
Add 48-bit value at the end of the buffer.
Definition net_buf.h:1908
uint8_t * net_buf_simple_add_u8(struct net_buf_simple *buf, uint8_t val)
Add (8-bit) byte at the end of the buffer.
static uint32_t net_buf_remove_le24(struct net_buf *buf)
Remove and convert 24 bits from the end of the buffer.
Definition net_buf.h:2028
static void net_buf_push_u8(struct net_buf *buf, uint8_t val)
Push 8-bit value to the beginning of the buffer.
Definition net_buf.h:2195
void net_buf_simple_add_be16(struct net_buf_simple *buf, uint16_t val)
Add 16-bit value at the end of the buffer.
uint16_t net_buf_simple_remove_be16(struct net_buf_simple *buf)
Remove and convert 16 bits from the end of the buffer.
static void * net_buf_push(struct net_buf *buf, size_t len)
Prepare data to be added at the start of the buffer.
Definition net_buf.h:2164
static uint16_t net_buf_pull_be16(struct net_buf *buf)
Remove and convert 16 bits from the beginning of the buffer.
Definition net_buf.h:2440
static void net_buf_push_le32(struct net_buf *buf, uint32_t val)
Push 32-bit value to the beginning of the buffer.
Definition net_buf.h:2265
static uint64_t net_buf_pull_le64(struct net_buf *buf)
Remove and convert 64 bits from the beginning of the buffer.
Definition net_buf.h:2575
uint64_t net_buf_simple_remove_be40(struct net_buf_simple *buf)
Remove and convert 40 bits from the end of the buffer.
uint32_t net_buf_simple_remove_be24(struct net_buf_simple *buf)
Remove and convert 24 bits from the end of the buffer.
struct net_buf *(* net_buf_allocator_cb)(k_timeout_t timeout, void *user_data)
Network buffer allocator callback.
Definition net_buf.h:2738
void * net_buf_simple_pull_mem(struct net_buf_simple *buf, size_t len)
Remove data from the beginning of the buffer.
static size_t net_buf_get_available(struct net_buf_pool *pool)
Get the number of buffers currently available to claim from a pool.
Definition net_buf.h:1461
uint32_t net_buf_simple_remove_le32(struct net_buf_simple *buf)
Remove and convert 32 bits from the end of the buffer.
void net_buf_simple_add_le16(struct net_buf_simple *buf, uint16_t val)
Add 16-bit value at the end of the buffer.
uint64_t net_buf_simple_pull_be40(struct net_buf_simple *buf)
Remove and convert 40 bits from the beginning of the buffer.
static uint8_t * net_buf_simple_tail(const struct net_buf_simple *buf)
Get the tail pointer for a buffer.
Definition net_buf.h:905
void * net_buf_simple_push_mem(struct net_buf_simple *buf, const void *mem, size_t len)
Copy given number of bytes from memory to the start of the buffer.
static uint64_t net_buf_remove_be48(struct net_buf *buf)
Remove and convert 48 bits from the end of the buffer.
Definition net_buf.h:2118
void net_buf_simple_add_be32(struct net_buf_simple *buf, uint32_t val)
Add 32-bit value at the end of the buffer.
#define NET_BUF_EXTERNAL_DATA
Flag indicating that the buffer's associated data pointer, points to externally allocated memory.
Definition net_buf.h:1006
static uint16_t net_buf_remove_le16(struct net_buf *buf)
Remove and convert 16 bits from the end of the buffer.
Definition net_buf.h:1983
static void net_buf_push_le16(struct net_buf *buf, uint16_t val)
Push 16-bit value to the beginning of the buffer.
Definition net_buf.h:2209
uint64_t net_buf_simple_remove_be48(struct net_buf_simple *buf)
Remove and convert 48 bits from the end of the buffer.
void net_buf_simple_push_le24(struct net_buf_simple *buf, uint32_t val)
Push 24-bit value to the beginning of the buffer.
void net_buf_unref(struct net_buf *buf)
Decrements the reference count of a buffer.
static void net_buf_simple_save(const struct net_buf_simple *buf, struct net_buf_simple_state *state)
Save the parsing state of a buffer.
Definition net_buf.h:974
static void net_buf_push_be48(struct net_buf *buf, uint64_t val)
Push 48-bit value to the beginning of the buffer.
Definition net_buf.h:2335
void net_buf_simple_push_be24(struct net_buf_simple *buf, uint32_t val)
Push 24-bit value to the beginning of the buffer.
void net_buf_frag_insert(struct net_buf *parent, struct net_buf *frag)
Insert a new fragment to a chain of bufs.
uint64_t net_buf_simple_remove_le48(struct net_buf_simple *buf)
Remove and convert 48 bits from the end of the buffer.
void * net_buf_simple_add_mem(struct net_buf_simple *buf, const void *mem, size_t len)
Copy given number of bytes from memory to the end of the buffer.
static void net_buf_add_le64(struct net_buf *buf, uint64_t val)
Add 64-bit value at the end of the buffer.
Definition net_buf.h:1923
static size_t net_buf_headroom(const struct net_buf *buf)
Check buffer headroom.
Definition net_buf.h:2618
static uint32_t net_buf_remove_be32(struct net_buf *buf)
Remove and convert 32 bits from the end of the buffer.
Definition net_buf.h:2058
int net_buf_id(const struct net_buf *buf)
Get a zero-based index for a buffer.
static void * net_buf_remove_mem(struct net_buf *buf, size_t len)
Remove data from the end of the buffer.
Definition net_buf.h:1953
static void * net_buf_add_mem(struct net_buf *buf, const void *mem, size_t len)
Copies the given number of bytes to the end of the buffer.
Definition net_buf.h:1741
uint64_t net_buf_simple_pull_be64(struct net_buf_simple *buf)
Remove and convert 64 bits from the beginning of the buffer.
void net_buf_simple_push_be32(struct net_buf_simple *buf, uint32_t val)
Push 32-bit value to the beginning of the buffer.
static void net_buf_push_le64(struct net_buf *buf, uint64_t val)
Push 64-bit value to the beginning of the buffer.
Definition net_buf.h:2349
uint16_t net_buf_simple_pull_le16(struct net_buf_simple *buf)
Remove and convert 16 bits from the beginning of the buffer.
static size_t net_buf_get_max_used(struct net_buf_pool *pool)
Get the maximum number of buffers simultaneously claimed from a pool.
Definition net_buf.h:1475
void net_buf_simple_push_be40(struct net_buf_simple *buf, uint64_t val)
Push 40-bit value to the beginning of the buffer.
uint64_t net_buf_simple_pull_le40(struct net_buf_simple *buf)
Remove and convert 40 bits from the beginning of the buffer.
static uint8_t net_buf_remove_u8(struct net_buf *buf)
Remove a 8-bit value from the end of the buffer.
Definition net_buf.h:1968
void net_buf_simple_add_be48(struct net_buf_simple *buf, uint64_t val)
Add 48-bit value at the end of the buffer.
static size_t net_buf_simple_headroom(const struct net_buf_simple *buf)
Check buffer headroom.
Definition net_buf.h:919
static void net_buf_add_le16(struct net_buf *buf, uint16_t val)
Add 16-bit value at the end of the buffer.
Definition net_buf.h:1773
static uint64_t net_buf_remove_be40(struct net_buf *buf)
Remove and convert 40 bits from the end of the buffer.
Definition net_buf.h:2088
uint16_t net_buf_simple_pull_be16(struct net_buf_simple *buf)
Remove and convert 16 bits from the beginning of the buffer.
static void net_buf_push_be32(struct net_buf *buf, uint32_t val)
Push 32-bit value to the beginning of the buffer.
Definition net_buf.h:2279
static void net_buf_add_le32(struct net_buf *buf, uint32_t val)
Add 32-bit value at the end of the buffer.
Definition net_buf.h:1833
uint32_t net_buf_simple_remove_be32(struct net_buf_simple *buf)
Remove and convert 32 bits from the end of the buffer.
static uint32_t net_buf_remove_le32(struct net_buf *buf)
Remove and convert 32 bits from the end of the buffer.
Definition net_buf.h:2043
static size_t net_buf_frags_len(const struct net_buf *buf)
Calculate amount of bytes stored in fragments.
Definition net_buf.h:2819
static size_t net_buf_tailroom(const struct net_buf *buf)
Check buffer tailroom.
Definition net_buf.h:2604
static uint16_t net_buf_pull_le16(struct net_buf *buf)
Remove and convert 16 bits from the beginning of the buffer.
Definition net_buf.h:2425
static uint8_t * net_buf_tail(const struct net_buf *buf)
Get the tail pointer for a buffer.
Definition net_buf.h:2646
static void * net_buf_pull_mem(struct net_buf *buf, size_t len)
Remove data from the beginning of the buffer.
Definition net_buf.h:2395
static void net_buf_simple_restore(struct net_buf_simple *buf, struct net_buf_simple_state *state)
Restore the parsing state of a buffer.
Definition net_buf.h:990
static void * net_buf_pull(struct net_buf *buf, size_t len)
Remove data from the beginning of the buffer.
Definition net_buf.h:2379
size_t net_buf_data_match(const struct net_buf *buf, size_t offset, const void *data, size_t len)
Match data with a net_buf's content.
static void net_buf_push_le40(struct net_buf *buf, uint64_t val)
Push 40-bit value to the beginning of the buffer.
Definition net_buf.h:2293
static void net_buf_add_le48(struct net_buf *buf, uint64_t val)
Add 48-bit value at the end of the buffer.
Definition net_buf.h:1893
void net_buf_simple_add_le24(struct net_buf_simple *buf, uint32_t val)
Add 24-bit value at the end of the buffer.
static void * net_buf_user_data(const struct net_buf *buf)
Get a pointer to the user data of a buffer.
Definition net_buf.h:1684
struct net_buf * net_buf_clone(struct net_buf *buf, k_timeout_t timeout)
Clone buffer.
uint8_t net_buf_simple_remove_u8(struct net_buf_simple *buf)
Remove a 8-bit value from the end of the buffer.
void * net_buf_simple_pull(struct net_buf_simple *buf, size_t len)
Remove data from the beginning of the buffer.
void net_buf_simple_push_be64(struct net_buf_simple *buf, uint64_t val)
Push 64-bit value to the beginning of the buffer.
size_t net_buf_linearize(void *dst, size_t dst_len, const struct net_buf *src, size_t offset, size_t len)
Copy bytes from net_buf chain starting at offset to linear buffer.
struct _slist sys_slist_t
Single-linked list structure.
Definition slist.h:49
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
#define NULL
Definition iar_missing_defs.h:20
Public kernel APIs.
state
Definition parser_state.h:29
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Kernel LIFO structure.
Definition kernel.h:3146
Kernel Spin Lock.
Definition spinlock.h:45
Kernel timeout type.
Definition clock.h:65
Network buffer pool representation.
Definition net_buf.h:1151
void(*const destroy)(struct net_buf *buf)
Optional destroy callback when buffer is freed.
Definition net_buf.h:1182
uint16_t uninit_count
Number of uninitialized buffers.
Definition net_buf.h:1162
uint8_t user_data_size
Size of user data allocated to this pool.
Definition net_buf.h:1165
const uint16_t buf_count
Number of buffers in pool.
Definition net_buf.h:1159
const struct net_buf_data_alloc * alloc
Data allocation handlers.
Definition net_buf.h:1185
struct k_lifo free
LIFO to place the buffer into when free.
Definition net_buf.h:1153
struct k_spinlock lock
To prevent concurrent access/modifications.
Definition net_buf.h:1156
Parsing state of a buffer.
Definition net_buf.h:959
uint16_t offset
Offset of the data pointer from the beginning of the storage.
Definition net_buf.h:961
uint16_t len
Length of data.
Definition net_buf.h:963
Simple network buffer representation.
Definition net_buf.h:89
uint8_t * data
Pointer to the start of data in the buffer.
Definition net_buf.h:91
uint16_t size
Amount of data that net_buf_simple::__buf can store.
Definition net_buf.h:101
uint16_t len
Length of the data behind the data pointer.
Definition net_buf.h:98
Network buffer representation.
Definition net_buf.h:1015
uint16_t size
Amount of data that this buffer can store.
Definition net_buf.h:1110
struct net_buf * frags
Fragments associated with this buffer.
Definition net_buf.h:1020
uint8_t ref
Reference count.
Definition net_buf.h:1083
uint8_t pool_id
Where the buffer should go when freed up.
Definition net_buf.h:1089
sys_snode_t node
Allow placing the buffer into sys_slist_t.
Definition net_buf.h:1017
uint8_t user_data_size
Size of user data on this buffer.
Definition net_buf.h:1092
uint8_t flags
Bit-field of buffer flags.
Definition net_buf.h:1086
uint8_t * data
Pointer to the start of data in the buffer.
Definition net_buf.h:1104
uint8_t user_data[]
System metadata for this buffer.
Definition net_buf.h:1125
uint16_t len
Length of the data behind the data pointer.
Definition net_buf.h:1107
Misc utilities.