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