First run at an E1000 driver, with various LWIP fixes.
[akaros.git] / kern / arch / i686 / ne2k.c
1 /*
2  * Copyright (c) 2009 The Regents of the University of California
3  * See LICENSE for details.
4  */
5
6 #ifdef __SHARC__
7 #pragma nosharc
8 #endif
9
10 #include <arch/mmu.h>
11 #include <arch/x86.h>
12 #include <arch/smp.h>
13 #include <arch/apic.h>
14 #include <arch/pci.h>
15 #include <arch/ne2k.h>
16
17 #include <ros/memlayout.h>
18
19 #include <atomic.h>
20 #include <stdio.h>
21 #include <string.h>
22 #include <trap.h>
23 #include <kmalloc.h>
24
25 #include <pmap.h>
26 #include <timing.h>
27
28 /** @file
29  * @brief NE2K Driver Sketch
30  *
31  * EXPERIMENTAL.
32  *
33  * Rough driver. Appears to work in QEMU. Probably completely broken under heavy load.
34  *
35  * @author Paul Pearce <pearce@eecs.berkeley.edu>
36  *
37  * @todo Everything
38  */
39
40 #define NE2K_RESET_R_ADDR 0x1f
41 #define NE2K_PG0_RW_CR  0x00
42 #define NE2K_PG0_RW_ISR 0x07
43 #define NE2K_PG0_W_IMR  0x0F
44 #define NE2K_PG0_W_PSTRT 0x1
45 #define NE2K_PG0_W_PSTP 0x2
46 #define NE2K_PG0_W_RCR 0xC
47 #define NE2K_PG0_R_RSR 0xC
48 #define NE2K_PG0_R_TSR 0x4
49 #define NE2K_PG0_W_TCR 0xD
50 #define NE2K_PG1_RW_PAR 0x1
51 #define NE2K_PG0_W_RSAR0 0x08
52 #define NE2K_PG0_W_RSAR1 0x09
53 #define NE2K_PG0_W_RBCR0 0x0A
54 #define NE2K_PG0_W_RBCR1 0x0B
55 #define NE2K_PG0_W_TBCR0 0x05
56 #define NE2K_PG0_W_TBCR1 0x06
57 #define NE2K_PG0_W_TPSR  0x04
58 #define NE2K_PG0_W_DCR 0x0E
59 #define NE2K_PG1_RW_CURR 0x07
60 #define NE2K_PG0_RW_BNRY 0x03
61
62 #define NE2K_PAGE_SIZE 256
63
64 #define NE2K_PMEM_START   (16*1024)
65 #define NE2K_PMEM_SIZE    (32*1024)
66 #define NE2K_NUM_PAGES          ((NE2K_PMEM_SIZE - NE2K_PMEM_START) / NE2K_PAGE_SIZE)
67 #define NE2K_NUM_RECV_PAGES     (NE2K_NUM_PAGES / 2)
68 #define NE2K_NUM_SEND_PAGES     (NE2K_NUM_PAGES / 2)
69 #define NE2K_FIRST_RECV_PAGE    (NE2K_PMEM_START / NE2K_PAGE_SIZE)
70 #define NE2K_LAST_RECV_PAGE     NE2K_FIRST_RECV_PAGE + NE2K_NUM_RECV_PAGES
71 #define NE2K_FIRST_SEND_PAGE    NE2K_LAST_RECV_PAGE + 1
72
73
74 #define SET_PAGE_0() (inb(ne2k_io_base_addr + NE2K_PG0_RW_CR) & 0x3F)
75
76 uint32_t ne2k_irq;      // Fix this
77 uint32_t ne2k_io_base_addr;
78
79 void* base_page;
80 uint32_t num_pages = 0;
81
82 void ne2k_init() {
83         
84         if (ne2k_scan_pci() < 0) return;
85         ne2k_mem_alloc();
86         ne2k_configure_nic();
87         ne2k_read_mac();
88         printk("Network Card MAC Address: %02x:%02x:%02x:%02x:%02x:%02x\n", 
89            device_mac[0],device_mac[1],device_mac[2],
90            device_mac[3],device_mac[4],device_mac[5]);
91         //ne2k_test_interrupts();
92         send_frame = &ne2k_send_frame;
93
94         ne2k_setup_interrupts();
95
96         eth_up = 1;
97
98         return;
99 }
100
101
102 int ne2k_scan_pci() {
103         
104         extern pci_dev_entry_t pci_dev_map[PCI_MAX_BUS][PCI_MAX_DEV][PCI_MAX_FUNC];
105         extern uint16_t pci_irq_map[PCI_MAX_BUS][PCI_MAX_DEV][PCI_MAX_FUNC];
106
107         cprintf("Searching for NE2000 Network device...");
108
109         for (int i = 0; i < PCI_MAX_BUS; i++)
110                 for (int j = 0; j < PCI_MAX_DEV; j++)
111                         for (int k = 0; k < PCI_MAX_FUNC; k++) {
112                                 uint32_t address;
113                                 uint32_t lbus = i;
114                                 uint32_t ldev = j;
115                                 uint32_t lfunc = k;
116                                 uint32_t lreg = 0; 
117                                 uint32_t result  = 0;
118         
119                                 uint16_t dev_id = pci_dev_map[i][j][k].dev_id;
120                                 uint16_t ven_id = pci_dev_map[i][j][k].ven_id;
121
122                                 // Vender DNE
123                                 if (ven_id == INVALID_VENDOR_ID) 
124                                         continue;
125
126                                 // Ignore non RealTek 8168 Devices
127                                 if (ven_id != NE2K_VENDOR_ID || dev_id != NE2K_DEV_ID)
128                                         continue;
129                                 cprintf(" found on BUS %x DEV %x\n", i, j);
130
131                                 // Find the IRQ
132                                 ne2k_irq = pci_irq_map[i][j][k];
133                                 ne2k_debug("-->IRQ: %u\n", ne2k_irq);
134
135                                 // Loop over the BARs
136                                 for (int k = 0; k <= 5; k++) {
137                                         lreg = 4 + k;
138                                         address = MK_CONFIG_ADDR(lbus, ldev, lfunc, lreg << 2); 
139                                 outl(PCI_CONFIG_ADDR, address);
140                                 result = inl(PCI_CONFIG_DATA);
141                                         
142                                         if (result == 0) // (0 denotes no valid data)
143                                                 continue;
144
145                                         // Read the bottom bit of the BAR. 
146                                         if (result & PCI_BAR_IO_MASK) {
147                                                 result = result & PCI_IO_MASK;
148                                                 ne2k_debug("-->BAR%u: %s --> %x\n", k, "IO", result);
149                                         } else {
150                                                 result = result & PCI_MEM_MASK;
151                                                 ne2k_debug("-->BAR%u: %s --> %x\n", k, "MEM", result);
152                                         }
153                         
154                                         // TODO Switch to memory mapped instead of IO?
155                                         if (k == 0) // BAR0 denotes the IO Addr for the device
156                                                 ne2k_io_base_addr = result;                                             
157                                 }
158                                 
159                 return 0;
160         }
161         cprintf(" not found. No device configured.\n");
162         
163         return -1;
164 }
165
166 void ne2k_configure_nic() {
167         
168         ne2k_debug("-->Configuring Device.\n");
169         
170         // Reset. Yes reading from this addr resets it
171         inb(ne2k_io_base_addr + NE2K_RESET_R_ADDR);
172
173         // Configure
174         outb(ne2k_io_base_addr + NE2K_PG0_RW_CR,  0x22);
175         outb(ne2k_io_base_addr + NE2K_PG0_W_PSTRT,  NE2K_FIRST_RECV_PAGE);
176         outb(ne2k_io_base_addr + NE2K_PG0_RW_BNRY, NE2K_FIRST_RECV_PAGE + 1);
177
178         outb(ne2k_io_base_addr + NE2K_PG0_RW_CR, (0x22 & 0x3F) | 0x40);
179         outb(ne2k_io_base_addr + NE2K_PG1_RW_CURR, NE2K_FIRST_RECV_PAGE + 2);
180         outb(ne2k_io_base_addr + NE2K_PG0_RW_CR, 0x22);
181         outb(ne2k_io_base_addr + NE2K_PG0_W_PSTP, NE2K_LAST_RECV_PAGE);
182         outb(ne2k_io_base_addr + NE2K_PG0_W_DCR, 0x94); 
183         outb(ne2k_io_base_addr + NE2K_PG0_RW_CR,  0x22);
184         
185         outb(ne2k_io_base_addr + NE2K_PG0_W_RCR,  0xDF);
186         outb(ne2k_io_base_addr + NE2K_PG0_W_TCR,  0xE0);
187         
188
189         //uint8_t isr = inb(ne2k_io_base_addr + NE2K_PG0_RW_ISR);
190         //cprintf("isr: %x\n", isr);
191
192         
193         return;
194 }
195
196 void ne2k_setup_interrupts() {
197         
198         extern handler_t interrupt_handlers[];
199         
200         ne2k_debug("-->Setting interrupts.\n");
201         
202         // Kernel based interrupt stuff
203         register_interrupt_handler(interrupt_handlers, KERNEL_IRQ_OFFSET + ne2k_irq, ne2k_interrupt_handler, (void *)0);
204         
205         ioapic_route_irq(ne2k_irq, 1);  
206         
207         SET_PAGE_0();
208
209         outb(ne2k_io_base_addr + NE2K_PG0_W_IMR,  0xBF);
210
211         outb(ne2k_io_base_addr + NE2K_PG0_RW_ISR, 0xFF);
212         return;
213 }
214
215 void ne2k_mem_alloc() {
216         
217         num_pages = ROUNDUP(NE2K_NUM_PAGES * NE2K_PAGE_SIZE, PGSIZE) / PGSIZE;
218         base_page = get_cont_pages(LOG2_UP(num_pages), 0);      
219 }
220
221 void ne2k_read_mac() {
222
223         uint8_t cr = inb(ne2k_io_base_addr + NE2K_PG0_RW_CR);
224         
225         // Set correct bits
226         outb(ne2k_io_base_addr + NE2K_PG0_RW_CR, 0xA);
227         outb(ne2k_io_base_addr + NE2K_PG0_W_RSAR0, 0x0);
228         outb(ne2k_io_base_addr + NE2K_PG0_W_RSAR1, 0x0);
229         outb(ne2k_io_base_addr + NE2K_PG0_W_RBCR0, 0x6);
230         outb(ne2k_io_base_addr + NE2K_PG0_W_RBCR1, 0x0);
231
232
233         for (int i = 0; i < 6; i++)
234                 device_mac[i] = inb(ne2k_io_base_addr + 0x10) & inb(ne2k_io_base_addr + 0x10);
235
236         // Set page 1
237         outb(ne2k_io_base_addr + NE2K_PG0_RW_CR, (cr & 0x3F) | 0x40);
238
239         for (int i = 0; i < 6; i++) 
240            outb(ne2k_io_base_addr + NE2K_PG1_RW_PAR + i, device_mac[i]);
241
242         
243         ne2k_debug("-->DEVICE MAC: %02x:%02x:%02x:%02x:%02x:%02x\n", 0xFF & device_mac[0], 0xFF & device_mac[1],        
244                                                                     0xFF & device_mac[2], 0xFF & device_mac[3], 
245                                                                 0xFF & device_mac[4], 0xFF & device_mac[5]);
246         // Restore old setting.
247         outb(ne2k_io_base_addr + NE2K_PG0_RW_CR, cr);
248         return;
249 }
250
251 void ne2k_test_interrupts() {
252         
253         cprintf("Generating Interrupt...\n");
254         outb(ne2k_io_base_addr + 0x0A, 0x00);
255         outb(ne2k_io_base_addr + 0x0B, 0x00);
256         outb(ne2k_io_base_addr + 0x00, 0x0A);
257         udelay(10000000);
258
259         cprintf("Generating Interrupt again...\n");
260         outb(ne2k_io_base_addr + 0x0A, 0x00);
261         outb(ne2k_io_base_addr + 0x0B, 0x00);
262         outb(ne2k_io_base_addr + 0x00, 0x0A);
263         udelay(10000000);
264         
265 }
266
267 // We need to evaluate this routine in terms of concurrency.
268 // We also need to figure out whats up with different core interrupts
269 void ne2k_interrupt_handler(trapframe_t *tf, void* data) {
270         
271         ne2k_interrupt_debug("\nNE2K interrupt on core %u!\n", lapic_get_id());
272
273         SET_PAGE_0();
274
275         uint8_t isr= inb(ne2k_io_base_addr + NE2K_PG0_RW_ISR);
276         ne2k_interrupt_debug("isr: %x\n", isr);
277         
278         while (isr != 0x0) {
279
280                 // TODO: Other interrupt cases.
281
282                 if (isr & 0x1) {
283                         ne2k_interrupt_debug("-->Packet received.\n");
284                         ne2k_handle_rx_packet();
285                 }
286                 
287                 SET_PAGE_0();
288
289                 // Clear interrupts
290                 isr = inb(ne2k_io_base_addr + NE2K_PG0_RW_ISR);
291                 outb(ne2k_io_base_addr + NE2K_PG0_RW_ISR, isr);
292
293         }
294
295         ne2k_handle_rx_packet();
296         
297         return;                         
298 }
299
300 // @TODO: Is this broken? Didn't change it after kmalloc changed
301 void ne2k_handle_rx_packet() {
302         
303         SET_PAGE_0();
304
305         uint8_t bound = inb(ne2k_io_base_addr + NE2K_PG0_RW_BNRY);
306
307         uint8_t cr = inb(ne2k_io_base_addr + NE2K_PG0_RW_CR);
308         
309         // Set page 1
310         outb(ne2k_io_base_addr + NE2K_PG0_RW_CR, (cr & 0x3F) | 0x40);
311
312         uint8_t next = inb(ne2k_io_base_addr + NE2K_PG1_RW_CURR);
313
314         // Restore old setting.
315         outb(ne2k_io_base_addr + NE2K_PG0_RW_CR, cr);
316
317         uint8_t start = NE2K_FIRST_RECV_PAGE;
318         uint8_t stop = NE2K_LAST_RECV_PAGE;
319
320         // Broken mult packets?
321         if (((bound + 1) == next) || (((bound + 1) == stop) && (start == next))) {
322                 ne2k_debug("NO PACKET TO PROCESS\n");
323                 return;
324         }
325
326         uint32_t kmalloc_size;
327
328         if (MAX_FRAME_SIZE % NE2K_PAGE_SIZE) {
329                 kmalloc_size = ((MAX_FRAME_SIZE / NE2K_PAGE_SIZE) + 1) * NE2K_PAGE_SIZE;
330         } else {
331                 kmalloc_size = MAX_FRAME_SIZE;
332         }
333         
334         char *rx_buffer = kmalloc(kmalloc_size, 0);
335         
336         if (rx_buffer == NULL) panic ("Can't allocate page for incoming packet.");
337
338         uint8_t curr = bound + 1;
339
340         uint8_t header[4];
341         uint16_t packet_len = 0xFFFF;
342         uint16_t page_count = 0;
343         for (int i = 0, n = 0; i < (MAX_FRAME_SIZE / NE2K_PAGE_SIZE); i++) {
344                 if (curr == stop)
345                         curr = start;                   
346
347                 outb(ne2k_io_base_addr + NE2K_PG0_W_RSAR0, 0x0);
348                 outb(ne2k_io_base_addr + NE2K_PG0_W_RSAR1, curr);
349
350
351                 // Fix this. Its hard coded to 256
352                 outb(ne2k_io_base_addr + NE2K_PG0_W_RBCR0, 0);
353                 outb(ne2k_io_base_addr + NE2K_PG0_W_RBCR1, 0x1);
354         
355                 outb(ne2k_io_base_addr + NE2K_PG0_RW_CR, 0x0A);
356
357                 for (int j = 0; j < NE2K_PAGE_SIZE; j++) {
358                         uint8_t val = inb(ne2k_io_base_addr + 0x10);
359                         if ((i == 0) && (j < 4)) {
360                                 header[j] = val;
361                         } else { 
362                                 rx_buffer[n++] = val;
363                         }
364                 }
365
366                 if (i == 0) {
367                         packet_len = ((uint16_t)header[3] << 8) | (uint16_t)header[2];
368                         if (packet_len % NE2K_PAGE_SIZE) {
369                                 page_count = (packet_len / NE2K_PAGE_SIZE) + 1;
370                         } else {
371                                 page_count = (packet_len / NE2K_PAGE_SIZE);
372                         }
373                 }
374                 
375                 if ((i + 1) == page_count)
376                         break;
377
378                 curr++;
379         
380         }
381         outb(ne2k_io_base_addr + NE2K_PG0_RW_BNRY, curr);
382
383         if (packet_len == 0) {
384                 ne2k_debug("Triggered on an empty packet.\n");
385                 return;
386         }
387
388
389         // Treat as a syscall frontend response packet if eth_type says so
390         // Will eventually go away, so not too worried about elegance here...
391         #include <frontend.h>
392         #include <arch/frontend.h>
393         uint16_t eth_type = htons(*(uint16_t*)(rx_buffer + 12));
394         if(eth_type == APPSERVER_ETH_TYPE) {
395                 handle_appserver_packet(rx_buffer, packet_len);
396                 kfree(rx_buffer);
397                 return;
398         }
399
400         spin_lock(&packet_buffers_lock);
401
402         if (num_packet_buffers >= MAX_PACKET_BUFFERS) {
403                 printk("WARNING: DROPPING PACKET!\n");
404                 spin_unlock(&packet_buffers_lock);
405                 kfree(rx_buffer);
406                 return;
407         }
408
409         packet_buffers[packet_buffers_tail] = rx_buffer;
410         packet_buffers_sizes[packet_buffers_tail] = packet_len;
411
412         packet_buffers_tail = (packet_buffers_tail + 1) % MAX_PACKET_BUFFERS;
413         num_packet_buffers++;
414
415         spin_unlock(&packet_buffers_lock);
416         
417         return;
418 }
419
420 // copied with love (and modification) from tcp/ip illistrated vl 2 1995 pg 236
421 // bsd licenced
422 uint16_t cksum(char *CT(len) ip, int len) {
423         
424         uint32_t sum = 0;
425         // Next two lines for ivy. Grr.
426         char *curr_ip = ip;
427         int curr_len = len;
428
429         while(curr_len > 1) {
430                 sum += *((uint16_t*) curr_ip);
431                 curr_ip = curr_ip + 2;
432                 
433                 if(sum & 0x80000000)    /* if high order bit set, fold */
434                         sum = (sum & 0xFFFF) + (sum >> 16);
435                         curr_len -= 2;
436                 }
437
438                 if(curr_len)             /* take care of left over byte */
439                         sum += *curr_ip;
440                   
441                 while(sum>>16)
442                         sum = (sum & 0xFFFF) + (sum >> 16);
443
444                 return ~sum;
445 }
446
447
448 // Main routine to send a frame. May be completely broken.
449 int ne2k_send_frame(const char *data, size_t len) {
450
451         if (data == NULL)
452                 return -1;
453         if (len == 0)
454                 return 0;
455
456
457         if (len > MAX_FRAME_SIZE) {
458                 ne2k_frame_debug("-->Frame Too Large!\n");
459                 return -1;
460         }
461
462         outb(ne2k_io_base_addr + NE2K_PG0_W_IMR,  0x00);
463
464
465         // The TPSR takes a page #
466         // The RSAR takes a byte offset, but since a page is 256 bits
467         // and we are writing on page boundries, the low bits are 0, and
468         // the high bits are a page #
469         outb(ne2k_io_base_addr + NE2K_PG0_W_TPSR, NE2K_FIRST_SEND_PAGE);
470         outb(ne2k_io_base_addr + NE2K_PG0_W_RSAR0, 0x0);
471         outb(ne2k_io_base_addr + NE2K_PG0_W_RSAR1, NE2K_FIRST_SEND_PAGE);
472
473         
474         outb(ne2k_io_base_addr + NE2K_PG0_W_TBCR0, len & 0xFF);
475         outb(ne2k_io_base_addr + NE2K_PG0_W_TBCR1, len >> 8);
476
477         outb(ne2k_io_base_addr + NE2K_PG0_W_RBCR0, len & 0xFF);
478         outb(ne2k_io_base_addr + NE2K_PG0_W_RBCR1, len >> 8);
479
480         
481         outb(ne2k_io_base_addr + NE2K_PG0_RW_CR,  0x12);
482         
483
484         for (int i = 0; i<len; i = i + 1) {
485                 outb(ne2k_io_base_addr + 0x10, *(uint8_t*)(data + i));
486                 //ne2k_debug("sent: %x\n", *(uint8_t*)(data + i));
487         }
488         
489         while(( inb(ne2k_io_base_addr + NE2K_PG0_RW_ISR) & 0x40) == 0);
490
491         outb(ne2k_io_base_addr + NE2K_PG0_RW_ISR,  0x40);
492
493         outb(ne2k_io_base_addr + NE2K_PG0_W_IMR,  0xBF);
494
495         outb(ne2k_io_base_addr + NE2K_PG0_RW_CR,  0x1E);
496         
497         
498         return len;
499 }
500