From 87276365ab8c78cd410eeb70e2c754ee25fd55dc Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Wed, 22 Feb 2012 21:43:04 +0100 Subject: [PATCH] mgmt-api: Add comments for commands that require powered controller --- doc/mgmt-api.txt | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt index 03c35ac28..18f697cfb 100644 --- a/doc/mgmt-api.txt +++ b/doc/mgmt-api.txt @@ -424,6 +424,8 @@ Load Long Term Keys Command Key2 { } ... + This command can be used when the controller is not powered. + This command generates a Command Complete event on success or a Command Status event on failure. @@ -438,6 +440,8 @@ Disconnect Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -461,6 +465,8 @@ Get Connections Command 1 LE Public 2 LE Random + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or a Command Status event on failure. @@ -477,6 +483,8 @@ PIN Code Reply Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -491,6 +499,8 @@ PIN Code Negative Reply Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -525,6 +535,8 @@ Pair Device Command 1 LE Public 2 LE Random + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -543,6 +555,8 @@ Cancel Pair Device The Address and Address_Type parameters should match what was given to a preceding Pair Device command. + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -565,6 +579,8 @@ Unpair Device Command practice always be 1 except for some special GAP qualification test-cases where a key removal without disconnecting is needed. + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -579,6 +595,8 @@ User Confirmation Reply Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -593,6 +611,8 @@ User Confirmation Negative Reply Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -608,6 +628,8 @@ User Passkey Reply Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -622,6 +644,8 @@ User Passkey Negative Reply Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -635,6 +659,8 @@ Read Local Out Of Band Data Command Return Parameters: Hash (16 Octets) Randomizer (16 Octets) + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or a Command Status event on failure. @@ -651,6 +677,8 @@ Add Remote Out Of Band Data Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -665,6 +693,8 @@ Remove Remote Out Of Band Data Command Return Parameters: Address (6 Octets) Address_Type (1 Octet) + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -690,6 +720,8 @@ Start Discovery Command 6 LE (public & random) 7 BR/EDR/LE (interleaved discovery) + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -702,6 +734,8 @@ Stop Discovery Command Command Parameters: Address_Type (1 Octet) Return Parameters: Address_Type (1 Octet) + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. @@ -721,6 +755,8 @@ Confirm Name Command expected for each Device Found event with the Confirm Name flag set. + This command can only be used when the controller is powered. + This command generates a Command Complete event on success or failure. -- 2.47.3