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  * 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         struct callout  sc_wdog_ch;
  52         int             sc_wdog_timer;
  53
  54         /*
  55          * Memory functions:
  56          *
  57          *      copy to/from descriptor
  58          *      copy to/from buffer
  59          *      zero bytes in buffer
  60          */
  61         void    (*sc_copytodesc)(struct lance_softc *, void *, int, int);
  62         void    (*sc_copyfromdesc)(struct lance_softc *, void *, int, int);
  63         void    (*sc_copytobuf)(struct lance_softc *, void *, int, int);
  64         void    (*sc_copyfrombuf)(struct lance_softc *, void *, int, int);
  65         void    (*sc_zerobuf)(struct lance_softc *, int, int);
  66
  67         /*
  68          * Machine-dependent functions:
  69          *
  70          *      read/write CSR
  71          *      hardware reset hook - may be NULL
  72          *      hardware init hook - may be NULL
  73          *      no carrier hook - may be NULL
  74          *      media change hook - may be NULL
  75          */
  76         uint16_t        (*sc_rdcsr)(struct lance_softc *, uint16_t);
  77         void    (*sc_wrcsr)(struct lance_softc *, uint16_t, uint16_t);
  78         void    (*sc_hwreset)(struct lance_softc *);
  79         void    (*sc_hwinit)(struct lance_softc *);
  80         int     (*sc_hwintr)(struct lance_softc *);
  81         void    (*sc_nocarrier)(struct lance_softc *);
  82         int     (*sc_mediachange)(struct lance_softc *);
  83         void    (*sc_mediastatus)(struct lance_softc *, struct ifmediareq *);
  84
  85         /*
  86          * Media-supported by this interface.  If this is NULL,
  87          * the only supported media is assumed to be "manual".
  88          */
  89         const int       *sc_supmedia;
  90         int     sc_nsupmedia;
  91         int     sc_defaultmedia;
  92
  93         uint16_t        sc_conf3;       /* CSR3 value */
  94
  95         void    *sc_mem;                /* base address of RAM - CPU's view */
  96         bus_addr_t      sc_addr;        /* base address of RAM - LANCE's view */
  97
  98         bus_size_t      sc_memsize;     /* size of RAM */
  99
 100         int     sc_nrbuf;       /* number of receive buffers */
 101         int     sc_ntbuf;       /* number of transmit buffers */
 102         int     sc_last_rd;
 103         int     sc_first_td;
 104         int     sc_last_td;
 105         int     sc_no_td;
 106
 107         int     sc_initaddr;
 108         int     sc_rmdaddr;
 109         int     sc_tmdaddr;
 110         int     sc_rbufaddr;
 111         int     sc_tbufaddr;
 112
 113         uint8_t sc_enaddr[ETHER_ADDR_LEN];
 114
 115         void    (*sc_meminit)(struct lance_softc *);
 116         void    (*sc_start_locked)(struct lance_softc *);
 117
 118         int     sc_flags;
 119 #define LE_ALLMULTI     (1 << 0)
 120 #define LE_BSWAP        (1 << 1)
 121 #define LE_CARRIER      (1 << 2)
 122 #define LE_DEBUG        (1 << 3)
 123 #define LE_PROMISC      (1 << 4)
 124 };
 125
 126 #define LE_LOCK_INIT(_sc, _name)                                        \
 127         mtx_init(&(_sc)->sc_mtx, _name, MTX_NETWORK_LOCK, MTX_DEF)
 128 #define LE_LOCK_INITIALIZED(_sc)        mtx_initialized(&(_sc)->sc_mtx)
 129 #define LE_LOCK(_sc)                    mtx_lock(&(_sc)->sc_mtx)
 130 #define LE_UNLOCK(_sc)                  mtx_unlock(&(_sc)->sc_mtx)
 131 #define LE_LOCK_ASSERT(_sc, _what)      mtx_assert(&(_sc)->sc_mtx, (_what))
 132 #define LE_LOCK_DESTROY(_sc)            mtx_destroy(&(_sc)->sc_mtx)
 133
 134 /*
 135  * Unfortunately, manual byte swapping is only necessary for the PCnet-PCI
 136  * variants but not for the original LANCE or ILACC so we cannot do this
 137  * with #ifdefs resolved at compile time.
 138  */
 139 #define LE_HTOLE16(v)   (((sc)->sc_flags & LE_BSWAP) ? htole16(v) : (v))
 140 #define LE_HTOLE32(v)   (((sc)->sc_flags & LE_BSWAP) ? htole32(v) : (v))
 141 #define LE_LE16TOH(v)   (((sc)->sc_flags & LE_BSWAP) ? le16toh(v) : (v))
 142 #define LE_LE32TOH(v)   (((sc)->sc_flags & LE_BSWAP) ? le32toh(v) : (v))
 143
 144 int lance_config(struct lance_softc *, const char*, int);
 145 void lance_attach(struct lance_softc *);
 146 void lance_detach(struct lance_softc *);
 147 void lance_suspend(struct lance_softc *);
 148 void lance_resume(struct lance_softc *);
 149 void lance_init_locked(struct lance_softc *);
 150 int lance_put(struct lance_softc *, int, struct mbuf *);
 151 struct mbuf *lance_get(struct lance_softc *, int, int);
 152 void lance_setladrf(struct lance_softc *, u_int16_t *);
 153
 154 /*
 155  * The following functions are only useful on certain CPU/bus
 156  * combinations.  They should be written in assembly language for
 157  * maximum efficiency, but machine-independent versions are provided
 158  * for drivers that have not yet been optimized.
 159  */
 160 void lance_copytobuf_contig(struct lance_softc *, void *, int, int);
 161 void lance_copyfrombuf_contig(struct lance_softc *, void *, int, int);
 162 void lance_zerobuf_contig(struct lance_softc *, int, int);
 163
 164 #if 0   /* Example only - see lance.c */
 165 void lance_copytobuf_gap2(struct lance_softc *, void *, int, int);
 166 void lance_copyfrombuf_gap2(struct lance_softc *, void *, int, int);
 167 void lance_zerobuf_gap2(struct lance_softc *, int, int);
 168
 169 void lance_copytobuf_gap16(struct lance_softc *, void *, int, int);
 170 void lance_copyfrombuf_gap16(struct lance_softc *, void *, int, int);
 171 void lance_zerobuf_gap16(struct lance_softc *, int, int);
 172 #endif /* Example only */
 173
 174 /*
 175  * Compare two Ether/802 addresses for equality, inlined and
 176  * unrolled for speed.  Use this like memcmp().
 177  *
 178  * XXX: Add <machine/inlines.h> for stuff like this?
 179  * XXX: or maybe add it to libkern.h instead?
 180  *
 181  * "I'd love to have an inline assembler version of this."
 182  * XXX: Who wanted that? mycroft?  I wrote one, but this
 183  * version in C is as good as hand-coded assembly. -gwr
 184  *
 185  * Please do NOT tweak this without looking at the actual
 186  * assembly code generated before and after your tweaks!
 187  */
 188 static inline uint16_t
 189 ether_cmp(void *one, void *two)
 190 {
 191         uint16_t *a = (u_short *)one;
 192         uint16_t *b = (u_short *)two;
 193         uint16_t diff;
 194
 195 #ifdef  m68k
 196         /*
 197          * The post-increment-pointer form produces the best
 198          * machine code for m68k.  This was carefully tuned
 199          * so it compiles to just 8 short (2-byte) op-codes!
 200          */
 201         diff  = *a++ - *b++;
 202         diff |= *a++ - *b++;
 203         diff |= *a++ - *b++;
 204 #else
 205         /*
 206          * Most modern CPUs do better with a single expresion.
 207          * Note that short-cut evaluation is NOT helpful here,
 208          * because it just makes the code longer, not faster!
 209          */
 210         diff = (a[0] - b[0]) | (a[1] - b[1]) | (a[2] - b[2]);
 211 #endif
 212
 213         return (diff);
 214 }
 215
 216 #endif /* _DEV_LE_LANCEVAR_H_ */