4 * See: ~/Sources/bochs/bochs.../iodev/ne2k.cc
7 #define VERSION ((0<<8)|50)
12 #include <tpl_drv_network.h>
13 #include <semaphore.h>
16 #define MEM_START 0x40
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
29 } csaCOMPAT_DEVICES[] = {
30 {0x10EC, 0x8029}, // Realtek 8029
31 {0x10EC, 0x8129} // Realtek 8129
33 #define NUM_COMPAT_DEVICES ((int)(sizeof(csaCOMPAT_DEVICES)/sizeof(csaCOMPAT_DEVICES[0])))
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
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)
65 enum eNe2k_Page1Read {
66 CURR = 7 //!< current page
70 typedef struct sNe2k_Card {
71 Uint16 IOBase; //!< IO Port Address from PCI
72 Uint8 IRQ; //!< IRQ Assigned from PCI
75 // int NumWaitingPackets;
78 int NextMemPage; //!< Next Card Memory page to use
80 Uint8 Buffer[RX_BUF_SIZE*256];
88 int Ne2k_Install(char **Arguments);
89 char *Ne2k_ReadDir(tVFS_Node *Node, int Pos);
90 tVFS_Node *Ne2k_FindDir(tVFS_Node *Node, const char *Name);
91 int Ne2k_IOCtl(tVFS_Node *Node, int ID, void *Data);
92 Uint64 Ne2k_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
93 Uint64 Ne2k_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
94 Uint8 Ne2k_int_GetWritePage(tCard *Card, Uint16 Length);
95 void Ne2k_IRQHandler(int IntNum);
98 MODULE_DEFINE(0, VERSION, Ne2k, Ne2k_Install, NULL, NULL);
99 tDevFS_Driver gNe2k_DriverInfo = {
103 .ACLs = &gVFS_ACL_EveryoneRX,
104 .Flags = VFS_FFLAG_DIRECTORY,
105 .ReadDir = Ne2k_ReadDir,
106 .FindDir = Ne2k_FindDir,
110 Uint16 gNe2k_BaseAddress;
111 int giNe2k_CardCount = 0;
112 tCard *gpNe2k_Cards = NULL;
116 * \fn int Ne2k_Install(char **Options)
117 * \brief Installs the NE2000 Driver
119 int Ne2k_Install(char **Options)
124 // --- Scan PCI Bus ---
126 giNe2k_CardCount = 0;
127 for( i = 0; i < NUM_COMPAT_DEVICES; i ++ )
129 giNe2k_CardCount += PCI_CountDevices( csaCOMPAT_DEVICES[i].Vendor, csaCOMPAT_DEVICES[i].Device, 0 );
132 if( giNe2k_CardCount == 0 ) {
133 Log_Warning("Ne2k", "No cards detected");
134 return MODULE_ERR_NOTNEEDED;
139 gpNe2k_Cards = calloc( giNe2k_CardCount, sizeof(tCard) );
141 for( i = 0; i < NUM_COMPAT_DEVICES; i ++ )
143 count = PCI_CountDevices( csaCOMPAT_DEVICES[i].Vendor, csaCOMPAT_DEVICES[i].Device, 0 );
144 for( j = 0; j < count; j ++,k ++ )
146 id = PCI_GetDevice( csaCOMPAT_DEVICES[i].Vendor, csaCOMPAT_DEVICES[i].Device, 0, j );
148 base = PCI_AssignPort( id, 0, 0x20 );
149 gpNe2k_Cards[ k ].IOBase = base;
150 gpNe2k_Cards[ k ].IRQ = PCI_GetIRQ( id );
151 gpNe2k_Cards[ k ].NextMemPage = 64;
152 gpNe2k_Cards[ k ].NextRXPage = RX_FIRST;
154 // Install IRQ Handler
155 IRQ_AddHandler(gpNe2k_Cards[ k ].IRQ, Ne2k_IRQHandler);
158 outb( base + 0x1F, inb(base + 0x1F) );
159 while( (inb( base+ISR ) & 0x80) == 0 );
160 outb( base + ISR, 0x80 );
163 outb( base + CMD, 0x40|0x21 ); // Page 1, No DMA, Stop
164 outb( base + CURR, RX_FIRST ); // Current RX page
165 outb( base + CMD, 0x21 ); // No DMA and Stop
166 outb( base + DCR, 0x49 ); // Set WORD mode
167 outb( base + IMR, 0x00 ); // Interrupt Mask Register
168 outb( base + ISR, 0xFF );
169 outb( base + RCR, 0x20 ); // Reciever to Monitor
170 outb( base + TCR, 0x02 ); // Transmitter OFF (TCR.LB = 1, Internal Loopback)
171 outb( base + RBCR0, 6*4 ); // Remote Byte Count
172 outb( base + RBCR1, 0 );
173 outb( base + RSAR0, 0 ); // Clear Source Address
174 outb( base + RSAR1, 0 );
175 outb( base + CMD, 0x0A ); // Remote Read, Start
178 gpNe2k_Cards[ k ].MacAddr[0] = inb(base+0x10);// inb(base+0x10);
179 gpNe2k_Cards[ k ].MacAddr[1] = inb(base+0x10);// inb(base+0x10);
180 gpNe2k_Cards[ k ].MacAddr[2] = inb(base+0x10);// inb(base+0x10);
181 gpNe2k_Cards[ k ].MacAddr[3] = inb(base+0x10);// inb(base+0x10);
182 gpNe2k_Cards[ k ].MacAddr[4] = inb(base+0x10);// inb(base+0x10);
183 gpNe2k_Cards[ k ].MacAddr[5] = inb(base+0x10);// inb(base+0x10);
185 outb( base+PSTART, RX_FIRST); // Set Receive Start
186 outb( base+BNRY, RX_LAST-1); // Set Boundary Page
187 outb( base+PSTOP, RX_LAST); // Set Stop Page
188 outb( base+ISR, 0xFF ); // Clear all ints
189 outb( base+CMD, 0x22 ); // No DMA, Start
190 outb( base+IMR, 0x3F ); // Set Interupt Mask
191 outb( base+RCR, 0x0F ); // Set WRAP and allow all packet matches
192 outb( base+TCR, 0x00 ); // Set Normal Transmitter mode
193 outb( base+TPSR, 0x40); // Set Transmit Start
196 Ne2k_WriteReg(base, MAC0, gpNe2k_Cards[ k ].MacAddr[0]);
197 Ne2k_WriteReg(base, MAC1, gpNe2k_Cards[ k ].MacAddr[1]);
198 Ne2k_WriteReg(base, MAC2, gpNe2k_Cards[ k ].MacAddr[2]);
199 Ne2k_WriteReg(base, MAC3, gpNe2k_Cards[ k ].MacAddr[3]);
200 Ne2k_WriteReg(base, MAC4, gpNe2k_Cards[ k ].MacAddr[4]);
201 Ne2k_WriteReg(base, MAC5, gpNe2k_Cards[ k ].MacAddr[5]);
204 Log_Log("Ne2k", "Card %i 0x%04x IRQ%i %02x:%02x:%02x:%02x:%02x:%02x",
205 k, base, gpNe2k_Cards[ k ].IRQ,
206 gpNe2k_Cards[k].MacAddr[0], gpNe2k_Cards[k].MacAddr[1],
207 gpNe2k_Cards[k].MacAddr[2], gpNe2k_Cards[k].MacAddr[3],
208 gpNe2k_Cards[k].MacAddr[4], gpNe2k_Cards[k].MacAddr[5]
212 gpNe2k_Cards[ k ].Name[0] = '0'+k;
213 gpNe2k_Cards[ k ].Name[1] = '\0';
214 gpNe2k_Cards[ k ].Node.ImplPtr = &gpNe2k_Cards[ k ];
215 gpNe2k_Cards[ k ].Node.NumACLs = 0; // Root Only
216 gpNe2k_Cards[ k ].Node.CTime = now();
217 gpNe2k_Cards[ k ].Node.Write = Ne2k_Write;
218 gpNe2k_Cards[ k ].Node.Read = Ne2k_Read;
219 gpNe2k_Cards[ k ].Node.IOCtl = Ne2k_IOCtl;
221 // Initialise packet semaphore
222 // - Start at zero, no max
223 Semaphore_Init( &gpNe2k_Cards[k].Semaphore, 0, 0, "NE2000", gpNe2k_Cards[ k ].Name );
227 gNe2k_DriverInfo.RootNode.Size = giNe2k_CardCount;
228 DevFS_AddDevice( &gNe2k_DriverInfo );
229 return MODULE_ERR_OK;
233 * \fn char *Ne2k_ReadDir(tVFS_Node *Node, int Pos)
235 char *Ne2k_ReadDir(tVFS_Node *Node, int Pos)
238 if(Pos < 0 || Pos >= giNe2k_CardCount) return NULL;
245 * \fn tVFS_Node *Ne2k_FindDir(tVFS_Node *Node, const char *Name)
247 tVFS_Node *Ne2k_FindDir(tVFS_Node *Node, const char *Name)
249 if(Name[0] == '\0' || Name[1] != '\0') return NULL;
251 return &gpNe2k_Cards[ Name[0]-'0' ].Node;
254 static const char *casIOCtls[] = { DRV_IOCTLNAMES, DRV_NETWORK_IOCTLNAMES, NULL };
256 * \fn int Ne2k_IOCtl(tVFS_Node *Node, int ID, void *Data)
257 * \brief IOCtl calls for a network device
259 int Ne2k_IOCtl(tVFS_Node *Node, int ID, void *Data)
261 ENTER("pNode iID pData", Node, ID, Data);
264 BASE_IOCTLS(DRV_TYPE_NETWORK, "NE2000", VERSION, casIOCtls);
267 // If this is the root, return
268 if( Node == &gNe2k_DriverInfo.RootNode ) {
273 // Device specific settings
276 case NET_IOCTL_GETMAC:
277 if( !CheckMem(Data, 6) ) {
281 memcpy( Data, ((tCard*)Node->ImplPtr)->MacAddr, 6 );
290 * \fn Uint64 Ne2k_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
291 * \brief Send a packet from the network card
293 Uint64 Ne2k_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
295 tCard *Card = (tCard*)Node->ImplPtr;
296 Uint16 *buf = Buffer;
300 ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
302 // Sanity Check Length
303 if(Length > TX_BUF_SIZE*256) {
306 "Ne2k_Write - Attempting to send over TX_BUF_SIZE*256 (%i) bytes (%i)",
307 TX_BUF_SIZE*256, Length
313 // Make sure that the card is in page 0
314 outb(Card->IOBase + CMD, 0|0x22); // Page 0, Start, NoDMA
316 // Clear Remote DMA Flag
317 outb(Card->IOBase + ISR, 0x40); // Bit 6
319 // Send Size - Remote Byte Count Register
320 outb(Card->IOBase + TBCR0, Length & 0xFF);
321 outb(Card->IOBase + TBCR1, Length >> 8);
323 // Send Size - Remote Byte Count Register
324 outb(Card->IOBase + RBCR0, Length & 0xFF);
325 outb(Card->IOBase + RBCR1, Length >> 8);
328 outb(Card->IOBase + RSAR0, 0x00); // Page Offset
329 page = Ne2k_int_GetWritePage(Card, Length);
330 outb(Card->IOBase + RSAR1, page); // Page Offset
332 //outb(Card->IOBase + CMD, 0|0x18|0x4|0x2); // Page 0, Transmit Packet, TXP, Start
333 outb(Card->IOBase + CMD, 0|0x10|0x2); // Page 0, Remote Write, Start
336 for(rem = Length; rem > 0; rem -= 2) {
337 outw(Card->IOBase + 0x10, *buf++);
340 while( inb(Card->IOBase + ISR) == 0 ) // Wait for Remote DMA Complete
343 outb( Card->IOBase + ISR, 0x40 ); // ACK Interrupt
346 outb(Card->IOBase + TPSR, page);
347 outb(Card->IOBase + CMD, 0|0x10|0x4|0x2);
350 //outb(Card->IOBase + CMD, 0|0x20);
357 * \fn Uint64 Ne2k_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
358 * \brief Wait for and read a packet from the network card
360 Uint64 Ne2k_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
362 tCard *Card = (tCard*)Node->ImplPtr;
368 Uint8 NextPacketPage;
369 Uint16 Length; // Little Endian
372 ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
375 Semaphore_Wait( &Card->Semaphore, 1 );
377 // Make sure that the card is in page 0
378 outb(Card->IOBase + CMD, 0|0x22); // Page 0, Start, NoDMA
381 page = Card->NextRXPage;
384 outb(Card->IOBase + RBCR0, 0);
385 outb(Card->IOBase + RBCR1, 1); // 256-bytes
386 outb(Card->IOBase + RSAR0, 0x00); // Page Offset
387 outb(Card->IOBase + RSAR1, page); // Page Number
389 outb(Card->IOBase + CMD, 0|0x08|0x2); // Page 0, Remote Read, Start
391 // Clear Remote DMA Flag
392 outb(Card->IOBase + ISR, 0x40); // Bit 6
395 for(i = 0; i < 128; i ++)
396 ((Uint16*)data)[i] = inw(Card->IOBase + 0x10);
398 pktHdr = (void*)data;
399 //Log("Ne2k_Read: Recieved packet (%i bytes)", pktHdr->Length);
401 // Have we read all the required bytes yet?
402 if(pktHdr->Length < 256 - 4)
404 if(Length > pktHdr->Length)
405 Length = pktHdr->Length;
406 memcpy(Buffer, &data[4], Length);
408 if(page == RX_LAST+1) page = RX_FIRST;
410 // No? oh damn, now we need to allocate a buffer
413 char *buf = malloc( (pktHdr->Length + 4 + 255) & ~255 );
420 memcpy(buf, data, 256);
423 while(page != pktHdr->NextPacketPage)
425 if(page == RX_LAST+1) page = RX_FIRST;
427 outb(Card->IOBase + RBCR0, 0);
428 outb(Card->IOBase + RBCR1, 1); // 256-bytes
429 outb(Card->IOBase + RSAR0, 0x00); // Page Offset
430 outb(Card->IOBase + RSAR1, page); // Page Number
431 outb(Card->IOBase + CMD, 0|0x08|0x2); // Page 0, Remote Read, Start
433 for(i = 0; i < 128; i ++)
434 ((Uint16*)buf)[j+i] = inw(Card->IOBase + 0x10);
439 if(Length > pktHdr->Length)
440 Length = pktHdr->Length;
441 memcpy(Buffer, &buf[4], Length);
446 outb( Card->IOBase + BNRY, RX_LAST );
448 outb( Card->IOBase + BNRY, page-1 );
449 // Set next RX Page and decrement the waiting list
450 Card->NextRXPage = page;
457 * \fn Uint8 Ne2k_int_GetWritePage(tCard *Card, Uint16 Length)
459 Uint8 Ne2k_int_GetWritePage(tCard *Card, Uint16 Length)
461 Uint8 ret = Card->NextMemPage;
463 Card->NextMemPage += (Length + 0xFF) >> 8;
464 if(Card->NextMemPage >= TX_LAST) {
465 Card->NextMemPage -= TX_BUF_SIZE;
472 * \fn void Ne2k_IRQHandler(int IntNum)
474 void Ne2k_IRQHandler(int IntNum)
478 for( i = 0; i < giNe2k_CardCount; i++ )
480 if(gpNe2k_Cards[i].IRQ == IntNum)
482 byte = inb( gpNe2k_Cards[i].IOBase + ISR );
484 // 0: Packet recieved (no error)
487 //if( gpNe2k_Cards[i].NumWaitingPackets > MAX_PACKET_QUEUE )
488 // gpNe2k_Cards[i].NumWaitingPackets = MAX_PACKET_QUEUE;
489 Semaphore_Signal( &gpNe2k_Cards[i].Semaphore, 1 );
491 // 1: Packet sent (no error)
492 // 2: Recieved with error
493 // 3: Transmission Halted (Excessive Collisions)
494 // 4: Recieve Buffer Exhausted
496 // 6: Remote DMA Complete
498 //LOG("Clearing interrupts on card %i (was 0x%x)\n", i, byte);
499 outb( gpNe2k_Cards[i].IOBase + ISR, 0xFF ); // Reset All
503 Log_Warning("Ne2k", "Recieved Unknown IRQ %i", IntNum);