Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / dev / netif / 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: src/sys/dev/sbni/if_sbnivar.h,v 1.1.2.3 2002/08/11 09:32:00 fjoe Exp $
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  arpcom arpcom;          /* ethernet common */
71
72         int     io_rid;
73         struct  resource *io_res;
74         int     io_off;
75
76         int     irq_rid;
77         struct  resource *irq_res;
78         void    *irq_handle;
79
80         struct  mbuf *rx_buf_p;         /* receive buffer ptr */
81         struct  mbuf *tx_buf_p;         /* transmit buffer ptr */
82         
83         u_int   pktlen;                 /* length of transmitting pkt */
84         u_int   framelen;               /* current frame length */
85         u_int   maxframe;               /* maximum valid frame length */
86         u_int   state;
87         u_int   inppos;                 /* positions in rx/tx buffers */
88         u_int   outpos;                 /* positions in rx/tx buffers */
89
90         /* transmitting frame number - from frames qty to 1 */
91         u_int   tx_frameno;
92
93         /* expected number of next receiving frame */
94         u_int   wait_frameno;
95
96         /* count of failed attempts to frame send - 32 attempts do before
97            error - while receiver tunes on opposite side of wire */
98         u_int   trans_errors;
99
100         /* idle time; send pong when limit exceeded */
101         u_int   timer_ticks;
102
103         /* fields used for receive level autoselection */
104         int     delta_rxl;
105         u_int   cur_rxl_index;
106         u_int   timeout_rxl;
107         u_int32_t       cur_rxl_rcvd;
108         u_int32_t       prev_rxl_rcvd;
109
110         struct  sbni_csr1 csr1;                 /* current value of CSR1 */
111         struct  sbni_in_stats in_stats;         /* internal statistics */ 
112
113         struct  callout_handle wch;
114
115         struct  sbni_softc *slave_sc;
116
117 #ifdef SBNI_DUAL_COMPOUND
118         struct  sbni_softc *link;
119 #endif
120 };
121
122 void    sbni_intr(void *);
123 int     sbni_probe(struct sbni_softc *);
124 void    sbni_attach(struct sbni_softc *, int, struct sbni_flags);
125
126 extern u_int32_t next_sbni_unit;
127
128 #ifdef SBNI_DUAL_COMPOUND
129 extern struct sbni_softc *sbni_headlist;
130
131 struct sbni_softc       *connect_to_master(struct sbni_softc *);
132 #endif
133 #endif  /* _KERNEL */
134
135 /*
136  * SBNI socket ioctl params
137  */
138 #define SIOCGHWFLAGS    _IOWR('i', 62, struct ifreq)    /* get flags */
139 #define SIOCSHWFLAGS    _IOWR('i', 61, struct ifreq)    /* set flags */
140 #define SIOCGINSTATS    _IOWR('i', 60, struct ifreq)    /* get internal stats */
141 #define SIOCRINSTATS    _IOWR('i', 63, struct ifreq)    /* reset internal stats */
142
143
144 /*
145  * CRC-32 stuff
146  */
147 #define CRC32(c,crc) (crc32tab[((size_t)(crc) ^ (c)) & 0xff] ^ (((crc) >> 8) & 0x00ffffff))
148       /* CRC generator EDB88320 */
149       /* CRC remainder 2144DF1C */
150       /* CRC initial value 0 */
151 #define CRC32_REMAINDER 0x2144df1c
152 #define CRC32_INITIAL 0x00000000