drivers/serial/sn_console.c

   1 /*
   2  * C-Brick Serial Port (and console) driver for SGI Altix machines.
   3  *
   4  * This driver is NOT suitable for talking to the l1-controller for
   5  * anything other than 'console activities' --- please use the l1
   6  * driver for that.
   7  *
   8  *
   9  * Copyright (c) 2004-2006 Silicon Graphics, Inc.  All Rights Reserved.
  10  *
  11  * This program is free software; you can redistribute it and/or modify it
  12  * under the terms of version 2 of the GNU General Public License
  13  * as published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it would be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  18  *
  19  * Further, this software is distributed without any warranty that it is
  20  * free of the rightful claim of any third person regarding infringement
  21  * or the like.  Any license provided herein, whether implied or
  22  * otherwise, applies only to this software file.  Patent licenses, if
  23  * any, provided herein do not apply to combinations of this program with
  24  * other software, or any other product whatsoever.
  25  *
  26  * You should have received a copy of the GNU General Public
  27  * License along with this program; if not, write the Free Software
  28  * Foundation, Inc., 59 Temple Place - Suite 330, Boston MA 02111-1307, USA.
  29  *
  30  * Contact information:  Silicon Graphics, Inc., 1500 Crittenden Lane,
  31  * Mountain View, CA  94043, or:
  32  *
  33  * http://www.sgi.com
  34  *
  35  * For further information regarding this notice, see:
  36  *
  37  * http://oss.sgi.com/projects/GenInfo/NoticeExplan
  38  */
  39
  40 #include <linux/config.h>
  41 #include <linux/interrupt.h>
  42 #include <linux/tty.h>
  43 #include <linux/serial.h>
  44 #include <linux/console.h>
  45 #include <linux/module.h>
  46 #include <linux/sysrq.h>
  47 #include <linux/circ_buf.h>
  48 #include <linux/serial_reg.h>
  49 #include <linux/delay.h> /* for mdelay */
  50 #include <linux/miscdevice.h>
  51 #include <linux/serial_core.h>
  52
  53 #include <asm/io.h>
  54 #include <asm/sn/simulator.h>
  55 #include <asm/sn/sn_sal.h>
  56
  57 /* number of characters we can transmit to the SAL console at a time */
  58 #define SN_SAL_MAX_CHARS 120
  59
  60 /* 64K, when we're asynch, it must be at least printk's LOG_BUF_LEN to
  61  * avoid losing chars, (always has to be a power of 2) */
  62 #define SN_SAL_BUFFER_SIZE (64 * (1 << 10))
  63
  64 #define SN_SAL_UART_FIFO_DEPTH 16
  65 #define SN_SAL_UART_FIFO_SPEED_CPS 9600/10
  66
  67 /* sn_transmit_chars() calling args */
  68 #define TRANSMIT_BUFFERED       0
  69 #define TRANSMIT_RAW            1
  70
  71 /* To use dynamic numbers only and not use the assigned major and minor,
  72  * define the following.. */
  73                                   /* #define USE_DYNAMIC_MINOR 1 *//* use dynamic minor number */
  74 #define USE_DYNAMIC_MINOR 0     /* Don't rely on misc_register dynamic minor */
  75
  76 /* Device name we're using */
  77 #define DEVICE_NAME "ttySG"
  78 #define DEVICE_NAME_DYNAMIC "ttySG0"    /* need full name for misc_register */
  79 /* The major/minor we are using, ignored for USE_DYNAMIC_MINOR */
  80 #define DEVICE_MAJOR 204
  81 #define DEVICE_MINOR 40
  82
  83 #ifdef CONFIG_MAGIC_SYSRQ
  84 static char sysrq_serial_str[] = "\eSYS";
  85 static char *sysrq_serial_ptr = sysrq_serial_str;
  86 static unsigned long sysrq_requested;
  87 #endif /* CONFIG_MAGIC_SYSRQ */
  88
  89 /*
  90  * Port definition - this kinda drives it all
  91  */
  92 struct sn_cons_port {
  93         struct timer_list sc_timer;
  94         struct uart_port sc_port;
  95         struct sn_sal_ops {
  96                 int (*sal_puts_raw) (const char *s, int len);
  97                 int (*sal_puts) (const char *s, int len);
  98                 int (*sal_getc) (void);
  99                 int (*sal_input_pending) (void);
 100                 void (*sal_wakeup_transmit) (struct sn_cons_port *, int);
 101         } *sc_ops;
 102         unsigned long sc_interrupt_timeout;
 103         int sc_is_asynch;
 104 };
 105
 106 static struct sn_cons_port sal_console_port;
 107 static int sn_process_input;
 108
 109 /* Only used if USE_DYNAMIC_MINOR is set to 1 */
 110 static struct miscdevice misc;  /* used with misc_register for dynamic */
 111
 112 extern void early_sn_setup(void);
 113
 114 #undef DEBUG
 115 #ifdef DEBUG
 116 static int sn_debug_printf(const char *fmt, ...);
 117 #define DPRINTF(x...) sn_debug_printf(x)
 118 #else
 119 #define DPRINTF(x...) do { } while (0)
 120 #endif
 121
 122 /* Prototypes */
 123 static int snt_hw_puts_raw(const char *, int);
 124 static int snt_hw_puts_buffered(const char *, int);
 125 static int snt_poll_getc(void);
 126 static int snt_poll_input_pending(void);
 127 static int snt_intr_getc(void);
 128 static int snt_intr_input_pending(void);
 129 static void sn_transmit_chars(struct sn_cons_port *, int);
 130
 131 /* A table for polling:
 132  */
 133 static struct sn_sal_ops poll_ops = {
 134         .sal_puts_raw = snt_hw_puts_raw,
 135         .sal_puts = snt_hw_puts_raw,
 136         .sal_getc = snt_poll_getc,
 137         .sal_input_pending = snt_poll_input_pending
 138 };
 139
 140 /* A table for interrupts enabled */
 141 static struct sn_sal_ops intr_ops = {
 142         .sal_puts_raw = snt_hw_puts_raw,
 143         .sal_puts = snt_hw_puts_buffered,
 144         .sal_getc = snt_intr_getc,
 145         .sal_input_pending = snt_intr_input_pending,
 146         .sal_wakeup_transmit = sn_transmit_chars
 147 };
 148
 149 /* the console does output in two distinctly different ways:
 150  * synchronous (raw) and asynchronous (buffered).  initally, early_printk
 151  * does synchronous output.  any data written goes directly to the SAL
 152  * to be output (incidentally, it is internally buffered by the SAL)
 153  * after interrupts and timers are initialized and available for use,
 154  * the console init code switches to asynchronous output.  this is
 155  * also the earliest opportunity to begin polling for console input.
 156  * after console initialization, console output and tty (serial port)
 157  * output is buffered and sent to the SAL asynchronously (either by
 158  * timer callback or by UART interrupt) */
 159
 160 /* routines for running the console in polling mode */
 161
 162 /**
 163  * snt_poll_getc - Get a character from the console in polling mode
 164  *
 165  */
 166 static int snt_poll_getc(void)
 167 {
 168         int ch;
 169
 170         ia64_sn_console_getc(&ch);
 171         return ch;
 172 }
 173
 174 /**
 175  * snt_poll_input_pending - Check if any input is waiting - polling mode.
 176  *
 177  */
 178 static int snt_poll_input_pending(void)
 179 {
 180         int status, input;
 181
 182         status = ia64_sn_console_check(&input);
 183         return !status && input;
 184 }
 185
 186 /* routines for an interrupt driven console (normal) */
 187
 188 /**
 189  * snt_intr_getc - Get a character from the console, interrupt mode
 190  *
 191  */
 192 static int snt_intr_getc(void)
 193 {
 194         return ia64_sn_console_readc();
 195 }
 196
 197 /**
 198  * snt_intr_input_pending - Check if input is pending, interrupt mode
 199  *
 200  */
 201 static int snt_intr_input_pending(void)
 202 {
 203         return ia64_sn_console_intr_status() & SAL_CONSOLE_INTR_RECV;
 204 }
 205
 206 /* these functions are polled and interrupt */
 207
 208 /**
 209  * snt_hw_puts_raw - Send raw string to the console, polled or interrupt mode
 210  * @s: String
 211  * @len: Length
 212  *
 213  */
 214 static int snt_hw_puts_raw(const char *s, int len)
 215 {
 216         /* this will call the PROM and not return until this is done */
 217         return ia64_sn_console_putb(s, len);
 218 }
 219
 220 /**
 221  * snt_hw_puts_buffered - Send string to console, polled or interrupt mode
 222  * @s: String
 223  * @len: Length
 224  *
 225  */
 226 static int snt_hw_puts_buffered(const char *s, int len)
 227 {
 228         /* queue data to the PROM */
 229         return ia64_sn_console_xmit_chars((char *)s, len);
 230 }
 231
 232 /* uart interface structs
 233  * These functions are associated with the uart_port that the serial core
 234  * infrastructure calls.
 235  *
 236  * Note: Due to how the console works, many routines are no-ops.
 237  */
 238
 239 /**
 240  * snp_type - What type of console are we?
 241  * @port: Port to operate with (we ignore since we only have one port)
 242  *
 243  */
 244 static const char *snp_type(struct uart_port *port)
 245 {
 246         return ("SGI SN L1");
 247 }
 248
 249 /**
 250  * snp_tx_empty - Is the transmitter empty?  We pretend we're always empty
 251  * @port: Port to operate on (we ignore since we only have one port)
 252  *
 253  */
 254 static unsigned int snp_tx_empty(struct uart_port *port)
 255 {
 256         return 1;
 257 }
 258
 259 /**
 260  * snp_stop_tx - stop the transmitter - no-op for us
 261  * @port: Port to operat eon - we ignore - no-op function
 262  *
 263  */
 264 static void snp_stop_tx(struct uart_port *port)
 265 {
 266 }
 267
 268 /**
 269  * snp_release_port - Free i/o and resources for port - no-op for us
 270  * @port: Port to operate on - we ignore - no-op function
 271  *
 272  */
 273 static void snp_release_port(struct uart_port *port)
 274 {
 275 }
 276
 277 /**
 278  * snp_enable_ms - Force modem status interrupts on - no-op for us
 279  * @port: Port to operate on - we ignore - no-op function
 280  *
 281  */
 282 static void snp_enable_ms(struct uart_port *port)
 283 {
 284 }
 285
 286 /**
 287  * snp_shutdown - shut down the port - free irq and disable - no-op for us
 288  * @port: Port to shut down - we ignore
 289  *
 290  */
 291 static void snp_shutdown(struct uart_port *port)
 292 {
 293 }
 294
 295 /**
 296  * snp_set_mctrl - set control lines (dtr, rts, etc) - no-op for our console
 297  * @port: Port to operate on - we ignore
 298  * @mctrl: Lines to set/unset - we ignore
 299  *
 300  */
 301 static void snp_set_mctrl(struct uart_port *port, unsigned int mctrl)
 302 {
 303 }
 304
 305 /**
 306  * snp_get_mctrl - get contorl line info, we just return a static value
 307  * @port: port to operate on - we only have one port so we ignore this
 308  *
 309  */
 310 static unsigned int snp_get_mctrl(struct uart_port *port)
 311 {
 312         return TIOCM_CAR | TIOCM_RNG | TIOCM_DSR | TIOCM_CTS;
 313 }
 314
 315 /**
 316  * snp_stop_rx - Stop the receiver - we ignor ethis
 317  * @port: Port to operate on - we ignore
 318  *
 319  */
 320 static void snp_stop_rx(struct uart_port *port)
 321 {
 322 }
 323
 324 /**
 325  * snp_start_tx - Start transmitter
 326  * @port: Port to operate on
 327  *
 328  */
 329 static void snp_start_tx(struct uart_port *port)
 330 {
 331         if (sal_console_port.sc_ops->sal_wakeup_transmit)
 332                 sal_console_port.sc_ops->sal_wakeup_transmit(&sal_console_port,
 333                                                              TRANSMIT_BUFFERED);
 334
 335 }
 336
 337 /**
 338  * snp_break_ctl - handle breaks - ignored by us
 339  * @port: Port to operate on
 340  * @break_state: Break state
 341  *
 342  */
 343 static void snp_break_ctl(struct uart_port *port, int break_state)
 344 {
 345 }
 346
 347 /**
 348  * snp_startup - Start up the serial port - always return 0 (We're always on)
 349  * @port: Port to operate on
 350  *
 351  */
 352 static int snp_startup(struct uart_port *port)
 353 {
 354         return 0;
 355 }
 356
 357 /**
 358  * snp_set_termios - set termios stuff - we ignore these
 359  * @port: port to operate on
 360  * @termios: New settings
 361  * @termios: Old
 362  *
 363  */
 364 static void
 365 snp_set_termios(struct uart_port *port, struct termios *termios,
 366                 struct termios *old)
 367 {
 368 }
 369
 370 /**
 371  * snp_request_port - allocate resources for port - ignored by us
 372  * @port: port to operate on
 373  *
 374  */
 375 static int snp_request_port(struct uart_port *port)
 376 {
 377         return 0;
 378 }
 379
 380 /**
 381  * snp_config_port - allocate resources, set up - we ignore,  we're always on
 382  * @port: Port to operate on
 383  * @flags: flags used for port setup
 384  *
 385  */
 386 static void snp_config_port(struct uart_port *port, int flags)
 387 {
 388 }
 389
 390 /* Associate the uart functions above - given to serial core */
 391
 392 static struct uart_ops sn_console_ops = {
 393         .tx_empty = snp_tx_empty,
 394         .set_mctrl = snp_set_mctrl,
 395         .get_mctrl = snp_get_mctrl,
 396         .stop_tx = snp_stop_tx,
 397         .start_tx = snp_start_tx,
 398         .stop_rx = snp_stop_rx,
 399         .enable_ms = snp_enable_ms,
 400         .break_ctl = snp_break_ctl,
 401         .startup = snp_startup,
 402         .shutdown = snp_shutdown,
 403         .set_termios = snp_set_termios,
 404         .pm = NULL,
 405         .type = snp_type,
 406         .release_port = snp_release_port,
 407         .request_port = snp_request_port,
 408         .config_port = snp_config_port,
 409         .verify_port = NULL,
 410 };
 411
 412 /* End of uart struct functions and defines */
 413
 414 #ifdef DEBUG
 415
 416 /**
 417  * sn_debug_printf - close to hardware debugging printf
 418  * @fmt: printf format
 419  *
 420  * This is as "close to the metal" as we can get, used when the driver
 421  * itself may be broken.
 422  *
 423  */
 424 static int sn_debug_printf(const char *fmt, ...)
 425 {
 426         static char printk_buf[1024];
 427         int printed_len;
 428         va_list args;
 429
 430         va_start(args, fmt);
 431         printed_len = vsnprintf(printk_buf, sizeof(printk_buf), fmt, args);
 432
 433         if (!sal_console_port.sc_ops) {
 434                 sal_console_port.sc_ops = &poll_ops;
 435                 early_sn_setup();
 436         }
 437         sal_console_port.sc_ops->sal_puts_raw(printk_buf, printed_len);
 438
 439         va_end(args);
 440         return printed_len;
 441 }
 442 #endif                          /* DEBUG */
 443
 444 /*
 445  * Interrupt handling routines.
 446  */
 447
 448 /**
 449  * sn_receive_chars - Grab characters, pass them to tty layer
 450  * @port: Port to operate on
 451  * @regs: Saved registers (needed by uart_handle_sysrq_char)
 452  * @flags: irq flags
 453  *
 454  * Note: If we're not registered with the serial core infrastructure yet,
 455  * we don't try to send characters to it...
 456  *
 457  */
 458 static void
 459 sn_receive_chars(struct sn_cons_port *port, struct pt_regs *regs,
 460                  unsigned long flags)
 461 {
 462         int ch;
 463         struct tty_struct *tty;
 464
 465         if (!port) {
 466                 printk(KERN_ERR "sn_receive_chars - port NULL so can't receieve\n");
 467                 return;
 468         }
 469
 470         if (!port->sc_ops) {
 471                 printk(KERN_ERR "sn_receive_chars - port->sc_ops  NULL so can't receieve\n");
 472                 return;
 473         }
 474
 475         if (port->sc_port.info) {
 476                 /* The serial_core stuffs are initilized, use them */
 477                 tty = port->sc_port.info->tty;
 478         }
 479         else {
 480                 /* Not registered yet - can't pass to tty layer.  */
 481                 tty = NULL;
 482         }
 483
 484         while (port->sc_ops->sal_input_pending()) {
 485                 ch = port->sc_ops->sal_getc();
 486                 if (ch < 0) {
 487                         printk(KERN_ERR "sn_console: An error occured while "
 488                                "obtaining data from the console (0x%0x)\n", ch);
 489                         break;
 490                 }
 491 #ifdef CONFIG_MAGIC_SYSRQ
 492                 if (sysrq_requested) {
 493                         unsigned long sysrq_timeout = sysrq_requested + HZ*5;
 494
 495                         sysrq_requested = 0;
 496                         if (ch && time_before(jiffies, sysrq_timeout)) {
 497                                 spin_unlock_irqrestore(&port->sc_port.lock, flags);
 498                                 handle_sysrq(ch, regs, NULL);
 499                                 spin_lock_irqsave(&port->sc_port.lock, flags);
 500                                 /* ignore actual sysrq command char */
 501                                 continue;
 502                         }
 503                 }
 504                 if (ch == *sysrq_serial_ptr) {
 505                         if (!(*++sysrq_serial_ptr)) {
 506                                 sysrq_requested = jiffies;
 507                                 sysrq_serial_ptr = sysrq_serial_str;
 508                         }
 509                         /*
 510                          * ignore the whole sysrq string except for the
 511                          * leading escape
 512                          */
 513                         if (ch != '\e')
 514                                 continue;
 515                 }
 516                 else
 517                         sysrq_serial_ptr = sysrq_serial_str;
 518 #endif /* CONFIG_MAGIC_SYSRQ */
 519
 520                 /* record the character to pass up to the tty layer */
 521                 if (tty) {
 522                         if(tty_insert_flip_char(tty, ch, TTY_NORMAL) == 0)
 523                                 break;
 524                 }
 525                 port->sc_port.icount.rx++;
 526         }
 527
 528         if (tty)
 529                 tty_flip_buffer_push(tty);
 530 }
 531
 532 /**
 533  * sn_transmit_chars - grab characters from serial core, send off
 534  * @port: Port to operate on
 535  * @raw: Transmit raw or buffered
 536  *
 537  * Note: If we're early, before we're registered with serial core, the
 538  * writes are going through sn_sal_console_write because that's how
 539  * register_console has been set up.  We currently could have asynch
 540  * polls calling this function due to sn_sal_switch_to_asynch but we can
 541  * ignore them until we register with the serial core stuffs.
 542  *
 543  */
 544 static void sn_transmit_chars(struct sn_cons_port *port, int raw)
 545 {
 546         int xmit_count, tail, head, loops, ii;
 547         int result;
 548         char *start;
 549         struct circ_buf *xmit;
 550
 551         if (!port)
 552                 return;
 553
 554         BUG_ON(!port->sc_is_asynch);
 555
 556         if (port->sc_port.info) {
 557                 /* We're initilized, using serial core infrastructure */
 558                 xmit = &port->sc_port.info->xmit;
 559         } else {
 560                 /* Probably sn_sal_switch_to_asynch has been run but serial core isn't
 561                  * initilized yet.  Just return.  Writes are going through
 562                  * sn_sal_console_write (due to register_console) at this time.
 563                  */
 564                 return;
 565         }
 566
 567         if (uart_circ_empty(xmit) || uart_tx_stopped(&port->sc_port)) {
 568                 /* Nothing to do. */
 569                 ia64_sn_console_intr_disable(SAL_CONSOLE_INTR_XMIT);
 570                 return;
 571         }
 572
 573         head = xmit->head;
 574         tail = xmit->tail;
 575         start = &xmit->buf[tail];
 576
 577         /* twice around gets the tail to the end of the buffer and
 578          * then to the head, if needed */
 579         loops = (head < tail) ? 2 : 1;
 580
 581         for (ii = 0; ii < loops; ii++) {
 582                 xmit_count = (head < tail) ?
 583                     (UART_XMIT_SIZE - tail) : (head - tail);
 584
 585                 if (xmit_count > 0) {
 586                         if (raw == TRANSMIT_RAW)
 587                                 result =
 588                                     port->sc_ops->sal_puts_raw(start,
 589                                                                xmit_count);
 590                         else
 591                                 result =
 592                                     port->sc_ops->sal_puts(start, xmit_count);
 593 #ifdef DEBUG
 594                         if (!result)
 595                                 DPRINTF("`");
 596 #endif
 597                         if (result > 0) {
 598                                 xmit_count -= result;
 599                                 port->sc_port.icount.tx += result;
 600                                 tail += result;
 601                                 tail &= UART_XMIT_SIZE - 1;
 602                                 xmit->tail = tail;
 603                                 start = &xmit->buf[tail];
 604                         }
 605                 }
 606         }
 607
 608         if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
 609                 uart_write_wakeup(&port->sc_port);
 610
 611         if (uart_circ_empty(xmit))
 612                 snp_stop_tx(&port->sc_port);    /* no-op for us */
 613 }
 614
 615 /**
 616  * sn_sal_interrupt - Handle console interrupts
 617  * @irq: irq #, useful for debug statements
 618  * @dev_id: our pointer to our port (sn_cons_port which contains the uart port)
 619  * @regs: Saved registers, used by sn_receive_chars for uart_handle_sysrq_char
 620  *
 621  */
 622 static irqreturn_t sn_sal_interrupt(int irq, void *dev_id, struct pt_regs *regs)
 623 {
 624         struct sn_cons_port *port = (struct sn_cons_port *)dev_id;
 625         unsigned long flags;
 626         int status = ia64_sn_console_intr_status();
 627
 628         if (!port)
 629                 return IRQ_NONE;
 630
 631         spin_lock_irqsave(&port->sc_port.lock, flags);
 632         if (status & SAL_CONSOLE_INTR_RECV) {
 633                 sn_receive_chars(port, regs, flags);
 634         }
 635         if (status & SAL_CONSOLE_INTR_XMIT) {
 636                 sn_transmit_chars(port, TRANSMIT_BUFFERED);
 637         }
 638         spin_unlock_irqrestore(&port->sc_port.lock, flags);
 639         return IRQ_HANDLED;
 640 }
 641
 642 /**
 643  * sn_sal_connect_interrupt - Request interrupt, handled by sn_sal_interrupt
 644  * @port: Our sn_cons_port (which contains the uart port)
 645  *
 646  * returns the console irq if interrupt is successfully registered, else 0
 647  *
 648  */
 649 static int sn_sal_connect_interrupt(struct sn_cons_port *port)
 650 {
 651         if (request_irq(SGI_UART_VECTOR, sn_sal_interrupt,
 652                         SA_INTERRUPT | SA_SHIRQ,
 653                         "SAL console driver", port) >= 0) {
 654                 return SGI_UART_VECTOR;
 655         }
 656
 657         printk(KERN_INFO "sn_console: console proceeding in polled mode\n");
 658         return 0;
 659 }
 660
 661 /**
 662  * sn_sal_timer_poll - this function handles polled console mode
 663  * @data: A pointer to our sn_cons_port (which contains the uart port)
 664  *
 665  * data is the pointer that init_timer will store for us.  This function is
 666  * associated with init_timer to see if there is any console traffic.
 667  * Obviously not used in interrupt mode
 668  *
 669  */
 670 static void sn_sal_timer_poll(unsigned long data)
 671 {
 672         struct sn_cons_port *port = (struct sn_cons_port *)data;
 673         unsigned long flags;
 674
 675         if (!port)
 676                 return;
 677
 678         if (!port->sc_port.irq) {
 679                 spin_lock_irqsave(&port->sc_port.lock, flags);
 680                 if (sn_process_input)
 681                         sn_receive_chars(port, NULL, flags);
 682                 sn_transmit_chars(port, TRANSMIT_RAW);
 683                 spin_unlock_irqrestore(&port->sc_port.lock, flags);
 684                 mod_timer(&port->sc_timer,
 685                           jiffies + port->sc_interrupt_timeout);
 686         }
 687 }
 688
 689 /*
 690  * Boot-time initialization code
 691  */
 692
 693 /**
 694  * sn_sal_switch_to_asynch - Switch to async mode (as opposed to synch)
 695  * @port: Our sn_cons_port (which contains the uart port)
 696  *
 697  * So this is used by sn_sal_serial_console_init (early on, before we're
 698  * registered with serial core).  It's also used by sn_sal_module_init
 699  * right after we've registered with serial core.  The later only happens
 700  * if we didn't already come through here via sn_sal_serial_console_init.
 701  *
 702  */
 703 static void __init sn_sal_switch_to_asynch(struct sn_cons_port *port)
 704 {
 705         unsigned long flags;
 706
 707         if (!port)
 708                 return;
 709
 710         DPRINTF("sn_console: about to switch to asynchronous console\n");
 711
 712         /* without early_printk, we may be invoked late enough to race
 713          * with other cpus doing console IO at this point, however
 714          * console interrupts will never be enabled */
 715         spin_lock_irqsave(&port->sc_port.lock, flags);
 716
 717         /* early_printk invocation may have done this for us */
 718         if (!port->sc_ops)
 719                 port->sc_ops = &poll_ops;
 720
 721         /* we can't turn on the console interrupt (as request_irq
 722          * calls kmalloc, which isn't set up yet), so we rely on a
 723          * timer to poll for input and push data from the console
 724          * buffer.
 725          */
 726         init_timer(&port->sc_timer);
 727         port->sc_timer.function = sn_sal_timer_poll;
 728         port->sc_timer.data = (unsigned long)port;
 729
 730         if (IS_RUNNING_ON_SIMULATOR())
 731                 port->sc_interrupt_timeout = 6;
 732         else {
 733                 /* 960cps / 16 char FIFO = 60HZ
 734                  * HZ / (SN_SAL_FIFO_SPEED_CPS / SN_SAL_FIFO_DEPTH) */
 735                 port->sc_interrupt_timeout =
 736                     HZ * SN_SAL_UART_FIFO_DEPTH / SN_SAL_UART_FIFO_SPEED_CPS;
 737         }
 738         mod_timer(&port->sc_timer, jiffies + port->sc_interrupt_timeout);
 739
 740         port->sc_is_asynch = 1;
 741         spin_unlock_irqrestore(&port->sc_port.lock, flags);
 742 }
 743
 744 /**
 745  * sn_sal_switch_to_interrupts - Switch to interrupt driven mode
 746  * @port: Our sn_cons_port (which contains the uart port)
 747  *
 748  * In sn_sal_module_init, after we're registered with serial core and
 749  * the port is added, this function is called to switch us to interrupt
 750  * mode.  We were previously in asynch/polling mode (using init_timer).
 751  *
 752  * We attempt to switch to interrupt mode here by calling
 753  * sn_sal_connect_interrupt.  If that works out, we enable receive interrupts.
 754  */
 755 static void __init sn_sal_switch_to_interrupts(struct sn_cons_port *port)
 756 {
 757         int irq;
 758         unsigned long flags;
 759
 760         if (!port)
 761                 return;
 762
 763         DPRINTF("sn_console: switching to interrupt driven console\n");
 764
 765         spin_lock_irqsave(&port->sc_port.lock, flags);
 766
 767         irq = sn_sal_connect_interrupt(port);
 768
 769         if (irq) {
 770                 port->sc_port.irq = irq;
 771                 port->sc_ops = &intr_ops;
 772
 773                 /* turn on receive interrupts */
 774                 ia64_sn_console_intr_enable(SAL_CONSOLE_INTR_RECV);
 775         }
 776         spin_unlock_irqrestore(&port->sc_port.lock, flags);
 777 }
 778
 779 /*
 780  * Kernel console definitions
 781  */
 782
 783 static void sn_sal_console_write(struct console *, const char *, unsigned);
 784 static int __init sn_sal_console_setup(struct console *, char *);
 785 static struct uart_driver sal_console_uart;
 786 extern struct tty_driver *uart_console_device(struct console *, int *);
 787
 788 static struct console sal_console = {
 789         .name = DEVICE_NAME,
 790         .write = sn_sal_console_write,
 791         .device = uart_console_device,
 792         .setup = sn_sal_console_setup,
 793         .index = -1,            /* unspecified */
 794         .data = &sal_console_uart,
 795 };
 796
 797 #define SAL_CONSOLE     &sal_console
 798
 799 static struct uart_driver sal_console_uart = {
 800         .owner = THIS_MODULE,
 801         .driver_name = "sn_console",
 802         .dev_name = DEVICE_NAME,
 803         .major = 0,             /* major/minor set at registration time per USE_DYNAMIC_MINOR */
 804         .minor = 0,
 805         .nr = 1,                /* one port */
 806         .cons = SAL_CONSOLE,
 807 };
 808
 809 /**
 810  * sn_sal_module_init - When the kernel loads us, get us rolling w/ serial core
 811  *
 812  * Before this is called, we've been printing kernel messages in a special
 813  * early mode not making use of the serial core infrastructure.  When our
 814  * driver is loaded for real, we register the driver and port with serial
 815  * core and try to enable interrupt driven mode.
 816  *
 817  */
 818 static int __init sn_sal_module_init(void)
 819 {
 820         int retval;
 821
 822         if (!ia64_platform_is("sn2"))
 823                 return -ENODEV;
 824
 825         printk(KERN_INFO "sn_console: Console driver init\n");
 826
 827         if (USE_DYNAMIC_MINOR == 1) {
 828                 misc.minor = MISC_DYNAMIC_MINOR;
 829                 misc.name = DEVICE_NAME_DYNAMIC;
 830                 retval = misc_register(&misc);
 831                 if (retval != 0) {
 832                         printk(KERN_WARNING "Failed to register console "
 833                                "device using misc_register.\n");
 834                         return -ENODEV;
 835                 }
 836                 sal_console_uart.major = MISC_MAJOR;
 837                 sal_console_uart.minor = misc.minor;
 838         } else {
 839                 sal_console_uart.major = DEVICE_MAJOR;
 840                 sal_console_uart.minor = DEVICE_MINOR;
 841         }
 842
 843         /* We register the driver and the port before switching to interrupts
 844          * or async above so the proper uart structures are populated */
 845
 846         if (uart_register_driver(&sal_console_uart) < 0) {
 847                 printk
 848                     ("ERROR sn_sal_module_init failed uart_register_driver, line %d\n",
 849                      __LINE__);
 850                 return -ENODEV;
 851         }
 852
 853         spin_lock_init(&sal_console_port.sc_port.lock);
 854
 855         /* Setup the port struct with the minimum needed */
 856         sal_console_port.sc_port.membase = (char *)1;   /* just needs to be non-zero */
 857         sal_console_port.sc_port.type = PORT_16550A;
 858         sal_console_port.sc_port.fifosize = SN_SAL_MAX_CHARS;
 859         sal_console_port.sc_port.ops = &sn_console_ops;
 860         sal_console_port.sc_port.line = 0;
 861
 862         if (uart_add_one_port(&sal_console_uart, &sal_console_port.sc_port) < 0) {
 863                 /* error - not sure what I'd do - so I'll do nothing */
 864                 printk(KERN_ERR "%s: unable to add port\n", __FUNCTION__);
 865         }
 866
 867         /* when this driver is compiled in, the console initialization
 868          * will have already switched us into asynchronous operation
 869          * before we get here through the module initcalls */
 870         if (!sal_console_port.sc_is_asynch) {
 871                 sn_sal_switch_to_asynch(&sal_console_port);
 872         }
 873
 874         /* at this point (module_init) we can try to turn on interrupts */
 875         if (!IS_RUNNING_ON_SIMULATOR()) {
 876                 sn_sal_switch_to_interrupts(&sal_console_port);
 877         }
 878         sn_process_input = 1;
 879         return 0;
 880 }
 881
 882 /**
 883  * sn_sal_module_exit - When we're unloaded, remove the driver/port
 884  *
 885  */
 886 static void __exit sn_sal_module_exit(void)
 887 {
 888         del_timer_sync(&sal_console_port.sc_timer);
 889         uart_remove_one_port(&sal_console_uart, &sal_console_port.sc_port);
 890         uart_unregister_driver(&sal_console_uart);
 891         misc_deregister(&misc);
 892 }
 893
 894 module_init(sn_sal_module_init);
 895 module_exit(sn_sal_module_exit);
 896
 897 /**
 898  * puts_raw_fixed - sn_sal_console_write helper for adding \r's as required
 899  * @puts_raw : puts function to do the writing
 900  * @s: input string
 901  * @count: length
 902  *
 903  * We need a \r ahead of every \n for direct writes through
 904  * ia64_sn_console_putb (what sal_puts_raw below actually does).
 905  *
 906  */
 907
 908 static void puts_raw_fixed(int (*puts_raw) (const char *s, int len),
 909                            const char *s, int count)
 910 {
 911         const char *s1;
 912
 913         /* Output '\r' before each '\n' */
 914         while ((s1 = memchr(s, '\n', count)) != NULL) {
 915                 puts_raw(s, s1 - s);
 916                 puts_raw("\r\n", 2);
 917                 count -= s1 + 1 - s;
 918                 s = s1 + 1;
 919         }
 920         puts_raw(s, count);
 921 }
 922
 923 /**
 924  * sn_sal_console_write - Print statements before serial core available
 925  * @console: Console to operate on - we ignore since we have just one
 926  * @s: String to send
 927  * @count: length
 928  *
 929  * This is referenced in the console struct.  It is used for early
 930  * console printing before we register with serial core and for things
 931  * such as kdb.  The console_lock must be held when we get here.
 932  *
 933  * This function has some code for trying to print output even if the lock
 934  * is held.  We try to cover the case where a lock holder could have died.
 935  * We don't use this special case code if we're not registered with serial
 936  * core yet.  After we're registered with serial core, the only time this
 937  * function would be used is for high level kernel output like magic sys req,
 938  * kdb, and printk's.
 939  */
 940 static void
 941 sn_sal_console_write(struct console *co, const char *s, unsigned count)
 942 {
 943         unsigned long flags = 0;
 944         struct sn_cons_port *port = &sal_console_port;
 945         static int stole_lock = 0;
 946
 947         BUG_ON(!port->sc_is_asynch);
 948
 949         /* We can't look at the xmit buffer if we're not registered with serial core
 950          *  yet.  So only do the fancy recovery after registering
 951          */
 952         if (!port->sc_port.info) {
 953                 /* Not yet registered with serial core - simple case */
 954                 puts_raw_fixed(port->sc_ops->sal_puts_raw, s, count);
 955                 return;
 956         }
 957
 958         /* somebody really wants this output, might be an
 959          * oops, kdb, panic, etc.  make sure they get it. */
 960         if (spin_is_locked(&port->sc_port.lock)) {
 961                 int lhead = port->sc_port.info->xmit.head;
 962                 int ltail = port->sc_port.info->xmit.tail;
 963                 int counter, got_lock = 0;
 964
 965                 /*
 966                  * We attempt to determine if someone has died with the
 967                  * lock. We wait ~20 secs after the head and tail ptrs
 968                  * stop moving and assume the lock holder is not functional
 969                  * and plow ahead. If the lock is freed within the time out
 970                  * period we re-get the lock and go ahead normally. We also
 971                  * remember if we have plowed ahead so that we don't have
 972                  * to wait out the time out period again - the asumption
 973                  * is that we will time out again.
 974                  */
 975
 976                 for (counter = 0; counter < 150; mdelay(125), counter++) {
 977                         if (!spin_is_locked(&port->sc_port.lock)
 978                             || stole_lock) {
 979                                 if (!stole_lock) {
 980                                         spin_lock_irqsave(&port->sc_port.lock,
 981                                                           flags);
 982                                         got_lock = 1;
 983                                 }
 984                                 break;
 985                         } else {
 986                                 /* still locked */
 987                                 if ((lhead != port->sc_port.info->xmit.head)
 988                                     || (ltail !=
 989                                         port->sc_port.info->xmit.tail)) {
 990                                         lhead =
 991                                                 port->sc_port.info->xmit.head;
 992                                         ltail =
 993                                                 port->sc_port.info->xmit.tail;
 994                                         counter = 0;
 995                                 }
 996                         }
 997                 }
 998                 /* flush anything in the serial core xmit buffer, raw */
 999                 sn_transmit_chars(port, 1);
1000                 if (got_lock) {
1001                         spin_unlock_irqrestore(&port->sc_port.lock, flags);
1002                         stole_lock = 0;
1003                 } else {
1004                         /* fell thru */
1005                         stole_lock = 1;
1006                 }
1007                 puts_raw_fixed(port->sc_ops->sal_puts_raw, s, count);
1008         } else {
1009                 stole_lock = 0;
1010                 spin_lock_irqsave(&port->sc_port.lock, flags);
1011                 sn_transmit_chars(port, 1);
1012                 spin_unlock_irqrestore(&port->sc_port.lock, flags);
1013
1014                 puts_raw_fixed(port->sc_ops->sal_puts_raw, s, count);
1015         }
1016 }
1017
1018
1019 /**
1020  * sn_sal_console_setup - Set up console for early printing
1021  * @co: Console to work with
1022  * @options: Options to set
1023  *
1024  * Altix console doesn't do anything with baud rates, etc, anyway.
1025  *
1026  * This isn't required since not providing the setup function in the
1027  * console struct is ok.  However, other patches like KDB plop something
1028  * here so providing it is easier.
1029  *
1030  */
1031 static int __init sn_sal_console_setup(struct console *co, char *options)
1032 {
1033         return 0;
1034 }
1035
1036 /**
1037  * sn_sal_console_write_early - simple early output routine
1038  * @co - console struct
1039  * @s - string to print
1040  * @count - count
1041  *
1042  * Simple function to provide early output, before even
1043  * sn_sal_serial_console_init is called.  Referenced in the
1044  * console struct registerd in sn_serial_console_early_setup.
1045  *
1046  */
1047 static void __init
1048 sn_sal_console_write_early(struct console *co, const char *s, unsigned count)
1049 {
1050         puts_raw_fixed(sal_console_port.sc_ops->sal_puts_raw, s, count);
1051 }
1052
1053 /* Used for very early console printing - again, before
1054  * sn_sal_serial_console_init is run */
1055 static struct console sal_console_early __initdata = {
1056         .name = "sn_sal",
1057         .write = sn_sal_console_write_early,
1058         .flags = CON_PRINTBUFFER,
1059         .index = -1,
1060 };
1061
1062 /**
1063  * sn_serial_console_early_setup - Sets up early console output support
1064  *
1065  * Register a console early on...  This is for output before even
1066  * sn_sal_serial_cosnole_init is called.  This function is called from
1067  * setup.c.  This allows us to do really early polled writes. When
1068  * sn_sal_serial_console_init is called, this console is unregistered
1069  * and a new one registered.
1070  */
1071 int __init sn_serial_console_early_setup(void)
1072 {
1073         if (!ia64_platform_is("sn2"))
1074                 return -1;
1075
1076         sal_console_port.sc_ops = &poll_ops;
1077         spin_lock_init(&sal_console_port.sc_port.lock);
1078         early_sn_setup();       /* Find SAL entry points */
1079         register_console(&sal_console_early);
1080
1081         return 0;
1082 }
1083
1084 /**
1085  * sn_sal_serial_console_init - Early console output - set up for register
1086  *
1087  * This function is called when regular console init happens.  Because we
1088  * support even earlier console output with sn_serial_console_early_setup
1089  * (called from setup.c directly), this function unregisters the really
1090  * early console.
1091  *
1092  * Note: Even if setup.c doesn't register sal_console_early, unregistering
1093  * it here doesn't hurt anything.
1094  *
1095  */
1096 static int __init sn_sal_serial_console_init(void)
1097 {
1098         if (ia64_platform_is("sn2")) {
1099                 sn_sal_switch_to_asynch(&sal_console_port);
1100                 DPRINTF("sn_sal_serial_console_init : register console\n");
1101                 register_console(&sal_console);
1102                 unregister_console(&sal_console_early);
1103         }
1104         return 0;
1105 }
1106
1107 console_initcall(sn_sal_serial_console_init);