Merge branch 'master' of git://git.denx.de/u-boot-sunxi

[u-boot] / include / misc.h

diff --git a/include/misc.h b/include/misc.h
index 7e9badfabd0119f34980d4b800cb86b29ecaa8a3..68f8e64d61abbabd3a7631db1246c53e50af916b 100644 (file)
--- a/include/misc.h
+++ b/include/misc.h
@@ -1,7 +1,6 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * Copyright (C) 2015 Thomas Chou <thomas@wytron.com.tw>
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #ifndef _MISC_H_
@@ -32,11 +31,32 @@ int misc_write(struct udevice *dev, int offset, void *buf, int size);
  *
  * @dev: the device
  * @request: command to be sent to the device
- * @buf: pointer to buffer related to the requset
+ * @buf: pointer to buffer related to the request
  * @return: 0 if OK, -ve on error
  */
 int misc_ioctl(struct udevice *dev, unsigned long request, void *buf);
 
+/*
+ * Send a message to the device and wait for a response.
+ *
+ * The caller provides the message type/ID and payload to be sent.
+ * The callee constructs any message header required, transmits it to the
+ * target, waits for a response, checks any error code in the response,
+ * 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
+ */
+int misc_call(struct udevice *dev, int msgid, void *tx_msg, int tx_size,
+             void *rx_msg, int rx_size);
+
 /*
  * struct misc_ops - Driver model Misc operations
  *
@@ -70,10 +90,24 @@ struct misc_ops {
         *
         * @dev: the device
         * @request: command to be sent to the device
-        * @buf: pointer to buffer related to the requset
+        * @buf: pointer to buffer related to the request
         * @return: 0 if OK, -ve on error
         */
        int (*ioctl)(struct udevice *dev, unsigned long request, void *buf);
+       /*
+        * 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
+        * @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);
 };
 
 #endif /* _MISC_H_ */