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>

diff --git a/include/linux/mailbox_controller.h b/include/linux/mailbox_controller.h
index a49ee687d4cf7b5718cfd07645e9f57f667a1c3f..dc93287a2a01aeef7299f6b10846dd9058dba84f 100644 (file)
--- a/include/linux/mailbox_controller.h
+++ b/include/linux/mailbox_controller.h
@@ -62,10 +62,10 @@ struct mbox_chan_ops {
 
 /**
  * struct mbox_controller - Controller of a class of communication channels
- * @dev:               Device backing this controller
- * @ops:               Operators that work on each communication chan
- * @chans:             Array of channels
- * @num_chans:         Number of channels in the 'chans' array.
+ * @dev:               Device backing this controller. Required.
+ * @ops:               Operators that work on each communication chan. Required.
+ * @chans:             Array of channels. Required.
+ * @num_chans:         Number of channels in the 'chans' array. Required.
  * @txdone_irq:                Indicates if the controller can report to API when
  *                     the last transmitted data was read by the remote.
  *                     Eg, if it has some TX ACK irq.
@@ -78,6 +78,7 @@ struct mbox_chan_ops {
  * @of_xlate:          Controller driver specific mapping of channel via DT
  * @poll_hrt:          API private. hrtimer used to poll for TXDONE on all
  *                     channels.
+ * @poll_hrt_lock:     API private. Lock protecting access to poll_hrt.
  * @node:              API private. To hook into list of controllers.
  */
 struct mbox_controller {