drivers/net/meth.h

   1
   2 /*
   3  * snull.h -- definitions for the network module
   4  *
   5  * Copyright (C) 2001 Alessandro Rubini and Jonathan Corbet
   6  * Copyright (C) 2001 O'Reilly & Associates
   7  *
   8  * The source code in this file can be freely used, adapted,
   9  * and redistributed in source or binary form, so long as an
  10  * acknowledgment appears in derived source files.  The citation
  11  * should list that the code comes from the book "Linux Device
  12  * Drivers" by Alessandro Rubini and Jonathan Corbet, published
  13  * by O'Reilly & Associates.   No warranty is attached;
  14  * we cannot take responsibility for errors or fitness for use.
  15  */
  16
  17 /* version dependencies have been confined to a separate file */
  18
  19 #define SGI_MFE         (MACE_BASE+MACE_ENET)
  20 /*              (0xBF280000)*/
  21
  22 /* Tunable parameters */
  23 #define TX_RING_ENTRIES 64      /* 64-512?*/
  24
  25 #define RX_RING_ENTRIES 16 /* Do not change */
  26 /* Internal constants */
  27 #define TX_RING_BUFFER_SIZE     (TX_RING_ENTRIES*sizeof(tx_packet))
  28 #define RX_BUFFER_SIZE 1546 /* ethenet packet size */
  29 #define METH_RX_BUFF_SIZE 4096
  30 #define RX_BUFFER_OFFSET (sizeof(rx_status_vector)+2) /* staus vector + 2 bytes of padding */
  31 #define RX_BUCKET_SIZE 256
  32
  33
  34
  35 /* For more detailed explanations of what each field menas,
  36    see Nick's great comments to #defines below (or docs, if
  37    you are lucky enough toget hold of them :)*/
  38
  39 /* tx status vector is written over tx command header upon
  40    dma completion. */
  41
  42 typedef struct tx_status_vector {
  43         u64             sent:1; /* always set to 1...*/
  44         u64             pad0:34;/* always set to 0 */
  45         u64             flags:9;                        /*I'm too lazy to specify each one separately at the moment*/
  46         u64             col_retry_cnt:4;        /*collision retry count*/
  47         u64             len:16;                         /*Transmit length in bytes*/
  48 } tx_status_vector;
  49
  50 /*
  51  * Each packet is 128 bytes long.
  52  * It consists of header, 0-3 concatination
  53  * buffer pointers and up to 120 data bytes.
  54  */
  55 typedef struct tx_packet_hdr {
  56         u64             pad1:36; /*should be filled with 0 */
  57         u64             cat_ptr3_valid:1,       /*Concatination pointer valid flags*/
  58                         cat_ptr2_valid:1,
  59                         cat_ptr1_valid:1;
  60         u64             tx_int_flag:1;          /*Generate TX intrrupt when packet has been sent*/
  61         u64             term_dma_flag:1;        /*Terminate transmit DMA on transmit abort conditions*/
  62         u64             data_offset:7;          /*Starting byte offset in ring data block*/
  63         u64             data_len:16;            /*Length of valid data in bytes-1*/
  64 } tx_packet_hdr;
  65 typedef union tx_cat_ptr {
  66         struct {
  67                 u64             pad2:16; /* should be 0 */
  68                 u64             len:16;                         /*length of buffer data - 1*/
  69                 u64             start_addr:29;          /*Physical starting address*/
  70                 u64             pad1:3; /* should be zero */
  71         } form;
  72         u64 raw;
  73 } tx_cat_ptr;
  74
  75 typedef struct tx_packet {
  76         union {
  77                 tx_packet_hdr header;
  78                 tx_status_vector res;
  79                 u64 raw;
  80         }header;
  81         union {
  82                 tx_cat_ptr cat_buf[3];
  83                 char dt[120];
  84         } data;
  85 } tx_packet;
  86
  87 typedef union rx_status_vector {
  88         struct {
  89                 u64             pad1:1;/*fill it with ones*/
  90                 u64             pad2:15;/*fill with 0*/
  91                 u64             ip_chk_sum:16;
  92                 u64             seq_num:5;
  93                 u64             mac_addr_match:1;
  94                 u64             mcast_addr_match:1;
  95                 u64             carrier_event_seen:1;
  96                 u64             bad_packet:1;
  97                 u64             long_event_seen:1;
  98                 u64             invalid_preamble:1;
  99                 u64             broadcast:1;
 100                 u64             multicast:1;
 101                 u64             crc_error:1;
 102                 u64             huh:1;/*???*/
 103                 u64             rx_code_violation:1;
 104                 u64             rx_len:16;
 105         } parsed;
 106         u64 raw;
 107 } rx_status_vector;
 108
 109 typedef struct rx_packet {
 110         rx_status_vector status;
 111         u64 pad[3]; /* For whatever reason, there needs to be 4 double-word offset */
 112         u16 pad2;
 113         char buf[METH_RX_BUFF_SIZE-sizeof(rx_status_vector)-3*sizeof(u64)-sizeof(u16)];/* data */
 114 } rx_packet;
 115
 116 typedef struct meth_regs {
 117         u64             mac_ctrl;               /*0x00,rw,31:0*/
 118         u64             int_flags;              /*0x08,rw,30:0*/
 119         u64             dma_ctrl;               /*0x10,rw,15:0*/
 120         u64             timer;                  /*0x18,rw,5:0*/
 121         u64             int_tx;                 /*0x20,wo,0:0*/
 122         u64             int_rx;                 /*0x28,wo,9:4*/
 123         struct {
 124                 u32 tx_info_pad;
 125                 u32 rptr:16,wptr:16;
 126         }               tx_info;                /*0x30,rw,31:0*/
 127         u64             tx_info_al;             /*0x38,rw,31:0*/
 128         struct {
 129                 u32     rx_buff_pad1;
 130                 u32     rx_buff_pad2:8,
 131                         wptr:8,
 132                         rptr:8,
 133                         depth:8;
 134         }               rx_buff;                /*0x40,ro,23:0*/
 135         u64             rx_buff_al1;    /*0x48,ro,23:0*/
 136         u64             rx_buff_al2;    /*0x50,ro,23:0*/
 137         u64             int_update;             /*0x58,wo,31:0*/
 138         u32             phy_data_pad;
 139         u32             phy_data;               /*0x60,rw,16:0*/
 140         u32             phy_reg_pad;
 141         u32             phy_registers;  /*0x68,rw,9:0*/
 142         u64             phy_trans_go;   /*0x70,wo,0:0*/
 143         u64             backoff_seed;   /*0x78,wo,10:0*/
 144         u64             imq_reserved[4];/*0x80,ro,64:0(x4)*/
 145         /*===================================*/
 146         u64             mac_addr;               /*0xA0,rw,47:0, I think it's MAC address, but I'm not sure*/
 147         u64             mcast_addr;             /*0xA8,rw,47:0, This seems like secondary MAC address*/
 148         u64             mcast_filter;   /*0xB0,rw,63:0*/
 149         u64             tx_ring_base;   /*0xB8,rw,31:13*/
 150         /* Following are read-only debugging info register */
 151         u64             tx_pkt1_hdr;    /*0xC0,ro,63:0*/
 152         u64             tx_pkt1_ptr[3]; /*0xC8,ro,63:0(x3)*/
 153         u64             tx_pkt2_hdr;    /*0xE0,ro,63:0*/
 154         u64             tx_pkt2_ptr[3]; /*0xE8,ro,63:0(x3)*/
 155         /*===================================*/
 156         u32             rx_pad;
 157         u32             rx_fifo;
 158         u64             reserved[31];
 159 }meth_regs;
 160
 161         /* Bits in METH_MAC */
 162
 163 #define SGI_MAC_RESET           BIT(0)  /* 0: MAC110 active in run mode, 1: Global reset signal to MAC110 core is active */
 164 #define METH_PHY_FDX            BIT(1) /* 0: Disable full duplex, 1: Enable full duplex */
 165 #define METH_PHY_LOOP   BIT(2) /* 0: Normal operation, follows 10/100mbit and M10T/MII select, 1: loops internal MII bus */
 166                                        /*    selects ignored */
 167 #define METH_100MBIT            BIT(3) /* 0: 10meg mode, 1: 100meg mode */
 168 #define METH_PHY_MII            BIT(4) /* 0: MII selected, 1: SIA selected */
 169                                        /*   Note: when loopback is set this bit becomes collision control.  Setting this bit will */
 170                                        /*         cause a collision to be reported. */
 171
 172                                        /* Bits 5 and 6 are used to determine the the Destination address filter mode */
 173 #define METH_ACCEPT_MY 0                        /* 00: Accept PHY address only */
 174 #define METH_ACCEPT_MCAST 0x20  /* 01: Accept physical, broadcast, and multicast filter matches only */
 175 #define METH_ACCEPT_AMCAST 0x40 /* 10: Accept physical, broadcast, and all multicast packets */
 176 #define METH_PROMISC 0x60               /* 11: Promiscious mode */
 177
 178 #define METH_PHY_LINK_FAIL      BIT(7) /* 0: Link failure detection disabled, 1: Hardware scans for link failure in PHY */
 179
 180 #define METH_MAC_IPG    0x1ffff00
 181
 182 #define METH_DEFAULT_IPG ((17<<15) | (11<<22) | (21<<8))
 183                                                 /* 0x172e5c00 */ /* 23, 23, 23 */ /*0x54A9500 *//*21,21,21*/
 184                                        /* Bits 8 through 14 are used to determine Inter-Packet Gap between "Back to Back" packets */
 185                                        /* The gap depends on the clock speed of the link, 80ns per increment for 100baseT, 800ns  */
 186                                        /* per increment for 10BaseT */
 187
 188                                        /* Bits 15 through 21 are used to determine IPGR1 */
 189
 190                                        /* Bits 22 through 28 are used to determine IPGR2 */
 191
 192 #define METH_REV_SHIFT 29       /* Bits 29 through 31 are used to determine the revision */
 193                                        /* 000: Inital revision */
 194                                        /* 001: First revision, Improved TX concatenation */
 195
 196
 197 /* DMA control bits */
 198 #define METH_RX_OFFSET_SHIFT 12 /* Bits 12:14 of DMA control register indicate starting offset of packet data for RX operation */
 199 #define METH_RX_DEPTH_SHIFT 4 /* Bits 8:4 define RX fifo depth -- when # of RX fifo entries != depth, interrupt is generted */
 200
 201 #define METH_DMA_TX_EN BIT(1) /* enable TX DMA */
 202 #define METH_DMA_TX_INT_EN BIT(0) /* enable TX Buffer Empty interrupt */
 203 #define METH_DMA_RX_EN BIT(15) /* Enable RX */
 204 #define METH_DMA_RX_INT_EN BIT(9) /* Enable interrupt on RX packet */
 205
 206
 207 /* RX status bits */
 208
 209 #define METH_RX_ST_RCV_CODE_VIOLATION BIT(16)
 210 #define METH_RX_ST_DRBL_NBL BIT(17)
 211 #define METH_RX_ST_CRC_ERR BIT(18)
 212 #define METH_RX_ST_MCAST_PKT BIT(19)
 213 #define METH_RX_ST_BCAST_PKT BIT(20)
 214 #define METH_RX_ST_INV_PREAMBLE_CTX BIT(21)
 215 #define METH_RX_ST_LONG_EVT_SEEN BIT(22)
 216 #define METH_RX_ST_BAD_PACKET BIT(23)
 217 #define METH_RX_ST_CARRIER_EVT_SEEN BIT(24)
 218 #define METH_RX_ST_MCAST_FILTER_MATCH BIT(25)
 219 #define METH_RX_ST_PHYS_ADDR_MATCH BIT(26)
 220
 221 #define METH_RX_STATUS_ERRORS \
 222         ( \
 223         METH_RX_ST_RCV_CODE_VIOLATION| \
 224         METH_RX_ST_CRC_ERR| \
 225         METH_RX_ST_INV_PREAMBLE_CTX| \
 226         METH_RX_ST_LONG_EVT_SEEN| \
 227         METH_RX_ST_BAD_PACKET| \
 228         METH_RX_ST_CARRIER_EVT_SEEN \
 229         )
 230         /* Bits in METH_INT */
 231         /* Write _1_ to corresponding bit to clear */
 232 #define METH_INT_TX_EMPTY       BIT(0)  /* 0: No interrupt pending, 1: The TX ring buffer is empty */
 233 #define METH_INT_TX_PKT         BIT(1)  /* 0: No interrupt pending */
 234                                                 /* 1: A TX message had the INT request bit set, the packet has been sent. */
 235 #define METH_INT_TX_LINK_FAIL   BIT(2)  /* 0: No interrupt pending, 1: PHY has reported a link failure */
 236 #define METH_INT_MEM_ERROR      BIT(3)  /* 0: No interrupt pending */
 237                                                 /* 1: A memory error occurred durring DMA, DMA stopped, Fatal */
 238 #define METH_INT_TX_ABORT               BIT(4)  /* 0: No interrupt pending, 1: The TX aborted operation, DMA stopped, FATAL */
 239 #define METH_INT_RX_THRESHOLD   BIT(5)  /* 0: No interrupt pending, 1: Selected receive threshold condition Valid */
 240 #define METH_INT_RX_UNDERFLOW   BIT(6)  /* 0: No interrupt pending, 1: FIFO was empty, packet could not be queued */
 241 #define METH_INT_RX_OVERFLOW            BIT(7)  /* 0: No interrupt pending, 1: DMA FIFO Overflow, DMA stopped, FATAL */
 242
 243 #define METH_INT_RX_RPTR_MASK 0x0001F00         /* Bits 8 through 12 alias of RX read-pointer */
 244
 245                                                 /* Bits 13 through 15 are always 0. */
 246
 247 #define METH_INT_TX_RPTR_MASK 0x1FF0000         /* Bits 16 through 24 alias of TX read-pointer */
 248
 249 #define METH_INT_SEQ_MASK    0x2E000000         /* Bits 25 through 29 are the starting seq number for the message at the */
 250                                                 /* top of the queue */
 251
 252 #define METH_ERRORS ( \
 253         METH_INT_RX_OVERFLOW|   \
 254         METH_INT_RX_UNDERFLOW|  \
 255         METH_INT_MEM_ERROR|                     \
 256         METH_INT_TX_ABORT)
 257
 258 #define METH_INT_MCAST_HASH             BIT(30) /* If RX DMA is enabled the hash select logic output is latched here */
 259
 260 /* TX status bits */
 261 #define METH_TX_STATUS_DONE BIT(23) /* Packet was transmitted successfully */
 262
 263 /* Tx command header bits */
 264 #define METH_TX_CMD_INT_EN BIT(24) /* Generate TX interrupt when packet is sent */
 265
 266 /* Phy MDIO interface busy flag */
 267 #define MDIO_BUSY    BIT(16)
 268 #define MDIO_DATA_MASK 0xFFFF
 269 /* PHY defines */
 270 #define PHY_QS6612X    0x0181441    /* Quality TX */
 271 #define PHY_ICS1889    0x0015F41    /* ICS FX */
 272 #define PHY_ICS1890    0x0015F42    /* ICS TX */
 273 #define PHY_DP83840    0x20005C0    /* National TX */