From be2f0f40240dcab71a9878f39d5252c999a19b19 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Fri, 17 Feb 2012 15:31:48 +0100 Subject: [PATCH] mgmt-api: Add comments if command status or command complete is returned --- doc/mgmt-api.txt | 120 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 119 insertions(+), 1 deletion(-) diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt index b4e9748cf..eaef77974 100644 --- a/doc/mgmt-api.txt +++ b/doc/mgmt-api.txt @@ -41,6 +41,9 @@ Read Management Version Information Command Return Parameters: Version (1 Octets) Revision (2 Octets) + This command generates a Command Complete event on success or + a Command Status event on failure. + Read Management Supported Commands Command ========================================== @@ -57,6 +60,9 @@ Read Management Supported Commands Command Event2 (2 Octets) ... + This command generates a Command Complete event on success or + a Command Status event on failure. + The commands Read Management Version Information and Read management Supported Commands are not included in this list. Both commands are always supported and mandatory. @@ -74,6 +80,9 @@ Read Controller Index List Command Return Parameters: Num_Controllers (2 Octets) Controller_Index[i] (2 Octets) + This command generates a Command Complete event on success or + a Command Status event on failure. + Read Controller Information Command =================================== @@ -107,6 +116,9 @@ Read Controller Information Command 9 High Speed 10 Low Energy + This command generates a Command Complete event on success or + a Command Status event on failure. + Set Powered Command =================== @@ -116,6 +128,9 @@ Set Powered Command Command Parameters: Powered (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command generates a Command Complete event on success or + a Command Status event on failure. + Set Discoverable Command ======================== @@ -129,6 +144,9 @@ Set Discoverable Command Timeout is the time in seconds and is only meningful when Discoverable is set to 1. + This command generates a Command Complete event on success or + a Command Status event on failure. + Set Connectable Command ======================= @@ -138,6 +156,9 @@ Set Connectable Command Command Parameters: Connectable (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command generates a Command Complete event on success or + a Command Status event on failure. + Set Fast Connectable Command ============================ @@ -147,6 +168,9 @@ Set Fast Connectable Command Command Parameters: Enable (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command generates a Command Complete event on success or + a Command Status event on failure. + Set Pairable Command ==================== @@ -156,6 +180,9 @@ Set Pairable Command Command Parameters: Pairable (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command generates a Command Complete event on success or + a Command Status event on failure. + Set Link Security Command ========================= @@ -165,6 +192,9 @@ Set Link Security Command Command Parameters: Link_Security (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command generates a Command Complete event on success or + a Command Status event on failure. + Set Secure Simple Pairing Command ================================= @@ -174,6 +204,9 @@ Set Secure Simple Pairing Command Command Parameters: Secure_Simple_Pairing (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command generates a Command Complete event on success or + a Command Status event on failure. + Set High Speed Command ====================== @@ -183,6 +216,9 @@ Set High Speed Command Command Parameters: High_Speed (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command generates a Command Complete event on success or + a Command Status event on failure. + Set Low Energy Command ====================== @@ -192,6 +228,9 @@ Set Low Energy Command Command Parameters: Low_Energy (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command generates a Command Complete event on success or + a Command Status event on failure. + Set Device Class ================ @@ -205,6 +244,9 @@ Set Device Class This command will also implicitly disable caching of pending CoD and EIR updates. + This command generates a Command Complete event on success or + a Command Status event on failure. + Set Local Name Command ====================== @@ -219,6 +261,9 @@ Set Local Name Command The name parameters need to always end with a nul byte (failure to do so will cause the command to fail). + This command generates a Command Complete event on success or + a Command Status event on failure. + Add UUID Command ================ @@ -229,6 +274,9 @@ Add UUID Command SVC_Hint (1 Octet) Return Parameters: Class_Of_Device (3 Octets) + This command generates a Command Complete event on success or + a Command Status event on failure. + Remove UUID Command =================== @@ -238,6 +286,9 @@ Remove UUID Command Command Parameters: UUID (16 Octets) Return Parameters: Class_Of_Device (3 Octets) + This command generates a Command Complete event on success or + a Command Status event on failure. + Load Link Keys Command ====================== @@ -257,6 +308,9 @@ Load Link Keys Command ... Return Parameters: + This command generates a Command Status event on success + or failure. + Load Long Term Keys Command =========================== @@ -277,6 +331,9 @@ Load Long Term Keys Command Key2 { } ... + This command generates a Command Status event on success + or failure. + Disconnect Command ================== @@ -288,6 +345,9 @@ Disconnect Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command generates a Command Complete event on success + or failure. + Get Connections Command ======================= @@ -308,6 +368,9 @@ Get Connections Command 1 LE Public 2 LE Random + This command generates a Command Complete event on success + or failure. + PIN Code Reply Command ======================= @@ -321,6 +384,9 @@ PIN Code Reply Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command generates a Command Complete event on success + or failure. + PIN Code Negative Reply Command =============================== @@ -332,6 +398,9 @@ PIN Code Negative Reply Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command generates a Command Complete event on success + or failure. + Set IO Capability Command ========================= @@ -341,6 +410,9 @@ Set IO Capability Command Command Parameters: IO_Capability (1 Octet) Return Parameters: + This command generates a Command Status event on success + or failure. + Pair Device Command =================== @@ -358,6 +430,9 @@ Pair Device Command 1 LE Public 2 LE Random + This command generates a Command Complete event on success + or failure. + Cancel Pair Device ================== @@ -373,6 +448,9 @@ Cancel Pair Device The Address and Address_Type parameters should match what was given to a preceding Pair Device command. + This command generates a Command Complete event on success + or failure. + Unpair Device Command ===================== @@ -387,11 +465,14 @@ Unpair Device Command Removes all keys associated with the remote device. - The Disconnect parameter tells the kernel whether to focefully + The Disconnect parameter tells the kernel whether to forcefully disconnect any existing connections to the device. It should in practice always be 1 except for some special GAP qualification test-cases where a key removal without disconnecting is needed. + This command generates a Command Complete event on success + or failure. + User Confirmation Reply Command =============================== @@ -403,6 +484,9 @@ User Confirmation Reply Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command generates a Command Complete event on success + or failure. + User Confirmation Negative Reply Command ======================================== @@ -414,6 +498,9 @@ User Confirmation Negative Reply Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command generates a Command Complete event on success + or failure. + User Passkey Reply Command ========================== @@ -426,6 +513,9 @@ User Passkey Reply Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command generates a Command Complete event on success + or failure. + User Passkey Negative Reply Command =================================== @@ -437,6 +527,9 @@ User Passkey Negative Reply Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command generates a Command Complete event on success + or failure. + Read Local Out Of Band Data Command =================================== @@ -447,6 +540,9 @@ Read Local Out Of Band Data Command Return Parameters: Hash (16 Octets) Randomizer (16 Octets) + This command generates a Command Complete event on success + or failure. + Add Remote Out Of Band Data Command =================================== @@ -460,6 +556,9 @@ Add Remote Out Of Band Data Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command generates a Command Complete event on success + or failure. + Remove Remote Out Of Band Data Command ======================================== @@ -471,6 +570,9 @@ Remove Remote Out Of Band Data Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command generates a Command Complete event on success + or failure. + Start Discovery Command ======================= @@ -493,6 +595,9 @@ Start Discovery Command 6 LE (public & random) 7 BR/EDR/LE (interleaved discovery) + This command generates a Command Complete event on success + or failure. + Stop Discovery Command ====================== @@ -502,6 +607,9 @@ Stop Discovery Command Command Parameters: Return Parameters: + This command generates a Command Complete event on success + or failure. + Confirm Name Command ==================== @@ -518,6 +626,9 @@ Confirm Name Command expected for each Device Found event with the Confirm Name flag set. + This command generates a Command Complete event on success + or failure. + Block Device Command ==================== @@ -529,6 +640,9 @@ Block Device Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command generates a Command Complete event on success + or failure. + Unblock Device Command ====================== @@ -540,6 +654,10 @@ Unblock Device Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command generates a Command Complete event on success + or failure. + + Command Complete Event ====================== -- 2.47.3