Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
mailbox: update kdoc for struct mbox_controller
Add field for missing lock around the hrtimer. Add 'Required' where
the core checks for valid entries.
Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
Reviewed-by: Geert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: Jassi Brar <jassisinghbrar@gmail.com>
authored by
Wolfram Sang
and committed by
Jassi Brar
a068c4d4
c1aad755
+5
-4
+5
-4
include/linux/mailbox_controller.h
+5
-4
include/linux/mailbox_controller.h
···
62
62
63
63
/**
64
64
* struct mbox_controller - Controller of a class of communication channels
65
-
* @dev: Device backing this controller
66
-
* @ops: Operators that work on each communication chan
67
-
* @chans: Array of channels
68
-
* @num_chans: Number of channels in the 'chans' array.
65
+
* @dev: Device backing this controller. Required.
66
+
* @ops: Operators that work on each communication chan. Required.
67
+
* @chans: Array of channels. Required.
68
+
* @num_chans: Number of channels in the 'chans' array. Required.
69
69
* @txdone_irq: Indicates if the controller can report to API when
70
70
* the last transmitted data was read by the remote.
71
71
* Eg, if it has some TX ACK irq.
···
78
78
* @of_xlate: Controller driver specific mapping of channel via DT
79
79
* @poll_hrt: API private. hrtimer used to poll for TXDONE on all
80
80
* channels.
81
+
* @poll_hrt_lock: API private. Lock protecting access to poll_hrt.
81
82
* @node: API private. To hook into list of controllers.
82
83
*/
83
84
struct mbox_controller {