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