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
[] = {
83 .mapbase
= OMAP_UART1_BASE
,
85 .flags
= UPF_BOOT_AUTOCONF
,
88 .uartclk
= OMAP24XX_BASE_BAUD
* 16,
94 static struct plat_serial8250_port serial_platform_data1
[] = {
96 .mapbase
= OMAP_UART2_BASE
,
98 .flags
= UPF_BOOT_AUTOCONF
,
101 .uartclk
= OMAP24XX_BASE_BAUD
* 16,
107 static struct plat_serial8250_port serial_platform_data2
[] = {
109 .mapbase
= OMAP_UART3_BASE
,
111 .flags
= UPF_BOOT_AUTOCONF
,
114 .uartclk
= OMAP24XX_BASE_BAUD
* 16,
120 #ifdef CONFIG_ARCH_OMAP4
121 static struct plat_serial8250_port serial_platform_data3
[] = {
123 .mapbase
= OMAP_UART4_BASE
,
125 .flags
= UPF_BOOT_AUTOCONF
,
128 .uartclk
= OMAP24XX_BASE_BAUD
* 16,
134 static inline unsigned int __serial_read_reg(struct uart_port
*up
,
137 offset
<<= up
->regshift
;
138 return (unsigned int)__raw_readb(up
->membase
+ offset
);
141 static inline unsigned int serial_read_reg(struct plat_serial8250_port
*up
,
144 offset
<<= up
->regshift
;
145 return (unsigned int)__raw_readb(up
->membase
+ offset
);
148 static inline void serial_write_reg(struct plat_serial8250_port
*p
, int offset
,
151 offset
<<= p
->regshift
;
152 __raw_writeb(value
, p
->membase
+ offset
);
156 * Internal UARTs need to be initialized for the 8250 autoconfig to work
157 * properly. Note that the TX watermark initialization may not be needed
158 * once the 8250.c watermark handling code is merged.
160 static inline void __init
omap_uart_reset(struct omap_uart_state
*uart
)
162 struct plat_serial8250_port
*p
= uart
->p
;
164 serial_write_reg(p
, UART_OMAP_MDR1
, 0x07);
165 serial_write_reg(p
, UART_OMAP_SCR
, 0x08);
166 serial_write_reg(p
, UART_OMAP_MDR1
, 0x00);
167 serial_write_reg(p
, UART_OMAP_SYSC
, (0x02 << 3) | (1 << 2) | (1 << 0));
170 #if defined(CONFIG_PM) && defined(CONFIG_ARCH_OMAP3)
172 static void omap_uart_save_context(struct omap_uart_state
*uart
)
175 struct plat_serial8250_port
*p
= uart
->p
;
177 if (!enable_off_mode
)
180 lcr
= serial_read_reg(p
, UART_LCR
);
181 serial_write_reg(p
, UART_LCR
, 0xBF);
182 uart
->dll
= serial_read_reg(p
, UART_DLL
);
183 uart
->dlh
= serial_read_reg(p
, UART_DLM
);
184 serial_write_reg(p
, UART_LCR
, lcr
);
185 uart
->ier
= serial_read_reg(p
, UART_IER
);
186 uart
->sysc
= serial_read_reg(p
, UART_OMAP_SYSC
);
187 uart
->scr
= serial_read_reg(p
, UART_OMAP_SCR
);
188 uart
->wer
= serial_read_reg(p
, UART_OMAP_WER
);
190 uart
->context_valid
= 1;
193 static void omap_uart_restore_context(struct omap_uart_state
*uart
)
196 struct plat_serial8250_port
*p
= uart
->p
;
198 if (!enable_off_mode
)
201 if (!uart
->context_valid
)
204 uart
->context_valid
= 0;
206 serial_write_reg(p
, UART_OMAP_MDR1
, 0x7);
207 serial_write_reg(p
, UART_LCR
, 0xBF); /* Config B mode */
208 efr
= serial_read_reg(p
, UART_EFR
);
209 serial_write_reg(p
, UART_EFR
, UART_EFR_ECB
);
210 serial_write_reg(p
, UART_LCR
, 0x0); /* Operational mode */
211 serial_write_reg(p
, UART_IER
, 0x0);
212 serial_write_reg(p
, UART_LCR
, 0xBF); /* Config B mode */
213 serial_write_reg(p
, UART_DLL
, uart
->dll
);
214 serial_write_reg(p
, UART_DLM
, uart
->dlh
);
215 serial_write_reg(p
, UART_LCR
, 0x0); /* Operational mode */
216 serial_write_reg(p
, UART_IER
, uart
->ier
);
217 serial_write_reg(p
, UART_FCR
, 0xA1);
218 serial_write_reg(p
, UART_LCR
, 0xBF); /* Config B mode */
219 serial_write_reg(p
, UART_EFR
, efr
);
220 serial_write_reg(p
, UART_LCR
, UART_LCR_WLEN8
);
221 serial_write_reg(p
, UART_OMAP_SCR
, uart
->scr
);
222 serial_write_reg(p
, UART_OMAP_WER
, uart
->wer
);
223 serial_write_reg(p
, UART_OMAP_SYSC
, uart
->sysc
);
224 serial_write_reg(p
, UART_OMAP_MDR1
, 0x00); /* UART 16x mode */
227 static inline void omap_uart_save_context(struct omap_uart_state
*uart
) {}
228 static inline void omap_uart_restore_context(struct omap_uart_state
*uart
) {}
229 #endif /* CONFIG_PM && CONFIG_ARCH_OMAP3 */
231 static inline void omap_uart_enable_clocks(struct omap_uart_state
*uart
)
236 clk_enable(uart
->ick
);
237 clk_enable(uart
->fck
);
239 omap_uart_restore_context(uart
);
244 static inline void omap_uart_disable_clocks(struct omap_uart_state
*uart
)
249 omap_uart_save_context(uart
);
251 clk_disable(uart
->ick
);
252 clk_disable(uart
->fck
);
255 static void omap_uart_enable_wakeup(struct omap_uart_state
*uart
)
257 /* Set wake-enable bit */
258 if (uart
->wk_en
&& uart
->wk_mask
) {
259 u32 v
= __raw_readl(uart
->wk_en
);
261 __raw_writel(v
, uart
->wk_en
);
264 /* Ensure IOPAD wake-enables are set */
265 if (cpu_is_omap34xx() && uart
->padconf
) {
266 u16 v
= omap_ctrl_readw(uart
->padconf
);
267 v
|= OMAP3_PADCONF_WAKEUPENABLE0
;
268 omap_ctrl_writew(v
, uart
->padconf
);
272 static void omap_uart_disable_wakeup(struct omap_uart_state
*uart
)
274 /* Clear wake-enable bit */
275 if (uart
->wk_en
&& uart
->wk_mask
) {
276 u32 v
= __raw_readl(uart
->wk_en
);
278 __raw_writel(v
, uart
->wk_en
);
281 /* Ensure IOPAD wake-enables are cleared */
282 if (cpu_is_omap34xx() && uart
->padconf
) {
283 u16 v
= omap_ctrl_readw(uart
->padconf
);
284 v
&= ~OMAP3_PADCONF_WAKEUPENABLE0
;
285 omap_ctrl_writew(v
, uart
->padconf
);
289 static void omap_uart_smart_idle_enable(struct omap_uart_state
*uart
,
292 struct plat_serial8250_port
*p
= uart
->p
;
295 sysc
= serial_read_reg(p
, UART_OMAP_SYSC
) & 0x7;
301 serial_write_reg(p
, UART_OMAP_SYSC
, sysc
);
304 static void omap_uart_block_sleep(struct omap_uart_state
*uart
)
306 omap_uart_enable_clocks(uart
);
308 omap_uart_smart_idle_enable(uart
, 0);
311 mod_timer(&uart
->timer
, jiffies
+ uart
->timeout
);
313 del_timer(&uart
->timer
);
316 static void omap_uart_allow_sleep(struct omap_uart_state
*uart
)
318 if (device_may_wakeup(&uart
->pdev
.dev
))
319 omap_uart_enable_wakeup(uart
);
321 omap_uart_disable_wakeup(uart
);
326 omap_uart_smart_idle_enable(uart
, 1);
328 del_timer(&uart
->timer
);
331 static void omap_uart_idle_timer(unsigned long data
)
333 struct omap_uart_state
*uart
= (struct omap_uart_state
*)data
;
335 omap_uart_allow_sleep(uart
);
338 void omap_uart_prepare_idle(int num
)
340 struct omap_uart_state
*uart
;
342 list_for_each_entry(uart
, &uart_list
, node
) {
343 if (num
== uart
->num
&& uart
->can_sleep
) {
344 omap_uart_disable_clocks(uart
);
350 void omap_uart_resume_idle(int num
)
352 struct omap_uart_state
*uart
;
354 list_for_each_entry(uart
, &uart_list
, node
) {
355 if (num
== uart
->num
) {
356 omap_uart_enable_clocks(uart
);
358 /* Check for IO pad wakeup */
359 if (cpu_is_omap34xx() && uart
->padconf
) {
360 u16 p
= omap_ctrl_readw(uart
->padconf
);
362 if (p
& OMAP3_PADCONF_WAKEUPEVENT0
)
363 omap_uart_block_sleep(uart
);
366 /* Check for normal UART wakeup */
367 if (__raw_readl(uart
->wk_st
) & uart
->wk_mask
)
368 omap_uart_block_sleep(uart
);
374 void omap_uart_prepare_suspend(void)
376 struct omap_uart_state
*uart
;
378 list_for_each_entry(uart
, &uart_list
, node
) {
379 omap_uart_allow_sleep(uart
);
383 int omap_uart_can_sleep(void)
385 struct omap_uart_state
*uart
;
388 list_for_each_entry(uart
, &uart_list
, node
) {
392 if (!uart
->can_sleep
) {
397 /* This UART can now safely sleep. */
398 omap_uart_allow_sleep(uart
);
405 * omap_uart_interrupt()
407 * This handler is used only to detect that *any* UART interrupt has
408 * occurred. It does _nothing_ to handle the interrupt. Rather,
409 * any UART interrupt will trigger the inactivity timer so the
410 * UART will not idle or sleep for its timeout period.
413 static irqreturn_t
omap_uart_interrupt(int irq
, void *dev_id
)
415 struct omap_uart_state
*uart
= dev_id
;
417 omap_uart_block_sleep(uart
);
422 static void omap_uart_idle_init(struct omap_uart_state
*uart
)
424 struct plat_serial8250_port
*p
= uart
->p
;
428 uart
->timeout
= DEFAULT_TIMEOUT
;
429 setup_timer(&uart
->timer
, omap_uart_idle_timer
,
430 (unsigned long) uart
);
432 mod_timer(&uart
->timer
, jiffies
+ uart
->timeout
);
433 omap_uart_smart_idle_enable(uart
, 0);
435 if (cpu_is_omap34xx()) {
436 u32 mod
= (uart
->num
== 2) ? OMAP3430_PER_MOD
: CORE_MOD
;
440 uart
->wk_en
= OMAP34XX_PRM_REGADDR(mod
, PM_WKEN1
);
441 uart
->wk_st
= OMAP34XX_PRM_REGADDR(mod
, PM_WKST1
);
444 wk_mask
= OMAP3430_ST_UART1_MASK
;
448 wk_mask
= OMAP3430_ST_UART2_MASK
;
452 wk_mask
= OMAP3430_ST_UART3_MASK
;
456 uart
->wk_mask
= wk_mask
;
457 uart
->padconf
= padconf
;
458 } else if (cpu_is_omap24xx()) {
461 if (cpu_is_omap2430()) {
462 uart
->wk_en
= OMAP2430_PRM_REGADDR(CORE_MOD
, PM_WKEN1
);
463 uart
->wk_st
= OMAP2430_PRM_REGADDR(CORE_MOD
, PM_WKST1
);
464 } else if (cpu_is_omap2420()) {
465 uart
->wk_en
= OMAP2420_PRM_REGADDR(CORE_MOD
, PM_WKEN1
);
466 uart
->wk_st
= OMAP2420_PRM_REGADDR(CORE_MOD
, PM_WKST1
);
470 wk_mask
= OMAP24XX_ST_UART1_MASK
;
473 wk_mask
= OMAP24XX_ST_UART2_MASK
;
476 wk_mask
= OMAP24XX_ST_UART3_MASK
;
479 uart
->wk_mask
= wk_mask
;
487 p
->irqflags
|= IRQF_SHARED
;
488 ret
= request_irq(p
->irq
, omap_uart_interrupt
, IRQF_SHARED
,
489 "serial idle", (void *)uart
);
493 void omap_uart_enable_irqs(int enable
)
496 struct omap_uart_state
*uart
;
498 list_for_each_entry(uart
, &uart_list
, node
) {
500 ret
= request_irq(uart
->p
->irq
, omap_uart_interrupt
,
501 IRQF_SHARED
, "serial idle", (void *)uart
);
503 free_irq(uart
->p
->irq
, (void *)uart
);
507 static ssize_t
sleep_timeout_show(struct device
*dev
,
508 struct device_attribute
*attr
,
511 struct platform_device
*pdev
= container_of(dev
,
512 struct platform_device
, dev
);
513 struct omap_uart_state
*uart
= container_of(pdev
,
514 struct omap_uart_state
, pdev
);
516 return sprintf(buf
, "%u\n", uart
->timeout
/ HZ
);
519 static ssize_t
sleep_timeout_store(struct device
*dev
,
520 struct device_attribute
*attr
,
521 const char *buf
, size_t n
)
523 struct platform_device
*pdev
= container_of(dev
,
524 struct platform_device
, dev
);
525 struct omap_uart_state
*uart
= container_of(pdev
,
526 struct omap_uart_state
, pdev
);
529 if (sscanf(buf
, "%u", &value
) != 1) {
530 printk(KERN_ERR
"sleep_timeout_store: Invalid value\n");
534 uart
->timeout
= value
* HZ
;
536 mod_timer(&uart
->timer
, jiffies
+ uart
->timeout
);
538 /* A zero value means disable timeout feature */
539 omap_uart_block_sleep(uart
);
544 DEVICE_ATTR(sleep_timeout
, 0644, sleep_timeout_show
, sleep_timeout_store
);
545 #define DEV_CREATE_FILE(dev, attr) WARN_ON(device_create_file(dev, attr))
547 static inline void omap_uart_idle_init(struct omap_uart_state
*uart
) {}
548 #define DEV_CREATE_FILE(dev, attr)
549 #endif /* CONFIG_PM */
551 static struct omap_uart_state omap_uart
[] = {
554 .name
= "serial8250",
555 .id
= PLAT8250_DEV_PLATFORM
,
557 .platform_data
= serial_platform_data0
,
562 .name
= "serial8250",
563 .id
= PLAT8250_DEV_PLATFORM1
,
565 .platform_data
= serial_platform_data1
,
570 .name
= "serial8250",
571 .id
= PLAT8250_DEV_PLATFORM2
,
573 .platform_data
= serial_platform_data2
,
577 #ifdef CONFIG_ARCH_OMAP4
580 .name
= "serial8250",
583 .platform_data
= serial_platform_data3
,
591 * Override the default 8250 read handler: mem_serial_in()
592 * Empty RX fifo read causes an abort on omap3630 and omap4
593 * This function makes sure that an empty rx fifo is not read on these silicons
594 * (OMAP1/2/3430 are not affected)
596 static unsigned int serial_in_override(struct uart_port
*up
, int offset
)
598 if (UART_RX
== offset
) {
600 lsr
= __serial_read_reg(up
, UART_LSR
);
601 if (!(lsr
& UART_LSR_DR
))
605 return __serial_read_reg(up
, offset
);
608 void __init
omap_serial_early_init(void)
614 * Make sure the serial ports are muxed on at this point.
615 * You have to mux them off in device drivers later on
619 for (i
= 0; i
< ARRAY_SIZE(omap_uart
); i
++) {
620 struct omap_uart_state
*uart
= &omap_uart
[i
];
621 struct platform_device
*pdev
= &uart
->pdev
;
622 struct device
*dev
= &pdev
->dev
;
623 struct plat_serial8250_port
*p
= dev
->platform_data
;
626 * Module 4KB + L4 interconnect 4KB
627 * Static mapping, never released
629 p
->membase
= ioremap(p
->mapbase
, SZ_8K
);
631 printk(KERN_ERR
"ioremap failed for uart%i\n", i
+ 1);
635 sprintf(name
, "uart%d_ick", i
+1);
636 uart
->ick
= clk_get(NULL
, name
);
637 if (IS_ERR(uart
->ick
)) {
638 printk(KERN_ERR
"Could not get uart%d_ick\n", i
+1);
642 sprintf(name
, "uart%d_fck", i
+1);
643 uart
->fck
= clk_get(NULL
, name
);
644 if (IS_ERR(uart
->fck
)) {
645 printk(KERN_ERR
"Could not get uart%d_fck\n", i
+1);
649 /* FIXME: Remove this once the clkdev is ready */
650 if (!cpu_is_omap44xx()) {
651 if (!uart
->ick
|| !uart
->fck
)
656 p
->private_data
= uart
;
659 if (cpu_is_omap44xx())
665 * omap_serial_init_port() - initialize single serial port
666 * @port: serial port number (0-3)
668 * This function initialies serial driver for given @port only.
669 * Platforms can call this function instead of omap_serial_init()
670 * if they don't plan to use all available UARTs as serial ports.
672 * Don't mix calls to omap_serial_init_port() and omap_serial_init(),
673 * use only one of the two.
675 void __init
omap_serial_init_port(int port
)
677 struct omap_uart_state
*uart
;
678 struct platform_device
*pdev
;
682 BUG_ON(port
>= ARRAY_SIZE(omap_uart
));
684 uart
= &omap_uart
[port
];
688 omap_uart_enable_clocks(uart
);
690 omap_uart_reset(uart
);
691 omap_uart_idle_init(uart
);
693 list_add_tail(&uart
->node
, &uart_list
);
695 if (WARN_ON(platform_device_register(pdev
)))
698 if ((cpu_is_omap34xx() && uart
->padconf
) ||
699 (uart
->wk_en
&& uart
->wk_mask
)) {
700 device_init_wakeup(dev
, true);
701 DEV_CREATE_FILE(dev
, &dev_attr_sleep_timeout
);
704 /* omap44xx: Never read empty UART fifo
705 * omap3xxx: Never read empty UART fifo on UARTs
708 if (cpu_is_omap44xx())
709 uart
->p
->serial_in
= serial_in_override
;
710 else if ((serial_read_reg(uart
->p
, UART_OMAP_MVER
) & 0xFF)
711 >= UART_OMAP_NO_EMPTY_FIFO_READ_IP_REV
)
712 uart
->p
->serial_in
= serial_in_override
;
716 * omap_serial_init() - intialize all supported serial ports
718 * Initializes all available UARTs as serial ports. Platforms
719 * can call this function when they want to have default behaviour
720 * for serial ports (e.g initialize them all as serial ports).
722 void __init
omap_serial_init(void)
726 for (i
= 0; i
< ARRAY_SIZE(omap_uart
); i
++)
727 omap_serial_init_port(i
);