sys/dev/sbni/if_sbnivar.h

   1 /*-
   2  * Copyright (c) 1997-2001 Granch, Ltd. All rights reserved.
   3  * Author: Denis I.Timofeev <timofeev@granch.ru>
   4  *
   5  * Redistributon 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 unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 /*
  31  * SBNI12 definitions
  32  */
  33
  34 /*
  35  * CONFIGURATION PARAMETER:
  36  *
  37  *      Uncomment this if you want to use model SBNI12D-11/ISA with same IRQ
  38  *      for both first and second channels.
  39  */
  40 #define SBNI_DUAL_COMPOUND 1
  41
  42 #define SBNI_DEBUG 0
  43
  44 #if SBNI_DEBUG
  45 #define DP(A) A
  46 #else
  47 #define DP(A)
  48 #endif
  49
  50 struct sbni_in_stats {
  51         u_int32_t       all_rx_number;
  52         u_int32_t       bad_rx_number;
  53         u_int32_t       timeout_number;
  54         u_int32_t       all_tx_number;
  55         u_int32_t       resend_tx_number;
  56 };
  57
  58 struct sbni_flags {
  59         u_int   mac_addr        : 24;
  60         u_int   rxl             : 4;
  61         u_int   rate            : 2;
  62         u_int   fixed_rxl       : 1;
  63         u_int   fixed_rate      : 1;
  64 };
  65
  66
  67 #ifdef _KERNEL  /* to avoid compile this decls with sbniconfig */
  68
  69 struct sbni_softc {
  70         struct  ifnet *ifp;
  71         device_t dev;
  72         u_char  enaddr[6];
  73
  74         int     io_rid;
  75         struct  resource *io_res;
  76         int     io_off;
  77
  78         int     irq_rid;
  79         struct  resource *irq_res;
  80         void    *irq_handle;
  81
  82         struct  mbuf *rx_buf_p;         /* receive buffer ptr */
  83         struct  mbuf *tx_buf_p;         /* transmit buffer ptr */
  84
  85         u_int   pktlen;                 /* length of transmitting pkt */
  86         u_int   framelen;               /* current frame length */
  87         u_int   maxframe;               /* maximum valid frame length */
  88         u_int   state;
  89         u_int   inppos;                 /* positions in rx/tx buffers */
  90         u_int   outpos;                 /* positions in rx/tx buffers */
  91
  92         /* transmitting frame number - from frames qty to 1 */
  93         u_int   tx_frameno;
  94
  95         /* expected number of next receiving frame */
  96         u_int   wait_frameno;
  97
  98         /* count of failed attempts to frame send - 32 attempts do before
  99            error - while receiver tunes on opposite side of wire */
 100         u_int   trans_errors;
 101
 102         /* idle time; send pong when limit exceeded */
 103         u_int   timer_ticks;
 104
 105         /* fields used for receive level autoselection */
 106         int     delta_rxl;
 107         u_int   cur_rxl_index;
 108         u_int   timeout_rxl;
 109         u_int32_t       cur_rxl_rcvd;
 110         u_int32_t       prev_rxl_rcvd;
 111
 112         struct  sbni_csr1 csr1;                 /* current value of CSR1 */
 113         struct  sbni_in_stats in_stats;         /* internal statistics */
 114
 115         struct  callout wch;
 116         struct  mtx lock;
 117
 118         struct  sbni_softc *slave_sc;
 119
 120 #ifdef SBNI_DUAL_COMPOUND
 121         struct  sbni_softc *link;
 122 #endif
 123 };
 124
 125 #define SBNI_LOCK(sc)           mtx_lock(&(sc)->lock)
 126 #define SBNI_UNLOCK(sc)         mtx_unlock(&(sc)->lock)
 127 #define SBNI_ASSERT_LOCKED(sc)  mtx_assert(&(sc)->lock, MA_OWNED)
 128
 129 void    sbni_intr(void *);
 130 int     sbni_probe(struct sbni_softc *);
 131 int     sbni_attach(struct sbni_softc *, int, struct sbni_flags);
 132 void    sbni_detach(struct sbni_softc *);
 133 void    sbni_release_resources(struct sbni_softc *);
 134
 135 extern u_int32_t next_sbni_unit;
 136
 137 #ifdef SBNI_DUAL_COMPOUND
 138 void                    sbni_add(struct sbni_softc *);
 139 struct sbni_softc       *connect_to_master(struct sbni_softc *);
 140 #endif
 141 #endif  /* _KERNEL */
 142
 143 /*
 144  * SBNI socket ioctl params
 145  */
 146 #define SIOCGHWFLAGS    _IOWR('i', 62, struct ifreq)    /* get flags */
 147 #define SIOCSHWFLAGS    _IOWR('i', 61, struct ifreq)    /* set flags */
 148 #define SIOCGINSTATS    _IOWR('i', 60, struct ifreq)    /* get internal stats */
 149 #define SIOCRINSTATS    _IOWR('i', 63, struct ifreq)    /* reset internal stats */
 150
 151
 152 /*
 153  * CRC-32 stuff
 154  */
 155 #define CRC32(c,crc) (crc32tab[((size_t)(crc) ^ (c)) & 0xff] ^ (((crc) >> 8) & 0x00ffffff))
 156       /* CRC generator EDB88320 */
 157       /* CRC remainder 2144DF1C */
 158       /* CRC initial value 0 */
 159 #define CRC32_REMAINDER 0x2144df1c
 160 #define CRC32_INITIAL 0x00000000