1194846f3SMichal Simek /* 2194846f3SMichal Simek * Copyright (C) 2012 Michal Simek <monstr@monstr.eu> 3194846f3SMichal Simek * Copyright (C) 2011-2012 Xilinx, Inc. All rights reserved. 4194846f3SMichal Simek * 51a459660SWolfgang Denk * SPDX-License-Identifier: GPL-2.0+ 6194846f3SMichal Simek */ 7194846f3SMichal Simek 8*59da82efSMichal Simek #include <clk.h> 9194846f3SMichal Simek #include <common.h> 1042800ffaSSimon Glass #include <debug_uart.h> 1142800ffaSSimon Glass #include <dm.h> 12c54c0a4cSSimon Glass #include <errno.h> 13c9416b92SMichal Simek #include <fdtdec.h> 14194846f3SMichal Simek #include <watchdog.h> 15194846f3SMichal Simek #include <asm/io.h> 16194846f3SMichal Simek #include <linux/compiler.h> 17194846f3SMichal Simek #include <serial.h> 1819605e2eSSoren Brinkmann #include <asm/arch/clk.h> 19bf834950SMichal Simek #include <asm/arch/hardware.h> 20194846f3SMichal Simek 21c9416b92SMichal Simek DECLARE_GLOBAL_DATA_PTR; 22c9416b92SMichal Simek 236cd0f2a6SMichal Simek #define ZYNQ_UART_SR_TXEMPTY (1 << 3) /* TX FIFO empty */ 2442800ffaSSimon Glass #define ZYNQ_UART_SR_TXACTIVE (1 << 11) /* TX active */ 25194846f3SMichal Simek #define ZYNQ_UART_SR_RXEMPTY 0x00000002 /* RX FIFO empty */ 26194846f3SMichal Simek 27194846f3SMichal Simek #define ZYNQ_UART_CR_TX_EN 0x00000010 /* TX enabled */ 28194846f3SMichal Simek #define ZYNQ_UART_CR_RX_EN 0x00000004 /* RX enabled */ 29194846f3SMichal Simek #define ZYNQ_UART_CR_TXRST 0x00000002 /* TX logic reset */ 30194846f3SMichal Simek #define ZYNQ_UART_CR_RXRST 0x00000001 /* RX logic reset */ 31194846f3SMichal Simek 32194846f3SMichal Simek #define ZYNQ_UART_MR_PARITY_NONE 0x00000020 /* No parity mode */ 33194846f3SMichal Simek 34194846f3SMichal Simek struct uart_zynq { 35a2425e62SMichal Simek u32 control; /* 0x0 - Control Register [8:0] */ 36a2425e62SMichal Simek u32 mode; /* 0x4 - Mode Register [10:0] */ 37194846f3SMichal Simek u32 reserved1[4]; 38a2425e62SMichal Simek u32 baud_rate_gen; /* 0x18 - Baud Rate Generator [15:0] */ 39194846f3SMichal Simek u32 reserved2[4]; 40a2425e62SMichal Simek u32 channel_sts; /* 0x2c - Channel Status [11:0] */ 41a2425e62SMichal Simek u32 tx_rx_fifo; /* 0x30 - FIFO [15:0] or [7:0] */ 42a2425e62SMichal Simek u32 baud_rate_divider; /* 0x34 - Baud Rate Divider [7:0] */ 43194846f3SMichal Simek }; 44194846f3SMichal Simek 4542800ffaSSimon Glass struct zynq_uart_priv { 4642800ffaSSimon Glass struct uart_zynq *regs; 47194846f3SMichal Simek }; 48194846f3SMichal Simek 49194846f3SMichal Simek /* Set up the baud rate in gd struct */ 50c54c0a4cSSimon Glass static void _uart_zynq_serial_setbrg(struct uart_zynq *regs, 51c54c0a4cSSimon Glass unsigned long clock, unsigned long baud) 52194846f3SMichal Simek { 53194846f3SMichal Simek /* Calculation results. */ 54194846f3SMichal Simek unsigned int calc_bauderror, bdiv, bgen; 55194846f3SMichal Simek unsigned long calc_baud = 0; 56194846f3SMichal Simek 5704bc5c93SMichal Simek /* Covering case where input clock is so slow */ 58c54c0a4cSSimon Glass if (clock < 1000000 && baud > 4800) 59c54c0a4cSSimon Glass baud = 4800; 6004bc5c93SMichal Simek 61194846f3SMichal Simek /* master clock 62194846f3SMichal Simek * Baud rate = ------------------ 63194846f3SMichal Simek * bgen * (bdiv + 1) 64194846f3SMichal Simek * 65194846f3SMichal Simek * Find acceptable values for baud generation. 66194846f3SMichal Simek */ 67194846f3SMichal Simek for (bdiv = 4; bdiv < 255; bdiv++) { 68194846f3SMichal Simek bgen = clock / (baud * (bdiv + 1)); 69194846f3SMichal Simek if (bgen < 2 || bgen > 65535) 70194846f3SMichal Simek continue; 71194846f3SMichal Simek 72194846f3SMichal Simek calc_baud = clock / (bgen * (bdiv + 1)); 73194846f3SMichal Simek 74194846f3SMichal Simek /* 75194846f3SMichal Simek * Use first calculated baudrate with 76194846f3SMichal Simek * an acceptable (<3%) error 77194846f3SMichal Simek */ 78194846f3SMichal Simek if (baud > calc_baud) 79194846f3SMichal Simek calc_bauderror = baud - calc_baud; 80194846f3SMichal Simek else 81194846f3SMichal Simek calc_bauderror = calc_baud - baud; 82194846f3SMichal Simek if (((calc_bauderror * 100) / baud) < 3) 83194846f3SMichal Simek break; 84194846f3SMichal Simek } 85194846f3SMichal Simek 86194846f3SMichal Simek writel(bdiv, ®s->baud_rate_divider); 87194846f3SMichal Simek writel(bgen, ®s->baud_rate_gen); 88194846f3SMichal Simek } 89194846f3SMichal Simek 90c54c0a4cSSimon Glass /* Initialize the UART, with...some settings. */ 91c54c0a4cSSimon Glass static void _uart_zynq_serial_init(struct uart_zynq *regs) 92c54c0a4cSSimon Glass { 93c54c0a4cSSimon Glass /* RX/TX enabled & reset */ 94c54c0a4cSSimon Glass writel(ZYNQ_UART_CR_TX_EN | ZYNQ_UART_CR_RX_EN | ZYNQ_UART_CR_TXRST | \ 95c54c0a4cSSimon Glass ZYNQ_UART_CR_RXRST, ®s->control); 96c54c0a4cSSimon Glass writel(ZYNQ_UART_MR_PARITY_NONE, ®s->mode); /* 8 bit, no parity */ 97c54c0a4cSSimon Glass } 98c54c0a4cSSimon Glass 99c54c0a4cSSimon Glass static int _uart_zynq_serial_putc(struct uart_zynq *regs, const char c) 100c54c0a4cSSimon Glass { 1016cd0f2a6SMichal Simek if (!(readl(®s->channel_sts) & ZYNQ_UART_SR_TXEMPTY)) 102c54c0a4cSSimon Glass return -EAGAIN; 103c54c0a4cSSimon Glass 104c54c0a4cSSimon Glass writel(c, ®s->tx_rx_fifo); 105c54c0a4cSSimon Glass 106c54c0a4cSSimon Glass return 0; 107c54c0a4cSSimon Glass } 108c54c0a4cSSimon Glass 10942800ffaSSimon Glass int zynq_serial_setbrg(struct udevice *dev, int baudrate) 110194846f3SMichal Simek { 11142800ffaSSimon Glass struct zynq_uart_priv *priv = dev_get_priv(dev); 112*59da82efSMichal Simek unsigned long clock; 113194846f3SMichal Simek 114*59da82efSMichal Simek #if defined(CONFIG_CLK) || defined(CONFIG_SPL_CLK) 115*59da82efSMichal Simek int ret; 116*59da82efSMichal Simek struct clk clk; 117*59da82efSMichal Simek 118*59da82efSMichal Simek ret = clk_get_by_index(dev, 0, &clk); 119*59da82efSMichal Simek if (ret < 0) { 120*59da82efSMichal Simek dev_err(dev, "failed to get clock\n"); 121*59da82efSMichal Simek return ret; 122*59da82efSMichal Simek } 123*59da82efSMichal Simek 124*59da82efSMichal Simek clock = clk_get_rate(&clk); 125*59da82efSMichal Simek if (IS_ERR_VALUE(clock)) { 126*59da82efSMichal Simek dev_err(dev, "failed to get rate\n"); 127*59da82efSMichal Simek return clock; 128*59da82efSMichal Simek } 129*59da82efSMichal Simek debug("%s: CLK %ld\n", __func__, clock); 130*59da82efSMichal Simek 131*59da82efSMichal Simek ret = clk_enable(&clk); 132*59da82efSMichal Simek if (ret && ret != -ENOSYS) { 133*59da82efSMichal Simek dev_err(dev, "failed to enable clock\n"); 134*59da82efSMichal Simek return ret; 135*59da82efSMichal Simek } 136*59da82efSMichal Simek #else 137*59da82efSMichal Simek clock = get_uart_clk(0); 138*59da82efSMichal Simek #endif 13942800ffaSSimon Glass _uart_zynq_serial_setbrg(priv->regs, clock, baudrate); 140194846f3SMichal Simek 14142800ffaSSimon Glass return 0; 142194846f3SMichal Simek } 143194846f3SMichal Simek 14442800ffaSSimon Glass static int zynq_serial_probe(struct udevice *dev) 145194846f3SMichal Simek { 14642800ffaSSimon Glass struct zynq_uart_priv *priv = dev_get_priv(dev); 14742800ffaSSimon Glass 14842800ffaSSimon Glass _uart_zynq_serial_init(priv->regs); 14942800ffaSSimon Glass 15042800ffaSSimon Glass return 0; 151194846f3SMichal Simek } 152194846f3SMichal Simek 15342800ffaSSimon Glass static int zynq_serial_getc(struct udevice *dev) 154194846f3SMichal Simek { 15542800ffaSSimon Glass struct zynq_uart_priv *priv = dev_get_priv(dev); 15642800ffaSSimon Glass struct uart_zynq *regs = priv->regs; 157194846f3SMichal Simek 15842800ffaSSimon Glass if (readl(®s->channel_sts) & ZYNQ_UART_SR_RXEMPTY) 15942800ffaSSimon Glass return -EAGAIN; 160194846f3SMichal Simek 161194846f3SMichal Simek return readl(®s->tx_rx_fifo); 162194846f3SMichal Simek } 163194846f3SMichal Simek 16442800ffaSSimon Glass static int zynq_serial_putc(struct udevice *dev, const char ch) 165c9416b92SMichal Simek { 16642800ffaSSimon Glass struct zynq_uart_priv *priv = dev_get_priv(dev); 167c9416b92SMichal Simek 16842800ffaSSimon Glass return _uart_zynq_serial_putc(priv->regs, ch); 169c9416b92SMichal Simek } 17051d8102fSTom Rini 17142800ffaSSimon Glass static int zynq_serial_pending(struct udevice *dev, bool input) 17251d8102fSTom Rini { 17342800ffaSSimon Glass struct zynq_uart_priv *priv = dev_get_priv(dev); 17442800ffaSSimon Glass struct uart_zynq *regs = priv->regs; 17542800ffaSSimon Glass 17642800ffaSSimon Glass if (input) 17742800ffaSSimon Glass return !(readl(®s->channel_sts) & ZYNQ_UART_SR_RXEMPTY); 17842800ffaSSimon Glass else 17942800ffaSSimon Glass return !!(readl(®s->channel_sts) & ZYNQ_UART_SR_TXACTIVE); 18051d8102fSTom Rini } 181c54c0a4cSSimon Glass 18242800ffaSSimon Glass static int zynq_serial_ofdata_to_platdata(struct udevice *dev) 18342800ffaSSimon Glass { 18442800ffaSSimon Glass struct zynq_uart_priv *priv = dev_get_priv(dev); 18542800ffaSSimon Glass 186842efb3aSMichal Simek priv->regs = (struct uart_zynq *)dev_get_addr(dev); 18742800ffaSSimon Glass 18842800ffaSSimon Glass return 0; 18942800ffaSSimon Glass } 19042800ffaSSimon Glass 19142800ffaSSimon Glass static const struct dm_serial_ops zynq_serial_ops = { 19242800ffaSSimon Glass .putc = zynq_serial_putc, 19342800ffaSSimon Glass .pending = zynq_serial_pending, 19442800ffaSSimon Glass .getc = zynq_serial_getc, 19542800ffaSSimon Glass .setbrg = zynq_serial_setbrg, 19642800ffaSSimon Glass }; 19742800ffaSSimon Glass 19842800ffaSSimon Glass static const struct udevice_id zynq_serial_ids[] = { 19942800ffaSSimon Glass { .compatible = "xlnx,xuartps" }, 20042800ffaSSimon Glass { .compatible = "cdns,uart-r1p8" }, 201a2533183SMichal Simek { .compatible = "cdns,uart-r1p12" }, 20242800ffaSSimon Glass { } 20342800ffaSSimon Glass }; 20442800ffaSSimon Glass 2056bf87dacSMichal Simek U_BOOT_DRIVER(serial_zynq) = { 20642800ffaSSimon Glass .name = "serial_zynq", 20742800ffaSSimon Glass .id = UCLASS_SERIAL, 20842800ffaSSimon Glass .of_match = zynq_serial_ids, 20942800ffaSSimon Glass .ofdata_to_platdata = zynq_serial_ofdata_to_platdata, 21042800ffaSSimon Glass .priv_auto_alloc_size = sizeof(struct zynq_uart_priv), 21142800ffaSSimon Glass .probe = zynq_serial_probe, 21242800ffaSSimon Glass .ops = &zynq_serial_ops, 21342800ffaSSimon Glass .flags = DM_FLAG_PRE_RELOC, 21442800ffaSSimon Glass }; 21542800ffaSSimon Glass 216c54c0a4cSSimon Glass #ifdef CONFIG_DEBUG_UART_ZYNQ 21780dc9997SMichal Simek static inline void _debug_uart_init(void) 218c54c0a4cSSimon Glass { 219c54c0a4cSSimon Glass struct uart_zynq *regs = (struct uart_zynq *)CONFIG_DEBUG_UART_BASE; 220c54c0a4cSSimon Glass 221c54c0a4cSSimon Glass _uart_zynq_serial_init(regs); 222c54c0a4cSSimon Glass _uart_zynq_serial_setbrg(regs, CONFIG_DEBUG_UART_CLOCK, 223c54c0a4cSSimon Glass CONFIG_BAUDRATE); 224c54c0a4cSSimon Glass } 225c54c0a4cSSimon Glass 226c54c0a4cSSimon Glass static inline void _debug_uart_putc(int ch) 227c54c0a4cSSimon Glass { 228c54c0a4cSSimon Glass struct uart_zynq *regs = (struct uart_zynq *)CONFIG_DEBUG_UART_BASE; 229c54c0a4cSSimon Glass 230c54c0a4cSSimon Glass while (_uart_zynq_serial_putc(regs, ch) == -EAGAIN) 231c54c0a4cSSimon Glass WATCHDOG_RESET(); 232c54c0a4cSSimon Glass } 233c54c0a4cSSimon Glass 234c54c0a4cSSimon Glass DEBUG_UART_FUNCS 235c54c0a4cSSimon Glass 236c54c0a4cSSimon Glass #endif 237