[U-Boot,5/5] dm: serial: Tidy up header file comments

Message ID 20181205195353.246542-6-sjg@chromium.org
State New
Delegated to: Simon Glass
Headers show
Series
  • dm: serial: Fix up some serial API errors
Related show

Commit Message

Simon Glass Dec. 5, 2018, 7:53 p.m.
The getconfig() comment is out of date. Fix this and add comments for
recently added functions.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 include/serial.h | 32 +++++++++++++++++++++++++++++---
 1 file changed, 29 insertions(+), 3 deletions(-)

Patch

diff --git a/include/serial.h b/include/serial.h
index 8a790ccaaf4..7acf781ebb8 100644
--- a/include/serial.h
+++ b/include/serial.h
@@ -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);
@@ -281,8 +279,36 @@  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
+ */
 int serial_getinfo(struct udevice *dev, struct serial_device_info *info);
 
 void atmel_serial_initialize(void);