reset: Extend reset control with an optional data field
[oweals/u-boot.git] / include / reset.h
index 34ebb096dd2f96c572d70220a15d5b80b6a5db40..bc495a90c2e99d9c565c3aa4dc0e5e730ecb514b 100644 (file)
@@ -40,10 +40,12 @@ struct udevice;
  *
  * @dev: The device which implements the reset signal.
  * @id: The reset signal ID within the provider.
+ * @data: An optional data field for scenarios where a single integer ID is not
+ *       sufficient. If used, it can be populated through an .of_xlate op and
+ *       processed during the various reset ops.
  *
- * Currently, the reset API assumes that a single integer ID is enough to
- * identify and configure any reset signal for any reset provider. If this
- * assumption becomes invalid in the future, the struct could be expanded to
+ * Should additional information to identify and configure any reset signal
+ * for any provider be required in the future, the struct could be expanded to
  * either (a) add more fields to allow reset providers to store additional
  * information, or (b) replace the id field with an opaque pointer, which the
  * provider would dynamically allocated during its .of_xlate op, and process
@@ -53,10 +55,10 @@ struct udevice;
 struct reset_ctl {
        struct udevice *dev;
        /*
-        * Written by of_xlate. We assume a single id is enough for now. In the
-        * future, we might add more fields here.
+        * Written by of_xlate. In the future, we might add more fields here.
         */
        unsigned long id;
+       unsigned long data;
 };
 
 /**