sys/dev/ofw/ofw_console.c

   1 /*-
   2  * Copyright (C) 2001 Benno Rice.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY Benno Rice ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  18  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  20  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  21  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  22  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  23  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #include <sys/cdefs.h>
  27 __FBSDID("$FreeBSD$");
  28
  29 #include "opt_ofw.h"
  30
  31 #include <sys/param.h>
  32 #include <sys/kdb.h>
  33 #include <sys/kernel.h>
  34 #include <sys/priv.h>
  35 #include <sys/systm.h>
  36 #include <sys/types.h>
  37 #include <sys/conf.h>
  38 #include <sys/cons.h>
  39 #include <sys/consio.h>
  40 #include <sys/tty.h>
  41
  42 #include <dev/ofw/openfirm.h>
  43
  44 #include <ddb/ddb.h>
  45
  46 #ifndef OFWCONS_POLL_HZ
  47 #define OFWCONS_POLL_HZ 4       /* 50-100 works best on Ultra2 */
  48 #endif
  49 #define OFBURSTLEN      128     /* max number of bytes to write in one chunk */
  50
  51 static tsw_open_t ofwtty_open;
  52 static tsw_close_t ofwtty_close;
  53 static tsw_outwakeup_t ofwtty_outwakeup;
  54
  55 static struct ttydevsw ofw_ttydevsw = {
  56         .tsw_flags      = TF_NOPREFIX,
  57         .tsw_open       = ofwtty_open,
  58         .tsw_close      = ofwtty_close,
  59         .tsw_outwakeup  = ofwtty_outwakeup,
  60 };
  61
  62 static int                      polltime;
  63 static struct callout_handle    ofw_timeouthandle
  64     = CALLOUT_HANDLE_INITIALIZER(&ofw_timeouthandle);
  65
  66 #if defined(KDB)
  67 static int                      alt_break_state;
  68 #endif
  69
  70 static void     ofw_timeout(void *);
  71
  72 static cn_probe_t       ofw_cnprobe;
  73 static cn_init_t        ofw_cninit;
  74 static cn_term_t        ofw_cnterm;
  75 static cn_getc_t        ofw_cngetc;
  76 static cn_putc_t        ofw_cnputc;
  77 static cn_grab_t        ofw_cngrab;
  78 static cn_ungrab_t      ofw_cnungrab;
  79
  80 CONSOLE_DRIVER(ofw);
  81
  82 static void
  83 cn_drvinit(void *unused)
  84 {
  85         phandle_t options;
  86         char output[32];
  87         struct tty *tp;
  88
  89         if (ofw_consdev.cn_pri != CN_DEAD &&
  90             ofw_consdev.cn_name[0] != '\0') {
  91                 tp = tty_alloc(&ofw_ttydevsw, NULL);
  92                 tty_makedev(tp, NULL, "%s", "ofwcons");
  93
  94                 /*
  95                  * XXX: This is a hack and it may result in two /dev/ttya
  96                  * XXX: devices on platforms where the sab driver works.
  97                  */
  98                 if ((options = OF_finddevice("/options")) == -1 ||
  99                     OF_getprop(options, "output-device", output,
 100                     sizeof(output)) == -1)
 101                         return;
 102                 if (strlen(output) > 0)
 103                         tty_makealias(tp, output);
 104         }
 105 }
 106
 107 SYSINIT(cndev, SI_SUB_CONFIGURE, SI_ORDER_MIDDLE, cn_drvinit, NULL);
 108
 109 static int      stdin;
 110 static int      stdout;
 111
 112 static int
 113 ofwtty_open(struct tty *tp)
 114 {
 115         polltime = hz / OFWCONS_POLL_HZ;
 116         if (polltime < 1)
 117                 polltime = 1;
 118
 119         ofw_timeouthandle = timeout(ofw_timeout, tp, polltime);
 120
 121         return (0);
 122 }
 123
 124 static void
 125 ofwtty_close(struct tty *tp)
 126 {
 127
 128         /* XXX Should be replaced with callout_stop(9) */
 129         untimeout(ofw_timeout, tp, ofw_timeouthandle);
 130 }
 131
 132 static void
 133 ofwtty_outwakeup(struct tty *tp)
 134 {
 135         int len;
 136         u_char buf[OFBURSTLEN];
 137
 138         for (;;) {
 139                 len = ttydisc_getc(tp, buf, sizeof buf);
 140                 if (len == 0)
 141                         break;
 142                 OF_write(stdout, buf, len);
 143         }
 144 }
 145
 146 static void
 147 ofw_timeout(void *v)
 148 {
 149         struct  tty *tp;
 150         int     c;
 151
 152         tp = (struct tty *)v;
 153
 154         tty_lock(tp);
 155         while ((c = ofw_cngetc(NULL)) != -1)
 156                 ttydisc_rint(tp, c, 0);
 157         ttydisc_rint_done(tp);
 158         tty_unlock(tp);
 159
 160         ofw_timeouthandle = timeout(ofw_timeout, tp, polltime);
 161 }
 162
 163 static void
 164 ofw_cnprobe(struct consdev *cp)
 165 {
 166         int chosen;
 167
 168         if ((chosen = OF_finddevice("/chosen")) == -1) {
 169                 cp->cn_pri = CN_DEAD;
 170                 return;
 171         }
 172
 173         if (OF_getprop(chosen, "stdin", &stdin, sizeof(stdin)) == -1) {
 174                 cp->cn_pri = CN_DEAD;
 175                 return;
 176         }
 177
 178         if (OF_getprop(chosen, "stdout", &stdout, sizeof(stdout)) == -1) {
 179                 cp->cn_pri = CN_DEAD;
 180                 return;
 181         }
 182
 183         cp->cn_pri = CN_LOW;
 184 }
 185
 186 static void
 187 ofw_cninit(struct consdev *cp)
 188 {
 189
 190         /* XXX: This is the alias, but that should be good enough */
 191         strcpy(cp->cn_name, "ofwcons");
 192 }
 193
 194 static void
 195 ofw_cnterm(struct consdev *cp)
 196 {
 197 }
 198
 199 static void
 200 ofw_cngrab(struct consdev *cp)
 201 {
 202 }
 203
 204 static void
 205 ofw_cnungrab(struct consdev *cp)
 206 {
 207 }
 208
 209 static int
 210 ofw_cngetc(struct consdev *cp)
 211 {
 212         unsigned char ch;
 213
 214         if (OF_read(stdin, &ch, 1) > 0) {
 215 #if defined(KDB)
 216                 kdb_alt_break(ch, &alt_break_state);
 217 #endif
 218                 return (ch);
 219         }
 220
 221         return (-1);
 222 }
 223
 224 static void
 225 ofw_cnputc(struct consdev *cp, int c)
 226 {
 227         char cbuf;
 228
 229         if (c == '\n') {
 230                 cbuf = '\r';
 231                 OF_write(stdout, &cbuf, 1);
 232         }
 233
 234         cbuf = c;
 235         OF_write(stdout, &cbuf, 1);
 236 }