Bluetooth: ATT: Add documentation for chan_send

Vudentz · nashif · commit b02636053ad5 · 2021-04-22T17:16:49.000-04:00
chan_send does restore buffer state in case of an error which is
different than how bt_l2cap_send_cb works as it does always unref in
case of an error.

Signed-off-by: Luiz Augusto von Dentz &lt;luiz.von.dentz@intel.com&gt;
diff --git a/subsys/bluetooth/host/att.c b/subsys/bluetooth/host/att.c
@@ -130,6 +130,13 @@ void att_sent(struct bt_conn *conn, void *user_data)
 	}
 }
 
+/* In case of success the ownership of the buffer is transferred to the stack
+ * which takes care of releasing it when it completes transmitting to the
+ * controller.
+ *
+ * In case bt_l2cap_send_cb fails the buffer state and ownership are retained
+ * so the buffer can be safely pushed back to the queue to be processed later.
+ */
 static int chan_send(struct bt_att_chan *chan, struct net_buf *buf,
 		     bt_att_chan_sent_t cb)
 {

Original file line number	Diff line number	Diff line change
`@@ -130,6 +130,13 @@ void att_sent(struct bt_conn conn, void user_data)`
`130`	`130`	`}`
`131`	`131`	`}`
`132`	`132`
	`133`	`+/* In case of success the ownership of the buffer is transferred to the stack`
	`134`	`+ * which takes care of releasing it when it completes transmitting to the`
	`135`	`+ * controller.`
	`136`	`+ *`
	`137`	`+ * In case bt_l2cap_send_cb fails the buffer state and ownership are retained`
	`138`	`+ * so the buffer can be safely pushed back to the queue to be processed later.`
	`139`	`+ */`
`133`	`140`	`static int chan_send(struct bt_att_chan chan, struct net_buf buf,`
`134`	`141`	`bt_att_chan_sent_t cb)`
`135`	`142`	`{`