Documentation: rs485: Mention uart_get_rs485_mode()

Add to rs485 documentation that serial core prepares the struct
serial_rs485 when uart_get_rs485_mode() is called. Remove the wrong
claim that the driver must fill it by itself.

Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Link: https://lore.kernel.org/r/20221019093343.9546-4-ilpo.jarvinen@linux.intel.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Ilpo Järvinen 2022-10-19 12:33:41 +03:00 committed by Greg Kroah-Hartman
parent 851453abc8
commit 0f4648a1a6

View File

@ -34,8 +34,9 @@ RS485 Serial Communications
parameters in the platform data and in ioctls. parameters in the platform data and in ioctls.
The device tree can also provide RS485 boot time parameters The device tree can also provide RS485 boot time parameters
[#DT-bindings]_. The driver is in charge of filling this data structure [#DT-bindings]_. The serial core fills the struct serial_rs485 from the
from the values given by the device tree. values given by the device tree when the driver calls
uart_get_rs485_mode().
Any driver for devices capable of working both as RS232 and RS485 should Any driver for devices capable of working both as RS232 and RS485 should
implement the rs485_config callback and provide rs485_supported in the implement the rs485_config callback and provide rs485_supported in the
@ -48,7 +49,7 @@ RS485 Serial Communications
serial_rs485 structure matching to the current configuration. serial_rs485 structure matching to the current configuration.
.. kernel-doc:: include/uapi/linux/serial.h .. kernel-doc:: include/uapi/linux/serial.h
:identifiers: serial_rs485 :identifiers: serial_rs485 uart_get_rs485_mode
4. Usage from user-level 4. Usage from user-level
======================== ========================