sys/dev/netif/jme/if_jmevar.h

   1 /*-
   2  * Copyright (c) 2008, Pyun YongHyeon <yongari@FreeBSD.org>
   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: src/sys/dev/jme/if_jmevar.h,v 1.1 2008/05/27 01:42:01 yongari Exp $
  28  * $DragonFly: src/sys/dev/netif/jme/if_jmevar.h,v 1.8 2008/11/26 11:55:18 sephe Exp $
  29  */
  30
  31 #ifndef _IF_JMEVAR_H
  32 #define _IF_JMEVAR_H
  33
  34 #include <sys/queue.h>
  35 #include <sys/callout.h>
  36 #include <sys/taskqueue.h>
  37
  38 /*
  39  * JMC250 supports upto JME_NDESC_MAX descriptors and the number of
  40  * descriptors should be multiple of JME_NDESC_ALIGN.
  41  */
  42 #define JME_TX_DESC_CNT_DEF     384
  43 #define JME_RX_DESC_CNT_DEF     256
  44
  45 #define JME_NDESC_ALIGN         16
  46 #define JME_NDESC_MAX           1024
  47
  48 #define JME_NRXRING_1           1
  49 #define JME_NRXRING_2           2
  50 #define JME_NRXRING_4           4
  51
  52 #define JME_NRXRING_DEF         JME_NRXRING_1
  53 #define JME_NRXRING_MIN         JME_NRXRING_1
  54 #define JME_NRXRING_MAX         JME_NRXRING_4
  55
  56 #define JME_NSERIALIZE          (JME_NRXRING_MAX + 2)
  57
  58 /*
  59  * Tx/Rx descriptor queue base should be 16bytes aligned and
  60  * should not cross 4G bytes boundary on the 64bits address
  61  * mode.
  62  */
  63 #define JME_TX_RING_ALIGN       16
  64 #define JME_RX_RING_ALIGN       16
  65 #define JME_MAXSEGSIZE          4096
  66 #define JME_TSO_MAXSIZE         (65535 + sizeof(struct ether_vlan_header))
  67 #define JME_MAXTXSEGS           32
  68 #define JME_RX_BUF_ALIGN        sizeof(uint64_t)
  69 #define JME_SSB_ALIGN           16
  70
  71 #if (BUS_SPACE_MAXADDR != BUS_SPACE_MAXADDR_32BIT)
  72 #define JME_RING_BOUNDARY       0x100000000ULL
  73 #else
  74 #define JME_RING_BOUNDARY       0
  75 #endif
  76
  77 #define JME_ADDR_LO(x)          ((uint64_t) (x) & 0xFFFFFFFF)
  78 #define JME_ADDR_HI(x)          ((uint64_t) (x) >> 32)
  79
  80 #define JME_MSI_MESSAGES        8
  81 #define JME_MSIX_MESSAGES       8
  82
  83 /* Water mark to kick reclaiming Tx buffers. */
  84 #define JME_TX_DESC_HIWAT(sc)   \
  85         ((sc)->jme_tx_desc_cnt - (((sc)->jme_tx_desc_cnt * 3) / 10))
  86
  87 /*
  88  * JMC250 can send 9K jumbo frame on Tx path and can receive
  89  * 65535 bytes.
  90  */
  91 #define JME_JUMBO_FRAMELEN      9216
  92 #define JME_JUMBO_MTU                                                   \
  93         (JME_JUMBO_FRAMELEN - sizeof(struct ether_vlan_header) -        \
  94          ETHER_HDR_LEN - ETHER_CRC_LEN)
  95 #define JME_MAX_MTU                                                     \
  96         (ETHER_MAX_LEN + sizeof(struct ether_vlan_header) -             \
  97          ETHER_HDR_LEN - ETHER_CRC_LEN)
  98 /*
  99  * JMC250 can't handle Tx checksum offload/TSO if frame length
 100  * is larger than its FIFO size(2K). It's also good idea to not
 101  * use jumbo frame if hardware is running at half-duplex media.
 102  * Because the jumbo frame may not fit into the Tx FIFO,
 103  * collisions make hardware fetch frame from host memory with
 104  * DMA again which in turn slows down Tx performance
 105  * significantly.
 106  */
 107 #define JME_TX_FIFO_SIZE        2000
 108 /*
 109  * JMC250 has just 4K Rx FIFO. To support jumbo frame that is
 110  * larger than 4K bytes in length, Rx FIFO threshold should be
 111  * adjusted to minimize Rx FIFO overrun.
 112  */
 113 #define JME_RX_FIFO_SIZE        4000
 114
 115 #define JME_DESC_INC(x, y)      ((x) = ((x) + 1) % (y))
 116
 117 struct jme_txdesc {
 118         struct mbuf             *tx_m;
 119         bus_dmamap_t            tx_dmamap;
 120         int                     tx_ndesc;
 121         struct jme_desc         *tx_desc;
 122 };
 123
 124 struct jme_rxdesc {
 125         struct mbuf             *rx_m;
 126         bus_dmamap_t            rx_dmamap;
 127         struct jme_desc         *rx_desc;
 128 };
 129
 130 /*
 131  * RX ring/descs
 132  */
 133 struct jme_rxdata {
 134         struct lwkt_serialize   jme_rx_serialize;
 135         bus_dma_tag_t           jme_rx_tag;     /* RX mbuf tag */
 136         bus_dmamap_t            jme_rx_sparemap;
 137         struct jme_rxdesc       *jme_rxdesc;
 138
 139         struct jme_desc         *jme_rx_ring;
 140         bus_addr_t              jme_rx_ring_paddr;
 141         bus_dma_tag_t           jme_rx_ring_tag;
 142         bus_dmamap_t            jme_rx_ring_map;
 143
 144         int                     jme_rx_cons;
 145
 146         int                     jme_rxlen;
 147         struct mbuf             *jme_rxhead;
 148         struct mbuf             *jme_rxtail;
 149 };
 150
 151 struct jme_chain_data {
 152         /*
 153          * Top level tags
 154          */
 155         bus_dma_tag_t           jme_ring_tag;   /* parent ring tag */
 156         bus_dma_tag_t           jme_buffer_tag; /* parent mbuf/ssb tag */
 157
 158         /*
 159          * Shadow status block
 160          */
 161         struct jme_ssb          *jme_ssb_block;
 162         bus_addr_t              jme_ssb_block_paddr;
 163         bus_dma_tag_t           jme_ssb_tag;
 164         bus_dmamap_t            jme_ssb_map;
 165
 166         /*
 167          * TX ring/descs
 168          */
 169         struct lwkt_serialize   jme_tx_serialize;
 170         bus_dma_tag_t           jme_tx_tag;     /* TX mbuf tag */
 171         struct jme_txdesc       *jme_txdesc;
 172
 173         struct jme_desc         *jme_tx_ring;
 174         bus_addr_t              jme_tx_ring_paddr;
 175         bus_dma_tag_t           jme_tx_ring_tag;
 176         bus_dmamap_t            jme_tx_ring_map;
 177
 178         int                     jme_tx_prod;
 179         int                     jme_tx_cons;
 180         int                     jme_tx_cnt;
 181
 182         struct jme_rxdata       jme_rx_data[JME_NRXRING_MAX];
 183 };
 184
 185 #define JME_TX_RING_SIZE(sc)    \
 186     (sizeof(struct jme_desc) * (sc)->jme_tx_desc_cnt)
 187 #define JME_RX_RING_SIZE(sc)    \
 188     (sizeof(struct jme_desc) * (sc)->jme_rx_desc_cnt)
 189 #define JME_SSB_SIZE            sizeof(struct jme_ssb)
 190
 191 /*
 192  * Software state per device.
 193  */
 194 struct jme_softc {
 195         struct arpcom           arpcom;
 196         device_t                jme_dev;
 197
 198         int                     jme_mem_rid;
 199         struct resource         *jme_mem_res;
 200         bus_space_tag_t         jme_mem_bt;
 201         bus_space_handle_t      jme_mem_bh;
 202
 203         int                     jme_irq_type;
 204         int                     jme_irq_rid;
 205         struct resource         *jme_irq_res;
 206         void                    *jme_irq_handle;
 207
 208         device_t                jme_miibus;
 209         int                     jme_phyaddr;
 210         bus_addr_t              jme_lowaddr;
 211
 212         uint32_t                jme_clksrc;
 213         uint32_t                jme_clksrc_1000;
 214         uint32_t                jme_tx_dma_size;
 215         uint32_t                jme_rx_dma_size;
 216
 217         uint32_t                jme_caps;
 218 #define JME_CAP_FPGA            0x0001
 219 #define JME_CAP_PCIE            0x0002
 220 #define JME_CAP_PMCAP           0x0004
 221 #define JME_CAP_FASTETH         0x0008
 222 #define JME_CAP_JUMBO           0x0010
 223
 224         uint32_t                jme_workaround;
 225 #define JME_WA_EXTFIFO          0x0001
 226 #define JME_WA_HDX              0x0002
 227
 228         uint32_t                jme_flags;
 229 #define JME_FLAG_MSI            0x0001
 230 #define JME_FLAG_MSIX           0x0002
 231 #define JME_FLAG_DETACH         0x0004
 232 #define JME_FLAG_LINK           0x0008
 233
 234         struct lwkt_serialize   jme_serialize;
 235         struct lwkt_serialize   *jme_serialize_arr[JME_NSERIALIZE];
 236         int                     jme_serialize_cnt;
 237
 238         struct callout          jme_tick_ch;
 239         struct jme_chain_data   jme_cdata;
 240         int                     jme_if_flags;
 241         uint32_t                jme_txcsr;
 242         uint32_t                jme_rxcsr;
 243
 244         int                     jme_txd_spare;
 245
 246         struct sysctl_ctx_list  jme_sysctl_ctx;
 247         struct sysctl_oid       *jme_sysctl_tree;
 248
 249         /*
 250          * Sysctl variables
 251          */
 252         int                     jme_tx_coal_to;
 253         int                     jme_tx_coal_pkt;
 254         int                     jme_rx_coal_to;
 255         int                     jme_rx_coal_pkt;
 256         int                     jme_rx_desc_cnt;
 257         int                     jme_tx_desc_cnt;
 258         int                     jme_rx_ring_cnt;
 259         int                     jme_rx_ring_inuse;
 260         int                     jme_rss_debug;
 261         u_int                   jme_rx_ring_pkt[JME_NRXRING_MAX];
 262 };
 263
 264 /* Register access macros. */
 265 #define CSR_WRITE_4(_sc, reg, val)      \
 266         bus_space_write_4((_sc)->jme_mem_bt, (_sc)->jme_mem_bh, (reg), (val))
 267 #define CSR_READ_4(_sc, reg)            \
 268         bus_space_read_4((_sc)->jme_mem_bt, (_sc)->jme_mem_bh, (reg))
 269
 270 #define JME_MAXERR      5
 271
 272 #define JME_RXCHAIN_RESET(sc, ring)                             \
 273 do {                                                            \
 274         (sc)->jme_cdata.jme_rx_data[(ring)].jme_rxhead = NULL;  \
 275         (sc)->jme_cdata.jme_rx_data[(ring)].jme_rxtail = NULL;  \
 276         (sc)->jme_cdata.jme_rx_data[(ring)].jme_rxlen = 0;      \
 277 } while (0)
 278
 279 #define JME_TX_TIMEOUT          5
 280 #define JME_TIMEOUT             1000
 281 #define JME_PHY_TIMEOUT         1000
 282 #define JME_EEPROM_TIMEOUT      1000
 283
 284 #define JME_TXD_RSVD            1
 285
 286 #endif