leandrof/u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

misc: docs: Fix comments in misc.h

Browse Source 
The comments in misc.h are not in kernel-doc format. Correct the format.

Signed-off-by: Mario Six <mario.six@gdsys.cc>
This commit is contained in:
Mario Six 2018-07-31 14:24:12 +02:00 committed by Anatolij Gustschin
parent a032e0a6ae
commit 3958bffeb3
1 changed files with 44 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
include/misc.h
View File

@ -6,38 +6,47 @@
#ifndef _MISC_H_ #ifndef _MISC_H_
#define _MISC_H_ #define _MISC_H_
/* /**
* Read the device to buffer, optional. * misc_read() - Read the device to buffer, optional.
*
* @dev: the device * @dev: the device
* @offset: offset to read the device * @offset: offset to read the device
* @buf: pointer to data buffer * @buf: pointer to data buffer
* @size: data size in bytes to read the device * @size: data size in bytes to read the device
* @return: 0 if OK, -ve on error *
* Return: 0 if OK, -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 * @dev: the device
* @offset: offset to write the device * @offset: offset to write the device
* @buf: pointer to data buffer * @buf: pointer to data buffer
* @size: data size in bytes to write the device * @size: data size in bytes to write the device
* @return: 0 if OK, -ve on error *
* Return: 0 if OK, -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 * @dev: the device
* @request: command to be sent to the device * @request: command to be sent to the device
* @buf: pointer to buffer related to the request * @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 caller provides the message type/ID and payload to be sent.
* The callee constructs any message header required, transmits it to the * The callee constructs any message header required, transmits it to the
@ -45,66 +54,61 @@ int misc_ioctl(struct udevice *dev, unsigned long request, void *buf);
* strips any message header from the response, and returns the error code * strips any message header from the response, and returns the error code
* (or a parsed version of it) and the response message payload. * (or a parsed version of it) and the response message payload.
* *
* @dev: the device. * Return: the response message size if OK, -ve on error
* @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, int misc_call(struct udevice *dev, int msgid, void *tx_msg, int tx_size,
void *rx_msg, int rx_size); void *rx_msg, int rx_size);
/* /**
* struct misc_ops - Driver model Misc operations * struct misc_ops - Driver model Misc operations
* *
* The uclass interface is implemented by all miscellaneous devices which * The uclass interface is implemented by all miscellaneous devices which
* use driver model. * use driver model.
*/ */
struct misc_ops { struct misc_ops {
/* /**
* Read the device to buffer, optional. * Read the device to buffer, optional.
*
* @dev: the device * @dev: the device
* @offset: offset to read the device * @offset: offset to read the device
* @buf: pointer to data buffer * @buf: pointer to data buffer
* @size: data size in bytes to read the device * @size: data size in bytes to read the device
* @return: 0 if OK, -ve on error *
* Return: 0 if OK, -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 * @dev: the device
* @offset: offset to write the device * @offset: offset to write the device
* @buf: pointer to data buffer * @buf: pointer to data buffer
* @size: data size in bytes to write the device * @size: data size in bytes to write the device
* @return: 0 if OK, -ve on error *
* Return: 0 if OK, -ve on error
*/ */
int (*write)(struct udevice *dev, int offset, const void *buf, int (*write)(struct udevice *dev, int offset, const void *buf,
int size); int size);
/* /**
* Assert command to the device, optional. * Assert command to the device, optional.
*
* @dev: the device * @dev: the device
* @request: command to be sent to the device * @request: command to be sent to the device
* @buf: pointer to buffer related to the request * @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 * @dev: the device
* @msgid: the message ID/number to send * @msgid: the message ID/number to send
* tx_msg: the request/transmit message payload * @tx_msg: the request/transmit message payload
* tx_size: the size of the buffer pointed at by tx_msg * @tx_size: the size of the buffer pointed at by tx_msg
* rx_msg: the buffer to receive the response message payload. May be * @rx_msg: the buffer to receive the response message payload. May be
* NULL if the caller only cares about the error code. * NULL if the caller only cares about the error code.
* rx_size: the size of the buffer pointed at by rx_msg * @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 (*call)(struct udevice *dev, int msgid, void *tx_msg, int tx_size, int (*call)(struct udevice *dev, int msgid, void *tx_msg, int tx_size,
void *rx_msg, int rx_size); void *rx_msg, int rx_size);