linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Pali Rohár" <pali@kernel.org>
To: Michael Turquette <mturquette@baylibre.com>,
	Stephen Boyd <sboyd@kernel.org>, Rob Herring <robh+dt@kernel.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: "Andrew Lunn" <andrew@lunn.ch>,
	"Gregory Clement" <gregory.clement@bootlin.com>,
	"Sebastian Hesselbarth" <sebastian.hesselbarth@gmail.com>,
	"Vladimir Vid" <vladimir.vid@sartura.hr>,
	"Marek Behún" <kabel@kernel.org>,
	"Geert Uytterhoeven" <geert@linux-m68k.org>,
	linux-clk@vger.kernel.org, linux-serial@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org
Subject: [PATCH v2 11/11] serial: mvebu-uart: implement support for baudrates higher than 230400
Date: Fri, 25 Jun 2021 16:36:17 +0200	[thread overview]
Message-ID: <20210625143617.12826-12-pali@kernel.org> (raw)
In-Reply-To: <20210625143617.12826-1-pali@kernel.org>

This change implements simple usage of fractional divisor. When main
divisor D is too large to represent requested baudrate then use divisor M
from fractional divisor feature. All the M prescalers are set to same and
maximal value 63, so fractional part is not used at all.

Tests showed that UART at 1500000 baudrate via this configuration is stable
and usable. So there is no need to implement complicated calculation of
fractional coefficients yet.

To use this feature with higher baudrates, it is required to use UART clock
provided by UART clock driver. Default boot xtal clock is not capable of
higher baudrates and this change also contains code for determining upper
limit of possible baudrate.

Signed-off-by: Pali Rohár <pali@kernel.org>
---
 drivers/tty/serial/mvebu-uart.c | 79 ++++++++++++++++++++++++++-------
 1 file changed, 62 insertions(+), 17 deletions(-)

diff --git a/drivers/tty/serial/mvebu-uart.c b/drivers/tty/serial/mvebu-uart.c
index a31235add99f..0fe251b8627b 100644
--- a/drivers/tty/serial/mvebu-uart.c
+++ b/drivers/tty/serial/mvebu-uart.c
@@ -99,6 +99,7 @@
 #define UART_OSAMP		0x14
 #define  OSAMP_DEFAULT_DIVISOR	16
 #define  OSAMP_DIVISORS_MASK	0x3F3F3F3F
+#define  OSAMP_MAX_DIVISOR	63
 
 #define MVEBU_NR_UARTS		2
 
@@ -479,18 +480,59 @@ static int mvebu_uart_baud_rate_set(struct uart_port *port, unsigned int baud)
 		return -EOPNOTSUPP;
 
 	/*
-	 * The baudrate is derived from the UART clock thanks to two divisors:
-	 *   > D ("baud generator"): can divide the clock from 2 to 2^10 - 1.
-	 *   > M ("fractional divisor"): allows a better accuracy for
-	 *     baudrates higher than 230400.
+	 * The baudrate is derived from the UART clock thanks to divisors:
+	 *   > d1 * d2 ("TBG divisors"): can divide only TBG clock from 1 to 6
+	 *   > D ("baud generator"): can divide the clock from 1 to 1023
+	 *   > M ("fractional divisor"): allows a better accuracy (from 1 to 63)
 	 *
-	 * As the derivation of M is rather complicated, the code sticks to its
-	 * default value (x16) when all the prescalers are zeroed, and only
-	 * makes use of D to configure the desired baudrate.
+	 * Exact formulas for calculating baudrate:
+	 *
+	 * with default x16 scheme:
+	 *   baudrate = xtal / (d * 16)
+	 *   baudrate = tbg / (d1 * d2 * d * 16)
+	 *
+	 * with fractional divisor:
+	 *   baudrate = 10 * xtal / (d * (3 * (m1 + m2) + 2 * (m3 + m4)))
+	 *   baudrate = 10 * tbg / (d1*d2 * d * (3 * (m1 + m2) + 2 * (m3 + m4)))
+	 *
+	 * Oversampling value:
+	 *   osamp = (m1 << 0) | (m2 << 8) | (m3 << 16) | (m4 << 24);
+	 *
+	 * Where m1 controls number of clock cycles per bit for bits 1,2,3;
+	 * m2 for bits 4,5,6; m3 for bits 7,8 and m4 for bits 9,10.
+	 *
+	 * To simplify baudrate setup set all the M prescalers to same value.
+	 * For 9600 baudrate and higher it is enough to use just default (x16)
+	 * divisor or fractional divisor with M = 63, so there is no need to
+	 * use real fractional support (when the M prescalers are not equal).
+	 *
+	 * When all the M prescalers are zeroed then default (x16) divisor is
+	 * used. Default x16 scheme is more stable than M (fractional divisor),
+	 * so use M only when D divisor is not enough to derivate baudrate.
+	 *
+	 * Member port->uartclk is either xtal clock rate or TBG clock rate
+	 * divided by (d1 * d2). So UART clock driver already sets d1 and d2
+	 * divisors and UART driver cannot change them. Moreover they are
+	 * shared with both UARTs.
 	 */
+
 	m_divisor = OSAMP_DEFAULT_DIVISOR;
 	d_divisor = DIV_ROUND_CLOSEST(port->uartclk, baud * m_divisor);
 
+	if (d_divisor > BRDV_BAUD_MAX) {
+		/*
+		 * Experiments showed that small M divisors are unstable.
+		 * So use maximal possible M = 63 and calculate D divisor.
+		 */
+		m_divisor = OSAMP_MAX_DIVISOR;
+		d_divisor = DIV_ROUND_CLOSEST(port->uartclk, baud * m_divisor);
+	}
+
+	if (d_divisor < 1)
+		d_divisor = 1;
+	else if (d_divisor > BRDV_BAUD_MAX)
+		d_divisor = BRDV_BAUD_MAX;
+
 	spin_lock_irqsave(&mvebu_uart_lock, flags);
 	brdv = readl(port->membase + UART_BRDV);
 	brdv &= ~BRDV_BAUD_MASK;
@@ -500,6 +542,9 @@ static int mvebu_uart_baud_rate_set(struct uart_port *port, unsigned int baud)
 
 	osamp = readl(port->membase + UART_OSAMP);
 	osamp &= ~OSAMP_DIVISORS_MASK;
+	if (m_divisor != OSAMP_DEFAULT_DIVISOR)
+		osamp |= (m_divisor << 0) | (m_divisor << 8) |
+			(m_divisor << 16) | (m_divisor << 24);
 	writel(osamp, port->membase + UART_OSAMP);
 
 	return 0;
@@ -529,14 +574,14 @@ static void mvebu_uart_set_termios(struct uart_port *port,
 		port->ignore_status_mask |= STAT_RX_RDY(port) | STAT_BRK_ERR;
 
 	/*
-	 * Maximal divisor is 1023 * 16 when using default (x16) scheme.
-	 * Maximum achievable frequency with simple baudrate divisor is 230400.
-	 * Since the error per bit frame would be of more than 15%, achieving
-	 * higher frequencies would require to implement the fractional divisor
-	 * feature.
+	 * Maximal divisor is 1023 and maximal fractional divisor is 63. And
+	 * experiments showed that baudrates above 1/80 of base clock are not
+	 * stable and usable. So disallow baudrate above 1/80 of the base clock.
+	 * When port->uartclk is not available then mvebu_uart_baud_rate_set()
+	 * fails so values min_baud and max_baud in this case does not matter.
 	 */
-	min_baud = DIV_ROUND_UP(port->uartclk, 1023 * 16);
-	max_baud = 230400;
+	min_baud = DIV_ROUND_UP(port->uartclk, BRDV_BAUD_MAX*OSAMP_MAX_DIVISOR);
+	max_baud = port->uartclk / 80;
 
 	baud = uart_get_baud_rate(port, termios, old, min_baud, max_baud);
 	if (mvebu_uart_baud_rate_set(port, baud)) {
@@ -1397,14 +1442,14 @@ static int mvebu_uart_clock_probe(struct platform_device *pdev)
 			 * Calculate the smallest TBG d1 and d2 divisors that
 			 * still can provide 9600 baudrate.
 			 */
-			d1 = DIV_ROUND_UP(rate, 9600 * OSAMP_DEFAULT_DIVISOR *
+			d1 = DIV_ROUND_UP(rate, 9600 * OSAMP_MAX_DIVISOR *
 						BRDV_BAUD_MAX);
 			if (d1 < 1)
 				d1 = 1;
 			else if (d1 > CLK_TBG_DIV1_MAX)
 				d1 = CLK_TBG_DIV1_MAX;
 
-			d2 = DIV_ROUND_UP(rate, 9600 * OSAMP_DEFAULT_DIVISOR *
+			d2 = DIV_ROUND_UP(rate, 9600 * OSAMP_MAX_DIVISOR *
 						BRDV_BAUD_MAX * d1);
 			if (d2 < 1)
 				d2 = 1;
@@ -1419,7 +1464,7 @@ static int mvebu_uart_clock_probe(struct platform_device *pdev)
 		}
 
 		/* Skip clock source which cannot provide 9600 baudrate */
-		if (rate > 9600 * OSAMP_DEFAULT_DIVISOR * BRDV_BAUD_MAX * d1 * d2)
+		if (rate > 9600 * OSAMP_MAX_DIVISOR * BRDV_BAUD_MAX * d1 * d2)
 			continue;
 
 		/*
-- 
2.20.1


  parent reply	other threads:[~2021-06-25 14:37 UTC|newest]

Thread overview: 67+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-24 22:48 [PATCH 00/10] serial: mvebu-uart: Fixes and new support for higher baudrates Pali Rohár
2021-06-24 22:49 ` [PATCH 01/10] serial: mvebu-uart: fix calculation of clock divisor Pali Rohár
2021-06-24 22:49 ` [PATCH 02/10] serial: mvebu-uart: do not allow changing baudrate when uartclk is not available Pali Rohár
2021-06-24 22:49 ` [PATCH 03/10] serial: mvebu-uart: correctly calculate minimal possible baudrate Pali Rohár
2021-06-24 22:49 ` [PATCH 04/10] dt-bindings: mvebu-uart: fix documentation Pali Rohár
2021-06-24 22:49 ` [PATCH 05/10] arm64: dts: marvell: armada-37xx: Fix reg for standard variant of UART Pali Rohár
2021-06-24 22:49 ` [PATCH 06/10] serial: mvebu-uart: remove unused member nb from struct mvebu_uart Pali Rohár
2021-06-24 22:49 ` [PATCH 07/10] serial: mvebu-uart: implement UART clock driver for configuring UART base clock Pali Rohár
2021-06-24 22:49 ` [PATCH 08/10] dt-bindings: mvebu-uart: document DT bindings for marvell,armada-3700-uart-clock Pali Rohár
2021-06-24 22:49 ` [PATCH 09/10] arm64: dts: marvell: armada-37xx: add device node for UART clock and use it Pali Rohár
2021-06-24 22:49 ` [PATCH 10/10] serial: mvebu-uart: implement support for baudrates higher than 230400 Pali Rohár
2021-06-25 14:36 ` [PATCH v2 00/11] serial: mvebu-uart: Fixes and new support for higher baudrates Pali Rohár
2021-06-25 14:36   ` [PATCH v2 01/11] serial: mvebu-uart: fix calculation of clock divisor Pali Rohár
2021-06-25 14:36   ` [PATCH v2 02/11] serial: mvebu-uart: do not allow changing baudrate when uartclk is not available Pali Rohár
2021-06-25 14:36   ` [PATCH v2 03/11] serial: mvebu-uart: correctly calculate minimal possible baudrate Pali Rohár
2021-06-25 14:36   ` [PATCH v2 04/11] dt-bindings: mvebu-uart: fix documentation Pali Rohár
2021-06-25 14:36   ` [PATCH v2 05/11] arm64: dts: marvell: armada-37xx: Fix reg for standard variant of UART Pali Rohár
2021-06-25 14:36   ` [PATCH v2 06/11] serial: mvebu-uart: remove unused member nb from struct mvebu_uart Pali Rohár
2021-06-25 14:36   ` [PATCH v2 07/11] math64: New DIV_U64_ROUND_CLOSEST helper Pali Rohár
2021-06-25 15:22     ` Geert Uytterhoeven
2021-06-25 15:38       ` Pali Rohár
2021-06-25 15:50         ` Willy Tarreau
2021-06-25 17:39           ` Geert Uytterhoeven
2021-06-25 17:44             ` Pali Rohár
2021-06-25 18:11               ` Geert Uytterhoeven
2021-07-19 12:45         ` Andy Shevchenko
2021-06-25 14:36   ` [PATCH v2 08/11] serial: mvebu-uart: implement UART clock driver for configuring UART base clock Pali Rohár
2021-06-25 14:36   ` [PATCH v2 09/11] dt-bindings: mvebu-uart: document DT bindings for marvell,armada-3700-uart-clock Pali Rohár
2021-06-25 14:36   ` [PATCH v2 10/11] arm64: dts: marvell: armada-37xx: add device node for UART clock and use it Pali Rohár
2021-06-25 14:36   ` Pali Rohár [this message]
2021-07-17 12:38 ` [PATCH v3 0/5] serial: mvebu-uart: Support for higher baudrates Pali Rohár
2021-07-17 12:38   ` [PATCH v3 1/5] math64: New DIV_U64_ROUND_CLOSEST helper Pali Rohár
2021-07-19 12:47     ` Andy Shevchenko
2021-07-22 21:57       ` Pali Rohár
2021-07-24 11:38         ` David Laight
2021-07-17 12:38   ` [PATCH v3 2/5] serial: mvebu-uart: implement UART clock driver for configuring UART base clock Pali Rohár
2021-07-17 17:26     ` Andrew Lunn
2021-07-17 18:05       ` Pali Rohár
2021-07-24  9:48         ` Pali Rohár
2021-07-24 16:33           ` Andrew Lunn
2021-07-25 12:14             ` Pali Rohár
2021-07-17 12:38   ` [PATCH v3 3/5] dt-bindings: mvebu-uart: document DT bindings for marvell,armada-3700-uart-clock Pali Rohár
2021-07-17 17:30     ` [PATCH v3 3/5] dt-bindings: mvebu-uart: document DT bindings for marvell, armada-3700-uart-clock Andrew Lunn
2021-08-02 14:45       ` Pali Rohár
2021-07-17 12:38   ` [PATCH v3 4/5] arm64: dts: marvell: armada-37xx: add device node for UART clock and use it Pali Rohár
2021-07-17 12:38   ` [PATCH v3 5/5] serial: mvebu-uart: implement support for baudrates higher than 230400 Pali Rohár
2021-08-02 14:45 ` [PATCH v4 0/6] serial: mvebu-uart: Support for higher baudrates Pali Rohár
2021-08-02 14:45   ` [PATCH v4 1/6] math64: New DIV_U64_ROUND_CLOSEST helper Pali Rohár
2021-08-02 14:45   ` [PATCH v4 2/6] serial: mvebu-uart: implement UART clock driver for configuring UART base clock Pali Rohár
2021-08-02 14:45   ` [PATCH v4 3/6] dt-bindings: mvebu-uart: document DT bindings for marvell,armada-3700-uart-clock Pali Rohár
2021-08-06  0:30     ` Stephen Boyd
2021-08-06  8:28       ` Pali Rohár
2021-08-12 19:33         ` Stephen Boyd
2021-08-12 20:08           ` Pali Rohár
2021-08-02 14:45   ` [PATCH v4 4/6] dt-bindings: mvebu-uart: update information about UART clock Pali Rohár
2021-08-02 14:45   ` [PATCH v4 5/6] arm64: dts: marvell: armada-37xx: add device node for UART clock and use it Pali Rohár
2021-08-02 14:45   ` [PATCH v4 6/6] serial: mvebu-uart: implement support for baudrates higher than 230400 Pali Rohár
2021-08-09 14:53 ` [PATCH v5 0/6] serial: mvebu-uart: Support for higher baudrates Pali Rohár
2021-08-09 14:53   ` [PATCH v5 1/6] math64: New DIV_U64_ROUND_CLOSEST helper Pali Rohár
2021-08-09 14:53   ` [PATCH v5 2/6] serial: mvebu-uart: implement UART clock driver for configuring UART base clock Pali Rohár
2021-08-09 14:53   ` [PATCH v5 3/6] dt-bindings: mvebu-uart: document DT bindings for marvell,armada-3700-uart-clock Pali Rohár
2021-08-09 14:53   ` [PATCH v5 4/6] dt-bindings: mvebu-uart: update information about UART clock Pali Rohár
2021-08-09 14:53   ` [PATCH v5 5/6] arm64: dts: marvell: armada-37xx: add device node for UART clock and use it Pali Rohár
2021-08-09 14:53   ` [PATCH v5 6/6] serial: mvebu-uart: implement support for baudrates higher than 230400 Pali Rohár
2021-08-20 17:22   ` [PATCH v5 0/6] serial: mvebu-uart: Support for higher baudrates Pali Rohár
2021-08-31  8:35     ` Pali Rohár
2021-09-21  7:41       ` Greg Kroah-Hartman

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=20210625143617.12826-12-pali@kernel.org \
    --to=pali@kernel.org \
    --cc=andrew@lunn.ch \
    --cc=geert@linux-m68k.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=gregory.clement@bootlin.com \
    --cc=kabel@kernel.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-clk@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-serial@vger.kernel.org \
    --cc=mturquette@baylibre.com \
    --cc=robh+dt@kernel.org \
    --cc=sboyd@kernel.org \
    --cc=sebastian.hesselbarth@gmail.com \
    --cc=vladimir.vid@sartura.hr \
    /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).