From: randy.dunlap@oracle.com (Randy Dunlap)
To: linux-arm-kernel@lists.infradead.org
Subject: [PATCH] Documentation about RS485 serial communications
Date: Sun, 15 Aug 2010 15:02:57 -0700 [thread overview]
Message-ID: <4C686411.3060500@oracle.com> (raw)
In-Reply-To: <4C669120.8080707@evidence.eu.com>
On 08/14/10 05:50, Claudio Scordino wrote:
> Randy Dunlap ha scritto:
>> On Wed, 11 Aug 2010 11:26:23 +0200 Claudio Scordino wrote:
>>
>>> Hi all,
>>>
>>> some time ago I've been asked (by both Wolfram and Philippe) to
>>> provide some minimal documentation about the usage of the RS485
>>> interface.
>>>
>
> [...]
>
>>
>> Thanks for the addition.
>>
>
> Hi all,
>
> here is the document about RS485 with the requested additions.
>
> If OK, somebody please provide for merging.
I would expect GregKH to merge it.
Acked-by: Randy Dunlap <randy.dunlap@oracle.com>
Thanks.
> Best regards,
>
> Claudio
>
>
> Documentation about RS485 serial communications.
>
> Signed-off-by: Claudio Scordino <claudio@evidence.eu.com>
> ---
> Documentation/serial/00-INDEX | 2 +
> Documentation/serial/serial-rs485.txt | 126 +++++++++++++++++++++++++++++++++
> 2 files changed, 128 insertions(+), 0 deletions(-)
> create mode 100644 Documentation/serial/serial-rs485.txt
>
> diff --git a/Documentation/serial/00-INDEX b/Documentation/serial/00-INDEX
> index 07dcdb0..e09468a 100644
> --- a/Documentation/serial/00-INDEX
> +++ b/Documentation/serial/00-INDEX
> @@ -14,6 +14,8 @@ riscom8.txt
> - notes on using the RISCom/8 multi-port serial driver.
> rocket.txt
> - info on the Comtrol RocketPort multiport serial driver.
> +serial-rs485.txt
> + - info about RS485 structures and support in the kernel.
> specialix.txt
> - info on hardware/driver for specialix IO8+ multiport serial card.
> stallion.txt
> diff --git a/Documentation/serial/serial-rs485.txt b/Documentation/serial/serial-rs485.txt
> new file mode 100644
> index 0000000..93b029e
> --- /dev/null
> +++ b/Documentation/serial/serial-rs485.txt
> @@ -0,0 +1,126 @@
> + 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.
> + Even though the data is transmitted over a 2-wire twisted pair bus, all
> + EIA-485 transceivers interpret the voltage levels of the differential
> + signals with respect to a third common voltage. Without this common
> + reference, a set of transceivers may interpret the differential signals
> + incorrectly.
> + See [1] for more information.
> +
> +
> +2. HARDWARE-RELATED CONSIDERATIONS
> +
> + Some CPUs (e.g., Atmel AT91) contain a transceiver capable of working both
> + as RS232 and RS485. 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.
> +
> + On some other CPUs (e.g., Freescale imx25) the RS485 transceiver is not
> + integrated inside the microcontroller itself. Therefore, manufacturers who
> + use these microcontrollers to produce embedded boards need to connect an
> + external transceiver to some pin of the CPU.
> + On these architectures, therefore, no assumptions can be done at the
> + CPU-level about the presence of a RS485 transceiver, because the connection
> + (if any) is done outside the microcontroller. Moreover, even in case of
> + RS485 transceiver, the manufacturer is free to choose the CPU pin used for
> + the connection.
> +
> +
> +3. DATA STRUCTURES ALREADY AVAILABLE IN THE KERNEL
> +
> + The Linux kernel provides the serial_rs485 structure (see [2]) to handle
> + RS485 communications. This data structure is used to set and configure RS485
> + parameters in the platform data and in ioctls.
> +
> + Any driver for devices capable of working both as RS232 and RS485 should
> + provide at least the following ioctls:
> +
> + - TIOCSRS485 (typically associated with number 0x542F). This ioctl is used
> + to enable/disable RS485 mode from user-space
> +
> + - TIOCGRS485 (typically associated with number 0x542E). This ioctl is used
> + to get RS485 mode from kernel-space (i.e., driver) to user-space.
> +
> + In other words, the serial driver should contain a code similar to the next
> + one:
> +
> + static struct uart_ops atmel_pops = {
> + /* ... */
> + .ioctl = handle_ioctl,
> + };
> +
> + static int handle_ioctl(struct uart_port *port,
> + unsigned int cmd,
> + unsigned long arg)
> + {
> + struct serial_rs485 rs485conf;
> +
> + switch (cmd) {
> + case TIOCSRS485:
> + if (copy_from_user(&rs485conf,
> + (struct serial_rs485 *) arg,
> + sizeof(rs485conf)))
> + return -EFAULT;
> +
> + /* ... */
> + break;
> +
> + case TIOCGRS485:
> + if (copy_to_user((struct serial_rs485 *) arg,
> + ...,
> + sizeof(rs485conf)))
> + return -EFAULT;
> + /* ... */
> + break;
> +
> + /* ... */
> + }
> + }
> +
> +
> +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>
> +
> + /* Driver-specific ioctls: */
> + #define TIOCGRS485 0x542E
> + #define TIOCSRS485 0x542F
> +
> + /* Open your specific device (e.g., /dev/mydevice): */
> + int fd = open ("/dev/mydevice", O_RDWR);
> + struct serial_rs485 rs485conf;
> +
> + /* Set RS485 mode: */
> + rs485conf.flags |= SER_RS485_ENABLED;
> +
> + /* Set rts delay before send, if needed: */
> + rs485conf.flags |= SER_RS485_RTS_BEFORE_SEND;
> + rs485conf.delay_rts_before_send = ...;
> +
> + /* Set rts delay after send, if needed: */
> + rs485conf.flags |= SER_RS485_RTS_AFTER_SEND;
> + rs485conf.delay_rts_after_send = ...;
> +
> + ioctl (fd, TIOCSRS485, &rs485conf);
> +
> + /* Use read() and write() syscalls here... */
> +
> + /* Close the device when finished: */
> + close (fd);
> +
> +5. REFERENCES
> +
> + [1] http://en.wikipedia.org/wiki/Rs485
> + [2] include/linux/serial.h
--
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
next prev parent reply other threads:[~2010-08-15 22:02 UTC|newest]
Thread overview: 48+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-03-29 7:16 [PATCH] atmel_serial: Atmel RS485 support v2 Claudio Scordino
2010-03-29 19:44 ` Ryan Mallon
2010-03-30 9:07 ` Claudio Scordino
2010-03-30 19:37 ` Ryan Mallon
2010-04-08 7:58 ` Claudio Scordino
2010-04-08 9:01 ` Russell King - ARM Linux
2010-04-08 10:13 ` Alan Cox
2010-04-08 13:16 ` Claudio Scordino
2010-04-08 13:42 ` Alan Cox
2010-05-26 13:18 ` Nicolas Ferre
2010-05-27 8:37 ` Claudio Scordino
2010-05-27 9:57 ` Nicolas Ferre
2010-05-27 10:29 ` Wolfram Sang
2010-05-28 15:05 ` Claudio Scordino
2010-08-11 9:26 ` [PATCH] Documentation about RS485 serial communications Claudio Scordino
2010-08-11 10:02 ` Philippe De Muyter
2010-08-11 15:32 ` Randy Dunlap
2010-08-11 19:58 ` Claudio Scordino
2010-08-14 12:50 ` Claudio Scordino
2010-08-15 22:02 ` Randy Dunlap [this message]
2010-08-15 22:19 ` Russell King - ARM Linux
2010-10-19 12:28 ` Claudio Scordino
2010-10-19 14:29 ` Grant Edwards
2010-10-19 15:27 ` Alexander Stein
2010-10-19 17:22 ` Grant Edwards
2010-10-20 7:36 ` Nicolas Ferre
2010-10-20 8:00 ` Alexander Stein
2010-10-20 18:56 ` Alan Cox
2010-10-24 11:29 ` Claudio Scordino
2010-10-28 15:10 ` Chris Down
2010-10-28 15:31 ` Claudio Scordino
2010-10-28 16:30 ` Chris Down
2010-11-10 9:17 ` Nicolas Ferre
2010-11-10 17:28 ` Greg KH
2010-11-11 10:22 ` Claudio Scordino
2010-11-16 14:30 ` Pavel Machek
2010-11-16 15:23 ` Grant Edwards
2010-11-16 15:28 ` Alexander Stein
2010-11-16 16:13 ` Matt Schulte
2010-11-16 17:20 ` Alan Cox
[not found] ` <ibuh1v$uh6$1@dough.gmane.org>
2010-11-16 20:04 ` Alan Cox
2010-11-30 19:19 ` Pavel Machek
[not found] ` <ibubf5$ev$1@dough.gmane.org>
2010-11-16 18:41 ` Matt Schulte
2010-05-28 9:42 ` [PATCH] atmel_serial: Atmel RS485 support v2 Haavard Skinnemoen
2010-05-28 13:54 ` [PATCH] MAINTAINERS: some Atmel drivers change maintainer Nicolas Ferre
2010-05-28 13:31 ` Haavard Skinnemoen
2010-06-11 7:23 ` Nicolas Ferre
-- strict thread matches above, loose matches on Subject: below --
2010-08-11 20:23 [PATCH] Documentation about RS485 serial communications Randy Dunlap
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4C686411.3060500@oracle.com \
--to=randy.dunlap@oracle.com \
--cc=linux-arm-kernel@lists.infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).