drivers/net/ethernet/natsemi/sonic.h

   1 /*
   2  * Header file for sonic.c
   3  *
   4  * (C) Waldorf Electronics, Germany
   5  * Written by Andreas Busse
   6  *
   7  * NOTE: most of the structure definitions here are endian dependent.
   8  * If you want to use this driver on big endian machines, the data
   9  * and pad structure members must be exchanged. Also, the structures
  10  * need to be changed accordingly to the bus size.
  11  *
  12  * 981229 MSch: did just that for the 68k Mac port (32 bit, big endian)
  13  *
  14  * 990611 David Huggins-Daines <dhd@debian.org>: This machine abstraction
  15  * does not cope with 16-bit bus sizes very well.  Therefore I have
  16  * rewritten it with ugly macros and evil inlines.
  17  *
  18  * 050625 Finn Thain: introduced more 32-bit cards and dhd's support
  19  *        for 16-bit cards (from the mac68k project).
  20  */
  21
  22 #ifndef SONIC_H
  23 #define SONIC_H
  24
  25
  26 /*
  27  * SONIC register offsets
  28  */
  29
  30 #define SONIC_CMD              0x00
  31 #define SONIC_DCR              0x01
  32 #define SONIC_RCR              0x02
  33 #define SONIC_TCR              0x03
  34 #define SONIC_IMR              0x04
  35 #define SONIC_ISR              0x05
  36
  37 #define SONIC_UTDA             0x06
  38 #define SONIC_CTDA             0x07
  39
  40 #define SONIC_URDA             0x0d
  41 #define SONIC_CRDA             0x0e
  42 #define SONIC_EOBC             0x13
  43 #define SONIC_URRA             0x14
  44 #define SONIC_RSA              0x15
  45 #define SONIC_REA              0x16
  46 #define SONIC_RRP              0x17
  47 #define SONIC_RWP              0x18
  48 #define SONIC_RSC              0x2b
  49
  50 #define SONIC_CEP              0x21
  51 #define SONIC_CAP2             0x22
  52 #define SONIC_CAP1             0x23
  53 #define SONIC_CAP0             0x24
  54 #define SONIC_CE               0x25
  55 #define SONIC_CDP              0x26
  56 #define SONIC_CDC              0x27
  57
  58 #define SONIC_WT0              0x29
  59 #define SONIC_WT1              0x2a
  60
  61 #define SONIC_SR               0x28
  62
  63
  64 /* test-only registers */
  65
  66 #define SONIC_TPS               0x08
  67 #define SONIC_TFC               0x09
  68 #define SONIC_TSA0              0x0a
  69 #define SONIC_TSA1              0x0b
  70 #define SONIC_TFS               0x0c
  71
  72 #define SONIC_CRBA0             0x0f
  73 #define SONIC_CRBA1             0x10
  74 #define SONIC_RBWC0             0x11
  75 #define SONIC_RBWC1             0x12
  76 #define SONIC_TTDA              0x20
  77 #define SONIC_MDT               0x2f
  78
  79 #define SONIC_TRBA0             0x19
  80 #define SONIC_TRBA1             0x1a
  81 #define SONIC_TBWC0             0x1b
  82 #define SONIC_TBWC1             0x1c
  83 #define SONIC_LLFA              0x1f
  84
  85 #define SONIC_ADDR0             0x1d
  86 #define SONIC_ADDR1             0x1e
  87
  88 /*
  89  * Error counters
  90  */
  91
  92 #define SONIC_CRCT              0x2c
  93 #define SONIC_FAET              0x2d
  94 #define SONIC_MPT               0x2e
  95
  96 #define SONIC_DCR2              0x3f
  97
  98 /*
  99  * SONIC command bits
 100  */
 101
 102 #define SONIC_CR_LCAM           0x0200
 103 #define SONIC_CR_RRRA           0x0100
 104 #define SONIC_CR_RST            0x0080
 105 #define SONIC_CR_ST             0x0020
 106 #define SONIC_CR_STP            0x0010
 107 #define SONIC_CR_RXEN           0x0008
 108 #define SONIC_CR_RXDIS          0x0004
 109 #define SONIC_CR_TXP            0x0002
 110 #define SONIC_CR_HTX            0x0001
 111
 112 #define SONIC_CR_ALL (SONIC_CR_LCAM | SONIC_CR_RRRA | \
 113                       SONIC_CR_RXEN | SONIC_CR_TXP)
 114
 115 /*
 116  * SONIC data configuration bits
 117  */
 118
 119 #define SONIC_DCR_EXBUS         0x8000
 120 #define SONIC_DCR_LBR           0x2000
 121 #define SONIC_DCR_PO1           0x1000
 122 #define SONIC_DCR_PO0           0x0800
 123 #define SONIC_DCR_SBUS          0x0400
 124 #define SONIC_DCR_USR1          0x0200
 125 #define SONIC_DCR_USR0          0x0100
 126 #define SONIC_DCR_WC1           0x0080
 127 #define SONIC_DCR_WC0           0x0040
 128 #define SONIC_DCR_DW            0x0020
 129 #define SONIC_DCR_BMS           0x0010
 130 #define SONIC_DCR_RFT1          0x0008
 131 #define SONIC_DCR_RFT0          0x0004
 132 #define SONIC_DCR_TFT1          0x0002
 133 #define SONIC_DCR_TFT0          0x0001
 134
 135 /*
 136  * Constants for the SONIC receive control register.
 137  */
 138
 139 #define SONIC_RCR_ERR           0x8000
 140 #define SONIC_RCR_RNT           0x4000
 141 #define SONIC_RCR_BRD           0x2000
 142 #define SONIC_RCR_PRO           0x1000
 143 #define SONIC_RCR_AMC           0x0800
 144 #define SONIC_RCR_LB1           0x0400
 145 #define SONIC_RCR_LB0           0x0200
 146
 147 #define SONIC_RCR_MC            0x0100
 148 #define SONIC_RCR_BC            0x0080
 149 #define SONIC_RCR_LPKT          0x0040
 150 #define SONIC_RCR_CRS           0x0020
 151 #define SONIC_RCR_COL           0x0010
 152 #define SONIC_RCR_CRCR          0x0008
 153 #define SONIC_RCR_FAER          0x0004
 154 #define SONIC_RCR_LBK           0x0002
 155 #define SONIC_RCR_PRX           0x0001
 156
 157 #define SONIC_RCR_LB_OFF        0
 158 #define SONIC_RCR_LB_MAC        SONIC_RCR_LB0
 159 #define SONIC_RCR_LB_ENDEC      SONIC_RCR_LB1
 160 #define SONIC_RCR_LB_TRANS      (SONIC_RCR_LB0 | SONIC_RCR_LB1)
 161
 162 /* default RCR setup */
 163
 164 #define SONIC_RCR_DEFAULT       (SONIC_RCR_BRD)
 165
 166
 167 /*
 168  * SONIC Transmit Control register bits
 169  */
 170
 171 #define SONIC_TCR_PINTR         0x8000
 172 #define SONIC_TCR_POWC          0x4000
 173 #define SONIC_TCR_CRCI          0x2000
 174 #define SONIC_TCR_EXDIS         0x1000
 175 #define SONIC_TCR_EXD           0x0400
 176 #define SONIC_TCR_DEF           0x0200
 177 #define SONIC_TCR_NCRS          0x0100
 178 #define SONIC_TCR_CRLS          0x0080
 179 #define SONIC_TCR_EXC           0x0040
 180 #define SONIC_TCR_PMB           0x0008
 181 #define SONIC_TCR_FU            0x0004
 182 #define SONIC_TCR_BCM           0x0002
 183 #define SONIC_TCR_PTX           0x0001
 184
 185 #define SONIC_TCR_DEFAULT       0x0000
 186
 187 /*
 188  * Constants for the SONIC_INTERRUPT_MASK and
 189  * SONIC_INTERRUPT_STATUS registers.
 190  */
 191
 192 #define SONIC_INT_BR            0x4000
 193 #define SONIC_INT_HBL           0x2000
 194 #define SONIC_INT_LCD           0x1000
 195 #define SONIC_INT_PINT          0x0800
 196 #define SONIC_INT_PKTRX         0x0400
 197 #define SONIC_INT_TXDN          0x0200
 198 #define SONIC_INT_TXER          0x0100
 199 #define SONIC_INT_TC            0x0080
 200 #define SONIC_INT_RDE           0x0040
 201 #define SONIC_INT_RBE           0x0020
 202 #define SONIC_INT_RBAE          0x0010
 203 #define SONIC_INT_CRC           0x0008
 204 #define SONIC_INT_FAE           0x0004
 205 #define SONIC_INT_MP            0x0002
 206 #define SONIC_INT_RFO           0x0001
 207
 208
 209 /*
 210  * The interrupts we allow.
 211  */
 212
 213 #define SONIC_IMR_DEFAULT     ( SONIC_INT_BR | \
 214                                 SONIC_INT_LCD | \
 215                                 SONIC_INT_RFO | \
 216                                 SONIC_INT_PKTRX | \
 217                                 SONIC_INT_TXDN | \
 218                                 SONIC_INT_TXER | \
 219                                 SONIC_INT_RDE | \
 220                                 SONIC_INT_RBAE | \
 221                                 SONIC_INT_CRC | \
 222                                 SONIC_INT_FAE | \
 223                                 SONIC_INT_MP)
 224
 225
 226 #define SONIC_EOL       0x0001
 227 #define CAM_DESCRIPTORS 16
 228
 229 /* Offsets in the various DMA buffers accessed by the SONIC */
 230
 231 #define SONIC_BITMODE16 0
 232 #define SONIC_BITMODE32 1
 233 #define SONIC_BUS_SCALE(bitmode) ((bitmode) ? 4 : 2)
 234 /* Note!  These are all measured in bus-size units, so use SONIC_BUS_SCALE */
 235 #define SIZEOF_SONIC_RR 4
 236 #define SONIC_RR_BUFADR_L  0
 237 #define SONIC_RR_BUFADR_H  1
 238 #define SONIC_RR_BUFSIZE_L 2
 239 #define SONIC_RR_BUFSIZE_H 3
 240
 241 #define SIZEOF_SONIC_RD 7
 242 #define SONIC_RD_STATUS   0
 243 #define SONIC_RD_PKTLEN   1
 244 #define SONIC_RD_PKTPTR_L 2
 245 #define SONIC_RD_PKTPTR_H 3
 246 #define SONIC_RD_SEQNO    4
 247 #define SONIC_RD_LINK     5
 248 #define SONIC_RD_IN_USE   6
 249
 250 #define SIZEOF_SONIC_TD 8
 251 #define SONIC_TD_STATUS       0
 252 #define SONIC_TD_CONFIG       1
 253 #define SONIC_TD_PKTSIZE      2
 254 #define SONIC_TD_FRAG_COUNT   3
 255 #define SONIC_TD_FRAG_PTR_L   4
 256 #define SONIC_TD_FRAG_PTR_H   5
 257 #define SONIC_TD_FRAG_SIZE    6
 258 #define SONIC_TD_LINK         7
 259
 260 #define SIZEOF_SONIC_CD 4
 261 #define SONIC_CD_ENTRY_POINTER 0
 262 #define SONIC_CD_CAP0          1
 263 #define SONIC_CD_CAP1          2
 264 #define SONIC_CD_CAP2          3
 265
 266 #define SIZEOF_SONIC_CDA ((CAM_DESCRIPTORS * SIZEOF_SONIC_CD) + 1)
 267 #define SONIC_CDA_CAM_ENABLE   (CAM_DESCRIPTORS * SIZEOF_SONIC_CD)
 268
 269 /*
 270  * Some tunables for the buffer areas. Power of 2 is required
 271  * the current driver uses one receive buffer for each descriptor.
 272  *
 273  * MSch: use more buffer space for the slow m68k Macs!
 274  */
 275 #define SONIC_NUM_RRS   16            /* number of receive resources */
 276 #define SONIC_NUM_RDS   SONIC_NUM_RRS /* number of receive descriptors */
 277 #define SONIC_NUM_TDS   16            /* number of transmit descriptors */
 278
 279 #define SONIC_RRS_MASK  (SONIC_NUM_RRS - 1)
 280 #define SONIC_RDS_MASK  (SONIC_NUM_RDS - 1)
 281 #define SONIC_TDS_MASK  (SONIC_NUM_TDS - 1)
 282
 283 #define SONIC_RBSIZE    1520          /* size of one resource buffer */
 284
 285 /* Again, measured in bus size units! */
 286 #define SIZEOF_SONIC_DESC (SIZEOF_SONIC_CDA     \
 287         + (SIZEOF_SONIC_TD * SONIC_NUM_TDS)     \
 288         + (SIZEOF_SONIC_RD * SONIC_NUM_RDS)     \
 289         + (SIZEOF_SONIC_RR * SONIC_NUM_RRS))
 290
 291 /* Information that need to be kept for each board. */
 292 struct sonic_local {
 293         /* Bus size.  0 == 16 bits, 1 == 32 bits. */
 294         int dma_bitmode;
 295         /* Register offset within the longword (independent of endianness,
 296            and varies from one type of Macintosh SONIC to another
 297            (Aarrgh)) */
 298         int reg_offset;
 299         void *descriptors;
 300         /* Crud.  These areas have to be within the same 64K.  Therefore
 301        we allocate a desriptors page, and point these to places within it. */
 302         void *cda;  /* CAM descriptor area */
 303         void *tda;  /* Transmit descriptor area */
 304         void *rra;  /* Receive resource area */
 305         void *rda;  /* Receive descriptor area */
 306         struct sk_buff* volatile rx_skb[SONIC_NUM_RRS]; /* packets to be received */
 307         struct sk_buff* volatile tx_skb[SONIC_NUM_TDS]; /* packets to be transmitted */
 308         unsigned int tx_len[SONIC_NUM_TDS]; /* lengths of tx DMA mappings */
 309         /* Logical DMA addresses on MIPS, bus addresses on m68k
 310          * (so "laddr" is a bit misleading) */
 311         dma_addr_t descriptors_laddr;
 312         u32 cda_laddr;              /* logical DMA address of CDA */
 313         u32 tda_laddr;              /* logical DMA address of TDA */
 314         u32 rra_laddr;              /* logical DMA address of RRA */
 315         u32 rda_laddr;              /* logical DMA address of RDA */
 316         dma_addr_t rx_laddr[SONIC_NUM_RRS]; /* logical DMA addresses of rx skbuffs */
 317         dma_addr_t tx_laddr[SONIC_NUM_TDS]; /* logical DMA addresses of tx skbuffs */
 318         unsigned int rra_end;
 319         unsigned int cur_rwp;
 320         unsigned int cur_rx;
 321         unsigned int cur_tx;           /* first unacked transmit packet */
 322         unsigned int eol_rx;
 323         unsigned int eol_tx;           /* last unacked transmit packet */
 324         unsigned int next_tx;          /* next free TD */
 325         struct device *device;         /* generic device */
 326         struct net_device_stats stats;
 327         spinlock_t lock;
 328 };
 329
 330 #define TX_TIMEOUT (3 * HZ)
 331
 332 /* Index to functions, as function prototypes. */
 333
 334 static int sonic_open(struct net_device *dev);
 335 static int sonic_send_packet(struct sk_buff *skb, struct net_device *dev);
 336 static irqreturn_t sonic_interrupt(int irq, void *dev_id);
 337 static void sonic_rx(struct net_device *dev);
 338 static int sonic_close(struct net_device *dev);
 339 static struct net_device_stats *sonic_get_stats(struct net_device *dev);
 340 static void sonic_multicast_list(struct net_device *dev);
 341 static int sonic_init(struct net_device *dev);
 342 static void sonic_tx_timeout(struct net_device *dev);
 343
 344 /* Internal inlines for reading/writing DMA buffers.  Note that bus
 345    size and endianness matter here, whereas they don't for registers,
 346    as far as we can tell. */
 347 /* OpenBSD calls this "SWO".  I'd like to think that sonic_buf_put()
 348    is a much better name. */
 349 static inline void sonic_buf_put(u16 *base, int bitmode,
 350                                  int offset, __u16 val)
 351 {
 352         if (bitmode)
 353 #ifdef __BIG_ENDIAN
 354                 __raw_writew(val, base + (offset * 2) + 1);
 355 #else
 356                 __raw_writew(val, base + (offset * 2) + 0);
 357 #endif
 358         else
 359                 __raw_writew(val, base + (offset * 1) + 0);
 360 }
 361
 362 static inline __u16 sonic_buf_get(u16 *base, int bitmode,
 363                                   int offset)
 364 {
 365         if (bitmode)
 366 #ifdef __BIG_ENDIAN
 367                 return __raw_readw(base + (offset * 2) + 1);
 368 #else
 369                 return __raw_readw(base + (offset * 2) + 0);
 370 #endif
 371         else
 372                 return __raw_readw(base + (offset * 1) + 0);
 373 }
 374
 375 /* Inlines that you should actually use for reading/writing DMA buffers */
 376 static inline void sonic_cda_put(struct net_device* dev, int entry,
 377                                  int offset, __u16 val)
 378 {
 379         struct sonic_local *lp = netdev_priv(dev);
 380         sonic_buf_put(lp->cda, lp->dma_bitmode,
 381                       (entry * SIZEOF_SONIC_CD) + offset, val);
 382 }
 383
 384 static inline __u16 sonic_cda_get(struct net_device* dev, int entry,
 385                                   int offset)
 386 {
 387         struct sonic_local *lp = netdev_priv(dev);
 388         return sonic_buf_get(lp->cda, lp->dma_bitmode,
 389                              (entry * SIZEOF_SONIC_CD) + offset);
 390 }
 391
 392 static inline void sonic_set_cam_enable(struct net_device* dev, __u16 val)
 393 {
 394         struct sonic_local *lp = netdev_priv(dev);
 395         sonic_buf_put(lp->cda, lp->dma_bitmode, SONIC_CDA_CAM_ENABLE, val);
 396 }
 397
 398 static inline __u16 sonic_get_cam_enable(struct net_device* dev)
 399 {
 400         struct sonic_local *lp = netdev_priv(dev);
 401         return sonic_buf_get(lp->cda, lp->dma_bitmode, SONIC_CDA_CAM_ENABLE);
 402 }
 403
 404 static inline void sonic_tda_put(struct net_device* dev, int entry,
 405                                  int offset, __u16 val)
 406 {
 407         struct sonic_local *lp = netdev_priv(dev);
 408         sonic_buf_put(lp->tda, lp->dma_bitmode,
 409                       (entry * SIZEOF_SONIC_TD) + offset, val);
 410 }
 411
 412 static inline __u16 sonic_tda_get(struct net_device* dev, int entry,
 413                                   int offset)
 414 {
 415         struct sonic_local *lp = netdev_priv(dev);
 416         return sonic_buf_get(lp->tda, lp->dma_bitmode,
 417                              (entry * SIZEOF_SONIC_TD) + offset);
 418 }
 419
 420 static inline void sonic_rda_put(struct net_device* dev, int entry,
 421                                  int offset, __u16 val)
 422 {
 423         struct sonic_local *lp = netdev_priv(dev);
 424         sonic_buf_put(lp->rda, lp->dma_bitmode,
 425                       (entry * SIZEOF_SONIC_RD) + offset, val);
 426 }
 427
 428 static inline __u16 sonic_rda_get(struct net_device* dev, int entry,
 429                                   int offset)
 430 {
 431         struct sonic_local *lp = netdev_priv(dev);
 432         return sonic_buf_get(lp->rda, lp->dma_bitmode,
 433                              (entry * SIZEOF_SONIC_RD) + offset);
 434 }
 435
 436 static inline void sonic_rra_put(struct net_device* dev, int entry,
 437                                  int offset, __u16 val)
 438 {
 439         struct sonic_local *lp = netdev_priv(dev);
 440         sonic_buf_put(lp->rra, lp->dma_bitmode,
 441                       (entry * SIZEOF_SONIC_RR) + offset, val);
 442 }
 443
 444 static inline __u16 sonic_rra_get(struct net_device* dev, int entry,
 445                                   int offset)
 446 {
 447         struct sonic_local *lp = netdev_priv(dev);
 448         return sonic_buf_get(lp->rra, lp->dma_bitmode,
 449                              (entry * SIZEOF_SONIC_RR) + offset);
 450 }
 451
 452 static const char *version =
 453     "sonic.c:v0.92 20.9.98 tsbogend@alpha.franken.de\n";
 454
 455 #endif /* SONIC_H */