sys/dev/ic/esp.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1995 Sean Eric Fagan.
   5  * 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. Neither the name of the author nor the names of contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  * $FreeBSD$
  32  */
  33
  34 #ifndef _IC_ESP_H_
  35 #define _IC_ESP_H_
  36
  37 /*
  38  * Definitions for Hayes ESP serial cards.
  39  */
  40
  41 /*
  42  * CMD1 and CMD2 are the command ports, offsets from <esp_iobase>.
  43  */
  44 #define ESP_CMD1        4
  45 #define ESP_CMD2        5
  46
  47 /*
  48  * STAT1 and STAT2 are to get return values and status bytes;
  49  * they overload CMD1 and CMD2.
  50  */
  51 #define ESP_STATUS1     ESP_CMD1
  52 #define ESP_STATUS2     ESP_CMD2
  53
  54 /*
  55  * Commands.  Commands are given by writing the command value to
  56  * ESP_CMD1 and then writing or reading some number of bytes from
  57  * ESP_CMD2 or ESP_STATUS2.
  58  */
  59 #define ESP_GETTEST     0x01    /* self-test command (1 byte + extras) */
  60 #define ESP_GETDIPS     0x02    /* get on-board DIP switches (1 byte) */
  61 #define ESP_SETFLOWTYPE 0x08    /* set type of flow-control (2 bytes) */
  62 #define ESP_SETRXFLOW   0x0a    /* set Rx FIFO flow control levels (4 bytes) */
  63 #define ESP_SETMODE     0x10    /* set board mode (1 byte) */
  64 #define ESP_SETCLOCK    0x23    /* set UART clock prescaler */
  65
  66 /* Mode bits (ESP_SETMODE). */
  67 #define ESP_MODE_FIFO   0x02    /* act like a 16550 (compatibility mode) */
  68 #define ESP_MODE_RTS    0x04    /* use RTS hardware flow control */
  69 #define ESP_MODE_SCALE  0x80    /* scale FIFO trigger levels */
  70
  71 /* Flow control type bits (ESP_SETFLOWTYPE). */
  72 #define ESP_FLOW_RTS    0x04    /* cmd1: local Rx sends RTS flow control */
  73 #define ESP_FLOW_CTS    0x10    /* cmd2: local transmitter responds to CTS */
  74
  75 /* Used by ESP_SETRXFLOW. */
  76 #define HIBYTE(w)       (((w) >> 8) & 0xff)
  77 #define LOBYTE(w)       ((w) & 0xff)
  78
  79 #endif /* !_IC_ESP_H_ */