2 * Acess2 RTL8139 Driver
3 * - By John Hodge (thePowersGang)
6 #define VERSION ((0<<8)|20)
11 #include <tpl_drv_network.h>
12 #include <semaphore.h>
15 #define VENDOR_ID 0x10EC
16 #define DEVICE_ID 0x8139
24 // Multicast Registers
25 MAR0 = 0x08, MAR1, MAR2, MAR3,
26 MAR4, MAR5, MAR6, MAR7,
28 // Transmit status of descriptors 0 - 3
29 TSD0 = 0x10, TSD1 = 0x14,
30 TSD2 = 0x18, TSD3 = 0x1C,
31 // Transmit start addresses
32 TSAD0 = 0x20, TSAD1 = 0x24,
33 TSAD2 = 0x28, TSAD3 = 0x2C,
35 RBSTART = 0x30, //!< Recieve Buffer Start (DWord)
36 // Early Recieve Byte Count
37 ERBCR = 0x34, // 16-bits
38 // Early RX Status Register
41 // ??, ??, ??, RST, RE, TE, ??, ??
44 CAPR = 0x38, // Current address of packet read
45 CBA = 0x3A, // Current Buffer Address - Total byte count in RX buffer
47 IMR = 0x3C, // Interrupt mask register
48 ISR = 0x3E, // Interrupt status register
50 TCR = 0x40, // Transmit Configuration Register
51 RCR = 0x44, // Recieve Configuration Register
52 TCTR = 0x48, // 32-bit timer (count)
53 MPC = 0x4C, // Missed packet count (due to RX overflow)
59 TIMERINT = 0x54, // Fires a timeout when TCTR equals this value
63 #define FLAG_ISR_TOK 0x04
64 #define FLAG_ISR_ROK 0x01
72 int NumWaitingPackets;
75 tPAddr PhysReceiveBuffer;
76 int ReceiveBufferLength;
77 int SeenOfs; //!< End of the most recently seen packet (by IRQ)
79 tSemaphore ReadSemaphore;
81 char *TransmitBuffers[4];
82 tPAddr PhysTransmitBuffers[4];
83 BOOL TransmitInUse; // Flags for each transmit descriptor
92 int RTL8139_Install(char **Options);
93 char *RTL8139_ReadDir(tVFS_Node *Node, int Pos);
94 tVFS_Node *RTL8139_FindDir(tVFS_Node *Node, const char *Filename);
95 int RTL8139_RootIOCtl(tVFS_Node *Node, int ID, void *Arg);
96 Uint64 RTL8139_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
97 Uint64 RTL8139_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
98 int RTL8139_IOCtl(tVFS_Node *Node, int ID, void *Arg);
99 void RTL8139_IRQHandler(int Num);
102 MODULE_DEFINE(0, VERSION, RTL8139, RTL8139_Install, NULL, NULL);
103 tDevFS_Driver gRTL8139_DriverInfo = {
107 .ACLs = &gVFS_ACL_EveryoneRX,
108 .Flags = VFS_FFLAG_DIRECTORY,
109 .ReadDir = RTL8139_ReadDir,
110 .FindDir = RTL8139_FindDir,
111 .IOCtl = RTL8139_RootIOCtl
114 int giRTL8139_CardCount;
115 tCard *gaRTL8139_Cards;
119 * \brief Installs the RTL8139 Driver
121 int RTL8139_Install(char **Options)
128 giRTL8139_CardCount = PCI_CountDevices(VENDOR_ID, DEVICE_ID);
129 Log_Debug("RTL8139", "%i cards", giRTL8139_CardCount);
131 if( giRTL8139_CardCount == 0 ) return MODULE_ERR_NOTNEEDED;
133 gaRTL8139_Cards = calloc( giRTL8139_CardCount, sizeof(tCard) );
135 //while( (id = PCI_GetDevice(0x10EC, 0x8139, 0, id)) != -1 )
136 while( (id = PCI_GetDevice(VENDOR_ID, DEVICE_ID, i)) != -1 )
138 card = &gaRTL8139_Cards[i];
139 base = PCI_GetBAR( id, 0 );
141 Log_Warning("RTL8139", "Driver does not support MMIO, skipping card");
148 card->IRQ = PCI_GetIRQ( id );
150 // Install IRQ Handler
151 IRQ_AddHandler(card->IRQ, RTL8139_IRQHandler);
154 outb( base + CONFIG1, 0x00 );
156 // Reset (0x10 to CMD)
157 outb( base + CMD, 0x10 );
158 while( inb(base + CMD) & 0x10 ) ;
160 // Set up recieve buffer
161 // - Allocate 3 pages below 4GiB for the recieve buffer (Allows 8k+16+1500)
162 card->ReceiveBuffer = (void*)MM_AllocDMA( 3, 32, &card->PhysReceiveBuffer );
163 card->ReceiveBufferLength = 8*1024+16;
164 outd(base + RBSTART, (Uint32)card->PhysReceiveBuffer);
166 outd(base + CAPR, 0);
167 // Set IMR to Transmit OK and Receive OK
168 outw(base + IMR, 0x5);
170 // Set up transmit buffers
171 // - 2 non-contiguous pages (each page can fit 2 1500 byte packets)
172 card->TransmitBuffers[0] = (void*)MM_AllocDMA( 1, 32, &card->PhysTransmitBuffers[0] );
173 card->TransmitBuffers[1] = card->TransmitBuffers[0] + 0x800;
174 card->PhysTransmitBuffers[1] = card->PhysTransmitBuffers[0] + 0x800;
176 card->TransmitBuffers[2] = (void*)MM_AllocDMA( 1, 32, &card->PhysTransmitBuffers[2] );
177 card->TransmitBuffers[3] = card->TransmitBuffers[2] + 0x800;
178 card->PhysTransmitBuffers[3] = card->PhysTransmitBuffers[2] + 0x800;
180 outd(base + TSAD0, card->PhysTransmitBuffers[0]);
181 outd(base + TSAD1, card->PhysTransmitBuffers[1]);
182 outd(base + TSAD2, card->PhysTransmitBuffers[2]);
183 outd(base + TSAD3, card->PhysTransmitBuffers[3]);
185 // Set recieve buffer size and recieve mask
186 // - Bit 7 being unset tells the card to overflow the recieve buffer if needed
187 // (i.e. when the packet starts at the end of the bufffer, it overflows up
189 outd(base + RCR, 0x0F);
191 // Recive Enable and Transmit Enable
192 outb(base + CMD, 0x0C);
194 // Get the card's MAC address
195 card->MacAddr[0] = inb(base+MAC0);
196 card->MacAddr[1] = inb(base+MAC1);
197 card->MacAddr[2] = inb(base+MAC2);
198 card->MacAddr[3] = inb(base+MAC3);
199 card->MacAddr[4] = inb(base+MAC4);
200 card->MacAddr[5] = inb(base+MAC5);
203 card->Name[0] = '0'+i;
204 card->Name[1] = '\0';
205 card->Node.ImplPtr = card;
206 card->Node.NumACLs = 0;
207 card->Node.CTime = now();
208 card->Node.Write = RTL8139_Write;
209 card->Node.Read = RTL8139_Read;
210 card->Node.IOCtl = RTL8139_IOCtl;
212 Log_Log("RTL8139", "Card %i 0x%04x, IRQ %i %02x:%02x:%02x:%02x:%02x:%02x",
213 i, card->IOBase, card->IRQ,
214 card->MacAddr[0], card->MacAddr[1], card->MacAddr[2],
215 card->MacAddr[3], card->MacAddr[4], card->MacAddr[5]
221 gRTL8139_DriverInfo.RootNode.Size = giRTL8139_CardCount;
222 DevFS_AddDevice( &gRTL8139_DriverInfo );
224 return MODULE_ERR_OK;
227 // --- Root Functions ---
228 char *RTL8139_ReadDir(tVFS_Node *Node, int Pos)
230 if( Pos < 0 || Pos >= giRTL8139_CardCount ) return NULL;
232 return strdup( gaRTL8139_Cards[Pos].Name );
235 tVFS_Node *RTL8139_FindDir(tVFS_Node *Node, const char *Filename)
237 //TODO: It might be an idea to supprt >10 cards
238 if(Filename[0] == '\0' || Filename[1] != '\0') return NULL;
239 if(Filename[0] < '0' || Filename[0] > '9') return NULL;
240 return &gaRTL8139_Cards[ Filename[0]-'0' ].Node;
243 const char *csaRTL8139_RootIOCtls[] = {DRV_IOCTLNAMES, NULL};
244 int RTL8139_RootIOCtl(tVFS_Node *Node, int ID, void *Data)
246 ENTER("pNode iID pData", Node, ID, Data);
249 BASE_IOCTLS(DRV_TYPE_NETWORK, "RTL8139", VERSION, csaRTL8139_RootIOCtls);
255 // --- File Functions ---
256 Uint64 RTL8139_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
258 tCard *card = Node->ImplPtr;
259 Uint16 read_ofs, pkt_length;
262 ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
265 if( Semaphore_Wait( &card->ReadSemaphore, 1 ) != 1 )
270 Mutex_Acquire( &card->ReadMutex );
272 read_ofs = (inw( card->IOBase + CAPR ) + 0x10) & 0xFFFF;
273 LOG("read_ofs = %i", read_ofs);
275 pkt_length = *(Uint16*)&card->ReceiveBuffer[read_ofs+2];
277 // Calculate new read offset
278 new_read_ofs = read_ofs + pkt_length + 4;
279 new_read_ofs = (new_read_ofs + 3) & ~3; // Align
280 if(new_read_ofs > card->ReceiveBufferLength) new_read_ofs = 0;
281 new_read_ofs -= 0x10; // I dunno
284 if( *(Uint16*)&card->ReceiveBuffer[read_ofs] & 0x1E ) {
286 outd(card->IOBase + CAPR, new_read_ofs);
287 Mutex_Release( &card->ReadMutex );
288 goto retry; // I feel evil
292 if( Length > pkt_length ) Length = pkt_length;
293 memcpy(Buffer, &card->ReceiveBuffer[read_ofs+4], Length);
296 outw(card->IOBase + CAPR, new_read_ofs);
298 Mutex_Release( &card->ReadMutex );
305 Uint64 RTL8139_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
309 tCard *card = Node->ImplPtr;
311 if( Length > 1500 ) return 0; // MTU exceeded
313 ENTER("pNode XLength pBuffer", Node, Length, Buffer);
315 // TODO: Implement a semaphore for avaliable transmit buffers
317 td = card->CurTXDecscriptor;
319 // Find an avaliable descriptor
320 while( card->TransmitInUse & (1 << td) )
325 // Transmit using descriptor `td`
326 LOG("card->PhysTransmitBuffers[td] = %P", card->PhysTransmitBuffers[td]);
327 card->TransmitInUse |= (1 << td);
328 outd(card->IOBase + TSAD0 + td*4, card->PhysTransmitBuffers[td]);
329 LOG("card->TransmitBuffers[td] = %p", card->TransmitBuffers[td]);
331 memcpy(card->TransmitBuffers[td], Buffer, Length);
334 status |= Length & 0x1FFF; // 0-12: Length
335 status |= 0 << 13; // 13: OWN bit
336 status |= (0 & 0x3F) << 16; // 16-21: Early TX threshold (zero atm, TODO: check)
337 LOG("status = 0x%08x", status);
338 outd(card->IOBase + TSD0 + td*4, status);
340 card->CurTXDecscriptor ++;
341 card->CurTXDecscriptor %= 4;
343 LEAVE('i', (int)Length);
348 const char *csaRTL8139_NodeIOCtls[] = {DRV_IOCTLNAMES, NULL};
349 int RTL8139_IOCtl(tVFS_Node *Node, int ID, void *Data)
351 tCard *card = Node->ImplPtr;
352 ENTER("pNode iID pData", Node, ID, Data);
355 BASE_IOCTLS(DRV_TYPE_NETWORK, "RTL8139", VERSION, csaRTL8139_NodeIOCtls);
356 case NET_IOCTL_GETMAC:
357 if( !CheckMem(Data, 6) ) {
361 memcpy( Data, card->MacAddr, 6 );
369 void RTL8139_IRQHandler(int Num)
375 LOG("Num = %i", Num);
377 for( i = 0; i < giRTL8139_CardCount; i ++ )
379 card = &gaRTL8139_Cards[i];
380 if( Num != card->IRQ ) break;
382 status = inw(card->IOBase + ISR);
383 LOG("status = 0x%02x", status);
385 // Transmit OK, a transmit descriptor is now free
386 if( status & FLAG_ISR_TOK )
388 for( j = 0; j < 4; j ++ )
390 if( ind(card->IOBase + TSD0 + j*4) & 0x8000 ) { // TSD TOK
391 card->TransmitInUse &= ~(1 << j);
392 // TODO: Update semaphore once implemented
395 outw(card->IOBase + ISR, FLAG_ISR_TOK);
398 // Recieve OK, inform read
399 if( status & FLAG_ISR_ROK )
401 int read_ofs, end_ofs;
402 int packet_count = 0;
404 // Scan recieve buffer for packets
405 end_ofs = inw(card->IOBase + CBA);
406 read_ofs = card->SeenOfs;
407 LOG("read_ofs = %i, end_ofs = %i", read_ofs, end_ofs);
408 if( read_ofs > end_ofs )
410 while( read_ofs < card->ReceiveBufferLength )
413 LOG("%i 0x%x Pkt Hdr: 0x%04x, len: 0x%04x",
414 packet_count, read_ofs,
415 *(Uint16*)&card->ReceiveBuffer[read_ofs],
416 *(Uint16*)&card->ReceiveBuffer[read_ofs+2]
418 read_ofs += *(Uint16*)&card->ReceiveBuffer[read_ofs+2] + 4;
419 read_ofs = (read_ofs + 3) & ~3; // Align
424 while( read_ofs < end_ofs )
426 LOG("%i 0x%x Pkt Hdr: 0x%04x, len: 0x%04x",
427 packet_count, read_ofs,
428 *(Uint16*)&card->ReceiveBuffer[read_ofs],
429 *(Uint16*)&card->ReceiveBuffer[read_ofs+2]
432 read_ofs += *(Uint16*)&card->ReceiveBuffer[read_ofs+2] + 4;
433 read_ofs = (read_ofs + 3) & ~3; // Align
435 card->SeenOfs = read_ofs;
437 LOG("packet_count = %i, read_ofs = 0x%x", packet_count, read_ofs);
441 if( Semaphore_Signal( &card->ReadSemaphore, packet_count ) != packet_count ) {
444 VFS_MarkAvaliable( &card->Node, 1 );
447 outw(card->IOBase + ISR, FLAG_ISR_ROK);