michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: Add doxygen for bt_conn_security

Browse source 
Change-Id: I8d2f609e803931bc5cd4c8cd60a017b1956eb726
Signed-off-by: Szymon Janc <szymon.janc@tieto.com>
This commit is contained in:
Szymon Janc 2015-06-26 19:03:05 +02:00 • committed by Anas Nashif
commit bd0642958b
1 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
include/bluetooth/conn.h
View file

@ -102,6 +102,26 @@ typedef enum {
BT_CONN_SEC_FIPS,
} bt_conn_security_t;
/*! @brief Set security level for a connection.
*
* This function enable security (encryption) for a connection. If device is
* already paired with sufficiently strong key encryption will be enabled. If
* link is already encrypted with sufficiently strong key this function does
* nothing.
*
* If device is not paired pairing will be initiated. If device is paired and
* keys are too weak but input output capabilities allow for strong enough keys
* pairing will be initiated.
*
* This function may return error if required level of security is not possible
* to achieve due to local or remote device limitation (eg input output
* capabilities).
*
* @param conn Connection object.
* @param sec Requested security level.
*
* @return 0 on success or negative error
*/
int bt_conn_security(struct bt_conn *conn, bt_conn_security_t sec);
#endif /* __BT_CONN_H */