1 // SPDX-License-Identifier: GPL-2.0+
4 * Copyright 2013 Freescale Semiconductor, Inc.
8 #include <clock_legacy.h>
11 #include <fsl_lpuart.h>
14 #include <asm/global_data.h>
17 #include <dm/device_compat.h>
18 #include <linux/bitops.h>
19 #include <linux/compiler.h>
20 #include <asm/arch/imx-regs.h>
21 #include <asm/arch/clock.h>
23 #define US1_TDRE (1 << 7)
24 #define US1_RDRF (1 << 5)
25 #define US1_OR (1 << 3)
26 #define UC2_TE (1 << 3)
27 #define UC2_RE (1 << 2)
28 #define CFIFO_TXFLUSH (1 << 7)
29 #define CFIFO_RXFLUSH (1 << 6)
30 #define SFIFO_RXOF (1 << 2)
31 #define SFIFO_RXUF (1 << 0)
33 #define STAT_LBKDIF (1 << 31)
34 #define STAT_RXEDGIF (1 << 30)
35 #define STAT_TDRE (1 << 23)
36 #define STAT_RDRF (1 << 21)
37 #define STAT_IDLE (1 << 20)
38 #define STAT_OR (1 << 19)
39 #define STAT_NF (1 << 18)
40 #define STAT_FE (1 << 17)
41 #define STAT_PF (1 << 16)
42 #define STAT_MA1F (1 << 15)
43 #define STAT_MA2F (1 << 14)
44 #define STAT_FLAGS (STAT_LBKDIF | STAT_RXEDGIF | STAT_IDLE | STAT_OR | \
45 STAT_NF | STAT_FE | STAT_PF | STAT_MA1F | STAT_MA2F)
47 #define CTRL_TE (1 << 19)
48 #define CTRL_RE (1 << 18)
50 #define FIFO_RXFLUSH BIT(14)
51 #define FIFO_TXFLUSH BIT(15)
52 #define FIFO_TXSIZE_MASK 0x70
53 #define FIFO_TXSIZE_OFF 4
54 #define FIFO_RXSIZE_MASK 0x7
55 #define FIFO_RXSIZE_OFF 0
56 #define FIFO_TXFE 0x80
57 #if defined(CONFIG_ARCH_IMX8) || defined(CONFIG_ARCH_IMXRT)
58 #define FIFO_RXFE 0x08
60 #define FIFO_RXFE 0x40
63 #define WATER_TXWATER_OFF 0
64 #define WATER_RXWATER_OFF 16
66 DECLARE_GLOBAL_DATA_PTR
;
68 #define LPUART_FLAG_REGMAP_32BIT_REG BIT(0)
69 #define LPUART_FLAG_REGMAP_ENDIAN_BIG BIT(1)
79 struct lpuart_serial_plat
{
81 enum lpuart_devtype devtype
;
85 static void lpuart_read32(u32 flags
, u32
*addr
, u32
*val
)
87 if (flags
& LPUART_FLAG_REGMAP_32BIT_REG
) {
88 if (flags
& LPUART_FLAG_REGMAP_ENDIAN_BIG
)
89 *(u32
*)val
= in_be32(addr
);
91 *(u32
*)val
= in_le32(addr
);
95 static void lpuart_write32(u32 flags
, u32
*addr
, u32 val
)
97 if (flags
& LPUART_FLAG_REGMAP_32BIT_REG
) {
98 if (flags
& LPUART_FLAG_REGMAP_ENDIAN_BIG
)
106 u32 __weak
get_lpuart_clk(void)
108 return get_board_sys_clk();
111 #if CONFIG_IS_ENABLED(CLK)
112 static int get_lpuart_clk_rate(struct udevice
*dev
, u32
*clk
)
118 ret
= clk_get_by_name(dev
, "per", &per_clk
);
120 dev_err(dev
, "Failed to get per clk: %d\n", ret
);
124 rate
= clk_get_rate(&per_clk
);
125 if ((long)rate
<= 0) {
126 dev_err(dev
, "Failed to get per clk rate: %ld\n", (long)rate
);
133 static inline int get_lpuart_clk_rate(struct udevice
*dev
, u32
*clk
)
137 static bool is_lpuart32(struct udevice
*dev
)
139 struct lpuart_serial_plat
*plat
= dev_get_plat(dev
);
141 return plat
->flags
& LPUART_FLAG_REGMAP_32BIT_REG
;
144 static void _lpuart_serial_setbrg(struct udevice
*dev
,
147 struct lpuart_serial_plat
*plat
= dev_get_plat(dev
);
148 struct lpuart_fsl
*base
= plat
->reg
;
153 if (CONFIG_IS_ENABLED(CLK
)) {
154 ret
= get_lpuart_clk_rate(dev
, &clk
);
158 clk
= get_lpuart_clk();
161 sbr
= (u16
)(clk
/ (16 * baudrate
));
163 /* place adjustment later - n/32 BRFA */
164 __raw_writeb(sbr
>> 8, &base
->ubdh
);
165 __raw_writeb(sbr
& 0xff, &base
->ubdl
);
168 static int _lpuart_serial_getc(struct lpuart_serial_plat
*plat
)
170 struct lpuart_fsl
*base
= plat
->reg
;
171 if (!(__raw_readb(&base
->us1
) & (US1_RDRF
| US1_OR
)))
176 return __raw_readb(&base
->ud
);
179 static int _lpuart_serial_putc(struct lpuart_serial_plat
*plat
,
182 struct lpuart_fsl
*base
= plat
->reg
;
184 if (!(__raw_readb(&base
->us1
) & US1_TDRE
))
187 __raw_writeb(c
, &base
->ud
);
191 /* Test whether a character is in the RX buffer */
192 static int _lpuart_serial_tstc(struct lpuart_serial_plat
*plat
)
194 struct lpuart_fsl
*base
= plat
->reg
;
196 if (__raw_readb(&base
->urcfifo
) == 0)
203 * Initialise the serial port with the given baudrate. The settings
204 * are always 8 data bits, no parity, 1 stop bit, no start bits.
206 static int _lpuart_serial_init(struct udevice
*dev
)
208 struct lpuart_serial_plat
*plat
= dev_get_plat(dev
);
209 struct lpuart_fsl
*base
= (struct lpuart_fsl
*)plat
->reg
;
212 ctrl
= __raw_readb(&base
->uc2
);
215 __raw_writeb(ctrl
, &base
->uc2
);
217 __raw_writeb(0, &base
->umodem
);
218 __raw_writeb(0, &base
->uc1
);
220 /* Disable FIFO and flush buffer */
221 __raw_writeb(0x0, &base
->upfifo
);
222 __raw_writeb(0x0, &base
->utwfifo
);
223 __raw_writeb(0x1, &base
->urwfifo
);
224 __raw_writeb(CFIFO_TXFLUSH
| CFIFO_RXFLUSH
, &base
->ucfifo
);
226 /* provide data bits, parity, stop bit, etc */
227 _lpuart_serial_setbrg(dev
, gd
->baudrate
);
229 __raw_writeb(UC2_RE
| UC2_TE
, &base
->uc2
);
234 static void _lpuart32_serial_setbrg_7ulp(struct udevice
*dev
,
237 struct lpuart_serial_plat
*plat
= dev_get_plat(dev
);
238 struct lpuart_fsl_reg32
*base
= plat
->reg
;
239 u32 sbr
, osr
, baud_diff
, tmp_osr
, tmp_sbr
, tmp_diff
, tmp
;
243 if (CONFIG_IS_ENABLED(CLK
)) {
244 ret
= get_lpuart_clk_rate(dev
, &clk
);
248 clk
= get_lpuart_clk();
251 baud_diff
= baudrate
;
255 for (tmp_osr
= 4; tmp_osr
<= 32; tmp_osr
++) {
256 tmp_sbr
= (clk
/ (baudrate
* tmp_osr
));
261 /*calculate difference in actual buad w/ current values */
262 tmp_diff
= (clk
/ (tmp_osr
* tmp_sbr
));
263 tmp_diff
= tmp_diff
- baudrate
;
265 /* select best values between sbr and sbr+1 */
266 if (tmp_diff
> (baudrate
- (clk
/ (tmp_osr
* (tmp_sbr
+ 1))))) {
267 tmp_diff
= baudrate
- (clk
/ (tmp_osr
* (tmp_sbr
+ 1)));
271 if (tmp_diff
<= baud_diff
) {
272 baud_diff
= tmp_diff
;
279 * TODO: handle buadrate outside acceptable rate
280 * if (baudDiff > ((config->baudRate_Bps / 100) * 3))
282 * Unacceptable baud rate difference of more than 3%
283 * return kStatus_LPUART_BaudrateNotSupport;
286 tmp
= in_le32(&base
->baud
);
288 if ((osr
> 3) && (osr
< 8))
289 tmp
|= LPUART_BAUD_BOTHEDGE_MASK
;
291 tmp
&= ~LPUART_BAUD_OSR_MASK
;
292 tmp
|= LPUART_BAUD_OSR(osr
-1);
294 tmp
&= ~LPUART_BAUD_SBR_MASK
;
295 tmp
|= LPUART_BAUD_SBR(sbr
);
297 /* explicitly disable 10 bit mode & set 1 stop bit */
298 tmp
&= ~(LPUART_BAUD_M10_MASK
| LPUART_BAUD_SBNS_MASK
);
300 out_le32(&base
->baud
, tmp
);
303 static void _lpuart32_serial_setbrg(struct udevice
*dev
,
306 struct lpuart_serial_plat
*plat
= dev_get_plat(dev
);
307 struct lpuart_fsl_reg32
*base
= plat
->reg
;
312 if (CONFIG_IS_ENABLED(CLK
)) {
313 ret
= get_lpuart_clk_rate(dev
, &clk
);
317 clk
= get_lpuart_clk();
320 sbr
= (clk
/ (16 * baudrate
));
322 /* place adjustment later - n/32 BRFA */
323 lpuart_write32(plat
->flags
, &base
->baud
, sbr
);
326 static int _lpuart32_serial_getc(struct lpuart_serial_plat
*plat
)
328 struct lpuart_fsl_reg32
*base
= plat
->reg
;
331 lpuart_read32(plat
->flags
, &base
->stat
, &stat
);
332 if ((stat
& STAT_RDRF
) == 0) {
333 lpuart_write32(plat
->flags
, &base
->stat
, STAT_FLAGS
);
337 lpuart_read32(plat
->flags
, &base
->data
, &val
);
339 lpuart_read32(plat
->flags
, &base
->stat
, &stat
);
341 lpuart_write32(plat
->flags
, &base
->stat
, STAT_OR
);
346 static int _lpuart32_serial_putc(struct lpuart_serial_plat
*plat
,
349 struct lpuart_fsl_reg32
*base
= plat
->reg
;
352 lpuart_read32(plat
->flags
, &base
->stat
, &stat
);
353 if (!(stat
& STAT_TDRE
))
356 lpuart_write32(plat
->flags
, &base
->data
, c
);
360 /* Test whether a character is in the RX buffer */
361 static int _lpuart32_serial_tstc(struct lpuart_serial_plat
*plat
)
363 struct lpuart_fsl_reg32
*base
= plat
->reg
;
366 lpuart_read32(plat
->flags
, &base
->water
, &water
);
368 if ((water
>> 24) == 0)
375 * Initialise the serial port with the given baudrate. The settings
376 * are always 8 data bits, no parity, 1 stop bit, no start bits.
378 static int _lpuart32_serial_init(struct udevice
*dev
)
380 struct lpuart_serial_plat
*plat
= dev_get_plat(dev
);
381 struct lpuart_fsl_reg32
*base
= (struct lpuart_fsl_reg32
*)plat
->reg
;
382 u32 val
, tx_fifo_size
;
384 lpuart_read32(plat
->flags
, &base
->ctrl
, &val
);
387 lpuart_write32(plat
->flags
, &base
->ctrl
, val
);
389 lpuart_write32(plat
->flags
, &base
->modir
, 0);
391 lpuart_read32(plat
->flags
, &base
->fifo
, &val
);
392 tx_fifo_size
= (val
& FIFO_TXSIZE_MASK
) >> FIFO_TXSIZE_OFF
;
393 /* Set the TX water to half of FIFO size */
394 if (tx_fifo_size
> 1)
395 tx_fifo_size
= tx_fifo_size
>> 1;
397 /* Set RX water to 0, to be triggered by any receive data */
398 lpuart_write32(plat
->flags
, &base
->water
,
399 (tx_fifo_size
<< WATER_TXWATER_OFF
));
401 /* Enable TX and RX FIFO */
402 val
|= (FIFO_TXFE
| FIFO_RXFE
| FIFO_TXFLUSH
| FIFO_RXFLUSH
);
403 lpuart_write32(plat
->flags
, &base
->fifo
, val
);
405 lpuart_write32(plat
->flags
, &base
->match
, 0);
407 if (plat
->devtype
== DEV_MX7ULP
|| plat
->devtype
== DEV_IMX8
||
408 plat
->devtype
== DEV_IMXRT
) {
409 _lpuart32_serial_setbrg_7ulp(dev
, gd
->baudrate
);
411 /* provide data bits, parity, stop bit, etc */
412 _lpuart32_serial_setbrg(dev
, gd
->baudrate
);
415 lpuart_write32(plat
->flags
, &base
->ctrl
, CTRL_RE
| CTRL_TE
);
420 static int lpuart_serial_setbrg(struct udevice
*dev
, int baudrate
)
422 struct lpuart_serial_plat
*plat
= dev_get_plat(dev
);
424 if (is_lpuart32(dev
)) {
425 if (plat
->devtype
== DEV_MX7ULP
|| plat
->devtype
== DEV_IMX8
||
426 plat
->devtype
== DEV_IMXRT
)
427 _lpuart32_serial_setbrg_7ulp(dev
, baudrate
);
429 _lpuart32_serial_setbrg(dev
, baudrate
);
431 _lpuart_serial_setbrg(dev
, baudrate
);
437 static int lpuart_serial_getc(struct udevice
*dev
)
439 struct lpuart_serial_plat
*plat
= dev_get_plat(dev
);
441 if (is_lpuart32(dev
))
442 return _lpuart32_serial_getc(plat
);
444 return _lpuart_serial_getc(plat
);
447 static int lpuart_serial_putc(struct udevice
*dev
, const char c
)
449 struct lpuart_serial_plat
*plat
= dev_get_plat(dev
);
451 if (is_lpuart32(dev
))
452 return _lpuart32_serial_putc(plat
, c
);
454 return _lpuart_serial_putc(plat
, c
);
457 static int lpuart_serial_pending(struct udevice
*dev
, bool input
)
459 struct lpuart_serial_plat
*plat
= dev_get_plat(dev
);
460 struct lpuart_fsl
*reg
= plat
->reg
;
461 struct lpuart_fsl_reg32
*reg32
= plat
->reg
;
464 if (is_lpuart32(dev
)) {
466 return _lpuart32_serial_tstc(plat
);
468 lpuart_read32(plat
->flags
, ®32
->stat
, &stat
);
469 return stat
& STAT_TDRE
? 0 : 1;
474 return _lpuart_serial_tstc(plat
);
476 return __raw_readb(®
->us1
) & US1_TDRE
? 0 : 1;
479 static int lpuart_serial_probe(struct udevice
*dev
)
481 #if CONFIG_IS_ENABLED(CLK)
486 ret
= clk_get_by_name(dev
, "per", &per_clk
);
488 ret
= clk_enable(&per_clk
);
490 dev_err(dev
, "Failed to enable per clk: %d\n", ret
);
494 debug("%s: Failed to get per clk: %d\n", __func__
, ret
);
497 ret
= clk_get_by_name(dev
, "ipg", &ipg_clk
);
499 ret
= clk_enable(&ipg_clk
);
501 dev_err(dev
, "Failed to enable ipg clk: %d\n", ret
);
505 debug("%s: Failed to get ipg clk: %d\n", __func__
, ret
);
509 if (is_lpuart32(dev
))
510 return _lpuart32_serial_init(dev
);
512 return _lpuart_serial_init(dev
);
515 static int lpuart_serial_of_to_plat(struct udevice
*dev
)
517 struct lpuart_serial_plat
*plat
= dev_get_plat(dev
);
518 const void *blob
= gd
->fdt_blob
;
519 int node
= dev_of_offset(dev
);
522 addr
= dev_read_addr(dev
);
523 if (addr
== FDT_ADDR_T_NONE
)
526 plat
->reg
= (void *)addr
;
527 plat
->flags
= dev_get_driver_data(dev
);
529 if (fdtdec_get_bool(blob
, node
, "little-endian"))
530 plat
->flags
&= ~LPUART_FLAG_REGMAP_ENDIAN_BIG
;
532 if (!fdt_node_check_compatible(blob
, node
, "fsl,ls1021a-lpuart"))
533 plat
->devtype
= DEV_LS1021A
;
534 else if (!fdt_node_check_compatible(blob
, node
, "fsl,imx7ulp-lpuart"))
535 plat
->devtype
= DEV_MX7ULP
;
536 else if (!fdt_node_check_compatible(blob
, node
, "fsl,vf610-lpuart"))
537 plat
->devtype
= DEV_VF610
;
538 else if (!fdt_node_check_compatible(blob
, node
, "fsl,imx8qm-lpuart"))
539 plat
->devtype
= DEV_IMX8
;
540 else if (!fdt_node_check_compatible(blob
, node
, "fsl,imxrt-lpuart"))
541 plat
->devtype
= DEV_IMXRT
;
546 static const struct dm_serial_ops lpuart_serial_ops
= {
547 .putc
= lpuart_serial_putc
,
548 .pending
= lpuart_serial_pending
,
549 .getc
= lpuart_serial_getc
,
550 .setbrg
= lpuart_serial_setbrg
,
553 static const struct udevice_id lpuart_serial_ids
[] = {
554 { .compatible
= "fsl,ls1021a-lpuart", .data
=
555 LPUART_FLAG_REGMAP_32BIT_REG
| LPUART_FLAG_REGMAP_ENDIAN_BIG
},
556 { .compatible
= "fsl,ls1028a-lpuart",
557 .data
= LPUART_FLAG_REGMAP_32BIT_REG
},
558 { .compatible
= "fsl,imx7ulp-lpuart",
559 .data
= LPUART_FLAG_REGMAP_32BIT_REG
},
560 { .compatible
= "fsl,vf610-lpuart"},
561 { .compatible
= "fsl,imx8qm-lpuart",
562 .data
= LPUART_FLAG_REGMAP_32BIT_REG
},
563 { .compatible
= "fsl,imxrt-lpuart",
564 .data
= LPUART_FLAG_REGMAP_32BIT_REG
},
568 U_BOOT_DRIVER(serial_lpuart
) = {
569 .name
= "serial_lpuart",
571 .of_match
= lpuart_serial_ids
,
572 .of_to_plat
= lpuart_serial_of_to_plat
,
573 .plat_auto
= sizeof(struct lpuart_serial_plat
),
574 .probe
= lpuart_serial_probe
,
575 .ops
= &lpuart_serial_ops
,