@@ -1325,19 +1325,14 @@ int net_buf_id(const struct net_buf *buf);
1325
1325
/**
1326
1326
* @brief Allocate a new fixed buffer from a pool.
1327
1327
*
1328
- * @note Some types of data allocators do not support
1329
- * blocking (such as the HEAP type). In this case it's still possible
1330
- * for net_buf_alloc() to fail (return NULL) even if it was given
1331
- * K_FOREVER.
1332
- *
1333
- * @note The timeout value will be overridden to K_NO_WAIT if called from the
1334
- * system workqueue.
1335
- *
1336
1328
* @param pool Which pool to allocate the buffer from.
1337
1329
* @param timeout Affects the action taken should the pool be empty.
1338
1330
* If K_NO_WAIT, then return immediately. If K_FOREVER, then
1339
1331
* wait as long as necessary. Otherwise, wait until the specified
1340
- * timeout.
1332
+ * timeout. Note that some types of data allocators do not support
1333
+ * blocking (such as the HEAP type). In this case it's still possible
1334
+ * for net_buf_alloc() to fail (return NULL) even if it was given
1335
+ * K_FOREVER.
1341
1336
*
1342
1337
* @return New buffer or NULL if out of buffers.
1343
1338
*/
@@ -1365,20 +1360,15 @@ static inline struct net_buf * __must_check net_buf_alloc(struct net_buf_pool *p
1365
1360
/**
1366
1361
* @brief Allocate a new variable length buffer from a pool.
1367
1362
*
1368
- * @note Some types of data allocators do not support
1369
- * blocking (such as the HEAP type). In this case it's still possible
1370
- * for net_buf_alloc() to fail (return NULL) even if it was given
1371
- * K_FOREVER.
1372
- *
1373
- * @note The timeout value will be overridden to K_NO_WAIT if called from the
1374
- * system workqueue.
1375
- *
1376
1363
* @param pool Which pool to allocate the buffer from.
1377
1364
* @param size Amount of data the buffer must be able to fit.
1378
1365
* @param timeout Affects the action taken should the pool be empty.
1379
1366
* If K_NO_WAIT, then return immediately. If K_FOREVER, then
1380
1367
* wait as long as necessary. Otherwise, wait until the specified
1381
- * timeout.
1368
+ * timeout. Note that some types of data allocators do not support
1369
+ * blocking (such as the HEAP type). In this case it's still possible
1370
+ * for net_buf_alloc() to fail (return NULL) even if it was given
1371
+ * K_FOREVER.
1382
1372
*
1383
1373
* @return New buffer or NULL if out of buffers.
1384
1374
*/
@@ -1402,21 +1392,16 @@ struct net_buf * __must_check net_buf_alloc_len(struct net_buf_pool *pool,
1402
1392
* Allocate a new buffer from a pool, where the data pointer comes from the
1403
1393
* user and not from the pool.
1404
1394
*
1405
- * @note Some types of data allocators do not support
1406
- * blocking (such as the HEAP type). In this case it's still possible
1407
- * for net_buf_alloc() to fail (return NULL) even if it was given
1408
- * K_FOREVER.
1409
- *
1410
- * @note The timeout value will be overridden to K_NO_WAIT if called from the
1411
- * system workqueue.
1412
- *
1413
1395
* @param pool Which pool to allocate the buffer from.
1414
1396
* @param data External data pointer
1415
1397
* @param size Amount of data the pointed data buffer if able to fit.
1416
1398
* @param timeout Affects the action taken should the pool be empty.
1417
1399
* If K_NO_WAIT, then return immediately. If K_FOREVER, then
1418
1400
* wait as long as necessary. Otherwise, wait until the specified
1419
- * timeout.
1401
+ * timeout. Note that some types of data allocators do not support
1402
+ * blocking (such as the HEAP type). In this case it's still possible
1403
+ * for net_buf_alloc() to fail (return NULL) even if it was given
1404
+ * K_FOREVER.
1420
1405
*
1421
1406
* @return New buffer or NULL if out of buffers.
1422
1407
*/
0 commit comments