espressif/esp-nimble
1
0
Fork 0
mirror of https://github.com/espressif/esp-nimble.git synced 2026-09-30 04:27:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

nimble/host: Add doxygen for ble_hs_mbuf.h

Browse Source
This commit is contained in:
Szymon Janc
2018-05-18 14:37:51 +02:00
parent 3285a68e04
commit 17166fefaf
2 changed files with 43 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
nimble/host/include/host/ble_hs_mbuf.h
+43
View File
@@ -20,6 +20,13 @@
#ifndef H_BLE_HS_MBUF_
#define H_BLE_HS_MBUF_
/**
* @brief Bluetooth Host chained memory buffer (mbuf)
* @defgroup bt_host_mbuf Bluetooth Host chained memory buffer (mbuf)
* @ingroup bt_host
* @{
*/
#include <inttypes.h>
#ifdef __cplusplus
extern "C" {
@@ -27,8 +34,40 @@ extern "C" {
struct os_mbuf;
/**
* Allocates an mbuf suitable for an ATT command packet. The resulting packet
* has sufficient leading space for:
* - ACL data header
* - L2CAP B-frame header
* - Largest ATT command base (prepare write request / response).
*
* @return An empty mbuf on success, NULLl on error.
*/
struct os_mbuf *ble_hs_mbuf_att_pkt(void);
/**
* Allocates an mbuf and fills it with the contents of the specified flat
* buffer.
*
* @param buf The flat buffer to copy from.
* @param len The length of the flat buffer.
*
* @return A newly-allocated mbuf on success, NULL on error.
*/
struct os_mbuf *ble_hs_mbuf_from_flat(const void *buf, uint16_t len);
/**
* Copies the contents of an mbuf into the specified flat buffer. If the flat
* buffer is too small to contain the mbuf's contents, it is filled to capacity
* and BLE_HS_EMSGSIZE is returned.
*
* @param om The mbuf to copy from.
* @param flat The destination flat buffer.
* @param max_len The size of the flat buffer.
* @param out_copy_len The number of bytes actually copied gets written here.
*
* @return 0 on success or BLE host core return code on error.
*/
int ble_hs_mbuf_to_flat(const struct os_mbuf *om, void *flat, uint16_t max_len,
uint16_t *out_copy_len);
@@ -36,4 +75,8 @@ int ble_hs_mbuf_to_flat(const struct os_mbuf *om, void *flat, uint16_t max_len,
}
#endif
/**
* @}
*/
#endif
nimble/host/src/ble_hs_mbuf.c
-37
View File
@@ -84,16 +84,6 @@ ble_hs_mbuf_l2cap_pkt(void)
return ble_hs_mbuf_gen_pkt(BLE_HCI_DATA_HDR_SZ + BLE_L2CAP_HDR_SZ);
}
/**
* Allocates an mbuf suitable for an ATT command packet. The resulting packet
* has sufficient leading space for:
* o ACL data header
* o L2CAP B-frame header
* o Largest ATT command base (prepare write request / response).
*
* @return An empty mbuf on success; null on memory
* exhaustion.
*/
struct os_mbuf *
ble_hs_mbuf_att_pkt(void)
{
@@ -105,16 +95,6 @@ ble_hs_mbuf_att_pkt(void)
BLE_ATT_PREP_WRITE_CMD_BASE_SZ);
}
/**
* Allocates a an mbuf and fills it with the contents of the specified flat
* buffer.
*
* @param buf The flat buffer to copy from.
* @param len The length of the flat buffer.
*
* @return A newly-allocated mbuf on success;
* NULL on memory exhaustion.
*/
struct os_mbuf *
ble_hs_mbuf_from_flat(const void *buf, uint16_t len)
{
@@ -135,23 +115,6 @@ ble_hs_mbuf_from_flat(const void *buf, uint16_t len)
return om;
}
/**
* Copies the contents of an mbuf into the specified flat buffer. If the flat
* buffer is too small to contain the mbuf's contents, it is filled to capacity
* and BLE_HS_EMSGSIZE is returned.
*
* @param om The mbuf to copy from.
* @param flat The destination flat buffer.
* @param max_len The size of the flat buffer.
* @param out_copy_len The number of bytes actually copied gets
* written here.
*
* @return 0 on success;
* BLE_HS_EMSGSIZE if the flat buffer is too small
* to contain the mbuf's contents;
* A BLE host core return code on unexpected
* error.
*/
int
ble_hs_mbuf_to_flat(const struct os_mbuf *om, void *flat, uint16_t max_len,
uint16_t *out_copy_len)