Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37;
From:   Crescent CY Hsieh <crescentcy.hsieh@moxa.com>
To:     Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Jiri Slaby <jirislaby@kernel.org>
Cc:     linux-kernel@vger.kernel.org, linux-serial@vger.kernel.org,
        Crescent CY Hsieh <crescentcy.hsieh@moxa.com>
Subject: [PATCH v3 6/6] tty: serial: 8250: Add support for MOXA PCIe boards to switch interface between RS422/RS485
Date:   Wed, 18 Oct 2023 17:17:39 +0800
Message-Id: <20231018091739.10125-7-crescentcy.hsieh@moxa.com>
In-Reply-To: <20231018091739.10125-1-crescentcy.hsieh@moxa.com>
References: <20231018091739.10125-1-crescentcy.hsieh@moxa.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?my4ILQl1e05ai5DYvxV4mDx6fnnzyDF7jEZYaBH7mQ+LumZ/74xVYjfabKKu?=
 =?us-ascii?Q?s2NZqCDO7gyp/1hjwZzZ5A0Bt2JwYHVY7Z60/ttTTImbQzE57HCDfWirXOms?=
 =?us-ascii?Q?52EpbXPVSukzkw+Gi9MeaGl8EsImodVkPe9ijdL7G7Z/u7ml5uDz1vzM6Qha?=
 =?us-ascii?Q?syK64TtlwDDa8NMzTTchBW0s4jIVqJ+oZ/AooDDPOQnRipykbMUNPkEW2FrG?=
 =?us-ascii?Q?kLiTWd5RSaYHsrFu2JMPEiB1CmfhwaT0u/zOYrmKcH54S/5us1BXcfGF7WTC?=
 =?us-ascii?Q?d6GvMMax+tqH9xs7CzQocRvOiu+4bHll7lGlZCnD111SCBr6mJXKrlxl0MP/?=
 =?us-ascii?Q?bSn4R+GOWcgZS/I2tlFbWsYXmROZdyywuJ48xKpiAMPluZ7lpPUUhCgfMmXL?=
 =?us-ascii?Q?W+1/nJ3r4EKK/3BZx3fSLjF0MdNqgmT092L24wA1FHW7fl/tMD9/g/DY4BAu?=
 =?us-ascii?Q?lCz/g8nRq8kaReQM5Fsu2bh3jeXK/ctfrmDAEviCXu/mJaHNLqj/IkswvwNt?=
 =?us-ascii?Q?QqxZz87uM2pDUonsJO92khg8i2EHmxGYi+Q4TcqOsFToEW8SEcdgSRB5Ao++?=
 =?us-ascii?Q?Y3+NqlcrvKXbcU7fCJ4zKVE/HVrjzXuxvbQN1L5OJD9VzageJXOiPdm2XyE3?=
 =?us-ascii?Q?gEf8KGtMHyFgRfpIGeG27ntdw3SCUKcJqvZphdIMcIQ1yr+WpurBEs1X8bB1?=
 =?us-ascii?Q?A8Ll4g6M9yXVwnTxTLqXeZgY5kwyBqOGV1ZAl80YTwYdsbhuWBh5JWqYUGOc?=
 =?us-ascii?Q?J169iK8JDZLgEjfcV+Db9CXb7CCNsoZEtvG0RPki/LmR2fWaMLCWaz8Bv1++?=
 =?us-ascii?Q?GU2IRdBUNKvqyovtBPS01KnZY3qbcS6FEL6cBLM/7dUzGxtF7EWcaPGriSWa?=
 =?us-ascii?Q?RIRZgCi752Mw5A6YM2p2LAaXU2FXnkNfTQxYwsi9obiFQ19DBaU3nSX84Son?=
 =?us-ascii?Q?o3n9HMs1kl49XO3HLIzNO0ieQnFqewvVpPcpUWFM2JBUZ9v0meLH9Amc6Psl?=
 =?us-ascii?Q?NbBR52OUImEq1h7eFrgrdBDYcI9Mcwr7r8zx8xCGc9U+Q2HylbcGgQBIqt9O?=
 =?us-ascii?Q?zvdtoC9A37yjX2V+tF+Pt/0I9mbfA3t6Pe5CxhGMSyXtQNtifigKaBsLF5Ym?=
 =?us-ascii?Q?BY8ZxHdDjqOjFVPCSvHPSwx+U3eSpuv0yusFlOYSDzBmV7WyyTuc6Mu+obes?=
 =?us-ascii?Q?V7pmEUVbeUlWOQ59bX8BuuosRu+QsVv5DirSou4AuaryQfRx20WavfkSX3XM?=
 =?us-ascii?Q?gSAtz2vPf1AndTqiKkbfR9oLpAr0p9s1bn03GRkZGObZiZjtyk3/SfHxhvti?=
 =?us-ascii?Q?GxGHC53Zyz2bS97VEJaFfkBOATF+wjlfHy1ODF1cHaRi31Jw1XRb1j/ZpaDq?=
 =?us-ascii?Q?kiAXj4/z//iw8W9fq6LvnLTohLsQL07KQMFxol9vSVQfSlkKLQvm7+VbzxKt?=
 =?us-ascii?Q?WQO45NdkqnR5XC1eIjHPzmek7VzJfzq1HldZvoi0V4ml+5snv49sHGolMYHR?=
 =?us-ascii?Q?CLAgGPvsNwFSWLJIZy6uLiO/zBDDNBDyLXGZYs6UD+b914ScipYgglcSLJzQ?=
 =?us-ascii?Q?EcAr2rI9KN1KpvEoNqU3vtQScXG1jIRKmpu35pml8SlXhUJlbHXVc2q/9DfN?=
 =?us-ascii?Q?ZQ=3D=3D?=
X-OriginatorOrg: moxa.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 9f0ef1c2-2b5b-4110-6999-08dbcfbb86b5
X-MS-Exchange-CrossTenant-AuthSource: PUZPR01MB5405.apcprd01.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 18 Oct 2023 09:20:53.0269
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 5571c7d4-286b-47f6-9dd5-0aa688773c8e
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: /bfsLwv2cXdaLuQs/LAqPJuetff8G9L5+SECbZkUP1Oy839NnAE7oU+SaRgn+vW9St02bxVXYVuh/WFqOgDcOac0oDhH4tZCx2quooVsZ9I=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SEZPR01MB4134
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Wed, 18 Oct 2023 02:21:52 -0700 (PDT)

MOXA PCIe boards have 4 serial interfaces and don't require additional
stuff to switch between interfaces:

- RS232
- RS422
- RS485_2W (half-duplex)
- RS485_4W (full-duplex)

By using ioctl command "TIOCRS485", it can switch between default
interface and RS485 if supported.

That means, for RS422/RS485 board, it can switch between RS422 and
RS485 by setting the flags within struct serial_rs485.

However, for the RS232/RS422/RS485 board, it can only switch between
RS232 and RS485, there's no flag for switching interface into RS422.

This patch uses "SER_RS485_TERMINATE_BUS" to represent RS422 as a
workaround solution:

- RS232                   = (no flags are set)
- RS422                   = SER_RS485_ENABLED | SER_RS485_TERMINATE_BUS
- RS485_2W (half-duplex)  = SER_RS485_ENABLED
- RS485_4W (full-duplex)  = SER_RS485_ENABLED | SER_RS485_RX_DURING_TX

Signed-off-by: Crescent CY Hsieh <crescentcy.hsieh@moxa.com>
---
 drivers/tty/serial/8250/8250_pci.c | 58 ++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)

diff --git a/drivers/tty/serial/8250/8250_pci.c b/drivers/tty/serial/8250/8250_pci.c
index 29a28e72b..098ac466b 100644
--- a/drivers/tty/serial/8250/8250_pci.c
+++ b/drivers/tty/serial/8250/8250_pci.c
@@ -1974,6 +1974,10 @@ pci_sunix_setup(struct serial_private *priv,
 #define MOXA_RS485_2W	0x0F
 #define MOXA_UIR_OFFSET	0x04
 
+static const struct serial_rs485 pci_moxa_rs485_supported = {
+	.flags = SER_RS485_ENABLED | SER_RS485_RX_DURING_TX | SER_RS485_TERMINATE_BUS,
+};
+
 static bool pci_moxa_is_mini_pcie(unsigned short device)
 {
 	if (device == PCI_DEVICE_ID_MOXA_CP102N	||
@@ -2024,6 +2028,46 @@ static int pci_moxa_set_interface(const struct pci_dev *dev,
 	return 0;
 }
 
+/*
+ * MOXA PCIe boards support switching the serial interface using the ioctl
+ * command "TIOCSRS485", but there is currently no dedicated flag for switching
+ * to RS422. As a workaround, we utilize the "SER_RS485_TERMINATE_BUS" flag to
+ * represent RS422.
+ *
+ *	RS232			= (no flags are set)
+ *	RS422			= SER_RS485_ENABLED | SER_RS485_TERMINATE_BUS
+ *	RS485_2W (half-duplex)	= SER_RS485_ENABLED
+ *	RS485_4W (full-duplex)	= SER_RS485_ENABLED | SER_RS485_RX_DURING_TX
+ */
+static int pci_moxa_rs485_config(struct uart_port *port,
+				 struct ktermios *termios,
+				 struct serial_rs485 *rs485)
+{
+	struct pci_dev *dev = to_pci_dev(port->dev);
+	unsigned short device = dev->device;
+	u8 mode = MOXA_RS232;
+
+	if (rs485->flags & SER_RS485_ENABLED) {
+		if (rs485->flags & SER_RS485_TERMINATE_BUS) {
+			mode = MOXA_RS422;
+		} else {
+			if (rs485->flags & SER_RS485_RX_DURING_TX)
+				mode = MOXA_RS485_4W;
+			else
+				mode = MOXA_RS485_2W;
+		}
+	} else {
+		/*
+		 * RS232 is not supported for MOXA PCIe boards with device IDs
+		 * matching the pattern 0x*3**.
+		 */
+		if (pci_moxa_match_second_digit(device, 0x0300))
+			return -EOPNOTSUPP;
+	}
+
+	return pci_moxa_set_interface(dev, port->port_id, mode);
+}
+
 static int pci_moxa_init(struct pci_dev *dev)
 {
 	unsigned short device = dev->device;
@@ -2063,9 +2107,23 @@ pci_moxa_setup(struct serial_private *priv,
 		const struct pciserial_board *board,
 		struct uart_8250_port *port, int idx)
 {
+	struct pci_dev *dev = priv->dev;
+	unsigned short device = dev->device;
 	unsigned int bar = FL_GET_BASE(board->flags);
 	int offset;
 
+	/*
+	 * For the device IDs of MOXA PCIe boards match the pattern 0x*1** and 0x*3**,
+	 * these boards support switching interface between RS422/RS485 using TIOCSRS485.
+	 */
+	if (pci_moxa_match_second_digit(device, 0x0100) ||
+	    pci_moxa_match_second_digit(device, 0x0300)) {
+		port->port.rs485_config = pci_moxa_rs485_config;
+		port->port.rs485_supported = pci_moxa_rs485_supported;
+
+		if (pci_moxa_match_second_digit(device, 0x0300))
+			port->port.rs485.flags |= SER_RS485_ENABLED | SER_RS485_TERMINATE_BUS;
+	}
 	if (board->num_ports == 4 && idx == 3)
 		offset = 7 * board->uart_offset;
 	else
-- 
2.34.1