[nrf fromtree] drivers: mspi: Add timeout callback to MSPI API

This is a new callback option that drivers can use for when a request
or xfer has timed out. E.g if an Async RX request never received
anything, this callback can be used so a user can clean up their
application.

Signed-off-by: David Jewsbury <[email protected]>
(cherry picked from commit a322957)

Author: Hi-Im-David

doc/hardware/peripherals/mspi.rst

@@ -100,10 +100,12 @@ whether to support scatter IO and callback management. The controller can determ
 which user callback to trigger based on :c:enum:`mspi_bus_event_cb_mask` upon completion
 of each async/sync transfer if the callback had been registered using
 :c:func:`mspi_register_callback`. Or not to trigger any callback at all with
-:c:enum:`MSPI_BUS_NO_CB` even if the callbacks are already registered.
-In which case that a controller supports hardware command queue, user could take full
-advantage of the hardware performance if scatter IO and callback management are supported
-by the driver implementation.
+:c:enum:`MSPI_BUS_NO_CB` even if the callbacks are already registered. If the implemented
+driver support it, the API supports :c:enum:`MSPI_BUS_XFER_COMPLETE_CB` to signal when a
+transfer finishes and :c:enum:`MSPI_BUS_TIMEOUT_CB` to signal when a transfer or request
+has timed-out. In which case that a controller supports hardware command queue, user could
+take full advantage of the hardware performance if scatter IO and callback management are
+supported by the driver implementation.
 
 Device Tree
 ===========

include/zephyr/drivers/mspi.h

@@ -126,6 +126,8 @@ enum mspi_bus_event {
 	MSPI_BUS_RESET              = 0,
 	MSPI_BUS_ERROR              = 1,
 	MSPI_BUS_XFER_COMPLETE      = 2,
+	/** @brief When a request or xfer has timed out */
+	MSPI_BUS_TIMEOUT            = 3,
 	MSPI_BUS_EVENT_MAX,
 };
 
@@ -139,6 +141,7 @@ enum mspi_bus_event_cb_mask {
 	MSPI_BUS_RESET_CB           = BIT(0),
 	MSPI_BUS_ERROR_CB           = BIT(1),
 	MSPI_BUS_XFER_COMPLETE_CB   = BIT(2),
+	MSPI_BUS_TIMEOUT_CB         = BIT(3),
 };
 
 /**