drivers: espi: Add return value to eSPI send_vwire API

AdiIntel · kartben · commit 410201045657 · 2025-04-17T00:57:28.000+02:00
Added note about return value to the eSPI send_vwire API in the header:
-ETIMEDOUT &amp; _EINVAL.

Signed-off-by: Aditya Bhutada &lt;aditya.bhutada@intel.com&gt;
diff --git a/include/zephyr/drivers/espi.h b/include/zephyr/drivers/espi.h
@@ -728,6 +728,8 @@ static inline int z_impl_espi_write_lpc_request(const struct device *dev,
  *
  * @retval 0 If successful.
  * @retval -EIO General input / output error, failed to send over the bus.
+ * @retval -EINVAL invalid signal.
+ * @retval -ETIMEDOUT timeout waiting for eSPI controller to process the VW.
  */
 __syscall int espi_send_vwire(const struct device *dev,
 			      enum espi_vwire_signal signal,

Original file line number	Diff line number	Diff line change
`@@ -728,6 +728,8 @@ static inline int z_impl_espi_write_lpc_request(const struct device *dev,`
`728`	`728`	`*`
`729`	`729`	`* @retval 0 If successful.`
`730`	`730`	`* @retval -EIO General input / output error, failed to send over the bus.`
	`731`	`+ * @retval -EINVAL invalid signal.`
	`732`	`+ * @retval -ETIMEDOUT timeout waiting for eSPI controller to process the VW.`
`731`	`733`	`*/`
`732`	`734`	`__syscall int espi_send_vwire(const struct device *dev,`
`733`	`735`	`enum espi_vwire_signal signal,`