sys/dev/dcons/dcons.h

   1 /*-
   2  * Copyright (C) 2002-2004
   3  *      Hidetoshi Shimokawa. 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  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *
  16  *      This product includes software developed by Hidetoshi Shimokawa.
  17  *
  18  * 4. Neither the name of the author 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  * $Id: dcons.h,v 1.15 2003/10/23 15:05:31 simokawa Exp $
  35  * $FreeBSD$
  36  */
  37
  38 #if defined(_KERNEL) || defined(_BOOT)
  39 #define V volatile
  40 #else
  41 #define V
  42 #endif
  43
  44 #define DCONS_NPORT     2
  45 #define DCONS_CON       0
  46 #define DCONS_GDB       1
  47
  48 struct dcons_buf {
  49 #define DCONS_VERSION 2
  50         V u_int32_t version;
  51         V u_int32_t ooffset[DCONS_NPORT];
  52         V u_int32_t ioffset[DCONS_NPORT];
  53         V u_int32_t osize[DCONS_NPORT];
  54         V u_int32_t isize[DCONS_NPORT];
  55 #define DCONS_MAGIC 0x64636f6e  /* "dcon" */
  56         V u_int32_t magic;
  57 #define DCONS_GEN_SHIFT         (24)
  58 #define DCONS_GEN_MASK          (0xff)
  59 #define DCONS_POS_MASK  ((1<< DCONS_GEN_SHIFT) - 1)
  60         V u_int32_t optr[DCONS_NPORT];
  61         V u_int32_t iptr[DCONS_NPORT];
  62         V char buf[0];
  63 };
  64
  65 #define DCONS_CSR_VAL_VER       0x64636f /* "dco" */
  66 #define DCONS_CSR_KEY_HI        0x3a
  67 #define DCONS_CSR_KEY_LO        0x3b
  68 #define DCONS_CSR_KEY_RESET_HI  0x3c
  69 #define DCONS_CSR_KEY_RESET_LO  0x3d
  70
  71 #define DCONS_HEADER_SIZE sizeof(struct dcons_buf)
  72 #define DCONS_MAKE_PTR(x)       htonl(((x)->gen << DCONS_GEN_SHIFT) | (x)->pos)
  73 #define DCONS_NEXT_GEN(x)       (((x) + 1) & DCONS_GEN_MASK)
  74
  75 struct dcons_ch {
  76         u_int32_t size;
  77         u_int32_t gen;
  78         u_int32_t pos;
  79 #if defined(_KERNEL) || defined(_BOOT)
  80         V u_int32_t *ptr;
  81         V char *buf;
  82 #else
  83         off_t buf;
  84 #endif
  85 };
  86
  87 #define KEY_CTRLB       2       /* ^B */
  88 #define KEY_CR          13      /* CR '\r' */
  89 #define KEY_TILDE       126     /* ~ */
  90 #define STATE0          0
  91 #define STATE1          1
  92 #define STATE2          2
  93 #define STATE3          3
  94
  95 #if defined(_KERNEL) || defined(_BOOT)
  96 struct dcons_softc {
  97         struct dcons_ch o, i;
  98         int brk_state;
  99 #define DC_GDB  1
 100         int flags;
 101         void *tty;
 102 };
 103
 104 int     dcons_checkc(struct dcons_softc *);
 105 int     dcons_ischar(struct dcons_softc *);
 106 void    dcons_putc(struct dcons_softc *, int);
 107 int     dcons_load_buffer(struct dcons_buf *, int, struct dcons_softc *);
 108 void    dcons_init(struct dcons_buf *, int, struct dcons_softc *);
 109 #endif