usbc: Update tcpc_sop_prime_enable() description

recalci · kartben · commit 6f0d72118a34 · 2025-01-15T19:03:27.000+01:00
Clearly mention that this function enables both SOP' and SOP'' messages.

Signed-off-by: Jianxiong Gu &lt;jianxiong.gu@outlook.com&gt;
diff --git a/include/zephyr/drivers/usb_c/usbc_tcpc.h b/include/zephyr/drivers/usb_c/usbc_tcpc.h
@@ -839,10 +839,11 @@ static inline int tcpc_set_low_power_mode(const struct device *dev, bool enable)
 }
 
 /**
- * @brief Enables the reception of SOP Prime messages
+ * @brief Enables the reception of SOP Prime and optionally SOP Double Prime messages
  *
  * @param dev     Runtime device structure
- * @param enable  Can receive SOP Prime messages when true, else it can not
+ * @param enable  Can receive SOP Prime messages and SOP Double Prime messages when true,
+ *		  else it can not
  *
  * @retval 0 on success
  * @retval -EIO on failure

Original file line number	Diff line number	Diff line change
`@@ -839,10 +839,11 @@ static inline int tcpc_set_low_power_mode(const struct device *dev, bool enable)`
`839`	`839`	`}`
`840`	`840`
`841`	`841`	`/**`
`842`		`- * @brief Enables the reception of SOP Prime messages`
	`842`	`+ * @brief Enables the reception of SOP Prime and optionally SOP Double Prime messages`
`843`	`843`	`*`
`844`	`844`	`* @param dev Runtime device structure`
`845`		`- * @param enable Can receive SOP Prime messages when true, else it can not`
	`845`	`+ * @param enable Can receive SOP Prime messages and SOP Double Prime messages when true,`
	`846`	`+ * else it can not`
`846`	`847`	`*`
`847`	`848`	`* @retval 0 on success`
`848`	`849`	`* @retval -EIO on failure`