Modules/Network/NE2000/ne2000.c

   1 /* Acess2
   2  * NE2000 Driver
   3  *
   4  * See: ~/Sources/bochs/bochs.../iodev/ne2k.cc
   5  */
   6 #define DEBUG   0
   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 <tpl_drv_network.h>
  13
  14 // === CONSTANTS ===
  15 #define MEM_START       0x40
  16 #define MEM_END         0xC0
  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
  24
  25 static const struct {
  26         Uint16  Vendor;
  27         Uint16  Device;
  28 } csaCOMPAT_DEVICES[] = {
  29         {0x10EC, 0x8029},       // Realtek 8029
  30         {0x10EC, 0x8129}        // Realtek 8129
  31 };
  32 #define NUM_COMPAT_DEVICES      (sizeof(csaCOMPAT_DEVICES)/sizeof(csaCOMPAT_DEVICES[0]))
  33
  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
  46 };
  47
  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)
  62 };
  63
  64 enum eNe2k_Page1Read {
  65         CURR = 7        //!< current page
  66 };
  67
  68 // === TYPES ===
  69 typedef struct sNe2k_Card {
  70         Uint16  IOBase; //!< IO Port Address from PCI
  71         Uint8   IRQ;    //!< IRQ Assigned from PCI
  72
  73          int    NumWaitingPackets;
  74          int    NextRXPage;
  75
  76          int    NextMemPage;    //!< Next Card Memory page to use
  77
  78         Uint8   Buffer[RX_BUF_SIZE*256];
  79
  80         char    Name[2];        // "0"
  81         tVFS_Node       Node;
  82         Uint8   MacAddr[6];
  83 } tCard;
  84
  85 // === PROTOTYPES ===
  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);
  94
  95 // === GLOBALS ===
  96 MODULE_DEFINE(0, VERSION, Ne2k, Ne2k_Install, NULL, NULL);
  97 tDevFS_Driver   gNe2k_DriverInfo = {
  98         NULL, "ne2k",
  99         {
 100         .NumACLs = 1,
 101         .ACLs = &gVFS_ACL_EveryoneRX,
 102         .Flags = VFS_FFLAG_DIRECTORY,
 103         .ReadDir = Ne2k_ReadDir,
 104         .FindDir = Ne2k_FindDir,
 105         .IOCtl = Ne2k_IOCtl
 106         }
 107 };
 108 Uint16  gNe2k_BaseAddress;
 109  int    giNe2k_CardCount = 0;
 110 tCard   *gpNe2k_Cards = NULL;
 111
 112 // === CODE ===
 113 /**
 114  * \fn int Ne2k_Install(char **Options)
 115  * \brief Installs the NE2000 Driver
 116  */
 117 int Ne2k_Install(char **Options)
 118 {
 119          int    i, j, k;
 120          int    count, id, base;
 121
 122         // --- Scan PCI Bus ---
 123         // Count Cards
 124         giNe2k_CardCount = 0;
 125         for( i = 0; i < NUM_COMPAT_DEVICES; i ++ )
 126         {
 127                 giNe2k_CardCount += PCI_CountDevices( csaCOMPAT_DEVICES[i].Vendor, csaCOMPAT_DEVICES[i].Device, 0 );
 128         }
 129
 130         if( giNe2k_CardCount == 0 ) {
 131                 Warning("[Ne2k ] No cards detected");
 132                 return MODULE_ERR_NOTNEEDED;
 133         }
 134
 135         // Enumerate Cards
 136         k = 0;
 137         gpNe2k_Cards = calloc( giNe2k_CardCount, sizeof(tCard) );
 138
 139         for( i = 0; i < NUM_COMPAT_DEVICES; i ++ )
 140         {
 141                 count = PCI_CountDevices( csaCOMPAT_DEVICES[i].Vendor, csaCOMPAT_DEVICES[i].Device, 0 );
 142                 for( j = 0; j < count; j ++,k ++ )
 143                 {
 144                         id = PCI_GetDevice( csaCOMPAT_DEVICES[i].Vendor, csaCOMPAT_DEVICES[i].Device, 0, j );
 145                         // Create Structure
 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;
 151
 152                         // Install IRQ Handler
 153                         IRQ_AddHandler(gpNe2k_Cards[ k ].IRQ, Ne2k_IRQHandler);
 154
 155                         // Reset Card
 156                         outb( base + 0x1F, inb(base + 0x1F) );
 157                         while( (inb( base+ISR ) & 0x80) == 0 );
 158                         outb( base + ISR, 0x80 );
 159
 160                         // Initialise Card
 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
 174
 175                         // Read MAC Address
 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);
 182
 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
 192                         // Set MAC Address
 193                         /*
 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]);
 200                         */
 201
 202                         Log("[NE2K]: Card #%i: IRQ=%i, IOBase=0x%x",
 203                                 k, gpNe2k_Cards[ k ].IRQ, gpNe2k_Cards[ k ].IOBase);
 204                         Log("MAC Address %x:%x:%x:%x:%x:%x",
 205                                 gpNe2k_Cards[ k ].MacAddr[0], gpNe2k_Cards[ k ].MacAddr[1],
 206                                 gpNe2k_Cards[ k ].MacAddr[2], gpNe2k_Cards[ k ].MacAddr[3],
 207                                 gpNe2k_Cards[ k ].MacAddr[4], gpNe2k_Cards[ k ].MacAddr[5]
 208                                 );
 209
 210                         // Set VFS Node
 211                         gpNe2k_Cards[ k ].Name[0] = '0'+k;
 212                         gpNe2k_Cards[ k ].Name[1] = '\0';
 213                         gpNe2k_Cards[ k ].Node.ImplPtr = &gpNe2k_Cards[ k ];
 214                         gpNe2k_Cards[ k ].Node.NumACLs = 0;     // Root Only
 215                         gpNe2k_Cards[ k ].Node.CTime = now();
 216                         gpNe2k_Cards[ k ].Node.Write = Ne2k_Write;
 217                         gpNe2k_Cards[ k ].Node.Read = Ne2k_Read;
 218                         gpNe2k_Cards[ k ].Node.IOCtl = Ne2k_IOCtl;
 219                 }
 220         }
 221
 222         gNe2k_DriverInfo.RootNode.Size = giNe2k_CardCount;
 223         DevFS_AddDevice( &gNe2k_DriverInfo );
 224         return MODULE_ERR_OK;
 225 }
 226
 227 /**
 228  * \fn char *Ne2k_ReadDir(tVFS_Node *Node, int Pos)
 229  */
 230 char *Ne2k_ReadDir(tVFS_Node *Node, int Pos)
 231 {
 232         char    ret[2];
 233         if(Pos < 0 || Pos >= giNe2k_CardCount)  return NULL;
 234         ret[0] = '0'+Pos;
 235         ret[1] = '\0';
 236         return strdup(ret);
 237 }
 238
 239 /**
 240  * \fn tVFS_Node *Ne2k_FindDir(tVFS_Node *Node, char *Name)
 241  */
 242 tVFS_Node *Ne2k_FindDir(tVFS_Node *Node, char *Name)
 243 {
 244         if(Name[0] == '\0' || Name[1] != '\0')  return NULL;
 245
 246         return &gpNe2k_Cards[ Name[0]-'0' ].Node;
 247 }
 248
 249 static const char *casIOCtls[] = { DRV_IOCTLNAMES, DRV_NETWORK_IOCTLNAMES, NULL };
 250 /**
 251  * \fn int Ne2k_IOCtl(tVFS_Node *Node, int ID, void *Data)
 252  * \brief IOCtl calls for a network device
 253  */
 254 int Ne2k_IOCtl(tVFS_Node *Node, int ID, void *Data)
 255 {
 256          int    tmp;
 257         ENTER("pNode iID pData", Node, ID, Data);
 258         switch( ID )
 259         {
 260         case DRV_IOCTL_TYPE:
 261                 LEAVE('i', DRV_TYPE_NETWORK);
 262                 return DRV_TYPE_NETWORK;
 263
 264         case DRV_IOCTL_IDENT:
 265                 tmp = ModUtil_SetIdent(Data, "Ne2k");
 266                 LEAVE('i', tmp);
 267                 return tmp;
 268
 269         case DRV_IOCTL_VERSION:
 270                 LEAVE('x', VERSION);
 271                 return VERSION;
 272
 273         case DRV_IOCTL_LOOKUP:
 274                 tmp = ModUtil_LookupString( (char**)casIOCtls, Data );
 275                 LEAVE('i', tmp);
 276                 return tmp;
 277         }
 278
 279         // If this is the root, return
 280         if( Node == &gNe2k_DriverInfo.RootNode ) {
 281                 LEAVE('i', 0);
 282                 return 0;
 283         }
 284
 285         // Device specific settings
 286         switch( ID )
 287         {
 288         case NET_IOCTL_GETMAC:
 289                 if( !CheckMem(Data, 6) ) {
 290                         LEAVE('i', -1);
 291                         return -1;
 292                 }
 293                 memcpy( Data, ((tCard*)Node->ImplPtr)->MacAddr, 6 );
 294                 LEAVE('i', 1);
 295                 return 1;
 296         }
 297         LEAVE('i', 0);
 298         return 0;
 299 }
 300
 301 /**
 302  * \fn Uint64 Ne2k_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 303  * \brief Send a packet from the network card
 304  */
 305 Uint64 Ne2k_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 306 {
 307         tCard   *Card = (tCard*)Node->ImplPtr;
 308         Uint16  *buf = Buffer;
 309          int    rem = Length;
 310          int    page;
 311
 312         ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
 313
 314         // Sanity Check Length
 315         if(Length > TX_BUF_SIZE*256) {
 316                 Warning(
 317                         "Ne2k_Write - Attempting to send over TX_BUF_SIZE*256 (%i) bytes (%i)",
 318                         TX_BUF_SIZE*256, Length
 319                         );
 320                 LEAVE('i', 0);
 321                 return 0;
 322         }
 323
 324         // Make sure that the card is in page 0
 325         outb(Card->IOBase + CMD, 0|0x22);       // Page 0, Start, NoDMA
 326
 327         // Clear Remote DMA Flag
 328         outb(Card->IOBase + ISR, 0x40); // Bit 6
 329
 330         // Send Size - Remote Byte Count Register
 331         outb(Card->IOBase + TBCR0, Length & 0xFF);
 332         outb(Card->IOBase + TBCR1, Length >> 8);
 333
 334         // Send Size - Remote Byte Count Register
 335         outb(Card->IOBase + RBCR0, Length & 0xFF);
 336         outb(Card->IOBase + RBCR1, Length >> 8);
 337
 338         // Set up transfer
 339         outb(Card->IOBase + RSAR0, 0x00);       // Page Offset
 340         page = Ne2k_int_GetWritePage(Card, Length);
 341         outb(Card->IOBase + RSAR1, page);       // Page Offset
 342         // Start
 343         //outb(Card->IOBase + CMD, 0|0x18|0x4|0x2);     // Page 0, Transmit Packet, TXP, Start
 344         outb(Card->IOBase + CMD, 0|0x10|0x2);   // Page 0, Remote Write, Start
 345
 346         // Send Data
 347         for(rem = Length; rem > 0; rem -= 2) {
 348                 outw(Card->IOBase + 0x10, *buf++);
 349         }
 350
 351         while( inb(Card->IOBase + ISR) == 0 )   // Wait for Remote DMA Complete
 352                 ;       //Proc_Yield();
 353
 354         outb( Card->IOBase + ISR, 0x40 );       // ACK Interrupt
 355
 356         // Send Packet
 357         outb(Card->IOBase + TPSR, page);
 358         outb(Card->IOBase + CMD, 0|0x10|0x4|0x2);
 359
 360         // Complete DMA
 361         //outb(Card->IOBase + CMD, 0|0x20);
 362
 363         LEAVE('i', Length);
 364         return Length;
 365 }
 366
 367 /**
 368  * \fn Uint64 Ne2k_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 369  * \brief Wait for and read a packet from the network card
 370  */
 371 Uint64 Ne2k_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 372 {
 373         tCard   *Card = (tCard*)Node->ImplPtr;
 374         Uint8   page;
 375         Uint8   data[256];
 376          int    i;
 377         struct {
 378                 Uint8   Status;
 379                 Uint8   NextPacketPage;
 380                 Uint16  Length; // Little Endian
 381         }       *pktHdr;
 382
 383         ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
 384
 385         while(Card->NumWaitingPackets == 0)     Threads_Yield();
 386
 387         // Make sure that the card is in page 0
 388         outb(Card->IOBase + CMD, 0|0x22);       // Page 0, Start, NoDMA
 389
 390         // Get BOUNDARY
 391         page = Card->NextRXPage;
 392
 393         // Set up transfer
 394         outb(Card->IOBase + RBCR0, 0);
 395         outb(Card->IOBase + RBCR1, 1);  // 256-bytes
 396         outb(Card->IOBase + RSAR0, 0x00);       // Page Offset
 397         outb(Card->IOBase + RSAR1, page);       // Page Number
 398
 399         outb(Card->IOBase + CMD, 0|0x08|0x2);   // Page 0, Remote Read, Start
 400
 401         // Clear Remote DMA Flag
 402         outb(Card->IOBase + ISR, 0x40); // Bit 6
 403
 404         // Read data
 405         for(i = 0; i < 128; i ++)
 406                 ((Uint16*)data)[i] = inw(Card->IOBase + 0x10);
 407
 408         pktHdr = (void*)data;
 409         //Log("Ne2k_Read: Recieved packet (%i bytes)", pktHdr->Length);
 410
 411         // Have we read all the required bytes yet?
 412         if(pktHdr->Length < 256 - 4)
 413         {
 414                 if(Length > pktHdr->Length)
 415                         Length = pktHdr->Length;
 416                 memcpy(Buffer, &data[4], Length);
 417                 page ++;
 418                 if(page == RX_LAST+1)   page = RX_FIRST;
 419         }
 420         // No? oh damn, now we need to allocate a buffer
 421         else {
 422                  int    j = 256/2;
 423                 char    *buf = malloc( (pktHdr->Length + 4 + 255) & ~255 );
 424
 425                 if(!buf) {
 426                         LEAVE('i', -1);
 427                         return -1;
 428                 }
 429
 430                 memcpy(buf, data, 256);
 431
 432                 page ++;
 433                 while(page != pktHdr->NextPacketPage)
 434                 {
 435                         if(page == RX_LAST+1)   page = RX_FIRST;
 436
 437                         outb(Card->IOBase + RBCR0, 0);
 438                         outb(Card->IOBase + RBCR1, 1);  // 256-bytes
 439                         outb(Card->IOBase + RSAR0, 0x00);       // Page Offset
 440                         outb(Card->IOBase + RSAR1, page);       // Page Number
 441                         outb(Card->IOBase + CMD, 0|0x08|0x2);   // Page 0, Remote Read, Start
 442
 443                         for(i = 0; i < 128; i ++)
 444                                 ((Uint16*)buf)[j+i] = inw(Card->IOBase + 0x10);
 445                         j += 128;
 446                         page ++;
 447                 }
 448
 449                 if(Length > pktHdr->Length)
 450                         Length = pktHdr->Length;
 451                 memcpy(Buffer, &buf[4], Length);
 452         }
 453
 454         // Write BNRY
 455         if(page == RX_FIRST)
 456                 outb( Card->IOBase + BNRY, RX_LAST );
 457         else
 458                 outb( Card->IOBase + BNRY, page-1 );
 459         // Set next RX Page and decrement the waiting list
 460         Card->NextRXPage = page;
 461         Card->NumWaitingPackets --;
 462
 463         LEAVE('i', Length);
 464         return Length;
 465 }
 466
 467 /**
 468  * \fn Uint8 Ne2k_int_GetWritePage(tCard *Card, Uint16 Length)
 469  */
 470 Uint8 Ne2k_int_GetWritePage(tCard *Card, Uint16 Length)
 471 {
 472         Uint8   ret = Card->NextMemPage;
 473
 474         Card->NextMemPage += (Length + 0xFF) >> 8;
 475         if(Card->NextMemPage >= TX_LAST) {
 476                 Card->NextMemPage -= TX_BUF_SIZE;
 477         }
 478
 479         return ret;
 480 }
 481
 482 /**
 483  * \fn void Ne2k_IRQHandler(int IntNum)
 484  */
 485 void Ne2k_IRQHandler(int IntNum)
 486 {
 487          int    i;
 488         Uint8   byte;
 489         for( i = 0; i < giNe2k_CardCount; i++ )
 490         {
 491                 if(gpNe2k_Cards[i].IRQ == IntNum)
 492                 {
 493                         byte = inb( gpNe2k_Cards[i].IOBase + ISR );
 494
 495                         // 0: Packet recieved (no error)
 496                         if( byte & 1 )
 497                         {
 498                                 gpNe2k_Cards[i].NumWaitingPackets ++;
 499                                 if( gpNe2k_Cards[i].NumWaitingPackets > MAX_PACKET_QUEUE )
 500                                         gpNe2k_Cards[i].NumWaitingPackets = MAX_PACKET_QUEUE;
 501                         }
 502                         // 1: Packet sent (no error)
 503                         // 2: Recieved with error
 504                         // 3: Transmission Halted (Excessive Collisions)
 505                         // 4: Recieve Buffer Exhausted
 506                         // 5:
 507                         // 6: Remote DMA Complete
 508                         // 7: Reset
 509                         //LOG("Clearing interrupts on card %i (was 0x%x)\n", i, byte);
 510                         outb( gpNe2k_Cards[i].IOBase + ISR, 0xFF );     // Reset All
 511                         return ;
 512                 }
 513         }
 514         Warning("[NE2K ] Recieved Unknown IRQ %i", IntNum);
 515 }