* [PATCH] android/hal-ipc-txt: Documentation update and cleanup
@ 2014-11-13 8:01 Szymon Janc
2014-11-13 17:11 ` Szymon Janc
0 siblings, 1 reply; 2+ messages in thread
From: Szymon Janc @ 2014-11-13 8:01 UTC (permalink / raw)
To: linux-bluetooth; +Cc: Szymon Janc
This patch clarifies that 0x80 opcode is reserved and not used. This is
in case we need to introduce confirmations for notifications.
Error response definition is moved into common place and all HALs are
simply referring to it. This is to keep valid status values in single
place. Valis status is also updated with 'Authentication Rejected'
error added in Android 5.0 API.
---
android/hal-ipc-api.txt | 168 ++++++------------------------------------------
1 file changed, 21 insertions(+), 147 deletions(-)
diff --git a/android/hal-ipc-api.txt b/android/hal-ipc-api.txt
index 4f202c8..7c51728 100644
--- a/android/hal-ipc-api.txt
+++ b/android/hal-ipc-api.txt
@@ -55,7 +55,9 @@ The unique service ID is assigned by this specification for each HAL.
As general rule of thumb, the opcode for command matches the opcode for a
response. Or the opcode 0x00 for an error is returned.
-Notification opcodes start from 0x80.
+Notification opcodes start from 0x81.
+
+Opcode 0x80 is reserved and shall not be used.
All command/response opcodes have the least significant bit not set. And all
notifications have the least significant bit set.
@@ -115,14 +117,29 @@ specific service.
init() --> register module handsfree
-Core Service (ID 0)
-===================
+Error response is common for all services and has fixed structure:
Opcode 0x00 - Error response
Response parameters: Status (1 octet)
- Valid status values: 0x01 Failed
+ Valid status values: 0x01 = Fail
+ 0x02 = Not ready
+ 0x03 = No memory
+ 0x04 = Busy
+ 0x05 = Done (already completed)
+ 0x06 = Unsupported
+ 0x07 = Parameter invalid
+ 0x08 = Unhandled
+ 0x09 = Authentication failure
+ 0x0a = Remote device down
+ 0x0b = Authentication rejected
+
+
+Core Service (ID 0)
+===================
+
+ Opcode 0x00 - Error response
Opcode 0x01 - Register module command/response
@@ -180,8 +197,6 @@ Commands and responses:
Opcode 0x00 - Error response
- Response parameters: Status (1 octet)
-
Opcode 0x01 - Enable command/response
Command parameters: <none>
@@ -436,19 +451,6 @@ Commands and responses:
Opcode 0x00 - Error response
- Response parameters: Status (1 octet)
-
- Valid status values: 0x01 = Fail
- 0x02 = Not ready
- 0x03 = No memory
- 0x04 = Busy
- 0x05 = Done (already completed)
- 0x06 = Unsupported
- 0x07 = Parameter invalid
- 0x08 = Unhandled
- 0x09 = Authentication failure
- 0x0a = Remote device down
-
Opcode 0x01 - Listen command/response
Command parameters: Socket type (1 octet)
@@ -495,19 +497,6 @@ Commands and responses:
Opcode 0x00 - Error response
- Response parameters: Status (1 octet)
-
- Valid status values: 0x01 = Fail
- 0x02 = Not ready
- 0x03 = No memory
- 0x04 = Busy
- 0x05 = Done (already completed)
- 0x06 = Unsupported
- 0x07 = Parameter invalid
- 0x08 = Unhandled
- 0x09 = Authentication failure
- 0x0a = Remote device down
-
Opcode 0x01 - Connect command/response
Command parameters: Remote address (6 octets)
@@ -692,19 +681,6 @@ Commands and responses:
Opcode 0x00 - Error response
- Response parameters: Status (1 octet)
-
- Valid status values: 0x01 = Fail
- 0x02 = Not ready
- 0x03 = No memory
- 0x04 = Busy
- 0x05 = Done (already completed)
- 0x06 = Unsupported
- 0x07 = Parameter invalid
- 0x08 = Unhandled
- 0x09 = Authentication failure
- 0x0a = Remote device down
-
Opcode 0x01 - Enable command/response
Command parameters: Local role (1 octet)
@@ -792,19 +768,6 @@ Commands and responses:
Opcode 0x00 - Error response
- Response parameters: Status (1 octet)
-
- Valid status values: 0x01 = Fail
- 0x02 = Not ready
- 0x03 = No memory
- 0x04 = Busy
- 0x05 = Done (already completed)
- 0x06 = Unsupported
- 0x07 = Parameter invalid
- 0x08 = Unhandled
- 0x09 = Authentication failure
- 0x0a = Remote device down
-
Opcode 0x01 - Connect command/response
Command parameters: Remote address (6 octets)
@@ -1093,19 +1056,6 @@ Commands and responses:
Opcode 0x00 - Error response
- Response parameters: Status (1 octet)
-
- Valid status values: 0x01 = Fail
- 0x02 = Not ready
- 0x03 = No memory
- 0x04 = Busy
- 0x05 = Done (already completed)
- 0x06 = Unsupported
- 0x07 = Parameter invalid
- 0x08 = Unhandled
- 0x09 = Authentication failure
- 0x0a = Remote device down
-
Opcode 0x01 - Connect command/response
Command parameters: Remote address (6 octets)
@@ -1151,19 +1101,6 @@ Commands and responses:
Opcode 0x00 - Error response
- Response parameters: Status (1 octet)
-
- Valid status values: 0x01 = Fail
- 0x02 = Not ready
- 0x03 = No memory
- 0x04 = Busy
- 0x05 = Done (already completed)
- 0x06 = Unsupported
- 0x07 = Parameter invalid
- 0x08 = Unhandled
- 0x09 = Authentication failure
- 0x0a = Remote device down
-
Opcode 0x01 - Register Application command/response
Command parameters: Number of MDEP (1 octet)
@@ -1250,19 +1187,6 @@ Commands and responses:
Opcode 0x00 - Error response
- Response parameters: Status (1 octet)
-
- Valid status values: 0x01 = Fail
- 0x02 = Not ready
- 0x03 = No memory
- 0x04 = Busy
- 0x05 = Done (already completed)
- 0x06 = Unsupported
- 0x07 = Parameter invalid
- 0x08 = Unhandled
- 0x09 = Authentication failure
- 0x0a = Remote device down
-
Opcode 0x01 - Get Play Status Response command/response
Command parameters: Status (1 octet)
@@ -1495,19 +1419,6 @@ Commands and responses:
Opcode 0x00 - Error response
- Response parameters: Status (1 octet)
-
- Valid status values: 0x01 = Fail
- 0x02 = Not ready
- 0x03 = No memory
- 0x04 = Busy
- 0x05 = Done (already completed)
- 0x06 = Unsupported
- 0x07 = Parameter invalid
- 0x08 = Unhandled
- 0x09 = Authentication failure
- 0x0a = Remote device down
-
Opcode 0x01 - Register Client command/response
Command parameters: Service UUID (16 octets)
@@ -2127,17 +2038,6 @@ Commands and response:
Opcode 0x00 - Error response
- Valid status values: 0x01 = Fail
- 0x02 = Not ready
- 0x03 = No memory
- 0x04 = Busy
- 0x05 = Done (already completed)
- 0x06 = Unsupported
- 0x07 = Parameter invalid
- 0x08 = Unhandled
- 0x09 = Authentication failure
- 0x0a = Remote device down
-
Opcode 0x01 - Connect command/respose
Command parameters: Remote address (6 octects)
@@ -2473,19 +2373,6 @@ Commands and responses:
Opcode 0x00 - Error response
- Response parameters: Status (1 octet)
-
- Valid status values: 0x01 = Fail
- 0x02 = Not ready
- 0x03 = No memory
- 0x04 = Busy
- 0x05 = Done (already completed)
- 0x06 = Unsupported
- 0x07 = Parameter invalid
- 0x08 = Unhandled
- 0x09 = Authentication failure
- 0x0a = Remote device down
-
Opcode 0x01 - Get Remote MAS Instances
Command parameters: Remote address (6 octets)
@@ -2514,19 +2401,6 @@ Commands and responses:
Opcode 0x00 - Error response
- Response parameters: Status (1 octet)
-
- Valid status values: 0x01 = Fail
- 0x02 = Not ready
- 0x03 = No memory
- 0x04 = Busy
- 0x05 = Done (already completed)
- 0x06 = Unsupported
- 0x07 = Parameter invalid
- 0x08 = Unhandled
- 0x09 = Authentication failure
- 0x0a = Remote device down
-
Opcode 0x01 - Send Pass Through command/response
Command parameters: Remote Address (6 octets)
--
1.9.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] android/hal-ipc-txt: Documentation update and cleanup
2014-11-13 8:01 [PATCH] android/hal-ipc-txt: Documentation update and cleanup Szymon Janc
@ 2014-11-13 17:11 ` Szymon Janc
0 siblings, 0 replies; 2+ messages in thread
From: Szymon Janc @ 2014-11-13 17:11 UTC (permalink / raw)
To: linux-bluetooth
On Thursday 13 of November 2014 09:01:21 Szymon Janc wrote:
> This patch clarifies that 0x80 opcode is reserved and not used. This is
> in case we need to introduce confirmations for notifications.
>
> Error response definition is moved into common place and all HALs are
> simply referring to it. This is to keep valid status values in single
> place. Valis status is also updated with 'Authentication Rejected'
> error added in Android 5.0 API.
> ---
> android/hal-ipc-api.txt | 168 ++++++------------------------------------------
> 1 file changed, 21 insertions(+), 147 deletions(-)
>
> diff --git a/android/hal-ipc-api.txt b/android/hal-ipc-api.txt
> index 4f202c8..7c51728 100644
> --- a/android/hal-ipc-api.txt
> +++ b/android/hal-ipc-api.txt
> @@ -55,7 +55,9 @@ The unique service ID is assigned by this specification for each HAL.
> As general rule of thumb, the opcode for command matches the opcode for a
> response. Or the opcode 0x00 for an error is returned.
>
> -Notification opcodes start from 0x80.
> +Notification opcodes start from 0x81.
> +
> +Opcode 0x80 is reserved and shall not be used.
>
> All command/response opcodes have the least significant bit not set. And all
> notifications have the least significant bit set.
> @@ -115,14 +117,29 @@ specific service.
> init() --> register module handsfree
>
>
> -Core Service (ID 0)
> -===================
> +Error response is common for all services and has fixed structure:
>
> Opcode 0x00 - Error response
>
> Response parameters: Status (1 octet)
>
> - Valid status values: 0x01 Failed
> + Valid status values: 0x01 = Fail
> + 0x02 = Not ready
> + 0x03 = No memory
> + 0x04 = Busy
> + 0x05 = Done (already completed)
> + 0x06 = Unsupported
> + 0x07 = Parameter invalid
> + 0x08 = Unhandled
> + 0x09 = Authentication failure
> + 0x0a = Remote device down
> + 0x0b = Authentication rejected
> +
> +
> +Core Service (ID 0)
> +===================
> +
> + Opcode 0x00 - Error response
>
> Opcode 0x01 - Register module command/response
>
> @@ -180,8 +197,6 @@ Commands and responses:
>
> Opcode 0x00 - Error response
>
> - Response parameters: Status (1 octet)
> -
> Opcode 0x01 - Enable command/response
>
> Command parameters: <none>
> @@ -436,19 +451,6 @@ Commands and responses:
>
> Opcode 0x00 - Error response
>
> - Response parameters: Status (1 octet)
> -
> - Valid status values: 0x01 = Fail
> - 0x02 = Not ready
> - 0x03 = No memory
> - 0x04 = Busy
> - 0x05 = Done (already completed)
> - 0x06 = Unsupported
> - 0x07 = Parameter invalid
> - 0x08 = Unhandled
> - 0x09 = Authentication failure
> - 0x0a = Remote device down
> -
> Opcode 0x01 - Listen command/response
>
> Command parameters: Socket type (1 octet)
> @@ -495,19 +497,6 @@ Commands and responses:
>
> Opcode 0x00 - Error response
>
> - Response parameters: Status (1 octet)
> -
> - Valid status values: 0x01 = Fail
> - 0x02 = Not ready
> - 0x03 = No memory
> - 0x04 = Busy
> - 0x05 = Done (already completed)
> - 0x06 = Unsupported
> - 0x07 = Parameter invalid
> - 0x08 = Unhandled
> - 0x09 = Authentication failure
> - 0x0a = Remote device down
> -
> Opcode 0x01 - Connect command/response
>
> Command parameters: Remote address (6 octets)
> @@ -692,19 +681,6 @@ Commands and responses:
>
> Opcode 0x00 - Error response
>
> - Response parameters: Status (1 octet)
> -
> - Valid status values: 0x01 = Fail
> - 0x02 = Not ready
> - 0x03 = No memory
> - 0x04 = Busy
> - 0x05 = Done (already completed)
> - 0x06 = Unsupported
> - 0x07 = Parameter invalid
> - 0x08 = Unhandled
> - 0x09 = Authentication failure
> - 0x0a = Remote device down
> -
> Opcode 0x01 - Enable command/response
>
> Command parameters: Local role (1 octet)
> @@ -792,19 +768,6 @@ Commands and responses:
>
> Opcode 0x00 - Error response
>
> - Response parameters: Status (1 octet)
> -
> - Valid status values: 0x01 = Fail
> - 0x02 = Not ready
> - 0x03 = No memory
> - 0x04 = Busy
> - 0x05 = Done (already completed)
> - 0x06 = Unsupported
> - 0x07 = Parameter invalid
> - 0x08 = Unhandled
> - 0x09 = Authentication failure
> - 0x0a = Remote device down
> -
> Opcode 0x01 - Connect command/response
>
> Command parameters: Remote address (6 octets)
> @@ -1093,19 +1056,6 @@ Commands and responses:
>
> Opcode 0x00 - Error response
>
> - Response parameters: Status (1 octet)
> -
> - Valid status values: 0x01 = Fail
> - 0x02 = Not ready
> - 0x03 = No memory
> - 0x04 = Busy
> - 0x05 = Done (already completed)
> - 0x06 = Unsupported
> - 0x07 = Parameter invalid
> - 0x08 = Unhandled
> - 0x09 = Authentication failure
> - 0x0a = Remote device down
> -
> Opcode 0x01 - Connect command/response
>
> Command parameters: Remote address (6 octets)
> @@ -1151,19 +1101,6 @@ Commands and responses:
>
> Opcode 0x00 - Error response
>
> - Response parameters: Status (1 octet)
> -
> - Valid status values: 0x01 = Fail
> - 0x02 = Not ready
> - 0x03 = No memory
> - 0x04 = Busy
> - 0x05 = Done (already completed)
> - 0x06 = Unsupported
> - 0x07 = Parameter invalid
> - 0x08 = Unhandled
> - 0x09 = Authentication failure
> - 0x0a = Remote device down
> -
> Opcode 0x01 - Register Application command/response
>
> Command parameters: Number of MDEP (1 octet)
> @@ -1250,19 +1187,6 @@ Commands and responses:
>
> Opcode 0x00 - Error response
>
> - Response parameters: Status (1 octet)
> -
> - Valid status values: 0x01 = Fail
> - 0x02 = Not ready
> - 0x03 = No memory
> - 0x04 = Busy
> - 0x05 = Done (already completed)
> - 0x06 = Unsupported
> - 0x07 = Parameter invalid
> - 0x08 = Unhandled
> - 0x09 = Authentication failure
> - 0x0a = Remote device down
> -
> Opcode 0x01 - Get Play Status Response command/response
>
> Command parameters: Status (1 octet)
> @@ -1495,19 +1419,6 @@ Commands and responses:
>
> Opcode 0x00 - Error response
>
> - Response parameters: Status (1 octet)
> -
> - Valid status values: 0x01 = Fail
> - 0x02 = Not ready
> - 0x03 = No memory
> - 0x04 = Busy
> - 0x05 = Done (already completed)
> - 0x06 = Unsupported
> - 0x07 = Parameter invalid
> - 0x08 = Unhandled
> - 0x09 = Authentication failure
> - 0x0a = Remote device down
> -
> Opcode 0x01 - Register Client command/response
>
> Command parameters: Service UUID (16 octets)
> @@ -2127,17 +2038,6 @@ Commands and response:
>
> Opcode 0x00 - Error response
>
> - Valid status values: 0x01 = Fail
> - 0x02 = Not ready
> - 0x03 = No memory
> - 0x04 = Busy
> - 0x05 = Done (already completed)
> - 0x06 = Unsupported
> - 0x07 = Parameter invalid
> - 0x08 = Unhandled
> - 0x09 = Authentication failure
> - 0x0a = Remote device down
> -
> Opcode 0x01 - Connect command/respose
>
> Command parameters: Remote address (6 octects)
> @@ -2473,19 +2373,6 @@ Commands and responses:
>
> Opcode 0x00 - Error response
>
> - Response parameters: Status (1 octet)
> -
> - Valid status values: 0x01 = Fail
> - 0x02 = Not ready
> - 0x03 = No memory
> - 0x04 = Busy
> - 0x05 = Done (already completed)
> - 0x06 = Unsupported
> - 0x07 = Parameter invalid
> - 0x08 = Unhandled
> - 0x09 = Authentication failure
> - 0x0a = Remote device down
> -
> Opcode 0x01 - Get Remote MAS Instances
>
> Command parameters: Remote address (6 octets)
> @@ -2514,19 +2401,6 @@ Commands and responses:
>
> Opcode 0x00 - Error response
>
> - Response parameters: Status (1 octet)
> -
> - Valid status values: 0x01 = Fail
> - 0x02 = Not ready
> - 0x03 = No memory
> - 0x04 = Busy
> - 0x05 = Done (already completed)
> - 0x06 = Unsupported
> - 0x07 = Parameter invalid
> - 0x08 = Unhandled
> - 0x09 = Authentication failure
> - 0x0a = Remote device down
> -
> Opcode 0x01 - Send Pass Through command/response
>
> Command parameters: Remote Address (6 octets)
>
Pushed.
--
Best regards,
Szymon Janc
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2014-11-13 17:11 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-11-13 8:01 [PATCH] android/hal-ipc-txt: Documentation update and cleanup Szymon Janc
2014-11-13 17:11 ` Szymon Janc
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox