sys/dev/ed/if_edvar.h

   1 /*-
   2  * Copyright (c) 1995, David Greenman
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef SYS_DEV_ED_IF_EDVAR_H
  31 #define SYS_DEV_ED_IF_EDVAR_H
  32 /*
  33  * ed_softc: per line info and status
  34  */
  35 struct ed_softc {
  36         struct ifnet *ifp;
  37         struct ifmedia ifmedia; /* Media info */
  38         device_t dev;
  39         struct mtx sc_mtx;
  40
  41         char   *type_str;       /* pointer to type string */
  42         u_char  vendor;         /* interface vendor */
  43         u_char  type;           /* interface type code */
  44         u_char  chip_type;      /* the type of chip (one of ED_CHIP_TYPE_*) */
  45         u_char  isa16bit;       /* width of access to card 0=8 or 1=16 */
  46         u_char  mem_shared;     /* NIC memory is shared with host */
  47         u_char  xmit_busy;      /* transmitter is busy */
  48         u_char  enaddr[6];
  49
  50         int     port_used;      /* nonzero if ports used */
  51         struct resource* port_res; /* resource for port range */
  52         struct resource* port_res2; /* resource for port range */
  53         bus_space_tag_t port_bst;
  54         bus_space_handle_t port_bsh;
  55         int     mem_used;       /* nonzero if memory used */
  56         struct resource* mem_res; /* resource for memory range */
  57         bus_space_tag_t mem_bst;
  58         bus_space_handle_t mem_bsh;
  59         struct resource* irq_res; /* resource for irq */
  60         void*   irq_handle;     /* handle for irq handler */
  61         int     (*sc_media_ioctl)(struct ed_softc *sc, struct ifreq *ifr,
  62             u_long command);
  63         void    (*sc_mediachg)(struct ed_softc *);
  64         device_t miibus;        /* MII bus for cards with MII. */
  65         void    (*mii_writebits)(struct ed_softc *, u_int, int);
  66         u_int   (*mii_readbits)(struct ed_softc *, int);
  67         struct callout        tick_ch;
  68         void    (*sc_tick)(void *);
  69         void (*readmem)(struct ed_softc *sc, bus_size_t src, uint8_t *dst,
  70             uint16_t amount);
  71         u_short (*sc_write_mbufs)(struct ed_softc *, struct mbuf *, bus_size_t);
  72
  73         int     nic_offset;     /* NIC (DS8390) I/O bus address offset */
  74         int     asic_offset;    /* ASIC I/O bus address offset */
  75
  76 /*
  77  * The following 'proto' variable is part of a work-around for 8013EBT asics
  78  *      being write-only. It's sort of a prototype/shadow of the real thing.
  79  */
  80         u_char  wd_laar_proto;
  81         u_char  cr_proto;
  82
  83 /*
  84  * HP PC LAN PLUS card support.
  85  */
  86
  87         u_short hpp_options;    /* flags controlling behaviour of the HP card */
  88         u_short hpp_id;         /* software revision and other fields */
  89         caddr_t hpp_mem_start;  /* Memory-mapped IO register address */
  90
  91         bus_size_t mem_start; /* NIC memory start address */
  92         bus_size_t mem_end; /* NIC memory end address */
  93         uint32_t mem_size;      /* total NIC memory size */
  94         bus_size_t mem_ring; /* start of RX ring-buffer (in NIC mem) */
  95
  96         u_char  txb_cnt;        /* number of transmit buffers */
  97         u_char  txb_inuse;      /* number of TX buffers currently in-use */
  98
  99         u_char  txb_new;        /* pointer to where new buffer will be added */
 100         u_char  txb_next_tx;    /* pointer to next buffer ready to xmit */
 101         u_short txb_len[8];     /* buffered xmit buffer lengths */
 102         u_char  tx_page_start;  /* first page of TX buffer area */
 103         u_char  rec_page_start; /* first page of RX ring-buffer */
 104         u_char  rec_page_stop;  /* last page of RX ring-buffer */
 105         u_char  next_packet;    /* pointer to next unread RX packet */
 106         u_int   tx_mem;         /* Total amount of RAM for tx */
 107         u_int   rx_mem;         /* Total amount of RAM for rx */
 108         struct  ifmib_iso_8802_3 mibdata; /* stuff for network mgmt */
 109 };
 110
 111 #define ed_nic_inb(sc, port) \
 112         bus_space_read_1(sc->port_bst, sc->port_bsh, (sc)->nic_offset + (port))
 113
 114 #define ed_nic_outb(sc, port, value) \
 115         bus_space_write_1(sc->port_bst, sc->port_bsh, \
 116             (sc)->nic_offset + (port), (value))
 117
 118 #define ed_nic_inw(sc, port) \
 119         bus_space_read_2(sc->port_bst, sc->port_bsh, (sc)->nic_offset + (port))
 120
 121 #define ed_nic_outw(sc, port, value) \
 122         bus_space_write_2(sc->port_bst, sc->port_bsh, \
 123             (sc)->nic_offset + (port), (value))
 124
 125 #define ed_nic_insb(sc, port, addr, count) \
 126         bus_space_read_multi_1(sc->port_bst,  sc->port_bsh, \
 127                 (sc)->nic_offset + (port), (addr), (count))
 128
 129 #define ed_nic_outsb(sc, port, addr, count) \
 130         bus_space_write_multi_1(sc->port_bst, sc->port_bsh, \
 131                 (sc)->nic_offset + (port), (addr), (count))
 132
 133 #define ed_nic_insw(sc, port, addr, count) \
 134         bus_space_read_multi_2(sc->port_bst, sc->port_bsh, \
 135                 (sc)->nic_offset + (port), (uint16_t *)(addr), (count))
 136
 137 #define ed_nic_outsw(sc, port, addr, count) \
 138         bus_space_write_multi_2(sc->port_bst, sc->port_bsh, \
 139                 (sc)->nic_offset + (port), (uint16_t *)(addr), (count))
 140
 141 #define ed_nic_insl(sc, port, addr, count) \
 142         bus_space_read_multi_4(sc->port_bst, sc->port_bsh, \
 143                 (sc)->nic_offset + (port), (uint32_t *)(addr), (count))
 144
 145 #define ed_nic_outsl(sc, port, addr, count) \
 146         bus_space_write_multi_4(sc->port_bst, sc->port_bsh, \
 147                 (sc)->nic_offset + (port), (uint32_t *)(addr), (count))
 148
 149 #define ed_asic_inb(sc, port) \
 150         bus_space_read_1(sc->port_bst, sc->port_bsh, \
 151             (sc)->asic_offset + (port))
 152
 153 #define ed_asic_outb(sc, port, value) \
 154         bus_space_write_1(sc->port_bst, sc->port_bsh, \
 155             (sc)->asic_offset + (port), (value))
 156
 157 #define ed_asic_inw(sc, port) \
 158         bus_space_read_2(sc->port_bst, sc->port_bsh, \
 159             (sc)->asic_offset + (port))
 160
 161 #define ed_asic_outw(sc, port, value) \
 162         bus_space_write_2(sc->port_bst, sc->port_bsh, \
 163             (sc)->asic_offset + (port), (value))
 164
 165 #define ed_asic_insb(sc, port, addr, count) \
 166         bus_space_read_multi_1(sc->port_bst, sc->port_bsh, \
 167                 (sc)->asic_offset + (port), (addr), (count))
 168
 169 #define ed_asic_outsb(sc, port, addr, count) \
 170         bus_space_write_multi_1(sc->port_bst, sc->port_bsh, \
 171                 (sc)->asic_offset + (port), (addr), (count))
 172
 173 #define ed_asic_insw(sc, port, addr, count) \
 174         bus_space_read_multi_2(sc->port_bst, sc->port_bsh, \
 175                 (sc)->asic_offset + (port), (uint16_t *)(addr), (count))
 176
 177 #define ed_asic_outsw(sc, port, addr, count) \
 178         bus_space_write_multi_2(sc->port_bst, sc->port_bsh, \
 179                 (sc)->asic_offset + (port), (uint16_t *)(addr), (count))
 180
 181 #define ed_asic_insl(sc, port, addr, count) \
 182         bus_space_read_multi_4(sc->port_bst, sc->port_bsh, \
 183                 (sc)->asic_offset + (port), (uint32_t *)(addr), (count))
 184
 185 #define ed_asic_outsl(sc, port, addr, count) \
 186         bus_space_write_multi_4(sc->port_bst, sc->port_bsh, \
 187                 (sc)->asic_offset + (port), (uint32_t *)(addr), (count))
 188
 189 void    ed_release_resources(device_t);
 190 int     ed_alloc_port(device_t, int, int);
 191 int     ed_alloc_memory(device_t, int, int);
 192 int     ed_alloc_irq(device_t, int, int);
 193
 194 int     ed_probe_generic8390(struct ed_softc *);
 195 int     ed_probe_WD80x3(device_t, int, int);
 196 int     ed_probe_WD80x3_generic(device_t, int, uint16_t *[]);
 197 int     ed_probe_RTL80x9(device_t, int, int);
 198 #ifdef ED_3C503
 199 int     ed_probe_3Com(device_t, int, int);
 200 #endif
 201 #ifdef ED_SIC
 202 int     ed_probe_SIC(device_t, int, int);
 203 #endif
 204 int     ed_probe_Novell_generic(device_t, int);
 205 int     ed_probe_Novell(device_t, int, int);
 206 void    ed_Novell_read_mac(struct ed_softc *);
 207 #ifdef ED_HPP
 208 int     ed_probe_HP_pclanp(device_t, int, int);
 209 #endif
 210
 211 int     ed_attach(device_t);
 212 int     ed_detach(device_t);
 213 int     ed_clear_memory(device_t);
 214 int     ed_isa_mem_ok(device_t, u_long, u_int); /* XXX isa specific */
 215 void    ed_stop(struct ed_softc *);
 216 void    ed_shmem_readmem16(struct ed_softc *, bus_size_t, uint8_t *, uint16_t);
 217 void    ed_shmem_readmem8(struct ed_softc *, bus_size_t, uint8_t *, uint16_t);
 218 u_short ed_shmem_write_mbufs(struct ed_softc *, struct mbuf *, bus_size_t);
 219 void    ed_pio_readmem(struct ed_softc *, bus_size_t, uint8_t *, uint16_t);
 220 void    ed_pio_writemem(struct ed_softc *, uint8_t *, uint16_t, uint16_t);
 221 u_short ed_pio_write_mbufs(struct ed_softc *, struct mbuf *, bus_size_t);
 222
 223 void    ed_disable_16bit_access(struct ed_softc *);
 224 void    ed_enable_16bit_access(struct ed_softc *);
 225
 226 void    ed_gen_ifmedia_init(struct ed_softc *);
 227
 228 driver_intr_t   edintr;
 229
 230 extern devclass_t ed_devclass;
 231
 232
 233 /*
 234  * Vendor types
 235  */
 236 #define ED_VENDOR_WD_SMC        0x00            /* Western Digital/SMC */
 237 #define ED_VENDOR_3COM          0x01            /* 3Com */
 238 #define ED_VENDOR_NOVELL        0x02            /* Novell */
 239 #define ED_VENDOR_HP            0x03            /* Hewlett Packard */
 240 #define ED_VENDOR_SIC           0x04            /* Allied-Telesis SIC */
 241
 242 /*
 243  * Configure time flags
 244  */
 245 /*
 246  * this sets the default for enabling/disabling the transceiver
 247  */
 248 #define ED_FLAGS_DISABLE_TRANCEIVER     0x0001
 249
 250 /*
 251  * This forces the board to be used in 8/16bit mode even if it
 252  *      autoconfigs differently
 253  */
 254 #define ED_FLAGS_FORCE_8BIT_MODE        0x0002
 255 #define ED_FLAGS_FORCE_16BIT_MODE       0x0004
 256
 257 /*
 258  * This disables the use of double transmit buffers.
 259  */
 260 #define ED_FLAGS_NO_MULTI_BUFFERING     0x0008
 261
 262 /*
 263  * This forces all operations with the NIC memory to use Programmed
 264  *      I/O (i.e. not via shared memory)
 265  */
 266 #define ED_FLAGS_FORCE_PIO              0x0010
 267
 268 /*
 269  * This forces a PC Card, and disables ISA memory range checks
 270  */
 271 #define ED_FLAGS_PCCARD                 0x0020
 272
 273 /*
 274  * These are flags describing the chip type.
 275  */
 276 #define ED_FLAGS_TOSH_ETHER             0x10000
 277 #define ED_FLAGS_GWETHER                0x20000
 278
 279 #define ED_FLAGS_GETTYPE(flg)           ((flg) & 0xff0000)
 280
 281 #define ED_MUTEX(_sc)           (&(_sc)->sc_mtx)
 282 #define ED_LOCK(_sc)            mtx_lock(ED_MUTEX(_sc))
 283 #define ED_UNLOCK(_sc)          mtx_unlock(ED_MUTEX(_sc))
 284 #define ED_LOCK_INIT(_sc) \
 285         mtx_init(ED_MUTEX(_sc), device_get_nameunit(_sc->dev), \
 286             MTX_NETWORK_LOCK, MTX_DEF)
 287 #define ED_LOCK_DESTROY(_sc)    mtx_destroy(ED_MUTEX(_sc));
 288 #define ED_ASSERT_LOCKED(_sc)   mtx_assert(ED_MUTEX(_sc), MA_OWNED);
 289 #define ED_ASSERT_UNLOCKED(_sc) mtx_assert(ED_MUTEX(_sc), MA_NOTOWNED);
 290
 291 #endif /* SYS_DEV_ED_IF_EDVAR_H */