5c75b69fc10c215ec6132ed176b751474b4e9c3b
[akaros.git] / kern / arch / i686 / rl8168.c
1 /** @filec
2  * @brief RL8168 Driver       
3  *
4  * EXPERIMENTAL. DO NOT USE IF YOU DONT KNOW WHAT YOU ARE DOING
5  *
6  * See Info below 
7  *
8  * @author Paul Pearce <pearce@eecs.berkeley.edu>
9  *
10  */
11
12 #ifdef __SHARC__
13 #pragma nosharc
14 #endif
15
16 #include <arch/mmu.h>
17 #include <arch/x86.h>
18 #include <arch/smp.h>
19 #include <arch/apic.h>
20 #include <arch/pci.h>
21 #include <arch/rl8168.h>
22
23 #include <ros/memlayout.h>
24
25 #include <atomic.h>
26 #include <stdio.h>
27 #include <string.h>
28 #include <trap.h>
29 #include <kmalloc.h>
30
31 #include <pmap.h>
32
33 /** @file
34  * @brief Realtek RL8168 Driver
35  *
36  * EXPERIMENTAL. DO NOT USE IF YOU DONT KNOW WHAT YOU ARE DOING
37  *
38  * This is a function rl8168 driver, that uses some really ugly hacks to achieve
39  * UDP communication with a remote syscall server, without a network stack.
40  *
41  * To enable use, define __NETWORK__ in your Makelocal
42  *
43  * @author Paul Pearce <pearce@eecs.berkeley.edu>
44  *
45  * @todo Move documention below into doxygen format.
46  * @todo See list in code
47  */
48
49
50 /* RealTek 8168d (8111d) NIC Driver
51  *
52  * Written by Paul Pearce.
53  *
54  * This is a really rough "driver". Really, its not a driver, just a kernel hack to give
55  * the kernel a way to receive and send packets. The basis of the init code is the OSDEV
56  * page on the 8169 chipset, which is a varient of this chipset (most 8169 drivers work 
57  * on the 8168d). http://wiki.osdev.org/RTL8169
58  * 
59  * Basic ideas (although no direct code) were gleamed from the OpenBSD re(4) driver,
60  * which can be found in sys/dev/ic/re.c. sys/dev/ic/rtl81x9reg.h is needed to make
61  * sense of the constants used in re.c.
62  *
63  * This is an ongoing work in progress. Main thing is we need a kernel interface for PCI
64  * devices and network devices, that we can hook into, instead of providing arbitary functions
65  * 
66  * TODO: Remove hacky syscall hack stuff (once we get a real stack).
67  * TODO: Jumbo frame support
68  * TODO: Use high priority transmit ring for syscall stuff.
69  * TODO: Discuss panic conditions.
70  * TODO: Shutdown cleanup kfrees()
71  * TODO: Use onboard timer interrupt to check for packets, instead of writing a bit each time we have a packet.
72  * TODO: CONCURRENCY!
73  */
74
75 struct Descriptor
76 {
77     unsigned int command,  /* command/status dword */
78                  vlan,     /* currently unused */
79                  low_buf,  /* low 32-bits of physical buffer address */
80                  high_buf; /* high 32-bits of physical buffer address */
81 };
82
83
84 uint32_t rl8168_io_base_addr = 0;
85 uint32_t rl8168_irq = 0;
86 char device_mac[6];
87
88 struct Descriptor *CT(NUM_RX_DESCRIPTORS) rx_des_kva;
89 unsigned long rx_des_pa;
90
91 struct Descriptor *CT(NUM_TX_DESCRIPTORS) tx_des_kva;
92 unsigned long tx_des_pa;
93
94 uint32_t rx_des_cur = 0;
95 uint32_t tx_des_cur = 0;
96
97 extern int eth_up;
98 extern uint32_t packet_buffer_count;
99 extern char* packet_buffer[PACKET_BUFFER_SIZE];
100 extern uint32_t packet_buffer_sizes[PACKET_BUFFER_SIZE];
101 extern uint32_t packet_buffer_head;
102 extern uint32_t packet_buffer_tail;
103 spinlock_t packet_buffer_lock;
104
105 extern char *CT(PACKET_HEADER_SIZE + len) (*packet_wrap)(const char *CT(len) data, size_t len);
106 extern int (*send_frame)(const char *CT(len) data, size_t len);
107
108
109 void rl8168_init() {
110
111         if (rl8168_scan_pci() < 0) return;
112         rl8168_read_mac();
113         rl8168_setup_descriptors();
114         rl8168_configure();
115         rl8168_setup_interrupts();
116         send_frame = &rl8168_send_frame;
117
118         eth_up = 1;
119         
120         //Trigger sw based nic interrupt
121 /*      cprintf("Generating interrupt...\n");
122         outb(rl8168_io_base_addr + 0x38, 0x1);
123         cprintf("sleeping\n");
124         udelay(3000000);
125         cprintf("done\n");
126 */
127         return;
128 }
129
130
131 int rl8168_scan_pci() {
132         
133         extern pci_dev_entry_t pci_dev_map[PCI_MAX_BUS][PCI_MAX_DEV][PCI_MAX_FUNC];
134         extern uint16_t pci_irq_map[PCI_MAX_BUS][PCI_MAX_DEV][PCI_MAX_FUNC];
135
136         cprintf("Searching for RealTek 8168 Network device...");
137
138         for (int i = 0; i < PCI_MAX_BUS; i++)
139                 for (int j = 0; j < PCI_MAX_DEV; j++)
140                         for (int k = 0; k < PCI_MAX_FUNC; k++) {
141                                 uint32_t address;
142                                 uint32_t bus = i;
143                                 uint32_t dev = j;
144                                 uint32_t func = k;
145                                 uint32_t reg = 0; 
146                                 uint32_t result  = 0;
147         
148                                 uint16_t dev_id = pci_dev_map[i][j][k].dev_id;
149                                 uint16_t ven_id = pci_dev_map[i][j][k].ven_id;
150
151                                 // Vender DNE
152                                 if (ven_id == INVALID_VENDOR_ID) 
153                                         continue;
154
155                                 // Ignore non RealTek 8168 Devices
156                                 if (ven_id != REALTEK_VENDOR_ID || dev_id != REALTEK_DEV_ID)
157                                         continue;
158                                 cprintf(" found on BUS %x DEV %x\n", i, j);
159
160                                 // Find the IRQ
161                                 rl8168_irq = pci_irq_map[i][j][k];
162                                 rl8168_debug("-->IRQ: %u\n", rl8168_irq);
163
164                                 // Loop over the BARs
165                                 for (int k = 0; k <= 5; k++) {
166                                         reg = 4 + k;
167                                         address = MK_CONFIG_ADDR(bus, dev, func, reg << 2);     
168                                 outl(PCI_CONFIG_ADDR, address);
169                                 result = inl(PCI_CONFIG_DATA);
170                                         
171                                         if (result == 0) // (0 denotes no valid data)
172                                                 continue;
173
174                                         // Read the bottom bit of the BAR. 
175                                         if (result & PCI_BAR_IO_MASK) {
176                                                 result = result & PCI_IO_MASK;
177                                                 rl8168_debug("-->BAR%u: %s --> %x\n", k, "IO", result);
178                                         } else {
179                                                 result = result & PCI_MEM_MASK;
180                                                 rl8168_debug("-->BAR%u: %s --> %x\n", k, "MEM", result);
181                                         }
182                         
183                                         // TODO Switch to memory mapped instead of IO?
184                                         if (k == 0) // BAR0 denotes the IO Addr for the device
185                                                 rl8168_io_base_addr = result;                                           
186                                 }
187                 
188                 rl8168_debug("-->hwrev: %x\n", inl(rl8168_io_base_addr + RL_HWREV_REG) & RL_HWREV_MASK);
189                 
190                 return 0;
191         }
192         cprintf(" not found. No device configured.\n");
193         
194         return -1;
195 }
196
197 void rl8168_read_mac() {
198         
199         for (int i = 0; i < 6; i++)
200            device_mac[i] = inb(rl8168_io_base_addr + RL_MAC_OFFSET + i); 
201         
202         rl8168_debug("-->DEVICE MAC: %02x:%02x:%02x:%02x:%02x:%02x\n", 0xFF & device_mac[0], 0xFF & device_mac[1],      
203                                                                     0xFF & device_mac[2], 0xFF & device_mac[3], 
204                                                                 0xFF & device_mac[4], 0xFF & device_mac[5]);
205         return;
206 }
207
208 void rl8168_setup_descriptors() {
209         
210         rl8168_debug("-->Setting up tx/rx descriptors.\n");
211                         
212         // Allocate room for the buffers. 
213         // Buffers need to be on 256 byte boundries.
214         // Note: We use get_cont_pages to force page alignment, and thus 256 byte aligned
215
216         uint32_t num_rx_pages = ROUNDUP(NUM_RX_DESCRIPTORS * sizeof(struct Descriptor), PGSIZE) / PGSIZE;
217         uint32_t num_tx_pages = ROUNDUP(NUM_TX_DESCRIPTORS * sizeof(struct Descriptor), PGSIZE) / PGSIZE;
218         
219         rx_des_kva = get_cont_pages(LOG2_UP(num_rx_pages), 0);
220         tx_des_kva = get_cont_pages(LOG2_UP(num_tx_pages), 0);
221
222         if (rx_des_kva == NULL) panic("Can't allocate page for RX Ring");
223         if (tx_des_kva == NULL) panic("Can't allocate page for TX Ring");
224         
225         rx_des_pa = PADDR(rx_des_kva);
226         tx_des_pa = PADDR(tx_des_kva);
227         
228     for (int i = 0; i < NUM_RX_DESCRIPTORS; i++) 
229                 rl8168_set_rx_descriptor(i, TRUE); // Allocate memory for the descriptor
230                 
231         for (int i = 0; i < NUM_TX_DESCRIPTORS; i++) 
232                 rl8168_set_tx_descriptor(i);
233                 
234         return;
235 }
236
237
238 void rl8168_set_rx_descriptor(uint32_t des_num, uint8_t reset_buffer) {
239         
240         // Set the OWN bit on all descriptors. Also set the buffer size.
241         rx_des_kva[des_num].command = (DES_OWN_MASK | (RL_RX_MAX_BUFFER_SIZE & DES_RX_SIZE_MASK));
242         
243         if (des_num == (NUM_RX_DESCRIPTORS - 1)) 
244                 rx_des_kva[des_num].command = rx_des_kva[des_num].command | DES_EOR_MASK;
245         
246         if (reset_buffer) {
247                 // Must be aligned on 8 byte boundries. Taken care of by kmalloc.
248                 char *rx_buffer = kmalloc(RL_RX_MAX_BUFFER_SIZE, 0);
249         
250                 if (rx_buffer == NULL) panic ("Can't allocate page for RX Buffer");
251
252                 rx_des_kva[des_num].low_buf = PADDR(rx_buffer);
253                 //.high_buf used if we do 64bit.
254         }
255         
256         return;
257 }
258
259 void rl8168_set_tx_descriptor(uint32_t des_num) {
260         
261         // Clear the command bits.
262         tx_des_kva[des_num].command = 0;
263         
264         // Set EOR bit on last descriptor
265         if (des_num == (NUM_TX_DESCRIPTORS - 1))
266                 tx_des_kva[des_num].command = DES_EOR_MASK;     
267                 
268         char *tx_buffer = kmalloc(RL_TX_MAX_BUFFER_SIZE, 0);
269
270         if (tx_buffer == NULL) panic ("Can't allocate page for TX Buffer");
271
272         tx_des_kva[des_num].low_buf = PADDR(tx_buffer);
273         //.high_buf used if we do 64bit.
274                 
275         return;
276 }
277
278 void rl8168_configure() {
279         
280         // TODO: Weigh resetting the nic. Not really needed. Remove?
281         // TODO Check ordering of what we set.
282         // TODO Remove C+ register setting?
283         
284         rl8168_debug("-->Configuring Device.\n");
285         rl8168_reset();
286
287         // Magic to handle the C+ register. Completely undocumented, ripped from the BSE RE driver.
288         outl(rl8168_io_base_addr + RL_CP_CTRL_REG, RL_CP_MAGIC_MASK);
289
290         // Unlock EPPROM CTRL REG
291         outb(rl8168_io_base_addr + RL_EP_CTRL_REG, RL_EP_CTRL_UL_MASK);         
292         
293         // Set max RX Packet Size
294     outw(rl8168_io_base_addr + RL_RX_MXPKT_REG, RL_RX_MAX_SIZE);        
295                 
296         // Set max TX Packet Size
297     outb(rl8168_io_base_addr + RL_TX_MXPKT_REG, RL_TX_MAX_SIZE);                        
298
299         // Set TX Des Ring Start Addr
300     outl(rl8168_io_base_addr + RL_TX_DES_REG, (unsigned long)tx_des_pa); 
301         
302         // Set RX Des Ring Start Addr
303     outl(rl8168_io_base_addr + RL_RX_DES_REG, (unsigned long)rx_des_pa);        
304
305         // Configure TX
306         outl(rl8168_io_base_addr + RL_TX_CFG_REG, RL_TX_CFG_MASK); 
307         
308         // Configure RX
309         outl(rl8168_io_base_addr + RL_TX_CFG_REG, RL_RX_CFG_MASK);                      
310
311         // Enable RX and TX in the CTRL Reg
312         outb(rl8168_io_base_addr + RL_CTRL_REG, RL_CTRL_RXTX_MASK);                     
313
314         // Lock the EPPROM Ctrl REG
315     outl(rl8168_io_base_addr + RL_EP_CTRL_REG, RL_EP_CTRL_L_MASK);              
316         
317         return;
318 }
319
320 void rl8168_reset() {
321         
322         rl8168_debug("-->Resetting device..... ");
323         outb(rl8168_io_base_addr + RL_CTRL_REG, RL_CTRL_RESET_MASK);
324         
325         // Wait for NIC to answer "done resetting" before continuing on
326         while (inb(rl8168_io_base_addr + RL_CTRL_REG) & RL_CTRL_RESET_MASK);
327         rl8168_debug(" done.\n");
328         
329         return;
330 }
331
332 void rl8168_setup_interrupts() {
333         
334         extern handler_t interrupt_handlers[];
335         
336         rl8168_debug("-->Setting interrupts.\n");
337         
338         // Enable NIC interrupts
339         outw(rl8168_io_base_addr + RL_IM_REG, RL_INTERRUPT_MASK);
340         
341         //Clear the current interrupts.
342         outw(rl8168_io_base_addr + RL_IS_REG, RL_INTRRUPT_CLEAR);
343         
344         // Kernel based interrupt stuff
345 #ifdef __IVY__
346         register_interrupt_handler(interrupt_handlers, KERNEL_IRQ_OFFSET + rl8168_irq, rl8168_interrupt_handler, (void *)0);
347 #else
348         register_interrupt_handler(interrupt_handlers, KERNEL_IRQ_OFFSET + rl8168_irq, rl8168_interrupt_handler, 0);
349 #endif
350         ioapic_route_irq(rl8168_irq, NE2K_IRQ_CPU);     
351         
352         return;
353 }
354
355 // We need to evaluate this routine in terms of concurrency.
356 // We also need to figure out whats up with different core interrupts
357 void rl8168_interrupt_handler(trapframe_t *tf, void* data) {
358
359         rl8168_interrupt_debug("\nNic interrupt on core %u!\n", lapic_get_id());
360                                 
361         // Read the offending interrupt(s)
362         uint16_t interrupt_status = inw(rl8168_io_base_addr + RL_IS_REG);
363
364         // Clear interrupts immediately so we can get the flag raised again.
365         outw(rl8168_io_base_addr + RL_IS_REG, interrupt_status);
366         
367         // Loop to deal with TOCTOU 
368         while (interrupt_status != 0x0000) {
369                 // We can have multiple interrupts fire at once. I've personally seen this.
370                 // This means we need to handle this as a series of independent if's
371                 if (interrupt_status & RL_INT_ROK) {
372                         rl8168_interrupt_debug("-->RX OK\n");
373                         rl8168_handle_rx_packet();
374                 }       
375         
376                 if (interrupt_status & RL_INT_RERR) {
377                         rl8168_interrupt_debug("-->RX ERR\n");                  
378                 }
379         
380                 if (interrupt_status & RL_INT_TOK) {
381                         rl8168_interrupt_debug("-->TX OK\n");
382                 }
383         
384                 if (interrupt_status & RL_INT_TERR) {
385                         rl8168_interrupt_debug("-->TX ERR\n");                  
386                 }
387         
388                 if (interrupt_status & RL_INT_RDU) {
389                         rl8168_interrupt_debug("-->RX Descriptor Unavailable\n");                       
390                 }
391         
392                 if (interrupt_status & RL_INT_LINKCHG) {
393                         rl8168_interrupt_debug("-->Link Status Changed\n");                     
394                 }
395         
396                 if (interrupt_status & RL_INT_FOVW) {
397                         rl8168_interrupt_debug("-->RX Fifo Overflow\n");                        
398                 }
399         
400                 if (interrupt_status & RL_INT_TDU) {
401                         rl8168_interrupt_debug("-->TX Descriptor Unavailable\n");                       
402                 }
403         
404                 if (interrupt_status & RL_INT_SWINT) {
405                         rl8168_interrupt_debug("-->Software Generated Interrupt\n");
406                 }
407         
408                 if (interrupt_status & RL_INT_TIMEOUT) {
409                         rl8168_interrupt_debug("-->Timer Expired\n");
410                 }
411         
412                 if (interrupt_status & RL_INT_SERR) {
413                         rl8168_interrupt_debug("-->PCI Bus System Error\n");                    
414                 }
415         
416                 rl8168_interrupt_debug("\n");
417                 
418                 // Clear interrupts     
419                 interrupt_status = inw(rl8168_io_base_addr + RL_IS_REG);
420                 outw(rl8168_io_base_addr + RL_IS_REG, interrupt_status);
421         }
422         
423         // In the event that we got really unlucky and more data arrived after we set 
424         //  set the bit last, try one more check
425         rl8168_handle_rx_packet();
426
427         return;
428 }
429
430 // TODO: Does a packet too large get dropped or just set the error bits in the descriptor? Find out.
431 // TODO: Should we move on to look for the next descriptor? is it safe? TOCTOU
432 void rl8168_handle_rx_packet() {
433         
434         uint32_t current_command = rx_des_kva[rx_des_cur].command;
435         uint16_t packet_size;
436         
437         if (current_command & DES_OWN_MASK) {
438                 rl8168_frame_debug("-->Nothing to process. Returning.");
439                 return;
440         }
441                 
442         rl8168_frame_debug("-->RX Des: %u\n", rx_des_cur);
443         
444         // Make sure we are processing from the start of a packet segment
445         if (!(current_command & DES_FS_MASK)) {
446                 rl8168_frame_debug("-->ERR: Current RX descriptor not marked with FS mask. Panic!");
447                 panic("RX Descriptor Ring FS out of sync");
448         }
449         
450         // NOTE: We are currently configured that the max packet size is large enough to fit inside 1 descriptor buffer,
451         // So we should never be in a situation where a packet spans multiple descriptors.
452         // When we change this, this should operate in a loop until the LS mask is found
453         // Loop would begin here.
454         
455         uint32_t rx_des_loop_cur = rx_des_cur;
456         uint32_t frame_size = 0;
457         uint32_t fragment_size = 0;
458         uint32_t num_frags = 0;
459         
460         char *rx_buffer = kmalloc(MAX_FRAME_SIZE, 0);
461         
462         if (rx_buffer == NULL) panic ("Can't allocate page for incoming packet.");
463         
464         do {
465                 current_command =  rx_des_kva[rx_des_loop_cur].command;
466                 fragment_size = rx_des_kva[rx_des_loop_cur].command & DES_RX_SIZE_MASK;
467                 
468                 // If we've looped through the entire ring and not found a terminating packet, bad nic state.
469                 // Panic or clear all descriptors? This is a nic hardware error. 
470                 if (num_frags && (rx_des_loop_cur == rx_des_cur)) {
471                         //for (int i = 0; i < NUM_RX_DESCRIPTORS; i++) 
472                         //      set_rx_descriptor(i, FALSE); // Dont reallocate memory for the descriptor
473                         // rx_des_cur = 0;
474                         // return;
475                         rl8168_frame_debug("-->ERR: No ending segment found in RX buffer.\n");
476                         panic("RX Descriptor Ring out of sync.");
477                 }
478                 
479                 num_frags++;
480                 
481                 
482                 // Make sure we own the current packet. Kernel ownership is denoted by a 0. Nic by a 1.
483                 if (current_command & DES_OWN_MASK) {
484                         rl8168_frame_debug("-->ERR: Current RX descriptor not owned by kernel. Panic!");
485                         panic("RX Descriptor Ring OWN out of sync");
486                 }
487                 
488                 // Make sure if we are at the end of the buffer, the des is marked as end
489                 if ((rx_des_loop_cur == (NUM_RX_DESCRIPTORS - 1)) && !(current_command & DES_EOR_MASK)) {
490                         rl8168_frame_debug("-->ERR: Last RX descriptor not marked with EOR mask. Panic!\n");
491                         panic("RX Descriptor Ring EOR Missing");
492                 }
493                 
494                 // We set a max frame size and the nic violated that. 
495                 // Panic or clear all desriptors?
496                 if ((frame_size + fragment_size) > MAX_FRAME_SIZE) {
497                         //for (int i = 0; i < NUM_RX_DESCRIPTORS; i++) 
498                         //      set_rx_descriptor(i, FALSE); // Dont reallocate memory for the descriptor
499                         // rx_des_cur = 0;
500                         // return;
501                         rl8168_frame_debug("-->ERR: Nic sent %u byte packet. Max is %u\n", frame_size, MAX_FRAME_SIZE);
502                         panic("NIC Sent packets larger than configured.");
503                 }
504                 
505                 // Move the fragment data into the buffer
506                 memcpy(rx_buffer + frame_size, KADDR(rx_des_kva[rx_des_loop_cur].low_buf), fragment_size);
507                 
508                 // Reset the descriptor. No reuse buffer.
509                 rl8168_set_rx_descriptor(rx_des_loop_cur, FALSE);
510                 
511                 // Note: We mask out fragment sizes at 0x3FFFF. There can be at most 1024 of them.
512                 // This can not overflow the uint32_t we allocated for frame size, so
513                 // we dont need to worry about mallocing too little then overflowing when we read.
514                 frame_size = frame_size + fragment_size;
515                 
516                 // Advance to the next descriptor
517                 rx_des_loop_cur = (rx_des_loop_cur + 1) % NUM_RX_DESCRIPTORS;
518                 
519         } while (!(current_command & DES_LS_MASK));
520         
521
522         spin_lock(&packet_buffer_lock);
523
524         if (packet_buffer_count >= PACKET_BUFFER_SIZE) {
525                 printk("WARNING: DROPPING PACKET!\n");
526                 spin_unlock(&packet_buffer_lock);
527                 kfree(rx_buffer);
528                 return;
529         }
530
531         packet_buffer[packet_buffer_tail] = rx_buffer;
532         packet_buffer_sizes[packet_buffer_tail] = frame_size;
533                 
534         packet_buffer_tail = (packet_buffer_tail + 1) % PACKET_BUFFER_SIZE;
535         packet_buffer_count = packet_buffer_count + 1;
536
537         spin_unlock(&packet_buffer_lock);
538                                 
539         rx_des_cur = rx_des_loop_cur;
540                                 
541         // Chew on the frame data. Command bits should be the same for all frags.
542         rl8168_process_frame(rx_buffer, frame_size, current_command);
543         
544         return;
545 }
546
547 // This is really more of a debug level function. Will probably go away once we get a stack going.
548 void rl8168_process_frame(char *frame_buffer, uint32_t frame_size, uint32_t command) {
549                 
550         rl8168_frame_debug("-->Command: %x\n", command);
551         rl8168_frame_debug("-->Size: %u\n", frame_size);
552         
553         if (frame_buffer == NULL)
554                 return;
555         
556         // This is hacky. Once we know what our stack will look like, change this.
557         // Once remove check for 0 size.
558         if (frame_size < MIN_FRAME_SIZE) {
559                 rl8168_frame_debug("-->Packet too small. Discarding.\n");
560                 return;
561         }
562         
563         char dest_mac[6];
564         char source_mac[6];
565         char eth_type[2];
566         
567         for (int i = 0; i < 6; i++) {
568                 dest_mac[i] = frame_buffer[i];
569         }
570         
571         for (int i = 0; i < 6; i++) {
572                 source_mac[i] = frame_buffer[i+6];
573         }
574         
575         eth_type[0] = frame_buffer[12];
576         eth_type[1] = frame_buffer[13];
577         
578         if (command & DES_MAR_MASK) {
579                 rl8168_frame_debug("-->Multicast Packet.\n");
580         }
581         
582         if (command & DES_PAM_MASK) {
583                 rl8168_frame_debug("-->Physical Address Matched.\n");
584         }
585         
586         if (command & DES_BAR_MASK) {
587                 rl8168_frame_debug("-->Broadcast Packet.\n");
588         }
589         
590         // Note: DEST comes before SRC in the ethernet frame, but that 
591         
592         rl8168_frame_debug("-->DEST   MAC: %02x:%02x:%02x:%02x:%02x:%02x\n", 0xFF & dest_mac[0], 0xFF & dest_mac[1],    
593                                                                              0xFF & dest_mac[2], 0xFF & dest_mac[3],    
594                                                                              0xFF & dest_mac[4], 0xFF & dest_mac[5]);
595         
596         rl8168_frame_debug("-->SOURCE MAC: %02x:%02x:%02x:%02x:%02x:%02x\n", 0xFF & source_mac[0], 0xFF & source_mac[1],        
597                                                                              0xFF & source_mac[2], 0xFF & source_mac[3],        
598                                                                              0xFF & source_mac[4], 0xFF & source_mac[5]);
599
600         rl8168_frame_debug("-->ETHR MODE: %02x%02x\n", 0xFF & eth_type[0], 0xFF & eth_type[1]);
601                 
602         return;
603 }
604
605 // Main routine to send a frame. Just sends it and goes.
606 // Card supports sending across multiple fragments.
607 // Would we want to write a function that takes a larger packet and generates fragments?
608 // This seems like the stacks responsibility. Leave this for now. may in future
609 // Remove the max size cap and generate multiple packets.
610 int rl8168_send_frame(const char *data, size_t len) {
611
612         if (data == NULL)
613                 return -1;
614         if (len == 0)
615                 return 0;
616
617         if (tx_des_kva[tx_des_cur].command & DES_OWN_MASK) {
618                 rl8168_frame_debug("-->TX Ring Buffer Full!\n");
619                 return -1;
620         }
621         
622         if (len > MAX_FRAME_SIZE) {
623                 rl8168_frame_debug("-->Frame Too Large!\n");
624                 return -1;
625         }
626         
627         memcpy(KADDR(tx_des_kva[tx_des_cur].low_buf), data, len);
628
629         tx_des_kva[tx_des_cur].command = tx_des_kva[tx_des_cur].command | len | DES_OWN_MASK | DES_FS_MASK | DES_LS_MASK;
630
631         // For this revision of the NIC, the checksum bits get set in the vlan field not the command field.
632         // THIS IS A HACK: Need to reach inside the frame we are sending and detect if its of type ip/udp/tcp and set right flag
633         // For now, for the syscall hack, force ip checksum on. (we dont care about udp checksum).
634         // Add an argument to function to specify packet type?
635         //tx_des_kva[tx_des_cur].vlan = DES_TX_IP_CHK_MASK;
636         tx_des_kva[tx_des_cur].vlan = 0;
637
638
639         tx_des_cur = (tx_des_cur + 1) % NUM_TX_DESCRIPTORS;
640         
641         //rl8168_frame_debug("-->Sent packet.\n");
642         
643         outb(rl8168_io_base_addr + RL_TX_CTRL_REG, RL_TX_SEND_MASK);
644         
645         return len;
646 }
647