sys/dev/netif/em/if_em.h

   1 /**************************************************************************
   2
   3 Copyright (c) 2001-2003, Intel Corporation
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions are met:
   8
   9  1. Redistributions of source code must retain the above copyright notice,
  10     this list of conditions and the following disclaimer.
  11
  12  2. Redistributions in binary form must reproduce the above copyright
  13     notice, this list of conditions and the following disclaimer in the
  14     documentation and/or other materials provided with the distribution.
  15
  16  3. Neither the name of the Intel Corporation nor the names of its
  17     contributors may be used to endorse or promote products derived from
  18     this software without specific prior written permission.
  19
  20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30 POSSIBILITY OF SUCH DAMAGE.
  31
  32 ***************************************************************************/
  33
  34 /*$FreeBSD: src/sys/dev/em/if_em.h,v 1.1.2.13 2003/06/09 21:43:41 pdeuskar Exp $*/
  35
  36 #ifndef _EM_H_DEFINED_
  37 #define _EM_H_DEFINED_
  38
  39
  40 #include <sys/param.h>
  41 #include <sys/systm.h>
  42 #include <sys/mbuf.h>
  43 #include <sys/protosw.h>
  44 #include <sys/socket.h>
  45 #include <sys/malloc.h>
  46 #include <sys/kernel.h>
  47 #include <sys/sockio.h>
  48
  49 #include <net/if.h>
  50 #include <net/if_arp.h>
  51 #include <net/ethernet.h>
  52 #include <net/if_dl.h>
  53 #include <net/if_media.h>
  54
  55 #include <net/bpf.h>
  56 #include <net/if_types.h>
  57 #include <net/if_vlan_var.h>
  58
  59 #include <netinet/in_systm.h>
  60 #include <netinet/in.h>
  61 #include <netinet/ip.h>
  62 #include <netinet/tcp.h>
  63 #include <netinet/udp.h>
  64
  65 #include <sys/bus.h>
  66 #include <machine/bus.h>
  67 #include <sys/rman.h>
  68 #include <machine/resource.h>
  69 #include <vm/vm.h>
  70 #include <vm/pmap.h>
  71 #include <machine/clock.h>
  72 #include <pci/pcivar.h>
  73 #include <pci/pcireg.h>
  74 #include <sys/proc.h>
  75 #include <sys/sysctl.h>
  76 #include "opt_bdg.h"
  77
  78 #include <dev/em/if_em_hw.h>
  79
  80 /* Tunables */
  81
  82 /*
  83  * TxDescriptors
  84  * Valid Range: 80-256 for 82542 and 82543-based adapters
  85  *              80-4096 for others
  86  * Default Value: 256
  87  *   This value is the number of transmit descriptors allocated by the driver.
  88  *   Increasing this value allows the driver to queue more transmits. Each
  89  *   descriptor is 16 bytes.
  90  */
  91 #define EM_MAX_TXD                      256
  92
  93 /*
  94  * RxDescriptors
  95  * Valid Range: 80-256 for 82542 and 82543-based adapters
  96  *              80-4096 for others
  97  * Default Value: 256
  98  *   This value is the number of receive descriptors allocated by the driver.
  99  *   Increasing this value allows the driver to buffer more incoming packets.
 100  *   Each descriptor is 16 bytes.  A receive buffer is also allocated for each
 101  *   descriptor. The maximum MTU size is 16110.
 102  *
 103  */
 104 #define EM_MAX_RXD                      256
 105
 106 /*
 107  * TxIntDelay
 108  * Valid Range: 0-65535 (0=off)
 109  * Default Value: 64
 110  *   This value delays the generation of transmit interrupts in units of
 111  *   1.024 microseconds. Transmit interrupt reduction can improve CPU
 112  *   efficiency if properly tuned for specific network traffic. If the
 113  *   system is reporting dropped transmits, this value may be set too high
 114  *   causing the driver to run out of available transmit descriptors.
 115  */
 116 #define EM_TIDV                         64
 117
 118 /*
 119  * TxAbsIntDelay (Not valid for 82542 and 82543)
 120  * Valid Range: 0-65535 (0=off)
 121  * Default Value: 64
 122  *   This value, in units of 1.024 microseconds, limits the delay in which a
 123  *   transmit interrupt is generated. Useful only if TxIntDelay is non-zero,
 124  *   this value ensures that an interrupt is generated after the initial
 125  *   packet is sent on the wire within the set amount of time.  Proper tuning,
 126  *   along with TxIntDelay, may improve traffic throughput in specific
 127  *   network conditions.
 128  */
 129 #define EM_TADV                         64
 130
 131 /*
 132  * RxIntDelay
 133  * Valid Range: 0-65535 (0=off)
 134  * Default Value: 0
 135  *   This value delays the generation of receive interrupts in units of 1.024
 136  *   microseconds.  Receive interrupt reduction can improve CPU efficiency if
 137  *   properly tuned for specific network traffic. Increasing this value adds
 138  *   extra latency to frame reception and can end up decreasing the throughput
 139  *   of TCP traffic. If the system is reporting dropped receives, this value
 140  *   may be set too high, causing the driver to run out of available receive
 141  *   descriptors.
 142  *
 143  *   CAUTION: When setting RxIntDelay to a value other than 0, adapters
 144  *            may hang (stop transmitting) under certain network conditions.
 145  *            If this occurs a WATCHDOG message is logged in the system event log.
 146  *            In addition, the controller is automatically reset, restoring the
 147  *            network connection. To eliminate the potential for the hang
 148  *            ensure that RxIntDelay is set to 0.
 149  */
 150 #define EM_RDTR                         0
 151
 152 /*
 153  * RxAbsIntDelay (Not valid for 82542 and 82543)
 154  * Valid Range: 0-65535 (0=off)
 155  * Default Value: 64
 156  *   This value, in units of 1.024 microseconds, limits the delay in which a
 157  *   receive interrupt is generated. Useful only if RxIntDelay is non-zero,
 158  *   this value ensures that an interrupt is generated after the initial
 159  *   packet is received within the set amount of time.  Proper tuning,
 160  *   along with RxIntDelay, may improve traffic throughput in specific network
 161  *   conditions.
 162  */
 163 #define EM_RADV                         64
 164
 165
 166 /*
 167  * This parameter controls the maximum no of times the driver will loop
 168  * in the isr.
 169  *           Minimum Value = 1
 170  */
 171 #define EM_MAX_INTR                     3
 172
 173 /*
 174  * Inform the stack about transmit checksum offload capabilities.
 175  */
 176 #define EM_CHECKSUM_FEATURES            (CSUM_TCP | CSUM_UDP)
 177
 178 /*
 179  * This parameter controls the duration of transmit watchdog timer.
 180  */
 181 #define EM_TX_TIMEOUT                   5    /* set to 5 seconds */
 182
 183 /*
 184  * This parameter controls when the driver calls the routine to reclaim
 185  * transmit descriptors.
 186  */
 187 #define EM_TX_CLEANUP_THRESHOLD         EM_MAX_TXD / 8
 188
 189 /*
 190  * This parameter controls whether or not autonegotation is enabled.
 191  *              0 - Disable autonegotiation
 192  *              1 - Enable  autonegotiation
 193  */
 194 #define DO_AUTO_NEG                     1
 195
 196 /*
 197  * This parameter control whether or not the driver will wait for
 198  * autonegotiation to complete.
 199  *              1 - Wait for autonegotiation to complete
 200  *              0 - Don't wait for autonegotiation to complete
 201  */
 202 #define WAIT_FOR_AUTO_NEG_DEFAULT       1
 203
 204
 205 /* Tunables -- End */
 206
 207 #define AUTONEG_ADV_DEFAULT             (ADVERTISE_10_HALF | ADVERTISE_10_FULL | \
 208                                          ADVERTISE_100_HALF | ADVERTISE_100_FULL | \
 209                                          ADVERTISE_1000_FULL)
 210
 211 #define EM_VENDOR_ID                    0x8086
 212 #define EM_MMBA                         0x0010 /* Mem base address */
 213 #define EM_ROUNDUP(size, unit) (((size) + (unit) - 1) & ~((unit) - 1))
 214
 215 #define EM_JUMBO_PBA                    0x00000028
 216 #define EM_DEFAULT_PBA                  0x00000030
 217 #define EM_SMARTSPEED_DOWNSHIFT         3
 218 #define EM_SMARTSPEED_MAX               15
 219
 220
 221 #define MAX_NUM_MULTICAST_ADDRESSES     128
 222 #define PCI_ANY_ID                      (~0U)
 223 #define ETHER_ALIGN                     2
 224
 225 /* Defines for printing debug information */
 226 #define DEBUG_INIT  0
 227 #define DEBUG_IOCTL 0
 228 #define DEBUG_HW    0
 229
 230 #define INIT_DEBUGOUT(S)            if (DEBUG_INIT)  printf(S "\n")
 231 #define INIT_DEBUGOUT1(S, A)        if (DEBUG_INIT)  printf(S "\n", A)
 232 #define INIT_DEBUGOUT2(S, A, B)     if (DEBUG_INIT)  printf(S "\n", A, B)
 233 #define IOCTL_DEBUGOUT(S)           if (DEBUG_IOCTL) printf(S "\n")
 234 #define IOCTL_DEBUGOUT1(S, A)       if (DEBUG_IOCTL) printf(S "\n", A)
 235 #define IOCTL_DEBUGOUT2(S, A, B)    if (DEBUG_IOCTL) printf(S "\n", A, B)
 236 #define HW_DEBUGOUT(S)              if (DEBUG_HW) printf(S "\n")
 237 #define HW_DEBUGOUT1(S, A)          if (DEBUG_HW) printf(S "\n", A)
 238 #define HW_DEBUGOUT2(S, A, B)       if (DEBUG_HW) printf(S "\n", A, B)
 239
 240
 241 /* Supported RX Buffer Sizes */
 242 #define EM_RXBUFFER_2048        2048
 243 #define EM_RXBUFFER_4096        4096
 244 #define EM_RXBUFFER_8192        8192
 245 #define EM_RXBUFFER_16384      16384
 246
 247 #ifdef __alpha__
 248         #undef vtophys
 249         #define vtophys(va)     alpha_XXX_dmamap((vm_offset_t)(va))
 250 #endif /* __alpha__ */
 251
 252 /* ******************************************************************************
 253  * vendor_info_array
 254  *
 255  * This array contains the list of Subvendor/Subdevice IDs on which the driver
 256  * should load.
 257  *
 258  * ******************************************************************************/
 259 typedef struct _em_vendor_info_t {
 260         unsigned int vendor_id;
 261         unsigned int device_id;
 262         unsigned int subvendor_id;
 263         unsigned int subdevice_id;
 264         unsigned int index;
 265 } em_vendor_info_t;
 266
 267
 268 struct em_buffer {
 269         struct mbuf    *m_head;
 270 };
 271
 272
 273 typedef enum _XSUM_CONTEXT_T {
 274         OFFLOAD_NONE,
 275         OFFLOAD_TCP_IP,
 276         OFFLOAD_UDP_IP
 277 } XSUM_CONTEXT_T;
 278
 279 /* Our adapter structure */
 280 struct adapter {
 281         struct arpcom   interface_data;
 282         struct adapter *next;
 283         struct adapter *prev;
 284         struct em_hw    hw;
 285
 286         /* FreeBSD operating-system-specific structures */
 287         struct em_osdep osdep;
 288         struct device   *dev;
 289         struct resource *res_memory;
 290         struct resource *res_ioport;
 291         struct resource *res_interrupt;
 292         void            *int_handler_tag;
 293         struct ifmedia  media;
 294         struct callout_handle timer_handle;
 295         struct callout_handle tx_fifo_timer_handle;
 296         int             io_rid;
 297         u_int8_t        unit;
 298
 299         /* Info about the board itself */
 300         u_int32_t       part_num;
 301         u_int8_t        link_active;
 302         u_int16_t       link_speed;
 303         u_int16_t       link_duplex;
 304         u_int32_t       smartspeed;
 305         u_int32_t       tx_int_delay;
 306         u_int32_t       tx_abs_int_delay;
 307         u_int32_t       rx_int_delay;
 308         u_int32_t       rx_abs_int_delay;
 309
 310         XSUM_CONTEXT_T  active_checksum_context;
 311
 312         /*
 313          * Transmit definitions
 314          *
 315          * We have an array of num_tx_desc descriptors (handled
 316          * by the controller) paired with an array of tx_buffers
 317          * (at tx_buffer_area).
 318          * The index of the next available descriptor is next_avail_tx_desc.
 319          * The number of remaining tx_desc is num_tx_desc_avail.
 320          */
 321         struct em_tx_desc *tx_desc_base;
 322         u_int32_t          next_avail_tx_desc;
 323         u_int32_t          oldest_used_tx_desc;
 324         volatile u_int16_t num_tx_desc_avail;
 325         u_int16_t          num_tx_desc;
 326         u_int32_t          txd_cmd;
 327         struct em_buffer   *tx_buffer_area;
 328
 329         /*
 330          * Receive definitions
 331          *
 332          * we have an array of num_rx_desc rx_desc (handled by the
 333          * controller), and paired with an array of rx_buffers
 334          * (at rx_buffer_area).
 335          * The next pair to check on receive is at offset next_rx_desc_to_check
 336          */
 337         struct em_rx_desc *rx_desc_base;
 338         u_int32_t          next_rx_desc_to_check;
 339         u_int16_t          num_rx_desc;
 340         u_int32_t          rx_buffer_len;
 341         struct em_buffer   *rx_buffer_area;
 342
 343         /* Jumbo frame */
 344         struct mbuf        *fmp;
 345         struct mbuf        *lmp;
 346
 347         u_int16_t          tx_fifo_head;
 348
 349         struct sysctl_ctx_list sysctl_ctx;
 350         struct sysctl_oid *sysctl_tree;
 351
 352         /* Misc stats maintained by the driver */
 353         unsigned long   dropped_pkts;
 354         unsigned long   mbuf_alloc_failed;
 355         unsigned long   mbuf_cluster_failed;
 356         unsigned long   no_tx_desc_avail1;
 357         unsigned long   no_tx_desc_avail2;
 358         u_int64_t       tx_fifo_reset;
 359         u_int64_t       tx_fifo_wrk;
 360
 361 #ifdef DBG_STATS
 362         unsigned long   no_pkts_avail;
 363         unsigned long   clean_tx_interrupts;
 364
 365 #endif
 366         struct em_hw_stats stats;
 367 };
 368
 369 #endif                                                  /* _EM_H_DEFINED_ */