arch/blackfin/cpu/serial.c

   1 /*
   2  * U-boot - serial.c Blackfin Serial Driver
   3  *
   4  * Copyright (c) 2005-2008 Analog Devices Inc.
   5  *
   6  * Copyright (c) 2003   Bas Vermeulen <bas@buyways.nl>,
   7  *                      BuyWays B.V. (www.buyways.nl)
   8  *
   9  * Based heavily on:
  10  * blkfinserial.c: Serial driver for BlackFin DSP internal USRTs.
  11  * Copyright(c) 2003    Metrowerks      <mwaddel@metrowerks.com>
  12  * Copyright(c) 2001    Tony Z. Kou     <tonyko@arcturusnetworks.com>
  13  * Copyright(c) 2001-2002 Arcturus Networks Inc. <www.arcturusnetworks.com>
  14  *
  15  * Based on code from 68328 version serial driver imlpementation which was:
  16  * Copyright (C) 1995       David S. Miller    <davem@caip.rutgers.edu>
  17  * Copyright (C) 1998       Kenneth Albanowski <kjahds@kjahds.com>
  18  * Copyright (C) 1998, 1999 D. Jeff Dionne     <jeff@uclinux.org>
  19  * Copyright (C) 1999       Vladimir Gurevich  <vgurevic@cisco.com>
  20  *
  21  * (C) Copyright 2000-2004
  22  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  23  *
  24  * Licensed under the GPL-2 or later.
  25  */
  26
  27 /* Anomaly notes:
  28  *  05000086 - we don't support autobaud
  29  *  05000099 - we only use DR bit, so losing others is not a problem
  30  *  05000100 - we don't use the UART_IIR register
  31  *  05000215 - we poll the uart (no dma/interrupts)
  32  *  05000225 - no workaround possible, but this shouldnt cause errors ...
  33  *  05000230 - we tweak the baud rate calculation slightly
  34  *  05000231 - we always use 1 stop bit
  35  *  05000309 - we always enable the uart before we modify it in anyway
  36  *  05000350 - we always enable the uart regardless of boot mode
  37  *  05000363 - we don't support break signals, so don't generate one
  38  */
  39
  40 #include <common.h>
  41 #include <watchdog.h>
  42 #include <serial.h>
  43 #include <linux/compiler.h>
  44 #include <asm/blackfin.h>
  45 #include <asm/mach-common/bits/uart.h>
  46
  47 DECLARE_GLOBAL_DATA_PTR;
  48
  49 #ifdef CONFIG_UART_CONSOLE
  50
  51 #include "serial.h"
  52
  53 #ifdef CONFIG_DEBUG_SERIAL
  54 static uint16_t cached_lsr[256];
  55 static uint16_t cached_rbr[256];
  56 static size_t cache_count;
  57
  58 /* The LSR is read-to-clear on some parts, so we have to make sure status
  59  * bits aren't inadvertently lost when doing various tests.  This also
  60  * works around anomaly 05000099 at the same time by keeping a cumulative
  61  * tally of all the status bits.
  62  */
  63 static uint16_t uart_lsr_save;
  64 static uint16_t uart_lsr_read(uint32_t uart_base)
  65 {
  66         uint16_t lsr = bfin_read(&pUART->lsr);
  67         uart_lsr_save |= (lsr & (OE|PE|FE|BI));
  68         return lsr | uart_lsr_save;
  69 }
  70 /* Just do the clear for everyone since it can't hurt. */
  71 static void uart_lsr_clear(uint32_t uart_base)
  72 {
  73         uart_lsr_save = 0;
  74         bfin_write(&pUART->lsr, bfin_read(&pUART->lsr) | -1);
  75 }
  76 #else
  77 /* When debugging is disabled, we only care about the DR bit, so if other
  78  * bits get set/cleared, we don't really care since we don't read them
  79  * anyways (and thus anomaly 05000099 is irrelevant).
  80  */
  81 static inline uint16_t uart_lsr_read(uint32_t uart_base)
  82 {
  83         return bfin_read(&pUART->lsr);
  84 }
  85 static void uart_lsr_clear(uint32_t uart_base)
  86 {
  87         bfin_write(&pUART->lsr, bfin_read(&pUART->lsr) | -1);
  88 }
  89 #endif
  90
  91 static void uart_putc(uint32_t uart_base, const char c)
  92 {
  93         /* send a \r for compatibility */
  94         if (c == '\n')
  95                 serial_putc('\r');
  96
  97         WATCHDOG_RESET();
  98
  99         /* wait for the hardware fifo to clear up */
 100         while (!(uart_lsr_read(uart_base) & THRE))
 101                 continue;
 102
 103         /* queue the character for transmission */
 104         bfin_write(&pUART->thr, c);
 105         SSYNC();
 106
 107         WATCHDOG_RESET();
 108 }
 109
 110 static int uart_tstc(uint32_t uart_base)
 111 {
 112         WATCHDOG_RESET();
 113         return (uart_lsr_read(uart_base) & DR) ? 1 : 0;
 114 }
 115
 116 static int uart_getc(uint32_t uart_base)
 117 {
 118         uint16_t uart_rbr_val;
 119
 120         /* wait for data ! */
 121         while (!uart_tstc(uart_base))
 122                 continue;
 123
 124         /* grab the new byte */
 125         uart_rbr_val = bfin_read(&pUART->rbr);
 126
 127 #ifdef CONFIG_DEBUG_SERIAL
 128         /* grab & clear the LSR */
 129         uint16_t uart_lsr_val = uart_lsr_read(uart_base);
 130
 131         cached_lsr[cache_count] = uart_lsr_val;
 132         cached_rbr[cache_count] = uart_rbr_val;
 133         cache_count = (cache_count + 1) % ARRAY_SIZE(cached_lsr);
 134
 135         if (uart_lsr_val & (OE|PE|FE|BI)) {
 136                 uint16_t dll, dlh;
 137                 printf("\n[SERIAL ERROR]\n");
 138                 ACCESS_LATCH();
 139                 dll = bfin_read(&pUART->dll);
 140                 dlh = bfin_read(&pUART->dlh);
 141                 ACCESS_PORT_IER();
 142                 printf("\tDLL=0x%x DLH=0x%x\n", dll, dlh);
 143                 do {
 144                         --cache_count;
 145                         printf("\t%3zu: RBR=0x%02x LSR=0x%02x\n", cache_count,
 146                                 cached_rbr[cache_count], cached_lsr[cache_count]);
 147                 } while (cache_count > 0);
 148                 return -1;
 149         }
 150 #endif
 151         uart_lsr_clear(uart_base);
 152
 153         return uart_rbr_val;
 154 }
 155
 156 #ifdef CONFIG_SYS_BFIN_UART
 157
 158 static void uart_puts(uint32_t uart_base, const char *s)
 159 {
 160         while (*s)
 161                 uart_putc(uart_base, *s++);
 162 }
 163
 164 #define DECL_BFIN_UART(n) \
 165 static int uart##n##_init(void) \
 166 { \
 167         const unsigned short pins[] = { _P_UART(n, RX), _P_UART(n, TX), 0, }; \
 168         peripheral_request_list(pins, "bfin-uart"); \
 169         uart_init(MMR_UART(n)); \
 170         serial_early_set_baud(MMR_UART(n), gd->baudrate); \
 171         uart_lsr_clear(MMR_UART(n)); \
 172         return 0; \
 173 } \
 174 \
 175 static int uart##n##_uninit(void) \
 176 { \
 177         return serial_early_uninit(MMR_UART(n)); \
 178 } \
 179 \
 180 static void uart##n##_setbrg(void) \
 181 { \
 182         serial_early_set_baud(MMR_UART(n), gd->baudrate); \
 183 } \
 184 \
 185 static int uart##n##_getc(void) \
 186 { \
 187         return uart_getc(MMR_UART(n)); \
 188 } \
 189 \
 190 static int uart##n##_tstc(void) \
 191 { \
 192         return uart_tstc(MMR_UART(n)); \
 193 } \
 194 \
 195 static void uart##n##_putc(const char c) \
 196 { \
 197         uart_putc(MMR_UART(n), c); \
 198 } \
 199 \
 200 static void uart##n##_puts(const char *s) \
 201 { \
 202         uart_puts(MMR_UART(n), s); \
 203 } \
 204 \
 205 struct serial_device bfin_serial##n##_device = { \
 206         .name   = "bfin_uart"#n, \
 207         .init   = uart##n##_init, \
 208         .uninit = uart##n##_uninit, \
 209         .setbrg = uart##n##_setbrg, \
 210         .getc   = uart##n##_getc, \
 211         .tstc   = uart##n##_tstc, \
 212         .putc   = uart##n##_putc, \
 213         .puts   = uart##n##_puts, \
 214 };
 215
 216 #ifdef UART0_DLL
 217 DECL_BFIN_UART(0)
 218 #endif
 219 #ifdef UART1_DLL
 220 DECL_BFIN_UART(1)
 221 #endif
 222 #ifdef UART2_DLL
 223 DECL_BFIN_UART(2)
 224 #endif
 225 #ifdef UART3_DLL
 226 DECL_BFIN_UART(3)
 227 #endif
 228
 229 __weak struct serial_device *default_serial_console(void)
 230 {
 231 #if CONFIG_UART_CONSOLE == 0
 232         return &bfin_serial0_device;
 233 #elif CONFIG_UART_CONSOLE == 1
 234         return &bfin_serial1_device;
 235 #elif CONFIG_UART_CONSOLE == 2
 236         return &bfin_serial2_device;
 237 #elif CONFIG_UART_CONSOLE == 3
 238         return &bfin_serial3_device;
 239 #endif
 240 }
 241
 242 void serial_register_bfin_uart(void)
 243 {
 244 #ifdef UART0_DLL
 245         serial_register(&bfin_serial0_device);
 246 #endif
 247 #ifdef UART1_DLL
 248         serial_register(&bfin_serial1_device);
 249 #endif
 250 #ifdef UART2_DLL
 251         serial_register(&bfin_serial2_device);
 252 #endif
 253 #ifdef UART3_DLL
 254         serial_register(&bfin_serial3_device);
 255 #endif
 256 }
 257
 258 #else
 259
 260 /* Symbol for our assembly to call. */
 261 void serial_set_baud(uint32_t baud)
 262 {
 263         serial_early_set_baud(UART_DLL, baud);
 264 }
 265
 266 /* Symbol for common u-boot code to call.
 267  * Setup the baudrate (brg: baudrate generator).
 268  */
 269 void serial_setbrg(void)
 270 {
 271         serial_set_baud(gd->baudrate);
 272 }
 273
 274 /* Symbol for our assembly to call. */
 275 void serial_initialize(void)
 276 {
 277         serial_early_init(UART_DLL);
 278 }
 279
 280 /* Symbol for common u-boot code to call. */
 281 int serial_init(void)
 282 {
 283         serial_initialize();
 284         serial_setbrg();
 285         uart_lsr_clear(UART_DLL);
 286         return 0;
 287 }
 288
 289 int serial_tstc(void)
 290 {
 291         return uart_tstc(UART_DLL);
 292 }
 293
 294 int serial_getc(void)
 295 {
 296         return uart_getc(UART_DLL);
 297 }
 298
 299 void serial_putc(const char c)
 300 {
 301         uart_putc(UART_DLL, c);
 302 }
 303
 304 void serial_puts(const char *s)
 305 {
 306         while (*s)
 307                 serial_putc(*s++);
 308 }
 309
 310 #endif
 311
 312 #endif