Kernel/ARMv7 - Fixed not using ASIDs
[tpg/acess2.git] / Modules / Network / NE2000 / ne2000.c
1 /* Acess2
2  * NE2000 Driver
3  * 
4  * See: ~/Sources/bochs/bochs.../iodev/ne2k.cc
5  */
6 #define DEBUG   1
7 #define VERSION ((0<<8)|50)
8 #include <acess.h>
9 #include <modules.h>
10 #include <fs_devfs.h>
11 #include <drv_pci.h>
12 #include <api_drv_network.h>
13 #include <semaphore.h>
14
15 // === CONSTANTS ===
16 #define MEM_START       0x40
17 #define MEM_END         0xC0
18 #define RX_FIRST        (MEM_START)
19 #define RX_LAST         (MEM_START+RX_BUF_SIZE-1)
20 #define RX_BUF_SIZE     0x40
21 #define TX_FIRST        (MEM_START+RX_BUF_SIZE)
22 #define TX_LAST         (MEM_END)
23 #define TX_BUF_SIZE     0x40
24 #define MAX_PACKET_QUEUE        10
25
26 static const struct {
27         Uint16  Vendor;
28         Uint16  Device;
29 } csaCOMPAT_DEVICES[] = {
30         {0x10EC, 0x8029},       // Realtek 8029
31         {0x10EC, 0x8129}        // Realtek 8129
32 };
33 #define NUM_COMPAT_DEVICES      ((int)(sizeof(csaCOMPAT_DEVICES)/sizeof(csaCOMPAT_DEVICES[0])))
34
35 enum eNe2k_Page0Read {
36         CMD = 0,        //!< the master command register
37         CLDA0,          //!< Current Local DMA Address 0
38         CLDA1,          //!< Current Local DMA Address 1
39         BNRY,           //!< Boundary Pointer (for ringbuffer)
40         TSR,            //!< Transmit Status Register
41         NCR,            //!< collisions counter
42         FIFO,           //!< (for what purpose ??)
43         ISR,            //!< Interrupt Status Register
44         CRDA0,          //!< Current Remote DMA Address 0
45         CRDA1,          //!< Current Remote DMA Address 1
46         RSR = 0xC       //!< Receive Status Register
47 };
48
49 enum eNe2k_Page0Write {
50         PSTART = 1,     //!< page start (init only)
51         PSTOP,          //!< page stop  (init only)
52         TPSR = 4,       //!< transmit page start address
53         TBCR0,          //!< transmit byte count (low)
54         TBCR1,          //!< transmit byte count (high)
55         RSAR0 = 8,      //!< remote start address (lo)
56         RSAR1,  //!< remote start address (hi)
57         RBCR0,  //!< remote byte count (lo)
58         RBCR1,  //!< remote byte count (hi)
59         RCR,    //!< receive config register
60         TCR,    //!< transmit config register
61         DCR,    //!< data config register    (init)
62         IMR             //!< interrupt mask register (init)
63 };
64
65 enum eNe2k_Page1Read {
66         CURR = 7        //!< current page
67 };
68
69 // === TYPES ===
70 typedef struct sNe2k_Card {
71         Uint16  IOBase; //!< IO Port Address from PCI
72         Uint8   IRQ;    //!< IRQ Assigned from PCI
73         
74         tSemaphore      Semaphore;      //!< Semaphore for incoming packets
75          int    NextRXPage;     //!< Next expected RX page
76         
77          int    NextMemPage;    //!< Next Card Memory page to use
78                 
79         char    Name[2];        // "0"
80         tVFS_Node       Node;   //!< VFS Node
81         Uint8   MacAddr[6];     //!< Cached MAC address
82 } tCard;
83
84 // === PROTOTYPES ===
85  int    Ne2k_Install(char **Arguments);
86 char    *Ne2k_ReadDir(tVFS_Node *Node, int Pos);
87 tVFS_Node       *Ne2k_FindDir(tVFS_Node *Node, const char *Name);
88  int    Ne2k_IOCtl(tVFS_Node *Node, int ID, void *Data);
89 Uint64  Ne2k_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
90 Uint64  Ne2k_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
91
92  int    Ne2k_int_ReadDMA(tCard *Card, int FirstPage, int NumPages, void *Buffer);
93 Uint8   Ne2k_int_GetWritePage(tCard *Card, Uint16 Length);
94 void    Ne2k_IRQHandler(int IntNum, void *Ptr);
95
96 // === GLOBALS ===
97 MODULE_DEFINE(0, VERSION, Ne2k, Ne2k_Install, NULL, NULL);
98 tDevFS_Driver   gNe2k_DriverInfo = {
99         NULL, "ne2k",
100         {
101         .NumACLs = 1,
102         .ACLs = &gVFS_ACL_EveryoneRX,
103         .Flags = VFS_FFLAG_DIRECTORY,
104         .ReadDir = Ne2k_ReadDir,
105         .FindDir = Ne2k_FindDir,
106         .IOCtl = Ne2k_IOCtl
107         }
108 };
109 Uint16  gNe2k_BaseAddress;
110  int    giNe2k_CardCount = 0;
111 tCard   *gpNe2k_Cards = NULL;
112
113 // === CODE ===
114 /**
115  * \fn int Ne2k_Install(char **Options)
116  * \brief Installs the NE2000 Driver
117  */
118 int Ne2k_Install(char **Options)
119 {
120          int    i, j, k;
121          int    count, base;
122         tPCIDev id;
123         
124         // --- Scan PCI Bus ---
125         // Count Cards
126         giNe2k_CardCount = 0;
127         for( i = 0; i < NUM_COMPAT_DEVICES; i ++ )
128         {
129                 giNe2k_CardCount += PCI_CountDevices( csaCOMPAT_DEVICES[i].Vendor, csaCOMPAT_DEVICES[i].Device );
130         }
131         
132         if( giNe2k_CardCount == 0 )     return MODULE_ERR_NOTNEEDED;
133         
134         // Enumerate Cards
135         k = 0;
136         gpNe2k_Cards = calloc( giNe2k_CardCount, sizeof(tCard) );
137         
138         for( i = 0; i < NUM_COMPAT_DEVICES; i ++ )
139         {
140                 count = PCI_CountDevices( csaCOMPAT_DEVICES[i].Vendor, csaCOMPAT_DEVICES[i].Device );
141                 for( j = 0; j < count; j ++,k ++ )
142                 {
143                         id = PCI_GetDevice( csaCOMPAT_DEVICES[i].Vendor, csaCOMPAT_DEVICES[i].Device, j );
144                         // Create Structure
145                         base = PCI_GetBAR( id, 0 );
146                         gpNe2k_Cards[ k ].IOBase = base;
147                         gpNe2k_Cards[ k ].IRQ = PCI_GetIRQ( id );
148                         gpNe2k_Cards[ k ].NextMemPage = 64;
149                         gpNe2k_Cards[ k ].NextRXPage = RX_FIRST;
150                         
151                         // Install IRQ Handler
152                         IRQ_AddHandler(gpNe2k_Cards[ k ].IRQ, Ne2k_IRQHandler, &gpNe2k_Cards[k]);
153                         
154                         // Reset Card
155                         outb( base + 0x1F, inb(base + 0x1F) );
156                         while( (inb( base+ISR ) & 0x80) == 0 );
157                         outb( base + ISR, 0x80 );
158                         
159                         // Initialise Card
160                         outb( base + CMD, 0x40|0x21 );  // Page 1, No DMA, Stop
161                         outb( base + CURR, RX_FIRST );  // Current RX page
162                         outb( base + CMD, 0x21 );       // No DMA and Stop
163                         outb( base + DCR, 0x49 );       // Set WORD mode
164                         outb( base + IMR, 0x00 );       // Interrupt Mask Register
165                         outb( base + ISR, 0xFF );
166                         outb( base + RCR, 0x20 );       // Reciever to Monitor
167                         outb( base + TCR, 0x02 );       // Transmitter OFF (TCR.LB = 1, Internal Loopback)
168                         
169                         // Read MAC Address
170                         outb( base + RBCR0, 6*4 );      // Remote Byte Count
171                         outb( base + RBCR1, 0 );
172                         outb( base + RSAR0, 0 );        // Clear Source Address
173                         outb( base + RSAR1, 0 );
174                         outb( base + CMD, 0x0A );       // Remote Read, Start
175                         gpNe2k_Cards[ k ].MacAddr[0] = inb(base+0x10);//        inb(base+0x10);
176                         gpNe2k_Cards[ k ].MacAddr[1] = inb(base+0x10);//        inb(base+0x10);
177                         gpNe2k_Cards[ k ].MacAddr[2] = inb(base+0x10);//        inb(base+0x10);
178                         gpNe2k_Cards[ k ].MacAddr[3] = inb(base+0x10);//        inb(base+0x10);
179                         gpNe2k_Cards[ k ].MacAddr[4] = inb(base+0x10);//        inb(base+0x10);
180                         gpNe2k_Cards[ k ].MacAddr[5] = inb(base+0x10);//        inb(base+0x10);
181                         
182                         outb( base+PSTART, RX_FIRST);   // Set Receive Start
183                         outb( base+BNRY, RX_LAST-1);    // Set Boundary Page
184                         outb( base+PSTOP, RX_LAST);     // Set Stop Page
185                         outb( base+ISR, 0xFF ); // Clear all ints
186                         outb( base+CMD, 0x22 ); // No DMA, Start
187                         outb( base+IMR, 0x3F ); // Set Interupt Mask
188                         outb( base+RCR, 0x0F ); // Set WRAP and allow all packet matches
189                         outb( base+TCR, 0x00 ); // Set Normal Transmitter mode
190                         outb( base+TPSR, 0x40); // Set Transmit Start
191                         
192                         Log_Log("Ne2k", "Card %i 0x%04x IRQ%i %02x:%02x:%02x:%02x:%02x:%02x",
193                                 k, base, gpNe2k_Cards[ k ].IRQ,
194                                 gpNe2k_Cards[k].MacAddr[0], gpNe2k_Cards[k].MacAddr[1],
195                                 gpNe2k_Cards[k].MacAddr[2], gpNe2k_Cards[k].MacAddr[3],
196                                 gpNe2k_Cards[k].MacAddr[4], gpNe2k_Cards[k].MacAddr[5]
197                                 );
198                         
199                         // Set VFS Node
200                         gpNe2k_Cards[ k ].Name[0] = '0'+k;
201                         gpNe2k_Cards[ k ].Name[1] = '\0';
202                         gpNe2k_Cards[ k ].Node.ImplPtr = &gpNe2k_Cards[ k ];
203                         gpNe2k_Cards[ k ].Node.NumACLs = 0;     // Root Only
204                         gpNe2k_Cards[ k ].Node.CTime = now();
205                         gpNe2k_Cards[ k ].Node.Write = Ne2k_Write;
206                         gpNe2k_Cards[ k ].Node.Read = Ne2k_Read;
207                         gpNe2k_Cards[ k ].Node.IOCtl = Ne2k_IOCtl;
208                         
209                         // Initialise packet semaphore
210                         // - Start at zero, no max
211                         Semaphore_Init( &gpNe2k_Cards[k].Semaphore, 0, 0, "NE2000", gpNe2k_Cards[ k ].Name );
212                 }
213         }
214         
215         gNe2k_DriverInfo.RootNode.Size = giNe2k_CardCount;
216         DevFS_AddDevice( &gNe2k_DriverInfo );
217         return MODULE_ERR_OK;
218 }
219
220 /**
221  * \fn char *Ne2k_ReadDir(tVFS_Node *Node, int Pos)
222  */
223 char *Ne2k_ReadDir(tVFS_Node *Node, int Pos)
224 {
225         char    ret[2];
226         if(Pos < 0 || Pos >= giNe2k_CardCount)  return NULL;
227         ret[0] = '0'+Pos;
228         ret[1] = '\0';
229         return strdup(ret);
230 }
231
232 /**
233  * \fn tVFS_Node *Ne2k_FindDir(tVFS_Node *Node, const char *Name)
234  */
235 tVFS_Node *Ne2k_FindDir(tVFS_Node *Node, const char *Name)
236 {
237         if(Name[0] == '\0' || Name[1] != '\0')  return NULL;
238         
239         return &gpNe2k_Cards[ Name[0]-'0' ].Node;
240 }
241
242 static const char *casIOCtls[] = { DRV_IOCTLNAMES, DRV_NETWORK_IOCTLNAMES, NULL };
243 /**
244  * \fn int Ne2k_IOCtl(tVFS_Node *Node, int ID, void *Data)
245  * \brief IOCtl calls for a network device
246  */
247 int Ne2k_IOCtl(tVFS_Node *Node, int ID, void *Data)
248 {
249         ENTER("pNode iID pData", Node, ID, Data);
250         switch( ID )
251         {
252         BASE_IOCTLS(DRV_TYPE_NETWORK, "NE2000", VERSION, casIOCtls);
253         }
254         
255         // If this is the root, return
256         if( Node == &gNe2k_DriverInfo.RootNode ) {
257                 LEAVE('i', 0);
258                 return 0;
259         }
260         
261         // Device specific settings
262         switch( ID )
263         {
264         case NET_IOCTL_GETMAC:
265                 if( !CheckMem(Data, 6) ) {
266                         LEAVE('i', -1);
267                         return -1;
268                 }
269                 memcpy( Data, ((tCard*)Node->ImplPtr)->MacAddr, 6 );
270                 LEAVE('i', 1);
271                 return 1;
272         }
273         LEAVE('i', 0);
274         return 0;
275 }
276
277 /**
278  * \fn Uint64 Ne2k_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
279  * \brief Send a packet from the network card
280  */
281 Uint64 Ne2k_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
282 {
283         tCard   *Card = (tCard*)Node->ImplPtr;
284         Uint16  *buf = Buffer;
285          int    rem = Length;
286          int    page;
287         
288         ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
289         
290         // TODO: Lock
291         
292         // Sanity Check Length
293         if(Length > TX_BUF_SIZE*256) {
294                 Log_Warning(
295                         "Ne2k",
296                         "Ne2k_Write - Attempting to send over TX_BUF_SIZE*256 (%i) bytes (%i)",
297                         TX_BUF_SIZE*256, Length
298                         );
299                 LEAVE('i', 0);
300                 return 0;
301         }
302         
303         // Make sure that the card is in page 0
304         outb(Card->IOBase + CMD, 0|0x22);       // Page 0, Start, NoDMA
305         
306         // Clear Remote DMA Flag
307         outb(Card->IOBase + ISR, 0x40); // Bit 6
308         
309         // Send Size - Transfer Byte Count Register
310         outb(Card->IOBase + TBCR0, Length & 0xFF);
311         outb(Card->IOBase + TBCR1, Length >> 8);
312         
313         // Send Size - Remote Byte Count Register
314         outb(Card->IOBase + RBCR0, Length & 0xFF);
315         outb(Card->IOBase + RBCR1, Length >> 8);
316         
317         // Set up transfer
318         outb(Card->IOBase + RSAR0, 0x00);       // Page Offset
319         page = Ne2k_int_GetWritePage(Card, Length);
320         outb(Card->IOBase + RSAR1, page);       // Page Offset
321         // Start
322         outb(Card->IOBase + CMD, 0|0x10|0x2);   // Page 0, Remote Write, Start
323         
324         // Send Data
325         for(rem = Length; rem > 0; rem -= 2) {
326                 outw(Card->IOBase + 0x10, *buf++);
327         }
328         
329         while( !(inb(Card->IOBase + ISR) & 0x40) )      // Wait for Remote DMA Complete
330                 ;       //Proc_Yield();
331         
332         outb( Card->IOBase + ISR, 0x40 );       // ACK Interrupt
333         
334         // Send Packet
335         outb(Card->IOBase + TPSR, page);
336         outb(Card->IOBase + CMD, 0|0x10|0x4|0x2);
337         
338         // Complete DMA
339         //outb(Card->IOBase + CMD, 0|0x20);
340         
341         LEAVE('i', Length);
342         return Length;
343 }
344
345 /**
346  * \fn Uint64 Ne2k_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
347  * \brief Wait for and read a packet from the network card
348  */
349 Uint64 Ne2k_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
350 {
351         tCard   *Card = (tCard*)Node->ImplPtr;
352         Uint8   page;
353         Uint8   data[256];
354         struct {
355                 Uint8   Status;
356                 Uint8   NextPacketPage;
357                 Uint16  Length; // Little Endian
358         }       *pktHdr;
359         
360         ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
361         
362         // Wait for packets
363         if( Semaphore_Wait( &Card->Semaphore, 1 ) != 1 )
364         {
365                 // Error or interrupted
366                 LEAVE_RET('i', 0);
367         }
368         
369         outb(Card->IOBase, 0x22 | (1 << 6));    // Page 6
370         LOG("CURR : 0x%02x", inb(Card->IOBase + CURR));
371         
372         // Get current read page
373         page = Card->NextRXPage;
374         LOG("page = %i", page);
375         
376         Ne2k_int_ReadDMA(Card, page, 1, data);
377         
378         pktHdr = (void*)data;
379         
380         LOG("pktHdr->Status = 0x%x", pktHdr->Status);
381         LOG("pktHdr->NextPacketPage = %i", pktHdr->NextPacketPage);
382         LOG("pktHdr->Length = 0x%03x", pktHdr->Length);
383         
384         // Have we read all the required bytes yet?
385         if(pktHdr->Length < 256 - 4)
386         {
387                 if(Length > pktHdr->Length)
388                         Length = pktHdr->Length;
389                 memcpy(Buffer, &data[4], Length);
390         }
391         // No? oh damn, now we need to allocate a buffer
392         else
393         {
394                  int    pages = pktHdr->NextPacketPage - page;
395                 char    *buf = malloc( pages*256 );
396                 
397                 LOG("pktHdr->Length (%i) > 256 - 4, allocated buffer %p", pktHdr->Length, buf);
398                 
399                 if(!buf)        LEAVE_RET('i', -1);
400                 
401                 // Copy the already read data
402                 memcpy(buf, data, 256);
403                 
404                 // Read all the needed pages
405                 page ++;
406                 if(page == RX_LAST+1)   page = RX_FIRST;
407                 
408                 if( page + pages > RX_LAST )
409                 {
410                          int    first_count = RX_LAST+1 - page;
411                          int    tmp = 0;
412                         tmp += Ne2k_int_ReadDMA(Card, page, first_count, buf+256);
413                         tmp += Ne2k_int_ReadDMA(Card, RX_FIRST, pages-1-first_count, buf+(first_count+1)*256);
414                         LOG("composite return count = %i", tmp);
415                 }
416                 else
417                         Ne2k_int_ReadDMA(Card, page, pages-1, buf+256);
418                 
419                 // Wrap length to the packet length
420                 if(Length > pktHdr->Length)
421                         Length = pktHdr->Length;
422                 else if( Length < pktHdr->Length ) {
423                         Log_Warning("NE2000", "Packet truncated! (%i bytes truncated to %i)",
424                                 pktHdr->Length, Length);
425                 }
426                 memcpy(Buffer, &buf[4], Length);
427                 
428                 free(buf);
429         }
430         
431         // Write BNRY (maximum page for incoming packets)
432         if(pktHdr->NextPacketPage == RX_FIRST)
433                 outb( Card->IOBase + BNRY, RX_LAST-1 );
434         else
435                 outb( Card->IOBase + BNRY, pktHdr->NextPacketPage-1 );
436         // Set next RX Page and decrement the waiting list
437         Card->NextRXPage = pktHdr->NextPacketPage;
438         
439         LEAVE('i', Length);
440         return Length;
441 }
442
443 int Ne2k_int_ReadDMA(tCard *Card, int FirstPage, int NumPages, void *Buffer)
444 {
445          int    i;
446         
447         // Sanity check
448         if( !(0 <= FirstPage && FirstPage < 256) ) {
449                 Log_Warning("NE2000", "Ne2k_int_ReadDMA: BUG - FirstPage(%i) not 8-bit", FirstPage);
450                 return -1;
451         }
452         if( !(0 <= NumPages && NumPages < 256) ) {
453                 Log_Warning("NE2000", "Ne2k_int_ReadDMA: BUG - NumPages(%i) not 8-bit", NumPages);
454                 return -1;
455         }
456         
457         ENTER("pCard iFirstPage iNumPages pBuffer", Card, FirstPage, NumPages, Buffer);
458         
459         // Make sure that the card is in bank 0
460         outb(Card->IOBase + CMD, 0|0x22);       // Bank 0, Start, NoDMA
461         outb(Card->IOBase + ISR, 0x40); // Clear Remote DMA Flag
462         
463         // Set up transfer
464         outb(Card->IOBase + RBCR0, 0);
465         outb(Card->IOBase + RBCR1, NumPages);   // page count
466         outb(Card->IOBase + RSAR0, 0x00);       // Page Offset
467         outb(Card->IOBase + RSAR1, FirstPage);  // Page Number
468         outb(Card->IOBase + CMD, 0|0x08|0x2);   // Bank 0, Remote Read, Start
469         
470         // TODO: Less expensive
471         //while( !(inb(Card->IOBase + ISR) & 0x40) ) {
472         //      HALT();
473         //      LOG("inb(ISR) = 0x%02x", inb(Card->IOBase + ISR));
474         //}
475         HALT(); // Small delay?
476         
477         // Read data
478         for(i = 0; i < 128*NumPages; i ++)
479                 ((Uint16*)Buffer)[i] = inw(Card->IOBase + 0x10);
480                 
481         
482         outb(Card->IOBase + ISR, 0x40); // Clear Remote DMA Flag
483         
484         LEAVE('i', NumPages);
485         return NumPages;
486 }
487
488 /**
489  * \fn Uint8 Ne2k_int_GetWritePage(tCard *Card, Uint16 Length)
490  */
491 Uint8 Ne2k_int_GetWritePage(tCard *Card, Uint16 Length)
492 {
493         Uint8   ret = Card->NextMemPage;
494         
495         Card->NextMemPage += (Length + 0xFF) >> 8;
496         if(Card->NextMemPage >= TX_LAST) {
497                 Card->NextMemPage -= TX_BUF_SIZE;
498         }
499         
500         return ret;
501 }
502
503 /**
504  * \fn void Ne2k_IRQHandler(int IntNum)
505  */
506 void Ne2k_IRQHandler(int IntNum, void *Ptr)
507 {
508         Uint8   byte;
509         tCard   *card = Ptr;
510
511         if(card->IRQ != IntNum) return;
512         
513         byte = inb( card->IOBase + ISR );
514         
515         LOG("byte = 0x%02x", byte);
516                         
517                         
518         // Reset All (save for RDMA), that's polled
519         outb( card->IOBase + ISR, 0xFF&(~0x40) );
520                         
521         // 0: Packet recieved (no error)
522         if( byte & 1 )
523         {
524                 //if( card->NumWaitingPackets > MAX_PACKET_QUEUE )
525                 //      card->NumWaitingPackets = MAX_PACKET_QUEUE;
526                 if( Semaphore_Signal( &card->Semaphore, 1 ) != 1 ) {
527                         // Oops?
528                 }
529         }
530         // 1: Packet sent (no error)
531         // 2: Recieved with error
532         // 3: Transmission Halted (Excessive Collisions)
533         // 4: Recieve Buffer Exhausted
534         // 5: 
535         // 6: Remote DMA Complete
536         // 7: Reset
537 }

UCC git Repository :: git.ucc.asn.au