Skip to content
charmOS docs

e1000

include/drivers/e1000.h View source View on GitHub

Structs

Section titled “Structs”

e1000_device

Section titled “e1000_device”
struct e1000_device {
    uint32_t              *regs;
    struct e1000_tx_desc  *tx_descs;
    uintptr_t             tx_descs_phys;
    uint32_t              tx_tail;
    void                  *tx_buffers[E1000_NUM_TX_DESC];
    struct e1000_rx_desc  *rx_descs;
    uintptr_t             rx_descs_phys;
    uint32_t              rx_tail;
    void                  *rx_buffers[E1000_NUM_RX_DESC];
    uint8_t               bus;
};

e1000_tx_desc

Section titled “e1000_tx_desc”
struct e1000_tx_desc {
    uint64_t  addr;
    uint16_t  length;
    uint8_t   cso;
    union {
        uint8_t  cmd;
        struct {
            uint8_t  eop : 1;
            uint8_t  ifcs : 1;
            uint8_t  ic : 1;
            uint8_t  rs : 1;
            uint8_t  rsvd : 1;
            uint8_t  dext : 1;
            uint8_t  vlei : 1;
            uint8_t  ide : 1;
        };
    };
    union {
        uint8_t  status;
        struct {
            uint8_t  dd : 1;
            uint8_t  ec : 1;
            uint8_t  lc : 1;
            uint8_t  rsvd0 : 5;
        };
    };
    uint8_t   css;
    uint16_t  special;
};

e1000_rx_desc

Section titled “e1000_rx_desc”
struct e1000_rx_desc {
    uint64_t  addr;
    uint16_t  length;
    uint16_t  checksum;
    union {
        uint8_t  status;
        struct {
            uint8_t  dd : 1;
            uint8_t  eop : 1;
            uint8_t  ixsm : 1;
            uint8_t  vp : 1;
            uint8_t  rsvd : 4;
        };
    };
    uint8_t   errors;
    uint16_t  special;
};

eth_hdr

Section titled “eth_hdr”
struct eth_hdr {
    uint8_t   dest[6];
    uint8_t   src[6];
    uint16_t  ethertype;
};

ipv4_hdr

Section titled “ipv4_hdr”
struct ipv4_hdr {
    uint8_t   version_ihl;
    uint8_t   tos;
    uint16_t  total_length;
    uint16_t  id;
    uint16_t  flags_fragment;
    uint8_t   ttl;
    uint8_t   protocol;
    uint16_t  checksum;
    uint32_t  src_ip;
    uint32_t  dest_ip;
};

icmp_hdr

Section titled “icmp_hdr”
struct icmp_hdr {
    uint8_t   type;
    uint8_t   code;
    uint16_t  checksum;
    uint16_t  identifier;
    uint16_t  sequence;
};

Functions

Section titled “Functions”

e1000_init

Section titled “e1000_init”
bool e1000_init(struct pci_device *dev, struct e1000_device *out);

Macros

Section titled “Macros”

E1000_REG_CTRL

Section titled “E1000_REG_CTRL”
#define E1000_REG_CTRL 0x0000

E1000_REG_STATUS

Section titled “E1000_REG_STATUS”
#define E1000_REG_STATUS 0x0008

E1000_REG_TCTL

Section titled “E1000_REG_TCTL”
#define E1000_REG_TCTL 0x0400

E1000_REG_TDBAL

Section titled “E1000_REG_TDBAL”
#define E1000_REG_TDBAL 0x03800

E1000_REG_TDBAH

Section titled “E1000_REG_TDBAH”
#define E1000_REG_TDBAH 0x03804

E1000_REG_TDLEN

Section titled “E1000_REG_TDLEN”
#define E1000_REG_TDLEN 0x03808

E1000_REG_TDH

Section titled “E1000_REG_TDH”
#define E1000_REG_TDH 0x03810

E1000_REG_TDT

Section titled “E1000_REG_TDT”
#define E1000_REG_TDT 0x03818

E1000_REG_RCTL

Section titled “E1000_REG_RCTL”
#define E1000_REG_RCTL 0x0100

E1000_REG_RDBAL

Section titled “E1000_REG_RDBAL”
#define E1000_REG_RDBAL 0x02800

E1000_REG_RDBAH

Section titled “E1000_REG_RDBAH”
#define E1000_REG_RDBAH 0x02804

E1000_REG_RDLEN

Section titled “E1000_REG_RDLEN”
#define E1000_REG_RDLEN 0x02808

E1000_REG_RDH

Section titled “E1000_REG_RDH”
#define E1000_REG_RDH 0x02810

E1000_REG_RDT

Section titled “E1000_REG_RDT”
#define E1000_REG_RDT 0x02818

E1000_REG_IMS

Section titled “E1000_REG_IMS”
#define E1000_REG_IMS 0x00D0

E1000_REG_ICR

Section titled “E1000_REG_ICR”
#define E1000_REG_ICR 0x00C0

E1000_TCTL_EN

Section titled “E1000_TCTL_EN”
#define E1000_TCTL_EN (1 << 1)

E1000_TCTL_PSP

Section titled “E1000_TCTL_PSP”
#define E1000_TCTL_PSP (1 << 3)

E1000_TCTL_CT_SHIFT

Section titled “E1000_TCTL_CT_SHIFT”
#define E1000_TCTL_CT_SHIFT 4

E1000_TCTL_COLD_SHIFT

Section titled “E1000_TCTL_COLD_SHIFT”
#define E1000_TCTL_COLD_SHIFT 12

E1000_RCTL_EN

Section titled “E1000_RCTL_EN”
#define E1000_RCTL_EN (1 << 1)

E1000_RCTL_BAM

Section titled “E1000_RCTL_BAM”
#define E1000_RCTL_BAM (1 << 15)

E1000_RCTL_SECRC

Section titled “E1000_RCTL_SECRC”
#define E1000_RCTL_SECRC (1 << 26)

E1000_NUM_RX_DESC

Section titled “E1000_NUM_RX_DESC”
#define E1000_NUM_RX_DESC 64

E1000_NUM_TX_DESC

Section titled “E1000_NUM_TX_DESC”
#define E1000_NUM_TX_DESC 64

E1000_TXD_CMD_EOP

Section titled “E1000_TXD_CMD_EOP”
#define E1000_TXD_CMD_EOP (1 << 0)

E1000_TXD_CMD_IFCS

Section titled “E1000_TXD_CMD_IFCS”
#define E1000_TXD_CMD_IFCS (1 << 1)

E1000_TXD_CMD_RS

Section titled “E1000_TXD_CMD_RS”
#define E1000_TXD_CMD_RS (1 << 3)

E1000_TXD_STAT_DD

Section titled “E1000_TXD_STAT_DD”
#define E1000_TXD_STAT_DD (1 << 0)

E1000_RXD_STAT_DD

Section titled “E1000_RXD_STAT_DD”
#define E1000_RXD_STAT_DD (1 << 0)

E1000_RXD_STAT_EOP

Section titled “E1000_RXD_STAT_EOP”
#define E1000_RXD_STAT_EOP (1 << 1)

E1000_CTRL_RST

Section titled “E1000_CTRL_RST”
#define E1000_CTRL_RST (1 << 26) // Software reset

E1000_BAR_INDEX

Section titled “E1000_BAR_INDEX”
#define E1000_BAR_INDEX 0

PCI_BAR0

Section titled “PCI_BAR0”
#define PCI_BAR0 0x10

E1000_RX_BUF_SIZE

Section titled “E1000_RX_BUF_SIZE”
#define E1000_RX_BUF_SIZE 2048

E1000_MAX_TX_PACKET_SIZE

Section titled “E1000_MAX_TX_PACKET_SIZE”
#define E1000_MAX_TX_PACKET_SIZE 1518 // Standard Ethernet frame

e1000_log

Section titled “e1000_log”
#define e1000_log(log_level, fmt, ...) \
    log(LOG_SITE(e1000), LOG_HANDLE(e1000), log_level, fmt, ##__VA_ARGS__)