7990.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:10k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /* 
  2.  * 7990.h -- LANCE ethernet IC generic routines.
  3.  * This is an attempt to separate out the bits of various ethernet
  4.  * drivers that are common because they all use the AMD 7990 LANCE
  5.  * (Local Area Network Controller for Ethernet) chip.
  6.  * 
  7.  * Copyright (C) 05/1998 Peter Maydell <pmaydell@chiark.greenend.org.uk>
  8.  *
  9.  * Most of this stuff was obtained by looking at other LANCE drivers,
  10.  * in particular a2065.[ch]. The AMD C-LANCE datasheet was also helpful.
  11.  */
  12. #ifndef _7990_H
  13. #define _7990_H
  14. /* The lance only has two register locations. We communicate mostly via memory. */
  15. struct lance_regs 
  16. {
  17.         unsigned short rdp;                       /* Register Data Port */
  18.         unsigned short rap;                       /* Register Address Port */
  19. };
  20. /* Transmit/receive ring definitions.
  21.  * We allow the specific drivers to override these defaults if they want to.
  22.  * NB: according to lance.c, increasing the number of buffers is a waste
  23.  * of space and reduces the chance that an upper layer will be able to
  24.  * reorder queued Tx packets based on priority. [Clearly there is a minimum
  25.  * limit too: too small and we drop rx packets and can't tx at full speed.]
  26.  * 4+4 seems to be the usual setting; the atarilance driver uses 3 and 5.
  27.  */
  28. /* Blast! This won't work. The problem is that we can't specify a default
  29.  * setting because that would cause the lance_init_block struct to be
  30.  * too long (and overflow the RAM on shared-memory cards like the HP LANCE.
  31.  */
  32. #ifndef LANCE_LOG_TX_BUFFERS
  33. #define LANCE_LOG_TX_BUFFERS 1
  34. #define LANCE_LOG_RX_BUFFERS 3
  35. #endif
  36. #define TX_RING_SIZE (1<<LANCE_LOG_TX_BUFFERS)
  37. #define RX_RING_SIZE (1<<LANCE_LOG_RX_BUFFERS)
  38. #define TX_RING_MOD_MASK (TX_RING_SIZE - 1)
  39. #define RX_RING_MOD_MASK (RX_RING_SIZE - 1)
  40. #define TX_RING_LEN_BITS ((LANCE_LOG_TX_BUFFERS) << 29)
  41. #define RX_RING_LEN_BITS ((LANCE_LOG_RX_BUFFERS) << 29)
  42. #define PKT_BUFF_SIZE (1544)
  43. #define RX_BUFF_SIZE PKT_BUFF_SIZE
  44. #define TX_BUFF_SIZE PKT_BUFF_SIZE
  45. /* Each receive buffer is described by a receive message descriptor (RMD) */
  46. struct lance_rx_desc {
  47. volatile unsigned short rmd0;        /* low address of packet */
  48. volatile unsigned char  rmd1_bits;   /* descriptor bits */
  49. volatile unsigned char  rmd1_hadr;   /* high address of packet */
  50. volatile short    length;         /* This length is 2s complement (negative)!
  51.      * Buffer length
  52.      */
  53. volatile unsigned short mblength;    /* Actual number of bytes received */
  54. };
  55.  
  56. /* Ditto for TMD: */
  57. struct lance_tx_desc {
  58. volatile unsigned short tmd0;        /* low address of packet */
  59. volatile unsigned char  tmd1_bits;   /* descriptor bits */
  60. volatile unsigned char  tmd1_hadr;   /* high address of packet */
  61. volatile short    length;            /* Length is 2s complement (negative)! */
  62. volatile unsigned short misc;
  63. };
  64. /* There are three memory structures accessed by the LANCE:
  65.  * the initialization block, the receive and transmit descriptor rings,
  66.  * and the data buffers themselves. In fact we might as well put the
  67.  * init block,the Tx and Rx rings and the buffers together in memory:
  68.  */
  69. struct lance_init_block {
  70.         volatile unsigned short mode;            /* Pre-set mode (reg. 15) */
  71.         volatile unsigned char phys_addr[6];     /* Physical ethernet address */
  72.         volatile unsigned filter[2];             /* Multicast filter (64 bits) */
  73.         /* Receive and transmit ring base, along with extra bits. */
  74.         volatile unsigned short rx_ptr;          /* receive descriptor addr */
  75.         volatile unsigned short rx_len;          /* receive len and high addr */
  76.         volatile unsigned short tx_ptr;          /* transmit descriptor addr */
  77.         volatile unsigned short tx_len;          /* transmit len and high addr */
  78.     
  79.         /* The Tx and Rx ring entries must be aligned on 8-byte boundaries. 
  80.          * This will be true if this whole struct is 8-byte aligned.
  81.          */
  82.         volatile struct lance_tx_desc btx_ring[TX_RING_SIZE];
  83.         volatile struct lance_rx_desc brx_ring[RX_RING_SIZE];
  84.         volatile char   tx_buf [TX_RING_SIZE][TX_BUFF_SIZE];
  85.         volatile char   rx_buf [RX_RING_SIZE][RX_BUFF_SIZE];
  86.         /* we use this just to make the struct big enough that we can move its startaddr
  87.          * in order to force alignment to an eight byte boundary.
  88.          */
  89. };
  90. /* This is where we keep all the stuff the driver needs to know about.
  91.  * I'm definitely unhappy about the mechanism for allowing specific
  92.  * drivers to add things...
  93.  */
  94. struct lance_private
  95. {
  96.         char *name;
  97.         volatile struct lance_regs *ll;
  98.         volatile struct lance_init_block *init_block; /* CPU address of RAM */
  99.         volatile struct lance_init_block *lance_init_block; /* LANCE address of RAM */
  100.         
  101.         int rx_new, tx_new;
  102.         int rx_old, tx_old;
  103.         
  104.         int lance_log_rx_bufs, lance_log_tx_bufs;
  105.         int rx_ring_mod_mask, tx_ring_mod_mask;
  106.         
  107.         struct net_device_stats stats;
  108.         int tpe;                                  /* TPE is selected */
  109.         int auto_select;                          /* cable-selection is by carrier */
  110.         unsigned short busmaster_regval;
  111.         unsigned int irq;                         /* IRQ to register */
  112.         
  113.         /* This is because the HP LANCE is disgusting and you have to check 
  114.          * a DIO-specific register every time you read/write the LANCE regs :-<
  115.          * [could we get away with making these some sort of macro?]
  116.          */
  117.         void (*writerap)(void *, unsigned short);
  118.         void (*writerdp)(void *, unsigned short);
  119.         unsigned short (*readrdp)(void *);
  120. spinlock_t devlock;
  121. char tx_full;
  122. };
  123. #define CRC_POLYNOMIAL_BE 0x04c11db7UL  /* Ethernet CRC, big endian */
  124. #define CRC_POLYNOMIAL_LE 0xedb88320UL  /* Ethernet CRC, little endian */
  125. /*
  126.  *              Am7990 Control and Status Registers
  127.  */
  128. #define LE_CSR0         0x0000          /* LANCE Controller Status */
  129. #define LE_CSR1         0x0001          /* IADR[15:0] (bit0==0 ie word aligned) */
  130. #define LE_CSR2         0x0002          /* IADR[23:16] (high bits reserved) */
  131. #define LE_CSR3         0x0003          /* Misc */
  132. /*
  133.  * Bit definitions for CSR0 (LANCE Controller Status)
  134.  */
  135. #define LE_C0_ERR 0x8000 /* Error = BABL | CERR | MISS | MERR */
  136. #define LE_C0_BABL 0x4000 /* Babble: Transmitted too many bits */
  137. #define LE_C0_CERR 0x2000 /* No Heartbeat (10BASE-T) */
  138. #define LE_C0_MISS 0x1000 /* Missed Frame (no rx buffer to put it in) */
  139. #define LE_C0_MERR 0x0800 /* Memory Error */
  140. #define LE_C0_RINT 0x0400 /* Receive Interrupt */
  141. #define LE_C0_TINT 0x0200 /* Transmit Interrupt */
  142. #define LE_C0_IDON 0x0100 /* Initialization Done */
  143. #define LE_C0_INTR 0x0080 /* Interrupt Flag 
  144.                                          = BABL | MISS | MERR | RINT | TINT | IDON */
  145. #define LE_C0_INEA 0x0040 /* Interrupt Enable */
  146. #define LE_C0_RXON 0x0020 /* Receive On */
  147. #define LE_C0_TXON 0x0010 /* Transmit On */
  148. #define LE_C0_TDMD 0x0008 /* Transmit Demand */
  149. #define LE_C0_STOP 0x0004 /* Stop */
  150. #define LE_C0_STRT 0x0002 /* Start */
  151. #define LE_C0_INIT 0x0001 /* Initialize */
  152. /*
  153.  * Bit definitions for CSR3
  154.  */
  155. #define LE_C3_BSWP 0x0004 /* Byte Swap
  156.    (on for big endian byte order) */
  157. #define LE_C3_ACON 0x0002 /* ALE Control
  158.    (on for active low ALE) */
  159. #define LE_C3_BCON 0x0001 /* Byte Control */
  160. /*
  161.  * Mode Flags
  162.  */
  163. #define LE_MO_PROM 0x8000 /* Promiscuous Mode */
  164. /* these next ones 0x4000 -- 0x0080 are not available on the LANCE 7990,
  165.  * but they are in NetBSD's am7990.h, presumably for backwards-compatible chips
  166.  */
  167. #define LE_MO_DRCVBC  0x4000          /* disable receive broadcast */
  168. #define LE_MO_DRCVPA  0x2000          /* disable physical address detection */
  169. #define LE_MO_DLNKTST 0x1000          /* disable link status */
  170. #define LE_MO_DAPC    0x0800          /* disable automatic polarity correction */
  171. #define LE_MO_MENDECL 0x0400          /* MENDEC loopback mode */
  172. #define LE_MO_LRTTSEL 0x0200          /* lower RX threshold / TX mode selection */
  173. #define LE_MO_PSEL1   0x0100          /* port selection bit1 */
  174. #define LE_MO_PSEL0   0x0080          /* port selection bit0 */
  175. /* and this one is from the C-LANCE data sheet... */
  176. #define LE_MO_EMBA      0x0080          /* Enable Modified Backoff Algorithm 
  177.                                            (C-LANCE, not original LANCE) */
  178. #define LE_MO_INTL 0x0040 /* Internal Loopback */
  179. #define LE_MO_DRTY 0x0020 /* Disable Retry */
  180. #define LE_MO_FCOLL 0x0010 /* Force Collision */
  181. #define LE_MO_DXMTFCS 0x0008 /* Disable Transmit CRC */
  182. #define LE_MO_LOOP 0x0004 /* Loopback Enable */
  183. #define LE_MO_DTX 0x0002 /* Disable Transmitter */
  184. #define LE_MO_DRX 0x0001 /* Disable Receiver */
  185. /*
  186.  * Receive Flags
  187.  */
  188. #define LE_R1_OWN 0x80 /* LANCE owns the descriptor */
  189. #define LE_R1_ERR 0x40 /* Error */
  190. #define LE_R1_FRA 0x20 /* Framing Error */
  191. #define LE_R1_OFL 0x10 /* Overflow Error */
  192. #define LE_R1_CRC 0x08 /* CRC Error */
  193. #define LE_R1_BUF 0x04 /* Buffer Error */
  194. #define LE_R1_SOP 0x02 /* Start of Packet */
  195. #define LE_R1_EOP 0x01 /* End of Packet */
  196. #define LE_R1_POK       0x03 /* Packet is complete: SOP + EOP */
  197. /*
  198.  * Transmit Flags
  199.  */
  200. #define LE_T1_OWN 0x80 /* LANCE owns the descriptor */
  201. #define LE_T1_ERR 0x40 /* Error */
  202. #define LE_T1_RES 0x20 /* Reserved, LANCE writes this with a zero */
  203. #define LE_T1_EMORE 0x10 /* More than one retry needed */
  204. #define LE_T1_EONE 0x08 /* One retry needed */
  205. #define LE_T1_EDEF 0x04 /* Deferred */
  206. #define LE_T1_SOP 0x02 /* Start of Packet */
  207. #define LE_T1_EOP 0x01 /* End of Packet */
  208. #define LE_T1_POK 0x03 /* Packet is complete: SOP + EOP */
  209. /*
  210.  * Error Flags
  211.  */
  212. #define LE_T3_BUF  0x8000 /* Buffer Error */
  213. #define LE_T3_UFL  0x4000 /* Underflow Error */
  214. #define LE_T3_LCOL  0x1000 /* Late Collision */
  215. #define LE_T3_CLOS  0x0800 /* Loss of Carrier */
  216. #define LE_T3_RTY  0x0400 /* Retry Error */
  217. #define LE_T3_TDR 0x03ff /* Time Domain Reflectometry */
  218. /* Miscellaneous useful macros */
  219. #define TX_BUFFS_AVAIL ((lp->tx_old<=lp->tx_new)?
  220.                         lp->tx_old+lp->tx_ring_mod_mask-lp->tx_new:
  221.                         lp->tx_old - lp->tx_new-1)
  222. /* The LANCE only uses 24 bit addresses. This does the obvious thing. */
  223. #define LANCE_ADDR(x) ((int)(x) & ~0xff000000)
  224. /* Now the prototypes we export */
  225. extern int lance_open(struct net_device *dev);
  226. extern int lance_close (struct net_device *dev);
  227. extern int lance_start_xmit (struct sk_buff *skb, struct net_device *dev);
  228. extern struct net_device_stats *lance_get_stats (struct net_device *dev);
  229. extern void lance_set_multicast (struct net_device *dev);
  230. extern void lance_tx_timeout(struct net_device *dev);
  231. #endif /* ndef _7990_H */