xref: /dragonfly/sys/dev/netif/lnc/lancevar.h (revision e7a56c3e6c5128a8051123d9ee7c61b8bbe142b2)
1 /*        $NetBSD: lancevar.h,v 1.10 2005/12/11 12:21:27 christos Exp $         */
2 /*        $FreeBSD: src/sys/dev/le/lancevar.h,v 1.2 2006/05/16 21:04:01 marius Exp $      */
3 /*        $DragonFly: src/sys/dev/netif/lnc/lancevar.h,v 1.1 2006/07/07 14:16:29 sephe Exp $        */
4 
5 
6 /*-
7  * Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
8  * All rights reserved.
9  *
10  * This code is derived from software contributed to The NetBSD Foundation
11  * by Charles M. Hannum and by Jason R. Thorpe of the Numerical Aerospace
12  * Simulation Facility, NASA Ames Research Center.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the distribution.
22  * 3. All advertising materials mentioning features or use of this software
23  *    must display the following acknowledgement:
24  *        This product includes software developed by the NetBSD
25  *        Foundation, Inc. and its contributors.
26  * 4. Neither the name of The NetBSD Foundation nor the names of its
27  *    contributors may be used to endorse or promote products derived
28  *    from this software without specific prior written permission.
29  *
30  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
31  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
32  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
33  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
34  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
35  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
36  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
37  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
38  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
40  * POSSIBILITY OF SUCH DAMAGE.
41  */
42 
43 #ifndef _DEV_LE_LANCEVAR_H_
44 #define   _DEV_LE_LANCEVAR_H_
45 
46 extern devclass_t le_devclass;
47 
48 struct lance_softc {
49           struct arpcom       sc_arp;
50           struct ifnet        *ifp;
51           struct ifmedia      sc_media;
52 
53           /*
54            * Memory functions:
55            *
56            *        copy to/from descriptor
57            *        copy to/from buffer
58            *        zero bytes in buffer
59            */
60           void      (*sc_copytodesc)(struct lance_softc *, void *, int, int);
61           void      (*sc_copyfromdesc)(struct lance_softc *, void *, int, int);
62           void      (*sc_copytobuf)(struct lance_softc *, void *, int, int);
63           void      (*sc_copyfrombuf)(struct lance_softc *, void *, int, int);
64           void      (*sc_zerobuf)(struct lance_softc *, int, int);
65 
66           /*
67            * Machine-dependent functions:
68            *
69            *        read/write CSR
70            *        hardware reset hook - may be NULL
71            *        hardware init hook - may be NULL
72            *        no carrier hook - may be NULL
73            *        media change hook - may be NULL
74            */
75           uint16_t  (*sc_rdcsr)(struct lance_softc *, uint16_t);
76           void      (*sc_wrcsr)(struct lance_softc *, uint16_t, uint16_t);
77           void      (*sc_hwreset)(struct lance_softc *);
78           void      (*sc_hwinit)(struct lance_softc *);
79           int       (*sc_hwintr)(struct lance_softc *);
80           void      (*sc_nocarrier)(struct lance_softc *);
81           int       (*sc_mediachange)(struct lance_softc *);
82           void      (*sc_mediastatus)(struct lance_softc *, struct ifmediareq *);
83 
84           /*
85            * Media-supported by this interface.  If this is NULL,
86            * the only supported media is assumed to be "manual".
87            */
88           const int *sc_supmedia;
89           int       sc_nsupmedia;
90           int       sc_defaultmedia;
91 
92           uint16_t  sc_conf3; /* CSR3 value */
93 
94           void      *sc_mem;            /* base address of RAM - CPU's view */
95           bus_addr_t          sc_addr;  /* base address of RAM - LANCE's view */
96 
97           bus_size_t          sc_memsize;         /* size of RAM */
98 
99           int       sc_nrbuf; /* number of receive buffers */
100           int       sc_ntbuf; /* number of transmit buffers */
101           int       sc_last_rd;
102           int       sc_first_td;
103           int       sc_last_td;
104           int       sc_no_td;
105 
106           int       sc_initaddr;
107           int       sc_rmdaddr;
108           int       sc_tmdaddr;
109           int       sc_rbufaddr;
110           int       sc_tbufaddr;
111 
112           uint8_t   sc_enaddr[ETHER_ADDR_LEN];
113 
114           void      (*sc_meminit)(struct lance_softc *);
115           void      (*sc_start_locked)(struct lance_softc *);
116 
117           int       sc_flags;
118 #define   LE_ALLMULTI         (1 << 0)
119 #define   LE_BSWAP  (1 << 1)
120 #define   LE_CARRIER          (1 << 2)
121 #define   LE_DEBUG  (1 << 3)
122 #define   LE_PROMISC          (1 << 4)
123 };
124 #define sc_if       sc_arp.ac_if
125 
126 /*
127  * Unfortunately, manual byte swapping is only necessary for the PCnet-PCI
128  * variants but not for the original LANCE or ILACC so we cannot do this
129  * with #ifdefs resolved at compile time.
130  */
131 #define   LE_HTOLE16(v)       (((sc)->sc_flags & LE_BSWAP) ? htole16(v) : (v))
132 #define   LE_HTOLE32(v)       (((sc)->sc_flags & LE_BSWAP) ? htole32(v) : (v))
133 #define   LE_LE16TOH(v)       (((sc)->sc_flags & LE_BSWAP) ? le16toh(v) : (v))
134 #define   LE_LE32TOH(v)       (((sc)->sc_flags & LE_BSWAP) ? le32toh(v) : (v))
135 
136 void lance_config(struct lance_softc *, const char*, int);
137 void lance_detach(struct lance_softc *);
138 void lance_stop(struct lance_softc *);
139 void lance_suspend(struct lance_softc *);
140 void lance_resume(struct lance_softc *);
141 void lance_init_locked(struct lance_softc *);
142 int lance_put(struct lance_softc *, int, struct mbuf *);
143 struct mbuf *lance_get(struct lance_softc *, int, int);
144 void lance_setladrf(struct lance_softc *, u_int16_t *);
145 
146 /*
147  * The following functions are only useful on certain CPU/bus
148  * combinations.  They should be written in assembly language for
149  * maximum efficiency, but machine-independent versions are provided
150  * for drivers that have not yet been optimized.
151  */
152 void lance_copytobuf_contig(struct lance_softc *, void *, int, int);
153 void lance_copyfrombuf_contig(struct lance_softc *, void *, int, int);
154 void lance_zerobuf_contig(struct lance_softc *, int, int);
155 
156 #if 0     /* Example only - see lance.c */
157 void lance_copytobuf_gap2(struct lance_softc *, void *, int, int);
158 void lance_copyfrombuf_gap2(struct lance_softc *, void *, int, int);
159 void lance_zerobuf_gap2(struct lance_softc *, int, int);
160 
161 void lance_copytobuf_gap16(struct lance_softc *, void *, int, int);
162 void lance_copyfrombuf_gap16(struct lance_softc *, void *, int, int);
163 void lance_zerobuf_gap16(struct lance_softc *, int, int);
164 #endif /* Example only */
165 
166 #endif /* _DEV_LE_LANCEVAR_H_ */
167