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, 0);
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, 0, i)) != -1 )
138 card = &gaRTL8139_Cards[i];
139 base = PCI_AssignPort( id, 0, 0x100 );
141 card->IRQ = PCI_GetIRQ( id );
143 // Install IRQ Handler
144 IRQ_AddHandler(card->IRQ, RTL8139_IRQHandler);
147 outb( base + CONFIG1, 0x00 );
149 // Reset (0x10 to CMD)
150 outb( base + CMD, 0x10 );
151 while( inb(base + CMD) & 0x10 ) ;
153 // Set up recieve buffer
154 // - Allocate 3 pages below 4GiB for the recieve buffer (Allows 8k+16+1500)
155 card->ReceiveBuffer = (void*)MM_AllocDMA( 3, 32, &card->PhysReceiveBuffer );
156 card->ReceiveBufferLength = 8*1024+16;
157 outd(base + RBSTART, (Uint32)card->PhysReceiveBuffer);
159 outd(base + CAPR, 0);
160 // Set IMR to Transmit OK and Receive OK
161 outw(base + IMR, 0x5);
163 // Set up transmit buffers
164 // - 2 non-contiguous pages (each page can fit 2 1500 byte packets)
165 card->TransmitBuffers[0] = (void*)MM_AllocDMA( 1, 32, &card->PhysTransmitBuffers[0] );
166 card->TransmitBuffers[1] = card->TransmitBuffers[0] + 0x800;
167 card->PhysTransmitBuffers[1] = card->PhysTransmitBuffers[0] + 0x800;
169 card->TransmitBuffers[2] = (void*)MM_AllocDMA( 1, 32, &card->PhysTransmitBuffers[2] );
170 card->TransmitBuffers[3] = card->TransmitBuffers[2] + 0x800;
171 card->PhysTransmitBuffers[3] = card->PhysTransmitBuffers[2] + 0x800;
173 outd(base + TSAD0, card->PhysTransmitBuffers[0]);
174 outd(base + TSAD1, card->PhysTransmitBuffers[1]);
175 outd(base + TSAD2, card->PhysTransmitBuffers[2]);
176 outd(base + TSAD3, card->PhysTransmitBuffers[3]);
178 // Set recieve buffer size and recieve mask
179 // - Bit 7 being unset tells the card to overflow the recieve buffer if needed
180 // (i.e. when the packet starts at the end of the bufffer, it overflows up
182 outd(base + RCR, 0x0F);
184 // Recive Enable and Transmit Enable
185 outb(base + CMD, 0x0C);
187 // Get the card's MAC address
188 card->MacAddr[0] = inb(base+MAC0);
189 card->MacAddr[1] = inb(base+MAC1);
190 card->MacAddr[2] = inb(base+MAC2);
191 card->MacAddr[3] = inb(base+MAC3);
192 card->MacAddr[4] = inb(base+MAC4);
193 card->MacAddr[5] = inb(base+MAC5);
196 card->Name[0] = '0'+i;
197 card->Name[1] = '\0';
198 card->Node.ImplPtr = card;
199 card->Node.NumACLs = 0;
200 card->Node.CTime = now();
201 card->Node.Write = RTL8139_Write;
202 card->Node.Read = RTL8139_Read;
203 card->Node.IOCtl = RTL8139_IOCtl;
205 Log_Log("RTL8139", "Card %i 0x%04x, IRQ %i %02x:%02x:%02x:%02x:%02x:%02x",
206 i, card->IOBase, card->IRQ,
207 card->MacAddr[0], card->MacAddr[1], card->MacAddr[2],
208 card->MacAddr[3], card->MacAddr[4], card->MacAddr[5]
214 gRTL8139_DriverInfo.RootNode.Size = giRTL8139_CardCount;
215 DevFS_AddDevice( &gRTL8139_DriverInfo );
217 return MODULE_ERR_OK;
220 // --- Root Functions ---
221 char *RTL8139_ReadDir(tVFS_Node *Node, int Pos)
223 if( Pos < 0 || Pos >= giRTL8139_CardCount ) return NULL;
225 return strdup( gaRTL8139_Cards[Pos].Name );
228 tVFS_Node *RTL8139_FindDir(tVFS_Node *Node, const char *Filename)
230 //TODO: It might be an idea to supprt >10 cards
231 if(Filename[0] == '\0' || Filename[1] != '\0') return NULL;
232 if(Filename[0] < '0' || Filename[0] > '9') return NULL;
233 return &gaRTL8139_Cards[ Filename[0]-'0' ].Node;
236 const char *csaRTL8139_RootIOCtls[] = {DRV_IOCTLNAMES, NULL};
237 int RTL8139_RootIOCtl(tVFS_Node *Node, int ID, void *Data)
239 ENTER("pNode iID pData", Node, ID, Data);
242 BASE_IOCTLS(DRV_TYPE_NETWORK, "RTL8139", VERSION, csaRTL8139_RootIOCtls);
248 // --- File Functions ---
249 Uint64 RTL8139_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
251 tCard *card = Node->ImplPtr;
252 Uint16 read_ofs, pkt_length;
255 ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
258 if( Semaphore_Wait( &card->ReadSemaphore, 1 ) != 1 )
263 Mutex_Acquire( &card->ReadMutex );
265 read_ofs = (inw( card->IOBase + CAPR ) + 0x10) & 0xFFFF;
266 LOG("read_ofs = %i", read_ofs);
268 pkt_length = *(Uint16*)&card->ReceiveBuffer[read_ofs+2];
270 // Calculate new read offset
271 new_read_ofs = read_ofs + pkt_length + 4;
272 new_read_ofs = (new_read_ofs + 3) & ~3; // Align
273 if(new_read_ofs > card->ReceiveBufferLength) new_read_ofs = 0;
274 new_read_ofs -= 0x10; // I dunno
277 if( *(Uint16*)&card->ReceiveBuffer[read_ofs] & 0x1E ) {
279 outd(card->IOBase + CAPR, new_read_ofs);
280 Mutex_Release( &card->ReadMutex );
281 goto retry; // I feel evil
285 if( Length > pkt_length ) Length = pkt_length;
286 memcpy(Buffer, &card->ReceiveBuffer[read_ofs+4], Length);
289 outw(card->IOBase + CAPR, new_read_ofs);
291 Mutex_Release( &card->ReadMutex );
298 Uint64 RTL8139_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
302 tCard *card = Node->ImplPtr;
304 if( Length > 1500 ) return 0; // MTU exceeded
306 ENTER("pNode XLength pBuffer", Node, Length, Buffer);
308 // TODO: Implement a semaphore for avaliable transmit buffers
310 td = card->CurTXDecscriptor;
312 // Find an avaliable descriptor
313 while( card->TransmitInUse & (1 << td) )
318 // Transmit using descriptor `td`
319 card->TransmitInUse |= (1 << td);
320 outd(card->IOBase + TSAD0 + td*4, card->PhysTransmitBuffers[td]);
321 LOG("card->PhysTransmitBuffers[td] = 0x%llx", card->PhysTransmitBuffers[td]);
323 memcpy(card->TransmitBuffers[td], Buffer, Length);
326 status |= Length & 0x1FFF; // 0-12: Length
327 status |= 0 << 13; // 13: OWN bit
328 status |= (0 & 0x3F) << 16; // 16-21: Early TX threshold (zero atm, TODO: check)
329 LOG("status = 0x%08x", status);
330 outd(card->IOBase + TSD0 + td*4, status);
332 card->CurTXDecscriptor ++;
333 card->CurTXDecscriptor %= 4;
335 LEAVE('i', (int)Length);
340 const char *csaRTL8139_NodeIOCtls[] = {DRV_IOCTLNAMES, NULL};
341 int RTL8139_IOCtl(tVFS_Node *Node, int ID, void *Data)
343 tCard *card = Node->ImplPtr;
344 ENTER("pNode iID pData", Node, ID, Data);
347 BASE_IOCTLS(DRV_TYPE_NETWORK, "RTL8139", VERSION, csaRTL8139_NodeIOCtls);
348 case NET_IOCTL_GETMAC:
349 if( !CheckMem(Data, 6) ) {
353 memcpy( Data, card->MacAddr, 6 );
361 void RTL8139_IRQHandler(int Num)
367 for( i = 0; i < giRTL8139_CardCount; i ++ )
369 card = &gaRTL8139_Cards[i];
370 if( Num != card->IRQ ) break;
372 status = inw(card->IOBase + ISR);
373 LOG("status = 0x%02x", status);
375 // Transmit OK, a transmit descriptor is now free
376 if( status & FLAG_ISR_TOK )
378 for( j = 0; j < 4; j ++ )
380 if( ind(card->IOBase + TSD0 + j*4) & 0x8000 ) { // TSD TOK
381 card->TransmitInUse &= ~(1 << j);
382 // TODO: Update semaphore once implemented
385 outw(card->IOBase + ISR, FLAG_ISR_TOK);
388 // Recieve OK, inform read
389 if( status & FLAG_ISR_ROK )
391 int read_ofs, end_ofs;
392 int packet_count = 0;
394 // Scan recieve buffer for packets
395 end_ofs = inw(card->IOBase + CBA);
396 read_ofs = card->SeenOfs;
397 LOG("read_ofs = %i, end_ofs = %i", read_ofs, end_ofs);
398 if( read_ofs > end_ofs )
400 while( read_ofs < card->ReceiveBufferLength )
403 LOG("%i 0x%x Pkt Hdr: 0x%04x, len: 0x%04x",
404 packet_count, read_ofs,
405 *(Uint16*)&card->ReceiveBuffer[read_ofs],
406 *(Uint16*)&card->ReceiveBuffer[read_ofs+2]
408 read_ofs += *(Uint16*)&card->ReceiveBuffer[read_ofs+2] + 4;
409 read_ofs = (read_ofs + 3) & ~3; // Align
414 while( read_ofs < end_ofs )
416 LOG("%i 0x%x Pkt Hdr: 0x%04x, len: 0x%04x",
417 packet_count, read_ofs,
418 *(Uint16*)&card->ReceiveBuffer[read_ofs],
419 *(Uint16*)&card->ReceiveBuffer[read_ofs+2]
422 read_ofs += *(Uint16*)&card->ReceiveBuffer[read_ofs+2] + 4;
423 read_ofs = (read_ofs + 3) & ~3; // Align
425 card->SeenOfs = read_ofs;
427 LOG("packet_count = %i, read_ofs = 0x%x", packet_count, read_ofs);
431 if( Semaphore_Signal( &card->ReadSemaphore, packet_count ) != packet_count ) {
434 VFS_MarkAvaliable( &card->Node, 1 );
437 outw(card->IOBase + ISR, FLAG_ISR_ROK);