6  * Generate TX index update each time, when TX ring is closed.
 
   7  * Normally, this is not useful, because results in more dma (and irqs
 
   8  * without TX_COAL_INTS_ONLY).
 
  10 #define USE_TX_COAL_NOW  0
 
  15  * The Tigon uses 64-bit host addresses, regardless of their actual
 
  16  * length, and it expects a big-endian format. For 32 bit systems the
 
  17  * upper 32 bits of the address are simply ignored (zero), however for
 
  18  * little endian 64 bit systems (Alpha) this looks strange with the
 
  19  * two parts of the address word being swapped.
 
  21  * The addresses are split in two 32 bit words for all architectures
 
  22  * as some of them are in PCI shared memory and it is necessary to use
 
  23  * readl/writel to access them.
 
  25  * The addressing code is derived from Pete Wyckoff's work, but
 
  26  * modified to deal properly with readl/writel usage.
 
  30         u32     pad0[16];       /* PCI control registers */
 
  32         u32     HostCtrl;       /* 0x40 */
 
  37         u32     MiscCfg;        /* 0x50 */
 
  43         u32     pad3[2];        /* 0x60 */
 
  48         u32     pad4[12];       /* 0x70 */
 
  50         u32     DmaWriteState;  /* 0xa0 */
 
  52         u32     DmaReadState;   /* 0xb0 */
 
  58         u32     pad7[8];        /* 0x120 */
 
  60         u32     CpuCtrl;        /* 0x140 */
 
  65         u32     SramAddr;       /* 0x154 */
 
  70         u32     MacRxState;     /* 0x220 */
 
  74         u32     CpuBCtrl;       /* 0x240 */
 
  79         u32     SramBAddr;      /* 0x254 */
 
  84         u32     pad13[32];      /* 0x400 */
 
  87         u32     Mb0Hi;          /* 0x500 */
 
 122         u32     MacAddrHi;      /* 0x600 */
 
 126         u32     MultiCastHi;    /* 0x610 */
 
 130         u32     DmaWriteCfg;    /* 0x620 */
 
 134         u32     TuneRxCoalTicks;/* 0x630 */
 
 138         u32     TuneMaxRxDesc;  /* 0x640 */
 
 142         u32     TracePtr;       /* 0x650 */
 
 146         u32     IfMtu;          /* 0x660 */
 
 150         u32     pad16[4];       /* 0x670 */
 
 151         u32     RxRetCsm;       /* 0x680 */
 
 155         u32     CmdRng[64];     /* 0x700 */
 
 166 #define ACE_WINDOW_SIZE 0x800
 
 168 #define ACE_JUMBO_MTU 9000
 
 169 #define ACE_STD_MTU 1500
 
 171 #define ACE_TRACE_SIZE 0x8000
 
 174  * Host control register bits.
 
 179 #define HW_RESET        0x08
 
 180 #define BYTE_SWAP       0x10
 
 181 #define WORD_SWAP       0x20
 
 182 #define MASK_INTS       0x40
 
 185  * Local control register bits.
 
 188 #define EEPROM_DATA_IN          0x800000
 
 189 #define EEPROM_DATA_OUT         0x400000
 
 190 #define EEPROM_WRITE_ENABLE     0x200000
 
 191 #define EEPROM_CLK_OUT          0x100000
 
 193 #define EEPROM_BASE             0xa0000000
 
 195 #define EEPROM_WRITE_SELECT     0xa0
 
 196 #define EEPROM_READ_SELECT      0xa1
 
 198 #define SRAM_BANK_512K          0x200
 
 202  * udelay() values for when clocking the eeprom
 
 204 #define ACE_SHORT_DELAY         2
 
 205 #define ACE_LONG_DELAY          4
 
 212 #define SYNC_SRAM_TIMING        0x100000
 
 219 #define CPU_RESET               0x01
 
 220 #define CPU_TRACE               0x02
 
 221 #define CPU_PROM_FAILED         0x10
 
 222 #define CPU_HALT                0x00010000
 
 223 #define CPU_HALTED              0xffff0000
 
 230 #define DMA_READ_MAX_4          0x04
 
 231 #define DMA_READ_MAX_16         0x08
 
 232 #define DMA_READ_MAX_32         0x0c
 
 233 #define DMA_READ_MAX_64         0x10
 
 234 #define DMA_READ_MAX_128        0x14
 
 235 #define DMA_READ_MAX_256        0x18
 
 236 #define DMA_READ_MAX_1K         0x1c
 
 237 #define DMA_WRITE_MAX_4         0x20
 
 238 #define DMA_WRITE_MAX_16        0x40
 
 239 #define DMA_WRITE_MAX_32        0x60
 
 240 #define DMA_WRITE_MAX_64        0x80
 
 241 #define DMA_WRITE_MAX_128       0xa0
 
 242 #define DMA_WRITE_MAX_256       0xc0
 
 243 #define DMA_WRITE_MAX_1K        0xe0
 
 244 #define DMA_READ_WRITE_MASK     0xfc
 
 245 #define MEM_READ_MULTIPLE       0x00020000
 
 246 #define PCI_66MHZ               0x00080000
 
 247 #define PCI_32BIT               0x00100000
 
 248 #define DMA_WRITE_ALL_ALIGN     0x00800000
 
 249 #define READ_CMD_MEM            0x06000000
 
 250 #define WRITE_CMD_MEM           0x70000000
 
 257 #define ACE_BYTE_SWAP_BD        0x02
 
 258 #define ACE_WORD_SWAP_BD        0x04            /* not actually used */
 
 259 #define ACE_WARN                0x08
 
 260 #define ACE_BYTE_SWAP_DMA       0x10
 
 261 #define ACE_NO_JUMBO_FRAG       0x200
 
 262 #define ACE_FATAL               0x40000000
 
 269 #define DMA_THRESH_1W           0x10
 
 270 #define DMA_THRESH_2W           0x20
 
 271 #define DMA_THRESH_4W           0x40
 
 272 #define DMA_THRESH_8W           0x80
 
 273 #define DMA_THRESH_16W          0x100
 
 274 #define DMA_THRESH_32W          0x0     /* not described in doc, but exists. */
 
 281 #define TICKS_PER_SEC           1000000
 
 288 #define LNK_PREF                0x00008000
 
 289 #define LNK_10MB                0x00010000
 
 290 #define LNK_100MB               0x00020000
 
 291 #define LNK_1000MB              0x00040000
 
 292 #define LNK_FULL_DUPLEX         0x00080000
 
 293 #define LNK_HALF_DUPLEX         0x00100000
 
 294 #define LNK_TX_FLOW_CTL_Y       0x00200000
 
 295 #define LNK_NEG_ADVANCED        0x00400000
 
 296 #define LNK_RX_FLOW_CTL_Y       0x00800000
 
 297 #define LNK_NIC                 0x01000000
 
 298 #define LNK_JAM                 0x02000000
 
 299 #define LNK_JUMBO               0x04000000
 
 300 #define LNK_ALTEON              0x08000000
 
 301 #define LNK_NEG_FCTL            0x10000000
 
 302 #define LNK_NEGOTIATE           0x20000000
 
 303 #define LNK_ENABLE              0x40000000
 
 304 #define LNK_UP                  0x80000000
 
 311 #define EVT_RING_ENTRIES        256
 
 312 #define EVT_RING_SIZE   (EVT_RING_ENTRIES * sizeof(struct event))
 
 315 #ifdef __LITTLE_ENDIAN_BITFIELD
 
 332 #define E_FW_RUNNING            0x01
 
 333 #define E_STATS_UPDATED         0x04
 
 335 #define E_STATS_UPDATE          0x04
 
 337 #define E_LNK_STATE             0x06
 
 338 #define E_C_LINK_UP             0x01
 
 339 #define E_C_LINK_DOWN           0x02
 
 340 #define E_C_LINK_10_100         0x03
 
 343 #define E_C_ERR_INVAL_CMD       0x01
 
 344 #define E_C_ERR_UNIMP_CMD       0x02
 
 345 #define E_C_ERR_BAD_CFG         0x03
 
 347 #define E_MCAST_LIST            0x08
 
 348 #define E_C_MCAST_ADDR_ADD      0x01
 
 349 #define E_C_MCAST_ADDR_DEL      0x02
 
 351 #define E_RESET_JUMBO_RNG       0x09
 
 358 #define CMD_RING_ENTRIES        64
 
 361 #ifdef __LITTLE_ENDIAN_BITFIELD
 
 373 #define C_HOST_STATE            0x01
 
 374 #define C_C_STACK_UP            0x01
 
 375 #define C_C_STACK_DOWN          0x02
 
 377 #define C_FDR_FILTERING         0x02
 
 378 #define C_C_FDR_FILT_ENABLE     0x01
 
 379 #define C_C_FDR_FILT_DISABLE    0x02
 
 381 #define C_SET_RX_PRD_IDX        0x03
 
 382 #define C_UPDATE_STATS          0x04
 
 383 #define C_RESET_JUMBO_RNG       0x05
 
 384 #define C_ADD_MULTICAST_ADDR    0x08
 
 385 #define C_DEL_MULTICAST_ADDR    0x09
 
 387 #define C_SET_PROMISC_MODE      0x0a
 
 388 #define C_C_PROMISC_ENABLE      0x01
 
 389 #define C_C_PROMISC_DISABLE     0x02
 
 391 #define C_LNK_NEGOTIATION       0x0b
 
 392 #define C_C_NEGOTIATE_BOTH      0x00
 
 393 #define C_C_NEGOTIATE_GIG       0x01
 
 394 #define C_C_NEGOTIATE_10_100    0x02
 
 396 #define C_SET_MAC_ADDR          0x0c
 
 397 #define C_CLEAR_PROFILE         0x0d
 
 399 #define C_SET_MULTICAST_MODE    0x0e
 
 400 #define C_C_MCAST_ENABLE        0x01
 
 401 #define C_C_MCAST_DISABLE       0x02
 
 403 #define C_CLEAR_STATS           0x0f
 
 404 #define C_SET_RX_JUMBO_PRD_IDX  0x10
 
 405 #define C_REFRESH_STATS         0x11
 
 411 #define BD_FLG_TCP_UDP_SUM      0x01
 
 412 #define BD_FLG_IP_SUM           0x02
 
 413 #define BD_FLG_END              0x04
 
 414 #define BD_FLG_MORE             0x08
 
 415 #define BD_FLG_JUMBO            0x10
 
 416 #define BD_FLG_UCAST            0x20
 
 417 #define BD_FLG_MCAST            0x40
 
 418 #define BD_FLG_BCAST            0x60
 
 419 #define BD_FLG_TYP_MASK         0x60
 
 420 #define BD_FLG_IP_FRAG          0x80
 
 421 #define BD_FLG_IP_FRAG_END      0x100
 
 422 #define BD_FLG_VLAN_TAG         0x200
 
 423 #define BD_FLG_FRAME_ERROR      0x400
 
 424 #define BD_FLG_COAL_NOW         0x800
 
 425 #define BD_FLG_MINI             0x1000
 
 429  * Ring Control block flags
 
 431 #define RCB_FLG_TCP_UDP_SUM     0x01
 
 432 #define RCB_FLG_IP_SUM          0x02
 
 433 #define RCB_FLG_NO_PSEUDO_HDR   0x08
 
 434 #define RCB_FLG_VLAN_ASSIST     0x10
 
 435 #define RCB_FLG_COAL_INT_ONLY   0x20
 
 436 #define RCB_FLG_TX_HOST_RING    0x40
 
 437 #define RCB_FLG_IEEE_SNAP_SUM   0x80
 
 438 #define RCB_FLG_EXT_RX_BD       0x100
 
 439 #define RCB_FLG_RNG_DISABLE     0x200
 
 443  * TX ring - maximum TX ring entries for Tigon I's is 128
 
 445 #define MAX_TX_RING_ENTRIES     256
 
 446 #define TIGON_I_TX_RING_ENTRIES 128
 
 447 #define TX_RING_SIZE            (MAX_TX_RING_ENTRIES * sizeof(struct tx_desc))
 
 448 #define TX_RING_BASE            0x3800
 
 455  * This is in PCI shared mem and must be accessed with readl/writel
 
 474 #define RX_STD_RING_ENTRIES     512
 
 475 #define RX_STD_RING_SIZE        (RX_STD_RING_ENTRIES * sizeof(struct rx_desc))
 
 477 #define RX_JUMBO_RING_ENTRIES   256
 
 478 #define RX_JUMBO_RING_SIZE      (RX_JUMBO_RING_ENTRIES *sizeof(struct rx_desc))
 
 480 #define RX_MINI_RING_ENTRIES    1024
 
 481 #define RX_MINI_RING_SIZE       (RX_MINI_RING_ENTRIES *sizeof(struct rx_desc))
 
 483 #define RX_RETURN_RING_ENTRIES  2048
 
 484 #define RX_RETURN_RING_SIZE     (RX_MAX_RETURN_RING_ENTRIES * \
 
 485                                  sizeof(struct rx_desc))
 
 489 #ifdef __LITTLE_ENDIAN
 
 496 #ifdef __LITTLE_ENDIAN
 
 503 #ifdef __LITTLE_ENDIAN
 
 510 #ifdef __LITTLE_ENDIAN
 
 523  * This struct is shared with the NIC firmware.
 
 527 #ifdef __LITTLE_ENDIAN
 
 538 struct ace_mac_stats {
 
 576         struct ring_ctrl        evt_ctrl;
 
 577         struct ring_ctrl        cmd_ctrl;
 
 578         struct ring_ctrl        tx_ctrl;
 
 579         struct ring_ctrl        rx_std_ctrl;
 
 580         struct ring_ctrl        rx_jumbo_ctrl;
 
 581         struct ring_ctrl        rx_mini_ctrl;
 
 582         struct ring_ctrl        rx_return_ctrl;
 
 584         aceaddr rx_ret_prd_ptr;
 
 592         DECLARE_PCI_UNMAP_ADDR(mapping)
 
 597  * Funny... As soon as we add maplen on alpha, it starts to work
 
 598  * much slower. Hmm... is it because struct does not fit to one cacheline?
 
 599  * So, split tx_ring_info.
 
 601 struct tx_ring_info {
 
 603         DECLARE_PCI_UNMAP_ADDR(mapping)
 
 604         DECLARE_PCI_UNMAP_LEN(maplen)
 
 609  * struct ace_skb holding the rings of skb's. This is an awful lot of
 
 610  * pointers, but I don't see any other smart mode to do this in an
 
 611  * efficient manner ;-(
 
 615         struct tx_ring_info     tx_skbuff[MAX_TX_RING_ENTRIES];
 
 616         struct ring_info        rx_std_skbuff[RX_STD_RING_ENTRIES];
 
 617         struct ring_info        rx_mini_skbuff[RX_MINI_RING_ENTRIES];
 
 618         struct ring_info        rx_jumbo_skbuff[RX_JUMBO_RING_ENTRIES];
 
 623  * Struct private for the AceNIC.
 
 625  * Elements are grouped so variables used by the tx handling goes
 
 626  * together, and will go into the same cache lines etc. in order to
 
 627  * avoid cache line contention between the rx and tx handling on SMP.
 
 629  * Frequently accessed variables are put at the beginning of the
 
 630  * struct to help the compiler generate better/shorter code.
 
 634         struct ace_info         *info;
 
 635         struct ace_regs __iomem *regs;          /* register base */
 
 637         dma_addr_t              info_dma;       /* 32/64 bit */
 
 640         int                     promisc, mcast_all;
 
 645         struct tx_desc          *tx_ring;
 
 647         volatile u32            tx_ret_csm;
 
 653         unsigned long           std_refill_busy
 
 654                                 __attribute__ ((aligned (SMP_CACHE_BYTES)));
 
 655         unsigned long           mini_refill_busy, jumbo_refill_busy;
 
 656         atomic_t                cur_rx_bufs;
 
 657         atomic_t                cur_mini_bufs;
 
 658         atomic_t                cur_jumbo_bufs;
 
 659         u32                     rx_std_skbprd, rx_mini_skbprd, rx_jumbo_skbprd;
 
 662         struct rx_desc          *rx_std_ring;
 
 663         struct rx_desc          *rx_jumbo_ring;
 
 664         struct rx_desc          *rx_mini_ring;
 
 665         struct rx_desc          *rx_return_ring;
 
 668         struct vlan_group       *vlgrp;
 
 671         int                     tasklet_pending, jumbo;
 
 672         struct tasklet_struct   ace_tasklet;
 
 674         struct event            *evt_ring;
 
 676         volatile u32            *evt_prd, *rx_ret_prd, *tx_csm;
 
 678         dma_addr_t              tx_ring_dma;    /* 32/64 bit */
 
 679         dma_addr_t              rx_ring_base_dma;
 
 680         dma_addr_t              evt_ring_dma;
 
 681         dma_addr_t              evt_prd_dma, rx_ret_prd_dma, tx_csm_dma;
 
 683         unsigned char           *trace_buf;
 
 684         struct pci_dev          *pdev;
 
 685         struct net_device       *next;
 
 686         volatile int            fw_running;
 
 692         spinlock_t              debug_lock
 
 693                                 __attribute__ ((aligned (SMP_CACHE_BYTES)));
 
 694         u32                     last_tx, last_std_rx, last_mini_rx;
 
 700 #define TX_RESERVED     MAX_SKB_FRAGS
 
 702 static inline int tx_space (struct ace_private *ap, u32 csm, u32 prd)
 
 704         return (csm - prd - 1) & (ACE_TX_RING_ENTRIES(ap) - 1);
 
 707 #define tx_free(ap)             tx_space((ap)->tx_ret_csm, (ap)->tx_prd, ap)
 
 708 #define tx_ring_full(ap, csm, prd)      (tx_space(ap, csm, prd) <= TX_RESERVED)
 
 710 static inline void set_aceaddr(aceaddr *aa, dma_addr_t addr)
 
 712         u64 baddr = (u64) addr;
 
 713         aa->addrlo = baddr & 0xffffffff;
 
 714         aa->addrhi = baddr >> 32;
 
 719 static inline void ace_set_txprd(struct ace_regs __iomem *regs,
 
 720                                  struct ace_private *ap, u32 value)
 
 724         spin_lock_irqsave(&ap->debug_lock, flags);
 
 725         writel(value, ®s->TxPrd);
 
 726         if (value == ap->last_tx)
 
 727                 printk(KERN_ERR "AceNIC RACE ALERT! writing identical value "
 
 728                        "to tx producer (%i)\n", value);
 
 730         spin_unlock_irqrestore(&ap->debug_lock, flags);
 
 732         writel(value, ®s->TxPrd);
 
 738 static inline void ace_mask_irq(struct net_device *dev)
 
 740         struct ace_private *ap = netdev_priv(dev);
 
 741         struct ace_regs __iomem *regs = ap->regs;
 
 743         if (ACE_IS_TIGON_I(ap))
 
 744                 writel(1, ®s->MaskInt);
 
 746                 writel(readl(®s->HostCtrl) | MASK_INTS, ®s->HostCtrl);
 
 748         ace_sync_irq(dev->irq);
 
 752 static inline void ace_unmask_irq(struct net_device *dev)
 
 754         struct ace_private *ap = netdev_priv(dev);
 
 755         struct ace_regs __iomem *regs = ap->regs;
 
 757         if (ACE_IS_TIGON_I(ap))
 
 758                 writel(0, ®s->MaskInt);
 
 760                 writel(readl(®s->HostCtrl) & ~MASK_INTS, ®s->HostCtrl);
 
 767 static int ace_init(struct net_device *dev);
 
 768 static void ace_load_std_rx_ring(struct ace_private *ap, int nr_bufs);
 
 769 static void ace_load_mini_rx_ring(struct ace_private *ap, int nr_bufs);
 
 770 static void ace_load_jumbo_rx_ring(struct ace_private *ap, int nr_bufs);
 
 771 static irqreturn_t ace_interrupt(int irq, void *dev_id);
 
 772 static int ace_load_firmware(struct net_device *dev);
 
 773 static int ace_open(struct net_device *dev);
 
 774 static int ace_start_xmit(struct sk_buff *skb, struct net_device *dev);
 
 775 static int ace_close(struct net_device *dev);
 
 776 static void ace_tasklet(unsigned long dev);
 
 777 static void ace_dump_trace(struct ace_private *ap);
 
 778 static void ace_set_multicast_list(struct net_device *dev);
 
 779 static int ace_change_mtu(struct net_device *dev, int new_mtu);
 
 780 static int ace_set_mac_addr(struct net_device *dev, void *p);
 
 781 static void ace_set_rxtx_parms(struct net_device *dev, int jumbo);
 
 782 static int ace_allocate_descriptors(struct net_device *dev);
 
 783 static void ace_free_descriptors(struct net_device *dev);
 
 784 static void ace_init_cleanup(struct net_device *dev);
 
 785 static struct net_device_stats *ace_get_stats(struct net_device *dev);
 
 786 static int read_eeprom_byte(struct net_device *dev, unsigned long offset);
 
 788 static void ace_vlan_rx_register(struct net_device *dev, struct vlan_group *grp);
 
 791 #endif /* _ACENIC_H_ */