diff mbox series

[U-Boot] dm: serial: fix comment on dm_serial_ops setconfig

Message ID 20181102200816.30575-1-simon.k.r.goldschmidt@gmail.com
State Accepted
Commit 0a16868757f40a4b5578c0cf65d3bfc8d3fd7dc0
Delegated to: Tom Rini
Headers show
Series [U-Boot] dm: serial: fix comment on dm_serial_ops setconfig | expand

Commit Message

Simon Goldschmidt Nov. 2, 2018, 8:08 p.m. UTC
The comment on this function prototype describes nonexistent
parameters. It seems to be copied from 'setparity'.

Update it to match its the parameter list.

Signed-off-by: Simon Goldschmidt <simon.k.r.goldschmidt@gmail.com>
---

 include/serial.h | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

Comments

Simon Glass Nov. 3, 2018, 6:08 a.m. UTC | #1
On 2 November 2018 at 14:08, Simon Goldschmidt
<simon.k.r.goldschmidt@gmail.com> wrote:
> The comment on this function prototype describes nonexistent
> parameters. It seems to be copied from 'setparity'.
>
> Update it to match its the parameter list.
>
> Signed-off-by: Simon Goldschmidt <simon.k.r.goldschmidt@gmail.com>
> ---
>
>  include/serial.h | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)

Reviewed-by: Simon Glass <sjg@chromium.org>
Tom Rini Nov. 17, 2018, 2:07 p.m. UTC | #2
On Fri, Nov 02, 2018 at 09:08:16PM +0100, Simon Goldschmidt wrote:

> The comment on this function prototype describes nonexistent
> parameters. It seems to be copied from 'setparity'.
> 
> Update it to match its the parameter list.
> 
> Signed-off-by: Simon Goldschmidt <simon.k.r.goldschmidt@gmail.com>
> Reviewed-by: Simon Glass <sjg@chromium.org>

Applied to u-boot/master, thanks!
diff mbox series

Patch

diff --git a/include/serial.h b/include/serial.h
index 020cd392e8..ec25db6e60 100644
--- a/include/serial.h
+++ b/include/serial.h
@@ -195,9 +195,7 @@  struct dm_serial_ops {
 	 * Set up a new config for this device.
 	 *
 	 * @dev: Device pointer
-	 * @parity: parity to use
-	 * @bits: bits number to use
-	 * @stop: stop bits number to use
+	 * @serial_config: number of bits, parity and number of stopbits to use
 	 * @return 0 if OK, -ve on error
 	 */
 	int (*setconfig)(struct udevice *dev, uint serial_config);