serdev: document driver callbacks
authorJohan Hovold <johan@kernel.org>
Fri, 3 Nov 2017 14:30:54 +0000 (15:30 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Tue, 28 Nov 2017 15:03:35 +0000 (16:03 +0100)
commit10f9e033c1e0e8563699b5839a2ff7f565dd72b2
tree32b207d27a797ece816a7a02821335eadcd62d2c
parent1f043572cbbee03f1de814e312f9dc11251fdc5a
serdev: document driver callbacks

Amend the driver-callback kerneldoc with calling context and expected
return values.

Note that this is based on the requirements and characteristics of the
tty-port controller implementation which receives data in workqueue
context and whose write_wakeup callback must not sleep.

Also note that while the receive_buf callback returns an integer, the
returned value is still expected to be non-negative (and no greater than
the buffer-size argument).

Signed-off-by: Johan Hovold <johan@kernel.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
include/linux/serdev.h