Convert CONFIG_SYS_INTERLAKEN et al to Kconfig
[platform/kernel/u-boot.git] / include / misc.h
index ce2f05d..6f04262 100644 (file)
@@ -6,6 +6,8 @@
 #ifndef _MISC_H_
 #define _MISC_H_
 
+struct udevice;
+
 /**
  * misc_read() - Read the device to buffer, optional.
  * @dev: the device
@@ -13,7 +15,7 @@
  * @buf: pointer to data buffer
  * @size: data size in bytes to read the device
  *
- * Return: 0 if OK, -ve on error
+ * Return: number of bytes read if OK (may be 0 if EOF), -ve on error
  */
 int misc_read(struct udevice *dev, int offset, void *buf, int size);
 
@@ -24,9 +26,9 @@ int misc_read(struct udevice *dev, int offset, void *buf, int size);
  * @buf: pointer to data buffer
  * @size: data size in bytes to write the device
  *
- * Return: 0 if OK, -ve on error
+ * Return: number of bytes written if OK (may be < @size), -ve on error
  */
-int misc_write(struct udevice *dev, int offset, void *buf, int size);
+int misc_write(struct udevice *dev, int offset, const void *buf, int size);
 
 /**
  * misc_ioctl() - Assert command to the device, optional.
@@ -60,6 +62,23 @@ int misc_call(struct udevice *dev, int msgid, void *tx_msg, int tx_size,
              void *rx_msg, int rx_size);
 
 /**
+ * misc_set_enabled() - Enable or disable a device.
+ * @dev: the device to enable or disable.
+ * @val: the flag that tells the driver to either enable or disable the device.
+ *
+ * The semantics of "disable" and "enable" should be understood here as
+ * activating or deactivating the device's primary function, hence a "disabled"
+ * device should be dormant, but still answer to commands and queries.
+ *
+ * A probed device may start in a disabled or enabled state, depending on the
+ * driver and hardware.
+ *
+ * Return: -ve on error, 0 if the previous state was "disabled", 1 if the
+ *        previous state was "enabled"
+ */
+int misc_set_enabled(struct udevice *dev, bool val);
+
+/*
  * struct misc_ops - Driver model Misc operations
  *
  * The uclass interface is implemented by all miscellaneous devices which
@@ -73,7 +92,7 @@ struct misc_ops {
         * @buf: pointer to data buffer
         * @size: data size in bytes to read the device
         *
-        * Return: 0 if OK, -ve on error
+        * Return: number of bytes read if OK (may be 0 if EOF), -ve on error
         */
        int (*read)(struct udevice *dev, int offset, void *buf, int size);
 
@@ -84,7 +103,7 @@ struct misc_ops {
         * @buf: pointer to data buffer
         * @size: data size in bytes to write the device
         *
-        * Return: 0 if OK, -ve on error
+        * Return: number of bytes written if OK (may be < @size), -ve on error
         */
        int (*write)(struct udevice *dev, int offset, const void *buf,
                     int size);
@@ -112,6 +131,16 @@ struct misc_ops {
         */
        int (*call)(struct udevice *dev, int msgid, void *tx_msg, int tx_size,
                    void *rx_msg, int rx_size);
+       /**
+        * Enable or disable a device, optional.
+        * @dev: the device to enable.
+        * @val: the flag that tells the driver to either enable or disable the
+        *       device.
+        *
+        * Return: -ve on error, 0 if the previous state was "disabled", 1 if
+        *         the previous state was "enabled"
+        */
+       int (*set_enabled)(struct udevice *dev, bool val);
 };
 
 #endif /* _MISC_H_ */