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