Linux bluetooth development
 help / color / mirror / Atom feed
* [PATCH 1/4] android/hal-gatt-api: Rename Service ID to GATT Service ID
@ 2014-03-05 14:43 Jakub Tyszkowski
  2014-03-05 14:43 ` [PATCH 2/4] android/hal-ipc-api: Fix documentation structure and notation Jakub Tyszkowski
                   ` (3 more replies)
  0 siblings, 4 replies; 5+ messages in thread
From: Jakub Tyszkowski @ 2014-03-05 14:43 UTC (permalink / raw)
  To: linux-bluetooth; +Cc: Jakub Tyszkowski

Use "GATT Service ID" instead "Service ID" inside ipc documentation
which is used to describe Core services like HAL_SERVICE_ID_GATT
himself.
---
 android/hal-ipc-api.txt | 46 ++++++++++++++++++++++------------------------
 1 file changed, 22 insertions(+), 24 deletions(-)

diff --git a/android/hal-ipc-api.txt b/android/hal-ipc-api.txt
index 43b79ec..4f1b74d 100644
--- a/android/hal-ipc-api.txt
+++ b/android/hal-ipc-api.txt
@@ -1496,15 +1496,13 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 	Opcode 0x09 - Get Included Service command/response
 
 		Command parameters: Connection ID (4 octets)
-		                    Number of Service ID Elements (1 octet)
-		                    Service ID Elements (variable)
+		                    Number of GATT Service ID Elements (1 octet)
+		                    GATT Service ID Elements (variable)
 		Valid Number of Service ID Elements: 0x01
 		                                     0x02
-		Valid Service ID Element: UUID (16 octets)
-		                          Instance ID (1 octet)
-		                          Is Primary (1 octet)
-		Valid GATT ID: UUID (16 octets)
-		               Instance ID (1 octet)
+		Valid GATT Service ID Element: UUID (16 octets)
+		                               Instance ID (1 octet)
+		                               Is Primary (1 octet)
 		Response parameters: <none>
 
 		In case of an error, the error response will be returned.
@@ -1512,10 +1510,10 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 	Opcode 0x0a - Get Characteristic command/response
 
 		Command parameters: Connection ID (4 octets)
-		                    Service ID (18 octets)
+		                    GATT Service ID (18 octets)
 		                    Number of GATT ID Elements (1 octet)
 		                    GATT ID Elements (variable)
-		Valid Service ID: as described in Get Included Service
+		Valid GATT Service ID: as described in Get Included Service
 		Valid Number of GATT ID Elements: 0x00
 		                                  0x01
 		Valid GATT ID Element: as described in Get Included Service
@@ -1526,10 +1524,10 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 	Opcode 0x0b - Get Descriptor command/response
 
 		Command parameters: Connection ID (4 octets)
-		                    Service ID (18 octets)
+		                    GATT Service ID (18 octets)
 		                    Number of GATT ID Elements (1 octet)
 		                    GATT ID Elements (variable)
-		Valid Service ID: as described in Get Included Service
+		Valid GATT Service ID: as described in Get Included Service
 		Valid Number of GATT ID Elements: 0x01
 		                                  0x02
 		Valid GATT ID Element: as described in Get Included Service
@@ -1540,10 +1538,10 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 	Opcode 0x0c - Read Characteristic command/response
 
 		Command parameters: Connection ID (4 octets)
-		                    Service ID (18 octets)
+		                    GATT Service ID (18 octets)
 		                    GATT ID (17 octets)
 		                    Authorization (4 octets)
-		Valid Service ID: as described in Get Included Service
+		Valid GATT Service ID: as described in Get Included Service
 		Valid GATT ID: as described in Get Included Service
 		Response parameters: <none>
 
@@ -1552,13 +1550,13 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 	Opcode 0x0d - Write Characteristic command/response
 
 		Command parameters: Connection ID (4 octets)
-		                    Service ID (18 octets)
+		                    GATT Service ID (18 octets)
 		                    GATT ID (17 octets)
 		                    Write Type (4 octets)
 		                    Length (4 octets)
 		                    Authorization Req. (4 octets)
 		                    Value (variable)
-		Valid Service ID: as described in Get Included Service
+		Valid GATT Service ID: as described in Get Included Service
 		Valid GATT ID: as described in Get Included Service
 		Response parameters: <none>
 
@@ -1567,11 +1565,11 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 	Opcode 0x0e - Read Descriptor command/response
 
 		Command parameters: Connection ID (4 octets)
-		                    Service ID (18 octets)
+		                    GATT Service ID (18 octets)
 		                    GATT ID (17 octets)
 		                    Descr. GATT ID (17 octets)
 		                    Authorization Req. (4 octets)
-		Valid Service ID: as described in Get Included Service
+		Valid GATT Service ID: as described in Get Included Service
 		Valid GATT ID: as described in Get Included Service
 		Response parameters: <none>
 
@@ -1580,14 +1578,14 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 	Opcode 0x0f - Write Descriptor command/response
 
 		Command parameters: Connection ID (4 octets)
-		                    Service ID (18 octets)
+		                    GATT Service ID (18 octets)
 		                    GATT ID (17 octets)
 		                    Descr. GATT ID (17 octets)
 		                    Write Type (4 octets)
 		                    Length (4 octets)
 		                    Authorization Req. (4 octets)
 		                    Value (variable)
-		Valid Service ID: as described in Get Included Service
+		Valid GATT Service ID: as described in Get Included Service
 		Valid GATT ID: as described in Get Included Service
 		Response parameters: <none>
 
@@ -1605,7 +1603,7 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 
 		Command parameters: Client Interface (4 octets)
 		                    Remote address (6 octets)
-		                    Service ID (18 octets)
+		                    GATT Service ID (18 octets)
 		                    GATT ID (17 octets)
 		Response parameters: <none>
 
@@ -1615,7 +1613,7 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 
 		Command parameters: Client Interface (4 octets)
 		                    Remote address (6 octets)
-		                    Service ID (18 octets)
+		                    GATT Service ID (18 octets)
 		                    GATT ID (17 octets)
 		Response parameters: <none>
 
@@ -1973,9 +1971,9 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                         GATT Service ID (18 octets)
 		                         Service Handle (4 octets)
 
-		Valid Service ID: UUID (16 octets)
-		                  Instance ID (1 octet)
-		                  Is Primary (1 octet)
+		Valid GATT Service ID: UUID (16 octets)
+		                       Instance ID (1 octet)
+		                       Is Primary (1 octet)
 
 	Opcode 0x96 - Included Service Added notification
 
-- 
1.9.0


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* [PATCH 2/4] android/hal-ipc-api: Fix documentation structure and notation
  2014-03-05 14:43 [PATCH 1/4] android/hal-gatt-api: Rename Service ID to GATT Service ID Jakub Tyszkowski
@ 2014-03-05 14:43 ` Jakub Tyszkowski
  2014-03-05 14:43 ` [PATCH 3/4] android/hal-ipc-api: Add missing sections in doc Jakub Tyszkowski
                   ` (2 subsequent siblings)
  3 siblings, 0 replies; 5+ messages in thread
From: Jakub Tyszkowski @ 2014-03-05 14:43 UTC (permalink / raw)
  To: linux-bluetooth; +Cc: Jakub Tyszkowski

Clean up the documentation by using 'Element # ...' notation for
variable length arrays of structs, fixing whitespaces and reordering
some parts.
---
 android/hal-ipc-api.txt | 160 +++++++++++++++++++++++++++++++++++-------------
 1 file changed, 116 insertions(+), 44 deletions(-)

diff --git a/android/hal-ipc-api.txt b/android/hal-ipc-api.txt
index 4f1b74d..05bb4db 100644
--- a/android/hal-ipc-api.txt
+++ b/android/hal-ipc-api.txt
@@ -330,25 +330,28 @@ Notifications:
 
 		Notification parameters: Status (1 octect)
 		                         Num properties (1 octet)
-		                         Type[i] (1 octect)
-		                         Length[i] (2 octets)
-		                         Value[i] (variable)
+		                         Type # (1 octet)
+		                         Length # (2 octets)
+		                         Value # (variable)
+		                         ...
 
 	Opcode 0x83 - Remote Device Properties notification
 
 		Notification parameters: Status (1 octect)
 		                         Remote address (6 octets)
 		                         Num properties (1 octet)
-		                         Type[i] (1 octect)
-		                         Length[i] (2 octets)
-		                         Value[i] (variable)
+		                         Type # (1 octet)
+		                         Length # (2 octets)
+		                         Value # (variable)
+		                         ...
 
 	Opcode 0x84 - Device Found notification
 
 		Notification parameters: Num properties (1 octet)
-		                         Type[i] (1 octect)
-		                         Length[i] (2 octets)
-		                         Value[i] (variable)
+		                         Type # (1 octet)
+		                         Length # (2 octets)
+		                         Value # (variable)
+		                         ...
 
 	Opcode 0x85 - Discovery State Changed notification
 
@@ -1121,10 +1124,11 @@ Android HAL name: "health" (BT_PROFILE_HEALTH_ID)
 		                    Service name (string)
 		                    Service description (string)
 		                    Number of MDEP (1 octet)
-		                    MDEP Role[i] (1 octet)
-		                    Data type[i] (1 octet)
-		                    Channel type[i] (1 octet)
-		                    MDEP description (string)
+		                    MDEP Role # (1 octet)
+		                    Data type # (1 octet)
+		                    Channel type # (1 octet)
+		                    MDEP description # (string)
+		                    ...
 		Response parameters: Application ID (2 octets)
 
 		In case of an error, the error response will be returned.
@@ -1486,10 +1490,12 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 
 		Command parameters: Connection ID (4 octets)
 		                    Number of UUID Filters (1 octet)
-		                    UUID Filter (variable)
+		                    UUID Filter # (16 octets)
+		                    ...
+		Response parameters: <none>
+
 		Valid Number of UUID Filters: 0x00
 		                              0x01
-		Response parameters: <none>
 
 		In case of an error, the error response will be returned.
 
@@ -1497,14 +1503,15 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 
 		Command parameters: Connection ID (4 octets)
 		                    Number of GATT Service ID Elements (1 octet)
-		                    GATT Service ID Elements (variable)
-		Valid Number of Service ID Elements: 0x01
-		                                     0x02
-		Valid GATT Service ID Element: UUID (16 octets)
-		                               Instance ID (1 octet)
-		                               Is Primary (1 octet)
+		                    GATT Service ID # UUID (16 octets)
+		                    GATT Service ID # Instance ID (1 octet)
+		                    GATT Service ID # Is Primary (1 octet)
+		                    ...
 		Response parameters: <none>
 
+		Valid Number of GATT Service ID Elements: 0x01
+		                                          0x02
+
 		In case of an error, the error response will be returned.
 
 	Opcode 0x0a - Get Characteristic command/response
@@ -1512,12 +1519,17 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		Command parameters: Connection ID (4 octets)
 		                    GATT Service ID (18 octets)
 		                    Number of GATT ID Elements (1 octet)
-		                    GATT ID Elements (variable)
-		Valid GATT Service ID: as described in Get Included Service
+		                    GATT ID # UUID (16 octets)
+		                    GATT ID # Instance ID (1 octet)
+		                    ...
+		Response parameters: <none>
+
+		Valid GATT Service ID: UUID (16 octets)
+		                       Instance ID (1 octet)
+		                       Is Primary (1 octet)
+
 		Valid Number of GATT ID Elements: 0x00
 		                                  0x01
-		Valid GATT ID Element: as described in Get Included Service
-		Response parameters: <none>
 
 		In case of an error, the error response will be returned.
 
@@ -1526,12 +1538,17 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		Command parameters: Connection ID (4 octets)
 		                    GATT Service ID (18 octets)
 		                    Number of GATT ID Elements (1 octet)
-		                    GATT ID Elements (variable)
-		Valid GATT Service ID: as described in Get Included Service
+		                    GATT ID # UUID (16 octets)
+		                    GATT ID # Instance ID (1 octet)
+		                    ...
+		Response parameters: <none>
+
+		Valid GATT Service ID: UUID (16 octets)
+		                       Instance ID (1 octet)
+		                       Is Primary (1 octet)
+
 		Valid Number of GATT ID Elements: 0x01
 		                                  0x02
-		Valid GATT ID Element: as described in Get Included Service
-		Response parameters: <none>
 
 		In case of an error, the error response will be returned.
 
@@ -1541,10 +1558,15 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                    GATT Service ID (18 octets)
 		                    GATT ID (17 octets)
 		                    Authorization (4 octets)
-		Valid GATT Service ID: as described in Get Included Service
-		Valid GATT ID: as described in Get Included Service
 		Response parameters: <none>
 
+		Valid GATT Service ID: UUID (16 octets)
+		                       Instance ID (1 octet)
+		                       Is Primary (1 octet)
+
+		Valid GATT ID: UUID (16 octets)
+		               Instance ID (1 octet)
+
 		In case of an error, the error response will be returned.
 
 	Opcode 0x0d - Write Characteristic command/response
@@ -1556,10 +1578,15 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                    Length (4 octets)
 		                    Authorization Req. (4 octets)
 		                    Value (variable)
-		Valid GATT Service ID: as described in Get Included Service
-		Valid GATT ID: as described in Get Included Service
 		Response parameters: <none>
 
+		Valid GATT Service ID: UUID (16 octets)
+		                       Instance ID (1 octet)
+		                       Is Primary (1 octet)
+
+		Valid GATT ID: UUID (16 octets)
+		               Instance ID (1 octet)
+
 		In case of an error, the error response will be returned.
 
 	Opcode 0x0e - Read Descriptor command/response
@@ -1569,10 +1596,18 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                    GATT ID (17 octets)
 		                    Descr. GATT ID (17 octets)
 		                    Authorization Req. (4 octets)
-		Valid GATT Service ID: as described in Get Included Service
-		Valid GATT ID: as described in Get Included Service
 		Response parameters: <none>
 
+		Valid GATT Service ID: UUID (16 octets)
+		                       Instance ID (1 octet)
+		                       Is Primary (1 octet)
+
+		Valid GATT ID: UUID (16 octets)
+		               Instance ID (1 octet)
+
+		Valid Descr. GATT ID: UUID (16 octets)
+		                      Instance ID (1 octet)
+
 		In case of an error, the error response will be returned.
 
 	Opcode 0x0f - Write Descriptor command/response
@@ -1585,10 +1620,18 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                    Length (4 octets)
 		                    Authorization Req. (4 octets)
 		                    Value (variable)
-		Valid GATT Service ID: as described in Get Included Service
-		Valid GATT ID: as described in Get Included Service
 		Response parameters: <none>
 
+		Valid GATT Service ID: UUID (16 octets)
+		                       Instance ID (1 octet)
+		                       Is Primary (1 octet)
+
+		Valid GATT ID: UUID (16 octets)
+		               Instance ID (1 octet)
+
+		Valid Descr. GATT ID: UUID (16 octets)
+		                      Instance ID (1 octet)
+
 		In case of an error, the error response will be returned.
 
 	Opcode 0x10 - Execute Write command/response
@@ -1607,6 +1650,13 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                    GATT ID (17 octets)
 		Response parameters: <none>
 
+		Valid GATT Service ID: UUID (16 octets)
+		                       Instance ID (1 octet)
+		                       Is Primary (1 octet)
+
+		Valid GATT ID: UUID (16 octets)
+		               Instance ID (1 octet)
+
 		In case of an error, the error response will be returned.
 
 	Opcode 0x12 - Deregister For Notification command/response
@@ -1617,6 +1667,13 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                    GATT ID (17 octets)
 		Response parameters: <none>
 
+		Valid GATT Service ID: UUID (16 octets)
+		                       Instance ID (1 octet)
+		                       Is Primary (1 octet)
+
+		Valid GATT ID: UUID (16 octets)
+		               Instance ID (1 octet)
+
 		In case of an error, the error response will be returned.
 
 	Opcode 0x13 - Read Remote RSSI command/response
@@ -1704,15 +1761,12 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		Command parameters: Server (4 octets)
 		                    GATT Service ID (18 octets)
 		                    Number of Handles (4 octet)
+		Response parameters: <none>
 
 		Valid GATT Service ID: UUID (16 octets)
-		                       Instance ID (1 octets)
+		                       Instance ID (1 octet)
 		                       Is Primary (1 octet)
 
-		Valid GATT ID: UUID (16 octets)
-		               Instance ID (1 octets)
-		Response parameters: <none>
-
 		In case of an error, the error response will be returned.
 
 	Opcode 0x1c - Add Included Service command/response
@@ -1788,6 +1842,7 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                    Transaction ID (4 octets)
 		                    Status (4 octets)
 		                    GATT Response (4 octets)
+		Response parameters: <none>
 
 		Valid GATT Response: GATT Value (607 octets)
 		                     Handle (2 octets)
@@ -1797,7 +1852,6 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                  Offset (2 octets)
 		                  Length (2 octets)
 		                  Authentication Request (1 octet)
-		Response parameters: <none>
 
 		In case of an error, the error response will be returned.
 
@@ -1837,6 +1891,7 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 
 		Notification parameters: Connection ID (4 octets)
 		                         GATT Service ID (18 octets)
+
 		Valid GATT Service ID: UUID (16 octets)
 		                       Instance ID (1 octets)
 		                       Is Primary (1 octet)
@@ -1848,7 +1903,9 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                         GATT Service ID (18 octets)
 		                         GATT Char. ID (17 octets)
 		                         Char Prop. (4 octets)
+
 		Valid GATT Service: As described in Search Result
+
 		Valid GATT Char. ID: UUID (16 octets)
 		                     Instance ID (1 octet)
 
@@ -1859,7 +1916,9 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                         GATT Service ID (18 octets)
 		                         GATT Char. ID (17 octets)
 		                         GATT Descr. ID (17 octets)
+
 		Valid GATT Service & Char. ID: As described in Get Characteristic
+
 		Valid GATT Descr. ID: UUID (16 octets)
 		                      Instance ID (1 octet)
 
@@ -1869,6 +1928,7 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                         Status (4 octets)
 		                         GATT Service ID (18 octets)
 		                         GATT Incl. Service ID (18 octets)
+
 		Valid GATT Service & Incl. Service ID: As described in Search Result
 
 	Opcode 0x8a - Register For Notification notification
@@ -1878,7 +1938,9 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                         Status (4 octets)
 		                         GATT Service ID (18 octets)
 		                         GATT Char. ID (17 octets)
+
 		Valid GATT Service ID: As described in Get Characteristic
+
 		Valid GATT Char. ID: As described in Get Characteristic
 
 	Opcode 0x8b - Notify notification
@@ -1890,7 +1952,9 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                         Is Notify (1 octet)
 		                         Length (2 octets)
 		                         Value (variable)
-		Valid Service ID: As described in Get Characteristic
+
+		Valid GATT Service ID: As described in Get Characteristic
+
 		Valid GATT Char. ID: As described in Get Characteristic
 
 	Opcode 0x8c - Read Characteristic notification
@@ -1898,6 +1962,7 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		Notification parameters: Connection ID (4 octets)
 		                         Status (4 octets)
 		                         GATT Read Parameters (variable)
+
 		Valid GATT Read Parameters: GATT Service ID (18 octets)
 		                            GATT Char. ID (17 octets)
 		                            GATT Descr. ID (17 octets)
@@ -1905,7 +1970,9 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		                            Status (1 octet)
 		                            Length (2 octets)
 		                            Value (variable)
+
 		Valid GATT Service ID: As described in Get Characteristic
+
 		Valid GATT Char. & Decr. ID: As described in Get Descriptor
 
 	Opcode 0x8d - Write Characteristic notification
@@ -1913,11 +1980,14 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		Notification parameters: Connection ID (4 octets)
 		                         Status (4 octets)
 		                         GATT Write Parameters (53 octets)
+
 		Valid GATT Write Parameters: GATT Service ID (18 octets)
 		                             GATT Characteristic ID (17 octets)
 		                             GATT Description ID (17 octets)
 		                             Status (1 octet)
+
 		Valid GATT Service ID: As described in Get Descriptor
+
 		Valid GATT Char. & Decr. ID: As described in Get Descriptor
 
 	Opcode 0x8e - Read Descriptor notification
@@ -1925,6 +1995,7 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		Notification parameters: Connection ID (4 octets)
 		                         Status (4 octets)
 		                         GATT Read Parameters (variable)
+
 		Valid GATT Read Parameters: As described in Read Characteristic
 
 	Opcode 0x8f - Write Descriptor notification
@@ -1932,6 +2003,7 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 		Notification parameters: Connection ID (4 octets)
 		                         Status (4 octets)
 		                         GATT Write Parameters (53 octets)
+
 		Valid GATT Write Parameters: As described in Write Characteristic
 
 	Opcode 0x90 - Execute Write notification
-- 
1.9.0


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* [PATCH 3/4] android/hal-ipc-api: Add missing sections in doc
  2014-03-05 14:43 [PATCH 1/4] android/hal-gatt-api: Rename Service ID to GATT Service ID Jakub Tyszkowski
  2014-03-05 14:43 ` [PATCH 2/4] android/hal-ipc-api: Fix documentation structure and notation Jakub Tyszkowski
@ 2014-03-05 14:43 ` Jakub Tyszkowski
  2014-03-05 14:43 ` [PATCH 4/4] android/hal-ipc-api: Trivial typo fix " Jakub Tyszkowski
  2014-03-05 19:53 ` [PATCH 1/4] android/hal-gatt-api: Rename Service ID to GATT Service ID Szymon Janc
  3 siblings, 0 replies; 5+ messages in thread
From: Jakub Tyszkowski @ 2014-03-05 14:43 UTC (permalink / raw)
  To: linux-bluetooth; +Cc: Jakub Tyszkowski

---
 android/hal-ipc-api.txt | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/android/hal-ipc-api.txt b/android/hal-ipc-api.txt
index 05bb4db..cd6bc92 100644
--- a/android/hal-ipc-api.txt
+++ b/android/hal-ipc-api.txt
@@ -758,6 +758,8 @@ Android HAL name: "handsfree" (BT_PROFILE_HANDSFREE_ID)
 
 	Service modes:               0x01 = Headset Profile only mode
 
+Commands and responses:
+
 	Opcode 0x00 - Error response
 
 		Response parameters: Status (1 octet)
@@ -1102,6 +1104,8 @@ Bluetooth Health HAL (ID 7)
 
 Android HAL name: "health" (BT_PROFILE_HEALTH_ID)
 
+Commands and responses:
+
 	Opcode 0x00 - Error response
 
 		Response parameters: Status (1 octet)
@@ -1189,6 +1193,8 @@ Bluetooth Remote Control HAL (ID 8)
 
 Android HAL name: "avrcp" (BT_PROFILE_AV_RC_ID)
 
+Commands and responses:
+
 	Opcode 0x00 - Error response
 
 		Response parameters: Status (1 octet)
@@ -1324,6 +1330,8 @@ Android HAL name: "avrcp" (BT_PROFILE_AV_RC_ID)
 
 		In case of an error, the error response will be returned.
 
+Notifications:
+
 	Opcode 0x81 - Remote Features notification
 
 		Notification parameters: Remote address (6 octets)
@@ -1415,6 +1423,8 @@ Bluetooth GATT HAL (ID 9)
 
 Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 
+Commands and responses:
+
 	Opcode 0x00 - Error response
 
 		Response parameters: Status (1 octet)
@@ -1855,6 +1865,8 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
 
 		In case of an error, the error response will be returned.
 
+Notifications:
+
 	Opcode 0x81 - Register Client notification
 
 		Notification parameters: Status (4 octets)
-- 
1.9.0


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* [PATCH 4/4] android/hal-ipc-api: Trivial typo fix in doc
  2014-03-05 14:43 [PATCH 1/4] android/hal-gatt-api: Rename Service ID to GATT Service ID Jakub Tyszkowski
  2014-03-05 14:43 ` [PATCH 2/4] android/hal-ipc-api: Fix documentation structure and notation Jakub Tyszkowski
  2014-03-05 14:43 ` [PATCH 3/4] android/hal-ipc-api: Add missing sections in doc Jakub Tyszkowski
@ 2014-03-05 14:43 ` Jakub Tyszkowski
  2014-03-05 19:53 ` [PATCH 1/4] android/hal-gatt-api: Rename Service ID to GATT Service ID Szymon Janc
  3 siblings, 0 replies; 5+ messages in thread
From: Jakub Tyszkowski @ 2014-03-05 14:43 UTC (permalink / raw)
  To: linux-bluetooth; +Cc: Jakub Tyszkowski

---
 android/hal-ipc-api.txt | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/android/hal-ipc-api.txt b/android/hal-ipc-api.txt
index cd6bc92..1ecf75f 100644
--- a/android/hal-ipc-api.txt
+++ b/android/hal-ipc-api.txt
@@ -321,14 +321,14 @@ Notifications:
 
 	Opcode 0x81 - Adapter State Changed notification
 
-		Notifications parameters: State (1 octect)
+		Notifications parameters: State (1 octet)
 
 		Valid state values: 0x00 = Off
 		                    0x01 = On
 
 	Opcode 0x82 - Adapter Properties Changed notification
 
-		Notification parameters: Status (1 octect)
+		Notification parameters: Status (1 octet)
 		                         Num properties (1 octet)
 		                         Type # (1 octet)
 		                         Length # (2 octets)
@@ -337,7 +337,7 @@ Notifications:
 
 	Opcode 0x83 - Remote Device Properties notification
 
-		Notification parameters: Status (1 octect)
+		Notification parameters: Status (1 octet)
 		                         Remote address (6 octets)
 		                         Num properties (1 octet)
 		                         Type # (1 octet)
@@ -355,7 +355,7 @@ Notifications:
 
 	Opcode 0x85 - Discovery State Changed notification
 
-		Notifications parameters: State (1 octect)
+		Notifications parameters: State (1 octet)
 
 	Opcode 0x86 - PIN Request notification
 
@@ -373,7 +373,7 @@ Notifications:
 
 	Opcode 0x88 - Bond State Changed notification
 
-		Notification parameters: Status (1 octect)
+		Notification parameters: Status (1 octet)
 		                         Remote address (6 octets)
 		                         Bond state (1 octet)
 
@@ -383,19 +383,19 @@ Notifications:
 
 	Opcode 0x89 - ACL State Changed notification
 
-		Notification parameters: Status (1 octect)
+		Notification parameters: Status (1 octet)
 		                         Remote address (6 octets)
 		                         ACL state (1 octet)
 
 	Opcode 0x8a - DUT Mode Receive notification
 
-		Notification parameters: Opcode (2 octects)
+		Notification parameters: Opcode (2 octets)
 		                         Length  (1 octet)
 		                         Data (variable)
 
 	Opcode 0x8b - LE Test Mode notification
 
-		Notification parameters: Status (1 octect)
+		Notification parameters: Status (1 octet)
 		                         Num packets (2 octets)
 
 
@@ -722,7 +722,7 @@ Notifications:
 
 	Opcode 0x81 - Control State notification
 
-		Notification parameters: Control state (1 octect)
+		Notification parameters: Control state (1 octet)
 		                         Status (1 octet)
 		                         Local role (1 octet)
 		                         Interface name (17 octet)
@@ -736,7 +736,7 @@ Notifications:
 
 	Opcode 0x82 - Connection State notification
 
-		Notification parameters: Connection state (1 octect)
+		Notification parameters: Connection state (1 octet)
 		                         Status (1 octet)
 		                         Remote address (6 octets)
 		                         Local role (1 octet)
@@ -950,7 +950,7 @@ Notifications:
 
 	Opcode 0x81 - Connection State notification
 
-		Notification parameters: Connection state (1 octect)
+		Notification parameters: Connection state (1 octet)
 		                         Remote address (6 octets)
 
 		Valid connection states: 0x00 = Disconnected
@@ -961,7 +961,7 @@ Notifications:
 
 	Opcode 0x82 - Audio State notification
 
-		Notification parameters: Audio state (1 octect)
+		Notification parameters: Audio state (1 octet)
 		                         Remote address (6 octets)
 
 		Valid audio states: 0x00 = Disconnected
@@ -1081,7 +1081,7 @@ Notifications:
 
 	Opcode 0x81 - Connection State notification
 
-		Notification parameters: Connection state (1 octect)
+		Notification parameters: Connection state (1 octet)
 		                         Remote address (6 octets)
 
 		Valid connection states: 0x00 = Disconnected
@@ -1091,7 +1091,7 @@ Notifications:
 
 	Opcode 0x82 - Audio State notification
 
-		Notification parameters: Audio state (1 octect)
+		Notification parameters: Audio state (1 octet)
 		                         Remote address (6 octets)
 
 		Valid connection states: 0x00 = Remote suspend
@@ -1164,7 +1164,7 @@ Notifications:
 
 	Opcode 0x81 - Application Registration State notification
 
-		Notification parameters: Application ID (2 octects)
+		Notification parameters: Application ID (2 octets)
 		                         Application state (1 octet)
 
 		Valid application states: 0x00 = Registration success
@@ -1174,7 +1174,7 @@ Notifications:
 
 	Opcode 0x82 - Channel State notification
 
-		Notification parameters: Application ID (2 octects)
+		Notification parameters: Application ID (2 octets)
 		                         Remote address (6 octets)
 		                         MDEP index (1 octet)
 		                         Channel ID (2 octets)
-- 
1.9.0


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH 1/4] android/hal-gatt-api: Rename Service ID to GATT Service ID
  2014-03-05 14:43 [PATCH 1/4] android/hal-gatt-api: Rename Service ID to GATT Service ID Jakub Tyszkowski
                   ` (2 preceding siblings ...)
  2014-03-05 14:43 ` [PATCH 4/4] android/hal-ipc-api: Trivial typo fix " Jakub Tyszkowski
@ 2014-03-05 19:53 ` Szymon Janc
  3 siblings, 0 replies; 5+ messages in thread
From: Szymon Janc @ 2014-03-05 19:53 UTC (permalink / raw)
  To: Jakub Tyszkowski; +Cc: linux-bluetooth

Hi Jakub,

On Wednesday 05 March 2014 15:43:56 Jakub Tyszkowski wrote:
> Use "GATT Service ID" instead "Service ID" inside ipc documentation
> which is used to describe Core services like HAL_SERVICE_ID_GATT
> himself.
> ---
>  android/hal-ipc-api.txt | 46 ++++++++++++++++++++++------------------------
> 1 file changed, 22 insertions(+), 24 deletions(-)
> 
> diff --git a/android/hal-ipc-api.txt b/android/hal-ipc-api.txt
> index 43b79ec..4f1b74d 100644
> --- a/android/hal-ipc-api.txt
> +++ b/android/hal-ipc-api.txt
> @@ -1496,15 +1496,13 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
>  	Opcode 0x09 - Get Included Service command/response
> 
>  		Command parameters: Connection ID (4 octets)
> -		                    Number of Service ID Elements (1 octet)
> -		                    Service ID Elements (variable)
> +		                    Number of GATT Service ID Elements (1 octet)
> +		                    GATT Service ID Elements (variable)
>  		Valid Number of Service ID Elements: 0x01
>  		                                     0x02
> -		Valid Service ID Element: UUID (16 octets)
> -		                          Instance ID (1 octet)
> -		                          Is Primary (1 octet)
> -		Valid GATT ID: UUID (16 octets)
> -		               Instance ID (1 octet)
> +		Valid GATT Service ID Element: UUID (16 octets)
> +		                               Instance ID (1 octet)
> +		                               Is Primary (1 octet)
>  		Response parameters: <none>
> 
>  		In case of an error, the error response will be returned.
> @@ -1512,10 +1510,10 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
>  	Opcode 0x0a - Get Characteristic command/response
> 
>  		Command parameters: Connection ID (4 octets)
> -		                    Service ID (18 octets)
> +		                    GATT Service ID (18 octets)
>  		                    Number of GATT ID Elements (1 octet)
>  		                    GATT ID Elements (variable)
> -		Valid Service ID: as described in Get Included Service
> +		Valid GATT Service ID: as described in Get Included Service
>  		Valid Number of GATT ID Elements: 0x00
>  		                                  0x01
>  		Valid GATT ID Element: as described in Get Included Service
> @@ -1526,10 +1524,10 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
>  	Opcode 0x0b - Get Descriptor command/response
> 
>  		Command parameters: Connection ID (4 octets)
> -		                    Service ID (18 octets)
> +		                    GATT Service ID (18 octets)
>  		                    Number of GATT ID Elements (1 octet)
>  		                    GATT ID Elements (variable)
> -		Valid Service ID: as described in Get Included Service
> +		Valid GATT Service ID: as described in Get Included Service
>  		Valid Number of GATT ID Elements: 0x01
>  		                                  0x02
>  		Valid GATT ID Element: as described in Get Included Service
> @@ -1540,10 +1538,10 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
>  	Opcode 0x0c - Read Characteristic command/response
> 
>  		Command parameters: Connection ID (4 octets)
> -		                    Service ID (18 octets)
> +		                    GATT Service ID (18 octets)
>  		                    GATT ID (17 octets)
>  		                    Authorization (4 octets)
> -		Valid Service ID: as described in Get Included Service
> +		Valid GATT Service ID: as described in Get Included Service
>  		Valid GATT ID: as described in Get Included Service
>  		Response parameters: <none>
> 
> @@ -1552,13 +1550,13 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
>  	Opcode 0x0d - Write Characteristic command/response
> 
>  		Command parameters: Connection ID (4 octets)
> -		                    Service ID (18 octets)
> +		                    GATT Service ID (18 octets)
>  		                    GATT ID (17 octets)
>  		                    Write Type (4 octets)
>  		                    Length (4 octets)
>  		                    Authorization Req. (4 octets)
>  		                    Value (variable)
> -		Valid Service ID: as described in Get Included Service
> +		Valid GATT Service ID: as described in Get Included Service
>  		Valid GATT ID: as described in Get Included Service
>  		Response parameters: <none>
> 
> @@ -1567,11 +1565,11 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
>  	Opcode 0x0e - Read Descriptor command/response
> 
>  		Command parameters: Connection ID (4 octets)
> -		                    Service ID (18 octets)
> +		                    GATT Service ID (18 octets)
>  		                    GATT ID (17 octets)
>  		                    Descr. GATT ID (17 octets)
>  		                    Authorization Req. (4 octets)
> -		Valid Service ID: as described in Get Included Service
> +		Valid GATT Service ID: as described in Get Included Service
>  		Valid GATT ID: as described in Get Included Service
>  		Response parameters: <none>
> 
> @@ -1580,14 +1578,14 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
>  	Opcode 0x0f - Write Descriptor command/response
> 
>  		Command parameters: Connection ID (4 octets)
> -		                    Service ID (18 octets)
> +		                    GATT Service ID (18 octets)
>  		                    GATT ID (17 octets)
>  		                    Descr. GATT ID (17 octets)
>  		                    Write Type (4 octets)
>  		                    Length (4 octets)
>  		                    Authorization Req. (4 octets)
>  		                    Value (variable)
> -		Valid Service ID: as described in Get Included Service
> +		Valid GATT Service ID: as described in Get Included Service
>  		Valid GATT ID: as described in Get Included Service
>  		Response parameters: <none>
> 
> @@ -1605,7 +1603,7 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
> 
>  		Command parameters: Client Interface (4 octets)
>  		                    Remote address (6 octets)
> -		                    Service ID (18 octets)
> +		                    GATT Service ID (18 octets)
>  		                    GATT ID (17 octets)
>  		Response parameters: <none>
> 
> @@ -1615,7 +1613,7 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
> 
>  		Command parameters: Client Interface (4 octets)
>  		                    Remote address (6 octets)
> -		                    Service ID (18 octets)
> +		                    GATT Service ID (18 octets)
>  		                    GATT ID (17 octets)
>  		Response parameters: <none>
> 
> @@ -1973,9 +1971,9 @@ Android HAL name: "gatt" (BT_PROFILE_GATT_ID)
>  		                         GATT Service ID (18 octets)
>  		                         Service Handle (4 octets)
> 
> -		Valid Service ID: UUID (16 octets)
> -		                  Instance ID (1 octet)
> -		                  Is Primary (1 octet)
> +		Valid GATT Service ID: UUID (16 octets)
> +		                       Instance ID (1 octet)
> +		                       Is Primary (1 octet)
> 
>  	Opcode 0x96 - Included Service Added notification

All patches applied, thanks.

-- 
Szymon K. Janc
szymon.janc@gmail.com

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2014-03-05 19:53 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-03-05 14:43 [PATCH 1/4] android/hal-gatt-api: Rename Service ID to GATT Service ID Jakub Tyszkowski
2014-03-05 14:43 ` [PATCH 2/4] android/hal-ipc-api: Fix documentation structure and notation Jakub Tyszkowski
2014-03-05 14:43 ` [PATCH 3/4] android/hal-ipc-api: Add missing sections in doc Jakub Tyszkowski
2014-03-05 14:43 ` [PATCH 4/4] android/hal-ipc-api: Trivial typo fix " Jakub Tyszkowski
2014-03-05 19:53 ` [PATCH 1/4] android/hal-gatt-api: Rename Service ID to GATT Service ID Szymon Janc

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox