Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 1 | /* uart_console.c - UART-driven console */ |
| 2 | |
| 3 | /* |
| 4 | * Copyright (c) 2011-2012, 2014-2015 Wind River Systems, Inc. |
| 5 | * |
Javier B Perez Hernandez | f7fffae | 2015-10-06 11:00:37 -0500 | [diff] [blame] | 6 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 | * you may not use this file except in compliance with the License. |
| 8 | * You may obtain a copy of the License at |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 9 | * |
Javier B Perez Hernandez | f7fffae | 2015-10-06 11:00:37 -0500 | [diff] [blame] | 10 | * http://www.apache.org/licenses/LICENSE-2.0 |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 11 | * |
Javier B Perez Hernandez | f7fffae | 2015-10-06 11:00:37 -0500 | [diff] [blame] | 12 | * Unless required by applicable law or agreed to in writing, software |
| 13 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | * See the License for the specific language governing permissions and |
| 16 | * limitations under the License. |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 17 | */ |
| 18 | |
| 19 | /* |
Dan Kalowsky | da67b29 | 2015-10-20 09:42:33 -0700 | [diff] [blame] | 20 | * DESCRIPTION |
| 21 | * |
| 22 | * Serial console driver. |
| 23 | * Hooks into the printk and fputc (for printf) modules. Poll driven. |
Anas Nashif | ea0d0b2 | 2015-07-01 17:22:39 -0400 | [diff] [blame] | 24 | */ |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 25 | |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 26 | #include <nanokernel.h> |
Dan Kalowsky | c02dd34 | 2015-05-28 10:56:47 -0700 | [diff] [blame] | 27 | #include <arch/cpu.h> |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 28 | |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 29 | #include <stdio.h> |
| 30 | #include <stdint.h> |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 31 | #include <errno.h> |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 32 | |
Daniel Leung | ad2d296 | 2015-08-12 10:17:35 -0700 | [diff] [blame] | 33 | #include <device.h> |
| 34 | #include <init.h> |
| 35 | |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 36 | #include <board.h> |
Tomasz Bursztyka | 17e06fb | 2015-10-15 09:48:03 +0300 | [diff] [blame] | 37 | #include <uart.h> |
Tomasz Bursztyka | ae09a48 | 2015-04-23 13:12:51 +0300 | [diff] [blame] | 38 | #include <console/uart_console.h> |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 39 | #include <toolchain.h> |
| 40 | #include <sections.h> |
| 41 | |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 42 | #if 0 /* NOTUSED */ |
Anas Nashif | ea0d0b2 | 2015-07-01 17:22:39 -0400 | [diff] [blame] | 43 | /** |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 44 | * |
Anas Nashif | f367f07 | 2015-07-01 17:51:40 -0400 | [diff] [blame] | 45 | * @brief Get a character from UART |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 46 | * |
Anas Nashif | 1362e3c | 2015-07-01 17:29:04 -0400 | [diff] [blame] | 47 | * @return the character or EOF if nothing present |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 48 | */ |
| 49 | |
| 50 | static int consoleIn(void) |
| 51 | { |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 52 | #ifdef UART_CONSOLE_DEV |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 53 | unsigned char c; |
Dan Kalowsky | da67b29 | 2015-10-20 09:42:33 -0700 | [diff] [blame] | 54 | |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 55 | if (uart_poll_in(UART_CONSOLE_DEV, &c) < 0) |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 56 | return EOF; |
| 57 | else |
| 58 | return (int)c; |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 59 | #else |
| 60 | return 0; |
| 61 | #endif |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 62 | } |
| 63 | #endif |
| 64 | |
| 65 | #if defined(CONFIG_PRINTK) || defined(CONFIG_STDOUT_CONSOLE) |
Anas Nashif | ea0d0b2 | 2015-07-01 17:22:39 -0400 | [diff] [blame] | 66 | /** |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 67 | * |
Anas Nashif | f367f07 | 2015-07-01 17:51:40 -0400 | [diff] [blame] | 68 | * @brief Output one character to UART |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 69 | * |
| 70 | * Outputs both line feed and carriage return in the case of a '\n'. |
| 71 | * |
Anas Nashif | 1362e3c | 2015-07-01 17:29:04 -0400 | [diff] [blame] | 72 | * @return The character passed as input. |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 73 | */ |
| 74 | |
| 75 | static int consoleOut(int c /* character to output */ |
| 76 | ) |
| 77 | { |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 78 | #ifdef UART_CONSOLE_DEV |
| 79 | uart_poll_out(UART_CONSOLE_DEV, (unsigned char)c); |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 80 | if ('\n' == c) { |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 81 | uart_poll_out(UART_CONSOLE_DEV, (unsigned char)'\r'); |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 82 | } |
| 83 | return c; |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 84 | #else |
| 85 | return 0; |
| 86 | #endif |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 87 | } |
| 88 | #endif |
| 89 | |
| 90 | #if defined(CONFIG_STDOUT_CONSOLE) |
| 91 | extern void __stdout_hook_install(int (*hook)(int)); |
| 92 | #else |
| 93 | #define __stdout_hook_install(x) \ |
| 94 | do {/* nothing */ \ |
| 95 | } while ((0)) |
| 96 | #endif |
| 97 | |
| 98 | #if defined(CONFIG_PRINTK) |
| 99 | extern void __printk_hook_install(int (*fn)(int)); |
| 100 | #else |
| 101 | #define __printk_hook_install(x) \ |
| 102 | do {/* nothing */ \ |
| 103 | } while ((0)) |
| 104 | #endif |
| 105 | |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 106 | #if defined(CONFIG_CONSOLE_HANDLER) |
Dan Kalowsky | 2e93848 | 2015-10-14 16:12:09 -0700 | [diff] [blame] | 107 | static size_t pos; |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 108 | |
| 109 | static struct nano_fifo *avail_queue; |
| 110 | static struct nano_fifo *lines_queue; |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 111 | |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 112 | static int read_uart(struct device *uart, uint8_t *buf, unsigned int size) |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 113 | { |
| 114 | int rx; |
| 115 | |
| 116 | rx = uart_fifo_read(uart, buf, size); |
| 117 | if (rx < 0) { |
| 118 | /* Overrun issue. Stop the UART */ |
| 119 | uart_irq_rx_disable(uart); |
| 120 | |
| 121 | return -EIO; |
| 122 | } |
| 123 | |
| 124 | return rx; |
| 125 | } |
| 126 | |
Andrei Emeltchenko | dfa5f23 | 2015-04-23 10:20:32 +0300 | [diff] [blame] | 127 | void uart_console_isr(void *unused) |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 128 | { |
| 129 | ARG_UNUSED(unused); |
| 130 | |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 131 | while (uart_irq_update(UART_CONSOLE_DEV) |
| 132 | && uart_irq_is_pending(UART_CONSOLE_DEV)) { |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 133 | /* Character(s) have been received */ |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 134 | if (uart_irq_rx_ready(UART_CONSOLE_DEV)) { |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 135 | static struct uart_console_input *cmd; |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 136 | uint8_t byte; |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 137 | int rx; |
| 138 | |
Peter Mitsis | b1c1020 | 2015-09-17 13:22:00 -0400 | [diff] [blame] | 139 | rx = read_uart(UART_CONSOLE_DEV, &byte, 1); |
| 140 | if (rx < 0) { |
| 141 | return; |
| 142 | } |
| 143 | |
| 144 | if (uart_irq_input_hook(UART_CONSOLE_DEV, byte) != 0) { |
| 145 | /* |
| 146 | * The input hook indicates that no further processing |
| 147 | * should be done by this handler. |
| 148 | */ |
| 149 | return; |
| 150 | } |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 151 | |
| 152 | if (!cmd) { |
| 153 | cmd = nano_isr_fifo_get(avail_queue); |
| 154 | if (!cmd) |
| 155 | return; |
| 156 | } |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 157 | |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 158 | /* Echo back to console */ |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 159 | uart_poll_out(UART_CONSOLE_DEV, byte); |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 160 | |
| 161 | if (byte == '\r' || byte == '\n' || |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 162 | pos == sizeof(cmd->line) - 1) { |
| 163 | cmd->line[pos] = '\0'; |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 164 | uart_poll_out(UART_CONSOLE_DEV, '\n'); |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 165 | pos = 0; |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 166 | |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 167 | nano_isr_fifo_put(lines_queue, cmd); |
| 168 | cmd = NULL; |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 169 | } else { |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 170 | cmd->line[pos++] = byte; |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | } |
| 174 | } |
| 175 | } |
| 176 | |
Dmitriy Korovkin | 8d06534 | 2015-06-04 11:42:35 -0400 | [diff] [blame] | 177 | IRQ_CONNECT_STATIC(console, CONFIG_UART_CONSOLE_IRQ, |
Dmitriy Korovkin | f142051 | 2015-11-02 18:06:08 -0500 | [diff] [blame^] | 178 | CONFIG_UART_CONSOLE_INT_PRI, uart_console_isr, 0, |
| 179 | UART_IRQ_FLAGS); |
Dmitriy Korovkin | 8d06534 | 2015-06-04 11:42:35 -0400 | [diff] [blame] | 180 | |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 181 | static void console_input_init(void) |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 182 | { |
| 183 | uint8_t c; |
| 184 | |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 185 | uart_irq_rx_disable(UART_CONSOLE_DEV); |
| 186 | uart_irq_tx_disable(UART_CONSOLE_DEV); |
Dirk Brandewie | 147d658 | 2015-10-15 08:13:50 -0700 | [diff] [blame] | 187 | IRQ_CONFIG(console, uart_irq_get(UART_CONSOLE_DEV), 0); |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 188 | irq_enable(uart_irq_get(UART_CONSOLE_DEV)); |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 189 | |
| 190 | /* Drain the fifo */ |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 191 | while (uart_irq_rx_ready(UART_CONSOLE_DEV)) { |
| 192 | uart_fifo_read(UART_CONSOLE_DEV, &c, 1); |
| 193 | } |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 194 | |
Daniel Leung | 1ad2a56 | 2015-08-05 12:13:36 -0700 | [diff] [blame] | 195 | uart_irq_rx_enable(UART_CONSOLE_DEV); |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 196 | } |
| 197 | |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 198 | void uart_register_input(struct nano_fifo *avail, struct nano_fifo *lines) |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 199 | { |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 200 | avail_queue = avail; |
| 201 | lines_queue = lines; |
| 202 | |
| 203 | console_input_init(); |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 204 | } |
| 205 | #else |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 206 | #define console_input_init(x) \ |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 207 | do {/* nothing */ \ |
| 208 | } while ((0)) |
Andrei Emeltchenko | 879541a | 2015-05-04 14:43:36 +0300 | [diff] [blame] | 209 | #define uart_register_input(x) \ |
Andrei Emeltchenko | 139c856 | 2015-04-20 11:04:22 +0300 | [diff] [blame] | 210 | do {/* nothing */ \ |
| 211 | } while ((0)) |
| 212 | #endif |
| 213 | |
Anas Nashif | ea0d0b2 | 2015-07-01 17:22:39 -0400 | [diff] [blame] | 214 | /** |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 215 | * |
Daniel Leung | ad2d296 | 2015-08-12 10:17:35 -0700 | [diff] [blame] | 216 | * @brief Install printk/stdout hook for UART console output |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 217 | * |
Anas Nashif | 1362e3c | 2015-07-01 17:29:04 -0400 | [diff] [blame] | 218 | * @return N/A |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 219 | */ |
| 220 | |
Daniel Leung | ad2d296 | 2015-08-12 10:17:35 -0700 | [diff] [blame] | 221 | void uart_console_hook_install(void) |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 222 | { |
| 223 | __stdout_hook_install(consoleOut); |
| 224 | __printk_hook_install(consoleOut); |
Inaky Perez-Gonzalez | 8ddf82c | 2015-04-10 16:44:37 -0700 | [diff] [blame] | 225 | } |
Daniel Leung | ad2d296 | 2015-08-12 10:17:35 -0700 | [diff] [blame] | 226 | |
| 227 | /** |
| 228 | * |
| 229 | * @brief Initialize one UART as the console/debug port |
| 230 | * |
| 231 | * @return DEV_OK if successful, otherwise failed. |
| 232 | */ |
| 233 | static int uart_console_init(struct device *arg) |
| 234 | { |
| 235 | ARG_UNUSED(arg); |
| 236 | |
| 237 | uart_console_hook_install(); |
| 238 | |
| 239 | return DEV_OK; |
| 240 | } |
| 241 | DECLARE_DEVICE_INIT_CONFIG(uart_console, "", uart_console_init, NULL); |
Dirk Brandewie | 4365f02 | 2015-09-25 13:02:12 -0700 | [diff] [blame] | 242 | pre_kernel_late_init(uart_console, NULL); |