2 * This file is part of the Palacios Virtual Machine Monitor developed
3 * by the V3VEE Project with funding from the United States National
4 * Science Foundation and the Department of Energy.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
10 * Copyright (c) 2009, Lei Xia <lxia@northwestern.edu>
11 * Copyright (c) 2009, The V3VEE Project <http://www.v3vee.org>
12 * All rights reserved.
14 * Author: Lei Xia <lxia@northwestern.edu>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
21 * Virtual NE2K Network Card
27 #include <devices/vnic.h>
28 #include <palacios/vmm.h>
29 #include <palacios/vmm_types.h>
30 #include <palacios/vmm_io.h>
31 #include <palacios/vmm_debug.h>
37 #define PrintDebug(fmts, args...)
40 typedef enum {NIC_READY, NIC_REG_POSTED} nic_state_t;
64 uchar_t phys[6]; // mac address
66 uchar_t mult[8]; // multicast mask array
75 struct guest_info * vm;
77 nic_state_t dev_state;
81 uchar_t mac[6]; //the mac address of this nic
83 uchar_t mem[NE2K_MEM_SIZE];
86 struct vm_device * current_vnic;
88 #define compare_mac(src, dst) ({ \
89 ( (src[0] == dst[0]) && \
90 (src[1] == dst[1]) && \
91 (src[2] == dst[2]) && \
92 (src[3] == dst[3]) && \
93 (src[4] == dst[4]) && \
94 (src[5] == dst[5]) ) ? 1 : 0; \
100 static int vnic_mem_write(struct nic_context * nic_state,
104 PrintDebug("wmem addr: %x val: %x\n", addr, val);
106 // if ((addr < NE2K_PMEM_START) || (addr > NE2K_MEM_SIZE))
110 uchar_t val = *(uchar_t *)src;
120 static void vnic_mem_writeb(struct nic_context * nic_state,
123 uchar_t tmp = (uchar_t) (val & 0x000000ff);
126 ((addr >= NE2K_PMEM_START && addr < NE2K_MEM_SIZE) ) {
127 nic_state->mem[addr] = tmp;
130 PrintDebug("wmem addr: %x val: %x\n", addr, val);
133 static void vnic_mem_writew(struct nic_context * nic_state,
137 addr &= ~1; //XXX: check exact behaviour if not even
140 ((addr >= NE2K_PMEM_START && addr) < NE2K_MEM_SIZE)) {
141 *(ushort_t *)(nic_state->mem + addr) = cpu2le16(val);
144 PrintDebug("wmem addr: %x val: %x\n", addr, val);
147 static void vnic_mem_writel(struct nic_context * nic_state,
150 addr &= ~1; // XXX: check exact behaviour if not even
153 ( (addr >= NE2K_PMEM_START) && (addr < NE2K_MEM_SIZE) ) ) {
154 *(uint32_t *)(nic_state->mem + addr) = cpu2le32(val);
157 PrintDebug("wmem addr: %x val: %x\n", addr, val);
160 static uchar_t vnic_mem_readb(struct nic_context * nic_state, uint32_t addr) {
161 PrintDebug("rmem addr: %x\n", addr);
164 ( (addr >= NE2K_PMEM_START) && (addr < NE2K_MEM_SIZE)) ) {
165 return nic_state->mem[addr];
171 static ushort_t vnic_mem_readw(struct nic_context * nic_state, uint32_t addr) {
172 PrintDebug("rmem addr: %x\n", addr);
174 addr &= ~1; //XXX: check exact behaviour if not even
177 ( (addr >= NE2K_PMEM_START) && (addr < NE2K_MEM_SIZE))) {
178 return (ushort_t)le16_to_cpu((ushort_t *)(nic_state->mem + addr));
184 static uint32_t vnic_mem_readl(struct nic_context * nic_state, uint32_t addr) {
185 PrintDebug("rmem addr: %x\n", addr);
187 addr &= ~1; //XXX: check exact behaviour if not even
190 ( (addr >= NE2K_PMEM_START && addr < NE2K_MEM_SIZE))) {
191 return (uint32_t)le32_to_cpu((uint32_t *)(nic_state->mem + addr));
200 static void dump_state(struct vm_device * dev) {
203 struct nic_context * nic_state = (struct nic_context *)dev->private_data;
205 PrintDebug("====VNIC: Dumping state Begin ==========\n");
206 PrintDebug("Registers:\n");
208 p = (uchar_t *)&nic_state->regs;
210 for (i = 0; i < sizeof(struct nic_regs); i++) {
211 PrintDebug("Regs[i] = 0x%2x\n", (int)p[i]);
214 PrintDebug("Memory:\n");
216 for (i = 0; i < 32; i++) {
217 PrintDebug("0x%02x ", nic_state->mem[i]);
221 PrintDebug("====VNIC: Dumping state End==========\n");
224 static void vnic_update_irq(struct vm_device * dev) {
225 struct nic_context * nic_state = (struct nic_context *)dev->private_data;
226 struct guest_info * guest = dev->vm;
228 int isr = ((nic_state->regs.isr & nic_state->regs.imr) & 0x7f);
230 if ((isr & 0x7f) != 0x0) {
231 v3_raise_irq(guest, NIC_IRQ);
232 PrintDebug("VNIC: RaiseIrq: isr: 0x%02x imr: 0x%02x\n", nic_state->regs.isr, nic_state->regs.imr);
236 static void init_vnic_context(struct vm_device * dev) {
237 struct nic_context *nic_state = (struct nic_context *)dev->private_data;
239 uchar_t mac[6] = {0x52, 0x54, 0x0, 0x12, 0x34, 0x56};
241 nic_state->vm = dev->vm;
243 nic_state->regs.isr = ENISR_RESET;
244 nic_state->regs.imr = 0x00;
245 nic_state->regs.cmd = 0x22;
247 for (i = 0; i < 6; i++) {
248 nic_state->regs.macaddr[i] = nic_state->mac[i] = mac[i];
251 for (i = 0; i < 8; i++) {
252 nic_state->regs.mult[i] = 0xff;
255 for(i = 0; i < 32; i++) {
256 nic_state->mem[i] = 0xff;
259 memcpy(nic_state->mem, nic_state->mac, 6);
260 nic_state->mem[14] = 0x57;
261 nic_state->mem[15] = 0x57;
267 static int vnic_send_packet(struct vm_device *dev, uchar_t *pkt, int length) {
270 PrintDebug("\nVNIC: Sending Packet\n");
272 for (i = 0; i < length; i++) {
273 PrintDebug("%x ",pkt[i]);
278 return V3_SEND_PKT(pkt, length);
282 struct vm_device * get_rx_dev(uchar_t * dst_mac) {
283 struct nic_context * nic_state = (struct nic_context *)current_vnic->private_data;
284 struct nic_regs * nregs = &(nic_state->regs);
286 static const uchar_t brocast_mac[6] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
288 if (nregs->rcr & 0x10) {
291 if (compare_mac(dst_mac, brocast_mac)) { //broadcast address
292 if (!(nregs->rcr & 0x04)) {
295 } else if (dst_mac[0] & 0x01) {
296 // multicast packet, not fully done here
298 if (!(nregs->rcr & 0x08)) {
301 } else if (!compare_mac(dst_mac, nic_state->mac)) {
311 static int vnic_rxbuf_full(struct vm_device * dev) {
312 int empty, index, boundary;
313 struct nic_context * nic_state = (struct nic_context *)dev->private_data;
315 index = nic_state->regs.curpag << 8;
316 boundary = nic_state->regs.boundary << 8;
317 if (index < boundary) {
318 empty = boundary - index;
320 empty = ((nic_state->regs.pgstop - nic_state->regs.pgstart) << 8) - (index - boundary);
323 if (empty < (MAX_ETH_FRAME_SIZE + 4)) {
330 #define MIN_BUF_SIZE 60
332 static void vnic_receive(struct vm_device * dev, const uchar_t * pkt, int length) {
333 struct nic_context * nic_state = (struct nic_context *)dev->private_data;
334 struct nic_regs * nregs = &(nic_state->regs);
337 uint32_t total_len = 0;
343 uint32_t start = nregs->pgstart << 8;
344 uint32_t stop = nregs->pgstop << 8;
346 //PrintDebug("VNIC: received packet, len=%d\n", length);
348 if (nregs->cmd & NE2K_STOP) {
352 if (vnic_rxbuf_full(dev)){
353 PrintDebug("VNIC: received buffer overflow\n");
357 // if too small buffer, expand it
358 if (length < MIN_BUF_SIZE) {
359 memcpy(buf, pkt, length);
360 memset(buf + length, 0, MIN_BUF_SIZE - length);
364 length = MIN_BUF_SIZE;
367 index = nregs->curpag << 8;
370 total_len = length + 4;
372 // address for next packet (4 bytes for CRC)
373 next = index + ((total_len + 4 + 255) & ~0xff);
376 next -= stop - start;
379 p = nic_state->mem + index;
380 nregs->rsr = ENRSR_RXOK;
383 nregs->rsr |= ENRSR_PHY;
389 p[3] = total_len >> 8;
395 empty = stop - index;
406 memcpy(nic_state->mem + index, pkt, len);
417 nregs->curpag = next >> 8;
419 nregs->isr |= ENISR_RX;
420 vnic_update_irq(dev);
425 void pci_vnic_init(PCIBus * bus, NICInfo * nd, int devfn)
427 PCINE2000State * d = NULL;
428 NE2000State * s = NULL;
429 uint8_t * pci_conf = NULL;
430 struct pci_device * pdev = pci_register_device(bus,
431 "NE2000", sizeof(PCINE2000State),
434 pci_conf = d->dev.config;
436 pci_conf[0x00] = 0xec; // Realtek 8029
437 pci_conf[0x01] = 0x10;
438 pci_conf[0x02] = 0x29;
439 pci_conf[0x03] = 0x80;
440 pci_conf[0x0a] = 0x00; // ethernet network controller
441 pci_conf[0x0b] = 0x02;
442 pci_conf[0x0e] = 0x00; // header_type
443 pci_conf[0x3d] = 1; // interrupt pin 0
445 pci_register_io_region(&d->dev, 0, 0x100,
446 PCI_ADDRESS_SPACE_IO, ne2000_map);
449 s->irq = d->dev.irq[0];
451 s->pci_dev = (PCIDevice *)d;
453 memcpy(s->macaddr, nd->macaddr, 6);
457 s->vc = qemu_new_vlan_client(nd->vlan, ne2000_receive,
458 ne2000_can_receive, s);
460 snprintf(s->vc->info_str, sizeof(s->vc->info_str),
461 "ne2000 pci macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
469 /* XXX: instance number ? */
470 register_savevm("ne2000", 0, 3, ne2000_save, ne2000_load, s);
473 //End Here====================================
475 static int netif_input(uchar_t * pkt, uint_t size) {
477 struct vm_device * dev = NULL;
479 PrintDebug("\nVNIC: Packet Received:\nSource:");
481 for (i = 6; i < 12; i++) {
482 PrintDebug("%x ", pkt[i]);
485 dev = get_rx_dev(pkt);
493 for(i = 0; i < size; i++) {
494 PrintDebug("%x ", pkt[i]);
497 vnic_receive(dev, pkt, size);
503 static int vnic_ioport_write(ushort_t port,
506 struct vm_device * dev) {
508 struct nic_context *nic_state = (struct nic_context* )dev->private_data;
513 memcpy(&val, src, 1);
515 PrintDebug("vnic_write error: length %d\n", length);
521 PrintDebug("vnic_write: port:0x%x (%u bytes): 0x%x\n", port, length, (int)val);
523 if (port == EN0_COMMAND) {
524 nic_state->regs.cmd = val;
526 if (!(val & NE2K_STOP)) {
527 nic_state->regs.isr &= ~ENISR_RESET;
529 if ((val & (NE2K_DMAREAD | NE2K_DMAWRITE)) &&
530 nic_state->regs.rbcr == 0) {
531 nic_state->regs.isr |= ENISR_RDC;
532 vnic_update_irq(dev);
536 if (val & NE2K_TRANSMIT) {
537 index = (nic_state->regs.tpsr << 8);
539 if (index >= NE2K_PMEM_END) {
540 index -= NE2K_PMEM_SIZE;
543 if (index + nic_state->regs.tbcr <= NE2K_PMEM_END) {
544 vnic_send_packet(dev, nic_state->mem + index, nic_state->regs.tbcr);
547 nic_state->regs.tsr = ENTSR_PTX;
548 nic_state->regs.isr |= ENISR_TX;
549 nic_state->regs.cmd &= ~NE2K_TRANSMIT;
551 vnic_update_irq(dev);
556 page = nic_state->regs.cmd >> 6;
562 nic_state->regs.pgstart = val;
565 nic_state->regs.pgstop = val;
568 nic_state->regs.boundary = val;
571 nic_state->regs.tpsr = val;
574 nic_state->regs.tbcr = (nic_state->regs.tbcr & 0xff00) | val;
577 nic_state->regs.tbcr = (nic_state->regs.tbcr & 0x00ff) | (val << 8);
580 nic_state->regs.isr &= ~(val & 0x7f);
581 vnic_update_irq(dev);
584 nic_state->regs.rsar = (nic_state->regs.rsar & 0xff00) | val;
587 nic_state->regs.rsar = (nic_state->regs.rsar & 0x00ff) | (val << 8);
590 nic_state->regs.rbcr = (nic_state->regs.rbcr & 0xff00) | val;
593 nic_state->regs.rbcr = (nic_state->regs.rbcr & 0x00ff) | (val << 8);
596 nic_state->regs.rcr = val;
599 nic_state->regs.tcr = val;
601 nic_state->regs.dcr = val;
604 nic_state->regs.imr = val;
605 vnic_update_irq(dev);
608 PrintDebug("vnic_write error: invalid port:0x%x\n", port);
612 } else if (page == 1) {
615 case EN1_PHYS ... EN1_PHYS + 5:
616 nic_state->regs.phys[port - EN1_PHYS] = val;
619 nic_state->regs.curpag = val;
621 case EN1_MULT ... EN1_MULT + 7:
622 nic_state->regs.mult[port - EN1_MULT] = val;
625 PrintDebug("vnic_write error: invalid port:0x%x\n", port);
629 } else if (page == 2) {
633 nic_state->regs.clda = (nic_state->regs.clda & 0xff00) | val;
636 nic_state->regs.clda = (nic_state->regs.clda & 0x00ff) | (val << 8);
639 nic_state->regs.rnpp = val;
642 nic_state->regs.lnpp = val;
645 nic_state->regs.addcnt = (nic_state->regs.addcnt & 0xff00) | val;
648 nic_state->regs.addcnt = (nic_state->regs.addcnt & 0x00ff) | (val << 8);
651 PrintDebug("vnic_write error: invalid port:0x%x\n", port);
663 static int vnic_ioport_read(ushort_t port, void * dst, uint_t length, struct vm_device *dev) {
667 struct nic_context *nic_state = (struct nic_context* )dev->private_data;
670 PrintDebug("vnic_read error: length %d\n", length);
676 if (port == EN0_COMMAND) {
677 val = nic_state->regs.cmd;
679 page = nic_state->regs.cmd >> 6;
685 val = nic_state->regs.clda & 0x00ff;
688 val = (nic_state->regs.clda & 0xff00) >> 8;
691 val = nic_state->regs.boundary;
694 val = nic_state->regs.tsr;
697 val = nic_state->regs.ncr;
700 val = nic_state->regs.fifo;
703 val = nic_state->regs.isr;
704 vnic_update_irq(dev);
707 val = nic_state->regs.crda & 0x00ff;
710 val = (nic_state->regs.crda & 0xff00) >> 8;
713 val = nic_state->regs.rsr;
716 val = nic_state->regs.cntr & 0x000000ff;
719 val = (nic_state->regs.cntr & 0x0000ff00) >> 8;
722 val = (nic_state->regs.cntr & 0x00ff0000) >> 16;
725 PrintDebug("vnic_read error: invalid port:0x%x\n", port);
730 } else if (page == 1) {
733 case EN1_PHYS ... EN1_PHYS + 5:
734 val = nic_state->regs.phys[port - EN1_PHYS];
737 val = nic_state->regs.curpag;
739 case EN1_MULT ... EN1_MULT + 7:
740 val = nic_state->regs.mult[port - EN1_MULT];
743 PrintDebug("vnic_read error: invalid port:0x%x\n", port);
748 } else if (page == 2) {
752 val = nic_state->regs.pgstart;
755 val = nic_state->regs.pgstop;
758 val = nic_state->regs.rnpp;
761 val = nic_state->regs.lnpp;
764 val = nic_state->regs.tpsr;
767 val = nic_state->regs.addcnt & 0x00ff;
770 val = (nic_state->regs.addcnt & 0xff00) >> 8;
773 val = nic_state->regs.rcr;
776 val = nic_state->regs.tcr;
779 val = nic_state->regs.dcr;
782 val = nic_state->regs.imr;
785 PrintDebug("vnic_read error: invalid port:0x%x\n", port);
792 memcpy(dst, &val, 1);
794 PrintDebug("vnic_read: port:0x%x (%u bytes): 0x%x\n", port,length, (uint32_t)val);
805 static void vnic_dma_update(struct vm_device * dev, int len) {
806 struct nic_context *nic_state = (struct nic_context *)dev->private_data;
808 nic_state->regs.rsar += len;
811 if (nic_state->regs.rsar == nic_state->regs.pgstop) {
812 nic_state->regs.rsar = nic_state->regs.pgstart;
815 if (nic_state->regs.rbcr <= len) {
816 nic_state->regs.rbcr = 0;
817 nic_state->regs.isr |= ENISR_RDC;
819 vnic_update_irq(dev);
821 nic_state->regs.rbcr -= len;
826 //for data port read/write
827 static int vnic_data_read(ushort_t port,
830 struct vm_device * dev) {
832 struct nic_context *nic_state = (struct nic_context *)dev->private_data;
834 // current dma address
835 uint32_t addr = nic_state->regs.rsar;
839 val = vnic_mem_readb(nic_state, addr);
842 val = vnic_mem_readw(nic_state, addr);
845 val = vnic_mem_readl(nic_state, addr);
848 PrintDebug("vnic_data_read error: invalid length %d\n", length);
852 vnic_dma_update(dev, length);
854 memcpy(dst, &val, length);
856 PrintDebug("vnic_read: port:0x%x (%u bytes): 0x%x", port & 0x1f, length, val);
861 static int vnic_data_write(ushort_t port,
864 struct vm_device * dev) {
866 struct nic_context * nic_state = (struct nic_context *)dev->private_data;
868 uint32_t addr = nic_state->regs.rsar;
870 if (nic_state->regs.rbcr == 0) {
874 memcpy(&val, src, length);
876 //determine the starting address of reading/writing
881 vnic_mem_writeb(nic_state, addr, val);
884 vnic_mem_writew(nic_state, addr, val);
887 vnic_mem_writel(nic_state, addr, val);
890 PrintDebug("nic_data_write error: invalid length %d\n", length);
893 vnic_dma_update(dev, length);
895 PrintDebug("vnic_write: port:0x%x (%u bytes): 0x%x\n", port & 0x1f,length, val);
900 static int vnic_reset_device(struct vm_device * dev) {
902 PrintDebug("vnic: reset device\n");
904 init_vnic_context(dev);
911 static int vnic_reset_port_read(ushort_t port, void * dst, uint_t length, struct vm_device * dev) {
914 PrintDebug("vnic_read: port:0x%x (%u bytes): 0x%x\n", port,length, val);
915 memcpy(dst, &val, length);
917 vnic_reset_device(dev);
922 static int vnic_reset_port_write(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
925 PrintDebug("vnic_write: port:0x%x (%u bytes): 0x%x\n", port,length, val);
926 memcpy(&val, src, length);
932 static int vnic_start_device(struct vm_device * dev) {
933 PrintDebug("vnic: start device\n");
938 static int vnic_stop_device(struct vm_device * dev) {
939 PrintDebug("vnic: stop device\n");
943 static void init_phy_network() {
944 V3_REGISTER_PKT_DELIVERY(&netif_input);
947 static int vnic_init_device(struct vm_device * dev) {
950 PrintDebug("vnic: init_device\n");
953 init_vnic_context(dev);
957 for (i = 0; i < 16; i++) {
958 v3_dev_hook_io(dev, NIC_BASE_ADDR + i, &vnic_ioport_read, &vnic_ioport_write);
961 v3_dev_hook_io(dev, NIC_BASE_ADDR + NIC_DATA_PORT, &vnic_data_read, &vnic_data_write);
962 v3_dev_hook_io(dev, NIC_BASE_ADDR + NIC_RESET_PORT, &vnic_reset_port_read, &vnic_reset_port_write);
969 static int vnic_deinit_device(struct vm_device * dev) {
972 for (i = 0; i < 16; i++){
973 v3_dev_unhook_io(dev, NIC_BASE_ADDR + i);
976 v3_dev_unhook_io(dev, NIC_BASE_ADDR + NIC_DATA_PORT);
977 v3_dev_unhook_io(dev, NIC_BASE_ADDR + NIC_RESET_PORT);
979 //vnic_reset_device(dev);
985 static struct vm_device_ops dev_ops = {
986 .init = vnic_init_device,
987 .deinit = vnic_deinit_device,
988 .reset = vnic_reset_device,
989 .start = vnic_start_device,
990 .stop = vnic_stop_device,
994 struct vm_device * v3_create_vnic() {
995 struct nic_context * nic_state = V3_Malloc(sizeof(struct nic_context));
997 //memset(nic_state, 0, sizeof(struct nic_context));
999 //PrintDebug("VNIC internal at %x\n",(int)nic_state);
1001 struct vm_device *device = v3_create_device("VNIC", &dev_ops, nic_state);