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_8250.h>
23 #include <linux/serial_reg.h>
24 #include <linux/clk.h>
27 #include <plat/common.h>
28 #include <plat/board.h>
29 #include <plat/clock.h>
30 #include <plat/control.h>
34 #include "prm-regbits-34xx.h"
36 #define UART_OMAP_NO_EMPTY_FIFO_READ_IP_REV 0x52
37 #define UART_OMAP_WER 0x17 /* Wake-up enable register */
40 * NOTE: By default the serial timeout is disabled as it causes lost characters
41 * over the serial ports. This means that the UART clocks will stay on until
42 * disabled via sysfs. This also causes that any deeper omap sleep states are
45 #define DEFAULT_TIMEOUT 0
47 struct omap_uart_state {
50 struct timer_list timer;
62 struct plat_serial8250_port *p;
63 struct list_head node;
64 struct platform_device pdev;
66 #if defined(CONFIG_ARCH_OMAP3) && defined(CONFIG_PM)
69 /* Registers to be saved/restored for OFF-mode */
79 static LIST_HEAD(uart_list);
81 static struct plat_serial8250_port serial_platform_data0[] = {
84 .flags = UPF_BOOT_AUTOCONF,
87 .uartclk = OMAP24XX_BASE_BAUD * 16,
93 static struct plat_serial8250_port serial_platform_data1[] = {
96 .flags = UPF_BOOT_AUTOCONF,
99 .uartclk = OMAP24XX_BASE_BAUD * 16,
105 static struct plat_serial8250_port serial_platform_data2[] = {
108 .flags = UPF_BOOT_AUTOCONF,
111 .uartclk = OMAP24XX_BASE_BAUD * 16,
117 #ifdef CONFIG_ARCH_OMAP4
118 static struct plat_serial8250_port serial_platform_data3[] = {
121 .flags = UPF_BOOT_AUTOCONF,
124 .uartclk = OMAP24XX_BASE_BAUD * 16,
131 void __init omap2_set_globals_uart(struct omap_globals *omap2_globals)
133 serial_platform_data0[0].mapbase = omap2_globals->uart1_phys;
134 serial_platform_data1[0].mapbase = omap2_globals->uart2_phys;
135 serial_platform_data2[0].mapbase = omap2_globals->uart3_phys;
136 #ifdef CONFIG_ARCH_OMAP4
137 serial_platform_data3[0].mapbase = omap2_globals->uart4_phys;
141 static inline unsigned int __serial_read_reg(struct uart_port *up,
144 offset <<= up->regshift;
145 return (unsigned int)__raw_readb(up->membase + offset);
148 static inline unsigned int serial_read_reg(struct plat_serial8250_port *up,
151 offset <<= up->regshift;
152 return (unsigned int)__raw_readb(up->membase + offset);
155 static inline void serial_write_reg(struct plat_serial8250_port *p, int offset,
158 offset <<= p->regshift;
159 __raw_writeb(value, p->membase + offset);
163 * Internal UARTs need to be initialized for the 8250 autoconfig to work
164 * properly. Note that the TX watermark initialization may not be needed
165 * once the 8250.c watermark handling code is merged.
167 static inline void __init omap_uart_reset(struct omap_uart_state *uart)
169 struct plat_serial8250_port *p = uart->p;
171 serial_write_reg(p, UART_OMAP_MDR1, 0x07);
172 serial_write_reg(p, UART_OMAP_SCR, 0x08);
173 serial_write_reg(p, UART_OMAP_MDR1, 0x00);
174 serial_write_reg(p, UART_OMAP_SYSC, (0x02 << 3) | (1 << 2) | (1 << 0));
177 #if defined(CONFIG_PM) && defined(CONFIG_ARCH_OMAP3)
179 static void omap_uart_save_context(struct omap_uart_state *uart)
182 struct plat_serial8250_port *p = uart->p;
184 if (!enable_off_mode)
187 lcr = serial_read_reg(p, UART_LCR);
188 serial_write_reg(p, UART_LCR, 0xBF);
189 uart->dll = serial_read_reg(p, UART_DLL);
190 uart->dlh = serial_read_reg(p, UART_DLM);
191 serial_write_reg(p, UART_LCR, lcr);
192 uart->ier = serial_read_reg(p, UART_IER);
193 uart->sysc = serial_read_reg(p, UART_OMAP_SYSC);
194 uart->scr = serial_read_reg(p, UART_OMAP_SCR);
195 uart->wer = serial_read_reg(p, UART_OMAP_WER);
197 uart->context_valid = 1;
200 static void omap_uart_restore_context(struct omap_uart_state *uart)
203 struct plat_serial8250_port *p = uart->p;
205 if (!enable_off_mode)
208 if (!uart->context_valid)
211 uart->context_valid = 0;
213 serial_write_reg(p, UART_OMAP_MDR1, 0x7);
214 serial_write_reg(p, UART_LCR, 0xBF); /* Config B mode */
215 efr = serial_read_reg(p, UART_EFR);
216 serial_write_reg(p, UART_EFR, UART_EFR_ECB);
217 serial_write_reg(p, UART_LCR, 0x0); /* Operational mode */
218 serial_write_reg(p, UART_IER, 0x0);
219 serial_write_reg(p, UART_LCR, 0xBF); /* Config B mode */
220 serial_write_reg(p, UART_DLL, uart->dll);
221 serial_write_reg(p, UART_DLM, uart->dlh);
222 serial_write_reg(p, UART_LCR, 0x0); /* Operational mode */
223 serial_write_reg(p, UART_IER, uart->ier);
224 serial_write_reg(p, UART_FCR, 0xA1);
225 serial_write_reg(p, UART_LCR, 0xBF); /* Config B mode */
226 serial_write_reg(p, UART_EFR, efr);
227 serial_write_reg(p, UART_LCR, UART_LCR_WLEN8);
228 serial_write_reg(p, UART_OMAP_SCR, uart->scr);
229 serial_write_reg(p, UART_OMAP_WER, uart->wer);
230 serial_write_reg(p, UART_OMAP_SYSC, uart->sysc);
231 serial_write_reg(p, UART_OMAP_MDR1, 0x00); /* UART 16x mode */
234 static inline void omap_uart_save_context(struct omap_uart_state *uart) {}
235 static inline void omap_uart_restore_context(struct omap_uart_state *uart) {}
236 #endif /* CONFIG_PM && CONFIG_ARCH_OMAP3 */
238 static inline void omap_uart_enable_clocks(struct omap_uart_state *uart)
243 clk_enable(uart->ick);
244 clk_enable(uart->fck);
246 omap_uart_restore_context(uart);
251 static inline void omap_uart_disable_clocks(struct omap_uart_state *uart)
256 omap_uart_save_context(uart);
258 clk_disable(uart->ick);
259 clk_disable(uart->fck);
262 static void omap_uart_enable_wakeup(struct omap_uart_state *uart)
264 /* Set wake-enable bit */
265 if (uart->wk_en && uart->wk_mask) {
266 u32 v = __raw_readl(uart->wk_en);
268 __raw_writel(v, uart->wk_en);
271 /* Ensure IOPAD wake-enables are set */
272 if (cpu_is_omap34xx() && uart->padconf) {
273 u16 v = omap_ctrl_readw(uart->padconf);
274 v |= OMAP3_PADCONF_WAKEUPENABLE0;
275 omap_ctrl_writew(v, uart->padconf);
279 static void omap_uart_disable_wakeup(struct omap_uart_state *uart)
281 /* Clear wake-enable bit */
282 if (uart->wk_en && uart->wk_mask) {
283 u32 v = __raw_readl(uart->wk_en);
285 __raw_writel(v, uart->wk_en);
288 /* Ensure IOPAD wake-enables are cleared */
289 if (cpu_is_omap34xx() && uart->padconf) {
290 u16 v = omap_ctrl_readw(uart->padconf);
291 v &= ~OMAP3_PADCONF_WAKEUPENABLE0;
292 omap_ctrl_writew(v, uart->padconf);
296 static void omap_uart_smart_idle_enable(struct omap_uart_state *uart,
299 struct plat_serial8250_port *p = uart->p;
302 sysc = serial_read_reg(p, UART_OMAP_SYSC) & 0x7;
308 serial_write_reg(p, UART_OMAP_SYSC, sysc);
311 static void omap_uart_block_sleep(struct omap_uart_state *uart)
313 omap_uart_enable_clocks(uart);
315 omap_uart_smart_idle_enable(uart, 0);
318 mod_timer(&uart->timer, jiffies + uart->timeout);
320 del_timer(&uart->timer);
323 static void omap_uart_allow_sleep(struct omap_uart_state *uart)
325 if (device_may_wakeup(&uart->pdev.dev))
326 omap_uart_enable_wakeup(uart);
328 omap_uart_disable_wakeup(uart);
333 omap_uart_smart_idle_enable(uart, 1);
335 del_timer(&uart->timer);
338 static void omap_uart_idle_timer(unsigned long data)
340 struct omap_uart_state *uart = (struct omap_uart_state *)data;
342 omap_uart_allow_sleep(uart);
345 void omap_uart_prepare_idle(int num)
347 struct omap_uart_state *uart;
349 list_for_each_entry(uart, &uart_list, node) {
350 if (num == uart->num && uart->can_sleep) {
351 omap_uart_disable_clocks(uart);
357 void omap_uart_resume_idle(int num)
359 struct omap_uart_state *uart;
361 list_for_each_entry(uart, &uart_list, node) {
362 if (num == uart->num) {
363 omap_uart_enable_clocks(uart);
365 /* Check for IO pad wakeup */
366 if (cpu_is_omap34xx() && uart->padconf) {
367 u16 p = omap_ctrl_readw(uart->padconf);
369 if (p & OMAP3_PADCONF_WAKEUPEVENT0)
370 omap_uart_block_sleep(uart);
373 /* Check for normal UART wakeup */
374 if (__raw_readl(uart->wk_st) & uart->wk_mask)
375 omap_uart_block_sleep(uart);
381 void omap_uart_prepare_suspend(void)
383 struct omap_uart_state *uart;
385 list_for_each_entry(uart, &uart_list, node) {
386 omap_uart_allow_sleep(uart);
390 int omap_uart_can_sleep(void)
392 struct omap_uart_state *uart;
395 list_for_each_entry(uart, &uart_list, node) {
399 if (!uart->can_sleep) {
404 /* This UART can now safely sleep. */
405 omap_uart_allow_sleep(uart);
412 * omap_uart_interrupt()
414 * This handler is used only to detect that *any* UART interrupt has
415 * occurred. It does _nothing_ to handle the interrupt. Rather,
416 * any UART interrupt will trigger the inactivity timer so the
417 * UART will not idle or sleep for its timeout period.
420 static irqreturn_t omap_uart_interrupt(int irq, void *dev_id)
422 struct omap_uart_state *uart = dev_id;
424 omap_uart_block_sleep(uart);
429 static void omap_uart_idle_init(struct omap_uart_state *uart)
431 struct plat_serial8250_port *p = uart->p;
435 uart->timeout = DEFAULT_TIMEOUT;
436 setup_timer(&uart->timer, omap_uart_idle_timer,
437 (unsigned long) uart);
439 mod_timer(&uart->timer, jiffies + uart->timeout);
440 omap_uart_smart_idle_enable(uart, 0);
442 if (cpu_is_omap34xx()) {
443 u32 mod = (uart->num == 2) ? OMAP3430_PER_MOD : CORE_MOD;
447 uart->wk_en = OMAP34XX_PRM_REGADDR(mod, PM_WKEN1);
448 uart->wk_st = OMAP34XX_PRM_REGADDR(mod, PM_WKST1);
451 wk_mask = OMAP3430_ST_UART1_MASK;
455 wk_mask = OMAP3430_ST_UART2_MASK;
459 wk_mask = OMAP3430_ST_UART3_MASK;
463 uart->wk_mask = wk_mask;
464 uart->padconf = padconf;
465 } else if (cpu_is_omap24xx()) {
468 if (cpu_is_omap2430()) {
469 uart->wk_en = OMAP2430_PRM_REGADDR(CORE_MOD, PM_WKEN1);
470 uart->wk_st = OMAP2430_PRM_REGADDR(CORE_MOD, PM_WKST1);
471 } else if (cpu_is_omap2420()) {
472 uart->wk_en = OMAP2420_PRM_REGADDR(CORE_MOD, PM_WKEN1);
473 uart->wk_st = OMAP2420_PRM_REGADDR(CORE_MOD, PM_WKST1);
477 wk_mask = OMAP24XX_ST_UART1_MASK;
480 wk_mask = OMAP24XX_ST_UART2_MASK;
483 wk_mask = OMAP24XX_ST_UART3_MASK;
486 uart->wk_mask = wk_mask;
494 p->irqflags |= IRQF_SHARED;
495 ret = request_irq(p->irq, omap_uart_interrupt, IRQF_SHARED,
496 "serial idle", (void *)uart);
500 void omap_uart_enable_irqs(int enable)
503 struct omap_uart_state *uart;
505 list_for_each_entry(uart, &uart_list, node) {
507 ret = request_irq(uart->p->irq, omap_uart_interrupt,
508 IRQF_SHARED, "serial idle", (void *)uart);
510 free_irq(uart->p->irq, (void *)uart);
514 static ssize_t sleep_timeout_show(struct device *dev,
515 struct device_attribute *attr,
518 struct platform_device *pdev = container_of(dev,
519 struct platform_device, dev);
520 struct omap_uart_state *uart = container_of(pdev,
521 struct omap_uart_state, pdev);
523 return sprintf(buf, "%u\n", uart->timeout / HZ);
526 static ssize_t sleep_timeout_store(struct device *dev,
527 struct device_attribute *attr,
528 const char *buf, size_t n)
530 struct platform_device *pdev = container_of(dev,
531 struct platform_device, dev);
532 struct omap_uart_state *uart = container_of(pdev,
533 struct omap_uart_state, pdev);
536 if (sscanf(buf, "%u", &value) != 1) {
537 printk(KERN_ERR "sleep_timeout_store: Invalid value\n");
541 uart->timeout = value * HZ;
543 mod_timer(&uart->timer, jiffies + uart->timeout);
545 /* A zero value means disable timeout feature */
546 omap_uart_block_sleep(uart);
551 DEVICE_ATTR(sleep_timeout, 0644, sleep_timeout_show, sleep_timeout_store);
552 #define DEV_CREATE_FILE(dev, attr) WARN_ON(device_create_file(dev, attr))
554 static inline void omap_uart_idle_init(struct omap_uart_state *uart) {}
555 #define DEV_CREATE_FILE(dev, attr)
556 #endif /* CONFIG_PM */
558 static struct omap_uart_state omap_uart[] = {
561 .name = "serial8250",
562 .id = PLAT8250_DEV_PLATFORM,
564 .platform_data = serial_platform_data0,
569 .name = "serial8250",
570 .id = PLAT8250_DEV_PLATFORM1,
572 .platform_data = serial_platform_data1,
577 .name = "serial8250",
578 .id = PLAT8250_DEV_PLATFORM2,
580 .platform_data = serial_platform_data2,
584 #ifdef CONFIG_ARCH_OMAP4
587 .name = "serial8250",
590 .platform_data = serial_platform_data3,
598 * Override the default 8250 read handler: mem_serial_in()
599 * Empty RX fifo read causes an abort on omap3630 and omap4
600 * This function makes sure that an empty rx fifo is not read on these silicons
601 * (OMAP1/2/3430 are not affected)
603 static unsigned int serial_in_override(struct uart_port *up, int offset)
605 if (UART_RX == offset) {
607 lsr = __serial_read_reg(up, UART_LSR);
608 if (!(lsr & UART_LSR_DR))
612 return __serial_read_reg(up, offset);
615 void __init omap_serial_early_init(void)
621 * Make sure the serial ports are muxed on at this point.
622 * You have to mux them off in device drivers later on
626 for (i = 0; i < ARRAY_SIZE(omap_uart); i++) {
627 struct omap_uart_state *uart = &omap_uart[i];
628 struct platform_device *pdev = &uart->pdev;
629 struct device *dev = &pdev->dev;
630 struct plat_serial8250_port *p = dev->platform_data;
633 * Module 4KB + L4 interconnect 4KB
634 * Static mapping, never released
636 p->membase = ioremap(p->mapbase, SZ_8K);
638 printk(KERN_ERR "ioremap failed for uart%i\n", i + 1);
642 sprintf(name, "uart%d_ick", i+1);
643 uart->ick = clk_get(NULL, name);
644 if (IS_ERR(uart->ick)) {
645 printk(KERN_ERR "Could not get uart%d_ick\n", i+1);
649 sprintf(name, "uart%d_fck", i+1);
650 uart->fck = clk_get(NULL, name);
651 if (IS_ERR(uart->fck)) {
652 printk(KERN_ERR "Could not get uart%d_fck\n", i+1);
656 /* FIXME: Remove this once the clkdev is ready */
657 if (!cpu_is_omap44xx()) {
658 if (!uart->ick || !uart->fck)
663 p->private_data = uart;
666 if (cpu_is_omap44xx())
672 * omap_serial_init_port() - initialize single serial port
673 * @port: serial port number (0-3)
675 * This function initialies serial driver for given @port only.
676 * Platforms can call this function instead of omap_serial_init()
677 * if they don't plan to use all available UARTs as serial ports.
679 * Don't mix calls to omap_serial_init_port() and omap_serial_init(),
680 * use only one of the two.
682 void __init omap_serial_init_port(int port)
684 struct omap_uart_state *uart;
685 struct platform_device *pdev;
689 BUG_ON(port >= ARRAY_SIZE(omap_uart));
691 uart = &omap_uart[port];
695 omap_uart_enable_clocks(uart);
697 omap_uart_reset(uart);
698 omap_uart_idle_init(uart);
700 list_add_tail(&uart->node, &uart_list);
702 if (WARN_ON(platform_device_register(pdev)))
705 if ((cpu_is_omap34xx() && uart->padconf) ||
706 (uart->wk_en && uart->wk_mask)) {
707 device_init_wakeup(dev, true);
708 DEV_CREATE_FILE(dev, &dev_attr_sleep_timeout);
711 /* omap44xx: Never read empty UART fifo
712 * omap3xxx: Never read empty UART fifo on UARTs
715 if (cpu_is_omap44xx())
716 uart->p->serial_in = serial_in_override;
717 else if ((serial_read_reg(uart->p, UART_OMAP_MVER) & 0xFF)
718 >= UART_OMAP_NO_EMPTY_FIFO_READ_IP_REV)
719 uart->p->serial_in = serial_in_override;
723 * omap_serial_init() - intialize all supported serial ports
725 * Initializes all available UARTs as serial ports. Platforms
726 * can call this function when they want to have default behaviour
727 * for serial ports (e.g initialize them all as serial ports).
729 void __init omap_serial_init(void)
733 for (i = 0; i < ARRAY_SIZE(omap_uart); i++)
734 omap_serial_init_port(i);