serial: Convert serial_rs485 to kernel doc
PATCH 1/1 serial: Convert serial_rs485 to kernel doc
Convert struct serial_rs485 comments to kernel doc format.
Suggested-by Andy Shevchenko <[email protected]>
Signed-off-by Ilpo Järvinen <[email protected]>
--- include/uapi/linux/serial.h | 61 +++++++++++++++++++++++++++++---------------- 1 file changed, 40 insertions(+), 21 deletions(-)
include/uapi/linux/serial.h +40 -21
@@ -107,37 +107,56 @@ struct serial_icounter_struct {int reserved[9 ]; }; -/* +/** +* struct serial_rs485 - serial interface for controlling RS485 settings. +* @flags: RS485 feature flags. +* @delay_rts_before_send: Delay before send (milliseconds). +* @delay_rts_after_send: Delay after send (milliseconds). +* @addr_recv: Receive filter for RS485 addressing mode +* (used only when %SER_RS485_ADDR_RECV is set). +* @addr_dest: Destination address for RS485 addressing mode +* (used only when %SER_RS485_ADDR_DEST is set). +* @padding0: Padding (set to zero). +* @padding1: Padding (set to zero). +* @padding: Deprecated, use @padding0 and @padding1 instead. +* Do not use with @addr_recv and @addr_dest (due to +* overlap). +* * Serial interface for controlling RS485 settings on chips with suitable * support. Set with TIOCSRS485 and get with TIOCGRS485 if supported by your * platform. The set function returns the new state, with any unsupported bits * reverted appropriately. +* +* serial_rs485::flags bits are: +* * %SER_RS485_ENABLED - RS485 enabled. +* * %SER_RS485_RTS_ON_SEND - Logical level for RTS pin when sending. +* * %SER_RS485_RTS_AFTER_SEND - Logical level for RTS pin after sent. +* * %SER_RS485_RX_DURING_TX - Full-duplex RS485 line. +* * %SER_RS485_TERMINATE_BUS - Enable bus termination (if supported). +* * %SER_RS485_ADDRB - Enable RS485 addressing mode. +* * %SER_RS485_ADDR_RECV - Receive address filter (enables @addr_recv). +* Requires %SER_RS485_ADDRB. +* * %SER_RS485_ADDR_DEST - Destination address (enables @addr_dest). +* Requires %SER_RS485_ADDRB. */ - struct serial_rs485 { - __u32 flags; /* RS485 feature flags */ -#define SER_RS485_ENABLED (1 << 0) /* If enabled */ -#define SER_RS485_RTS_ON_SEND (1 << 1) /* Logical level for - RTS pin when - sending */ -#define SER_RS485_RTS_AFTER_SEND (1 << 2) /* Logical level for - RTS pin after sent*/ + __u32 flags; +#define SER_RS485_ENABLED (1 << 0) +#define SER_RS485_RTS_ON_SEND (1 << 1) +#define SER_RS485_RTS_AFTER_SEND (1 << 2) #define SER_RS485_RX_DURING_TX (1 << 4) -#define SER_RS485_TERMINATE_BUS (1 << 5) /* Enable bus - termination - (if supported) */ - -/* RS-485 addressing mode */ -#define SER_RS485_ADDRB (1 << 6) /* Enable addressing mode */ -#define SER_RS485_ADDR_RECV (1 << 7) /* Receive address filter */ -#define SER_RS485_ADDR_DEST (1 << 8) /* Destination address */ +#define SER_RS485_TERMINATE_BUS (1 << 5) +#define SER_RS485_ADDRB (1 << 6) +#define SER_RS485_ADDR_RECV (1 << 7) +#define SER_RS485_ADDR_DEST (1 << 8) - __u32 delay_rts_before_send; /* Delay before send (milliseconds) */ - __u32 delay_rts_after_send; /* Delay after send (milliseconds) */ + __u32 delay_rts_before_send; + __u32 delay_rts_after_send; - /* The fields below are defined by flags */ + /* private: The fields below are defined by flags */ union { - __u32 padding[5]; /* Memory is cheap, new structs are a pain */ + /* private: Memory is cheap, new structs are a pain. */ + __u32 padding[5]; struct { __u8 addr_recv;
Signature · 1 line
tg: (2eb6f6da8b51..) rs485/kdoc (depends on: supported-fix/intro-kernel_serial_rs485_to_user_rs485)
Jiri Slaby
maintainerQuoted 1 line · Ilpo Järvinen
Convert struct
serial_rs485comments to kernel doc format.
It'd be nice if you referenced the struct from Documentation/, so that it is: 1) checked, and 2) rendered somewhere.
Quoted 12 lines
Suggested-by Andy Shevchenko <[email protected]>Signed-off-by Ilpo Järvinen <[email protected]>--- include/uapi/linux/serial.h | 61 +++++++++++++++++++++++++++++---------------- 1 file changed, 40 insertions(+), 21 deletions(-)include/uapi/linux/serial.h +0
-0
include/uapi/linux/serial.h struct serial_icounter_struct { · line 111
Quoted 6 lines
include/uapi/linux/serial.h +2
-1@@ -107,37 +107,56 @@ struct serial_icounter_struct {int reserved[9 ]; }; -/* +/** +* struct serial_rs485 - serial interface for controlling RS485 settings.
...
thanks,
Signature · 2 lines
js suse labs