sys/dev/cxgb/cxgb_adapter.h

   1 /**************************************************************************
   2
   3 Copyright (c) 2007, Chelsio Inc.
   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. Neither the name of the Chelsio Corporation nor the names of its
  13     contributors may be used to endorse or promote products derived from
  14     this software without specific prior written permission.
  15
  16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  20 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26 POSSIBILITY OF SUCH DAMAGE.
  27
  28
  29 $FreeBSD$
  30
  31 ***************************************************************************/
  32
  33
  34
  35 #ifndef _CXGB_ADAPTER_H_
  36 #define _CXGB_ADAPTER_H_
  37
  38 #include <sys/cdefs.h>
  39 __FBSDID("$FreeBSD$");
  40
  41 #include <sys/lock.h>
  42 #include <sys/mutex.h>
  43 #include <sys/sx.h>
  44 #include <sys/rman.h>
  45 #include <sys/mbuf.h>
  46 #include <sys/socket.h>
  47 #include <sys/sockio.h>
  48
  49 #include <net/ethernet.h>
  50 #include <net/if.h>
  51 #include <net/if_media.h>
  52
  53 #include <machine/bus.h>
  54 #include <machine/resource.h>
  55 #include <sys/bus_dma.h>
  56 #include <dev/pci/pcireg.h>
  57 #include <dev/pci/pcivar.h>
  58
  59 #ifdef CONFIG_DEFINED
  60 #include <cxgb_osdep.h>
  61 #include <ulp/toecore/toedev.h>
  62 #include <sys/mbufq.h>
  63 #else
  64 #include <dev/cxgb/cxgb_osdep.h>
  65 #include <dev/cxgb/sys/mbufq.h>
  66 #include <dev/cxgb/ulp/toecore/toedev.h>
  67 #endif
  68
  69 #define USE_SX
  70
  71 struct adapter;
  72 struct sge_qset;
  73 extern int cxgb_debug;
  74
  75 #ifdef DEBUG_LOCKING
  76 #define MTX_INIT(lock, lockname, class, flags) \
  77         do { \
  78                 printf("initializing %s at %s:%d\n", lockname, __FILE__, __LINE__); \
  79                 mtx_init((lock), lockname, class, flags);               \
  80         } while (0)
  81
  82 #define MTX_DESTROY(lock) \
  83         do { \
  84                 printf("destroying %s at %s:%d\n", (lock)->lock_object.lo_name, __FILE__, __LINE__); \
  85                 mtx_destroy((lock));                                    \
  86         } while (0)
  87
  88 #define SX_INIT(lock, lockname) \
  89         do { \
  90                 printf("initializing %s at %s:%d\n", lockname, __FILE__, __LINE__); \
  91                 sx_init((lock), lockname);              \
  92         } while (0)
  93
  94 #define SX_DESTROY(lock) \
  95         do { \
  96                 printf("destroying %s at %s:%d\n", (lock)->lock_object.lo_name, __FILE__, __LINE__); \
  97                 sx_destroy((lock));                                     \
  98         } while (0)
  99 #else
 100 #define MTX_INIT mtx_init
 101 #define MTX_DESTROY mtx_destroy
 102 #define SX_INIT sx_init
 103 #define SX_DESTROY sx_destroy
 104 #endif
 105
 106 struct port_info {
 107         struct adapter  *adapter;
 108         struct ifnet    *ifp;
 109         int             if_flags;
 110         const struct port_type_info *port_type;
 111         struct cphy     phy;
 112         struct cmac     mac;
 113         struct link_config link_config;
 114         struct ifmedia  media;
 115 #ifdef USE_SX
 116         struct sx       lock;
 117 #else
 118         struct mtx      lock;
 119 #endif
 120         int             port_id;
 121         uint8_t         hw_addr[ETHER_ADDR_LEN];
 122         uint8_t         nqsets;
 123         uint8_t         first_qset;
 124         struct taskqueue *tq;
 125         struct task     start_task;
 126         struct task     timer_reclaim_task;
 127         struct cdev     *port_cdev;
 128
 129 #define PORT_NAME_LEN 32
 130 #define TASKQ_NAME_LEN 32
 131         char            lockbuf[PORT_NAME_LEN];
 132         char            taskqbuf[TASKQ_NAME_LEN];
 133 };
 134
 135 enum {                          /* adapter flags */
 136         FULL_INIT_DONE  = (1 << 0),
 137         USING_MSI       = (1 << 1),
 138         USING_MSIX      = (1 << 2),
 139         QUEUES_BOUND    = (1 << 3),
 140         FW_UPTODATE     = (1 << 4),
 141         TPS_UPTODATE    = (1 << 5),
 142 };
 143
 144
 145 #define FL_Q_SIZE       4096
 146 #define JUMBO_Q_SIZE    512
 147 #define RSPQ_Q_SIZE     1024
 148 #define TX_ETH_Q_SIZE   1024
 149
 150
 151
 152 /*
 153  * Types of Tx queues in each queue set.  Order here matters, do not change.
 154  * XXX TOE is not implemented yet, so the extra queues are just placeholders.
 155  */
 156 enum { TXQ_ETH, TXQ_OFLD, TXQ_CTRL };
 157
 158
 159 /* careful, the following are set on priv_flags and must not collide with
 160  * IFF_ flags!
 161  */
 162 enum {
 163         LRO_ACTIVE = (1 << 8),
 164 };
 165
 166 /* Max concurrent LRO sessions per queue set */
 167 #define MAX_LRO_SES 8
 168
 169 struct t3_lro_session {
 170         struct mbuf *head;
 171         struct mbuf *tail;
 172         uint32_t seq;
 173         uint16_t ip_len;
 174         uint16_t vtag;
 175         uint8_t npkts;
 176 };
 177
 178 struct lro_state {
 179         unsigned short enabled;
 180         unsigned short active_idx;
 181         unsigned int nactive;
 182         struct t3_lro_session sess[MAX_LRO_SES];
 183 };
 184
 185 #define RX_BUNDLE_SIZE 8
 186
 187 struct rsp_desc;
 188
 189 struct sge_rspq {
 190         uint32_t        credits;
 191         uint32_t        size;
 192         uint32_t        cidx;
 193         uint32_t        gen;
 194         uint32_t        polling;
 195         uint32_t        holdoff_tmr;
 196         uint32_t        next_holdoff;
 197         uint32_t        imm_data;
 198         struct rsp_desc *desc;
 199         uint32_t        cntxt_id;
 200         struct mtx      lock;
 201         struct mbuf     *rx_head;    /* offload packet receive queue head */
 202         struct mbuf     *rx_tail;    /* offload packet receive queue tail */
 203
 204         uint32_t        offload_pkts;
 205         uint32_t        offload_bundles;
 206         uint32_t        pure_rsps;
 207         uint32_t        unhandled_irqs;
 208
 209         bus_addr_t      phys_addr;
 210         bus_dma_tag_t   desc_tag;
 211         bus_dmamap_t    desc_map;
 212         struct mbuf     *m;
 213 #define RSPQ_NAME_LEN  32
 214         char            lockbuf[RSPQ_NAME_LEN];
 215
 216 };
 217
 218 struct rx_desc;
 219 struct rx_sw_desc;
 220
 221 struct sge_fl {
 222         uint32_t        buf_size;
 223         uint32_t        credits;
 224         uint32_t        size;
 225         uint32_t        cidx;
 226         uint32_t        pidx;
 227         uint32_t        gen;
 228         struct rx_desc  *desc;
 229         struct rx_sw_desc *sdesc;
 230         bus_addr_t      phys_addr;
 231         uint32_t        cntxt_id;
 232         uint64_t        empty;
 233         bus_dma_tag_t   desc_tag;
 234         bus_dmamap_t    desc_map;
 235         bus_dma_tag_t   entry_tag;
 236         uma_zone_t      zone;
 237         int             type;
 238 };
 239
 240 struct tx_desc;
 241 struct tx_sw_desc;
 242
 243 #define TXQ_TRANSMITTING    0x1
 244
 245 struct sge_txq {
 246         uint64_t        flags;
 247         uint32_t        in_use;
 248         uint32_t        size;
 249         uint32_t        processed;
 250         uint32_t        cleaned;
 251         uint32_t        stop_thres;
 252         uint32_t        cidx;
 253         uint32_t        pidx;
 254         uint32_t        gen;
 255         uint32_t        unacked;
 256         struct tx_desc  *desc;
 257         struct tx_sw_desc *sdesc;
 258         uint32_t        token;
 259         bus_addr_t      phys_addr;
 260         struct task     qresume_task;
 261         struct task     qreclaim_task;
 262         struct port_info *port;
 263         uint32_t        cntxt_id;
 264         uint64_t        stops;
 265         uint64_t        restarts;
 266         bus_dma_tag_t   desc_tag;
 267         bus_dmamap_t    desc_map;
 268         bus_dma_tag_t   entry_tag;
 269         struct mbuf_head sendq;
 270         struct mtx      lock;
 271 #define TXQ_NAME_LEN  32
 272         char            lockbuf[TXQ_NAME_LEN];
 273 };
 274
 275
 276 enum {
 277         SGE_PSTAT_TSO,              /* # of TSO requests */
 278         SGE_PSTAT_RX_CSUM_GOOD,     /* # of successful RX csum offloads */
 279         SGE_PSTAT_TX_CSUM,          /* # of TX checksum offloads */
 280         SGE_PSTAT_VLANEX,           /* # of VLAN tag extractions */
 281         SGE_PSTAT_VLANINS,          /* # of VLAN tag insertions */
 282         SGE_PSTATS_LRO_QUEUED,      /* # of LRO appended packets */
 283         SGE_PSTATS_LRO_FLUSHED,     /* # of LRO flushed packets */
 284         SGE_PSTATS_LRO_X_STREAMS,   /* # of exceeded LRO contexts */
 285 };
 286
 287 #define SGE_PSTAT_MAX (SGE_PSTATS_LRO_X_STREAMS+1)
 288
 289 struct sge_qset {
 290         struct sge_rspq         rspq;
 291         struct sge_fl           fl[SGE_RXQ_PER_SET];
 292         struct lro_state        lro;
 293         struct sge_txq          txq[SGE_TXQ_PER_SET];
 294         uint32_t                txq_stopped;       /* which Tx queues are stopped */
 295         uint64_t                port_stats[SGE_PSTAT_MAX];
 296         struct port_info        *port;
 297         int                     idx; /* qset # */
 298 };
 299
 300 struct sge {
 301         struct sge_qset         qs[SGE_QSETS];
 302         struct mtx              reg_lock;
 303 };
 304
 305 struct filter_info;
 306
 307 struct adapter {
 308         device_t                dev;
 309         int                     flags;
 310         TAILQ_ENTRY(adapter)    adapter_entry;
 311
 312         /* PCI register resources */
 313         uint32_t                regs_rid;
 314         struct resource         *regs_res;
 315         bus_space_handle_t      bh;
 316         bus_space_tag_t         bt;
 317         bus_size_t              mmio_len;
 318         uint32_t                link_width;
 319
 320         /* DMA resources */
 321         bus_dma_tag_t           parent_dmat;
 322         bus_dma_tag_t           rx_dmat;
 323         bus_dma_tag_t           rx_jumbo_dmat;
 324         bus_dma_tag_t           tx_dmat;
 325
 326         /* Interrupt resources */
 327         struct resource         *irq_res;
 328         int                     irq_rid;
 329         void                    *intr_tag;
 330
 331         uint32_t                msix_regs_rid;
 332         struct resource         *msix_regs_res;
 333
 334         struct resource         *msix_irq_res[SGE_QSETS];
 335         int                     msix_irq_rid[SGE_QSETS];
 336         void                    *msix_intr_tag[SGE_QSETS];
 337         uint8_t                 rxpkt_map[8]; /* maps RX_PKT interface values to port ids */
 338         uint8_t                 rrss_map[SGE_QSETS]; /* revers RSS map table */
 339
 340         struct filter_info      *filters;
 341
 342         /* Tasks */
 343         struct task             ext_intr_task;
 344         struct task             slow_intr_task;
 345         struct task             tick_task;
 346         struct task             process_responses_task;
 347         struct taskqueue        *tq;
 348         struct callout          cxgb_tick_ch;
 349         struct callout          sge_timer_ch;
 350
 351         /* Register lock for use by the hardware layer */
 352         struct mtx              mdio_lock;
 353         struct mtx              elmer_lock;
 354
 355         /* Bookkeeping for the hardware layer */
 356         struct adapter_params  params;
 357         unsigned int slow_intr_mask;
 358         unsigned long irq_stats[IRQ_NUM_STATS];
 359
 360         struct sge              sge;
 361         struct mc7              pmrx;
 362         struct mc7              pmtx;
 363         struct mc7              cm;
 364         struct mc5              mc5;
 365
 366         struct port_info        port[MAX_NPORTS];
 367         device_t                portdev[MAX_NPORTS];
 368         struct toedev           tdev;
 369         char                    fw_version[64];
 370         uint32_t                open_device_map;
 371         uint32_t                registered_device_map;
 372 #ifdef USE_SX
 373         struct sx               lock;
 374 #else
 375         struct mtx              lock;
 376 #endif
 377         driver_intr_t           *cxgb_intr;
 378         int                     msi_count;
 379
 380 #define ADAPTER_LOCK_NAME_LEN   32
 381         char                    lockbuf[ADAPTER_LOCK_NAME_LEN];
 382         char                    reglockbuf[ADAPTER_LOCK_NAME_LEN];
 383         char                    mdiolockbuf[ADAPTER_LOCK_NAME_LEN];
 384         char                    elmerlockbuf[ADAPTER_LOCK_NAME_LEN];
 385 };
 386
 387 struct t3_rx_mode {
 388
 389         uint32_t                idx;
 390         struct port_info        *port;
 391 };
 392
 393
 394 #define MDIO_LOCK(adapter)      mtx_lock(&(adapter)->mdio_lock)
 395 #define MDIO_UNLOCK(adapter)    mtx_unlock(&(adapter)->mdio_lock)
 396 #define ELMR_LOCK(adapter)      mtx_lock(&(adapter)->elmer_lock)
 397 #define ELMR_UNLOCK(adapter)    mtx_unlock(&(adapter)->elmer_lock)
 398
 399
 400 #ifdef USE_SX
 401 #define PORT_LOCK(port)              sx_xlock(&(port)->lock);
 402 #define PORT_UNLOCK(port)            sx_xunlock(&(port)->lock);
 403 #define PORT_LOCK_INIT(port, name)   SX_INIT(&(port)->lock, name)
 404 #define PORT_LOCK_DEINIT(port)       SX_DESTROY(&(port)->lock)
 405 #define PORT_LOCK_ASSERT_OWNED(port) sx_assert(&(port)->lock, SA_LOCKED)
 406
 407 #define ADAPTER_LOCK(adap)                 sx_xlock(&(adap)->lock);
 408 #define ADAPTER_UNLOCK(adap)               sx_xunlock(&(adap)->lock);
 409 #define ADAPTER_LOCK_INIT(adap, name)      SX_INIT(&(adap)->lock, name)
 410 #define ADAPTER_LOCK_DEINIT(adap)          SX_DESTROY(&(adap)->lock)
 411 #define ADAPTER_LOCK_ASSERT_NOTOWNED(adap) sx_assert(&(adap)->lock, SA_UNLOCKED)
 412 #else
 413 #define PORT_LOCK(port)              mtx_lock(&(port)->lock);
 414 #define PORT_UNLOCK(port)            mtx_unlock(&(port)->lock);
 415 #define PORT_LOCK_INIT(port, name)   mtx_init(&(port)->lock, name, 0, MTX_DEF)
 416 #define PORT_LOCK_DEINIT(port)       mtx_destroy(&(port)->lock)
 417 #define PORT_LOCK_ASSERT_OWNED(port) mtx_assert(&(port)->lock, MA_OWNED)
 418
 419 #define ADAPTER_LOCK(adap)      mtx_lock(&(adap)->lock);
 420 #define ADAPTER_UNLOCK(adap)    mtx_unlock(&(adap)->lock);
 421 #define ADAPTER_LOCK_INIT(adap, name) mtx_init(&(adap)->lock, name, 0, MTX_DEF)
 422 #define ADAPTER_LOCK_DEINIT(adap) mtx_destroy(&(adap)->lock)
 423 #define ADAPTER_LOCK_ASSERT_NOTOWNED(adap) mtx_assert(&(adap)->lock, MO_NOTOWNED)
 424 #endif
 425
 426
 427 static __inline uint32_t
 428 t3_read_reg(adapter_t *adapter, uint32_t reg_addr)
 429 {
 430         return (bus_space_read_4(adapter->bt, adapter->bh, reg_addr));
 431 }
 432
 433 static __inline void
 434 t3_write_reg(adapter_t *adapter, uint32_t reg_addr, uint32_t val)
 435 {
 436         bus_space_write_4(adapter->bt, adapter->bh, reg_addr, val);
 437 }
 438
 439 static __inline void
 440 t3_os_pci_read_config_4(adapter_t *adapter, int reg, uint32_t *val)
 441 {
 442         *val = pci_read_config(adapter->dev, reg, 4);
 443 }
 444
 445 static __inline void
 446 t3_os_pci_write_config_4(adapter_t *adapter, int reg, uint32_t val)
 447 {
 448         pci_write_config(adapter->dev, reg, val, 4);
 449 }
 450
 451 static __inline void
 452 t3_os_pci_read_config_2(adapter_t *adapter, int reg, uint16_t *val)
 453 {
 454         *val = pci_read_config(adapter->dev, reg, 2);
 455 }
 456
 457 static __inline void
 458 t3_os_pci_write_config_2(adapter_t *adapter, int reg, uint16_t val)
 459 {
 460         pci_write_config(adapter->dev, reg, val, 2);
 461 }
 462
 463 static __inline uint8_t *
 464 t3_get_next_mcaddr(struct t3_rx_mode *rm)
 465 {
 466         uint8_t *macaddr = NULL;
 467
 468         if (rm->idx == 0)
 469                 macaddr = rm->port->hw_addr;
 470
 471         rm->idx++;
 472         return (macaddr);
 473 }
 474
 475 static __inline void
 476 t3_init_rx_mode(struct t3_rx_mode *rm, struct port_info *port)
 477 {
 478         rm->idx = 0;
 479         rm->port = port;
 480 }
 481
 482 static __inline struct port_info *
 483 adap2pinfo(struct adapter *adap, int idx)
 484 {
 485         return &adap->port[idx];
 486 }
 487
 488 int t3_os_find_pci_capability(adapter_t *adapter, int cap);
 489 int t3_os_pci_save_state(struct adapter *adapter);
 490 int t3_os_pci_restore_state(struct adapter *adapter);
 491 void t3_os_link_changed(adapter_t *adapter, int port_id, int link_status,
 492                         int speed, int duplex, int fc);
 493 void t3_sge_err_intr_handler(adapter_t *adapter);
 494 int t3_offload_tx(struct toedev *, struct mbuf *);
 495 void t3_os_ext_intr_handler(adapter_t *adapter);
 496 void t3_os_set_hw_addr(adapter_t *adapter, int port_idx, u8 hw_addr[]);
 497 int t3_mgmt_tx(adapter_t *adap, struct mbuf *m);
 498
 499
 500 int t3_sge_alloc(struct adapter *);
 501 int t3_sge_free(struct adapter *);
 502 int t3_sge_alloc_qset(adapter_t *, uint32_t, int, int, const struct qset_params *,
 503     int, struct port_info *);
 504 void t3_free_sge_resources(adapter_t *);
 505 void t3_sge_start(adapter_t *);
 506 void t3_sge_stop(adapter_t *);
 507 void t3b_intr(void *data);
 508 void t3_intr_msi(void *data);
 509 void t3_intr_msix(void *data);
 510 int t3_encap(struct port_info *, struct mbuf **);
 511
 512 int t3_sge_init_adapter(adapter_t *);
 513 int t3_sge_init_port(struct port_info *);
 514 void t3_sge_deinit_sw(adapter_t *);
 515
 516 void t3_rx_eth_lro(adapter_t *adap, struct sge_rspq *rq, struct mbuf *m,
 517     int ethpad, uint32_t rss_hash, uint32_t rss_csum, int lro);
 518 void t3_rx_eth(struct port_info *p, struct sge_rspq *rq, struct mbuf *m, int ethpad);
 519 void t3_lro_flush(adapter_t *adap, struct sge_qset *qs, struct lro_state *state);
 520
 521 void t3_add_sysctls(adapter_t *sc);
 522 int t3_get_desc(const struct sge_qset *qs, unsigned int qnum, unsigned int idx,
 523     unsigned char *data);
 524 void t3_update_qset_coalesce(struct sge_qset *qs, const struct qset_params *p);
 525 /*
 526  * XXX figure out how we can return this to being private to sge
 527  */
 528 #define desc_reclaimable(q) ((int)((q)->processed - (q)->cleaned - TX_MAX_DESC))
 529
 530 #define container_of(p, stype, field) ((stype *)(((uint8_t *)(p)) - offsetof(stype, field)))
 531
 532 static __inline struct sge_qset *
 533 fl_to_qset(struct sge_fl *q, int qidx)
 534 {
 535         return container_of(q, struct sge_qset, fl[qidx]);
 536 }
 537
 538 static __inline struct sge_qset *
 539 rspq_to_qset(struct sge_rspq *q)
 540 {
 541         return container_of(q, struct sge_qset, rspq);
 542 }
 543
 544 static __inline struct sge_qset *
 545 txq_to_qset(struct sge_txq *q, int qidx)
 546 {
 547         return container_of(q, struct sge_qset, txq[qidx]);
 548 }
 549
 550 static __inline struct adapter *
 551 tdev2adap(struct toedev *d)
 552 {
 553         return container_of(d, struct adapter, tdev);
 554 }
 555
 556 #undef container_of
 557
 558 #define OFFLOAD_DEVMAP_BIT 15
 559 static inline int offload_running(adapter_t *adapter)
 560 {
 561         return isset(&adapter->open_device_map, OFFLOAD_DEVMAP_BIT);
 562 }
 563
 564
 565 #endif