sys/dev/ic/sunscpalreg.h

   1 /*      $NetBSD: sunscpalreg.h,v 1.2 2001/07/15 16:32:40 fredette Exp $ */
   2
   3 /*-
   4  * Copyright (c) 2001 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to The NetBSD Foundation
   8  * by Matthew Fredette.
   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  *
  19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 /*
  33  * Macros for accessing the registers in the Sun "Sun-2" "sc"
  34  * PAL+logic sequencer chips.
  35  */
  36
  37 /*
  38  * Interface Control Register.
  39  *
  40  * This register pretty much just reflects the state of the SCSI
  41  * bus, directly.  For example, the _COMMAND_DATA, _MESSAGE,
  42  * and _INPUT_OUTPUT bits and their values correspond directly
  43  * to SCSI bus signals.
  44  *
  45  * Note:
  46  *      (r)     indicates bit is read only.
  47  *      (rw)    indicates bit is read or write.
  48  */
  49 #define SUNSCPAL_ICR_PARITY_ERROR       0x8000  /* (r) parity error */
  50 #define SUNSCPAL_ICR_BUS_ERROR          0x4000  /* (r) bus error */
  51 #define SUNSCPAL_ICR_ODD_LENGTH         0x2000  /* (r) odd length */
  52 #define SUNSCPAL_ICR_INTERRUPT_REQUEST  0x1000  /* (r) interrupt request */
  53 #define SUNSCPAL_ICR_REQUEST            0x0800  /* (r) request */
  54 #define SUNSCPAL_ICR_MESSAGE            0x0400  /* (r) message */
  55 #define SUNSCPAL_ICR_COMMAND_DATA       0x0200  /* (r) 1=command, 0=data */
  56 #define SUNSCPAL_ICR_INPUT_OUTPUT       0x0100  /* (r) 1=input (initiator should read), 0=output */
  57 #define SUNSCPAL_ICR_PARITY             0x0080  /* (r) parity */
  58 #define SUNSCPAL_ICR_BUSY               0x0040  /* (r) busy */
  59 #define SUNSCPAL_ICR_SELECT             0x0020  /* (rw) select */
  60 #define SUNSCPAL_ICR_RESET              0x0010  /* (rw) reset */
  61 #define SUNSCPAL_ICR_PARITY_ENABLE      0x0008  /* (rw) enable parity */
  62 #define SUNSCPAL_ICR_WORD_MODE          0x0004  /* (rw) word mode */
  63 #define SUNSCPAL_ICR_DMA_ENABLE         0x0002  /* (rw) enable DMA */
  64 #define SUNSCPAL_ICR_INTERRUPT_ENABLE   0x0001  /* (rw) enable interrupts */
  65
  66 #define SUNSCPAL_ICR_BITS       "\20\1INTEN\2DMAEN\3WM\4PAREN\5RESET\6SEL\7BSY\10PAR\11INPUT\12CMD\13MSG\14REQ\15INTRQ\16ODD\17BUSERR\20PARERR"
  67
  68 /*
  69  * This chip keeps its DMA count with its bits flipped.  Normally, you
  70  * would just use the ~ operator everywhere.  However, apparently that
  71  * operator doesn't always work as you would expect, i.e.:
  72  *
  73  * #include <stdio.h>
  74  * int main() {
  75  *   unsigned short x;
  76  *   int y;
  77  *   x = 0;
  78  *   y = ~x;
  79  *   printf("%d\n", y);
  80  * }
  81  *
  82  * prints -1, not 65535.  So this macro does the bit-flipping
  83  * carefully for you.
  84  */
  85 #define SUNSCPAL_DMA_COUNT_FLIP(x) (((unsigned short) (x)) ^ 0xFFFF)