FreeBSD/Linux Kernel Cross Reference
sys/dev/le/lancevar.h
1 /* $NetBSD: lancevar.h,v 1.10 2005/12/11 12:21:27 christos Exp $ */
2
3 /*-
4 * Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Charles M. Hannum and by Jason R. Thorpe of the Numerical Aerospace
9 * Simulation Facility, NASA Ames Research Center.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 /* $FreeBSD$ */
34
35 #ifndef _DEV_LE_LANCEVAR_H_
36 #define _DEV_LE_LANCEVAR_H_
37
38 extern devclass_t le_devclass;
39
40 struct lance_softc {
41 struct ifnet *sc_ifp;
42 struct ifmedia sc_media;
43 struct mtx sc_mtx;
44 struct callout sc_wdog_ch;
45 int sc_wdog_timer;
46
47 /*
48 * Memory functions:
49 *
50 * copy to/from descriptor
51 * copy to/from buffer
52 * zero bytes in buffer
53 */
54 void (*sc_copytodesc)(struct lance_softc *, void *, int, int);
55 void (*sc_copyfromdesc)(struct lance_softc *, void *, int, int);
56 void (*sc_copytobuf)(struct lance_softc *, void *, int, int);
57 void (*sc_copyfrombuf)(struct lance_softc *, void *, int, int);
58 void (*sc_zerobuf)(struct lance_softc *, int, int);
59
60 /*
61 * Machine-dependent functions:
62 *
63 * read/write CSR
64 * hardware reset hook - may be NULL
65 * hardware init hook - may be NULL
66 * no carrier hook - may be NULL
67 * media change hook - may be NULL
68 */
69 uint16_t (*sc_rdcsr)(struct lance_softc *, uint16_t);
70 void (*sc_wrcsr)(struct lance_softc *, uint16_t, uint16_t);
71 void (*sc_hwreset)(struct lance_softc *);
72 void (*sc_hwinit)(struct lance_softc *);
73 int (*sc_hwintr)(struct lance_softc *);
74 void (*sc_nocarrier)(struct lance_softc *);
75 int (*sc_mediachange)(struct lance_softc *);
76 void (*sc_mediastatus)(struct lance_softc *, struct ifmediareq *);
77
78 /*
79 * Media-supported by this interface. If this is NULL,
80 * the only supported media is assumed to be "manual".
81 */
82 const int *sc_supmedia;
83 int sc_nsupmedia;
84 int sc_defaultmedia;
85
86 uint16_t sc_conf3; /* CSR3 value */
87
88 void *sc_mem; /* base address of RAM - CPU's view */
89 bus_addr_t sc_addr; /* base address of RAM - LANCE's view */
90
91 bus_size_t sc_memsize; /* size of RAM */
92
93 int sc_nrbuf; /* number of receive buffers */
94 int sc_ntbuf; /* number of transmit buffers */
95 int sc_last_rd;
96 int sc_first_td;
97 int sc_last_td;
98 int sc_no_td;
99
100 int sc_initaddr;
101 int sc_rmdaddr;
102 int sc_tmdaddr;
103 int sc_rbufaddr;
104 int sc_tbufaddr;
105
106 uint8_t sc_enaddr[ETHER_ADDR_LEN];
107
108 void (*sc_meminit)(struct lance_softc *);
109 void (*sc_start_locked)(struct lance_softc *);
110
111 int sc_flags;
112 #define LE_ALLMULTI (1 << 0)
113 #define LE_BSWAP (1 << 1)
114 #define LE_CARRIER (1 << 2)
115 #define LE_DEBUG (1 << 3)
116 #define LE_PROMISC (1 << 4)
117 };
118
119 #define LE_LOCK_INIT(_sc, _name) \
120 mtx_init(&(_sc)->sc_mtx, _name, MTX_NETWORK_LOCK, MTX_DEF)
121 #define LE_LOCK_INITIALIZED(_sc) mtx_initialized(&(_sc)->sc_mtx)
122 #define LE_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
123 #define LE_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
124 #define LE_LOCK_ASSERT(_sc, _what) mtx_assert(&(_sc)->sc_mtx, (_what))
125 #define LE_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->sc_mtx)
126
127 /*
128 * Unfortunately, manual byte swapping is only necessary for the PCnet-PCI
129 * variants but not for the original LANCE or ILACC so we cannot do this
130 * with #ifdefs resolved at compile time.
131 */
132 #define LE_HTOLE16(v) (((sc)->sc_flags & LE_BSWAP) ? htole16(v) : (v))
133 #define LE_HTOLE32(v) (((sc)->sc_flags & LE_BSWAP) ? htole32(v) : (v))
134 #define LE_LE16TOH(v) (((sc)->sc_flags & LE_BSWAP) ? le16toh(v) : (v))
135 #define LE_LE32TOH(v) (((sc)->sc_flags & LE_BSWAP) ? le32toh(v) : (v))
136
137 int lance_config(struct lance_softc *, const char*, int);
138 void lance_attach(struct lance_softc *);
139 void lance_detach(struct lance_softc *);
140 void lance_suspend(struct lance_softc *);
141 void lance_resume(struct lance_softc *);
142 void lance_init_locked(struct lance_softc *);
143 int lance_put(struct lance_softc *, int, struct mbuf *);
144 struct mbuf *lance_get(struct lance_softc *, int, int);
145 void lance_setladrf(struct lance_softc *, u_int16_t *);
146
147 /*
148 * The following functions are only useful on certain CPU/bus
149 * combinations. They should be written in assembly language for
150 * maximum efficiency, but machine-independent versions are provided
151 * for drivers that have not yet been optimized.
152 */
153 void lance_copytobuf_contig(struct lance_softc *, void *, int, int);
154 void lance_copyfrombuf_contig(struct lance_softc *, void *, int, int);
155 void lance_zerobuf_contig(struct lance_softc *, int, int);
156
157 #if 0 /* Example only - see lance.c */
158 void lance_copytobuf_gap2(struct lance_softc *, void *, int, int);
159 void lance_copyfrombuf_gap2(struct lance_softc *, void *, int, int);
160 void lance_zerobuf_gap2(struct lance_softc *, int, int);
161
162 void lance_copytobuf_gap16(struct lance_softc *, void *, int, int);
163 void lance_copyfrombuf_gap16(struct lance_softc *, void *, int, int);
164 void lance_zerobuf_gap16(struct lance_softc *, int, int);
165 #endif /* Example only */
166
167 /*
168 * Compare two Ether/802 addresses for equality, inlined and
169 * unrolled for speed. Use this like memcmp().
170 *
171 * XXX: Add <machine/inlines.h> for stuff like this?
172 * XXX: or maybe add it to libkern.h instead?
173 *
174 * "I'd love to have an inline assembler version of this."
175 * XXX: Who wanted that? mycroft? I wrote one, but this
176 * version in C is as good as hand-coded assembly. -gwr
177 *
178 * Please do NOT tweak this without looking at the actual
179 * assembly code generated before and after your tweaks!
180 */
181 static inline uint16_t
182 ether_cmp(void *one, void *two)
183 {
184 uint16_t *a = (u_short *)one;
185 uint16_t *b = (u_short *)two;
186 uint16_t diff;
187
188 #ifdef m68k
189 /*
190 * The post-increment-pointer form produces the best
191 * machine code for m68k. This was carefully tuned
192 * so it compiles to just 8 short (2-byte) op-codes!
193 */
194 diff = *a++ - *b++;
195 diff |= *a++ - *b++;
196 diff |= *a++ - *b++;
197 #else
198 /*
199 * Most modern CPUs do better with a single expresion.
200 * Note that short-cut evaluation is NOT helpful here,
201 * because it just makes the code longer, not faster!
202 */
203 diff = (a[0] - b[0]) | (a[1] - b[1]) | (a[2] - b[2]);
204 #endif
205
206 return (diff);
207 }
208
209 #endif /* _DEV_LE_LANCEVAR_H_ */
Cache object: c01da60e5b03ef446f3afd5b48a4879b
|