ich777/linux_media
1
0
Fork 0
mirror of https://github.com/tbsdtv/linux_media.git synced 2025-07-23 20:51:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: Make formatting consistent for rs485 docs

Browse Source 
Tweak styling of names that come directly from the code.

Suggested-by: Bagas Sanjaya <bagasdotme@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-6-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:43 +03:00
committed by Greg Kroah-Hartman
parent 891e999394
commit 7b1c56e08a
1 changed files with 19 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
Documentation/driver-api/serial/serial-rs485.rst
View File

@@ -39,15 +39,15 @@ RS485 Serial Communications
uart_get_rs485_mode(). 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``
struct uart_port. The serial core calls rs485_config to do the device in the ``struct uart_port``. The serial core calls ``rs485_config`` to do
specific part in response to TIOCSRS485 ioctl (see below). The the device specific part in response to TIOCSRS485 ioctl (see below). The
rs485_config callback receives a pointer to a sanitizated struct ``rs485_config`` callback receives a pointer to a sanitizated struct
serial_rs485. The struct serial_rs485 userspace provides is sanitized serial_rs485. The struct serial_rs485 userspace provides is sanitized
before calling rs485_config using rs485_supported that indicates what before calling ``rs485_config`` using ``rs485_supported`` that indicates
RS485 features the driver supports for the struct uart_port. TIOCGRS485 what RS485 features the driver supports for the ``struct uart_port``.
ioctl can be used to read back the struct serial_rs485 matching to the TIOCGRS485 ioctl can be used to read back the struct serial_rs485
current configuration. matching to the current configuration.
.. kernel-doc:: include/uapi/linux/serial.h .. kernel-doc:: include/uapi/linux/serial.h
:identifiers: serial_rs485 uart_get_rs485_mode :identifiers: serial_rs485 uart_get_rs485_mode
@@ -108,23 +108,24 @@ RS485 Serial Communications
======================== ========================
The Linux kernel provides addressing mode for multipoint RS-485 serial The Linux kernel provides addressing mode for multipoint RS-485 serial
communications line. The addressing mode is enabled with SER_RS485_ADDRB communications line. The addressing mode is enabled with
flag in struct serial_rs485. The struct serial_rs485 has two additional ``SER_RS485_ADDRB`` flag in struct serial_rs485. The struct serial_rs485
flags and fields for enabling receive and destination addresses. has two additional flags and fields for enabling receive and destination
addresses.
Address mode flags: Address mode flags:
- SER_RS485_ADDRB: Enabled addressing mode (sets also ADDRB in termios). - ``SER_RS485_ADDRB``: Enabled addressing mode (sets also ADDRB in termios).
- SER_RS485_ADDR_RECV: Receive (filter) address enabled. - ``SER_RS485_ADDR_RECV``: Receive (filter) address enabled.
- SER_RS485_ADDR_DEST: Set destination address. - ``SER_RS485_ADDR_DEST``: Set destination address.
Address fields (enabled with corresponding SER_RS485_ADDR_* flag): Address fields (enabled with corresponding ``SER_RS485_ADDR_*`` flag):
- addr_recv: Receive address. - ``addr_recv``: Receive address.
- addr_dest: Destination address. - ``addr_dest``: Destination address.
Once a receive address is set, the communication can occur only with the Once a receive address is set, the communication can occur only with the
particular device and other peers are filtered out. It is left up to the particular device and other peers are filtered out. It is left up to the
receiver side to enforce the filtering. Receive address will be cleared receiver side to enforce the filtering. Receive address will be cleared
if SER_RS485_ADDR_RECV is not set. if ``SER_RS485_ADDR_RECV`` is not set.
Note: not all devices supporting RS485 support multipoint addressing. Note: not all devices supporting RS485 support multipoint addressing.