diff mbox series

[2/2] usb: typec: tcpm: Add a description for the init callback

Message ID 20210511022224.1309077-3-bryan.odonoghue@linaro.org (mailing list archive)
State New, archived
Headers show
Series usb: typec: tcpm: Fix logic and documentation of tcpc_dev->init | expand

Commit Message

Bryan O'Donoghue May 11, 2021, 2:22 a.m. UTC 
The init callback is the only callback in the tcpc_dev structure which
doesn't have a description. The code treats the callback as optional but,
we don't document that.

Let's add a description making clear the callback is optional.

Signed-off-by: Bryan O'Donoghue <bryan.odonoghue@linaro.org>
---
 include/linux/usb/tcpm.h | 2 ++
 1 file changed, 2 insertions(+)
diff mbox series

Patch

diff --git a/include/linux/usb/tcpm.h b/include/linux/usb/tcpm.h
index 42fcfbe10590..452a0bb9ec50 100644
--- a/include/linux/usb/tcpm.h
+++ b/include/linux/usb/tcpm.h
@@ -58,6 +58,8 @@  enum tcpm_transmit_type {
 /**
  * struct tcpc_dev - Port configuration and callback functions
  * @fwnode:	Pointer to port fwnode
+ * @init:	Optional; Called by tcpm_port_register() and tcpm_tcpc_reset()
+ *		to set the TCPM driver into a known initial state.
  * @get_vbus:	Called to read current VBUS state
  * @get_current_limit:
  *		Optional; called by the tcpm core when configured as a snk