2 * arch/arm/mach-omap2/serial.c
4 * OMAP2 serial support.
6 * Copyright (C) 2005-2008 Nokia Corporation
7 * Author: Paul Mundt <paul.mundt@nokia.com>
9 * Major rework for PM support by Kevin Hilman
11 * Based off of arch/arm/mach-omap/omap1/serial.c
13 * Copyright (C) 2009 Texas Instruments
14 * Added OMAP4 support - Santosh Shilimkar <santosh.shilimkar@ti.com
16 * This file is subject to the terms and conditions of the GNU General Public
17 * License. See the file "COPYING" in the main directory of this archive
20 #include <linux/kernel.h>
21 #include <linux/init.h>
22 #include <linux/serial_reg.h>
23 #include <linux/clk.h>
25 #include <linux/delay.h>
26 #include <linux/platform_device.h>
27 #include <linux/slab.h>
28 #include <linux/serial_8250.h>
29 #include <linux/pm_runtime.h>
30 #include <linux/console.h>
32 #ifdef CONFIG_SERIAL_OMAP
33 #include <plat/omap-serial.h>
36 #include <plat/common.h>
37 #include <plat/board.h>
38 #include <plat/clock.h>
40 #include <plat/omap_hwmod.h>
41 #include <plat/omap_device.h>
43 #include "prm2xxx_3xxx.h"
45 #include "cm2xxx_3xxx.h"
46 #include "prm-regbits-34xx.h"
49 #define UART_OMAP_NO_EMPTY_FIFO_READ_IP_REV 0x52
50 #define UART_OMAP_WER 0x17 /* Wake-up enable register */
52 #define UART_ERRATA_FIFO_FULL_ABORT (0x1 << 0)
53 #define UART_ERRATA_i202_MDR1_ACCESS (0x1 << 1)
56 * NOTE: By default the serial timeout is disabled as it causes lost characters
57 * over the serial ports. This means that the UART clocks will stay on until
58 * disabled via sysfs. This also causes that any deeper omap sleep states are
61 #define DEFAULT_TIMEOUT 0
63 #define MAX_UART_HWMOD_NAME_LEN 16
65 struct omap_uart_state {
68 struct timer_list timer;
84 void __iomem *membase;
85 resource_size_t mapbase;
87 struct list_head node;
88 struct omap_hwmod *oh;
89 struct platform_device *pdev;
92 #if defined(CONFIG_ARCH_OMAP3) && defined(CONFIG_PM)
95 /* Registers to be saved/restored for OFF-mode */
106 static LIST_HEAD(uart_list);
109 static int uart_idle_hwmod(struct omap_device *od)
111 omap_hwmod_idle(od->hwmods[0]);
116 static int uart_enable_hwmod(struct omap_device *od)
118 omap_hwmod_enable(od->hwmods[0]);
123 static struct omap_device_pm_latency omap_uart_latency[] = {
125 .deactivate_func = uart_idle_hwmod,
126 .activate_func = uart_enable_hwmod,
127 .flags = OMAP_DEVICE_LATENCY_AUTO_ADJUST,
131 static inline unsigned int __serial_read_reg(struct uart_port *up,
134 offset <<= up->regshift;
135 return (unsigned int)__raw_readb(up->membase + offset);
138 static inline unsigned int serial_read_reg(struct omap_uart_state *uart,
141 offset <<= uart->regshift;
142 return (unsigned int)__raw_readb(uart->membase + offset);
145 static inline void __serial_write_reg(struct uart_port *up, int offset,
148 offset <<= up->regshift;
149 __raw_writeb(value, up->membase + offset);
152 static inline void serial_write_reg(struct omap_uart_state *uart, int offset,
155 offset <<= uart->regshift;
156 __raw_writeb(value, uart->membase + offset);
160 * Internal UARTs need to be initialized for the 8250 autoconfig to work
161 * properly. Note that the TX watermark initialization may not be needed
162 * once the 8250.c watermark handling code is merged.
165 static inline void __init omap_uart_reset(struct omap_uart_state *uart)
167 serial_write_reg(uart, UART_OMAP_MDR1, UART_OMAP_MDR1_DISABLE);
168 serial_write_reg(uart, UART_OMAP_SCR, 0x08);
169 serial_write_reg(uart, UART_OMAP_MDR1, UART_OMAP_MDR1_16X_MODE);
172 #if defined(CONFIG_PM) && defined(CONFIG_ARCH_OMAP3)
175 * Work Around for Errata i202 (3430 - 1.12, 3630 - 1.6)
176 * The access to uart register after MDR1 Access
177 * causes UART to corrupt data.
180 * 5 L4 clock cycles + 5 UART functional clock cycle (@48MHz = ~0.2uS)
181 * give 10 times as much
183 static void omap_uart_mdr1_errataset(struct omap_uart_state *uart, u8 mdr1_val,
188 serial_write_reg(uart, UART_OMAP_MDR1, mdr1_val);
190 serial_write_reg(uart, UART_FCR, fcr_val | UART_FCR_CLEAR_XMIT |
191 UART_FCR_CLEAR_RCVR);
193 * Wait for FIFO to empty: when empty, RX_FIFO_E bit is 0 and
194 * TX_FIFO_E bit is 1.
196 while (UART_LSR_THRE != (serial_read_reg(uart, UART_LSR) &
197 (UART_LSR_THRE | UART_LSR_DR))) {
200 /* Should *never* happen. we warn and carry on */
201 dev_crit(&uart->pdev->dev, "Errata i202: timedout %x\n",
202 serial_read_reg(uart, UART_LSR));
209 static void omap_uart_save_context(struct omap_uart_state *uart)
213 if (!enable_off_mode)
216 lcr = serial_read_reg(uart, UART_LCR);
217 serial_write_reg(uart, UART_LCR, UART_LCR_CONF_MODE_B);
218 uart->dll = serial_read_reg(uart, UART_DLL);
219 uart->dlh = serial_read_reg(uart, UART_DLM);
220 serial_write_reg(uart, UART_LCR, lcr);
221 uart->ier = serial_read_reg(uart, UART_IER);
222 uart->sysc = serial_read_reg(uart, UART_OMAP_SYSC);
223 uart->scr = serial_read_reg(uart, UART_OMAP_SCR);
224 uart->wer = serial_read_reg(uart, UART_OMAP_WER);
225 serial_write_reg(uart, UART_LCR, UART_LCR_CONF_MODE_A);
226 uart->mcr = serial_read_reg(uart, UART_MCR);
227 serial_write_reg(uart, UART_LCR, lcr);
229 uart->context_valid = 1;
232 static void omap_uart_restore_context(struct omap_uart_state *uart)
236 if (!enable_off_mode)
239 if (!uart->context_valid)
242 uart->context_valid = 0;
244 if (uart->errata & UART_ERRATA_i202_MDR1_ACCESS)
245 omap_uart_mdr1_errataset(uart, UART_OMAP_MDR1_DISABLE, 0xA0);
247 serial_write_reg(uart, UART_OMAP_MDR1, UART_OMAP_MDR1_DISABLE);
249 serial_write_reg(uart, UART_LCR, UART_LCR_CONF_MODE_B);
250 efr = serial_read_reg(uart, UART_EFR);
251 serial_write_reg(uart, UART_EFR, UART_EFR_ECB);
252 serial_write_reg(uart, UART_LCR, 0x0); /* Operational mode */
253 serial_write_reg(uart, UART_IER, 0x0);
254 serial_write_reg(uart, UART_LCR, UART_LCR_CONF_MODE_B);
255 serial_write_reg(uart, UART_DLL, uart->dll);
256 serial_write_reg(uart, UART_DLM, uart->dlh);
257 serial_write_reg(uart, UART_LCR, 0x0); /* Operational mode */
258 serial_write_reg(uart, UART_IER, uart->ier);
259 serial_write_reg(uart, UART_LCR, UART_LCR_CONF_MODE_A);
260 serial_write_reg(uart, UART_MCR, uart->mcr);
261 serial_write_reg(uart, UART_LCR, UART_LCR_CONF_MODE_B);
262 serial_write_reg(uart, UART_EFR, efr);
263 serial_write_reg(uart, UART_LCR, UART_LCR_WLEN8);
264 serial_write_reg(uart, UART_OMAP_SCR, uart->scr);
265 serial_write_reg(uart, UART_OMAP_WER, uart->wer);
266 serial_write_reg(uart, UART_OMAP_SYSC, uart->sysc);
268 if (uart->errata & UART_ERRATA_i202_MDR1_ACCESS)
269 omap_uart_mdr1_errataset(uart, UART_OMAP_MDR1_16X_MODE, 0xA1);
272 serial_write_reg(uart, UART_OMAP_MDR1,
273 UART_OMAP_MDR1_16X_MODE);
276 static inline void omap_uart_save_context(struct omap_uart_state *uart) {}
277 static inline void omap_uart_restore_context(struct omap_uart_state *uart) {}
278 #endif /* CONFIG_PM && CONFIG_ARCH_OMAP3 */
280 static inline void omap_uart_enable_clocks(struct omap_uart_state *uart)
285 omap_device_enable(uart->pdev);
287 omap_uart_restore_context(uart);
292 static inline void omap_uart_disable_clocks(struct omap_uart_state *uart)
297 omap_uart_save_context(uart);
299 omap_device_idle(uart->pdev);
302 static void omap_uart_enable_wakeup(struct omap_uart_state *uart)
304 /* Set wake-enable bit */
305 if (uart->wk_en && uart->wk_mask) {
306 u32 v = __raw_readl(uart->wk_en);
308 __raw_writel(v, uart->wk_en);
311 /* Ensure IOPAD wake-enables are set */
312 if (cpu_is_omap34xx() && uart->padconf) {
313 u16 v = omap_ctrl_readw(uart->padconf);
314 v |= OMAP3_PADCONF_WAKEUPENABLE0;
315 omap_ctrl_writew(v, uart->padconf);
319 static void omap_uart_disable_wakeup(struct omap_uart_state *uart)
321 /* Clear wake-enable bit */
322 if (uart->wk_en && uart->wk_mask) {
323 u32 v = __raw_readl(uart->wk_en);
325 __raw_writel(v, uart->wk_en);
328 /* Ensure IOPAD wake-enables are cleared */
329 if (cpu_is_omap34xx() && uart->padconf) {
330 u16 v = omap_ctrl_readw(uart->padconf);
331 v &= ~OMAP3_PADCONF_WAKEUPENABLE0;
332 omap_ctrl_writew(v, uart->padconf);
336 static void omap_uart_smart_idle_enable(struct omap_uart_state *uart,
343 * Errata 2.15: [UART]:Cannot Acknowledge Idle Requests
344 * in Smartidle Mode When Configured for DMA Operations.
346 if (uart->dma_enabled)
347 idlemode = HWMOD_IDLEMODE_FORCE;
349 idlemode = HWMOD_IDLEMODE_SMART;
351 idlemode = HWMOD_IDLEMODE_NO;
354 omap_hwmod_set_slave_idlemode(uart->oh, idlemode);
357 static void omap_uart_block_sleep(struct omap_uart_state *uart)
359 omap_uart_enable_clocks(uart);
361 omap_uart_smart_idle_enable(uart, 0);
364 mod_timer(&uart->timer, jiffies + uart->timeout);
366 del_timer(&uart->timer);
369 static void omap_uart_allow_sleep(struct omap_uart_state *uart)
371 if (device_may_wakeup(&uart->pdev->dev))
372 omap_uart_enable_wakeup(uart);
374 omap_uart_disable_wakeup(uart);
379 omap_uart_smart_idle_enable(uart, 1);
381 del_timer(&uart->timer);
384 static void omap_uart_idle_timer(unsigned long data)
386 struct omap_uart_state *uart = (struct omap_uart_state *)data;
388 omap_uart_allow_sleep(uart);
391 void omap_uart_prepare_idle(int num)
393 struct omap_uart_state *uart;
395 list_for_each_entry(uart, &uart_list, node) {
396 if (num == uart->num && uart->can_sleep) {
397 omap_uart_disable_clocks(uart);
403 void omap_uart_resume_idle(int num)
405 struct omap_uart_state *uart;
407 list_for_each_entry(uart, &uart_list, node) {
408 if (num == uart->num && uart->can_sleep) {
409 omap_uart_enable_clocks(uart);
411 /* Check for IO pad wakeup */
412 if (cpu_is_omap34xx() && uart->padconf) {
413 u16 p = omap_ctrl_readw(uart->padconf);
415 if (p & OMAP3_PADCONF_WAKEUPEVENT0)
416 omap_uart_block_sleep(uart);
419 /* Check for normal UART wakeup */
420 if (__raw_readl(uart->wk_st) & uart->wk_mask)
421 omap_uart_block_sleep(uart);
427 void omap_uart_prepare_suspend(void)
429 struct omap_uart_state *uart;
431 list_for_each_entry(uart, &uart_list, node) {
432 omap_uart_allow_sleep(uart);
436 int omap_uart_can_sleep(void)
438 struct omap_uart_state *uart;
441 list_for_each_entry(uart, &uart_list, node) {
445 if (!uart->can_sleep) {
450 /* This UART can now safely sleep. */
451 omap_uart_allow_sleep(uart);
458 * omap_uart_interrupt()
460 * This handler is used only to detect that *any* UART interrupt has
461 * occurred. It does _nothing_ to handle the interrupt. Rather,
462 * any UART interrupt will trigger the inactivity timer so the
463 * UART will not idle or sleep for its timeout period.
466 /* static int first_interrupt; */
467 static irqreturn_t omap_uart_interrupt(int irq, void *dev_id)
469 struct omap_uart_state *uart = dev_id;
471 omap_uart_block_sleep(uart);
476 static void omap_uart_idle_init(struct omap_uart_state *uart)
481 uart->timeout = DEFAULT_TIMEOUT;
482 setup_timer(&uart->timer, omap_uart_idle_timer,
483 (unsigned long) uart);
485 mod_timer(&uart->timer, jiffies + uart->timeout);
486 omap_uart_smart_idle_enable(uart, 0);
488 if (cpu_is_omap34xx()) {
489 u32 mod = (uart->num > 1) ? OMAP3430_PER_MOD : CORE_MOD;
493 /* XXX These PRM accesses do not belong here */
494 uart->wk_en = OMAP34XX_PRM_REGADDR(mod, PM_WKEN1);
495 uart->wk_st = OMAP34XX_PRM_REGADDR(mod, PM_WKST1);
498 wk_mask = OMAP3430_ST_UART1_MASK;
502 wk_mask = OMAP3430_ST_UART2_MASK;
506 wk_mask = OMAP3430_ST_UART3_MASK;
510 wk_mask = OMAP3630_ST_UART4_MASK;
514 uart->wk_mask = wk_mask;
515 uart->padconf = padconf;
516 } else if (cpu_is_omap24xx()) {
518 u32 wk_en = PM_WKEN1, wk_st = PM_WKST1;
522 wk_mask = OMAP24XX_ST_UART1_MASK;
525 wk_mask = OMAP24XX_ST_UART2_MASK;
528 wk_en = OMAP24XX_PM_WKEN2;
529 wk_st = OMAP24XX_PM_WKST2;
530 wk_mask = OMAP24XX_ST_UART3_MASK;
533 uart->wk_mask = wk_mask;
534 if (cpu_is_omap2430()) {
535 uart->wk_en = OMAP2430_PRM_REGADDR(CORE_MOD, wk_en);
536 uart->wk_st = OMAP2430_PRM_REGADDR(CORE_MOD, wk_st);
537 } else if (cpu_is_omap2420()) {
538 uart->wk_en = OMAP2420_PRM_REGADDR(CORE_MOD, wk_en);
539 uart->wk_st = OMAP2420_PRM_REGADDR(CORE_MOD, wk_st);
548 uart->irqflags |= IRQF_SHARED;
549 ret = request_threaded_irq(uart->irq, NULL, omap_uart_interrupt,
550 IRQF_SHARED, "serial idle", (void *)uart);
554 void omap_uart_enable_irqs(int enable)
557 struct omap_uart_state *uart;
559 list_for_each_entry(uart, &uart_list, node) {
561 pm_runtime_put_sync(&uart->pdev->dev);
562 ret = request_threaded_irq(uart->irq, NULL,
568 pm_runtime_get_noresume(&uart->pdev->dev);
569 free_irq(uart->irq, (void *)uart);
574 static ssize_t sleep_timeout_show(struct device *dev,
575 struct device_attribute *attr,
578 struct platform_device *pdev = to_platform_device(dev);
579 struct omap_device *odev = to_omap_device(pdev);
580 struct omap_uart_state *uart = odev->hwmods[0]->dev_attr;
582 return sprintf(buf, "%u\n", uart->timeout / HZ);
585 static ssize_t sleep_timeout_store(struct device *dev,
586 struct device_attribute *attr,
587 const char *buf, size_t n)
589 struct platform_device *pdev = to_platform_device(dev);
590 struct omap_device *odev = to_omap_device(pdev);
591 struct omap_uart_state *uart = odev->hwmods[0]->dev_attr;
594 if (sscanf(buf, "%u", &value) != 1) {
595 dev_err(dev, "sleep_timeout_store: Invalid value\n");
599 uart->timeout = value * HZ;
601 mod_timer(&uart->timer, jiffies + uart->timeout);
603 /* A zero value means disable timeout feature */
604 omap_uart_block_sleep(uart);
609 static DEVICE_ATTR(sleep_timeout, 0644, sleep_timeout_show,
610 sleep_timeout_store);
611 #define DEV_CREATE_FILE(dev, attr) WARN_ON(device_create_file(dev, attr))
613 static inline void omap_uart_idle_init(struct omap_uart_state *uart) {}
614 static void omap_uart_block_sleep(struct omap_uart_state *uart)
616 /* Needed to enable UART clocks when built without CONFIG_PM */
617 omap_uart_enable_clocks(uart);
619 #define DEV_CREATE_FILE(dev, attr)
620 #endif /* CONFIG_PM */
622 #ifndef CONFIG_SERIAL_OMAP
624 * Override the default 8250 read handler: mem_serial_in()
625 * Empty RX fifo read causes an abort on omap3630 and omap4
626 * This function makes sure that an empty rx fifo is not read on these silicons
627 * (OMAP1/2/3430 are not affected)
629 static unsigned int serial_in_override(struct uart_port *up, int offset)
631 if (UART_RX == offset) {
633 lsr = __serial_read_reg(up, UART_LSR);
634 if (!(lsr & UART_LSR_DR))
638 return __serial_read_reg(up, offset);
641 static void serial_out_override(struct uart_port *up, int offset, int value)
643 unsigned int status, tmout = 10000;
645 status = __serial_read_reg(up, UART_LSR);
646 while (!(status & UART_LSR_THRE)) {
647 /* Wait up to 10ms for the character(s) to be sent. */
651 status = __serial_read_reg(up, UART_LSR);
653 __serial_write_reg(up, offset, value);
657 void __init omap_serial_early_init(void)
662 char oh_name[MAX_UART_HWMOD_NAME_LEN];
663 struct omap_hwmod *oh;
664 struct omap_uart_state *uart;
666 snprintf(oh_name, MAX_UART_HWMOD_NAME_LEN,
668 oh = omap_hwmod_lookup(oh_name);
672 uart = kzalloc(sizeof(struct omap_uart_state), GFP_KERNEL);
678 list_add_tail(&uart->node, &uart_list);
682 * NOTE: omap_hwmod_init() has not yet been called,
683 * so no hwmod functions will work yet.
687 * During UART early init, device need to be probed
688 * to determine SoC specific init before omap_device
689 * is ready. Therefore, don't allow idle here
691 uart->oh->flags |= HWMOD_INIT_NO_IDLE | HWMOD_INIT_NO_RESET;
696 * omap_serial_init_port() - initialize single serial port
697 * @port: serial port number (0-3)
699 * This function initialies serial driver for given @port only.
700 * Platforms can call this function instead of omap_serial_init()
701 * if they don't plan to use all available UARTs as serial ports.
703 * Don't mix calls to omap_serial_init_port() and omap_serial_init(),
704 * use only one of the two.
706 void __init omap_serial_init_port(int port)
708 struct omap_uart_state *uart;
709 struct omap_hwmod *oh;
710 struct omap_device *od;
714 #ifndef CONFIG_SERIAL_OMAP
715 struct plat_serial8250_port ports[2] = {
719 struct plat_serial8250_port *p = &ports[0];
721 struct omap_uart_port_info omap_up;
724 if (WARN_ON(port < 0))
726 if (WARN_ON(port >= num_uarts))
729 list_for_each_entry(uart, &uart_list, node)
730 if (port == uart->num)
734 uart->dma_enabled = 0;
735 #ifndef CONFIG_SERIAL_OMAP
739 * !! 8250 driver does not use standard IORESOURCE* It
740 * has it's own custom pdata that can be taken from
741 * the hwmod resource data. But, this needs to be
742 * done after the build.
744 * ?? does it have to be done before the register ??
745 * YES, because platform_device_data_add() copies
746 * pdata, it does not use a pointer.
748 p->flags = UPF_BOOT_AUTOCONF;
749 p->iotype = UPIO_MEM;
751 p->uartclk = OMAP24XX_BASE_BAUD * 16;
752 p->irq = oh->mpu_irqs[0].irq;
753 p->mapbase = oh->slaves[0]->addr->pa_start;
754 p->membase = omap_hwmod_get_mpu_rt_va(oh);
755 p->irqflags = IRQF_SHARED;
756 p->private_data = uart;
759 * omap44xx: Never read empty UART fifo
760 * omap3xxx: Never read empty UART fifo on UARTs
763 uart->regshift = p->regshift;
764 uart->membase = p->membase;
765 if (cpu_is_omap44xx())
766 uart->errata |= UART_ERRATA_FIFO_FULL_ABORT;
767 else if ((serial_read_reg(uart, UART_OMAP_MVER) & 0xFF)
768 >= UART_OMAP_NO_EMPTY_FIFO_READ_IP_REV)
769 uart->errata |= UART_ERRATA_FIFO_FULL_ABORT;
771 if (uart->errata & UART_ERRATA_FIFO_FULL_ABORT) {
772 p->serial_in = serial_in_override;
773 p->serial_out = serial_out_override;
777 pdata_size = 2 * sizeof(struct plat_serial8250_port);
782 omap_up.dma_enabled = uart->dma_enabled;
783 omap_up.uartclk = OMAP24XX_BASE_BAUD * 16;
784 omap_up.mapbase = oh->slaves[0]->addr->pa_start;
785 omap_up.membase = omap_hwmod_get_mpu_rt_va(oh);
786 omap_up.irqflags = IRQF_SHARED;
787 omap_up.flags = UPF_BOOT_AUTOCONF | UPF_SHARE_IRQ;
790 pdata_size = sizeof(struct omap_uart_port_info);
796 od = omap_device_build(name, uart->num, oh, pdata, pdata_size,
798 ARRAY_SIZE(omap_uart_latency), false);
799 WARN(IS_ERR(od), "Could not build omap_device for %s: %s.\n",
802 uart->irq = oh->mpu_irqs[0].irq;
804 uart->mapbase = oh->slaves[0]->addr->pa_start;
805 uart->membase = omap_hwmod_get_mpu_rt_va(oh);
806 uart->pdev = &od->pdev;
810 acquire_console_sem(); /* in case the earlycon is on the UART */
813 * Because of early UART probing, UART did not get idled
814 * on init. Now that omap_device is ready, ensure full idle
815 * before doing omap_device_enable().
817 omap_hwmod_idle(uart->oh);
819 omap_device_enable(uart->pdev);
820 omap_uart_idle_init(uart);
821 omap_uart_reset(uart);
822 omap_hwmod_enable_wakeup(uart->oh);
823 omap_device_idle(uart->pdev);
826 * Need to block sleep long enough for interrupt driven
827 * driver to start. Console driver is in polling mode
828 * so device needs to be kept enabled while polling driver
832 uart->timeout = (30 * HZ);
833 omap_uart_block_sleep(uart);
834 uart->timeout = DEFAULT_TIMEOUT;
836 release_console_sem();
838 if ((cpu_is_omap34xx() && uart->padconf) ||
839 (uart->wk_en && uart->wk_mask)) {
840 device_init_wakeup(&od->pdev.dev, true);
841 DEV_CREATE_FILE(&od->pdev.dev, &dev_attr_sleep_timeout);
844 /* Enable the MDR1 errata for OMAP3 */
845 if (cpu_is_omap34xx())
846 uart->errata |= UART_ERRATA_i202_MDR1_ACCESS;
850 * omap_serial_init() - intialize all supported serial ports
852 * Initializes all available UARTs as serial ports. Platforms
853 * can call this function when they want to have default behaviour
854 * for serial ports (e.g initialize them all as serial ports).
856 void __init omap_serial_init(void)
858 struct omap_uart_state *uart;
860 list_for_each_entry(uart, &uart_list, node)
861 omap_serial_init_port(uart->num);