2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2016 Alexander Motin <mav@FreeBSD.org>
5 * Copyright (c) 2015 Peter Grehan <grehan@freebsd.org>
6 * Copyright (c) 2013 Jeremiah Lott, Avere Systems
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer
14 * in this position and unchanged.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/types.h>
36 #ifndef WITHOUT_CAPSICUM
37 #include <sys/capsicum.h>
39 #include <sys/limits.h>
40 #include <sys/ioctl.h>
42 #include <net/ethernet.h>
43 #include <netinet/in.h>
44 #include <netinet/tcp.h>
46 #ifndef WITHOUT_CAPSICUM
47 #include <capsicum_helpers.h>
59 #include <pthread_np.h>
61 #include "e1000_regs.h"
62 #include "e1000_defines.h"
68 #include "net_utils.h"
70 /* Hardware/register definitions XXX: move some to common code. */
71 #define E82545_VENDOR_ID_INTEL 0x8086
72 #define E82545_DEV_ID_82545EM_COPPER 0x100F
73 #define E82545_SUBDEV_ID 0x1008
75 #define E82545_REVISION_4 4
77 #define E82545_MDIC_DATA_MASK 0x0000FFFF
78 #define E82545_MDIC_OP_MASK 0x0c000000
79 #define E82545_MDIC_IE 0x20000000
81 #define E82545_EECD_FWE_DIS 0x00000010 /* Flash writes disabled */
82 #define E82545_EECD_FWE_EN 0x00000020 /* Flash writes enabled */
83 #define E82545_EECD_FWE_MASK 0x00000030 /* Flash writes mask */
85 #define E82545_BAR_REGISTER 0
86 #define E82545_BAR_REGISTER_LEN (128*1024)
87 #define E82545_BAR_FLASH 1
88 #define E82545_BAR_FLASH_LEN (64*1024)
89 #define E82545_BAR_IO 2
90 #define E82545_BAR_IO_LEN 8
92 #define E82545_IOADDR 0x00000000
93 #define E82545_IODATA 0x00000004
94 #define E82545_IO_REGISTER_MAX 0x0001FFFF
95 #define E82545_IO_FLASH_BASE 0x00080000
96 #define E82545_IO_FLASH_MAX 0x000FFFFF
98 #define E82545_ARRAY_ENTRY(reg, offset) (reg + (offset<<2))
99 #define E82545_RAR_MAX 15
100 #define E82545_MTA_MAX 127
101 #define E82545_VFTA_MAX 127
103 /* Slightly modified from the driver versions, hardcoded for 3 opcode bits,
104 * followed by 6 address bits.
105 * TODO: make opcode bits and addr bits configurable?
106 * NVM Commands - Microwire */
107 #define E82545_NVM_OPCODE_BITS 3
108 #define E82545_NVM_ADDR_BITS 6
109 #define E82545_NVM_DATA_BITS 16
110 #define E82545_NVM_OPADDR_BITS (E82545_NVM_OPCODE_BITS + E82545_NVM_ADDR_BITS)
111 #define E82545_NVM_ADDR_MASK ((1 << E82545_NVM_ADDR_BITS)-1)
112 #define E82545_NVM_OPCODE_MASK \
113 (((1 << E82545_NVM_OPCODE_BITS) - 1) << E82545_NVM_ADDR_BITS)
114 #define E82545_NVM_OPCODE_READ (0x6 << E82545_NVM_ADDR_BITS) /* read */
115 #define E82545_NVM_OPCODE_WRITE (0x5 << E82545_NVM_ADDR_BITS) /* write */
116 #define E82545_NVM_OPCODE_ERASE (0x7 << E82545_NVM_ADDR_BITS) /* erase */
117 #define E82545_NVM_OPCODE_EWEN (0x4 << E82545_NVM_ADDR_BITS) /* wr-enable */
119 #define E82545_NVM_EEPROM_SIZE 64 /* 64 * 16-bit values == 128K */
121 #define E1000_ICR_SRPD 0x00010000
123 /* This is an arbitrary number. There is no hard limit on the chip. */
124 #define I82545_MAX_TXSEGS 64
126 /* Legacy receive descriptor */
127 struct e1000_rx_desc {
128 uint64_t buffer_addr; /* Address of the descriptor's data buffer */
129 uint16_t length; /* Length of data DMAed into data buffer */
130 uint16_t csum; /* Packet checksum */
131 uint8_t status; /* Descriptor status */
132 uint8_t errors; /* Descriptor Errors */
136 /* Transmit descriptor types */
137 #define E1000_TXD_MASK (E1000_TXD_CMD_DEXT | 0x00F00000)
138 #define E1000_TXD_TYP_L (0)
139 #define E1000_TXD_TYP_C (E1000_TXD_CMD_DEXT | E1000_TXD_DTYP_C)
140 #define E1000_TXD_TYP_D (E1000_TXD_CMD_DEXT | E1000_TXD_DTYP_D)
142 /* Legacy transmit descriptor */
143 struct e1000_tx_desc {
144 uint64_t buffer_addr; /* Address of the descriptor's data buffer */
148 uint16_t length; /* Data buffer length */
149 uint8_t cso; /* Checksum offset */
150 uint8_t cmd; /* Descriptor control */
156 uint8_t status; /* Descriptor status */
157 uint8_t css; /* Checksum start */
163 /* Context descriptor */
164 struct e1000_context_desc {
168 uint8_t ipcss; /* IP checksum start */
169 uint8_t ipcso; /* IP checksum offset */
170 uint16_t ipcse; /* IP checksum end */
176 uint8_t tucss; /* TCP checksum start */
177 uint8_t tucso; /* TCP checksum offset */
178 uint16_t tucse; /* TCP checksum end */
181 uint32_t cmd_and_length;
185 uint8_t status; /* Descriptor status */
186 uint8_t hdr_len; /* Header length */
187 uint16_t mss; /* Maximum segment size */
192 /* Data descriptor */
193 struct e1000_data_desc {
194 uint64_t buffer_addr; /* Address of the descriptor's buffer address */
198 uint16_t length; /* Data buffer length */
206 uint8_t status; /* Descriptor status */
207 uint8_t popts; /* Packet Options */
213 union e1000_tx_udesc {
214 struct e1000_tx_desc td;
215 struct e1000_context_desc cd;
216 struct e1000_data_desc dd;
219 /* Tx checksum info for a packet. */
221 int ck_valid; /* ck_info is valid */
222 uint8_t ck_start; /* start byte of cksum calcuation */
223 uint8_t ck_off; /* offset of cksum insertion */
224 uint16_t ck_len; /* length of cksum calc: 0 is to packet-end */
230 static int e82545_debug = 0;
231 #define DPRINTF(msg,params...) if (e82545_debug) fprintf(stderr, "e82545: " msg, params)
232 #define WPRINTF(msg,params...) fprintf(stderr, "e82545: " msg, params)
234 #define MIN(a,b) (((a)<(b))?(a):(b))
235 #define MAX(a,b) (((a)>(b))?(a):(b))
237 /* s/w representation of the RAL/RAH regs */
241 struct ether_addr eu_eth;
245 struct e82545_softc {
246 struct pci_devinst *esc_pi;
247 struct vmctx *esc_ctx;
248 struct mevent *esc_mevp;
249 struct mevent *esc_mevpitr;
250 pthread_mutex_t esc_mtx;
251 struct ether_addr esc_mac;
255 uint32_t esc_CTRL; /* x0000 device ctl */
256 uint32_t esc_FCAL; /* x0028 flow ctl addr lo */
257 uint32_t esc_FCAH; /* x002C flow ctl addr hi */
258 uint32_t esc_FCT; /* x0030 flow ctl type */
259 uint32_t esc_VET; /* x0038 VLAN eth type */
260 uint32_t esc_FCTTV; /* x0170 flow ctl tx timer */
261 uint32_t esc_LEDCTL; /* x0E00 LED control */
262 uint32_t esc_PBA; /* x1000 pkt buffer allocation */
264 /* Interrupt control */
265 int esc_irq_asserted;
266 uint32_t esc_ICR; /* x00C0 cause read/clear */
267 uint32_t esc_ITR; /* x00C4 intr throttling */
268 uint32_t esc_ICS; /* x00C8 cause set */
269 uint32_t esc_IMS; /* x00D0 mask set/read */
270 uint32_t esc_IMC; /* x00D8 mask clear */
273 union e1000_tx_udesc *esc_txdesc;
274 struct e1000_context_desc esc_txctx;
275 pthread_t esc_tx_tid;
276 pthread_cond_t esc_tx_cond;
279 uint32_t esc_TXCW; /* x0178 transmit config */
280 uint32_t esc_TCTL; /* x0400 transmit ctl */
281 uint32_t esc_TIPG; /* x0410 inter-packet gap */
282 uint16_t esc_AIT; /* x0458 Adaptive Interframe Throttle */
283 uint64_t esc_tdba; /* verified 64-bit desc table addr */
284 uint32_t esc_TDBAL; /* x3800 desc table addr, low bits */
285 uint32_t esc_TDBAH; /* x3804 desc table addr, hi 32-bits */
286 uint32_t esc_TDLEN; /* x3808 # descriptors in bytes */
287 uint16_t esc_TDH; /* x3810 desc table head idx */
288 uint16_t esc_TDHr; /* internal read version of TDH */
289 uint16_t esc_TDT; /* x3818 desc table tail idx */
290 uint32_t esc_TIDV; /* x3820 intr delay */
291 uint32_t esc_TXDCTL; /* x3828 desc control */
292 uint32_t esc_TADV; /* x382C intr absolute delay */
294 /* L2 frame acceptance */
295 struct eth_uni esc_uni[16]; /* 16 x unicast MAC addresses */
296 uint32_t esc_fmcast[128]; /* Multicast filter bit-match */
297 uint32_t esc_fvlan[128]; /* VLAN 4096-bit filter */
300 struct e1000_rx_desc *esc_rxdesc;
301 pthread_cond_t esc_rx_cond;
305 uint32_t esc_RCTL; /* x0100 receive ctl */
306 uint32_t esc_FCRTL; /* x2160 flow cntl thresh, low */
307 uint32_t esc_FCRTH; /* x2168 flow cntl thresh, hi */
308 uint64_t esc_rdba; /* verified 64-bit desc table addr */
309 uint32_t esc_RDBAL; /* x2800 desc table addr, low bits */
310 uint32_t esc_RDBAH; /* x2804 desc table addr, hi 32-bits*/
311 uint32_t esc_RDLEN; /* x2808 #descriptors */
312 uint16_t esc_RDH; /* x2810 desc table head idx */
313 uint16_t esc_RDT; /* x2818 desc table tail idx */
314 uint32_t esc_RDTR; /* x2820 intr delay */
315 uint32_t esc_RXDCTL; /* x2828 desc control */
316 uint32_t esc_RADV; /* x282C intr absolute delay */
317 uint32_t esc_RSRPD; /* x2C00 recv small packet detect */
318 uint32_t esc_RXCSUM; /* x5000 receive cksum ctl */
320 /* IO Port register access */
323 /* Shadow copy of MDIC */
324 uint32_t mdi_control;
325 /* Shadow copy of EECD */
326 uint32_t eeprom_control;
327 /* Latest NVM in/out */
331 uint32_t missed_pkt_count; /* dropped for no room in rx queue */
332 uint32_t pkt_rx_by_size[6];
333 uint32_t pkt_tx_by_size[6];
334 uint32_t good_pkt_rx_count;
335 uint32_t bcast_pkt_rx_count;
336 uint32_t mcast_pkt_rx_count;
337 uint32_t good_pkt_tx_count;
338 uint32_t bcast_pkt_tx_count;
339 uint32_t mcast_pkt_tx_count;
340 uint32_t oversize_rx_count;
341 uint32_t tso_tx_count;
342 uint64_t good_octets_rx;
343 uint64_t good_octets_tx;
344 uint64_t missed_octets; /* counts missed and oversized */
346 uint8_t nvm_bits:6; /* number of bits remaining in/out */
348 #define E82545_NVM_MODE_OPADDR 0x0
349 #define E82545_NVM_MODE_DATAIN 0x1
350 #define E82545_NVM_MODE_DATAOUT 0x2
352 uint16_t eeprom_data[E82545_NVM_EEPROM_SIZE];
355 static void e82545_reset(struct e82545_softc *sc, int dev);
356 static void e82545_rx_enable(struct e82545_softc *sc);
357 static void e82545_rx_disable(struct e82545_softc *sc);
358 static void e82545_tap_callback(int fd, enum ev_type type, void *param);
359 static void e82545_tx_start(struct e82545_softc *sc);
360 static void e82545_tx_enable(struct e82545_softc *sc);
361 static void e82545_tx_disable(struct e82545_softc *sc);
364 e82545_size_stat_index(uint32_t size)
368 } else if (size >= 1024) {
372 return (ffs(size) - 6);
377 e82545_init_eeprom(struct e82545_softc *sc)
379 uint16_t checksum, i;
382 sc->eeprom_data[NVM_MAC_ADDR] = ((uint16_t)sc->esc_mac.octet[0]) |
383 (((uint16_t)sc->esc_mac.octet[1]) << 8);
384 sc->eeprom_data[NVM_MAC_ADDR+1] = ((uint16_t)sc->esc_mac.octet[2]) |
385 (((uint16_t)sc->esc_mac.octet[3]) << 8);
386 sc->eeprom_data[NVM_MAC_ADDR+2] = ((uint16_t)sc->esc_mac.octet[4]) |
387 (((uint16_t)sc->esc_mac.octet[5]) << 8);
390 sc->eeprom_data[NVM_SUB_DEV_ID] = E82545_SUBDEV_ID;
391 sc->eeprom_data[NVM_SUB_VEN_ID] = E82545_VENDOR_ID_INTEL;
392 sc->eeprom_data[NVM_DEV_ID] = E82545_DEV_ID_82545EM_COPPER;
393 sc->eeprom_data[NVM_VEN_ID] = E82545_VENDOR_ID_INTEL;
395 /* fill in the checksum */
397 for (i = 0; i < NVM_CHECKSUM_REG; i++) {
398 checksum += sc->eeprom_data[i];
400 checksum = NVM_SUM - checksum;
401 sc->eeprom_data[NVM_CHECKSUM_REG] = checksum;
402 DPRINTF("eeprom checksum: 0x%x\r\n", checksum);
406 e82545_write_mdi(struct e82545_softc *sc, uint8_t reg_addr,
407 uint8_t phy_addr, uint32_t data)
409 DPRINTF("Write mdi reg:0x%x phy:0x%x data: 0x%x\r\n", reg_addr, phy_addr, data);
413 e82545_read_mdi(struct e82545_softc *sc, uint8_t reg_addr,
416 //DPRINTF("Read mdi reg:0x%x phy:0x%x\r\n", reg_addr, phy_addr);
419 return (MII_SR_LINK_STATUS | MII_SR_AUTONEG_CAPS |
420 MII_SR_AUTONEG_COMPLETE);
421 case PHY_AUTONEG_ADV:
422 return NWAY_AR_SELECTOR_FIELD;
425 case PHY_1000T_STATUS:
426 return (SR_1000T_LP_FD_CAPS | SR_1000T_REMOTE_RX_STATUS |
427 SR_1000T_LOCAL_RX_STATUS);
429 return (M88E1011_I_PHY_ID >> 16) & 0xFFFF;
431 return (M88E1011_I_PHY_ID | E82545_REVISION_4) & 0xFFFF;
433 DPRINTF("Unknown mdi read reg:0x%x phy:0x%x\r\n", reg_addr, phy_addr);
440 e82545_eecd_strobe(struct e82545_softc *sc)
442 /* Microwire state machine */
444 DPRINTF("eeprom state machine srtobe "
445 "0x%x 0x%x 0x%x 0x%x\r\n",
446 sc->nvm_mode, sc->nvm_bits,
447 sc->nvm_opaddr, sc->nvm_data);*/
449 if (sc->nvm_bits == 0) {
450 DPRINTF("eeprom state machine not expecting data! "
451 "0x%x 0x%x 0x%x 0x%x\r\n",
452 sc->nvm_mode, sc->nvm_bits,
453 sc->nvm_opaddr, sc->nvm_data);
457 if (sc->nvm_mode == E82545_NVM_MODE_DATAOUT) {
459 if (sc->nvm_data & 0x8000) {
460 sc->eeprom_control |= E1000_EECD_DO;
462 sc->eeprom_control &= ~E1000_EECD_DO;
465 if (sc->nvm_bits == 0) {
466 /* read done, back to opcode mode. */
468 sc->nvm_mode = E82545_NVM_MODE_OPADDR;
469 sc->nvm_bits = E82545_NVM_OPADDR_BITS;
471 } else if (sc->nvm_mode == E82545_NVM_MODE_DATAIN) {
474 if (sc->eeprom_control & E1000_EECD_DI) {
477 if (sc->nvm_bits == 0) {
479 uint16_t op = sc->nvm_opaddr & E82545_NVM_OPCODE_MASK;
480 uint16_t addr = sc->nvm_opaddr & E82545_NVM_ADDR_MASK;
481 if (op != E82545_NVM_OPCODE_WRITE) {
482 DPRINTF("Illegal eeprom write op 0x%x\r\n",
484 } else if (addr >= E82545_NVM_EEPROM_SIZE) {
485 DPRINTF("Illegal eeprom write addr 0x%x\r\n",
488 DPRINTF("eeprom write eeprom[0x%x] = 0x%x\r\n",
490 sc->eeprom_data[addr] = sc->nvm_data;
492 /* back to opcode mode */
494 sc->nvm_mode = E82545_NVM_MODE_OPADDR;
495 sc->nvm_bits = E82545_NVM_OPADDR_BITS;
497 } else if (sc->nvm_mode == E82545_NVM_MODE_OPADDR) {
498 sc->nvm_opaddr <<= 1;
499 if (sc->eeprom_control & E1000_EECD_DI) {
502 if (sc->nvm_bits == 0) {
503 uint16_t op = sc->nvm_opaddr & E82545_NVM_OPCODE_MASK;
505 case E82545_NVM_OPCODE_EWEN:
506 DPRINTF("eeprom write enable: 0x%x\r\n",
508 /* back to opcode mode */
510 sc->nvm_mode = E82545_NVM_MODE_OPADDR;
511 sc->nvm_bits = E82545_NVM_OPADDR_BITS;
513 case E82545_NVM_OPCODE_READ:
515 uint16_t addr = sc->nvm_opaddr &
516 E82545_NVM_ADDR_MASK;
517 sc->nvm_mode = E82545_NVM_MODE_DATAOUT;
518 sc->nvm_bits = E82545_NVM_DATA_BITS;
519 if (addr < E82545_NVM_EEPROM_SIZE) {
520 sc->nvm_data = sc->eeprom_data[addr];
521 DPRINTF("eeprom read: eeprom[0x%x] = 0x%x\r\n",
524 DPRINTF("eeprom illegal read: 0x%x\r\n",
530 case E82545_NVM_OPCODE_WRITE:
531 sc->nvm_mode = E82545_NVM_MODE_DATAIN;
532 sc->nvm_bits = E82545_NVM_DATA_BITS;
536 DPRINTF("eeprom unknown op: 0x%x\r\r",
538 /* back to opcode mode */
540 sc->nvm_mode = E82545_NVM_MODE_OPADDR;
541 sc->nvm_bits = E82545_NVM_OPADDR_BITS;
545 DPRINTF("eeprom state machine wrong state! "
546 "0x%x 0x%x 0x%x 0x%x\r\n",
547 sc->nvm_mode, sc->nvm_bits,
548 sc->nvm_opaddr, sc->nvm_data);
553 e82545_itr_callback(int fd, enum ev_type type, void *param)
556 struct e82545_softc *sc = param;
558 pthread_mutex_lock(&sc->esc_mtx);
559 new = sc->esc_ICR & sc->esc_IMS;
560 if (new && !sc->esc_irq_asserted) {
561 DPRINTF("itr callback: lintr assert %x\r\n", new);
562 sc->esc_irq_asserted = 1;
563 pci_lintr_assert(sc->esc_pi);
565 mevent_delete(sc->esc_mevpitr);
566 sc->esc_mevpitr = NULL;
568 pthread_mutex_unlock(&sc->esc_mtx);
572 e82545_icr_assert(struct e82545_softc *sc, uint32_t bits)
576 DPRINTF("icr assert: 0x%x\r\n", bits);
579 * An interrupt is only generated if bits are set that
580 * aren't already in the ICR, these bits are unmasked,
581 * and there isn't an interrupt already pending.
583 new = bits & ~sc->esc_ICR & sc->esc_IMS;
587 DPRINTF("icr assert: masked %x, ims %x\r\n", new, sc->esc_IMS);
588 } else if (sc->esc_mevpitr != NULL) {
589 DPRINTF("icr assert: throttled %x, ims %x\r\n", new, sc->esc_IMS);
590 } else if (!sc->esc_irq_asserted) {
591 DPRINTF("icr assert: lintr assert %x\r\n", new);
592 sc->esc_irq_asserted = 1;
593 pci_lintr_assert(sc->esc_pi);
594 if (sc->esc_ITR != 0) {
595 sc->esc_mevpitr = mevent_add(
596 (sc->esc_ITR + 3905) / 3906, /* 256ns -> 1ms */
597 EVF_TIMER, e82545_itr_callback, sc);
603 e82545_ims_change(struct e82545_softc *sc, uint32_t bits)
608 * Changing the mask may allow previously asserted
609 * but masked interrupt requests to generate an interrupt.
611 new = bits & sc->esc_ICR & ~sc->esc_IMS;
615 DPRINTF("ims change: masked %x, ims %x\r\n", new, sc->esc_IMS);
616 } else if (sc->esc_mevpitr != NULL) {
617 DPRINTF("ims change: throttled %x, ims %x\r\n", new, sc->esc_IMS);
618 } else if (!sc->esc_irq_asserted) {
619 DPRINTF("ims change: lintr assert %x\n\r", new);
620 sc->esc_irq_asserted = 1;
621 pci_lintr_assert(sc->esc_pi);
622 if (sc->esc_ITR != 0) {
623 sc->esc_mevpitr = mevent_add(
624 (sc->esc_ITR + 3905) / 3906, /* 256ns -> 1ms */
625 EVF_TIMER, e82545_itr_callback, sc);
631 e82545_icr_deassert(struct e82545_softc *sc, uint32_t bits)
634 DPRINTF("icr deassert: 0x%x\r\n", bits);
635 sc->esc_ICR &= ~bits;
638 * If there are no longer any interrupt sources and there
639 * was an asserted interrupt, clear it
641 if (sc->esc_irq_asserted && !(sc->esc_ICR & sc->esc_IMS)) {
642 DPRINTF("icr deassert: lintr deassert %x\r\n", bits);
643 pci_lintr_deassert(sc->esc_pi);
644 sc->esc_irq_asserted = 0;
649 e82545_intr_write(struct e82545_softc *sc, uint32_t offset, uint32_t value)
652 DPRINTF("intr_write: off %x, val %x\n\r", offset, value);
656 e82545_icr_deassert(sc, value);
662 sc->esc_ICS = value; /* not used: store for debug */
663 e82545_icr_assert(sc, value);
666 e82545_ims_change(sc, value);
669 sc->esc_IMC = value; /* for debug */
670 sc->esc_IMS &= ~value;
671 // XXX clear interrupts if all ICR bits now masked
672 // and interrupt was pending ?
680 e82545_intr_read(struct e82545_softc *sc, uint32_t offset)
686 DPRINTF("intr_read: off %x\n\r", offset);
690 retval = sc->esc_ICR;
692 e82545_icr_deassert(sc, ~0);
695 retval = sc->esc_ITR;
698 /* write-only register */
701 retval = sc->esc_IMS;
704 /* write-only register */
714 e82545_devctl(struct e82545_softc *sc, uint32_t val)
717 sc->esc_CTRL = val & ~E1000_CTRL_RST;
719 if (val & E1000_CTRL_RST) {
720 DPRINTF("e1k: s/w reset, ctl %x\n", val);
723 /* XXX check for phy reset ? */
727 e82545_rx_update_rdba(struct e82545_softc *sc)
730 /* XXX verify desc base/len within phys mem range */
731 sc->esc_rdba = (uint64_t)sc->esc_RDBAH << 32 |
734 /* Cache host mapping of guest descriptor array */
735 sc->esc_rxdesc = paddr_guest2host(sc->esc_ctx,
736 sc->esc_rdba, sc->esc_RDLEN);
740 e82545_rx_ctl(struct e82545_softc *sc, uint32_t val)
744 on = ((val & E1000_RCTL_EN) == E1000_RCTL_EN);
746 /* Save RCTL after stripping reserved bits 31:27,24,21,14,11:10,0 */
747 sc->esc_RCTL = val & ~0xF9204c01;
749 DPRINTF("rx_ctl - %s RCTL %x, val %x\n",
750 on ? "on" : "off", sc->esc_RCTL, val);
752 /* state change requested */
753 if (on != sc->esc_rx_enabled) {
755 /* Catch disallowed/unimplemented settings */
756 //assert(!(val & E1000_RCTL_LBM_TCVR));
758 if (sc->esc_RCTL & E1000_RCTL_LBM_TCVR) {
759 sc->esc_rx_loopback = 1;
761 sc->esc_rx_loopback = 0;
764 e82545_rx_update_rdba(sc);
765 e82545_rx_enable(sc);
767 e82545_rx_disable(sc);
768 sc->esc_rx_loopback = 0;
770 sc->esc_rxdesc = NULL;
776 e82545_tx_update_tdba(struct e82545_softc *sc)
779 /* XXX verify desc base/len within phys mem range */
780 sc->esc_tdba = (uint64_t)sc->esc_TDBAH << 32 | sc->esc_TDBAL;
782 /* Cache host mapping of guest descriptor array */
783 sc->esc_txdesc = paddr_guest2host(sc->esc_ctx, sc->esc_tdba,
788 e82545_tx_ctl(struct e82545_softc *sc, uint32_t val)
792 on = ((val & E1000_TCTL_EN) == E1000_TCTL_EN);
794 /* ignore TCTL_EN settings that don't change state */
795 if (on == sc->esc_tx_enabled)
799 e82545_tx_update_tdba(sc);
800 e82545_tx_enable(sc);
802 e82545_tx_disable(sc);
804 sc->esc_txdesc = NULL;
807 /* Save TCTL value after stripping reserved bits 31:25,23,2,0 */
808 sc->esc_TCTL = val & ~0xFE800005;
812 e82545_bufsz(uint32_t rctl)
815 switch (rctl & (E1000_RCTL_BSEX | E1000_RCTL_SZ_256)) {
816 case (E1000_RCTL_SZ_2048): return (2048);
817 case (E1000_RCTL_SZ_1024): return (1024);
818 case (E1000_RCTL_SZ_512): return (512);
819 case (E1000_RCTL_SZ_256): return (256);
820 case (E1000_RCTL_BSEX|E1000_RCTL_SZ_16384): return (16384);
821 case (E1000_RCTL_BSEX|E1000_RCTL_SZ_8192): return (8192);
822 case (E1000_RCTL_BSEX|E1000_RCTL_SZ_4096): return (4096);
824 return (256); /* Forbidden value. */
827 static uint8_t dummybuf[2048];
829 /* XXX one packet at a time until this is debugged */
831 e82545_tap_callback(int fd, enum ev_type type, void *param)
833 struct e82545_softc *sc = param;
834 struct e1000_rx_desc *rxd;
835 struct iovec vec[64];
836 int left, len, lim, maxpktsz, maxpktdesc, bufsz, i, n, size;
838 uint16_t *tp, tag, head;
840 pthread_mutex_lock(&sc->esc_mtx);
841 DPRINTF("rx_run: head %x, tail %x\r\n", sc->esc_RDH, sc->esc_RDT);
843 if (!sc->esc_rx_enabled || sc->esc_rx_loopback) {
844 DPRINTF("rx disabled (!%d || %d) -- packet(s) dropped\r\n",
845 sc->esc_rx_enabled, sc->esc_rx_loopback);
846 while (read(sc->esc_tapfd, dummybuf, sizeof(dummybuf)) > 0) {
850 bufsz = e82545_bufsz(sc->esc_RCTL);
851 maxpktsz = (sc->esc_RCTL & E1000_RCTL_LPE) ? 16384 : 1522;
852 maxpktdesc = (maxpktsz + bufsz - 1) / bufsz;
853 size = sc->esc_RDLEN / 16;
855 left = (size + sc->esc_RDT - head) % size;
856 if (left < maxpktdesc) {
857 DPRINTF("rx overflow (%d < %d) -- packet(s) dropped\r\n",
859 while (read(sc->esc_tapfd, dummybuf, sizeof(dummybuf)) > 0) {
864 sc->esc_rx_active = 1;
865 pthread_mutex_unlock(&sc->esc_mtx);
867 for (lim = size / 4; lim > 0 && left >= maxpktdesc; lim -= n) {
869 /* Grab rx descriptor pointed to by the head pointer */
870 for (i = 0; i < maxpktdesc; i++) {
871 rxd = &sc->esc_rxdesc[(head + i) % size];
872 vec[i].iov_base = paddr_guest2host(sc->esc_ctx,
873 rxd->buffer_addr, bufsz);
874 vec[i].iov_len = bufsz;
876 len = readv(sc->esc_tapfd, vec, maxpktdesc);
878 DPRINTF("tap: readv() returned %d\n", len);
883 * Adjust the packet length based on whether the CRC needs
884 * to be stripped or if the packet is less than the minimum
887 if (len < ETHER_MIN_LEN - ETHER_CRC_LEN)
888 len = ETHER_MIN_LEN - ETHER_CRC_LEN;
889 if (!(sc->esc_RCTL & E1000_RCTL_SECRC))
890 len += ETHER_CRC_LEN;
891 n = (len + bufsz - 1) / bufsz;
893 DPRINTF("packet read %d bytes, %d segs, head %d\r\n",
896 /* Apply VLAN filter. */
897 tp = (uint16_t *)vec[0].iov_base + 6;
898 if ((sc->esc_RCTL & E1000_RCTL_VFE) &&
899 (ntohs(tp[0]) == sc->esc_VET)) {
900 tag = ntohs(tp[1]) & 0x0fff;
901 if ((sc->esc_fvlan[tag >> 5] &
902 (1 << (tag & 0x1f))) != 0) {
903 DPRINTF("known VLAN %d\r\n", tag);
905 DPRINTF("unknown VLAN %d\r\n", tag);
911 /* Update all consumed descriptors. */
912 for (i = 0; i < n - 1; i++) {
913 rxd = &sc->esc_rxdesc[(head + i) % size];
918 rxd->status = E1000_RXD_STAT_DD;
920 rxd = &sc->esc_rxdesc[(head + i) % size];
921 rxd->length = len % bufsz;
925 /* XXX signal no checksum for now */
926 rxd->status = E1000_RXD_STAT_PIF | E1000_RXD_STAT_IXSM |
927 E1000_RXD_STAT_EOP | E1000_RXD_STAT_DD;
929 /* Schedule receive interrupts. */
930 if (len <= sc->esc_RSRPD) {
931 cause |= E1000_ICR_SRPD | E1000_ICR_RXT0;
933 /* XXX: RDRT and RADV timers should be here. */
934 cause |= E1000_ICR_RXT0;
937 head = (head + n) % size;
942 pthread_mutex_lock(&sc->esc_mtx);
943 sc->esc_rx_active = 0;
944 if (sc->esc_rx_enabled == 0)
945 pthread_cond_signal(&sc->esc_rx_cond);
948 /* Respect E1000_RCTL_RDMTS */
949 left = (size + sc->esc_RDT - head) % size;
950 if (left < (size >> (((sc->esc_RCTL >> 8) & 3) + 1)))
951 cause |= E1000_ICR_RXDMT0;
952 /* Assert all accumulated interrupts. */
954 e82545_icr_assert(sc, cause);
956 DPRINTF("rx_run done: head %x, tail %x\r\n", sc->esc_RDH, sc->esc_RDT);
957 pthread_mutex_unlock(&sc->esc_mtx);
961 e82545_carry(uint32_t sum)
964 sum = (sum & 0xFFFF) + (sum >> 16);
971 e82545_buf_checksum(uint8_t *buf, int len)
976 /* Checksum all the pairs of bytes first... */
977 for (i = 0; i < (len & ~1U); i += 2)
978 sum += *((u_int16_t *)(buf + i));
981 * If there's a single byte left over, checksum it, too.
982 * Network byte order is big-endian, so the remaining byte is
986 sum += htons(buf[i] << 8);
988 return (e82545_carry(sum));
992 e82545_iov_checksum(struct iovec *iov, int iovcnt, int off, int len)
997 /* Skip completely unneeded vectors. */
998 while (iovcnt > 0 && iov->iov_len <= off && off > 0) {
1004 /* Calculate checksum of requested range. */
1006 while (len > 0 && iovcnt > 0) {
1007 now = MIN(len, iov->iov_len - off);
1008 s = e82545_buf_checksum(iov->iov_base + off, now);
1009 sum += odd ? (s << 8) : s;
1017 return (e82545_carry(sum));
1021 * Return the transmit descriptor type.
1024 e82545_txdesc_type(uint32_t lower)
1030 if (lower & E1000_TXD_CMD_DEXT)
1031 type = lower & E1000_TXD_MASK;
1037 e82545_transmit_checksum(struct iovec *iov, int iovcnt, struct ck_info *ck)
1042 DPRINTF("tx cksum: iovcnt/s/off/len %d/%d/%d/%d\r\n",
1043 iovcnt, ck->ck_start, ck->ck_off, ck->ck_len);
1044 cklen = ck->ck_len ? ck->ck_len - ck->ck_start + 1 : INT_MAX;
1045 cksum = e82545_iov_checksum(iov, iovcnt, ck->ck_start, cklen);
1046 *(uint16_t *)((uint8_t *)iov[0].iov_base + ck->ck_off) = ~cksum;
1050 e82545_transmit_backend(struct e82545_softc *sc, struct iovec *iov, int iovcnt)
1053 if (sc->esc_tapfd == -1)
1056 (void) writev(sc->esc_tapfd, iov, iovcnt);
1060 e82545_transmit_done(struct e82545_softc *sc, uint16_t head, uint16_t tail,
1061 uint16_t dsize, int *tdwb)
1063 union e1000_tx_udesc *dsc;
1065 for ( ; head != tail; head = (head + 1) % dsize) {
1066 dsc = &sc->esc_txdesc[head];
1067 if (dsc->td.lower.data & E1000_TXD_CMD_RS) {
1068 dsc->td.upper.data |= E1000_TXD_STAT_DD;
1075 e82545_transmit(struct e82545_softc *sc, uint16_t head, uint16_t tail,
1076 uint16_t dsize, uint16_t *rhead, int *tdwb)
1078 uint8_t *hdr, *hdrp;
1079 struct iovec iovb[I82545_MAX_TXSEGS + 2];
1080 struct iovec tiov[I82545_MAX_TXSEGS + 2];
1081 struct e1000_context_desc *cd;
1082 struct ck_info ckinfo[2];
1084 union e1000_tx_udesc *dsc;
1085 int desc, dtype, len, ntype, iovcnt, tlen, hdrlen, vlen, tcp, tso;
1086 int mss, paylen, seg, tiovcnt, left, now, nleft, nnow, pv, pvoff;
1087 uint32_t tcpsum, tcpseq;
1088 uint16_t ipcs, tcpcs, ipid, ohead;
1090 ckinfo[0].ck_valid = ckinfo[1].ck_valid = 0;
1097 /* iovb[0/1] may be used for writable copy of headers. */
1100 for (desc = 0; ; desc++, head = (head + 1) % dsize) {
1105 dsc = &sc->esc_txdesc[head];
1106 dtype = e82545_txdesc_type(dsc->td.lower.data);
1110 case E1000_TXD_TYP_C:
1111 DPRINTF("tx ctxt desc idx %d: %016jx "
1113 head, dsc->td.buffer_addr,
1114 dsc->td.upper.data, dsc->td.lower.data);
1115 /* Save context and return */
1116 sc->esc_txctx = dsc->cd;
1118 case E1000_TXD_TYP_L:
1119 DPRINTF("tx legacy desc idx %d: %08x%08x\r\n",
1120 head, dsc->td.upper.data, dsc->td.lower.data);
1122 * legacy cksum start valid in first descriptor
1125 ckinfo[0].ck_start = dsc->td.upper.fields.css;
1127 case E1000_TXD_TYP_D:
1128 DPRINTF("tx data desc idx %d: %08x%08x\r\n",
1129 head, dsc->td.upper.data, dsc->td.lower.data);
1136 /* Descriptor type must be consistent */
1137 assert(dtype == ntype);
1138 DPRINTF("tx next desc idx %d: %08x%08x\r\n",
1139 head, dsc->td.upper.data, dsc->td.lower.data);
1142 len = (dtype == E1000_TXD_TYP_L) ? dsc->td.lower.flags.length :
1143 dsc->dd.lower.data & 0xFFFFF;
1146 /* Strip checksum supplied by guest. */
1147 if ((dsc->td.lower.data & E1000_TXD_CMD_EOP) != 0 &&
1148 (dsc->td.lower.data & E1000_TXD_CMD_IFCS) == 0)
1151 if (iovcnt < I82545_MAX_TXSEGS) {
1152 iov[iovcnt].iov_base = paddr_guest2host(
1153 sc->esc_ctx, dsc->td.buffer_addr, len);
1154 iov[iovcnt].iov_len = len;
1160 * Pull out info that is valid in the final descriptor
1161 * and exit descriptor loop.
1163 if (dsc->td.lower.data & E1000_TXD_CMD_EOP) {
1164 if (dtype == E1000_TXD_TYP_L) {
1165 if (dsc->td.lower.data & E1000_TXD_CMD_IC) {
1166 ckinfo[0].ck_valid = 1;
1168 dsc->td.lower.flags.cso;
1169 ckinfo[0].ck_len = 0;
1172 cd = &sc->esc_txctx;
1173 if (dsc->dd.lower.data & E1000_TXD_CMD_TSE)
1175 if (dsc->dd.upper.fields.popts &
1176 E1000_TXD_POPTS_IXSM)
1177 ckinfo[0].ck_valid = 1;
1178 if (dsc->dd.upper.fields.popts &
1179 E1000_TXD_POPTS_IXSM || tso) {
1180 ckinfo[0].ck_start =
1181 cd->lower_setup.ip_fields.ipcss;
1183 cd->lower_setup.ip_fields.ipcso;
1185 cd->lower_setup.ip_fields.ipcse;
1187 if (dsc->dd.upper.fields.popts &
1188 E1000_TXD_POPTS_TXSM)
1189 ckinfo[1].ck_valid = 1;
1190 if (dsc->dd.upper.fields.popts &
1191 E1000_TXD_POPTS_TXSM || tso) {
1192 ckinfo[1].ck_start =
1193 cd->upper_setup.tcp_fields.tucss;
1195 cd->upper_setup.tcp_fields.tucso;
1197 cd->upper_setup.tcp_fields.tucse;
1204 if (iovcnt > I82545_MAX_TXSEGS) {
1205 WPRINTF("tx too many descriptors (%d > %d) -- dropped\r\n",
1206 iovcnt, I82545_MAX_TXSEGS);
1211 /* Estimate writable space for VLAN header insertion. */
1212 if ((sc->esc_CTRL & E1000_CTRL_VME) &&
1213 (dsc->td.lower.data & E1000_TXD_CMD_VLE)) {
1214 hdrlen = ETHER_ADDR_LEN*2;
1215 vlen = ETHER_VLAN_ENCAP_LEN;
1218 /* Estimate required writable space for checksums. */
1219 if (ckinfo[0].ck_valid)
1220 hdrlen = MAX(hdrlen, ckinfo[0].ck_off + 2);
1221 if (ckinfo[1].ck_valid)
1222 hdrlen = MAX(hdrlen, ckinfo[1].ck_off + 2);
1223 /* Round up writable space to the first vector. */
1224 if (hdrlen != 0 && iov[0].iov_len > hdrlen &&
1225 iov[0].iov_len < hdrlen + 100)
1226 hdrlen = iov[0].iov_len;
1228 /* In case of TSO header length provided by software. */
1229 hdrlen = sc->esc_txctx.tcp_seg_setup.fields.hdr_len;
1232 /* Allocate, fill and prepend writable header vector. */
1234 hdr = __builtin_alloca(hdrlen + vlen);
1236 for (left = hdrlen, hdrp = hdr; left > 0;
1237 left -= now, hdrp += now) {
1238 now = MIN(left, iov->iov_len);
1239 memcpy(hdrp, iov->iov_base, now);
1240 iov->iov_base += now;
1241 iov->iov_len -= now;
1242 if (iov->iov_len == 0) {
1249 iov->iov_base = hdr;
1250 iov->iov_len = hdrlen;
1253 /* Insert VLAN tag. */
1255 hdr -= ETHER_VLAN_ENCAP_LEN;
1256 memmove(hdr, hdr + ETHER_VLAN_ENCAP_LEN, ETHER_ADDR_LEN*2);
1257 hdrlen += ETHER_VLAN_ENCAP_LEN;
1258 hdr[ETHER_ADDR_LEN*2 + 0] = sc->esc_VET >> 8;
1259 hdr[ETHER_ADDR_LEN*2 + 1] = sc->esc_VET & 0xff;
1260 hdr[ETHER_ADDR_LEN*2 + 2] = dsc->td.upper.fields.special >> 8;
1261 hdr[ETHER_ADDR_LEN*2 + 3] = dsc->td.upper.fields.special & 0xff;
1262 iov->iov_base = hdr;
1263 iov->iov_len += ETHER_VLAN_ENCAP_LEN;
1264 /* Correct checksum offsets after VLAN tag insertion. */
1265 ckinfo[0].ck_start += ETHER_VLAN_ENCAP_LEN;
1266 ckinfo[0].ck_off += ETHER_VLAN_ENCAP_LEN;
1267 if (ckinfo[0].ck_len != 0)
1268 ckinfo[0].ck_len += ETHER_VLAN_ENCAP_LEN;
1269 ckinfo[1].ck_start += ETHER_VLAN_ENCAP_LEN;
1270 ckinfo[1].ck_off += ETHER_VLAN_ENCAP_LEN;
1271 if (ckinfo[1].ck_len != 0)
1272 ckinfo[1].ck_len += ETHER_VLAN_ENCAP_LEN;
1275 /* Simple non-TSO case. */
1277 /* Calculate checksums and transmit. */
1278 if (ckinfo[0].ck_valid)
1279 e82545_transmit_checksum(iov, iovcnt, &ckinfo[0]);
1280 if (ckinfo[1].ck_valid)
1281 e82545_transmit_checksum(iov, iovcnt, &ckinfo[1]);
1282 e82545_transmit_backend(sc, iov, iovcnt);
1287 tcp = (sc->esc_txctx.cmd_and_length & E1000_TXD_CMD_TCP) != 0;
1288 mss = sc->esc_txctx.tcp_seg_setup.fields.mss;
1289 paylen = (sc->esc_txctx.cmd_and_length & 0x000fffff);
1290 DPRINTF("tx %s segmentation offload %d+%d/%d bytes %d iovs\r\n",
1291 tcp ? "TCP" : "UDP", hdrlen, paylen, mss, iovcnt);
1292 ipid = ntohs(*(uint16_t *)&hdr[ckinfo[0].ck_start + 4]);
1293 tcpseq = ntohl(*(uint32_t *)&hdr[ckinfo[1].ck_start + 4]);
1294 ipcs = *(uint16_t *)&hdr[ckinfo[0].ck_off];
1296 if (ckinfo[1].ck_valid) /* Save partial pseudo-header checksum. */
1297 tcpcs = *(uint16_t *)&hdr[ckinfo[1].ck_off];
1300 for (seg = 0, left = paylen; left > 0; seg++, left -= now) {
1301 now = MIN(left, mss);
1303 /* Construct IOVs for the segment. */
1304 /* Include whole original header. */
1305 tiov[0].iov_base = hdr;
1306 tiov[0].iov_len = hdrlen;
1308 /* Include respective part of payload IOV. */
1309 for (nleft = now; pv < iovcnt && nleft > 0; nleft -= nnow) {
1310 nnow = MIN(nleft, iov[pv].iov_len - pvoff);
1311 tiov[tiovcnt].iov_base = iov[pv].iov_base + pvoff;
1312 tiov[tiovcnt++].iov_len = nnow;
1313 if (pvoff + nnow == iov[pv].iov_len) {
1319 DPRINTF("tx segment %d %d+%d bytes %d iovs\r\n",
1320 seg, hdrlen, now, tiovcnt);
1322 /* Update IP header. */
1323 if (sc->esc_txctx.cmd_and_length & E1000_TXD_CMD_IP) {
1324 /* IPv4 -- set length and ID */
1325 *(uint16_t *)&hdr[ckinfo[0].ck_start + 2] =
1326 htons(hdrlen - ckinfo[0].ck_start + now);
1327 *(uint16_t *)&hdr[ckinfo[0].ck_start + 4] =
1330 /* IPv6 -- set length */
1331 *(uint16_t *)&hdr[ckinfo[0].ck_start + 4] =
1332 htons(hdrlen - ckinfo[0].ck_start - 40 +
1336 /* Update pseudo-header checksum. */
1338 tcpsum += htons(hdrlen - ckinfo[1].ck_start + now);
1340 /* Update TCP/UDP headers. */
1342 /* Update sequence number and FIN/PUSH flags. */
1343 *(uint32_t *)&hdr[ckinfo[1].ck_start + 4] =
1344 htonl(tcpseq + paylen - left);
1346 hdr[ckinfo[1].ck_start + 13] &=
1347 ~(TH_FIN | TH_PUSH);
1350 /* Update payload length. */
1351 *(uint32_t *)&hdr[ckinfo[1].ck_start + 4] =
1352 hdrlen - ckinfo[1].ck_start + now;
1355 /* Calculate checksums and transmit. */
1356 if (ckinfo[0].ck_valid) {
1357 *(uint16_t *)&hdr[ckinfo[0].ck_off] = ipcs;
1358 e82545_transmit_checksum(tiov, tiovcnt, &ckinfo[0]);
1360 if (ckinfo[1].ck_valid) {
1361 *(uint16_t *)&hdr[ckinfo[1].ck_off] =
1362 e82545_carry(tcpsum);
1363 e82545_transmit_checksum(tiov, tiovcnt, &ckinfo[1]);
1365 e82545_transmit_backend(sc, tiov, tiovcnt);
1369 head = (head + 1) % dsize;
1370 e82545_transmit_done(sc, ohead, head, dsize, tdwb);
1377 e82545_tx_run(struct e82545_softc *sc)
1380 uint16_t head, rhead, tail, size;
1381 int lim, tdwb, sent;
1385 size = sc->esc_TDLEN / 16;
1386 DPRINTF("tx_run: head %x, rhead %x, tail %x\r\n",
1387 sc->esc_TDH, sc->esc_TDHr, sc->esc_TDT);
1389 pthread_mutex_unlock(&sc->esc_mtx);
1392 for (lim = size / 4; sc->esc_tx_enabled && lim > 0; lim -= sent) {
1393 sent = e82545_transmit(sc, head, tail, size, &rhead, &tdwb);
1398 pthread_mutex_lock(&sc->esc_mtx);
1401 sc->esc_TDHr = rhead;
1404 cause |= E1000_ICR_TXDW;
1405 if (lim != size / 4 && sc->esc_TDH == sc->esc_TDT)
1406 cause |= E1000_ICR_TXQE;
1408 e82545_icr_assert(sc, cause);
1410 DPRINTF("tx_run done: head %x, rhead %x, tail %x\r\n",
1411 sc->esc_TDH, sc->esc_TDHr, sc->esc_TDT);
1414 static _Noreturn void *
1415 e82545_tx_thread(void *param)
1417 struct e82545_softc *sc = param;
1419 pthread_mutex_lock(&sc->esc_mtx);
1421 while (!sc->esc_tx_enabled || sc->esc_TDHr == sc->esc_TDT) {
1422 if (sc->esc_tx_enabled && sc->esc_TDHr != sc->esc_TDT)
1424 sc->esc_tx_active = 0;
1425 if (sc->esc_tx_enabled == 0)
1426 pthread_cond_signal(&sc->esc_tx_cond);
1427 pthread_cond_wait(&sc->esc_tx_cond, &sc->esc_mtx);
1429 sc->esc_tx_active = 1;
1431 /* Process some tx descriptors. Lock dropped inside. */
1437 e82545_tx_start(struct e82545_softc *sc)
1440 if (sc->esc_tx_active == 0)
1441 pthread_cond_signal(&sc->esc_tx_cond);
1445 e82545_tx_enable(struct e82545_softc *sc)
1448 sc->esc_tx_enabled = 1;
1452 e82545_tx_disable(struct e82545_softc *sc)
1455 sc->esc_tx_enabled = 0;
1456 while (sc->esc_tx_active)
1457 pthread_cond_wait(&sc->esc_tx_cond, &sc->esc_mtx);
1461 e82545_rx_enable(struct e82545_softc *sc)
1464 sc->esc_rx_enabled = 1;
1468 e82545_rx_disable(struct e82545_softc *sc)
1471 sc->esc_rx_enabled = 0;
1472 while (sc->esc_rx_active)
1473 pthread_cond_wait(&sc->esc_rx_cond, &sc->esc_mtx);
1477 e82545_write_ra(struct e82545_softc *sc, int reg, uint32_t wval)
1485 eu = &sc->esc_uni[idx];
1489 eu->eu_valid = ((wval & E1000_RAH_AV) == E1000_RAH_AV);
1490 eu->eu_addrsel = (wval >> 16) & 0x3;
1491 eu->eu_eth.octet[5] = wval >> 8;
1492 eu->eu_eth.octet[4] = wval;
1495 eu->eu_eth.octet[3] = wval >> 24;
1496 eu->eu_eth.octet[2] = wval >> 16;
1497 eu->eu_eth.octet[1] = wval >> 8;
1498 eu->eu_eth.octet[0] = wval;
1503 e82545_read_ra(struct e82545_softc *sc, int reg)
1512 eu = &sc->esc_uni[idx];
1516 retval = (eu->eu_valid << 31) |
1517 (eu->eu_addrsel << 16) |
1518 (eu->eu_eth.octet[5] << 8) |
1519 eu->eu_eth.octet[4];
1522 retval = (eu->eu_eth.octet[3] << 24) |
1523 (eu->eu_eth.octet[2] << 16) |
1524 (eu->eu_eth.octet[1] << 8) |
1525 eu->eu_eth.octet[0];
1532 e82545_write_register(struct e82545_softc *sc, uint32_t offset, uint32_t value)
1537 DPRINTF("Unaligned register write offset:0x%x value:0x%x\r\n", offset, value);
1540 DPRINTF("Register write: 0x%x value: 0x%x\r\n", offset, value);
1544 case E1000_CTRL_DUP:
1545 e82545_devctl(sc, value);
1548 sc->esc_FCAL = value;
1551 sc->esc_FCAH = value & ~0xFFFF0000;
1554 sc->esc_FCT = value & ~0xFFFF0000;
1557 sc->esc_VET = value & ~0xFFFF0000;
1560 sc->esc_FCTTV = value & ~0xFFFF0000;
1563 sc->esc_LEDCTL = value & ~0x30303000;
1566 sc->esc_PBA = value & 0x0000FF80;
1573 e82545_intr_write(sc, offset, value);
1576 e82545_rx_ctl(sc, value);
1579 sc->esc_FCRTL = value & ~0xFFFF0007;
1582 sc->esc_FCRTH = value & ~0xFFFF0007;
1584 case E1000_RDBAL(0):
1585 sc->esc_RDBAL = value & ~0xF;
1586 if (sc->esc_rx_enabled) {
1587 /* Apparently legal: update cached address */
1588 e82545_rx_update_rdba(sc);
1591 case E1000_RDBAH(0):
1592 assert(!sc->esc_rx_enabled);
1593 sc->esc_RDBAH = value;
1595 case E1000_RDLEN(0):
1596 assert(!sc->esc_rx_enabled);
1597 sc->esc_RDLEN = value & ~0xFFF0007F;
1600 /* XXX should only ever be zero ? Range check ? */
1601 sc->esc_RDH = value;
1604 /* XXX if this opens up the rx ring, do something ? */
1605 sc->esc_RDT = value;
1608 /* ignore FPD bit 31 */
1609 sc->esc_RDTR = value & ~0xFFFF0000;
1611 case E1000_RXDCTL(0):
1612 sc->esc_RXDCTL = value & ~0xFEC0C0C0;
1615 sc->esc_RADV = value & ~0xFFFF0000;
1618 sc->esc_RSRPD = value & ~0xFFFFF000;
1621 sc->esc_RXCSUM = value & ~0xFFFFF800;
1624 sc->esc_TXCW = value & ~0x3FFF0000;
1627 e82545_tx_ctl(sc, value);
1630 sc->esc_TIPG = value;
1633 sc->esc_AIT = value;
1635 case E1000_TDBAL(0):
1636 sc->esc_TDBAL = value & ~0xF;
1637 if (sc->esc_tx_enabled) {
1638 /* Apparently legal */
1639 e82545_tx_update_tdba(sc);
1642 case E1000_TDBAH(0):
1643 //assert(!sc->esc_tx_enabled);
1644 sc->esc_TDBAH = value;
1646 case E1000_TDLEN(0):
1647 //assert(!sc->esc_tx_enabled);
1648 sc->esc_TDLEN = value & ~0xFFF0007F;
1651 //assert(!sc->esc_tx_enabled);
1652 /* XXX should only ever be zero ? Range check ? */
1653 sc->esc_TDHr = sc->esc_TDH = value;
1656 /* XXX range check ? */
1657 sc->esc_TDT = value;
1658 if (sc->esc_tx_enabled)
1659 e82545_tx_start(sc);
1662 sc->esc_TIDV = value & ~0xFFFF0000;
1664 case E1000_TXDCTL(0):
1665 //assert(!sc->esc_tx_enabled);
1666 sc->esc_TXDCTL = value & ~0xC0C0C0;
1669 sc->esc_TADV = value & ~0xFFFF0000;
1671 case E1000_RAL(0) ... E1000_RAH(15):
1672 /* convert to u32 offset */
1673 ridx = (offset - E1000_RAL(0)) >> 2;
1674 e82545_write_ra(sc, ridx, value);
1676 case E1000_MTA ... (E1000_MTA + (127*4)):
1677 sc->esc_fmcast[(offset - E1000_MTA) >> 2] = value;
1679 case E1000_VFTA ... (E1000_VFTA + (127*4)):
1680 sc->esc_fvlan[(offset - E1000_VFTA) >> 2] = value;
1684 //DPRINTF("EECD write 0x%x -> 0x%x\r\n", sc->eeprom_control, value);
1685 /* edge triggered low->high */
1686 uint32_t eecd_strobe = ((sc->eeprom_control & E1000_EECD_SK) ?
1687 0 : (value & E1000_EECD_SK));
1688 uint32_t eecd_mask = (E1000_EECD_SK|E1000_EECD_CS|
1689 E1000_EECD_DI|E1000_EECD_REQ);
1690 sc->eeprom_control &= ~eecd_mask;
1691 sc->eeprom_control |= (value & eecd_mask);
1692 /* grant/revoke immediately */
1693 if (value & E1000_EECD_REQ) {
1694 sc->eeprom_control |= E1000_EECD_GNT;
1696 sc->eeprom_control &= ~E1000_EECD_GNT;
1698 if (eecd_strobe && (sc->eeprom_control & E1000_EECD_CS)) {
1699 e82545_eecd_strobe(sc);
1705 uint8_t reg_addr = (uint8_t)((value & E1000_MDIC_REG_MASK) >>
1706 E1000_MDIC_REG_SHIFT);
1707 uint8_t phy_addr = (uint8_t)((value & E1000_MDIC_PHY_MASK) >>
1708 E1000_MDIC_PHY_SHIFT);
1710 (value & ~(E1000_MDIC_ERROR|E1000_MDIC_DEST));
1711 if ((value & E1000_MDIC_READY) != 0) {
1712 DPRINTF("Incorrect MDIC ready bit: 0x%x\r\n", value);
1715 switch (value & E82545_MDIC_OP_MASK) {
1716 case E1000_MDIC_OP_READ:
1717 sc->mdi_control &= ~E82545_MDIC_DATA_MASK;
1718 sc->mdi_control |= e82545_read_mdi(sc, reg_addr, phy_addr);
1720 case E1000_MDIC_OP_WRITE:
1721 e82545_write_mdi(sc, reg_addr, phy_addr,
1722 value & E82545_MDIC_DATA_MASK);
1725 DPRINTF("Unknown MDIC op: 0x%x\r\n", value);
1728 /* TODO: barrier? */
1729 sc->mdi_control |= E1000_MDIC_READY;
1730 if (value & E82545_MDIC_IE) {
1731 // TODO: generate interrupt
1739 DPRINTF("Unknown write register: 0x%x value:%x\r\n", offset, value);
1745 e82545_read_register(struct e82545_softc *sc, uint32_t offset)
1751 DPRINTF("Unaligned register read offset:0x%x\r\n", offset);
1755 DPRINTF("Register read: 0x%x\r\n", offset);
1759 retval = sc->esc_CTRL;
1762 retval = E1000_STATUS_FD | E1000_STATUS_LU |
1763 E1000_STATUS_SPEED_1000;
1766 retval = sc->esc_FCAL;
1769 retval = sc->esc_FCAH;
1772 retval = sc->esc_FCT;
1775 retval = sc->esc_VET;
1778 retval = sc->esc_FCTTV;
1781 retval = sc->esc_LEDCTL;
1784 retval = sc->esc_PBA;
1791 retval = e82545_intr_read(sc, offset);
1794 retval = sc->esc_RCTL;
1797 retval = sc->esc_FCRTL;
1800 retval = sc->esc_FCRTH;
1802 case E1000_RDBAL(0):
1803 retval = sc->esc_RDBAL;
1805 case E1000_RDBAH(0):
1806 retval = sc->esc_RDBAH;
1808 case E1000_RDLEN(0):
1809 retval = sc->esc_RDLEN;
1812 retval = sc->esc_RDH;
1815 retval = sc->esc_RDT;
1818 retval = sc->esc_RDTR;
1820 case E1000_RXDCTL(0):
1821 retval = sc->esc_RXDCTL;
1824 retval = sc->esc_RADV;
1827 retval = sc->esc_RSRPD;
1830 retval = sc->esc_RXCSUM;
1833 retval = sc->esc_TXCW;
1836 retval = sc->esc_TCTL;
1839 retval = sc->esc_TIPG;
1842 retval = sc->esc_AIT;
1844 case E1000_TDBAL(0):
1845 retval = sc->esc_TDBAL;
1847 case E1000_TDBAH(0):
1848 retval = sc->esc_TDBAH;
1850 case E1000_TDLEN(0):
1851 retval = sc->esc_TDLEN;
1854 retval = sc->esc_TDH;
1857 retval = sc->esc_TDT;
1860 retval = sc->esc_TIDV;
1862 case E1000_TXDCTL(0):
1863 retval = sc->esc_TXDCTL;
1866 retval = sc->esc_TADV;
1868 case E1000_RAL(0) ... E1000_RAH(15):
1869 /* convert to u32 offset */
1870 ridx = (offset - E1000_RAL(0)) >> 2;
1871 retval = e82545_read_ra(sc, ridx);
1873 case E1000_MTA ... (E1000_MTA + (127*4)):
1874 retval = sc->esc_fmcast[(offset - E1000_MTA) >> 2];
1876 case E1000_VFTA ... (E1000_VFTA + (127*4)):
1877 retval = sc->esc_fvlan[(offset - E1000_VFTA) >> 2];
1880 //DPRINTF("EECD read %x\r\n", sc->eeprom_control);
1881 retval = sc->eeprom_control;
1884 retval = sc->mdi_control;
1889 /* stats that we emulate. */
1891 retval = sc->missed_pkt_count;
1894 retval = sc->pkt_rx_by_size[0];
1897 retval = sc->pkt_rx_by_size[1];
1900 retval = sc->pkt_rx_by_size[2];
1903 retval = sc->pkt_rx_by_size[3];
1906 retval = sc->pkt_rx_by_size[4];
1909 retval = sc->pkt_rx_by_size[5];
1912 retval = sc->good_pkt_rx_count;
1915 retval = sc->bcast_pkt_rx_count;
1918 retval = sc->mcast_pkt_rx_count;
1922 retval = sc->good_pkt_tx_count;
1925 retval = (uint32_t)sc->good_octets_rx;
1928 retval = (uint32_t)(sc->good_octets_rx >> 32);
1932 retval = (uint32_t)sc->good_octets_tx;
1936 retval = (uint32_t)(sc->good_octets_tx >> 32);
1939 retval = sc->oversize_rx_count;
1942 retval = (uint32_t)(sc->good_octets_rx + sc->missed_octets);
1945 retval = (uint32_t)((sc->good_octets_rx +
1946 sc->missed_octets) >> 32);
1949 retval = sc->good_pkt_rx_count + sc->missed_pkt_count +
1950 sc->oversize_rx_count;
1953 retval = sc->pkt_tx_by_size[0];
1956 retval = sc->pkt_tx_by_size[1];
1959 retval = sc->pkt_tx_by_size[2];
1962 retval = sc->pkt_tx_by_size[3];
1965 retval = sc->pkt_tx_by_size[4];
1968 retval = sc->pkt_tx_by_size[5];
1971 retval = sc->mcast_pkt_tx_count;
1974 retval = sc->bcast_pkt_tx_count;
1977 retval = sc->tso_tx_count;
1979 /* stats that are always 0. */
1981 case E1000_ALGNERRC:
2010 DPRINTF("Unknown read register: 0x%x\r\n", offset);
2019 e82545_write(struct vmctx *ctx, int vcpu, struct pci_devinst *pi, int baridx,
2020 uint64_t offset, int size, uint64_t value)
2022 struct e82545_softc *sc;
2024 //DPRINTF("Write bar:%d offset:0x%lx value:0x%lx size:%d\r\n", baridx, offset, value, size);
2028 pthread_mutex_lock(&sc->esc_mtx);
2035 DPRINTF("Wrong io addr write sz:%d value:0x%lx\r\n", size, value);
2037 sc->io_addr = (uint32_t)value;
2041 DPRINTF("Wrong io data write size:%d value:0x%lx\r\n", size, value);
2042 } else if (sc->io_addr > E82545_IO_REGISTER_MAX) {
2043 DPRINTF("Non-register io write addr:0x%x value:0x%lx\r\n", sc->io_addr, value);
2045 e82545_write_register(sc, sc->io_addr,
2049 DPRINTF("Unknown io bar write offset:0x%lx value:0x%lx size:%d\r\n", offset, value, size);
2053 case E82545_BAR_REGISTER:
2055 DPRINTF("Wrong register write size:%d offset:0x%lx value:0x%lx\r\n", size, offset, value);
2057 e82545_write_register(sc, (uint32_t)offset,
2061 DPRINTF("Unknown write bar:%d off:0x%lx val:0x%lx size:%d\r\n",
2062 baridx, offset, value, size);
2065 pthread_mutex_unlock(&sc->esc_mtx);
2069 e82545_read(struct vmctx *ctx, int vcpu, struct pci_devinst *pi, int baridx,
2070 uint64_t offset, int size)
2072 struct e82545_softc *sc;
2075 //DPRINTF("Read bar:%d offset:0x%lx size:%d\r\n", baridx, offset, size);
2079 pthread_mutex_lock(&sc->esc_mtx);
2086 DPRINTF("Wrong io addr read sz:%d\r\n", size);
2088 retval = sc->io_addr;
2092 DPRINTF("Wrong io data read sz:%d\r\n", size);
2094 if (sc->io_addr > E82545_IO_REGISTER_MAX) {
2095 DPRINTF("Non-register io read addr:0x%x\r\n",
2098 retval = e82545_read_register(sc, sc->io_addr);
2101 DPRINTF("Unknown io bar read offset:0x%lx size:%d\r\n",
2106 case E82545_BAR_REGISTER:
2108 DPRINTF("Wrong register read size:%d offset:0x%lx\r\n",
2111 retval = e82545_read_register(sc, (uint32_t)offset);
2114 DPRINTF("Unknown read bar:%d offset:0x%lx size:%d\r\n",
2115 baridx, offset, size);
2119 pthread_mutex_unlock(&sc->esc_mtx);
2125 e82545_reset(struct e82545_softc *sc, int drvr)
2129 e82545_rx_disable(sc);
2130 e82545_tx_disable(sc);
2132 /* clear outstanding interrupts */
2133 if (sc->esc_irq_asserted)
2134 pci_lintr_deassert(sc->esc_pi);
2144 sc->esc_LEDCTL = 0x07061302;
2145 sc->esc_PBA = 0x00100030;
2147 /* start nvm in opcode mode. */
2149 sc->nvm_mode = E82545_NVM_MODE_OPADDR;
2150 sc->nvm_bits = E82545_NVM_OPADDR_BITS;
2151 sc->eeprom_control = E1000_EECD_PRES | E82545_EECD_FWE_EN;
2152 e82545_init_eeprom(sc);
2163 memset(sc->esc_fvlan, 0, sizeof(sc->esc_fvlan));
2164 memset(sc->esc_fmcast, 0, sizeof(sc->esc_fmcast));
2165 memset(sc->esc_uni, 0, sizeof(sc->esc_uni));
2167 /* XXX not necessary on 82545 ?? */
2168 sc->esc_uni[0].eu_valid = 1;
2169 memcpy(sc->esc_uni[0].eu_eth.octet, sc->esc_mac.octet,
2172 /* Clear RAH valid bits */
2173 for (i = 0; i < 16; i++)
2174 sc->esc_uni[i].eu_valid = 0;
2189 sc->esc_RXDCTL = (1 << 24) | (1 << 16); /* default GRAN/WTHRESH */
2203 sc->esc_txdesc = NULL;
2208 sc->esc_TDHr = sc->esc_TDH = 0;
2213 e82545_open_tap(struct e82545_softc *sc, char *opts)
2216 #ifndef WITHOUT_CAPSICUM
2217 cap_rights_t rights;
2225 strcpy(tbuf, "/dev/");
2226 strlcat(tbuf, opts, sizeof(tbuf));
2228 sc->esc_tapfd = open(tbuf, O_RDWR);
2229 if (sc->esc_tapfd == -1) {
2230 DPRINTF("unable to open tap device %s\n", opts);
2235 * Set non-blocking and register for read
2236 * notifications with the event loop
2239 if (ioctl(sc->esc_tapfd, FIONBIO, &opt) < 0) {
2240 WPRINTF("tap device O_NONBLOCK failed: %d\n", errno);
2241 close(sc->esc_tapfd);
2245 #ifndef WITHOUT_CAPSICUM
2246 cap_rights_init(&rights, CAP_EVENT, CAP_READ, CAP_WRITE);
2247 if (caph_rights_limit(sc->esc_tapfd, &rights) == -1)
2248 errx(EX_OSERR, "Unable to apply rights for sandbox");
2251 sc->esc_mevp = mevent_add(sc->esc_tapfd,
2253 e82545_tap_callback,
2255 if (sc->esc_mevp == NULL) {
2256 DPRINTF("Could not register mevent %d\n", EVF_READ);
2257 close(sc->esc_tapfd);
2263 e82545_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts)
2266 struct e82545_softc *sc;
2271 DPRINTF("Loading with options: %s\r\n", opts);
2273 /* Setup our softc */
2274 sc = calloc(1, sizeof(*sc));
2280 pthread_mutex_init(&sc->esc_mtx, NULL);
2281 pthread_cond_init(&sc->esc_rx_cond, NULL);
2282 pthread_cond_init(&sc->esc_tx_cond, NULL);
2283 pthread_create(&sc->esc_tx_tid, NULL, e82545_tx_thread, sc);
2284 snprintf(nstr, sizeof(nstr), "e82545-%d:%d tx", pi->pi_slot,
2286 pthread_set_name_np(sc->esc_tx_tid, nstr);
2288 pci_set_cfgdata16(pi, PCIR_DEVICE, E82545_DEV_ID_82545EM_COPPER);
2289 pci_set_cfgdata16(pi, PCIR_VENDOR, E82545_VENDOR_ID_INTEL);
2290 pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_NETWORK);
2291 pci_set_cfgdata8(pi, PCIR_SUBCLASS, PCIS_NETWORK_ETHERNET);
2292 pci_set_cfgdata16(pi, PCIR_SUBDEV_0, E82545_SUBDEV_ID);
2293 pci_set_cfgdata16(pi, PCIR_SUBVEND_0, E82545_VENDOR_ID_INTEL);
2295 pci_set_cfgdata8(pi, PCIR_HDRTYPE, PCIM_HDRTYPE_NORMAL);
2296 pci_set_cfgdata8(pi, PCIR_INTPIN, 0x1);
2298 /* TODO: this card also supports msi, but the freebsd driver for it
2299 * does not, so I have not implemented it. */
2300 pci_lintr_request(pi);
2302 pci_emul_alloc_bar(pi, E82545_BAR_REGISTER, PCIBAR_MEM32,
2303 E82545_BAR_REGISTER_LEN);
2304 pci_emul_alloc_bar(pi, E82545_BAR_FLASH, PCIBAR_MEM32,
2305 E82545_BAR_FLASH_LEN);
2306 pci_emul_alloc_bar(pi, E82545_BAR_IO, PCIBAR_IO,
2310 * Attempt to open the tap device and read the MAC address
2311 * if specified. Copied from virtio-net, slightly modified.
2318 devname = vtopts = strdup(opts);
2319 (void) strsep(&vtopts, ",");
2321 if (vtopts != NULL) {
2322 err = net_parsemac(vtopts, sc->esc_mac.octet);
2330 if (strncmp(devname, "tap", 3) == 0 ||
2331 strncmp(devname, "vmnet", 5) == 0)
2332 e82545_open_tap(sc, devname);
2337 if (!mac_provided) {
2338 net_genmac(pi, sc->esc_mac.octet);
2341 /* H/w initiated reset */
2342 e82545_reset(sc, 0);
2347 struct pci_devemu pci_de_e82545 = {
2349 .pe_init = e82545_init,
2350 .pe_barwrite = e82545_write,
2351 .pe_barread = e82545_read
2353 PCI_EMUL_SET(pci_de_e82545);