michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: doc: Document HCI errors for connected callback

Browse source 
Add documentation for the possible HCI errors codes received for a
connected callback. The HCI error code received when the initiator is
canceled through the HCI create conn cancel operation is non-intuitive.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
This commit is contained in:
Joakim Andersson 2019-11-13 12:55:43 +01:00 • committed by Ioannis Glaropoulos
commit be63f42db1
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
include/bluetooth/conn.h
View file

@ -409,6 +409,15 @@ struct bt_conn_cb {
*
* @param conn New connection object.
* @param err HCI error. Zero for success, non-zero otherwise.
*
* @p err can mean either of the following:
* - @ref BT_HCI_ERR_UNKNOWN_CONN_ID Creating the connection started by
* @ref bt_conn_create_le was canceled either by the user through
* @ref bt_conn_disconnect or by the timeout in the host through
* :option:`CONFIG_BT_CREATE_CONN_TIMEOUT`.
* - @p BT_HCI_ERR_ADV_TIMEOUT Directed advertiser started by @ref
* bt_conn_create_slave_le with high duty cycle timed out after 1.28
* seconds.
*/
void (*connected)(struct bt_conn *conn, u8_t err);