michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: host: Document the allowed disconnect reasons.

Browse source 
Document the disconnect reasons that is allowed in the disconnect
command.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
This commit is contained in:
Joakim Andersson 2020-12-11 13:48:28 +01:00 • committed by Carles Cufí
commit d840f42b33
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
include/bluetooth/conn.h
View file

@ -476,6 +476,18 @@ int bt_conn_le_phy_update(struct bt_conn *conn,
* Disconnect an active connection with the specified reason code or cancel
* pending outgoing connection.
*
* The disconnect reason for a normal disconnect should be:
* @ref BT_HCI_ERR_REMOTE_USER_TERM_CONN.
*
* The following disconnect reasons are accepted:
* - @ref BT_HCI_ERR_AUTH_FAIL
* - @ref BT_HCI_ERR_REMOTE_USER_TERM_CONN
* - @ref BT_HCI_ERR_REMOTE_LOW_RESOURCES
* - @ref BT_HCI_ERR_REMOTE_POWER_OFF
* - @ref BT_HCI_ERR_UNSUPP_REMOTE_FEATURE
* - @ref BT_HCI_ERR_PAIRING_NOT_SUPPORTED
* - @ref BT_HCI_ERR_UNACCEPT_CONN_PARAM
*
* @param conn Connection to disconnect.
* @param reason Reason code for the disconnection.
*