GitHub-Mirror/u-boot
2
0
Fork 0
mirror of https://github.com/Fishwaldo/u-boot.git synced 2025-03-17 12:41:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

dm: serial: Tidy up header file comments

Browse source 
The getconfig() comment is out of date. Fix this and add comments for
recently added functions.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
This commit is contained in:
Simon Glass 2018-12-28 14:23:11 -07:00
parent a61cbad78e
commit eab647d5e7
1 changed files with 31 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
include/serial.h
View file

@ -235,9 +235,7 @@ struct dm_serial_ops {
* Get a current config for this device.
*
* @dev: Device pointer
* @parity: parity to use
* @bits: bits number to use
* @stop: stop bits number to use
* @serial_config: Returns config information (see SERIAL_... above)
* @return 0 if OK, -ve on error
*/
int (*getconfig)(struct udevice *dev, uint *serial_config);
@ -257,6 +255,7 @@ struct dm_serial_ops {
*
* @dev: Device pointer
* @info: struct serial_device_info to fill
* @return 0 if OK, -ve on error
*/
int (*getinfo)(struct udevice *dev, struct serial_device_info *info);
};
@ -281,8 +280,37 @@ struct serial_dev_priv {
/* Access the serial operations for a device */
#define serial_get_ops(dev) ((struct dm_serial_ops *)(dev)->driver->ops)
/**
* serial_getconfig() - Get the uart configuration
* (parity, 5/6/7/8 bits word length, stop bits)
*
* Get a current config for this device.
*
* @dev: Device pointer
* @serial_config: Returns config information (see SERIAL_... above)
* @return 0 if OK, -ve on error
*/
int serial_getconfig(struct udevice *dev, uint *config);
/**
* serial_setconfig() - Set up the uart configuration
* (parity, 5/6/7/8 bits word length, stop bits)
*
* Set up a new config for this device.
*
* @dev: Device pointer
* @serial_config: number of bits, parity and number of stopbits to use
* @return 0 if OK, -ve on error
*/
int serial_setconfig(struct udevice *dev, uint config);
/**
* serial_getinfo() - Get serial device information
*
* @dev: Device pointer
* @info: struct serial_device_info to fill
* @return 0 if OK, -ve on error
*/
int serial_getinfo(struct udevice *dev, struct serial_device_info *info);
void atmel_serial_initialize(void);