You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ja...@apache.org on 2024/05/16 12:48:46 UTC

(mynewt-nimble) branch master updated (8bdd23e2 -> 9190dcc9)

This is an automated email from the ASF dual-hosted git repository.

janc pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-nimble.git


    from 8bdd23e2 nimble/host: Fix invalid connection handle check in SM
     new d40479fc nimble/host: Modify BASS characteristics properties
     new d18ab269 nimble/host: Fix incorrect naming in BASS
     new a36ed341 nimble/host: Modify GATT flags descriptions
     new 9190dcc9 Update GATT function descriptions

The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 nimble/host/audio/services/bass/pkg.yml            |  2 +-
 .../audio/services/bass/src/ble_audio_svc_bass.c   |  4 +-
 nimble/host/audio/services/bass/syscfg.yml         |  2 +-
 nimble/host/include/host/ble_gatt.h                | 75 ++++++++++++++++------
 4 files changed, 60 insertions(+), 23 deletions(-)


(mynewt-nimble) 03/04: nimble/host: Modify GATT flags descriptions

Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-nimble.git

commit a36ed34174909570e6ea592fe5fa2e621046408f
Author: Szymon Czapracki <sz...@codecoup.pl>
AuthorDate: Wed May 15 12:53:41 2024 +0200

    nimble/host: Modify GATT flags descriptions
    
    This commit changes GATT flags descriptions,
    making them more readable regarding permissions and
    properties.
---
 nimble/host/include/host/ble_gatt.h | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/nimble/host/include/host/ble_gatt.h b/nimble/host/include/host/ble_gatt.h
index 1492b1aa..2532e4d2 100644
--- a/nimble/host/include/host/ble_gatt.h
+++ b/nimble/host/include/host/ble_gatt.h
@@ -121,49 +121,49 @@ struct ble_hs_cfg;
  * @{
  */
 
-/** GATT Characteristic Flag: Broadcast. */
+/** GATT Characteristic Flag: Broadcast property. */
 #define BLE_GATT_CHR_F_BROADCAST                        0x0001
 
-/** GATT Characteristic Flag: Read. */
+/** GATT Characteristic Flag: Read property. */
 #define BLE_GATT_CHR_F_READ                             0x0002
 
-/** GATT Characteristic Flag: Write without Response. */
+/** GATT Characteristic Flag: Write without Response property. */
 #define BLE_GATT_CHR_F_WRITE_NO_RSP                     0x0004
 
-/** GATT Characteristic Flag: Write. */
+/** GATT Characteristic Flag: Write property. */
 #define BLE_GATT_CHR_F_WRITE                            0x0008
 
-/** GATT Characteristic Flag: Notify. */
+/** GATT Characteristic Flag: Notify property. */
 #define BLE_GATT_CHR_F_NOTIFY                           0x0010
 
-/** GATT Characteristic Flag: Indicate. */
+/** GATT Characteristic Flag: Indicate property. */
 #define BLE_GATT_CHR_F_INDICATE                         0x0020
 
-/** GATT Characteristic Flag: Authenticated Signed Writes. */
+/** GATT Characteristic Flag: Authenticated Signed Writes property. */
 #define BLE_GATT_CHR_F_AUTH_SIGN_WRITE                  0x0040
 
-/** GATT Characteristic Flag: Reliable Writes. */
+/** GATT Characteristic Flag: Reliable Writes property. */
 #define BLE_GATT_CHR_F_RELIABLE_WRITE                   0x0080
 
-/** GATT Characteristic Flag: Auxiliary Writes. */
+/** GATT Characteristic Flag: Auxiliary Writes permission. */
 #define BLE_GATT_CHR_F_AUX_WRITE                        0x0100
 
-/** GATT Characteristic Flag: Read Encrypted. */
+/** GATT Characteristic Flag: Read Encrypted permission. */
 #define BLE_GATT_CHR_F_READ_ENC                         0x0200
 
-/** GATT Characteristic Flag: Read Authenticated. */
+/** GATT Characteristic Flag: Read Authenticated permission. */
 #define BLE_GATT_CHR_F_READ_AUTHEN                      0x0400
 
-/** GATT Characteristic Flag: Read Authorized. */
+/** GATT Characteristic Flag: Read Authorized permission. */
 #define BLE_GATT_CHR_F_READ_AUTHOR                      0x0800
 
-/** GATT Characteristic Flag: Write Encrypted. */
+/** GATT Characteristic Flag: Write Encrypted permission. */
 #define BLE_GATT_CHR_F_WRITE_ENC                        0x1000
 
-/** GATT Characteristic Flag: Write Authenticated. */
+/** GATT Characteristic Flag: Write Authenticated permission. */
 #define BLE_GATT_CHR_F_WRITE_AUTHEN                     0x2000
 
-/** GATT Characteristic Flag: Write Authorized. */
+/** GATT Characteristic Flag: Write Authorized permission. */
 #define BLE_GATT_CHR_F_WRITE_AUTHOR                     0x4000
 
 


(mynewt-nimble) 01/04: nimble/host: Modify BASS characteristics properties

Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-nimble.git

commit d40479fce96091e685ea1e088de80c8ae88c984b
Author: Szymon Czapracki <sz...@codecoup.pl>
AuthorDate: Tue May 14 16:48:34 2024 +0200

    nimble/host: Modify BASS characteristics properties
    
    This commit changes BASS audio scan control point and
    BASS broadcast receive state characteristics properties.
    Previous properties were not correct with specification.
---
 nimble/host/audio/services/bass/src/ble_audio_svc_bass.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/nimble/host/audio/services/bass/src/ble_audio_svc_bass.c b/nimble/host/audio/services/bass/src/ble_audio_svc_bass.c
index 6a40c17a..97f8afd9 100644
--- a/nimble/host/audio/services/bass/src/ble_audio_svc_bass.c
+++ b/nimble/host/audio/services/bass/src/ble_audio_svc_bass.c
@@ -861,7 +861,9 @@ ble_svc_audio_bass_init(void)
 
     ble_svc_audio_bass_chrs[0].uuid = bass_cp_uuid;
     ble_svc_audio_bass_chrs[0].access_cb = ble_svc_audio_bass_access;
-    ble_svc_audio_bass_chrs[0].flags = BLE_GATT_CHR_F_WRITE_NO_RSP | BLE_GATT_CHR_F_WRITE_ENC;
+    ble_svc_audio_bass_chrs[0].flags = BLE_GATT_CHR_F_WRITE_NO_RSP |
+                                       BLE_GATT_CHR_F_WRITE |
+                                       BLE_GATT_CHR_F_WRITE_ENC;
 
     for (i = 1; i <= MYNEWT_VAL(BLE_SVC_AUDIO_BASS_RECEIVE_STATE_MAX); i++) {
         ble_svc_audio_bass_chrs[i].uuid = bass_receive_state_uuid;


(mynewt-nimble) 04/04: Update GATT function descriptions

Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-nimble.git

commit 9190dcc9e9cbf1b099213ccac447aeb7ff3d8474
Author: Szymon Czapracki <sz...@codecoup.pl>
AuthorDate: Wed May 15 14:56:50 2024 +0200

    Update GATT function descriptions
    
    This commit modifies GATT functions description
    to get them up to speed with current doxygen rules.
---
 nimble/host/include/host/ble_gatt.h | 45 ++++++++++++++++++++++++++++++++-----
 1 file changed, 40 insertions(+), 5 deletions(-)

diff --git a/nimble/host/include/host/ble_gatt.h b/nimble/host/include/host/ble_gatt.h
index 2532e4d2..5a268c0c 100644
--- a/nimble/host/include/host/ble_gatt.h
+++ b/nimble/host/include/host/ble_gatt.h
@@ -334,6 +334,8 @@ int ble_gattc_exchange_mtu(uint16_t conn_handle,
  *                                  updates; null for no callback.
  * @param cb_arg                The optional argument to pass to the callback
  *                                  function.
+ *
+ * @return                      0 on success; nonzero on failure.
  */
 int ble_gattc_disc_all_svcs(uint16_t conn_handle,
                             ble_gatt_disc_svc_fn *cb, void *cb_arg);
@@ -637,6 +639,8 @@ int ble_gattc_write_long(uint16_t conn_handle, uint16_t attr_handle,
  *                                  updates; null for no callback.
  * @param cb_arg                The optional argument to pass to the callback
  *                                  function.
+ *
+ * @return                      0 on success; nonzero on failure.
  */
 int ble_gattc_write_reliable(uint16_t conn_handle,
                              struct ble_gatt_attr *attrs,
@@ -686,7 +690,15 @@ int ble_gatts_notify_multiple_custom(uint16_t conn_handle,
                                      struct ble_gatt_notif *tuples);
 
 /**
- * Deprecated. Should not be used. Use ble_gatts_notify_custom instead.
+ * @deprecated Should not be used. Use ble_gatts_notify_custom instead.
+ *
+ * @param conn_handle           The connection over which to execute the
+ *                                  procedure.
+ * @param att_handle            The attribute handle to indicate in the
+ *                                  outgoing notification.
+ * @param om                    The value to write to the characteristic.
+ *
+ * @return                      0 on success; nonzero on failure.
  */
 int ble_gattc_notify_custom(uint16_t conn_handle, uint16_t att_handle,
                             struct os_mbuf *om);
@@ -706,7 +718,15 @@ int ble_gattc_notify_custom(uint16_t conn_handle, uint16_t att_handle,
 int ble_gatts_notify(uint16_t conn_handle, uint16_t chr_val_handle);
 
 /**
- * Deprecated. Should not be used. Use ble_gatts_notify instead.
+ * @deprecated Should not be used. Use ble_gatts_notify instead.
+ *
+ * @param conn_handle           The connection over which to execute the
+ *                                  procedure.
+ * @param chr_val_handle        The value attribute handle of the
+ *                                  characteristic to include in the outgoing
+ *                                  notification.
+ *
+ * @return                      0 on success; nonzero on failure.
  */
 int ble_gattc_notify(uint16_t conn_handle, uint16_t chr_val_handle);
 
@@ -752,8 +772,18 @@ int ble_gatts_notify_multiple(uint16_t conn_handle,
  */
 int ble_gatts_indicate_custom(uint16_t conn_handle, uint16_t chr_val_handle,
                               struct os_mbuf *txom);
+
 /**
- * Deprecated. Should not be used. Use ble_gatts_indicate_custom instead.
+ * @deprecated Should not be used. Use ble_gatts_indicate_custom instead.
+ *
+ * @param conn_handle           The connection over which to execute the
+ *                                  procedure.
+ * @param chr_val_handle        The value attribute handle of the
+ *                                  characteristic to include in the outgoing
+ *                                  indication.
+ * @param txom                  The data to include in the indication.
+ *
+ * @return                      0 on success; nonzero on failure.
  */
 int ble_gattc_indicate_custom(uint16_t conn_handle, uint16_t chr_val_handle,
                               struct os_mbuf *txom);
@@ -773,11 +803,16 @@ int ble_gattc_indicate_custom(uint16_t conn_handle, uint16_t chr_val_handle,
 int ble_gatts_indicate(uint16_t conn_handle, uint16_t chr_val_handle);
 
 /**
- * Deprecated. Should not be used. Use ble_gatts_indicate instead.
+ * @deprecated Should not be used. Use ble_gatts_indicate instead.
+ * @copydoc ble_gatts_indicate
  */
 int ble_gattc_indicate(uint16_t conn_handle, uint16_t chr_val_handle);
 
-/** Initialize the BLE GATT client. */
+/**
+ * Initialize the BLE GATT client
+ *
+ * @return                      0 on success; nonzero on failure.
+ */
 int ble_gattc_init(void);
 
 /*** @server. */


(mynewt-nimble) 02/04: nimble/host: Fix incorrect naming in BASS

Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-nimble.git

commit d18ab26959eba920801092120980dc0f719e40e8
Author: Szymon Czapracki <sz...@codecoup.pl>
AuthorDate: Tue May 14 16:49:51 2024 +0200

    nimble/host: Fix incorrect naming in BASS
    
    Change keyword and description from PACS to BASS.
---
 nimble/host/audio/services/bass/pkg.yml    | 2 +-
 nimble/host/audio/services/bass/syscfg.yml | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/nimble/host/audio/services/bass/pkg.yml b/nimble/host/audio/services/bass/pkg.yml
index e92ab6dd..1546b264 100644
--- a/nimble/host/audio/services/bass/pkg.yml
+++ b/nimble/host/audio/services/bass/pkg.yml
@@ -22,7 +22,7 @@ pkg.homepage: "http://mynewt.apache.org/"
 pkg.keywords:
   - ble
   - bluetooth
-  - pacs
+  - bass
   - nimble
 
 pkg.deps:
diff --git a/nimble/host/audio/services/bass/syscfg.yml b/nimble/host/audio/services/bass/syscfg.yml
index 2be3f497..f125115e 100644
--- a/nimble/host/audio/services/bass/syscfg.yml
+++ b/nimble/host/audio/services/bass/syscfg.yml
@@ -18,7 +18,7 @@
 syscfg.defs:
     BLE_SVC_AUDIO_BASS_SYSINIT_STAGE:
         description: >
-            Sysinit stage for Published Audio Capabilities Service.
+            Sysinit stage for Broadcast Audio Scan Service.
         value: 303
     BLE_SVC_AUDIO_BASS_RECEIVE_STATE_MAX:
         description: >