osfmk/console/serial_general.c

   1 /*
   2  * Copyright (c) 2005-2006 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * @APPLE_FREE_COPYRIGHT@
  33  */
  34
  35 #include <kern/spl.h>
  36 #include <mach/std_types.h>
  37 #include <types.h>
  38 #include <kern/thread.h>
  39 #include <console/serial_protos.h>
  40 #include <libkern/section_keywords.h>
  41
  42 extern void cons_cinput(char ch);               /* The BSD routine that gets characters */
  43
  44 SECURITY_READ_ONLY_LATE(unsigned int) serialmode;                               /* Serial mode keyboard and console control */
  45
  46 /*
  47  *  This routine will start a thread that polls the serial port, listening for
  48  *  characters that have been typed.
  49  */
  50
  51 void
  52 serial_keyboard_init(void)
  53 {
  54         kern_return_t   result;
  55         thread_t                thread;
  56
  57         if (!(serialmode & SERIALMODE_INPUT)) { /* Leave if we do not want a serial console */
  58                 return;
  59         }
  60
  61         kprintf("Serial keyboard started\n");
  62         result = kernel_thread_start_priority((thread_continue_t)serial_keyboard_start, NULL, MAXPRI_KERNEL, &thread);
  63         if (result != KERN_SUCCESS) {
  64                 panic("serial_keyboard_init");
  65         }
  66
  67         thread_deallocate(thread);
  68 }
  69
  70 void
  71 serial_keyboard_start(void)
  72 {
  73         /* Go see if there are any characters pending now */
  74         serial_keyboard_poll();
  75 }
  76
  77 __dead2
  78 void
  79 serial_keyboard_poll(void)
  80 {
  81         int chr;
  82         uint64_t next;
  83
  84         while (1) {
  85                 chr = _serial_getc(0, 1, 0, 1); /* Get a character if there is one */
  86                 if (chr < 0) { /* The serial buffer is empty */
  87                         break;
  88                 }
  89                 cons_cinput((char)chr);                 /* Buffer up the character */
  90         }
  91
  92         clock_interval_to_deadline(16, 1000000, &next); /* Get time of pop */
  93
  94         assert_wait_deadline((event_t)serial_keyboard_poll, THREAD_UNINT, next);        /* Show we are "waiting" */
  95         thread_block((thread_continue_t)serial_keyboard_poll);  /* Wait for it */
  96         panic("serial_keyboard_poll: Shouldn't never ever get here...\n");
  97 }
  98
  99 boolean_t
 100 console_is_serial(void)
 101 {
 102         return cons_ops_index == SERIAL_CONS_OPS;
 103 }
 104
 105 int
 106 switch_to_video_console(void)
 107 {
 108         int old_cons_ops = cons_ops_index;
 109         cons_ops_index = VC_CONS_OPS;
 110         return old_cons_ops;
 111 }
 112
 113 int
 114 switch_to_serial_console(void)
 115 {
 116         int old_cons_ops = cons_ops_index;
 117         cons_ops_index = SERIAL_CONS_OPS;
 118         return old_cons_ops;
 119 }
 120
 121 /* The switch_to_{video,serial,kgdb}_console functions return a cookie that
 122  *  can be used to restore the console to whatever it was before, in the
 123  *  same way that splwhatever() and splx() work.  */
 124 void
 125 switch_to_old_console(int old_console)
 126 {
 127         static boolean_t squawked;
 128         uint32_t ops = old_console;
 129
 130         if ((ops >= nconsops) && !squawked) {
 131                 squawked = TRUE;
 132                 printf("switch_to_old_console: unknown ops %d\n", ops);
 133         } else {
 134                 cons_ops_index = ops;
 135         }
 136 }
 137
 138 void
 139 console_printbuf_state_init(struct console_printbuf_state * data, int write_on_newline, int can_block)
 140 {
 141         if (data == NULL) {
 142                 return;
 143         }
 144         bzero(data, sizeof(struct console_printbuf_state));
 145         if (write_on_newline) {
 146                 data->flags |= CONS_PB_WRITE_NEWLINE;
 147         }
 148         if (can_block) {
 149                 data->flags |= CONS_PB_CANBLOCK;
 150         }
 151 }
 152
 153 void
 154 console_printbuf_putc(int ch, void * arg)
 155 {
 156         struct console_printbuf_state * info = (struct console_printbuf_state *)arg;
 157         info->total += 1;
 158         if (info->pos < (SERIAL_CONS_BUF_SIZE - 1)) {
 159                 info->str[info->pos] = (char)ch;
 160                 info->pos += 1;
 161         } else {
 162                 /*
 163                  * when len(line) > SERIAL_CONS_BUF_SIZE, we truncate the message
 164                  * if boot-arg 'drain_uart_sync=1' is set, then
 165                  * drain all the buffer right now and append new ch
 166                  */
 167                 if (serialmode & SERIALMODE_SYNCDRAIN) {
 168                         info->str[info->pos] = '\0';
 169                         console_write(info->str, info->pos);
 170                         info->pos            = 0;
 171                         info->str[info->pos] = (char)ch;
 172                         info->pos += 1;
 173                 }
 174         }
 175
 176         info->str[info->pos] = '\0';
 177         /* if newline, then try output to console */
 178         if (ch == '\n' && info->flags & CONS_PB_WRITE_NEWLINE) {
 179                 console_write(info->str, info->pos);
 180                 info->pos            = 0;
 181                 info->str[info->pos] = '\0';
 182         }
 183 }
 184
 185 void
 186 console_printbuf_clear(struct console_printbuf_state * info)
 187 {
 188         if (info->pos != 0) {
 189                 console_write(info->str, info->pos);
 190         }
 191         info->pos = 0;
 192         info->str[info->pos] = '\0';
 193         info->total = 0;
 194 }