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