lkml.org 
[lkml]   [2022]   [Sep]   [28]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v3 1/4] serial: Convert serial_rs485 to kernel doc
On Wed, Sep 28, 2022 at 02:05:06PM +0300, Ilpo Järvinen wrote:
> diff --git a/include/uapi/linux/serial.h b/include/uapi/linux/serial.h
> index cea06924b295..6e347eb10b1f 100644
> --- a/include/uapi/linux/serial.h
> +++ b/include/uapi/linux/serial.h
> @@ -107,37 +107,57 @@ 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).
> + *

I don't see definition of fields after @delay_rts_after_send in the
htmldocs output.

> * 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.

The last two items are rendered as bold text instead (maybe due to missing
fields rendering above?)

Thanks.

--
An old man doll... just what I always wanted! - Clara
[unhandled content-type:application/pgp-signature]
\
 
 \ /
  Last update: 2022-09-29 05:30    [W:0.064 / U:1.272 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site