--- doc/mgmt-api.txt | 96 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt index 39f23c456080..ac5b6c97d64a 100644 --- a/doc/mgmt-api.txt +++ b/doc/mgmt-api.txt @@ -3138,6 +3138,74 @@ Read Security Information Command Invalid Index +Get Device Flags Command +======================== + + Command Code: 0x0049 + Controller Index: <controller id> + Command Parameters: Address (6 Octets) + Address_Type (1 Octet) + Return Parameters: Address (6 Octets) + Address_Type (1 Octet) + Supported_Flags (4 Octets) + Current_Flags (4 Octets) + + This command is used to retrieve additional flags and settings + for devices that are added via Add Device command. + + Possible values for the Address_Type parameter: + 0 BR/EDR + 1 LE Public + 2 LE Random + + The Flags parameters are a bitmask with currently the following + available bits: + + 0 Remote Wakeup enabled + + This command generates a Command Complete event on success + or a Command Status event on failure. + + Possible errors: Invalid Parameters + Invalid Index + + +Set Device Flags Command +======================== + + Command Code: 0x004a + Controller Index: <controller id> + Command Parameters: Address (6 Octets) + Address_Type (1 Octet) + Current_Flags (4 Octets) + Return Parameters: Address (6 Octets) + Address_Type (1 Octet) + + This command is used to configure additional flags and settings + for devices that are added via Add Device command. + + Possible values for the Address_Type parameter: + 0 BR/EDR + 1 LE Public + 2 LE Random + + The list of supported Flags can be retrieved via the Get Device + Flags or Device Flags Changed command. Selecting unsupported flags + will result in an Invalid Parameter error; + + Refer to the Get Device Flags command for a detailed description + of the Flags parameters. + + 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. + + Possible errors: Invalid Parameters + Invalid Index + + Command Complete Event ====================== @@ -4004,6 +4072,7 @@ Extended Controller Information Changed Event The event will only be sent to management sockets other than the one through which the change was triggered. + PHY Configuration Changed Event =============================== @@ -4020,3 +4089,30 @@ PHY Configuration Changed Event one through which the change was triggered. Refer Get PHY Configuration command for PHYs parameter. + + +Device Flags Changed Event +========================== + + Event Code: 0x0027 + Controller Index: <controller id> + Event Parameters: Address (6 Octets) + Address_Type (1 Octet) + Supported_Flags (4 Octets) + Current_Flags (4 Octets) + + This event indicates that the device flags have been changed via + the Set Device Flags command or that a new device has been added + via the Add Device command. In the latter case it is send right + after the Device Added event. + + Possible values for the Address_Type parameter: + 0 BR/EDR + 1 LE Public + 2 LE Random + + The event will only be sent to management sockets other than the + one through which the command was sent. + + In case this event is triggered by Add Device then it is sent to + all management sockets. -- 2.25.1
