diff options
author | Alain Michaud <alainm@chromium.org> | 2020-06-10 10:47:58 +0200 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2020-06-10 10:47:58 +0200 |
commit | 1bc9dc3ed7a0ebe10e898d9a4177e486d1cc6190 (patch) | |
tree | 803a2b6941c7413ed341af3decd23ef3578a5837 /doc/mgmt-api.txt | |
parent | 4cf36cb549eca28a2bdf5cde837c056fd0878953 (diff) | |
download | bluez-1bc9dc3ed7a0ebe10e898d9a4177e486d1cc6190.tar.gz |
doc: adding definitions for load default params mgmt op
This change adds the definition for the read/set default parameter
commands.
In particular, these commands are used to read and set the system
default parameters. The use of a TLV format also ensures that
parameters are expandable in the future.
This will allow bluetoothd to load parameters from a conf file that may
be customized for the specific requirements of each platforms.
Diffstat (limited to 'doc/mgmt-api.txt')
-rw-r--r-- | doc/mgmt-api.txt | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt index 6ee01fed8..3b97b54bd 100644 --- a/doc/mgmt-api.txt +++ b/doc/mgmt-api.txt @@ -3223,6 +3223,96 @@ Set Experimental Feature Command Invalid Index +Read Default System Configuration Command +========================================= + + Command Code: 0x004b + Controller Index: <controller id> + Command Parameters: + Return Parameters: Parameter1 { + Parameter_Type (2 Octet) + Value_Length (1 Octet) + Value (0-255 Octets) + } + Parameter2 { } + ... + + This command is used to read a list of default controller parameters. + + Currently defined Parameter_Type values are: + + 0x0000 BR/EDR Page Scan Type + 0x0001 BR/EDR Page Scan Interval + 0x0002 BR/EDR Page Scan Window + 0x0003 BR/EDR Inquiry Scan Type + 0x0004 BR/EDR Inquiry Scan Interval + 0x0005 BR/EDR Inquiry Scan Window + 0x0006 BR/EDR Link Supervision Timeout + 0x0007 BR/EDR Page Timeout + 0x0008 BR/EDR Min Sniff Interval + 0x0009 BR/EDR Max Sniff Interval + 0x000a LE Advertisement Min Interval + 0x000b LE Advertisement Max Interval + 0x000c LE Multi Advertisement Rotation Interval + 0x000d LE Scanning Interval for auto connect + 0x000e LE Scanning Window for auto connect + 0x000f LE Scanning Interval for wake scenarios + 0x0010 LE Scanning Window for wake scenarios + 0x0011 LE Scanning Interval for discovery + 0x0012 LE Scanning Window for discovery + 0x0013 LE Scanning Interval for adv monitoring + 0x0014 LE Scanning Window for adv monitoring + 0x0015 LE Scanning Interval for connect + 0x0016 LE Scanning Window for connect + 0x0017 LE Min Connection Interval + 0x0018 LE Max Connection Interval + 0x0019 LE Connection Latency + 0x001a LE Connection Supervision Timeout + + This command can be used at any time and will return a list of + supported default parameters as well as their current value. + + This command generates a Command Complete event on success or + a Command Status event on failure. + + Possible errors: Invalid Parameters + Invalid Index + + +Set Default System Configuration Command +======================================== + + Command Code: 0x004c + Controller Index: <controller id> + Command Parameters: Parameter1 { + Parameter_Type (2 Octet) + Value_Length (1 Octet) + Value (0-255 Octets) + } + Parameter2 { } + ... + Return Parameters: + + This command is used to set a list of default controller parameters. + + See Read Default System Configuration command for list of supported + Parameter_Type values. + + This command can be used when the controller is not powered and + all supported parameters will be programmed once powered. + + When providing unsupported values or invalid values, no parameter + value will be changed and all values discarded. + + This command generates a Command Complete event on success or + a Command Status event on failure. + + Possible errors: Rejected + Not Supported + Invalid Parameters + Invalid Index + + Command Complete Event ====================== |