drivers/e1000/e1000.h

   1 /**
   2  * @file e1000.h
   3  *
   4  * @brief Device driver implementation declarations for the
   5  *        Intel Pro/1000 Gigabit Ethernet card(s).
   6  *
   7  * Parts of this code is based on the DragonflyBSD (FreeBSD)
   8  * implementation, and the fxp driver for Minix 3.
   9  *
  10  * @see http://svn.freebsd.org/viewvc/base/head/sys/dev/e1000/
  11  * @see fxp.c
  12  *
  13  * @author Niek Linnenbank <nieklinnenbank@gmail.com>
  14  * @date September 2009
  15  *
  16  */
  17
  18 #ifndef __E1000_H
  19 #define __E1000_H
  20
  21 #include <minix/drivers.h>
  22 #include <stdlib.h>
  23 #include <net/hton.h>
  24 #include <net/gen/ether.h>
  25 #include <net/gen/eth_io.h>
  26 #include <machine/pci.h>
  27 #include <minix/ds.h>
  28 #include "e1000_hw.h"
  29
  30 /**
  31  * @name Constants.
  32  * @{
  33  */
  34
  35 /** Number of receive descriptors per card. */
  36 #define E1000_RXDESC_NR 256
  37
  38 /** Number of transmit descriptors per card. */
  39 #define E1000_TXDESC_NR 256
  40
  41 /** Number of I/O vectors to use. */
  42 #define E1000_IOVEC_NR 16
  43
  44 /** Size of each I/O buffer per descriptor. */
  45 #define E1000_IOBUF_SIZE 2048
  46
  47 /** Debug verbosity. */
  48 #define E1000_VERBOSE 1
  49
  50 /** MAC address override variable. */
  51 #define E1000_ENVVAR "E1000ETH"
  52
  53 /**
  54  * @}
  55  */
  56
  57 /**
  58  * @name Status Flags.
  59  * @{
  60  */
  61
  62 /** Card has been detected on the PCI bus. */
  63 #define E1000_DETECTED (1 << 0)
  64
  65 /** Card is enabled. */
  66 #define E1000_ENABLED  (1 << 1)
  67
  68 /** Client has requested to receive packets. */
  69 #define E1000_READING  (1 << 2)
  70
  71 /** Client has requested to write packets. */
  72 #define E1000_WRITING  (1 << 3)
  73
  74 /** Received some packets on the card. */
  75 #define E1000_RECEIVED (1 << 4)
  76
  77 /** Transmitted some packets on the card. */
  78 #define E1000_TRANSMIT (1 << 5)
  79
  80 /**
  81  * @}
  82  */
  83
  84 /**
  85  * @name Macros.
  86  * @{
  87  */
  88
  89 /**
  90  * @brief Print a debug message.
  91  * @param level Debug verbosity level.
  92  * @param args Arguments to printf().
  93  */
  94 #define E1000_DEBUG(level, args) \
  95         if ((level) <= E1000_VERBOSE) \
  96         { \
  97             printf args; \
  98         } \
  99
 100 /**
 101  * Read a byte from flash memory.
 102  * @param e e1000_t pointer.
 103  * @param reg Register offset.
 104  */
 105 #define E1000_READ_FLASH_REG(e,reg) \
 106     *(u32_t *) (((e)->flash) + (reg))
 107
 108 /**
 109  * Read a 16-bit word from flash memory.
 110  * @param e e1000_t pointer.
 111  * @param reg Register offset.
 112  */
 113 #define E1000_READ_FLASH_REG16(e,reg) \
 114     *(u16_t *) (((e)->flash) + (reg))
 115
 116 /**
 117  * Write a 16-bit word to flash memory.
 118  * @param e e1000_t pointer.
 119  * @param reg Register offset.
 120  * @param value New value.
 121  */
 122 #define E1000_WRITE_FLASH_REG(e,reg,value) \
 123     *((u32_t *) (((e)->flash) + (reg))) = (value)
 124
 125 /**
 126  * Write a 16-bit word to flash memory.
 127  * @param e e1000_t pointer.
 128  * @param reg Register offset.
 129  * @param value New value.
 130  */
 131 #define E1000_WRITE_FLASH_REG16(e,reg,value) \
 132     *((u16_t *) (((e)->flash) + (reg))) = (value)
 133
 134 /**
 135  * @}
 136  */
 137
 138 /**
 139  * @brief Describes the state of an Intel Pro/1000 card.
 140  */
 141 typedef struct e1000
 142 {
 143     char name[8];                 /**< String containing the device name. */
 144     int status;                   /**< Describes the card's current state. */
 145     int irq;                      /**< Interrupt Request Vector. */
 146     int irq_hook;                 /**< Interrupt Request Vector Hook. */
 147     int revision;                 /**< Hardware Revision Number. */
 148     u8_t *regs;                   /**< Memory mapped hardware registers. */
 149     u8_t *flash;                  /**< Optional flash memory. */
 150     u32_t flash_base_addr;        /**< Flash base address. */
 151     ether_addr_t address;         /**< Ethernet MAC address. */
 152     u16_t (*eeprom_read)(void *, int reg); /**< Function to read
 153                                                 the EEPROM. */
 154     int eeprom_done_bit;          /**< Offset of the EERD.DONE bit. */
 155     int eeprom_addr_off;          /**< Offset of the EERD.ADDR field. */
 156
 157     e1000_rx_desc_t *rx_desc;     /**< Receive Descriptor table. */
 158     phys_bytes rx_desc_p;         /**< Physical Receive Descriptor Address. */
 159     int rx_desc_count;            /**< Number of Receive Descriptors. */
 160     char *rx_buffer;              /**< Receive buffer returned by malloc(). */
 161     int rx_buffer_size;           /**< Size of the receive buffer. */
 162
 163     e1000_tx_desc_t *tx_desc;     /**< Transmit Descriptor table. */
 164     phys_bytes tx_desc_p;         /**< Physical Transmit Descriptor Address. */
 165     int tx_desc_count;            /**< Number of Transmit Descriptors. */
 166     char *tx_buffer;              /**< Transmit buffer returned by malloc(). */
 167     int tx_buffer_size;           /**< Size of the transmit buffer. */
 168
 169     int client;                   /**< Process ID being served by e1000. */
 170     message rx_message;           /**< Read message received from client. */
 171     message tx_message;           /**< Write message received from client. */
 172     size_t rx_size;               /**< Size of one packet received. */
 173 }
 174 e1000_t;
 175
 176 #endif /* __E1000_H */