From 4ebdcf49dcf43c2ab2f250555c8604530fe776c4 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Tue, 21 Feb 2012 13:26:52 +0100 Subject: [PATCH] mgmt-api: Add comments for valid commands when power off --- doc/mgmt-api.txt | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt index 71e991409..a6bb22a00 100644 --- a/doc/mgmt-api.txt +++ b/doc/mgmt-api.txt @@ -144,6 +144,12 @@ Set Discoverable Command Timeout is the time in seconds and is only meningful when Discoverable is set to 1. + This command can be used when the controller is not powered and + all settings will be programmed once powered. + + However using a timeout when the controller is not powered will + return an error. + This command generates a Command Complete event on success or a Command Status event on failure. @@ -156,6 +162,9 @@ Set Connectable Command Command Parameters: Connectable (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command can be used when the controller is not powered and + all settings will be programmed once powered. + This command generates a Command Complete event on success or a Command Status event on failure. @@ -168,6 +177,9 @@ Set Fast Connectable Command Command Parameters: Enable (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command can be used when the controller is not powered and + all settings will be programmed once powered. + This command generates a Command Complete event on success or a Command Status event on failure. @@ -180,6 +192,9 @@ Set Pairable Command Command Parameters: Pairable (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command can be used when the controller is not powered and + all settings will be programmed once powered. + This command generates a Command Complete event on success or a Command Status event on failure. @@ -192,6 +207,9 @@ Set Link Security Command Command Parameters: Link_Security (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command can be used when the controller is not powered and + all settings will be programmed once powered. + This command generates a Command Complete event on success or a Command Status event on failure. @@ -204,6 +222,12 @@ Set Secure Simple Pairing Command Command Parameters: Secure_Simple_Pairing (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command can be used when the controller is not powered and + all settings will be programmed once powered. + + In case the controller does not support Secure Simple Pairing, + the command will fail regardless. + This command generates a Command Complete event on success or a Command Status event on failure. @@ -216,6 +240,12 @@ Set High Speed Command Command Parameters: High_Speed (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command can be used when the controller is not powered and + all settings will be programmed once powered. + + In case the kernel subsystem does not support High Speed, the + command will fail regardless. + This command generates a Command Complete event on success or a Command Status event on failure. @@ -228,6 +258,12 @@ Set Low Energy Command Command Parameters: Low_Energy (1 Octet) Return Parameters: Current_Settings (4 Octets) + This command can be used when the controller is not powered and + all settings will be programmed once powered. + + In case the kernel subsystem does not support Low Energy or the + controller does not either, the command will fail regardless. + This command generates a Command Complete event on success or a Command Status event on failure. @@ -669,6 +705,9 @@ Set Device ID Command Version (2 Octets) Return Parameters: + This command can be used when the controller is not powered and + all settings will be programmed once powered. + The Source parameter selects the organization that assigned the Vendor parameter: -- 2.47.3