drivers: i3c: add i3c error type in payload

Add the SDR Error Code to be written in to the payload following
section 5.1.10.2 of the I3C v1.1.1 specification.

Signed-off-by: Ryan McClelland <[email protected]>

Author: XenuIsWatching

include/zephyr/drivers/i3c.h

@@ -23,6 +23,7 @@
 
 #include <zephyr/device.h>
 #include <zephyr/drivers/i3c/addresses.h>
+#include <zephyr/drivers/i3c/error_types.h>
 #include <zephyr/drivers/i3c/ccc.h>
 #include <zephyr/drivers/i3c/devicetree.h>
 #include <zephyr/drivers/i3c/ibi.h>
@@ -292,87 +293,6 @@ enum i3c_data_rate {
 	I3C_DATA_RATE_INVALID,
 };
 
-/**
- * @brief I3C SDR Controller Error Codes
- *
- * These are error codes defined by the I3C specification.
- *
- * #I3C_ERROR_CE_UNKNOWN and #I3C_ERROR_CE_NONE are not
- * official error codes according to the specification.
- * These are there simply to aid in error handling during
- * interactions with the I3C drivers and subsystem.
- */
-enum i3c_sdr_controller_error_codes {
-	/** Transaction after sending CCC */
-	I3C_ERROR_CE0,
-
-	/** Monitoring Error */
-	I3C_ERROR_CE1,
-
-	/** No response to broadcast address (0x7E) */
-	I3C_ERROR_CE2,
-
-	/** Failed Controller Handoff */
-	I3C_ERROR_CE3,
-
-	/** Unknown error (not official error code) */
-	I3C_ERROR_CE_UNKNOWN,
-
-	/** No error (not official error code) */
-	I3C_ERROR_CE_NONE,
-
-	I3C_ERROR_CE_MAX = I3C_ERROR_CE_UNKNOWN,
-	I3C_ERROR_CE_INVALID,
-};
-
-/**
- * @brief I3C SDR Target Error Codes
- *
- * These are error codes defined by the I3C specification.
- *
- * #I3C_ERROR_TE_UNKNOWN and #I3C_ERROR_TE_NONE are not
- * official error codes according to the specification.
- * These are there simply to aid in error handling during
- * interactions with the I3C drivers and subsystem.
- */
-enum i3c_sdr_target_error_codes {
-	/**
-	 * Invalid Broadcast Address or
-	 * Dynamic Address after DA assignment
-	 */
-	I3C_ERROR_TE0,
-
-	/** CCC Code */
-	I3C_ERROR_TE1,
-
-	/** Write Data */
-	I3C_ERROR_TE2,
-
-	/** Assigned Address during Dynamic Address Arbitration */
-	I3C_ERROR_TE3,
-
-	/** 0x7E/R missing after RESTART during Dynamic Address Arbitration */
-	I3C_ERROR_TE4,
-
-	/** Transaction after detecting CCC */
-	I3C_ERROR_TE5,
-
-	/** Monitoring Error */
-	I3C_ERROR_TE6,
-
-	/** Dead Bus Recovery */
-	I3C_ERROR_DBR,
-
-	/** Unknown error (not official error code) */
-	I3C_ERROR_TE_UNKNOWN,
-
-	/** No error (not official error code) */
-	I3C_ERROR_TE_NONE,
-
-	I3C_ERROR_TE_MAX = I3C_ERROR_TE_UNKNOWN,
-	I3C_ERROR_TE_INVALID,
-};
-
 /**
  * @brief I3C Transfer API
  * @defgroup i3c_transfer_api I3C Transfer API
@@ -486,6 +406,14 @@ struct i3c_msg {
 	 */
 	uint32_t		num_xfer;
 
+	/**
+	 * SDR Error Type
+	 *
+	 * Error from I3C Specification v1.1.1 section 5.1.10.2. It is expected
+	 * for the driver to write to this.
+	 */
+	enum i3c_sdr_controller_error_types err;
+
 	/** Flags for this message */
 	uint8_t			flags;
 

include/zephyr/drivers/i3c/ccc.h

@@ -259,6 +259,14 @@ struct i3c_ccc_target_payload {
 	 * write to this after the transfer.
 	 */
 	size_t num_xfer;
+
+	/**
+	 * SDR Error Type
+	 *
+	 * Error from I3C Specification v1.1.1 section 5.1.10.2. It is expected
+	 * for the driver to write to this.
+	 */
+	enum i3c_sdr_controller_error_types err;
 };
 
 /**
@@ -289,6 +297,14 @@ struct i3c_ccc_payload {
 		 * It is expected for the driver to write to this after the transfer.
 		 */
 		size_t num_xfer;
+
+		/**
+		 * SDR Error Type
+		 *
+		 * Error from I3C Specification v1.1.1 section 5.1.10.2. It is expected
+		 * for the driver to write to this.
+		 */
+		enum i3c_sdr_controller_error_types err;
 	} ccc;
 
 	struct {

include/zephyr/drivers/i3c/error_types.h

@@ -0,0 +1,99 @@
+/*
+ * Copyright 2024 Meta Platforms, Inc. and its affiliates
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_DRIVERS_I3C_ERROR_TYPES_H_
+#define ZEPHYR_INCLUDE_DRIVERS_I3C_ERROR_TYPES_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief I3C SDR Controller Error Types
+ *
+ * These are error types defined by the I3C specification.
+ *
+ * #I3C_ERROR_CE_UNKNOWN and #I3C_ERROR_CE_NONE are not
+ * official error types according to the specification.
+ * These are there simply to aid in error handling during
+ * interactions with the I3C drivers and subsystem.
+ */
+enum i3c_sdr_controller_error_types {
+	/** Transaction after sending CCC */
+	I3C_ERROR_CE0,
+
+	/** Monitoring Error */
+	I3C_ERROR_CE1,
+
+	/** No response to broadcast address (0x7E) */
+	I3C_ERROR_CE2,
+
+	/** Failed Controller Handoff */
+	I3C_ERROR_CE3,
+
+	/** Unknown error (not official error type) */
+	I3C_ERROR_CE_UNKNOWN,
+
+	/** No error (not official error type) */
+	I3C_ERROR_CE_NONE,
+
+	I3C_ERROR_CE_MAX = I3C_ERROR_CE_UNKNOWN,
+	I3C_ERROR_CE_INVALID,
+};
+
+/**
+ * @brief I3C SDR Target Error Types
+ *
+ * These are error types defined by the I3C specification.
+ *
+ * #I3C_ERROR_TE_UNKNOWN and #I3C_ERROR_TE_NONE are not
+ * official error types according to the specification.
+ * These are there simply to aid in error handling during
+ * interactions with the I3C drivers and subsystem.
+ */
+enum i3c_sdr_target_error_types {
+	/**
+	 * Invalid Broadcast Address or
+	 * Dynamic Address after DA assignment
+	 */
+	I3C_ERROR_TE0,
+
+	/** CCC type */
+	I3C_ERROR_TE1,
+
+	/** Write Data */
+	I3C_ERROR_TE2,
+
+	/** Assigned Address during Dynamic Address Arbitration */
+	I3C_ERROR_TE3,
+
+	/** 0x7E/R missing after RESTART during Dynamic Address Arbitration */
+	I3C_ERROR_TE4,
+
+	/** Transaction after detecting CCC */
+	I3C_ERROR_TE5,
+
+	/** Monitoring Error */
+	I3C_ERROR_TE6,
+
+	/** Dead Bus Recovery */
+	I3C_ERROR_DBR,
+
+	/** Unknown error (not official error type) */
+	I3C_ERROR_TE_UNKNOWN,
+
+	/** No error (not official error type) */
+	I3C_ERROR_TE_NONE,
+
+	I3C_ERROR_TE_MAX = I3C_ERROR_TE_UNKNOWN,
+	I3C_ERROR_TE_INVALID,
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* ZEPHYR_INCLUDE_DRIVERS_I3C_ERROR_TYPES_H_ */