4 * See: ~/Sources/bochs/bochs.../iodev/ne2k.cc
7 #define VERSION ((0<<8)|50)
12 #include <tpl_drv_network.h>
15 #define MEM_START 0x40
17 #define RX_FIRST (MEM_START)
18 #define RX_LAST (MEM_START+RX_BUF_SIZE-1)
19 #define RX_BUF_SIZE 0x40
20 #define TX_FIRST (MEM_START+RX_BUF_SIZE)
21 #define TX_LAST (MEM_END)
22 #define TX_BUF_SIZE 0x40
23 #define MAX_PACKET_QUEUE 10
28 } csaCOMPAT_DEVICES[] = {
29 {0x10EC, 0x8029}, // Realtek 8029
30 {0x10EC, 0x8129} // Realtek 8129
32 #define NUM_COMPAT_DEVICES (sizeof(csaCOMPAT_DEVICES)/sizeof(csaCOMPAT_DEVICES[0]))
34 enum eNe2k_Page0Read {
35 CMD = 0, //!< the master command register
36 CLDA0, //!< Current Local DMA Address 0
37 CLDA1, //!< Current Local DMA Address 1
38 BNRY, //!< Boundary Pointer (for ringbuffer)
39 TSR, //!< Transmit Status Register
40 NCR, //!< collisions counter
41 FIFO, //!< (for what purpose ??)
42 ISR, //!< Interrupt Status Register
43 CRDA0, //!< Current Remote DMA Address 0
44 CRDA1, //!< Current Remote DMA Address 1
45 RSR = 0xC //!< Receive Status Register
48 enum eNe2k_Page0Write {
49 PSTART = 1, //!< page start (init only)
50 PSTOP, //!< page stop (init only)
51 TPSR = 4, //!< transmit page start address
52 TBCR0, //!< transmit byte count (low)
53 TBCR1, //!< transmit byte count (high)
54 RSAR0 = 8, //!< remote start address (lo)
55 RSAR1, //!< remote start address (hi)
56 RBCR0, //!< remote byte count (lo)
57 RBCR1, //!< remote byte count (hi)
58 RCR, //!< receive config register
59 TCR, //!< transmit config register
60 DCR, //!< data config register (init)
61 IMR //!< interrupt mask register (init)
64 enum eNe2k_Page1Read {
65 CURR = 7 //!< current page
69 typedef struct sNe2k_Card {
70 Uint16 IOBase; //!< IO Port Address from PCI
71 Uint8 IRQ; //!< IRQ Assigned from PCI
73 int NumWaitingPackets;
76 int NextMemPage; //!< Next Card Memory page to use
78 Uint8 Buffer[RX_BUF_SIZE*256];
86 int Ne2k_Install(char **Arguments);
87 char *Ne2k_ReadDir(tVFS_Node *Node, int Pos);
88 tVFS_Node *Ne2k_FindDir(tVFS_Node *Node, char *Name);
89 int Ne2k_IOCtl(tVFS_Node *Node, int ID, void *Data);
90 Uint64 Ne2k_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
91 Uint64 Ne2k_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
92 Uint8 Ne2k_int_GetWritePage(tCard *Card, Uint16 Length);
93 void Ne2k_IRQHandler(int IntNum);
96 MODULE_DEFINE(0, VERSION, Ne2k, Ne2k_Install, NULL, NULL);
97 tDevFS_Driver gNe2k_DriverInfo = {
101 .ACLs = &gVFS_ACL_EveryoneRX,
102 .Flags = VFS_FFLAG_DIRECTORY,
103 .ReadDir = Ne2k_ReadDir,
104 .FindDir = Ne2k_FindDir,
108 Uint16 gNe2k_BaseAddress;
109 int giNe2k_CardCount = 0;
110 tCard *gpNe2k_Cards = NULL;
114 * \fn int Ne2k_Install(char **Options)
115 * \brief Installs the NE2000 Driver
117 int Ne2k_Install(char **Options)
122 // --- Scan PCI Bus ---
124 giNe2k_CardCount = 0;
125 for( i = 0; i < NUM_COMPAT_DEVICES; i ++ )
127 giNe2k_CardCount += PCI_CountDevices( csaCOMPAT_DEVICES[i].Vendor, csaCOMPAT_DEVICES[i].Device, 0 );
130 if( giNe2k_CardCount == 0 ) {
131 Warning("[Ne2k ] No cards detected");
132 return MODULE_ERR_NOTNEEDED;
137 gpNe2k_Cards = calloc( giNe2k_CardCount, sizeof(tCard) );
139 for( i = 0; i < NUM_COMPAT_DEVICES; i ++ )
141 count = PCI_CountDevices( csaCOMPAT_DEVICES[i].Vendor, csaCOMPAT_DEVICES[i].Device, 0 );
142 for( j = 0; j < count; j ++,k ++ )
144 id = PCI_GetDevice( csaCOMPAT_DEVICES[i].Vendor, csaCOMPAT_DEVICES[i].Device, 0, j );
146 base = PCI_AssignPort( id, 0, 0x20 );
147 gpNe2k_Cards[ k ].IOBase = base;
148 gpNe2k_Cards[ k ].IRQ = PCI_GetIRQ( id );
149 gpNe2k_Cards[ k ].NextMemPage = 64;
150 gpNe2k_Cards[ k ].NextRXPage = RX_FIRST;
152 // Install IRQ Handler
153 IRQ_AddHandler(gpNe2k_Cards[ k ].IRQ, Ne2k_IRQHandler);
156 outb( base + 0x1F, inb(base + 0x1F) );
157 while( (inb( base+ISR ) & 0x80) == 0 );
158 outb( base + ISR, 0x80 );
161 outb( base + CMD, 0x40|0x21 ); // Page 1, No DMA, Stop
162 outb( base + CURR, RX_FIRST ); // Current RX page
163 outb( base + CMD, 0x21 ); // No DMA and Stop
164 outb( base + DCR, 0x49 ); // Set WORD mode
165 outb( base + IMR, 0x00 );
166 outb( base + ISR, 0xFF );
167 outb( base + RCR, 0x20 ); // Reciever to Monitor
168 outb( base + TCR, 0x02 ); // Transmitter OFF (TCR.LB = 1, Internal Loopback)
169 outb( base + RBCR0, 6*4 ); // Remote Byte Count
170 outb( base + RBCR1, 0 );
171 outb( base + RSAR0, 0 ); // Clear Source Address
172 outb( base + RSAR1, 0 );
173 outb( base + CMD, 0x0A ); // Remote Read, Start
176 gpNe2k_Cards[ k ].MacAddr[0] = inb(base+0x10);// inb(base+0x10);
177 gpNe2k_Cards[ k ].MacAddr[1] = inb(base+0x10);// inb(base+0x10);
178 gpNe2k_Cards[ k ].MacAddr[2] = inb(base+0x10);// inb(base+0x10);
179 gpNe2k_Cards[ k ].MacAddr[3] = inb(base+0x10);// inb(base+0x10);
180 gpNe2k_Cards[ k ].MacAddr[4] = inb(base+0x10);// inb(base+0x10);
181 gpNe2k_Cards[ k ].MacAddr[5] = inb(base+0x10);// inb(base+0x10);
183 outb( base+PSTART, RX_FIRST); // Set Receive Start
184 outb( base+BNRY, RX_LAST-1); // Set Boundary Page
185 outb( base+PSTOP, RX_LAST); // Set Stop Page
186 outb( base+ISR, 0xFF ); // Clear all ints
187 outb( base+CMD, 0x22 ); // No DMA, Start
188 outb( base+IMR, 0x3F ); // Set Interupt Mask
189 outb( base+RCR, 0x0F ); // Set WRAP and allow all packet matches
190 outb( base+TCR, 0x00 ); // Set Normal Transmitter mode
191 outb( base+TPSR, 0x40); // Set Transmit Start
194 Ne2k_WriteReg(base, MAC0, gpNe2k_Cards[ k ].MacAddr[0]);
195 Ne2k_WriteReg(base, MAC1, gpNe2k_Cards[ k ].MacAddr[1]);
196 Ne2k_WriteReg(base, MAC2, gpNe2k_Cards[ k ].MacAddr[2]);
197 Ne2k_WriteReg(base, MAC3, gpNe2k_Cards[ k ].MacAddr[3]);
198 Ne2k_WriteReg(base, MAC4, gpNe2k_Cards[ k ].MacAddr[4]);
199 Ne2k_WriteReg(base, MAC5, gpNe2k_Cards[ k ].MacAddr[5]);
202 Log_Log("NE2K", "Card %i 0x%04x %02x:%02x:%02x:%02x:%02x:%02x",
204 gpNe2k_Cards[k].MacAddr[0], gpNe2k_Cards[k].MacAddr[1],
205 gpNe2k_Cards[k].MacAddr[2], gpNe2k_Cards[k].MacAddr[3],
206 gpNe2k_Cards[k].MacAddr[4], gpNe2k_Cards[k].MacAddr[5]
209 Log("[NE2K]: Card #%i: IRQ=%i, IOBase=0x%x",
210 k, gpNe2k_Cards[ k ].IRQ, gpNe2k_Cards[ k ].IOBase);
211 Log("MAC Address %x:%x:%x:%x:%x:%x",
212 gpNe2k_Cards[ k ].MacAddr[0], gpNe2k_Cards[ k ].MacAddr[1],
213 gpNe2k_Cards[ k ].MacAddr[2], gpNe2k_Cards[ k ].MacAddr[3],
214 gpNe2k_Cards[ k ].MacAddr[4], gpNe2k_Cards[ k ].MacAddr[5]
218 gpNe2k_Cards[ k ].Name[0] = '0'+k;
219 gpNe2k_Cards[ k ].Name[1] = '\0';
220 gpNe2k_Cards[ k ].Node.ImplPtr = &gpNe2k_Cards[ k ];
221 gpNe2k_Cards[ k ].Node.NumACLs = 0; // Root Only
222 gpNe2k_Cards[ k ].Node.CTime = now();
223 gpNe2k_Cards[ k ].Node.Write = Ne2k_Write;
224 gpNe2k_Cards[ k ].Node.Read = Ne2k_Read;
225 gpNe2k_Cards[ k ].Node.IOCtl = Ne2k_IOCtl;
229 gNe2k_DriverInfo.RootNode.Size = giNe2k_CardCount;
230 DevFS_AddDevice( &gNe2k_DriverInfo );
231 return MODULE_ERR_OK;
235 * \fn char *Ne2k_ReadDir(tVFS_Node *Node, int Pos)
237 char *Ne2k_ReadDir(tVFS_Node *Node, int Pos)
240 if(Pos < 0 || Pos >= giNe2k_CardCount) return NULL;
247 * \fn tVFS_Node *Ne2k_FindDir(tVFS_Node *Node, char *Name)
249 tVFS_Node *Ne2k_FindDir(tVFS_Node *Node, char *Name)
251 if(Name[0] == '\0' || Name[1] != '\0') return NULL;
253 return &gpNe2k_Cards[ Name[0]-'0' ].Node;
256 static const char *casIOCtls[] = { DRV_IOCTLNAMES, DRV_NETWORK_IOCTLNAMES, NULL };
258 * \fn int Ne2k_IOCtl(tVFS_Node *Node, int ID, void *Data)
259 * \brief IOCtl calls for a network device
261 int Ne2k_IOCtl(tVFS_Node *Node, int ID, void *Data)
264 ENTER("pNode iID pData", Node, ID, Data);
268 LEAVE('i', DRV_TYPE_NETWORK);
269 return DRV_TYPE_NETWORK;
271 case DRV_IOCTL_IDENT:
272 tmp = ModUtil_SetIdent(Data, "Ne2k");
276 case DRV_IOCTL_VERSION:
280 case DRV_IOCTL_LOOKUP:
281 tmp = ModUtil_LookupString( (char**)casIOCtls, Data );
286 // If this is the root, return
287 if( Node == &gNe2k_DriverInfo.RootNode ) {
292 // Device specific settings
295 case NET_IOCTL_GETMAC:
296 if( !CheckMem(Data, 6) ) {
300 memcpy( Data, ((tCard*)Node->ImplPtr)->MacAddr, 6 );
309 * \fn Uint64 Ne2k_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
310 * \brief Send a packet from the network card
312 Uint64 Ne2k_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
314 tCard *Card = (tCard*)Node->ImplPtr;
315 Uint16 *buf = Buffer;
319 ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
321 // Sanity Check Length
322 if(Length > TX_BUF_SIZE*256) {
324 "Ne2k_Write - Attempting to send over TX_BUF_SIZE*256 (%i) bytes (%i)",
325 TX_BUF_SIZE*256, Length
331 // Make sure that the card is in page 0
332 outb(Card->IOBase + CMD, 0|0x22); // Page 0, Start, NoDMA
334 // Clear Remote DMA Flag
335 outb(Card->IOBase + ISR, 0x40); // Bit 6
337 // Send Size - Remote Byte Count Register
338 outb(Card->IOBase + TBCR0, Length & 0xFF);
339 outb(Card->IOBase + TBCR1, Length >> 8);
341 // Send Size - Remote Byte Count Register
342 outb(Card->IOBase + RBCR0, Length & 0xFF);
343 outb(Card->IOBase + RBCR1, Length >> 8);
346 outb(Card->IOBase + RSAR0, 0x00); // Page Offset
347 page = Ne2k_int_GetWritePage(Card, Length);
348 outb(Card->IOBase + RSAR1, page); // Page Offset
350 //outb(Card->IOBase + CMD, 0|0x18|0x4|0x2); // Page 0, Transmit Packet, TXP, Start
351 outb(Card->IOBase + CMD, 0|0x10|0x2); // Page 0, Remote Write, Start
354 for(rem = Length; rem > 0; rem -= 2) {
355 outw(Card->IOBase + 0x10, *buf++);
358 while( inb(Card->IOBase + ISR) == 0 ) // Wait for Remote DMA Complete
361 outb( Card->IOBase + ISR, 0x40 ); // ACK Interrupt
364 outb(Card->IOBase + TPSR, page);
365 outb(Card->IOBase + CMD, 0|0x10|0x4|0x2);
368 //outb(Card->IOBase + CMD, 0|0x20);
375 * \fn Uint64 Ne2k_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
376 * \brief Wait for and read a packet from the network card
378 Uint64 Ne2k_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
380 tCard *Card = (tCard*)Node->ImplPtr;
386 Uint8 NextPacketPage;
387 Uint16 Length; // Little Endian
390 ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
392 while(Card->NumWaitingPackets == 0) Threads_Yield();
394 // Make sure that the card is in page 0
395 outb(Card->IOBase + CMD, 0|0x22); // Page 0, Start, NoDMA
398 page = Card->NextRXPage;
401 outb(Card->IOBase + RBCR0, 0);
402 outb(Card->IOBase + RBCR1, 1); // 256-bytes
403 outb(Card->IOBase + RSAR0, 0x00); // Page Offset
404 outb(Card->IOBase + RSAR1, page); // Page Number
406 outb(Card->IOBase + CMD, 0|0x08|0x2); // Page 0, Remote Read, Start
408 // Clear Remote DMA Flag
409 outb(Card->IOBase + ISR, 0x40); // Bit 6
412 for(i = 0; i < 128; i ++)
413 ((Uint16*)data)[i] = inw(Card->IOBase + 0x10);
415 pktHdr = (void*)data;
416 //Log("Ne2k_Read: Recieved packet (%i bytes)", pktHdr->Length);
418 // Have we read all the required bytes yet?
419 if(pktHdr->Length < 256 - 4)
421 if(Length > pktHdr->Length)
422 Length = pktHdr->Length;
423 memcpy(Buffer, &data[4], Length);
425 if(page == RX_LAST+1) page = RX_FIRST;
427 // No? oh damn, now we need to allocate a buffer
430 char *buf = malloc( (pktHdr->Length + 4 + 255) & ~255 );
437 memcpy(buf, data, 256);
440 while(page != pktHdr->NextPacketPage)
442 if(page == RX_LAST+1) page = RX_FIRST;
444 outb(Card->IOBase + RBCR0, 0);
445 outb(Card->IOBase + RBCR1, 1); // 256-bytes
446 outb(Card->IOBase + RSAR0, 0x00); // Page Offset
447 outb(Card->IOBase + RSAR1, page); // Page Number
448 outb(Card->IOBase + CMD, 0|0x08|0x2); // Page 0, Remote Read, Start
450 for(i = 0; i < 128; i ++)
451 ((Uint16*)buf)[j+i] = inw(Card->IOBase + 0x10);
456 if(Length > pktHdr->Length)
457 Length = pktHdr->Length;
458 memcpy(Buffer, &buf[4], Length);
463 outb( Card->IOBase + BNRY, RX_LAST );
465 outb( Card->IOBase + BNRY, page-1 );
466 // Set next RX Page and decrement the waiting list
467 Card->NextRXPage = page;
468 Card->NumWaitingPackets --;
475 * \fn Uint8 Ne2k_int_GetWritePage(tCard *Card, Uint16 Length)
477 Uint8 Ne2k_int_GetWritePage(tCard *Card, Uint16 Length)
479 Uint8 ret = Card->NextMemPage;
481 Card->NextMemPage += (Length + 0xFF) >> 8;
482 if(Card->NextMemPage >= TX_LAST) {
483 Card->NextMemPage -= TX_BUF_SIZE;
490 * \fn void Ne2k_IRQHandler(int IntNum)
492 void Ne2k_IRQHandler(int IntNum)
496 for( i = 0; i < giNe2k_CardCount; i++ )
498 if(gpNe2k_Cards[i].IRQ == IntNum)
500 byte = inb( gpNe2k_Cards[i].IOBase + ISR );
502 // 0: Packet recieved (no error)
505 gpNe2k_Cards[i].NumWaitingPackets ++;
506 if( gpNe2k_Cards[i].NumWaitingPackets > MAX_PACKET_QUEUE )
507 gpNe2k_Cards[i].NumWaitingPackets = MAX_PACKET_QUEUE;
509 // 1: Packet sent (no error)
510 // 2: Recieved with error
511 // 3: Transmission Halted (Excessive Collisions)
512 // 4: Recieve Buffer Exhausted
514 // 6: Remote DMA Complete
516 //LOG("Clearing interrupts on card %i (was 0x%x)\n", i, byte);
517 outb( gpNe2k_Cards[i].IOBase + ISR, 0xFF ); // Reset All
521 Warning("[NE2K ] Recieved Unknown IRQ %i", IntNum);