| Message ID | 20220928110509.13544-4-ilpo.jarvinen@linux.intel.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | serial: RS485 kerneldoc/documentation improvements | expand |
On Wed, 28 Sep 2022, Andy Shevchenko wrote: > On Wed, Sep 28, 2022 at 2:05 PM Ilpo Järvinen > <ilpo.jarvinen@linux.intel.com> wrote: > > > The device tree can also provide RS485 boot time parameters > > - [#DT-bindings]_. The driver is in charge of filling this data structure > > - from the values given by the device tree. > > + [#DT-bindings]_. The serial core fills the struct serial_rs485 from the > > + values given by the device tree when driver calls uart_get_rs485_mode(). > > the driver > > Feels like this should be before the previous patch and actually have > a Fixes tag. I don't feel it would be an appropriate tag for this kind of cases where documentation is simply lacking behind what the core code now offers.
diff --git a/Documentation/driver-api/serial/serial-rs485.rst b/Documentation/driver-api/serial/serial-rs485.rst index 513758a702a6..2951dacfb9eb 100644 --- a/Documentation/driver-api/serial/serial-rs485.rst +++ b/Documentation/driver-api/serial/serial-rs485.rst @@ -34,8 +34,8 @@ RS485 Serial Communications parameters in the platform data and in ioctls. The device tree can also provide RS485 boot time parameters - [#DT-bindings]_. The driver is in charge of filling this data structure - from the values given by the device tree. + [#DT-bindings]_. The serial core fills the struct serial_rs485 from the + values given by the device tree when driver calls uart_get_rs485_mode(). Any driver for devices capable of working both as RS232 and RS485 should implement the rs485_config callback and provide rs485_supported in the @@ -48,7 +48,7 @@ RS485 Serial Communications serial_rs485 structure matching to the current configuration. .. kernel-doc:: include/uapi/linux/serial.h - :identifiers: serial_rs485 + :identifiers: serial_rs485 uart_get_rs485_mode 4. Usage from user-level ========================
Add to rs485 documentation that serial core prepares the struct serial_rs485 when uart_get_rs485_mode() is called. Remove the wrong claim that driver must fill it by itself. Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com> --- Documentation/driver-api/serial/serial-rs485.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)