Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / dev / netif / ed / if_edvar.h
1 /*
2  * Copyright (c) 1995, David Greenman
3  * All rights reserved.
4  *
5  * Redistribution 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 NEGLIGENCE 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/ed/if_edvar.h,v 1.4.2.4 2001/07/25 18:06:01 iedowse Exp $
28  */
29
30 /*
31  * ed_softc: per line info and status
32  */
33 struct ed_softc {
34         struct arpcom arpcom;   /* ethernet common */
35
36         char   *type_str;       /* pointer to type string */
37         u_char  vendor;         /* interface vendor */
38         u_char  type;           /* interface type code */
39         u_char  gone;           /* HW missing, presumed having a good time */
40
41         int     port_rid;       /* resource id for port range */
42         int     port_used;      /* nonzero if ports used */
43         struct resource* port_res; /* resource for port range */
44         int     mem_rid;        /* resource id for memory range */
45         int     mem_used;       /* nonzero if memory used */
46         struct resource* mem_res; /* resource for memory range */
47         int     irq_rid;        /* resource id for irq */
48         struct resource* irq_res; /* resource for irq */
49         void*   irq_handle;     /* handle for irq handler */
50         device_t miibus;        /* MII bus for cards with MII. */
51         void    (*mii_writebits)__P((struct ed_softc *, u_int, int));
52         u_int   (*mii_readbits)__P((struct ed_softc *, int));
53         struct callout_handle tick_ch; /* Callout handle for ed_tick */
54
55         int     nic_offset;     /* NIC (DS8390) I/O bus address offset */
56         int     asic_offset;    /* ASIC I/O bus address offset */
57
58 /*
59  * The following 'proto' variable is part of a work-around for 8013EBT asics
60  *      being write-only. It's sort of a prototype/shadow of the real thing.
61  */
62         u_char  wd_laar_proto;
63         u_char  cr_proto;
64         u_char  isa16bit;       /* width of access to card 0=8 or 1=16 */
65         int     chip_type;      /* the type of chip (one of ED_CHIP_TYPE_*) */
66
67 /*
68  * HP PC LAN PLUS card support.
69  */
70
71         u_short hpp_options;    /* flags controlling behaviour of the HP card */
72         u_short hpp_id;         /* software revision and other fields */
73         caddr_t hpp_mem_start;  /* Memory-mapped IO register address */
74
75         caddr_t mem_start;      /* NIC memory start address */
76         caddr_t mem_end;                /* NIC memory end address */
77         u_int32_t mem_size;     /* total NIC memory size */
78         caddr_t mem_ring;       /* start of RX ring-buffer (in NIC mem) */
79
80         u_char  mem_shared;     /* NIC memory is shared with host */
81         u_char  xmit_busy;      /* transmitter is busy */
82         u_char  txb_cnt;        /* number of transmit buffers */
83         u_char  txb_inuse;      /* number of TX buffers currently in-use */
84
85         u_char  txb_new;        /* pointer to where new buffer will be added */
86         u_char  txb_next_tx;    /* pointer to next buffer ready to xmit */
87         u_short txb_len[8];     /* buffered xmit buffer lengths */
88         u_char  tx_page_start;  /* first page of TX buffer area */
89         u_char  rec_page_start; /* first page of RX ring-buffer */
90         u_char  rec_page_stop;  /* last page of RX ring-buffer */
91         u_char  next_packet;    /* pointer to next unread RX packet */
92         struct  ifmib_iso_8802_3 mibdata; /* stuff for network mgmt */
93 };
94
95 #define ed_nic_inb(sc, port) \
96         bus_space_read_1(rman_get_bustag((sc)->port_res), \
97                 rman_get_bushandle((sc)->port_res), (sc)->nic_offset + (port))
98
99 #define ed_nic_outb(sc, port, value) \
100         bus_space_write_1(rman_get_bustag((sc)->port_res), \
101                 rman_get_bushandle((sc)->port_res), (sc)->nic_offset + (port), \
102                 (value))
103
104 #define ed_nic_inw(sc, port) \
105         bus_space_read_2(rman_get_bustag((sc)->port_res), \
106                 rman_get_bushandle((sc)->port_res), (sc)->nic_offset + (port))
107
108 #define ed_nic_outw(sc, port, value) \
109         bus_space_write_2(rman_get_bustag((sc)->port_res), \
110                 rman_get_bushandle((sc)->port_res), (sc)->nic_offset + (port), \
111                 (value))
112
113 #define ed_nic_insb(sc, port, addr, count) \
114         bus_space_read_multi_1(rman_get_bustag((sc)->port_res), \
115                 rman_get_bushandle((sc)->port_res), \
116                 (sc)->nic_offset + (port), (addr), (count))
117
118 #define ed_nic_outsb(sc, port, addr, count) \
119         bus_space_write_multi_1(rman_get_bustag((sc)->port_res), \
120                 rman_get_bushandle((sc)->port_res), \
121                 (sc)->nic_offset + (port), (addr), (count))
122
123 #define ed_nic_insw(sc, port, addr, count) \
124         bus_space_read_multi_2(rman_get_bustag((sc)->port_res), \
125                 rman_get_bushandle((sc)->port_res), \
126                 (sc)->nic_offset + (port), (u_int16_t *)(addr), (count))
127
128 #define ed_nic_outsw(sc, port, addr, count) \
129         bus_space_write_multi_2(rman_get_bustag((sc)->port_res), \
130                 rman_get_bushandle((sc)->port_res), \
131                 (sc)->nic_offset + (port), (u_int16_t *)(addr), (count))
132
133 #define ed_nic_insl(sc, port, addr, count) \
134         bus_space_read_multi_4(rman_get_bustag((sc)->port_res), \
135                 rman_get_bushandle((sc)->port_res), \
136                 (sc)->nic_offset + (port), (u_int32_t *)(addr), (count))
137
138 #define ed_nic_outsl(sc, port, addr, count) \
139         bus_space_write_multi_4(rman_get_bustag((sc)->port_res), \
140                 rman_get_bushandle((sc)->port_res), \
141                 (sc)->nic_offset + (port), (u_int32_t *)(addr), (count))
142
143 #define ed_asic_inb(sc, port) \
144         bus_space_read_1(rman_get_bustag((sc)->port_res), \
145                 rman_get_bushandle((sc)->port_res), (sc)->asic_offset + (port))
146
147 #define ed_asic_outb(sc, port, value) \
148         bus_space_write_1(rman_get_bustag((sc)->port_res), \
149                 rman_get_bushandle((sc)->port_res), (sc)->asic_offset + (port), \
150                 (value))
151
152 #define ed_asic_inw(sc, port) \
153         bus_space_read_2(rman_get_bustag((sc)->port_res), \
154                 rman_get_bushandle((sc)->port_res), (sc)->asic_offset + (port))
155
156 #define ed_asic_outw(sc, port, value) \
157         bus_space_write_2(rman_get_bustag((sc)->port_res), \
158                 rman_get_bushandle((sc)->port_res), (sc)->asic_offset + (port), \
159                 (value))
160
161 #define ed_asic_insb(sc, port, addr, count) \
162         bus_space_read_multi_1(rman_get_bustag((sc)->port_res), \
163                 rman_get_bushandle((sc)->port_res), \
164                 (sc)->asic_offset + (port), (addr), (count))
165
166 #define ed_asic_outsb(sc, port, addr, count) \
167         bus_space_write_multi_1(rman_get_bustag((sc)->port_res), \
168                 rman_get_bushandle((sc)->port_res), \
169                 (sc)->asic_offset + (port), (addr), (count))
170
171 #define ed_asic_insw(sc, port, addr, count) \
172         bus_space_read_multi_2(rman_get_bustag((sc)->port_res), \
173                 rman_get_bushandle((sc)->port_res), \
174                 (sc)->asic_offset + (port), (u_int16_t *)(addr), (count))
175
176 #define ed_asic_outsw(sc, port, addr, count) \
177         bus_space_write_multi_2(rman_get_bustag((sc)->port_res), \
178                 rman_get_bushandle((sc)->port_res), \
179                 (sc)->asic_offset + (port), (u_int16_t *)(addr), (count))
180
181 #define ed_asic_insl(sc, port, addr, count) \
182         bus_space_read_multi_4(rman_get_bustag((sc)->port_res), \
183                 rman_get_bushandle((sc)->port_res), \
184                 (sc)->asic_offset + (port), (u_int32_t *)(addr), (count))
185
186 #define ed_asic_outsl(sc, port, addr, count) \
187         bus_space_write_multi_4(rman_get_bustag((sc)->port_res), \
188                 rman_get_bushandle((sc)->port_res), \
189                 (sc)->asic_offset + (port), (u_int32_t *)(addr), (count))
190
191 void    ed_release_resources    __P((device_t));
192 int     ed_alloc_port           __P((device_t, int, int));
193 int     ed_alloc_memory         __P((device_t, int, int));
194 int     ed_alloc_irq            __P((device_t, int, int));
195
196 int     ed_probe_generic8390    __P((struct ed_softc *));
197 int     ed_probe_WD80x3         __P((device_t, int, int));
198 int     ed_probe_WD80x3_generic __P((device_t, int, unsigned short *[]));
199 int     ed_probe_3Com           __P((device_t, int, int));
200 int     ed_probe_Novell         __P((device_t, int, int));
201 int     ed_probe_Novell_generic __P((device_t, int));
202 int     ed_probe_HP_pclanp      __P((device_t, int, int));
203
204 int     ed_attach               __P((struct ed_softc *, int, int));
205 void    ed_stop                 __P((struct ed_softc *));
206 void    ed_pio_readmem          __P((struct ed_softc *, int, unsigned char *,
207                                      unsigned short));
208 void    ed_pio_writemem         __P((struct ed_softc *, char *,
209                                      unsigned short, unsigned short));
210 int     ed_miibus_readreg       __P((device_t, int, int));
211 void    ed_miibus_writereg      __P((device_t, int, int, int));
212 int     ed_ifmedia_upd          __P((struct ifnet *));
213 void    ed_ifmedia_sts          __P((struct ifnet *, struct ifmediareq *));
214 void    ed_child_detached       __P((device_t, device_t));
215
216 driver_intr_t   edintr;
217