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 arpcom arpcom;   /* ethernet common */
  37
  38         char   *type_str;       /* pointer to type string */
  39         u_char  vendor;         /* interface vendor */
  40         u_char  type;           /* interface type code */
  41         u_char  gone;           /* HW missing, presumed having a good time */
  42
  43         int     port_rid;       /* resource id for port range */
  44         int     port_used;      /* nonzero if ports used */
  45         struct resource* port_res; /* resource for port range */
  46         int     mem_rid;        /* resource id for memory range */
  47         int     mem_used;       /* nonzero if memory used */
  48         struct resource* mem_res; /* resource for memory range */
  49         int     irq_rid;        /* resource id for irq */
  50         struct resource* irq_res; /* resource for irq */
  51         void*   irq_handle;     /* handle for irq handler */
  52         device_t miibus;        /* MII bus for cards with MII. */
  53         void    (*mii_writebits)(struct ed_softc *, u_int, int);
  54         u_int   (*mii_readbits)(struct ed_softc *, int);
  55         struct callout_handle tick_ch; /* Callout handle for ed_tick */
  56
  57         int     nic_offset;     /* NIC (DS8390) I/O bus address offset */
  58         int     asic_offset;    /* ASIC I/O bus address offset */
  59
  60 /*
  61  * The following 'proto' variable is part of a work-around for 8013EBT asics
  62  *      being write-only. It's sort of a prototype/shadow of the real thing.
  63  */
  64         u_char  wd_laar_proto;
  65         u_char  cr_proto;
  66         u_char  isa16bit;       /* width of access to card 0=8 or 1=16 */
  67         int     chip_type;      /* the type of chip (one of ED_CHIP_TYPE_*) */
  68
  69 /*
  70  * HP PC LAN PLUS card support.
  71  */
  72
  73         u_short hpp_options;    /* flags controlling behaviour of the HP card */
  74         u_short hpp_id;         /* software revision and other fields */
  75         caddr_t hpp_mem_start;  /* Memory-mapped IO register address */
  76
  77         caddr_t mem_start;      /* NIC memory start address */
  78         caddr_t mem_end;                /* NIC memory end address */
  79         u_int32_t mem_size;     /* total NIC memory size */
  80         caddr_t mem_ring;       /* start of RX ring-buffer (in NIC mem) */
  81
  82         u_char  mem_shared;     /* NIC memory is shared with host */
  83         u_char  xmit_busy;      /* transmitter is busy */
  84         u_char  txb_cnt;        /* number of transmit buffers */
  85         u_char  txb_inuse;      /* number of TX buffers currently in-use */
  86
  87         u_char  txb_new;        /* pointer to where new buffer will be added */
  88         u_char  txb_next_tx;    /* pointer to next buffer ready to xmit */
  89         u_short txb_len[8];     /* buffered xmit buffer lengths */
  90         u_char  tx_page_start;  /* first page of TX buffer area */
  91         u_char  rec_page_start; /* first page of RX ring-buffer */
  92         u_char  rec_page_stop;  /* last page of RX ring-buffer */
  93         u_char  next_packet;    /* pointer to next unread RX packet */
  94         struct  ifmib_iso_8802_3 mibdata; /* stuff for network mgmt */
  95 };
  96
  97 #define ed_nic_inb(sc, port) \
  98         bus_space_read_1(rman_get_bustag((sc)->port_res), \
  99                 rman_get_bushandle((sc)->port_res), (sc)->nic_offset + (port))
 100
 101 #define ed_nic_outb(sc, port, value) \
 102         bus_space_write_1(rman_get_bustag((sc)->port_res), \
 103                 rman_get_bushandle((sc)->port_res), (sc)->nic_offset + (port), \
 104                 (value))
 105
 106 #define ed_nic_inw(sc, port) \
 107         bus_space_read_2(rman_get_bustag((sc)->port_res), \
 108                 rman_get_bushandle((sc)->port_res), (sc)->nic_offset + (port))
 109
 110 #define ed_nic_outw(sc, port, value) \
 111         bus_space_write_2(rman_get_bustag((sc)->port_res), \
 112                 rman_get_bushandle((sc)->port_res), (sc)->nic_offset + (port), \
 113                 (value))
 114
 115 #define ed_nic_insb(sc, port, addr, count) \
 116         bus_space_read_multi_1(rman_get_bustag((sc)->port_res), \
 117                 rman_get_bushandle((sc)->port_res), \
 118                 (sc)->nic_offset + (port), (addr), (count))
 119
 120 #define ed_nic_outsb(sc, port, addr, count) \
 121         bus_space_write_multi_1(rman_get_bustag((sc)->port_res), \
 122                 rman_get_bushandle((sc)->port_res), \
 123                 (sc)->nic_offset + (port), (addr), (count))
 124
 125 #define ed_nic_insw(sc, port, addr, count) \
 126         bus_space_read_multi_2(rman_get_bustag((sc)->port_res), \
 127                 rman_get_bushandle((sc)->port_res), \
 128                 (sc)->nic_offset + (port), (u_int16_t *)(addr), (count))
 129
 130 #define ed_nic_outsw(sc, port, addr, count) \
 131         bus_space_write_multi_2(rman_get_bustag((sc)->port_res), \
 132                 rman_get_bushandle((sc)->port_res), \
 133                 (sc)->nic_offset + (port), (u_int16_t *)(addr), (count))
 134
 135 #define ed_nic_insl(sc, port, addr, count) \
 136         bus_space_read_multi_4(rman_get_bustag((sc)->port_res), \
 137                 rman_get_bushandle((sc)->port_res), \
 138                 (sc)->nic_offset + (port), (u_int32_t *)(addr), (count))
 139
 140 #define ed_nic_outsl(sc, port, addr, count) \
 141         bus_space_write_multi_4(rman_get_bustag((sc)->port_res), \
 142                 rman_get_bushandle((sc)->port_res), \
 143                 (sc)->nic_offset + (port), (u_int32_t *)(addr), (count))
 144
 145 #define ed_asic_inb(sc, port) \
 146         bus_space_read_1(rman_get_bustag((sc)->port_res), \
 147                 rman_get_bushandle((sc)->port_res), (sc)->asic_offset + (port))
 148
 149 #define ed_asic_outb(sc, port, value) \
 150         bus_space_write_1(rman_get_bustag((sc)->port_res), \
 151                 rman_get_bushandle((sc)->port_res), (sc)->asic_offset + (port), \
 152                 (value))
 153
 154 #define ed_asic_inw(sc, port) \
 155         bus_space_read_2(rman_get_bustag((sc)->port_res), \
 156                 rman_get_bushandle((sc)->port_res), (sc)->asic_offset + (port))
 157
 158 #define ed_asic_outw(sc, port, value) \
 159         bus_space_write_2(rman_get_bustag((sc)->port_res), \
 160                 rman_get_bushandle((sc)->port_res), (sc)->asic_offset + (port), \
 161                 (value))
 162
 163 #define ed_asic_insb(sc, port, addr, count) \
 164         bus_space_read_multi_1(rman_get_bustag((sc)->port_res), \
 165                 rman_get_bushandle((sc)->port_res), \
 166                 (sc)->asic_offset + (port), (addr), (count))
 167
 168 #define ed_asic_outsb(sc, port, addr, count) \
 169         bus_space_write_multi_1(rman_get_bustag((sc)->port_res), \
 170                 rman_get_bushandle((sc)->port_res), \
 171                 (sc)->asic_offset + (port), (addr), (count))
 172
 173 #define ed_asic_insw(sc, port, addr, count) \
 174         bus_space_read_multi_2(rman_get_bustag((sc)->port_res), \
 175                 rman_get_bushandle((sc)->port_res), \
 176                 (sc)->asic_offset + (port), (u_int16_t *)(addr), (count))
 177
 178 #define ed_asic_outsw(sc, port, addr, count) \
 179         bus_space_write_multi_2(rman_get_bustag((sc)->port_res), \
 180                 rman_get_bushandle((sc)->port_res), \
 181                 (sc)->asic_offset + (port), (u_int16_t *)(addr), (count))
 182
 183 #define ed_asic_insl(sc, port, addr, count) \
 184         bus_space_read_multi_4(rman_get_bustag((sc)->port_res), \
 185                 rman_get_bushandle((sc)->port_res), \
 186                 (sc)->asic_offset + (port), (u_int32_t *)(addr), (count))
 187
 188 #define ed_asic_outsl(sc, port, addr, count) \
 189         bus_space_write_multi_4(rman_get_bustag((sc)->port_res), \
 190                 rman_get_bushandle((sc)->port_res), \
 191                 (sc)->asic_offset + (port), (u_int32_t *)(addr), (count))
 192
 193 void    ed_release_resources    (device_t);
 194 int     ed_alloc_port           (device_t, int, int);
 195 int     ed_alloc_memory         (device_t, int, int);
 196 int     ed_alloc_irq            (device_t, int, int);
 197
 198 int     ed_probe_generic8390    (struct ed_softc *);
 199 int     ed_probe_WD80x3         (device_t, int, int);
 200 int     ed_probe_WD80x3_generic (device_t, int, unsigned short *[]);
 201 int     ed_probe_3Com           (device_t, int, int);
 202 int     ed_probe_Novell         (device_t, int, int);
 203 int     ed_probe_Novell_generic (device_t, int);
 204 int     ed_probe_HP_pclanp      (device_t, int, int);
 205
 206 int     ed_attach               (struct ed_softc *, int, int);
 207 void    ed_stop                 (struct ed_softc *);
 208 void    ed_pio_readmem          (struct ed_softc *, int, unsigned char *,
 209                                      unsigned short);
 210 void    ed_pio_writemem         (struct ed_softc *, char *,
 211                                      unsigned short, unsigned short);
 212 #ifndef ED_NO_MIIBUS
 213 int     ed_miibus_readreg       (device_t, int, int);
 214 void    ed_miibus_writereg      (device_t, int, int, int);
 215 int     ed_ifmedia_upd          (struct ifnet *);
 216 void    ed_ifmedia_sts          (struct ifnet *, struct ifmediareq *);
 217 void    ed_child_detached       (device_t, device_t);
 218 #endif
 219
 220 driver_intr_t   edintr;
 221
 222 extern devclass_t ed_devclass;
 223 #endif /* SYS_DEV_ED_IF_EDVAR_H */