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