arm: dts: stm32mp15: alignment with v5.11-rc2

[J-u-boot.git] / include / misc.h

diff --git a/include/misc.h b/include/misc.h
index 68f8e64d61abbabd3a7631db1246c53e50af916b..12d1325ee26e4f5ca65f51d2c2012a478e61496c 100644 (file)
--- a/include/misc.h
+++ b/include/misc.h
@@ -6,38 +6,47 @@
 #ifndef _MISC_H_
 #define _MISC_H_
 
 #ifndef _MISC_H_
 #define _MISC_H_
 

-/*
- * Read the device to buffer, optional.
- *
+/**
+ * misc_read() - Read the device to buffer, optional.

  * @dev: the device
  * @offset: offset to read the device
  * @buf: pointer to data buffer
  * @size: data size in bytes to read the device
  * @dev: the device
  * @offset: offset to read the device
  * @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);
  */
 int misc_read(struct udevice *dev, int offset, void *buf, int size);

-/*
- * Write buffer to the device, optional.
- *
+
+/**
+ * misc_write() - Write buffer to the device, optional.

  * @dev: the device
  * @offset: offset to write the device
  * @buf: pointer to data buffer
  * @size: data size in bytes to write the device
  * @dev: the device
  * @offset: offset to write the device
  * @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, void *buf, int size);

-/*
- * Assert command to the device, optional.
- *
+
+/**
+ * misc_ioctl() - Assert command to the device, optional.

  * @dev: the device
  * @request: command to be sent to the device
  * @buf: pointer to buffer related to the request
  * @dev: the device
  * @request: command to be sent to the device
  * @buf: pointer to buffer related to the request

- * @return: 0 if OK, -ve on error
+ *
+ * Return: 0 if OK, -ve on error

  */
 int misc_ioctl(struct udevice *dev, unsigned long request, void *buf);
 
  */
 int misc_ioctl(struct udevice *dev, unsigned long request, void *buf);
 

-/*
- * Send a message to the device and wait for a response.
+/**
+ * misc_call() - Send a message to the device and wait for a response.
+ * @dev: the device.
+ * @msgid: the message ID/number to send.
+ * @tx_msg: the request/transmit message payload.
+ * @tx_size: the size of the buffer pointed at by tx_msg.
+ * @rx_msg: the buffer to receive the response message payload. May be NULL if
+ *          the caller only cares about the error code.
+ * @rx_size: the size of the buffer pointed at by rx_msg.

  *
  * The caller provides the message type/ID and payload to be sent.
  * The callee constructs any message header required, transmits it to the
  *
  * The caller provides the message type/ID and payload to be sent.
  * The callee constructs any message header required, transmits it to the


@@ -45,18 +54,28 @@ int misc_ioctl(struct udevice *dev, unsigned long request, void *buf);
  * strips any message header from the response, and returns the error code
  * (or a parsed version of it) and the response message payload.
  *
  * strips any message header from the response, and returns the error code
  * (or a parsed version of it) and the response message payload.
  *

- * @dev: the device.
- * @msgid: the message ID/number to send.
- * tx_msg: the request/transmit message payload.
- * tx_size: the size of the buffer pointed at by tx_msg.
- * rx_msg: the buffer to receive the response message payload. May be NULL if
- *         the caller only cares about the error code.
- * rx_size: the size of the buffer pointed at by rx_msg.
- * @return the response message size if OK, -ve on error
+ * Return: the response message size if OK, -ve on error

  */
 int misc_call(struct udevice *dev, int msgid, void *tx_msg, int tx_size,
              void *rx_msg, int rx_size);
 
  */
 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
  *
 /*
  * struct misc_ops - Driver model Misc operations
  *


@@ -64,50 +83,62 @@ int misc_call(struct udevice *dev, int msgid, void *tx_msg, int tx_size,
  * use driver model.
  */
 struct misc_ops {
  * use driver model.
  */
 struct misc_ops {

-       /*
+       /**

         * Read the device to buffer, optional.
         * Read the device to buffer, optional.

-        *

         * @dev: the device
         * @offset: offset to read the device
         * @buf: pointer to data buffer
         * @size: data size in bytes to read the device
         * @dev: the device
         * @offset: offset to read the device
         * @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);
         */
        int (*read)(struct udevice *dev, int offset, void *buf, int size);

-       /*
+
+       /**

         * Write buffer to the device, optional.
         * Write buffer to the device, optional.

-        *

         * @dev: the device
         * @offset: offset to write the device
         * @buf: pointer to data buffer
         * @size: data size in bytes to write the device
         * @dev: the device
         * @offset: offset to write the device
         * @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);
         */
        int (*write)(struct udevice *dev, int offset, const void *buf,
                     int size);

-       /*
+       /**

         * Assert command to the device, optional.
         * Assert command to the device, optional.

-        *

         * @dev: the device
         * @request: command to be sent to the device
         * @buf: pointer to buffer related to the request
         * @dev: the device
         * @request: command to be sent to the device
         * @buf: pointer to buffer related to the request

-        * @return: 0 if OK, -ve on error
+        *
+        * Return: 0 if OK, -ve on error

         */
        int (*ioctl)(struct udevice *dev, unsigned long request, void *buf);
         */
        int (*ioctl)(struct udevice *dev, unsigned long request, void *buf);

-       /*
+
+       /**

         * Send a message to the device and wait for a response.
         * Send a message to the device and wait for a response.

-        *

         * @dev: the device
         * @msgid: the message ID/number to send
         * @dev: the device
         * @msgid: the message ID/number to send

-        * tx_msg: the request/transmit message payload
-        * tx_size: the size of the buffer pointed at by tx_msg
-        * rx_msg: the buffer to receive the response message payload. May be
-        *         NULL if the caller only cares about the error code.
-        * rx_size: the size of the buffer pointed at by rx_msg
-        * @return the response message size if OK, -ve on error
+        * @tx_msg: the request/transmit message payload
+        * @tx_size: the size of the buffer pointed at by tx_msg
+        * @rx_msg: the buffer to receive the response message payload. May be
+        *          NULL if the caller only cares about the error code.
+        * @rx_size: the size of the buffer pointed at by rx_msg
+        *
+        * Return: the response message size if OK, -ve on error

         */
        int (*call)(struct udevice *dev, int msgid, void *tx_msg, int tx_size,
                    void *rx_msg, int rx_size);
         */
        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_ */
 };
 
 #endif /* _MISC_H_ */