sys/dev/dcons/dcons.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-4-Clause
   3  *
   4  * Copyright (C) 2002-2004
   5  *      Hidetoshi Shimokawa. All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. All advertising materials mentioning features or use of this software
  16  *    must display the following acknowledgement:
  17  *
  18  *      This product includes software developed by Hidetoshi Shimokawa.
  19  *
  20  * 4. Neither the name of the author nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  * $Id: dcons.h,v 1.15 2003/10/23 15:05:31 simokawa Exp $
  37  * $FreeBSD$
  38  */
  39
  40 #if defined(_KERNEL) || defined(_BOOT)
  41 #define V volatile
  42 #else
  43 #define V
  44 #endif
  45
  46 #define DCONS_NPORT     2
  47 #define DCONS_CON       0
  48 #define DCONS_GDB       1
  49
  50 struct dcons_buf {
  51 #define DCONS_VERSION 2
  52         V u_int32_t version;
  53         V u_int32_t ooffset[DCONS_NPORT];
  54         V u_int32_t ioffset[DCONS_NPORT];
  55         V u_int32_t osize[DCONS_NPORT];
  56         V u_int32_t isize[DCONS_NPORT];
  57 #define DCONS_MAGIC 0x64636f6e  /* "dcon" */
  58         V u_int32_t magic;
  59 #define DCONS_GEN_SHIFT         (24)
  60 #define DCONS_GEN_MASK          (0xff)
  61 #define DCONS_POS_MASK  ((1<< DCONS_GEN_SHIFT) - 1)
  62         V u_int32_t optr[DCONS_NPORT];
  63         V u_int32_t iptr[DCONS_NPORT];
  64         V char buf[0];
  65 };
  66
  67 #define DCONS_CSR_VAL_VER       0x64636f /* "dco" */
  68 #define DCONS_CSR_KEY_HI        0x3a
  69 #define DCONS_CSR_KEY_LO        0x3b
  70 #define DCONS_CSR_KEY_RESET_HI  0x3c
  71 #define DCONS_CSR_KEY_RESET_LO  0x3d
  72
  73 #define DCONS_HEADER_SIZE sizeof(struct dcons_buf)
  74 #define DCONS_MAKE_PTR(x)       htonl(((x)->gen << DCONS_GEN_SHIFT) | (x)->pos)
  75 #define DCONS_NEXT_GEN(x)       (((x) + 1) & DCONS_GEN_MASK)
  76
  77 struct dcons_ch {
  78         u_int32_t size;
  79         u_int32_t gen;
  80         u_int32_t pos;
  81 #if defined(_KERNEL) || defined(_BOOT)
  82         V u_int32_t *ptr;
  83         V char *buf;
  84 #else
  85         off_t buf;
  86 #endif
  87 };
  88
  89 #define KEY_CTRLB       2       /* ^B */
  90 #define KEY_CR          13      /* CR '\r' */
  91 #define KEY_TILDE       126     /* ~ */
  92 #define STATE0          0
  93 #define STATE1          1
  94 #define STATE2          2
  95 #define STATE3          3
  96
  97 #if defined(_KERNEL) || defined(_BOOT)
  98 struct dcons_softc {
  99         struct dcons_ch o, i;
 100         int brk_state;
 101 #define DC_GDB  1
 102         int flags;
 103         void *tty;
 104 };
 105
 106 int     dcons_checkc(struct dcons_softc *);
 107 int     dcons_ischar(struct dcons_softc *);
 108 void    dcons_putc(struct dcons_softc *, int);
 109 int     dcons_load_buffer(struct dcons_buf *, int, struct dcons_softc *);
 110 void    dcons_init(struct dcons_buf *, int, struct dcons_softc *);
 111 #endif