/************************************************************************** Copyright (c) 2001-2007, Intel Corporation All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the Intel Corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ***************************************************************************/ /* $FreeBSD: head/sys/dev/ixgbe/ixgbe.h 171384 2007-07-11 23:03:16Z jfv $ */ #ifndef _IXGBE_H_ #define _IXGBE_H_ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "ixgbe_api.h" /* Tunables */ /* ** The number of queues: right now significant performance ** seems to be gained by using muliple RX queues. The ** infrastructure for multiple TX is there but its not ** completely working, dont set greater than 1 for now. ** OTHER is the vector used for link changes, it also ** should only be set to 1. */ #define IXGBE_TX_QUEUES 1 #define IXGBE_RX_QUEUES 8 #define IXGBE_OTHER 1 /* * TxDescriptors Valid Range: 64-4096 Default Value: 2048 This value is the * number of transmit descriptors allocated by the driver. Increasing this * value allows the driver to queue more transmits. Each descriptor is 16 * bytes. */ #define DEFAULT_TXD 2048 #define MAX_TXD 4096 #define MIN_TXD 64 /* * RxDescriptors Valid Range: 64-4096 Default Value: 2048 This value is the * number of receive descriptors allocated by the driver. Increasing this * value allows the driver to buffer more incoming packets. Each descriptor * is 16 bytes. A receive buffer is also allocated for each descriptor. The * maximum MTU size is 16110. * */ #define DEFAULT_RXD 2048 #define MAX_RXD 4096 #define MIN_RXD 64 /* * This parameter controls the maximum no of times the driver will loop in * the isr. Minimum Value = 1 */ #define MAX_INTR 10 /* * This parameter controls the duration of transmit watchdog timer. */ #define IXGBE_TX_TIMEOUT 5 /* set to 5 seconds */ /* * This parameters control when the driver calls the routine to reclaim * transmit descriptors. */ #define IXGBE_TX_CLEANUP_THRESHOLD (adapter->num_tx_desc / 8) #define IXGBE_TX_OP_THRESHOLD (adapter->num_tx_desc / 32) #define IXGBE_MAX_FRAME_SIZE 0x3F00 #define PERFORMANCE_MTU 9000 /* Best thruput results */ /* ** This controls the size mbuf pool used, it ** may ultimately be automatic, but for now its ** a compile time option. ** - use MCLBYTES for legacy size */ #define IXGBE_RXBUF MJUMPAGESIZE /* Defines for printing debug information */ #define DEBUG_INIT 0 #define DEBUG_IOCTL 0 #define DEBUG_HW 0 #define INIT_DEBUGOUT(S) if (DEBUG_INIT) printf(S "\n") #define INIT_DEBUGOUT1(S, A) if (DEBUG_INIT) printf(S "\n", A) #define INIT_DEBUGOUT2(S, A, B) if (DEBUG_INIT) printf(S "\n", A, B) #define IOCTL_DEBUGOUT(S) if (DEBUG_IOCTL) printf(S "\n") #define IOCTL_DEBUGOUT1(S, A) if (DEBUG_IOCTL) printf(S "\n", A) #define IOCTL_DEBUGOUT2(S, A, B) if (DEBUG_IOCTL) printf(S "\n", A, B) #define HW_DEBUGOUT(S) if (DEBUG_HW) printf(S "\n") #define HW_DEBUGOUT1(S, A) if (DEBUG_HW) printf(S "\n", A) #define HW_DEBUGOUT2(S, A, B) if (DEBUG_HW) printf(S "\n", A, B) #define MAX_NUM_MULTICAST_ADDRESSES 128 #define IXGBE_MAX_SCATTER 100 #define IXGBE_MMBA 0x0010 #define IXGBE_TSO_SIZE 65535 #define IXGBE_TX_BUFFER_SIZE ((u32) 1514) #define IXGBE_RX_HDR_SIZE ((u32) 256) #define CSUM_OFFLOAD 7 /* Bits in csum flags */ /* The number of MSIX messages the 82598 supports */ #define IXGBE_MSGS 18 /* * Interrupt Moderation parameters * for now we hardcode, later * it would be nice to do dynamic */ #define DEFAULT_ITR 8000 #define LINK_ITR 1950 /* * ****************************************************************************** * vendor_info_array * * This array contains the list of Subvendor/Subdevice IDs on which the driver * should load. * ***************************************************************************** */ typedef struct _ixgbe_vendor_info_t { unsigned int vendor_id; unsigned int device_id; unsigned int subvendor_id; unsigned int subdevice_id; unsigned int index; } ixgbe_vendor_info_t; struct ixgbe_tx_buf { int next_eop; struct mbuf *m_head; bus_dmamap_t map; }; struct ixgbe_rx_buf { struct mbuf *m_head; boolean_t bigbuf; /* one small and one large map */ bus_dmamap_t map[2]; }; /* * Bus dma allocation structure used by ixgbe_dma_malloc and ixgbe_dma_free. */ struct ixgbe_dma_alloc { bus_addr_t dma_paddr; caddr_t dma_vaddr; bus_dma_tag_t dma_tag; bus_dmamap_t dma_map; bus_dma_segment_t dma_seg; bus_size_t dma_size; int dma_nseg; }; /* * The transmit ring, one per tx queue */ struct tx_ring { struct adapter *adapter; u32 me; struct mtx mtx; union ixgbe_adv_tx_desc *tx_base; struct ixgbe_dma_alloc txdma; uint32_t next_avail_tx_desc; uint32_t next_tx_to_clean; struct ixgbe_tx_buf *tx_buffers; volatile uint16_t tx_avail; uint32_t txd_cmd; bus_dma_tag_t txtag; }; /* * The Receive ring, one per rx queue */ struct rx_ring { struct adapter *adapter; u32 me; struct mtx mtx; u32 payload; union ixgbe_adv_rx_desc *rx_base; struct ixgbe_dma_alloc rxdma; unsigned int last_cleaned; unsigned int next_to_check; struct ixgbe_rx_buf *rx_buffers; bus_dma_tag_t rxtag[2]; bus_dmamap_t spare_map[2]; struct mbuf *fmp; struct mbuf *lmp; /* Soft stats */ u64 packet_count; u64 byte_count; }; /* Our adapter structure */ struct adapter { struct ifnet *ifp; struct ixgbe_hw hw; /* FreeBSD operating-system-specific structures */ struct ixgbe_osdep osdep; struct device *dev; struct resource *res_memory; struct resource *res_msix; /* * Interrupt resources: * Oplin has 20 MSIX messages * so allocate that for now. */ void *tag[IXGBE_MSGS]; struct resource *res[IXGBE_MSGS]; int rid[IXGBE_MSGS]; struct ifmedia media; struct callout timer; int watchdog_timer; int msix; int if_flags; struct mtx mtx; /* Info about the board itself */ uint32_t part_num; boolean_t link_active; uint16_t max_frame_size; uint16_t link_duplex; uint32_t tx_int_delay; uint32_t tx_abs_int_delay; uint32_t rx_int_delay; uint32_t rx_abs_int_delay; /* Indicates the cluster size to use */ boolean_t bigbufs; /* * Transmit rings: * Allocated at run time, an array of rings. */ struct tx_ring *tx_rings; int num_tx_desc; int num_tx_queues; /* * Receive rings: * Allocated at run time, an array of rings. */ struct rx_ring *rx_rings; int num_rx_desc; int num_rx_queues; uint32_t rx_process_limit; /* Misc stats maintained by the driver */ unsigned long dropped_pkts; unsigned long mbuf_alloc_failed; unsigned long mbuf_cluster_failed; unsigned long no_tx_desc_avail1; unsigned long no_tx_desc_avail2; unsigned long no_tx_map_avail; unsigned long no_tx_dma_setup; unsigned long watchdog_events; unsigned long tso_tx; struct ixgbe_hw_stats stats; }; #define IXGBE_LOCK_INIT(_sc, _name) \ mtx_init(&(_sc)->mtx, _name, MTX_NETWORK_LOCK, MTX_DEF) #define IXGBE_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->mtx) #define IXGBE_LOCK(_sc) mtx_lock(&(_sc)->mtx) #define IXGBE_UNLOCK(_sc) mtx_unlock(&(_sc)->mtx) #define IXGBE_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->mtx, MA_OWNED) #endif /* _IXGBE_H_ */