include/misc.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright (C) 2015 Thomas Chou <thomas@wytron.com.tw>
   4  */
   5
   6 #ifndef _MISC_H_
   7 #define _MISC_H_
   8
   9 /**
  10  * misc_read() - Read the device to buffer, optional.
  11  * @dev: the device
  12  * @offset: offset to read the device
  13  * @buf: pointer to data buffer
  14  * @size: data size in bytes to read the device
  15  *
  16  * Return: 0 if OK, -ve on error
  17  */
  18 int misc_read(struct udevice *dev, int offset, void *buf, int size);
  19
  20 /**
  21  * misc_write() - Write buffer to the device, optional.
  22  * @dev: the device
  23  * @offset: offset to write the device
  24  * @buf: pointer to data buffer
  25  * @size: data size in bytes to write the device
  26  *
  27  * Return: 0 if OK, -ve on error
  28  */
  29 int misc_write(struct udevice *dev, int offset, void *buf, int size);
  30
  31 /**
  32  * misc_ioctl() - Assert command to the device, optional.
  33  * @dev: the device
  34  * @request: command to be sent to the device
  35  * @buf: pointer to buffer related to the request
  36  *
  37  * Return: 0 if OK, -ve on error
  38  */
  39 int misc_ioctl(struct udevice *dev, unsigned long request, void *buf);
  40
  41 /**
  42  * misc_call() - Send a message to the device and wait for a response.
  43  * @dev: the device.
  44  * @msgid: the message ID/number to send.
  45  * @tx_msg: the request/transmit message payload.
  46  * @tx_size: the size of the buffer pointed at by tx_msg.
  47  * @rx_msg: the buffer to receive the response message payload. May be NULL if
  48  *          the caller only cares about the error code.
  49  * @rx_size: the size of the buffer pointed at by rx_msg.
  50  *
  51  * The caller provides the message type/ID and payload to be sent.
  52  * The callee constructs any message header required, transmits it to the
  53  * target, waits for a response, checks any error code in the response,
  54  * strips any message header from the response, and returns the error code
  55  * (or a parsed version of it) and the response message payload.
  56  *
  57  * Return: the response message size if OK, -ve on error
  58  */
  59 int misc_call(struct udevice *dev, int msgid, void *tx_msg, int tx_size,
  60               void *rx_msg, int rx_size);
  61
  62 /**
  63  * struct misc_ops - Driver model Misc operations
  64  *
  65  * The uclass interface is implemented by all miscellaneous devices which
  66  * use driver model.
  67  */
  68 struct misc_ops {
  69         /**
  70          * Read the device to buffer, optional.
  71          * @dev: the device
  72          * @offset: offset to read the device
  73          * @buf: pointer to data buffer
  74          * @size: data size in bytes to read the device
  75          *
  76          * Return: 0 if OK, -ve on error
  77          */
  78         int (*read)(struct udevice *dev, int offset, void *buf, int size);
  79
  80         /**
  81          * Write buffer to the device, optional.
  82          * @dev: the device
  83          * @offset: offset to write the device
  84          * @buf: pointer to data buffer
  85          * @size: data size in bytes to write the device
  86          *
  87          * Return: 0 if OK, -ve on error
  88          */
  89         int (*write)(struct udevice *dev, int offset, const void *buf,
  90                      int size);
  91         /**
  92          * Assert command to the device, optional.
  93          * @dev: the device
  94          * @request: command to be sent to the device
  95          * @buf: pointer to buffer related to the request
  96          *
  97          * Return: 0 if OK, -ve on error
  98          */
  99         int (*ioctl)(struct udevice *dev, unsigned long request, void *buf);
 100
 101         /**
 102          * Send a message to the device and wait for a response.
 103          * @dev: the device
 104          * @msgid: the message ID/number to send
 105          * @tx_msg: the request/transmit message payload
 106          * @tx_size: the size of the buffer pointed at by tx_msg
 107          * @rx_msg: the buffer to receive the response message payload. May be
 108          *          NULL if the caller only cares about the error code.
 109          * @rx_size: the size of the buffer pointed at by rx_msg
 110          *
 111          * Return: the response message size if OK, -ve on error
 112          */
 113         int (*call)(struct udevice *dev, int msgid, void *tx_msg, int tx_size,
 114                     void *rx_msg, int rx_size);
 115 };
 116
 117 #endif  /* _MISC_H_ */