blob: 70a0e5e9197d8b5f560a87dbfcda1a13dbce5cb9 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Sascha Hauer9b56f4f2008-03-26 20:40:42 +01002/*
3 * (c) 2007 Sascha Hauer <s.hauer@pengutronix.de>
Sascha Hauer9b56f4f2008-03-26 20:40:42 +01004 */
5
6#include <common.h>
Simon Glassa8ba5692014-10-01 19:57:27 -06007#include <dm.h>
8#include <errno.h>
Stefano Babic4ec3d2a2010-08-18 10:22:42 +02009#include <watchdog.h>
Ilya Yanok47d19da2009-06-08 04:12:46 +040010#include <asm/arch/imx-regs.h>
11#include <asm/arch/clock.h>
Simon Glass401d1c42020-10-30 21:38:53 -060012#include <asm/global_data.h>
Masahiro Yamada86256b72014-10-24 12:41:19 +090013#include <dm/platform_data/serial_mxc.h>
Marek Vasuta9434722012-09-14 22:37:43 +020014#include <serial.h>
15#include <linux/compiler.h>
Sascha Hauer9b56f4f2008-03-26 20:40:42 +010016
Sascha Hauer9b56f4f2008-03-26 20:40:42 +010017/* UART Control Register Bit Fields.*/
Jagan Teki52c14ca2017-06-06 05:31:50 +000018#define URXD_CHARRDY (1<<15)
19#define URXD_ERR (1<<14)
20#define URXD_OVRRUN (1<<13)
21#define URXD_FRMERR (1<<12)
22#define URXD_BRK (1<<11)
23#define URXD_PRERR (1<<10)
24#define URXD_RX_DATA (0xFF)
25#define UCR1_ADEN (1<<15) /* Auto dectect interrupt */
26#define UCR1_ADBR (1<<14) /* Auto detect baud rate */
27#define UCR1_TRDYEN (1<<13) /* Transmitter ready interrupt enable */
28#define UCR1_IDEN (1<<12) /* Idle condition interrupt */
29#define UCR1_RRDYEN (1<<9) /* Recv ready interrupt enable */
30#define UCR1_RDMAEN (1<<8) /* Recv ready DMA enable */
31#define UCR1_IREN (1<<7) /* Infrared interface enable */
32#define UCR1_TXMPTYEN (1<<6) /* Transimitter empty interrupt enable */
33#define UCR1_RTSDEN (1<<5) /* RTS delta interrupt enable */
34#define UCR1_SNDBRK (1<<4) /* Send break */
35#define UCR1_TDMAEN (1<<3) /* Transmitter ready DMA enable */
36#define UCR1_UARTCLKEN (1<<2) /* UART clock enabled */
37#define UCR1_DOZE (1<<1) /* Doze */
38#define UCR1_UARTEN (1<<0) /* UART enabled */
39#define UCR2_ESCI (1<<15) /* Escape seq interrupt enable */
40#define UCR2_IRTS (1<<14) /* Ignore RTS pin */
41#define UCR2_CTSC (1<<13) /* CTS pin control */
42#define UCR2_CTS (1<<12) /* Clear to send */
43#define UCR2_ESCEN (1<<11) /* Escape enable */
44#define UCR2_PREN (1<<8) /* Parity enable */
45#define UCR2_PROE (1<<7) /* Parity odd/even */
46#define UCR2_STPB (1<<6) /* Stop */
47#define UCR2_WS (1<<5) /* Word size */
48#define UCR2_RTSEN (1<<4) /* Request to send interrupt enable */
49#define UCR2_TXEN (1<<2) /* Transmitter enabled */
50#define UCR2_RXEN (1<<1) /* Receiver enabled */
51#define UCR2_SRST (1<<0) /* SW reset */
52#define UCR3_DTREN (1<<13) /* DTR interrupt enable */
53#define UCR3_PARERREN (1<<12) /* Parity enable */
54#define UCR3_FRAERREN (1<<11) /* Frame error interrupt enable */
55#define UCR3_DSR (1<<10) /* Data set ready */
56#define UCR3_DCD (1<<9) /* Data carrier detect */
57#define UCR3_RI (1<<8) /* Ring indicator */
58#define UCR3_ADNIMP (1<<7) /* Autobaud Detection Not Improved */
59#define UCR3_RXDSEN (1<<6) /* Receive status interrupt enable */
60#define UCR3_AIRINTEN (1<<5) /* Async IR wake interrupt enable */
61#define UCR3_AWAKEN (1<<4) /* Async wake interrupt enable */
62#define UCR3_REF25 (1<<3) /* Ref freq 25 MHz */
63#define UCR3_REF30 (1<<2) /* Ref Freq 30 MHz */
64#define UCR3_INVT (1<<1) /* Inverted Infrared transmission */
65#define UCR3_BPEN (1<<0) /* Preset registers enable */
66#define UCR4_CTSTL_32 (32<<10) /* CTS trigger level (32 chars) */
67#define UCR4_INVR (1<<9) /* Inverted infrared reception */
68#define UCR4_ENIRI (1<<8) /* Serial infrared interrupt enable */
69#define UCR4_WKEN (1<<7) /* Wake interrupt enable */
70#define UCR4_REF16 (1<<6) /* Ref freq 16 MHz */
71#define UCR4_IRSC (1<<5) /* IR special case */
72#define UCR4_TCEN (1<<3) /* Transmit complete interrupt enable */
73#define UCR4_BKEN (1<<2) /* Break condition interrupt enable */
74#define UCR4_OREN (1<<1) /* Receiver overrun interrupt enable */
75#define UCR4_DREN (1<<0) /* Recv data ready interrupt enable */
76#define UFCR_RXTL_SHF 0 /* Receiver trigger level shift */
77#define UFCR_RFDIV (7<<7) /* Reference freq divider mask */
78#define UFCR_RFDIV_SHF 7 /* Reference freq divider shift */
79#define RFDIV 4 /* divide input clock by 2 */
80#define UFCR_DCEDTE (1<<6) /* DTE mode select */
81#define UFCR_TXTL_SHF 10 /* Transmitter trigger level shift */
82#define USR1_PARITYERR (1<<15) /* Parity error interrupt flag */
83#define USR1_RTSS (1<<14) /* RTS pin status */
84#define USR1_TRDY (1<<13) /* Transmitter ready interrupt/dma flag */
85#define USR1_RTSD (1<<12) /* RTS delta */
86#define USR1_ESCF (1<<11) /* Escape seq interrupt flag */
87#define USR1_FRAMERR (1<<10) /* Frame error interrupt flag */
88#define USR1_RRDY (1<<9) /* Receiver ready interrupt/dma flag */
89#define USR1_TIMEOUT (1<<7) /* Receive timeout interrupt status */
90#define USR1_RXDS (1<<6) /* Receiver idle interrupt flag */
91#define USR1_AIRINT (1<<5) /* Async IR wake interrupt flag */
92#define USR1_AWAKE (1<<4) /* Aysnc wake interrupt flag */
93#define USR2_ADET (1<<15) /* Auto baud rate detect complete */
94#define USR2_TXFE (1<<14) /* Transmit buffer FIFO empty */
95#define USR2_DTRF (1<<13) /* DTR edge interrupt flag */
96#define USR2_IDLE (1<<12) /* Idle condition */
97#define USR2_IRINT (1<<8) /* Serial infrared interrupt flag */
98#define USR2_WAKE (1<<7) /* Wake */
99#define USR2_RTSF (1<<4) /* RTS edge interrupt flag */
100#define USR2_TXDC (1<<3) /* Transmitter complete */
101#define USR2_BRCD (1<<2) /* Break condition */
102#define USR2_ORE (1<<1) /* Overrun error */
103#define USR2_RDR (1<<0) /* Recv data ready */
104#define UTS_FRCPERR (1<<13) /* Force parity error */
105#define UTS_LOOP (1<<12) /* Loop tx and rx */
106#define UTS_TXEMPTY (1<<6) /* TxFIFO empty */
107#define UTS_RXEMPTY (1<<5) /* RxFIFO empty */
108#define UTS_TXFULL (1<<4) /* TxFIFO full */
109#define UTS_RXFULL (1<<3) /* RxFIFO full */
110#define UTS_SOFTRS (1<<0) /* Software reset */
Jagan Teki45d97512017-06-06 05:31:49 +0000111#define TXTL 2 /* reset default */
112#define RXTL 1 /* reset default */
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100113
Stefan Agnera99546a2016-10-05 15:27:03 -0700114DECLARE_GLOBAL_DATA_PTR;
115
Jagan Tekiffa8bcd2017-06-06 05:31:45 +0000116struct mxc_uart {
117 u32 rxd;
118 u32 spare0[15];
119
120 u32 txd;
121 u32 spare1[15];
122
123 u32 cr1;
124 u32 cr2;
125 u32 cr3;
126 u32 cr4;
127
128 u32 fcr;
129 u32 sr1;
130 u32 sr2;
131 u32 esc;
132
133 u32 tim;
134 u32 bir;
135 u32 bmr;
136 u32 brc;
137
138 u32 onems;
139 u32 ts;
140};
141
Max Krummenachera2453202019-02-01 16:04:50 +0100142static void _mxc_serial_init(struct mxc_uart *base, int use_dte)
Jagan Teki97548d52017-06-06 05:31:48 +0000143{
144 writel(0, &base->cr1);
145 writel(0, &base->cr2);
146
147 while (!(readl(&base->cr2) & UCR2_SRST));
148
Max Krummenachera2453202019-02-01 16:04:50 +0100149 if (use_dte)
150 writel(0x404 | UCR3_ADNIMP, &base->cr3);
151 else
152 writel(0x704 | UCR3_ADNIMP, &base->cr3);
153
Jagan Teki97548d52017-06-06 05:31:48 +0000154 writel(0x704 | UCR3_ADNIMP, &base->cr3);
155 writel(0x8000, &base->cr4);
156 writel(0x2b, &base->esc);
157 writel(0, &base->tim);
158
159 writel(0, &base->ts);
160}
161
Jagan Teki45d97512017-06-06 05:31:49 +0000162static void _mxc_serial_setbrg(struct mxc_uart *base, unsigned long clk,
163 unsigned long baudrate, bool use_dte)
164{
165 u32 tmp;
166
167 tmp = RFDIV << UFCR_RFDIV_SHF;
168 if (use_dte)
169 tmp |= UFCR_DCEDTE;
170 else
171 tmp |= (TXTL << UFCR_TXTL_SHF) | (RXTL << UFCR_RXTL_SHF);
172 writel(tmp, &base->fcr);
173
174 writel(0xf, &base->bir);
175 writel(clk / (2 * baudrate), &base->bmr);
176
177 writel(UCR2_WS | UCR2_IRTS | UCR2_RXEN | UCR2_TXEN | UCR2_SRST,
178 &base->cr2);
179 writel(UCR1_UARTEN, &base->cr1);
180}
181
Adam Forde434b412019-02-19 22:07:22 -0600182#if !CONFIG_IS_ENABLED(DM_SERIAL)
Simon Glassa8ba5692014-10-01 19:57:27 -0600183
184#ifndef CONFIG_MXC_UART_BASE
185#error "define CONFIG_MXC_UART_BASE to use the MXC UART driver"
186#endif
187
Jagan Tekiffa8bcd2017-06-06 05:31:45 +0000188#define mxc_base ((struct mxc_uart *)CONFIG_MXC_UART_BASE)
Simon Glassa8ba5692014-10-01 19:57:27 -0600189
Marek Vasuta9434722012-09-14 22:37:43 +0200190static void mxc_serial_setbrg(void)
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100191{
Stefano Babic71d64c02010-01-20 18:20:19 +0100192 u32 clk = imx_get_uartclk();
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100193
194 if (!gd->baudrate)
195 gd->baudrate = CONFIG_BAUDRATE;
196
Jagan Teki45d97512017-06-06 05:31:49 +0000197 _mxc_serial_setbrg(mxc_base, clk, gd->baudrate, false);
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100198}
199
Marek Vasuta9434722012-09-14 22:37:43 +0200200static int mxc_serial_getc(void)
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100201{
Jagan Tekiffa8bcd2017-06-06 05:31:45 +0000202 while (readl(&mxc_base->ts) & UTS_RXEMPTY)
Stefano Babic4ec3d2a2010-08-18 10:22:42 +0200203 WATCHDOG_RESET();
Jagan Tekiffa8bcd2017-06-06 05:31:45 +0000204 return (readl(&mxc_base->rxd) & URXD_RX_DATA); /* mask out status from upper word */
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100205}
206
Marek Vasuta9434722012-09-14 22:37:43 +0200207static void mxc_serial_putc(const char c)
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100208{
Alison Wang055457e2016-03-02 11:00:37 +0800209 /* If \n, also do \r */
210 if (c == '\n')
211 serial_putc('\r');
212
Jagan Tekiffa8bcd2017-06-06 05:31:45 +0000213 writel(c, &mxc_base->txd);
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100214
215 /* wait for transmitter to be ready */
Jagan Tekiffa8bcd2017-06-06 05:31:45 +0000216 while (!(readl(&mxc_base->ts) & UTS_TXEMPTY))
Stefano Babic4ec3d2a2010-08-18 10:22:42 +0200217 WATCHDOG_RESET();
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100218}
219
Jagan Teki52c14ca2017-06-06 05:31:50 +0000220/* Test whether a character is in the RX buffer */
Marek Vasuta9434722012-09-14 22:37:43 +0200221static int mxc_serial_tstc(void)
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100222{
223 /* If receive fifo is empty, return false */
Jagan Tekiffa8bcd2017-06-06 05:31:45 +0000224 if (readl(&mxc_base->ts) & UTS_RXEMPTY)
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100225 return 0;
226 return 1;
227}
228
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100229/*
230 * Initialise the serial port with the given baudrate. The settings
231 * are always 8 data bits, no parity, 1 stop bit, no start bits.
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100232 */
Marek Vasuta9434722012-09-14 22:37:43 +0200233static int mxc_serial_init(void)
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100234{
Max Krummenachera2453202019-02-01 16:04:50 +0100235 _mxc_serial_init(mxc_base, false);
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100236
237 serial_setbrg();
238
Sascha Hauer9b56f4f2008-03-26 20:40:42 +0100239 return 0;
240}
Marek Vasuta9434722012-09-14 22:37:43 +0200241
Marek Vasuta9434722012-09-14 22:37:43 +0200242static struct serial_device mxc_serial_drv = {
243 .name = "mxc_serial",
244 .start = mxc_serial_init,
245 .stop = NULL,
246 .setbrg = mxc_serial_setbrg,
247 .putc = mxc_serial_putc,
Marek Vasutec3fd682012-10-06 14:07:02 +0000248 .puts = default_serial_puts,
Marek Vasuta9434722012-09-14 22:37:43 +0200249 .getc = mxc_serial_getc,
250 .tstc = mxc_serial_tstc,
251};
252
253void mxc_serial_initialize(void)
254{
255 serial_register(&mxc_serial_drv);
256}
257
258__weak struct serial_device *default_serial_console(void)
259{
260 return &mxc_serial_drv;
261}
Simon Glassa8ba5692014-10-01 19:57:27 -0600262#endif
263
Adam Forde434b412019-02-19 22:07:22 -0600264#if CONFIG_IS_ENABLED(DM_SERIAL)
Simon Glassa8ba5692014-10-01 19:57:27 -0600265
Simon Glassa8ba5692014-10-01 19:57:27 -0600266int mxc_serial_setbrg(struct udevice *dev, int baudrate)
267{
Simon Glass0fd3d912020-12-22 19:30:28 -0700268 struct mxc_serial_plat *plat = dev_get_plat(dev);
Simon Glassa8ba5692014-10-01 19:57:27 -0600269 u32 clk = imx_get_uartclk();
270
Jagan Teki45d97512017-06-06 05:31:49 +0000271 _mxc_serial_setbrg(plat->reg, clk, baudrate, plat->use_dte);
Simon Glassa8ba5692014-10-01 19:57:27 -0600272
273 return 0;
274}
275
276static int mxc_serial_probe(struct udevice *dev)
277{
Simon Glass0fd3d912020-12-22 19:30:28 -0700278 struct mxc_serial_plat *plat = dev_get_plat(dev);
Simon Glassa8ba5692014-10-01 19:57:27 -0600279
Max Krummenachera2453202019-02-01 16:04:50 +0100280 _mxc_serial_init(plat->reg, plat->use_dte);
Simon Glassa8ba5692014-10-01 19:57:27 -0600281
282 return 0;
283}
284
285static int mxc_serial_getc(struct udevice *dev)
286{
Simon Glass0fd3d912020-12-22 19:30:28 -0700287 struct mxc_serial_plat *plat = dev_get_plat(dev);
Simon Glassa8ba5692014-10-01 19:57:27 -0600288 struct mxc_uart *const uart = plat->reg;
289
290 if (readl(&uart->ts) & UTS_RXEMPTY)
291 return -EAGAIN;
292
293 return readl(&uart->rxd) & URXD_RX_DATA;
294}
295
296static int mxc_serial_putc(struct udevice *dev, const char ch)
297{
Simon Glass0fd3d912020-12-22 19:30:28 -0700298 struct mxc_serial_plat *plat = dev_get_plat(dev);
Simon Glassa8ba5692014-10-01 19:57:27 -0600299 struct mxc_uart *const uart = plat->reg;
300
301 if (!(readl(&uart->ts) & UTS_TXEMPTY))
302 return -EAGAIN;
303
304 writel(ch, &uart->txd);
305
306 return 0;
307}
308
309static int mxc_serial_pending(struct udevice *dev, bool input)
310{
Simon Glass0fd3d912020-12-22 19:30:28 -0700311 struct mxc_serial_plat *plat = dev_get_plat(dev);
Simon Glassa8ba5692014-10-01 19:57:27 -0600312 struct mxc_uart *const uart = plat->reg;
313 uint32_t sr2 = readl(&uart->sr2);
314
315 if (input)
316 return sr2 & USR2_RDR ? 1 : 0;
317 else
318 return sr2 & USR2_TXDC ? 0 : 1;
319}
320
321static const struct dm_serial_ops mxc_serial_ops = {
322 .putc = mxc_serial_putc,
323 .pending = mxc_serial_pending,
324 .getc = mxc_serial_getc,
325 .setbrg = mxc_serial_setbrg,
326};
327
Stefan Agnera99546a2016-10-05 15:27:03 -0700328#if CONFIG_IS_ENABLED(OF_CONTROL)
Simon Glassd1998a92020-12-03 16:55:21 -0700329static int mxc_serial_of_to_plat(struct udevice *dev)
Stefan Agnera99546a2016-10-05 15:27:03 -0700330{
Simon Glass0fd3d912020-12-22 19:30:28 -0700331 struct mxc_serial_plat *plat = dev_get_plat(dev);
Stefan Agnera99546a2016-10-05 15:27:03 -0700332 fdt_addr_t addr;
333
Masahiro Yamada25484932020-07-17 14:36:48 +0900334 addr = dev_read_addr(dev);
Stefan Agnera99546a2016-10-05 15:27:03 -0700335 if (addr == FDT_ADDR_T_NONE)
336 return -EINVAL;
337
338 plat->reg = (struct mxc_uart *)addr;
339
Simon Glasse160f7d2017-01-17 16:52:55 -0700340 plat->use_dte = fdtdec_get_bool(gd->fdt_blob, dev_of_offset(dev),
Stefan Agnera99546a2016-10-05 15:27:03 -0700341 "fsl,dte-mode");
342 return 0;
343}
344
345static const struct udevice_id mxc_serial_ids[] = {
Lukasz Majewski2756fd12019-07-09 17:00:05 +0200346 { .compatible = "fsl,imx21-uart" },
347 { .compatible = "fsl,imx53-uart" },
Marek Vasut6757fa52019-05-17 21:56:40 +0200348 { .compatible = "fsl,imx6sx-uart" },
Sébastien Szymanski3a5d6362017-03-07 14:33:24 +0100349 { .compatible = "fsl,imx6ul-uart" },
Stefan Agnera99546a2016-10-05 15:27:03 -0700350 { .compatible = "fsl,imx7d-uart" },
Bernhard Messerklinger4684fa82018-09-03 10:17:35 +0200351 { .compatible = "fsl,imx6q-uart" },
Stefan Agnera99546a2016-10-05 15:27:03 -0700352 { }
353};
354#endif
355
Simon Glassa8ba5692014-10-01 19:57:27 -0600356U_BOOT_DRIVER(serial_mxc) = {
357 .name = "serial_mxc",
358 .id = UCLASS_SERIAL,
Stefan Agnera99546a2016-10-05 15:27:03 -0700359#if CONFIG_IS_ENABLED(OF_CONTROL)
360 .of_match = mxc_serial_ids,
Simon Glassd1998a92020-12-03 16:55:21 -0700361 .of_to_plat = mxc_serial_of_to_plat,
Simon Glass8a8d24b2020-12-03 16:55:23 -0700362 .plat_auto = sizeof(struct mxc_serial_plat),
Stefan Agnera99546a2016-10-05 15:27:03 -0700363#endif
Simon Glassa8ba5692014-10-01 19:57:27 -0600364 .probe = mxc_serial_probe,
365 .ops = &mxc_serial_ops,
366 .flags = DM_FLAG_PRE_RELOC,
367};
368#endif
Jagan Teki61366b72017-06-06 05:31:51 +0000369
370#ifdef CONFIG_DEBUG_UART_MXC
371#include <debug_uart.h>
372
373static inline void _debug_uart_init(void)
374{
Pali Rohárb62450c2022-05-27 22:15:24 +0200375 struct mxc_uart *base = (struct mxc_uart *)CONFIG_VAL(DEBUG_UART_BASE);
Jagan Teki61366b72017-06-06 05:31:51 +0000376
Max Krummenachera2453202019-02-01 16:04:50 +0100377 _mxc_serial_init(base, false);
Jagan Teki61366b72017-06-06 05:31:51 +0000378 _mxc_serial_setbrg(base, CONFIG_DEBUG_UART_CLOCK,
379 CONFIG_BAUDRATE, false);
380}
381
382static inline void _debug_uart_putc(int ch)
383{
Pali Rohárb62450c2022-05-27 22:15:24 +0200384 struct mxc_uart *base = (struct mxc_uart *)CONFIG_VAL(DEBUG_UART_BASE);
Jagan Teki61366b72017-06-06 05:31:51 +0000385
386 while (!(readl(&base->ts) & UTS_TXEMPTY))
387 WATCHDOG_RESET();
388
389 writel(ch, &base->txd);
390}
391
392DEBUG_UART_FUNCS
393
394#endif