MariuszSkamra commented on code in PR #1694:
URL: https://github.com/apache/mynewt-nimble/pull/1694#discussion_r1505510311
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -19,29 +19,112 @@
#ifndef H_BLE_ISO_
#define H_BLE_ISO_
+
+/**
+ * @file ble_iso.h
+ *
+ * @brief Bluetooth ISO
+ * @defgroup bt_iso Bluetooth ISO
+ * @ingroup bt_host
+ * @{
+ */
+
#include "syscfg/syscfg.h"
+/**
+ * @defgroup ble_iso_events ISO Events
+ * @{
+ */
+
/** ISO event: BIG Create Completed */
#define BLE_ISO_EVENT_BIG_CREATE_COMPLETE 0
/** ISO event: BIG Terminate Completed */
#define BLE_ISO_EVENT_BIG_TERMINATE_COMPLETE 1
+/** @} */
+
#include <inttypes.h>
+/** Broadcast Isochronous Group (BIG) descriptor */
struct ble_iso_big_desc
{
+ /**
+ * The identifier of the BIG. Assigned by the Host when a new BIG is
+ * created. The value shall be between 0x00 and 0xEF.
+ */
uint8_t big_handle;
+
+ /**
+ * The maximum time in microseconds for transmission of PDUs of all BISes
in
+ * a BIG event. The value of BIG_Sync_Delay shall equal the time from the
+ * anchor point to the BIG Synchronization point and shall be between
+ * 0x0000EA and 0x7FFFFF.
+ */
Review Comment:
Ditto, probably just a short description like below would be sufficient
```suggestion
/**
* The maximum time in microseconds for transmission of PDUs of all
BISes in
* a BIG event.
*/
```
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -19,29 +19,112 @@
#ifndef H_BLE_ISO_
#define H_BLE_ISO_
+
+/**
+ * @file ble_iso.h
+ *
+ * @brief Bluetooth ISO
+ * @defgroup bt_iso Bluetooth ISO
+ * @ingroup bt_host
+ * @{
+ */
+
#include "syscfg/syscfg.h"
+/**
+ * @defgroup ble_iso_events ISO Events
+ * @{
+ */
+
/** ISO event: BIG Create Completed */
#define BLE_ISO_EVENT_BIG_CREATE_COMPLETE 0
/** ISO event: BIG Terminate Completed */
#define BLE_ISO_EVENT_BIG_TERMINATE_COMPLETE 1
+/** @} */
+
#include <inttypes.h>
+/** Broadcast Isochronous Group (BIG) descriptor */
struct ble_iso_big_desc
{
+ /**
+ * The identifier of the BIG. Assigned by the Host when a new BIG is
+ * created. The value shall be between 0x00 and 0xEF.
+ */
uint8_t big_handle;
+
+ /**
+ * The maximum time in microseconds for transmission of PDUs of all BISes
in
+ * a BIG event. The value of BIG_Sync_Delay shall equal the time from the
+ * anchor point to the BIG Synchronization point and shall be between
+ * 0x0000EA and 0x7FFFFF.
+ */
uint32_t big_sync_delay;
+
+ /**
+ * The actual transport latency of transmitting payloads of all BISes in
the
+ * BIG in microseconds. The value shall be between 0x0000EA and 0x7FFFFF.
+ */
uint32_t transport_latency_big;
+
+ /**
+ * The PHY used to create the BIG. The value shall be one of the following:
+ * o BLE_HCI_LE_PHY_1M
+ * o BLE_HCI_LE_PHY_2M
+ * o BLE_HCI_LE_PHY_CODED
+ */
uint8_t phy;
+
+ /**
+ * The number of subevents per BIS in each BIG event. The value shall be
+ * between 1 and 31 and shall be an integer multiple of BN.
+ */
Review Comment:
```suggestion
/**
* The number of subevents per BIS in each BIG event.
*/
```
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -19,29 +19,112 @@
#ifndef H_BLE_ISO_
#define H_BLE_ISO_
+
+/**
+ * @file ble_iso.h
+ *
+ * @brief Bluetooth ISO
+ * @defgroup bt_iso Bluetooth ISO
+ * @ingroup bt_host
+ * @{
+ */
+
#include "syscfg/syscfg.h"
+/**
+ * @defgroup ble_iso_events ISO Events
+ * @{
+ */
+
/** ISO event: BIG Create Completed */
#define BLE_ISO_EVENT_BIG_CREATE_COMPLETE 0
/** ISO event: BIG Terminate Completed */
#define BLE_ISO_EVENT_BIG_TERMINATE_COMPLETE 1
+/** @} */
+
#include <inttypes.h>
+/** Broadcast Isochronous Group (BIG) descriptor */
struct ble_iso_big_desc
{
+ /**
+ * The identifier of the BIG. Assigned by the Host when a new BIG is
+ * created. The value shall be between 0x00 and 0xEF.
+ */
uint8_t big_handle;
+
+ /**
+ * The maximum time in microseconds for transmission of PDUs of all BISes
in
+ * a BIG event. The value of BIG_Sync_Delay shall equal the time from the
+ * anchor point to the BIG Synchronization point and shall be between
+ * 0x0000EA and 0x7FFFFF.
+ */
uint32_t big_sync_delay;
+
+ /**
+ * The actual transport latency of transmitting payloads of all BISes in
the
+ * BIG in microseconds. The value shall be between 0x0000EA and 0x7FFFFF.
+ */
Review Comment:
Ditto
```suggestion
/**
* The actual transport latency of transmitting payloads of all BISes in
the
* BIG in microseconds.
*/
```
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -19,29 +19,112 @@
#ifndef H_BLE_ISO_
#define H_BLE_ISO_
+
+/**
+ * @file ble_iso.h
+ *
+ * @brief Bluetooth ISO
+ * @defgroup bt_iso Bluetooth ISO
+ * @ingroup bt_host
+ * @{
+ */
+
#include "syscfg/syscfg.h"
+/**
+ * @defgroup ble_iso_events ISO Events
+ * @{
+ */
+
/** ISO event: BIG Create Completed */
#define BLE_ISO_EVENT_BIG_CREATE_COMPLETE 0
/** ISO event: BIG Terminate Completed */
#define BLE_ISO_EVENT_BIG_TERMINATE_COMPLETE 1
+/** @} */
+
#include <inttypes.h>
+/** Broadcast Isochronous Group (BIG) descriptor */
struct ble_iso_big_desc
{
+ /**
+ * The identifier of the BIG. Assigned by the Host when a new BIG is
+ * created. The value shall be between 0x00 and 0xEF.
+ */
uint8_t big_handle;
+
+ /**
+ * The maximum time in microseconds for transmission of PDUs of all BISes
in
+ * a BIG event. The value of BIG_Sync_Delay shall equal the time from the
+ * anchor point to the BIG Synchronization point and shall be between
+ * 0x0000EA and 0x7FFFFF.
+ */
uint32_t big_sync_delay;
+
+ /**
+ * The actual transport latency of transmitting payloads of all BISes in
the
+ * BIG in microseconds. The value shall be between 0x0000EA and 0x7FFFFF.
+ */
uint32_t transport_latency_big;
+
+ /**
+ * The PHY used to create the BIG. The value shall be one of the following:
+ * o BLE_HCI_LE_PHY_1M
+ * o BLE_HCI_LE_PHY_2M
+ * o BLE_HCI_LE_PHY_CODED
+ */
uint8_t phy;
+
+ /**
+ * The number of subevents per BIS in each BIG event. The value shall be
+ * between 1 and 31 and shall be an integer multiple of BN.
+ */
uint8_t nse;
+
+ /**
+ * The Burst Number (BN) specifies the number of new payloads in each BIS
+ * event. The value of BN shall be between 1 and 7.
+ */
uint8_t bn;
+
+ /**
+ * The Pre-Transmission Offset (PTO) specifies the offset of groups that
+ * carry data associated with the future BIS events. The value of PTO shall
+ * be between 0 and 15.
+ */
uint8_t pto;
+
+ /**
+ * The Immediate Repetition Count (IRC) specifies the number of groups that
+ * carry the data associated with the current BIS event. The value of IRC
+ * shall be between 1 and 15.
+ */
uint8_t irc;
+
+ /**
+ * The maximum number of data octets (excluding the MIC, if any) that can
be
+ * carried in each BIS Data PDU in the BIG. The value shall be between 1
and
+ * 251 octets.
+ */
Review Comment:
```suggestion
/**
* The maximum number of data octets (excluding the MIC, if any) that
can be
* carried in each BIS Data PDU in the BIG.
*/
```
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -19,29 +19,112 @@
#ifndef H_BLE_ISO_
#define H_BLE_ISO_
+
+/**
+ * @file ble_iso.h
+ *
+ * @brief Bluetooth ISO
+ * @defgroup bt_iso Bluetooth ISO
+ * @ingroup bt_host
+ * @{
+ */
+
#include "syscfg/syscfg.h"
+/**
+ * @defgroup ble_iso_events ISO Events
+ * @{
+ */
+
/** ISO event: BIG Create Completed */
#define BLE_ISO_EVENT_BIG_CREATE_COMPLETE 0
/** ISO event: BIG Terminate Completed */
#define BLE_ISO_EVENT_BIG_TERMINATE_COMPLETE 1
+/** @} */
+
#include <inttypes.h>
+/** Broadcast Isochronous Group (BIG) descriptor */
struct ble_iso_big_desc
{
+ /**
+ * The identifier of the BIG. Assigned by the Host when a new BIG is
+ * created. The value shall be between 0x00 and 0xEF.
+ */
uint8_t big_handle;
+
+ /**
+ * The maximum time in microseconds for transmission of PDUs of all BISes
in
+ * a BIG event. The value of BIG_Sync_Delay shall equal the time from the
+ * anchor point to the BIG Synchronization point and shall be between
+ * 0x0000EA and 0x7FFFFF.
+ */
uint32_t big_sync_delay;
+
+ /**
+ * The actual transport latency of transmitting payloads of all BISes in
the
+ * BIG in microseconds. The value shall be between 0x0000EA and 0x7FFFFF.
+ */
uint32_t transport_latency_big;
+
+ /**
+ * The PHY used to create the BIG. The value shall be one of the following:
+ * o BLE_HCI_LE_PHY_1M
+ * o BLE_HCI_LE_PHY_2M
+ * o BLE_HCI_LE_PHY_CODED
+ */
uint8_t phy;
+
+ /**
+ * The number of subevents per BIS in each BIG event. The value shall be
+ * between 1 and 31 and shall be an integer multiple of BN.
+ */
uint8_t nse;
+
+ /**
+ * The Burst Number (BN) specifies the number of new payloads in each BIS
+ * event. The value of BN shall be between 1 and 7.
+ */
uint8_t bn;
+
+ /**
+ * The Pre-Transmission Offset (PTO) specifies the offset of groups that
+ * carry data associated with the future BIS events. The value of PTO shall
+ * be between 0 and 15.
+ */
uint8_t pto;
+
+ /**
+ * The Immediate Repetition Count (IRC) specifies the number of groups that
+ * carry the data associated with the current BIS event. The value of IRC
+ * shall be between 1 and 15.
+ */
uint8_t irc;
+
+ /**
+ * The maximum number of data octets (excluding the MIC, if any) that can
be
+ * carried in each BIS Data PDU in the BIG. The value shall be between 1
and
+ * 251 octets.
+ */
uint16_t max_pdu;
+
+ /**
+ * The time between two adjacent BIG anchor points in units of 1.25 ms. The
+ * value shall be between 0x0004 and 0x0C80 (i.e. 5 ms to 4 s).
+ */
uint16_t iso_interval;
+
+ /**
+ * The total number of BISes in the BIG. The value shall be between 1 and
31.
+ */
uint8_t num_bis;
+
+ /**
+ * The connection handles of all the BIS in the BIG. The value shall be
+ * between 0x0000 and 0x0EFF.
+ */
Review Comment:
```suggestion
/**
* The connection handles of all the BIS in the BIG.
*/
```
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -83,34 +166,149 @@ struct ble_iso_event {
};
};
+/** Function prototype for isochronous event callback. */
typedef int ble_iso_event_fn(struct ble_iso_event *event, void *arg);
+/** Broadcast Isochronous Group (BIG) parameters */
struct ble_iso_big_params {
+ /**
+ * The time interval of the periodic SDUs in microseconds. The value shall
+ * be between 0x0000FF and 0x0FFFFF.
+ */
uint32_t sdu_interval;
+
+ /**
+ * The maximum size of an SDU in octets. The value shall be between 0x0001
+ * and 0x0FFF.
+ */
uint16_t max_sdu;
+
+ /**
+ * The maximum transport latency in milliseconds. The value shall be
between
+ * 0x0005 and 0x0FA0.
+ */
uint16_t max_transport_latency;
+
+ /**
+ * The Retransmission Number (RTN) parameter contains the number of times
+ * every PDU should be retransmitted, irrespective of which BIG events the
+ * retransmissions occur in. The value shall be between 0x00 and 0x1E.
+ */
uint8_t rtn;
+
+ /**
+ * The PHY parameter is a bit field that indicates the PHY used for
+ * transmission of PDUs of BISes in the BIG. The value can be one of the
+ * following:
+ * o BLE_HCI_LE_PHY_1M_PREF_MASK
+ * o BLE_HCI_LE_PHY_2M_PREF_MASK
+ * o BLE_HCI_LE_PHY_CODED_PREF_MASK
+ */
Review Comment:
```suggestion
/**
* The PHY parameter is a bit field that indicates the PHY used for
* transmission of PDUs of BISes in the BIG. The value shall be one of
the
* following:
* o BLE_HCI_LE_PHY_1M_PREF_MASK
* o BLE_HCI_LE_PHY_2M_PREF_MASK
* o BLE_HCI_LE_PHY_CODED_PREF_MASK
*/
```
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -83,34 +166,149 @@ struct ble_iso_event {
};
};
+/** Function prototype for isochronous event callback. */
typedef int ble_iso_event_fn(struct ble_iso_event *event, void *arg);
+/** Broadcast Isochronous Group (BIG) parameters */
struct ble_iso_big_params {
+ /**
+ * The time interval of the periodic SDUs in microseconds. The value shall
+ * be between 0x0000FF and 0x0FFFFF.
+ */
uint32_t sdu_interval;
+
+ /**
+ * The maximum size of an SDU in octets. The value shall be between 0x0001
+ * and 0x0FFF.
+ */
uint16_t max_sdu;
+
+ /**
+ * The maximum transport latency in milliseconds. The value shall be
between
+ * 0x0005 and 0x0FA0.
+ */
uint16_t max_transport_latency;
+
+ /**
+ * The Retransmission Number (RTN) parameter contains the number of times
+ * every PDU should be retransmitted, irrespective of which BIG events the
+ * retransmissions occur in. The value shall be between 0x00 and 0x1E.
+ */
uint8_t rtn;
+
+ /**
+ * The PHY parameter is a bit field that indicates the PHY used for
+ * transmission of PDUs of BISes in the BIG. The value can be one of the
+ * following:
+ * o BLE_HCI_LE_PHY_1M_PREF_MASK
+ * o BLE_HCI_LE_PHY_2M_PREF_MASK
+ * o BLE_HCI_LE_PHY_CODED_PREF_MASK
+ */
uint8_t phy;
+
+ /**
+ * Indicates the preferred method of arranging subevents of multiple BISes.
+ * The value can be one of the following:
+ * o 0x00 - Sequential
+ * o 0x01 - Interleaved
+ */
Review Comment:
```suggestion
/**
* Indicates the preferred method of arranging subevents of multiple
BISes.
* The value shall be one of the following:
* o 0x00 - Sequential
* o 0x01 - Interleaved
*/
```
and in other places
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -19,29 +19,112 @@
#ifndef H_BLE_ISO_
#define H_BLE_ISO_
+
+/**
+ * @file ble_iso.h
+ *
+ * @brief Bluetooth ISO
+ * @defgroup bt_iso Bluetooth ISO
+ * @ingroup bt_host
+ * @{
+ */
+
#include "syscfg/syscfg.h"
+/**
+ * @defgroup ble_iso_events ISO Events
+ * @{
+ */
+
/** ISO event: BIG Create Completed */
#define BLE_ISO_EVENT_BIG_CREATE_COMPLETE 0
/** ISO event: BIG Terminate Completed */
#define BLE_ISO_EVENT_BIG_TERMINATE_COMPLETE 1
+/** @} */
+
#include <inttypes.h>
+/** Broadcast Isochronous Group (BIG) descriptor */
struct ble_iso_big_desc
{
+ /**
+ * The identifier of the BIG. Assigned by the Host when a new BIG is
+ * created. The value shall be between 0x00 and 0xEF.
Review Comment:
Nitpick:
```suggestion
* created.
```
IMO the possible values is redundant information as it's value assigned by
the host, not a function parameter provided by the user.
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -19,29 +19,112 @@
#ifndef H_BLE_ISO_
#define H_BLE_ISO_
+
+/**
+ * @file ble_iso.h
+ *
+ * @brief Bluetooth ISO
+ * @defgroup bt_iso Bluetooth ISO
+ * @ingroup bt_host
+ * @{
+ */
+
#include "syscfg/syscfg.h"
+/**
+ * @defgroup ble_iso_events ISO Events
+ * @{
+ */
+
/** ISO event: BIG Create Completed */
#define BLE_ISO_EVENT_BIG_CREATE_COMPLETE 0
/** ISO event: BIG Terminate Completed */
#define BLE_ISO_EVENT_BIG_TERMINATE_COMPLETE 1
+/** @} */
+
#include <inttypes.h>
+/** Broadcast Isochronous Group (BIG) descriptor */
struct ble_iso_big_desc
{
+ /**
+ * The identifier of the BIG. Assigned by the Host when a new BIG is
+ * created. The value shall be between 0x00 and 0xEF.
+ */
uint8_t big_handle;
+
+ /**
+ * The maximum time in microseconds for transmission of PDUs of all BISes
in
+ * a BIG event. The value of BIG_Sync_Delay shall equal the time from the
+ * anchor point to the BIG Synchronization point and shall be between
+ * 0x0000EA and 0x7FFFFF.
+ */
uint32_t big_sync_delay;
+
+ /**
+ * The actual transport latency of transmitting payloads of all BISes in
the
+ * BIG in microseconds. The value shall be between 0x0000EA and 0x7FFFFF.
+ */
uint32_t transport_latency_big;
+
+ /**
+ * The PHY used to create the BIG. The value shall be one of the following:
+ * o BLE_HCI_LE_PHY_1M
+ * o BLE_HCI_LE_PHY_2M
+ * o BLE_HCI_LE_PHY_CODED
+ */
uint8_t phy;
+
+ /**
+ * The number of subevents per BIS in each BIG event. The value shall be
+ * between 1 and 31 and shall be an integer multiple of BN.
+ */
uint8_t nse;
+
+ /**
+ * The Burst Number (BN) specifies the number of new payloads in each BIS
+ * event. The value of BN shall be between 1 and 7.
+ */
uint8_t bn;
+
+ /**
+ * The Pre-Transmission Offset (PTO) specifies the offset of groups that
+ * carry data associated with the future BIS events. The value of PTO shall
+ * be between 0 and 15.
+ */
uint8_t pto;
+
+ /**
+ * The Immediate Repetition Count (IRC) specifies the number of groups that
+ * carry the data associated with the current BIS event. The value of IRC
+ * shall be between 1 and 15.
+ */
Review Comment:
```suggestion
* The Immediate Repetition Count (IRC) specifies the number of groups
that
* carry the data associated with the current BIS event.
*/
```
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -19,29 +19,112 @@
#ifndef H_BLE_ISO_
#define H_BLE_ISO_
+
+/**
+ * @file ble_iso.h
+ *
+ * @brief Bluetooth ISO
+ * @defgroup bt_iso Bluetooth ISO
+ * @ingroup bt_host
+ * @{
+ */
+
#include "syscfg/syscfg.h"
+/**
+ * @defgroup ble_iso_events ISO Events
+ * @{
+ */
+
/** ISO event: BIG Create Completed */
#define BLE_ISO_EVENT_BIG_CREATE_COMPLETE 0
/** ISO event: BIG Terminate Completed */
#define BLE_ISO_EVENT_BIG_TERMINATE_COMPLETE 1
+/** @} */
+
#include <inttypes.h>
+/** Broadcast Isochronous Group (BIG) descriptor */
struct ble_iso_big_desc
{
+ /**
+ * The identifier of the BIG. Assigned by the Host when a new BIG is
+ * created. The value shall be between 0x00 and 0xEF.
+ */
uint8_t big_handle;
+
+ /**
+ * The maximum time in microseconds for transmission of PDUs of all BISes
in
+ * a BIG event. The value of BIG_Sync_Delay shall equal the time from the
+ * anchor point to the BIG Synchronization point and shall be between
+ * 0x0000EA and 0x7FFFFF.
+ */
uint32_t big_sync_delay;
+
+ /**
+ * The actual transport latency of transmitting payloads of all BISes in
the
+ * BIG in microseconds. The value shall be between 0x0000EA and 0x7FFFFF.
+ */
uint32_t transport_latency_big;
+
+ /**
+ * The PHY used to create the BIG. The value shall be one of the following:
+ * o BLE_HCI_LE_PHY_1M
+ * o BLE_HCI_LE_PHY_2M
+ * o BLE_HCI_LE_PHY_CODED
+ */
uint8_t phy;
+
+ /**
+ * The number of subevents per BIS in each BIG event. The value shall be
+ * between 1 and 31 and shall be an integer multiple of BN.
+ */
uint8_t nse;
+
+ /**
+ * The Burst Number (BN) specifies the number of new payloads in each BIS
+ * event. The value of BN shall be between 1 and 7.
+ */
uint8_t bn;
+
+ /**
+ * The Pre-Transmission Offset (PTO) specifies the offset of groups that
+ * carry data associated with the future BIS events. The value of PTO shall
+ * be between 0 and 15.
+ */
Review Comment:
```suggestion
/**
* The Pre-Transmission Offset (PTO) specifies the offset of groups that
* carry data associated with the future BIS events.
*/
```
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -19,29 +19,112 @@
#ifndef H_BLE_ISO_
#define H_BLE_ISO_
+
+/**
+ * @file ble_iso.h
+ *
+ * @brief Bluetooth ISO
+ * @defgroup bt_iso Bluetooth ISO
+ * @ingroup bt_host
+ * @{
+ */
+
#include "syscfg/syscfg.h"
+/**
+ * @defgroup ble_iso_events ISO Events
+ * @{
+ */
+
/** ISO event: BIG Create Completed */
#define BLE_ISO_EVENT_BIG_CREATE_COMPLETE 0
/** ISO event: BIG Terminate Completed */
#define BLE_ISO_EVENT_BIG_TERMINATE_COMPLETE 1
+/** @} */
+
#include <inttypes.h>
+/** Broadcast Isochronous Group (BIG) descriptor */
struct ble_iso_big_desc
{
+ /**
+ * The identifier of the BIG. Assigned by the Host when a new BIG is
+ * created. The value shall be between 0x00 and 0xEF.
+ */
uint8_t big_handle;
+
+ /**
+ * The maximum time in microseconds for transmission of PDUs of all BISes
in
+ * a BIG event. The value of BIG_Sync_Delay shall equal the time from the
+ * anchor point to the BIG Synchronization point and shall be between
+ * 0x0000EA and 0x7FFFFF.
+ */
uint32_t big_sync_delay;
+
+ /**
+ * The actual transport latency of transmitting payloads of all BISes in
the
+ * BIG in microseconds. The value shall be between 0x0000EA and 0x7FFFFF.
+ */
uint32_t transport_latency_big;
+
+ /**
+ * The PHY used to create the BIG. The value shall be one of the following:
+ * o BLE_HCI_LE_PHY_1M
+ * o BLE_HCI_LE_PHY_2M
+ * o BLE_HCI_LE_PHY_CODED
+ */
uint8_t phy;
+
+ /**
+ * The number of subevents per BIS in each BIG event. The value shall be
+ * between 1 and 31 and shall be an integer multiple of BN.
+ */
uint8_t nse;
+
+ /**
+ * The Burst Number (BN) specifies the number of new payloads in each BIS
+ * event. The value of BN shall be between 1 and 7.
+ */
Review Comment:
```suggestion
/**
* The Burst Number (BN) specifies the number of new payloads in each BIS
* event.
*/
```
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -19,29 +19,112 @@
#ifndef H_BLE_ISO_
#define H_BLE_ISO_
+
+/**
+ * @file ble_iso.h
+ *
+ * @brief Bluetooth ISO
+ * @defgroup bt_iso Bluetooth ISO
+ * @ingroup bt_host
+ * @{
+ */
+
#include "syscfg/syscfg.h"
+/**
+ * @defgroup ble_iso_events ISO Events
+ * @{
+ */
+
/** ISO event: BIG Create Completed */
#define BLE_ISO_EVENT_BIG_CREATE_COMPLETE 0
/** ISO event: BIG Terminate Completed */
#define BLE_ISO_EVENT_BIG_TERMINATE_COMPLETE 1
+/** @} */
+
#include <inttypes.h>
+/** Broadcast Isochronous Group (BIG) descriptor */
struct ble_iso_big_desc
{
+ /**
+ * The identifier of the BIG. Assigned by the Host when a new BIG is
+ * created. The value shall be between 0x00 and 0xEF.
+ */
uint8_t big_handle;
+
+ /**
+ * The maximum time in microseconds for transmission of PDUs of all BISes
in
+ * a BIG event. The value of BIG_Sync_Delay shall equal the time from the
+ * anchor point to the BIG Synchronization point and shall be between
+ * 0x0000EA and 0x7FFFFF.
+ */
uint32_t big_sync_delay;
+
+ /**
+ * The actual transport latency of transmitting payloads of all BISes in
the
+ * BIG in microseconds. The value shall be between 0x0000EA and 0x7FFFFF.
+ */
uint32_t transport_latency_big;
+
+ /**
+ * The PHY used to create the BIG. The value shall be one of the following:
+ * o BLE_HCI_LE_PHY_1M
+ * o BLE_HCI_LE_PHY_2M
+ * o BLE_HCI_LE_PHY_CODED
+ */
uint8_t phy;
+
+ /**
+ * The number of subevents per BIS in each BIG event. The value shall be
+ * between 1 and 31 and shall be an integer multiple of BN.
+ */
uint8_t nse;
+
+ /**
+ * The Burst Number (BN) specifies the number of new payloads in each BIS
+ * event. The value of BN shall be between 1 and 7.
+ */
uint8_t bn;
+
+ /**
+ * The Pre-Transmission Offset (PTO) specifies the offset of groups that
+ * carry data associated with the future BIS events. The value of PTO shall
+ * be between 0 and 15.
+ */
uint8_t pto;
+
+ /**
+ * The Immediate Repetition Count (IRC) specifies the number of groups that
+ * carry the data associated with the current BIS event. The value of IRC
+ * shall be between 1 and 15.
+ */
uint8_t irc;
+
+ /**
+ * The maximum number of data octets (excluding the MIC, if any) that can
be
+ * carried in each BIS Data PDU in the BIG. The value shall be between 1
and
+ * 251 octets.
+ */
uint16_t max_pdu;
+
+ /**
+ * The time between two adjacent BIG anchor points in units of 1.25 ms. The
+ * value shall be between 0x0004 and 0x0C80 (i.e. 5 ms to 4 s).
+ */
Review Comment:
```suggestion
/**
* The time between two adjacent BIG anchor points in units of 1.25 ms.
*/
```
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -19,29 +19,112 @@
#ifndef H_BLE_ISO_
#define H_BLE_ISO_
+
+/**
+ * @file ble_iso.h
+ *
+ * @brief Bluetooth ISO
+ * @defgroup bt_iso Bluetooth ISO
+ * @ingroup bt_host
+ * @{
+ */
+
#include "syscfg/syscfg.h"
+/**
+ * @defgroup ble_iso_events ISO Events
+ * @{
+ */
+
/** ISO event: BIG Create Completed */
#define BLE_ISO_EVENT_BIG_CREATE_COMPLETE 0
/** ISO event: BIG Terminate Completed */
#define BLE_ISO_EVENT_BIG_TERMINATE_COMPLETE 1
+/** @} */
+
#include <inttypes.h>
+/** Broadcast Isochronous Group (BIG) descriptor */
struct ble_iso_big_desc
{
+ /**
+ * The identifier of the BIG. Assigned by the Host when a new BIG is
+ * created. The value shall be between 0x00 and 0xEF.
+ */
uint8_t big_handle;
+
+ /**
+ * The maximum time in microseconds for transmission of PDUs of all BISes
in
+ * a BIG event. The value of BIG_Sync_Delay shall equal the time from the
+ * anchor point to the BIG Synchronization point and shall be between
+ * 0x0000EA and 0x7FFFFF.
+ */
uint32_t big_sync_delay;
+
+ /**
+ * The actual transport latency of transmitting payloads of all BISes in
the
+ * BIG in microseconds. The value shall be between 0x0000EA and 0x7FFFFF.
+ */
uint32_t transport_latency_big;
+
+ /**
+ * The PHY used to create the BIG. The value shall be one of the following:
+ * o BLE_HCI_LE_PHY_1M
+ * o BLE_HCI_LE_PHY_2M
+ * o BLE_HCI_LE_PHY_CODED
+ */
Review Comment:
```suggestion
/**
* The PHY used to create the BIG. The value can be one of the following:
* o BLE_HCI_LE_PHY_1M
* o BLE_HCI_LE_PHY_2M
* o BLE_HCI_LE_PHY_CODED
*/
```
##########
nimble/host/include/host/ble_iso.h:
##########
@@ -19,29 +19,112 @@
#ifndef H_BLE_ISO_
#define H_BLE_ISO_
+
+/**
+ * @file ble_iso.h
+ *
+ * @brief Bluetooth ISO
+ * @defgroup bt_iso Bluetooth ISO
+ * @ingroup bt_host
+ * @{
+ */
+
#include "syscfg/syscfg.h"
+/**
+ * @defgroup ble_iso_events ISO Events
+ * @{
+ */
+
/** ISO event: BIG Create Completed */
#define BLE_ISO_EVENT_BIG_CREATE_COMPLETE 0
/** ISO event: BIG Terminate Completed */
#define BLE_ISO_EVENT_BIG_TERMINATE_COMPLETE 1
+/** @} */
+
#include <inttypes.h>
+/** Broadcast Isochronous Group (BIG) descriptor */
struct ble_iso_big_desc
{
+ /**
+ * The identifier of the BIG. Assigned by the Host when a new BIG is
+ * created. The value shall be between 0x00 and 0xEF.
+ */
uint8_t big_handle;
+
+ /**
+ * The maximum time in microseconds for transmission of PDUs of all BISes
in
+ * a BIG event. The value of BIG_Sync_Delay shall equal the time from the
+ * anchor point to the BIG Synchronization point and shall be between
+ * 0x0000EA and 0x7FFFFF.
+ */
uint32_t big_sync_delay;
+
+ /**
+ * The actual transport latency of transmitting payloads of all BISes in
the
+ * BIG in microseconds. The value shall be between 0x0000EA and 0x7FFFFF.
+ */
uint32_t transport_latency_big;
+
+ /**
+ * The PHY used to create the BIG. The value shall be one of the following:
+ * o BLE_HCI_LE_PHY_1M
+ * o BLE_HCI_LE_PHY_2M
+ * o BLE_HCI_LE_PHY_CODED
+ */
uint8_t phy;
+
+ /**
+ * The number of subevents per BIS in each BIG event. The value shall be
+ * between 1 and 31 and shall be an integer multiple of BN.
+ */
uint8_t nse;
+
+ /**
+ * The Burst Number (BN) specifies the number of new payloads in each BIS
+ * event. The value of BN shall be between 1 and 7.
+ */
uint8_t bn;
+
+ /**
+ * The Pre-Transmission Offset (PTO) specifies the offset of groups that
+ * carry data associated with the future BIS events. The value of PTO shall
+ * be between 0 and 15.
+ */
uint8_t pto;
+
+ /**
+ * The Immediate Repetition Count (IRC) specifies the number of groups that
+ * carry the data associated with the current BIS event. The value of IRC
+ * shall be between 1 and 15.
+ */
uint8_t irc;
+
+ /**
+ * The maximum number of data octets (excluding the MIC, if any) that can
be
+ * carried in each BIS Data PDU in the BIG. The value shall be between 1
and
+ * 251 octets.
+ */
uint16_t max_pdu;
+
+ /**
+ * The time between two adjacent BIG anchor points in units of 1.25 ms. The
+ * value shall be between 0x0004 and 0x0C80 (i.e. 5 ms to 4 s).
+ */
uint16_t iso_interval;
+
+ /**
+ * The total number of BISes in the BIG. The value shall be between 1 and
31.
+ */
Review Comment:
```suggestion
/**
* The total number of BISes in the BIG.
*/
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
