sys/sys/cons.h

   1 /*-
   2  * Copyright (c) 1988 University of Utah.
   3  * Copyright (c) 1991 The Regents of the University of California.
   4  * All rights reserved.
   5  *
   6  * This code is derived from software contributed to Berkeley by
   7  * the Systems Programming Group of the University of Utah Computer
   8  * Science Department.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 4. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      from: @(#)cons.h        7.2 (Berkeley) 5/9/91
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _MACHINE_CONS_H_
  39 #define _MACHINE_CONS_H_
  40
  41 struct consdev;
  42 struct tty;
  43
  44 typedef void    cn_probe_t(struct consdev *);
  45 typedef void    cn_init_t(struct consdev *);
  46 typedef void    cn_term_t(struct consdev *);
  47 typedef void    cn_grab_t(struct consdev *);
  48 typedef void    cn_ungrab_t(struct consdev *);
  49 typedef int     cn_getc_t(struct consdev *);
  50 typedef void    cn_putc_t(struct consdev *, int);
  51
  52 struct consdev_ops {
  53         cn_probe_t      *cn_probe;
  54                                 /* probe hardware and fill in consdev info */
  55         cn_init_t       *cn_init;
  56                                 /* turn on as console */
  57         cn_term_t       *cn_term;
  58                                 /* turn off as console */
  59         cn_getc_t       *cn_getc;
  60                                 /* kernel getchar interface */
  61         cn_putc_t       *cn_putc;
  62                                 /* kernel putchar interface */
  63         cn_grab_t       *cn_grab;
  64                                 /* grab console for exclusive kernel use */
  65         cn_ungrab_t     *cn_ungrab;
  66                                 /* ungrab console */
  67 };
  68
  69 struct consdev {
  70         const struct consdev_ops *cn_ops;
  71                                 /* console device operations. */
  72         short   cn_pri;         /* pecking order; the higher the better */
  73         void    *cn_arg;        /* drivers method argument */
  74         int     cn_flags;       /* capabilities of this console */
  75         char    cn_name[SPECNAMELEN + 1];       /* console (device) name */
  76 };
  77
  78 /* values for cn_pri - reflect our policy for console selection */
  79 #define CN_DEAD         0       /* device doesn't exist */
  80 #define CN_LOW          1       /* device is a last restort only */
  81 #define CN_NORMAL       2       /* device exists but is nothing special */
  82 #define CN_INTERNAL     3       /* "internal" bit-mapped display */
  83 #define CN_REMOTE       4       /* serial interface with remote bit set */
  84
  85 /* Values for cn_flags. */
  86 #define CN_FLAG_NODEBUG 0x00000001      /* Not supported with debugger. */
  87 #define CN_FLAG_NOAVAIL 0x00000002      /* Temporarily not available. */
  88
  89 /* Visibility of characters in cngets() */
  90 #define GETS_NOECHO     0       /* Disable echoing of characters. */
  91 #define GETS_ECHO       1       /* Enable echoing of characters. */
  92 #define GETS_ECHOPASS   2       /* Print a * for every character. */
  93
  94 #ifdef _KERNEL
  95
  96 extern  struct msgbuf consmsgbuf; /* Message buffer for constty. */
  97 extern  struct tty *constty;    /* Temporary virtual console. */
  98
  99 #define CONSOLE_DEVICE(name, ops, arg)                                  \
 100         static struct consdev name = {                                  \
 101                 .cn_ops = &ops,                                         \
 102                 .cn_arg = (arg),                                        \
 103         };                                                              \
 104         DATA_SET(cons_set, name)
 105
 106 #define CONSOLE_DRIVER(name)                                            \
 107         static const struct consdev_ops name##_consdev_ops = {          \
 108                 .cn_probe = name##_cnprobe,                             \
 109                 .cn_init = name##_cninit,                               \
 110                 .cn_term = name##_cnterm,                               \
 111                 .cn_getc = name##_cngetc,                               \
 112                 .cn_putc = name##_cnputc,                               \
 113                 .cn_grab = name##_cngrab,                               \
 114                 .cn_ungrab = name##_cnungrab,                           \
 115         };                                                              \
 116         CONSOLE_DEVICE(name##_consdev, name##_consdev_ops, NULL)
 117
 118 /* Other kernel entry points. */
 119 void    cninit(void);
 120 void    cninit_finish(void);
 121 int     cnadd(struct consdev *);
 122 void    cnavailable(struct consdev *, int);
 123 void    cnremove(struct consdev *);
 124 void    cnselect(struct consdev *);
 125 void    cngrab(void);
 126 void    cnungrab(void);
 127 int     cncheckc(void);
 128 int     cngetc(void);
 129 void    cngets(char *, size_t, int);
 130 void    cnputc(int);
 131 void    cnputs(char *);
 132 int     cnunavailable(void);
 133 void    constty_set(struct tty *tp);
 134 void    constty_clear(void);
 135
 136 #endif /* _KERNEL */
 137
 138 #endif /* !_MACHINE_CONS_H_ */