Bluetooth: GATT: Document the context in which callbacks are run

This documents the context in which callbacks are run, that is now
the System Workqueue.

Signed-off-by: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
This commit is contained in:
Luiz Augusto von Dentz 2019-05-31 13:33:50 +03:00 committed by Johan Hedberg
commit dcf253a1d2

View file

@ -790,7 +790,9 @@ struct bt_gatt_notify_params {
* With the addition that after sending the notification the * With the addition that after sending the notification the
* callback function will be called and can dispatch multiple * callback function will be called and can dispatch multiple
* notifications at once. * notifications at once.
*
* The callback is run from System Workqueue context.
*
* Alternatively it is possible to notify by UUID by setting it on the * Alternatively it is possible to notify by UUID by setting it on the
* parameters, when using this method the attribute given when be used as the * parameters, when using this method the attribute given when be used as the
* start range when looking up for possible matches. * start range when looking up for possible matches.
@ -1147,6 +1149,8 @@ int bt_gatt_write(struct bt_conn *conn, struct bt_gatt_write_params *params);
* With the addition that after sending the write the callback function will be * With the addition that after sending the write the callback function will be
* called. * called.
* *
* The callback is run from System Workqueue context.
*
* Note: By using a callback it also disable the internal flow control * Note: By using a callback it also disable the internal flow control
* which would prevent sending multiple commands without waiting for their * which would prevent sending multiple commands without waiting for their
* transmissions to complete, so if that is required the caller shall not * transmissions to complete, so if that is required the caller shall not