dm: serial: Tidy up header file comments

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>

diff --git a/include/serial.h b/include/serial.h
index 8a790ccaaf4b36a624392c1878bf573c5728c832..c1368c68b6473bee38e19d766d08324185b3fa47 100644 (file)
--- 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);
@@ -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);