Blame view

Documentation/serial/serial-rs485.txt 3.37 KB
63295cb2f   Claudio Scordino   serial: add Docum...
1
2
3
4
5
6
7
8
9
10
11
12
                          RS485 SERIAL COMMUNICATIONS
  
  1. INTRODUCTION
  
     EIA-485, also known as TIA/EIA-485 or RS-485, is a standard defining the
     electrical characteristics of drivers and receivers for use in balanced
     digital multipoint systems.
     This standard is widely used for communications in industrial automation
     because it can be used effectively over long distances and in electrically
     noisy environments.
  
  2. HARDWARE-RELATED CONSIDERATIONS
de6f86ce5   Yegor Yefremov   RS485 documentati...
13
14
15
16
17
     Some CPUs/UARTs (e.g., Atmel AT91 or 16C950 UART) contain a built-in
     half-duplex mode capable of automatically controlling line direction by
     toggling RTS or DTR signals. That can be used to control external
     half-duplex hardware like an RS485 transceiver or any RS232-connected
     half-duplex devices like some modems.
63295cb2f   Claudio Scordino   serial: add Docum...
18
19
20
21
22
23
24
25
26
27
28
  
     For these microcontrollers, the Linux driver should be made capable of
     working in both modes, and proper ioctls (see later) should be made
     available at user-level to allow switching from one mode to the other, and
     vice versa.
  
  3. DATA STRUCTURES ALREADY AVAILABLE IN THE KERNEL
  
     The Linux kernel provides the serial_rs485 structure (see [1]) to handle
     RS485 communications. This data structure is used to set and configure RS485
     parameters in the platform data and in ioctls.
0331bbf3c   Nicolas Ferre   tty/serial: RS485...
29
30
31
     The device tree can also provide RS485 boot time parameters (see [2]
     for bindings). The driver is in charge of filling this data structure from
     the values given by the device tree.
63295cb2f   Claudio Scordino   serial: add Docum...
32
     Any driver for devices capable of working both as RS232 and RS485 should
71206b9f8   Baruch Siach   Doc: serial-rs485...
33
34
35
36
     implement the rs485_config callback in the uart_port structure. The
     serial_core calls rs485_config to do the device specific part in response
     to TIOCSRS485 and TIOCGRS485 ioctls (see below). The rs485_config callback
     receives a pointer to struct serial_rs485.
63295cb2f   Claudio Scordino   serial: add Docum...
37
38
39
40
41
42
43
  
  4. USAGE FROM USER-LEVEL
  
     From user-level, RS485 configuration can be get/set using the previous
     ioctls. For instance, to set RS485 you can use the following code:
  
  	#include <linux/serial.h>
5021bb933   Ricardo Ribalda Delgado   Documentation: rs...
44
45
  	/* Include definition for RS485 ioctls: TIOCGRS485 and TIOCSRS485 */
  	#include <sys/ioctl.h>
63295cb2f   Claudio Scordino   serial: add Docum...
46
47
48
49
50
51
52
53
  
  	/* Open your specific device (e.g., /dev/mydevice): */
  	int fd = open ("/dev/mydevice", O_RDWR);
  	if (fd < 0) {
  		/* Error handling. See errno. */
  	}
  
  	struct serial_rs485 rs485conf;
93f3350c4   Claudio Scordino   RS485: fix incons...
54
  	/* Enable RS485 mode: */
63295cb2f   Claudio Scordino   serial: add Docum...
55
  	rs485conf.flags |= SER_RS485_ENABLED;
93f3350c4   Claudio Scordino   RS485: fix incons...
56
57
58
59
60
61
62
63
64
  	/* Set logical level for RTS pin equal to 1 when sending: */
  	rs485conf.flags |= SER_RS485_RTS_ON_SEND;
  	/* or, set logical level for RTS pin equal to 0 when sending: */
  	rs485conf.flags &= ~(SER_RS485_RTS_ON_SEND);
  
  	/* Set logical level for RTS pin equal to 1 after sending: */
  	rs485conf.flags |= SER_RS485_RTS_AFTER_SEND;
  	/* or, set logical level for RTS pin equal to 0 after sending: */
  	rs485conf.flags &= ~(SER_RS485_RTS_AFTER_SEND);
63295cb2f   Claudio Scordino   serial: add Docum...
65
  	/* Set rts delay before send, if needed: */
63295cb2f   Claudio Scordino   serial: add Docum...
66
67
68
  	rs485conf.delay_rts_before_send = ...;
  
  	/* Set rts delay after send, if needed: */
63295cb2f   Claudio Scordino   serial: add Docum...
69
  	rs485conf.delay_rts_after_send = ...;
83cac9f3b   Bernhard Roth   atmel_serial: RS4...
70
71
  	/* Set this flag if you want to receive data even whilst sending data */
  	rs485conf.flags |= SER_RS485_RX_DURING_TX;
63295cb2f   Claudio Scordino   serial: add Docum...
72
73
74
75
76
77
78
79
80
81
82
83
  	if (ioctl (fd, TIOCSRS485, &rs485conf) < 0) {
  		/* Error handling. See errno. */
  	}
  
  	/* Use read() and write() syscalls here... */
  
  	/* Close the device when finished: */
  	if (close (fd) < 0) {
  		/* Error handling. See errno. */
  	}
  
  5. REFERENCES
8307959d5   Yegor Yefremov   Documentation: se...
84
   [1]	include/uapi/linux/serial.h
0331bbf3c   Nicolas Ferre   tty/serial: RS485...
85
   [2]	Documentation/devicetree/bindings/serial/rs485.txt