Add lpuart kernel driver
[barrelfish] / kernel / arch / arm / lpuart.c
1 /**
2  * \file
3  * \brief ARM pl011 UART kernel-level driver.
4  */
5
6 /*
7  * Copyright (c) 2007, 2008, ETH Zurich.
8  * All rights reserved.
9  *
10  * This file is distributed under the terms in the attached LICENSE file.
11  * If you do not find this file, copies can be found by writing to:
12  * ETH Zurich D-INFK, Universitaetstrasse 6, CH-8092 Zurich. Attn: Systems Group.
13  */
14
15 #include <arch/arm/lpuart.h>
16 #include <kernel.h>
17 #include <paging_kernel_arch.h>
18 #include <arch/arm/arm.h>
19 #include <arch/arm/platform.h>
20 #include <serial.h>
21 #include <dev/lpuart_dev.h>
22
23 static lpuart_t uarts[LPUART_MAX_PORTS];
24
25 // Mask all interrupts in the IMSC register
26 #define INTERRUPTS_MASK         0
27
28 #define MSG(format, ...) printk( LOG_NOTE, "lpuart: "format, ## __VA_ARGS__ )
29
30 /**
31  * \brief Configure the serial interface, from a caller that knows
32  * that this is a bunch of PL011s, and furthermore where they are in
33  * the physical address space.
34  */
35 errval_t serial_early_init(unsigned n)
36 {
37     assert(!paging_mmu_enabled());
38     assert(n < serial_num_physical_ports);
39
40     lpuart_initialize(&uarts[n],
41         (mackerel_addr_t)local_phys_to_mem(platform_uart_base[n]));
42
43     // Make sure that the UART is enabled and transmitting - not all platforms
44     // do this for us.
45     lpuart_baud_rawwr(&uarts[n], 0x402008b);
46     lpuart_ctrl_te_wrf(&uarts[n], 1);
47     lpuart_ctrl_re_wrf(&uarts[n], 1);
48
49     return SYS_ERR_OK;
50 }
51
52 /**
53  * \brief Configure the serial interface, from a caller that knows
54  * that this is a bunch of PL011s, and furthermore where they are in
55  * the physical address space.
56  */
57 errval_t serial_early_init_mmu_enabled(unsigned n)
58 {
59     assert(paging_mmu_enabled());
60     assert(n < serial_num_physical_ports);
61
62     lpuart_initialize(&uarts[n],
63         (mackerel_addr_t)local_phys_to_mem(platform_uart_base[n]));
64
65     // Make sure that the UART is enabled and transmitting - not all platforms
66     // do this for us.
67     lpuart_baud_rawwr(&uarts[n], 0x402008b);
68     lpuart_ctrl_te_wrf(&uarts[n], 1);
69     lpuart_ctrl_re_wrf(&uarts[n], 1);
70
71     return SYS_ERR_OK;
72 }
73 /*
74  * \brief Initialize a serial port.  The MMU is turned on.
75  */
76 void lpuart_init(unsigned port, lvaddr_t base, bool hwinit)
77 {
78     assert(paging_mmu_enabled());
79     assert(port < serial_num_physical_ports);
80
81     lpuart_t *u = &uarts[port];
82
83     // [Re]initialize the Mackerel state for the UART
84     lpuart_initialize(u, (mackerel_addr_t) base);
85
86     if (hwinit) {
87         lpuart_baud_rawwr(u, 0x402008b);
88         lpuart_ctrl_t ctrl = (lpuart_ctrl_t)0;
89         ctrl = lpuart_ctrl_te_insert(ctrl, 1);
90         ctrl = lpuart_ctrl_re_insert(ctrl, 1);
91         lpuart_ctrl_rawwr(u, ctrl);
92
93         //TODO: Figure out more advanced configuration (FIFO etc.)
94     }
95 }
96
97 /*
98  * \brief Put a character to the port
99  */
100 void serial_putchar(unsigned port, char c)
101 {
102     assert(port < LPUART_MAX_PORTS);
103     lpuart_t *u = &uarts[port];
104     assert(u->base != 0);
105
106     while(lpuart_stat_tdre_rdf(u) == 0);
107     lpuart_data_buf_wrf(u, c);
108 }
109
110 /*
111  * \brief Read a character from a port
112  */
113 char serial_getchar(unsigned port)
114 {
115     assert(port < LPUART_MAX_PORTS);
116     lpuart_t *u = &uarts[port];
117     assert(u->base != 0);
118
119     /* Wait for data. */
120     while(lpuart_stat_rdrf_rdf(u) == 0);
121
122     return (char)lpuart_data_buf_rdf(u);
123 }