KernelLand/Modules/Network/VIARhineII/rhine2.c

   1 /*
   2  * Acess2 VIA Rhine II Driver (VT6102)
   3  * - By John Hodge (thePowersGang)
   4  */
   5 #define DEBUG   1
   6 #define VERSION ((0<<8)|10)
   7 #include <acess.h>
   8 #include <modules.h>
   9 #include <drv_pci.h>
  10 #include <semaphore.h>
  11 #include "rhine2_hw.h"
  12 #include <IPStack/include/adapters_api.h>
  13
  14 #define DESC_SIZE       16
  15 #define N_RX_DESCS      16
  16 #define RX_BUF_SIZE     1024
  17 #define N_RX_BUF_PER_PAGE       (PAGE_SIZE/RX_BUF_SIZE)
  18 #define N_RX_BUF_PAGES  ((N_RX_DESCS*RX_BUF_SIZE)/PAGE_SIZE)
  19 #define N_TX_DESCS      ((PAGE_SIZE/DESC_SIZE)-N_RX_DESCS)
  20
  21 #define CR0_BASEVAL     (CR0_STRT|CR0_TXON|CR0_RXON)
  22
  23 // === CONSTANTS ===
  24 #define VENDOR_ID       0x1106
  25 #define DEVICE_ID       0x3065
  26
  27 // === TYPES ===
  28 typedef struct sCard
  29 {
  30         Uint16  IOBase;
  31         Uint8   IRQ;
  32
  33         tSemaphore      ReadSemaphore;
  34         tSemaphore      SendSemaphore;
  35
  36         struct {
  37                 Uint32  Phys;
  38                 void    *Virt;
  39         } RXBuffers[N_RX_PAGES];
  40
  41         Uint32  DescTablePhys;
  42         void    *DescTable;
  43
  44         struct sTXDesc  *TXDescs;
  45          int    NextTX;
  46          int    nFreeTX;
  47
  48         struct sRXDesc  *NextRX;        // Most recent unread packet
  49
  50         void    *IPHandle;
  51         Uint8   MacAddr[6];
  52 }       tCard;
  53
  54 // === PROTOTYPES ===
  55  int    Rhine2_Install(char **Options);
  56 void    Rhine2_int_InitialiseCard(tCard *Card);
  57 tIPStackBuffer  *Rhine2_WaitPacket(void *Ptr);
  58  int    Rhine2_SendPacket(void *Ptr, tIPStackBuffer *Buffer);
  59 void    Rhine2_IRQHandler(int Num, void *Pt);
  60 // --- Helpers ---
  61 struct sRXDesc  *Rhine2_int_GetDescFromPhys(tCard *Card, Uint32 Addr);
  62 void    *Rhine2_int_GetBufferFromPhys(tCard *Card, Uint32 Addr);
  63 void    Rhine2_int_FreeRXDesc(void *Desc, size_t, size_t, const void*);
  64
  65 // === GLOBALS ===
  66 MODULE_DEFINE(0, VERSION, VIARhineII, Rhine2_Install, NULL, NULL);
  67 tIPStack_AdapterType    gRhine2_AdapterType = {
  68         .Name = "VIA Rhine II",
  69         .SendPacket = Rhine2_SendPacket,
  70         .WaitForPacket = Rhine2_WaitPacket,
  71 };
  72  int    giRhine2_CardCount;
  73 tCard   *gaRhine2_Cards;
  74
  75 // === CODE ===
  76 /**
  77  * \brief Initialises the driver
  78  */
  79 int Rhine2_Install(char **Options)
  80 {
  81          int    id = -1;
  82          int    i = 0;
  83 //      Uint16  base;
  84         tCard   *card;
  85
  86         giRhine2_CardCount = PCI_CountDevices(VENDOR_ID, DEVICE_ID);
  87         if( giRhine2_CardCount == 0 )   return MODULE_ERR_NOTNEEDED;
  88
  89         gaRhine2_Cards = calloc( giRhine2_CardCount, sizeof(tCard) );
  90
  91         while( (id = PCI_GetDevice(VENDOR_ID, DEVICE_ID, i)) != -1 )
  92         {
  93                 card = &gaRhine2_Cards[i];
  94
  95                 LOG("BAR0 = 0x%08x", PCI_GetBAR(id, 0));
  96                 LOG("BAR1 = 0x%08x", PCI_GetBAR(id, 1));
  97                 LOG("BAR2 = 0x%08x", PCI_GetBAR(id, 2));
  98                 LOG("BAR3 = 0x%08x", PCI_GetBAR(id, 3));
  99                 LOG("BAR4 = 0x%08x", PCI_GetBAR(id, 4));
 100                 LOG("BAR5 = 0x%08x", PCI_GetBAR(id, 5));
 101
 102                 card->IOBase = PCI_GetBAR(id, 0);
 103                 if( !(card->IOBase & 1) ) {
 104                         // Oops?
 105                         Log_Warning("Rhine2", "BAR0 is not in IO space");
 106                         continue ;
 107                 }
 108                 card->IOBase &= ~1;
 109                 card->IRQ = PCI_GetIRQ( id );
 110
 111                 // Install IRQ Handler
 112                 IRQ_AddHandler(card->IRQ, Rhine2_IRQHandler, card);
 113
 114                 Rhine2_int_InitialiseCard(card);
 115
 116                 card->IPHandle = IPStack_Adapter_Add(&gRhine2_AdapterType, card, card->MacAddr);
 117
 118                 Log_Log("Rhine2", "Card %i 0x%04x, IRQ %i %02x:%02x:%02x:%02x:%02x:%02x",
 119                         i, card->IOBase, card->IRQ,
 120                         card->MacAddr[0], card->MacAddr[1], card->MacAddr[2],
 121                         card->MacAddr[3], card->MacAddr[4], card->MacAddr[5]
 122                         );
 123
 124                 i ++;
 125         }
 126
 127         return MODULE_ERR_OK;
 128 }
 129
 130 void Rhine2_int_InitialiseCard(tCard *Card)
 131 {
 132         tPAddr  phys;
 133
 134         Card->MacAddr[0] = inb(Card->IOBase + REG_PAR0);
 135         Card->MacAddr[1] = inb(Card->IOBase + REG_PAR1);
 136         Card->MacAddr[2] = inb(Card->IOBase + REG_PAR2);
 137         Card->MacAddr[3] = inb(Card->IOBase + REG_PAR3);
 138         Card->MacAddr[4] = inb(Card->IOBase + REG_PAR4);
 139         Card->MacAddr[5] = inb(Card->IOBase + REG_PAR5);
 140
 141         LOG("Resetting card");
 142         outb(Card->IOBase + REG_CR1, CR1_SFRST);
 143         // TODO: Timeout
 144         while( inb(Card->IOBase + REG_CR1) & CR1_SFRST ) ;
 145
 146         LOG("Allocaating RX buffers");
 147         // Allocate memory for things
 148         for( int i = 0; i < N_RX_PAGES; i ++ )
 149         {
 150                 Card->RXBuffers[i].Virt = (void*)MM_AllocDMA(1, 32, &phys);
 151                 Card->RXBuffers[i].Phys = phys;
 152         }
 153
 154         LOG("Allocating and filling RX/TX Descriptors");
 155         Card->DescTable = (void*)MM_AllocDMA(1, 32, &phys);
 156         Card->DescTablePhys = phys;
 157
 158         // Initialise RX Descriptors
 159         struct sRXDesc  *rxdescs = Card->DescTable;
 160         for( int i = 0; i < N_RX_DESCS; i ++ )
 161         {
 162                 rxdescs[i].RSR = 0;
 163                 rxdescs[i].BufferSize = RX_BUF_SIZE;
 164                 rxdescs[i].RXBufferStart = Card->RXBuffers[i/N_RX_BUF_PER_PAGE].Phys
 165                         + (i % N_RX_BUF_PER_PAGE) * RX_BUF_SIZE;
 166                 rxdescs[i].RDBranchAddress = Card->DescTablePhys + (i+1) * DESC_SIZE;
 167                 rxdescs[i].Length = (1 << 15);  // set OWN
 168                 LOG("RX Desc %p = {Buf:0x%8x, Next:0x%x}", rxdescs,
 169                         rxdescs[i].RXBufferStart, rxdescs[i].RDBranchAddress
 170                         );
 171         }
 172         rxdescs[ N_RX_DESCS - 1 ].RDBranchAddress = Card->DescTablePhys;
 173         Card->NextRX = &rxdescs[0];
 174
 175         Card->TXDescs = (void*)(rxdescs + N_RX_DESCS);
 176         memset(Card->TXDescs, 0, sizeof(struct sTXDesc)*N_TX_DESCS);
 177         for( int i = 0; i < N_TX_DESCS; i ++ )
 178         {
 179                 Card->TXDescs[i].TDBranchAddress = Card->DescTablePhys + (N_RX_DESCS + i + 1) * DESC_SIZE;
 180         }
 181         Card->TXDescs[N_TX_DESCS-1].TDBranchAddress = Card->DescTablePhys + N_RX_DESCS * DESC_SIZE;
 182         Card->nFreeTX = N_TX_DESCS;
 183         Card->NextTX = 0;
 184
 185         // - Initialise card state
 186         LOG("Initialising card state");
 187         outb(Card->IOBase + REG_IMR0, 0xFF);
 188         outb(Card->IOBase + REG_IMR1, 0xFF);
 189         outd(Card->IOBase + REG_CUR_RX_DESC, Card->DescTablePhys);
 190         outd(Card->IOBase + REG_CUR_TX_DESC, Card->DescTablePhys + N_RX_DESCS * DESC_SIZE);
 191
 192         outb(Card->IOBase + REG_TCR, TCR_TRSF(4));
 193
 194         LOG("RX started");
 195         outb(Card->IOBase + REG_CR0, CR0_BASEVAL);
 196         outb(Card->IOBase + REG_CR1, 0);        // Disabled TX polling only?
 197
 198         LOG("ISR state: %02x %02x", inb(Card->IOBase + REG_ISR0), inb(Card->IOBase + REG_ISR1));
 199 }
 200
 201 // --- File Functions ---
 202 tIPStackBuffer *Rhine2_WaitPacket(void *Ptr)
 203 {
 204         tCard   *card = Ptr;
 205         tIPStackBuffer  *ret;
 206         struct sRXDesc  *desc;
 207          int    nDesc;
 208
 209         ENTER("pPtr", Ptr);
 210
 211         LOG("CR0 state: %02x", inb(card->IOBase + REG_CR0));
 212         if( Semaphore_Wait( &card->ReadSemaphore, 1 ) != 1 )
 213         {
 214                 LEAVE('n');
 215                 return NULL;
 216         }
 217
 218         nDesc = 0;
 219         desc = card->NextRX;
 220         while( !(desc->Length & (1 << 15)) )
 221         {
 222 //              LOG("desc(%p) = {RSR:%04x,Length:%04x,BufferSize:%04x,RXBufferStart:%08x,RDBranchAddress:%08x}",
 223 //                      desc, desc->RSR, desc->Length, desc->BufferSize, desc->RXBufferStart, desc->RDBranchAddress);
 224                 // TODO: This kinda expensive call can be changed for an increment, but cbf
 225                 desc = Rhine2_int_GetDescFromPhys(card, desc->RDBranchAddress);
 226                 nDesc ++;
 227         }
 228
 229         LOG("%i descriptors in packet", nDesc);
 230
 231         ret = IPStack_Buffer_CreateBuffer(nDesc);
 232         desc = card->NextRX;
 233         while( !(desc->Length & (1 << 15)) )
 234         {
 235                 void    *data = Rhine2_int_GetBufferFromPhys(card, desc->RXBufferStart);
 236                 IPStack_Buffer_AppendSubBuffer(ret,
 237                         desc->Length, 0, data,
 238                         Rhine2_int_FreeRXDesc, desc
 239                         );
 240                 desc = Rhine2_int_GetDescFromPhys(card, desc->RDBranchAddress);
 241         }
 242         card->NextRX = desc;
 243
 244         LEAVE('p', ret);
 245         return ret;
 246 }
 247
 248 int Rhine2_SendPacket(void *Ptr, tIPStackBuffer *Buffer)
 249 {
 250         tCard   *card = Ptr;
 251         size_t  len;
 252         const void      *data;
 253          int    nDescs, first_desc_id;
 254         struct sTXDesc  *desc = NULL;
 255         struct sTXDesc  *first_desc = NULL;
 256         struct sTXDesc  *last_desc = NULL;
 257
 258         ENTER("pPtr pBuffer", Ptr, Buffer);
 259
 260         #if 0
 261         // Iterate buffers
 262         nDescs = 0;
 263         for( int id = -1; -1 != (id = IPStack_Buffer_GetBuffer(Buffer, id, &len, &data)); )
 264         {
 265                 if( ((tVAddr)data & (PAGE_SIZE-1)) + len > PAGE_SIZE )
 266                         nDescs ++;
 267                 nDescs ++;
 268         }
 269         if( nDescs == 0 ) {
 270                 LEAVE('i', -1);
 271                 return -1;
 272         }
 273
 274         LOG("%i descriptors needed", nDescs);
 275
 276         if( card->nFreeTX < nDescs ) {
 277                 // Oops... wait?
 278                 // TODO: Semaphore instead?
 279                 LEAVE('i', 1);
 280                 return 1;
 281         }
 282
 283         first_desc_id = card->NextTX;
 284         card->NextTX = (card->NextTX + nDescs) % N_TX_DESCS;
 285
 286         desc = card->TXDescs + first_desc_id;
 287
 288         nDescs = 0;
 289         for( int id = -1; -1 != (id = IPStack_Buffer_GetBuffer(Buffer, id, &len, &data)); )
 290         {
 291                 tPAddr  pdata = MM_GetPhysAddr( (tVAddr)data );
 292                 #if PHYS_BITS > 32
 293                 if( pdata >> 32 ) {
 294                         // TODO: re-map
 295                         Log_Warning("Rhine2", "TODO: Bounce-buffer >32 pbit buffers");
 296                 }
 297                 #endif
 298
 299                 if( (pdata & (PAGE_SIZE-1)) + len > PAGE_SIZE )
 300                 {
 301                         // Need to split into to descriptors
 302                         Log_Warning("Rhine2", "TODO: Split cross-page buffers");
 303                 }
 304
 305                 LOG("Buffer %i (%p+0x%x) placed in %p", id-1, data, len, desc);
 306
 307                 // TODO: Rhine I requires 4-byte alignment (fsck that, I don't have one)
 308
 309                 desc->TXBufferStart = pdata;
 310                 desc->BufferSize = len | (1 << 15);
 311                 // TODO: TCR
 312                 desc->TCR = 0;
 313                 if( nDescs == 0 )
 314                         desc->TSR = 0;  // OWN will be set below
 315                 else
 316                         desc->TSR = TD_TSR_OWN;
 317
 318                 nDescs ++;
 319                 if(first_desc_id + nDescs == N_TX_DESCS)
 320                         desc = card->TXDescs;
 321                 else
 322                         desc ++;
 323         }
 324         #else
 325         data = IPStack_Buffer_CompactBuffer(Buffer, &len);
 326
 327         nDescs = 1;
 328         first_desc_id = card->NextTX;
 329         card->NextTX = (card->NextTX + nDescs) % N_TX_DESCS;
 330         desc = card->TXDescs + first_desc_id;
 331
 332         desc->TXBufferStart = MM_GetPhysAddr( (tVAddr)data );
 333         desc->BufferSize = len | (1 << 15);
 334         desc->TSR = 0;
 335         desc->TCR = 0;
 336         #endif
 337
 338         first_desc = card->TXDescs + first_desc_id;
 339         last_desc = desc;
 340
 341         first_desc->TCR |= TD_TCR_STP;
 342         last_desc->TCR |= TD_TCR_EDP|TD_TCR_IC;
 343 //      last_desc->BufferSize &= ~(1 << 15);
 344
 345         first_desc->TSR |= TD_TSR_OWN;
 346
 347         LOG("%i descriptors allocated, first = %p, last = %p", nDescs, first_desc, last_desc);
 348
 349
 350         LOG("Waiting for TX to complete");
 351         outb(card->IOBase + REG_CR0, CR0_TDMD|CR0_BASEVAL);
 352         Semaphore_Wait(&card->SendSemaphore, 1);
 353
 354         #if 1
 355         free((void*)data);
 356         #endif
 357
 358         LEAVE('i', 0);
 359         return 0;
 360 }
 361
 362 void Rhine2_IRQHandler(int Num, void *Ptr)
 363 {
 364         tCard   *card = Ptr;
 365         Uint8   isr0 = inb(card->IOBase + REG_ISR0);
 366         Uint8   isr1 = inb(card->IOBase + REG_ISR1);
 367
 368         if( isr0 == 0 ) return ;
 369
 370         LOG("ISR0 = 0x%02x, ISR1 = 0x%02x", isr0, isr1);
 371
 372         if( isr0 & ISR0_PRX )
 373         {
 374                 LOG("PRX");
 375                 Semaphore_Signal(&card->ReadSemaphore, 1);
 376         }
 377
 378         if( isr0 & ISR0_PTX )
 379         {
 380                 LOG("PTX");
 381                 Semaphore_Signal(&card->SendSemaphore, 1);
 382         }
 383
 384         if( isr0 & ISR0_TXE )
 385         {
 386                 LOG("TX Error... oops");
 387                 Semaphore_Signal(&card->SendSemaphore, 1);
 388         }
 389
 390         if( isr0 & ISR0_TU )
 391         {
 392                 LOG("Transmit buffer underflow");
 393         }
 394
 395         LOG("Acking interrupts");
 396         outb(card->IOBase + REG_ISR0, isr0);
 397         outb(card->IOBase + REG_ISR1, isr1);
 398 }
 399
 400 // --- Helpers ---
 401 struct sRXDesc *Rhine2_int_GetDescFromPhys(tCard *Card, Uint32 Addr)
 402 {
 403         if( Card->DescTablePhys > Addr )        return NULL;
 404         if( Card->DescTablePhys + PAGE_SIZE <= Addr )   return NULL;
 405         if( Addr & 15 ) return NULL;
 406         return (struct sRXDesc*)Card->DescTable + ((Addr & (PAGE_SIZE-1)) / 16);
 407 }
 408
 409 void *Rhine2_int_GetBufferFromPhys(tCard *Card, Uint32 Addr)
 410 {
 411         for( int i = 0; i < N_RX_PAGES; i ++ )
 412         {
 413                 if( Card->RXBuffers[i].Phys > Addr )    continue;
 414                 if( Card->RXBuffers[i].Phys + PAGE_SIZE <= Addr )       continue;
 415                 return Card->RXBuffers[i].Virt + (Addr & (PAGE_SIZE-1));
 416         }
 417         return NULL;
 418 }
 419
 420 void Rhine2_int_FreeRXDesc(void *Ptr, size_t u1, size_t u2, const void *u3)
 421 {
 422         struct sRXDesc  *desc = Ptr;
 423
 424         LOG("Descriptor %p returned to card", desc);
 425
 426         desc->RSR = 0;
 427         desc->Length = (1 << 15);       // Reset OWN
 428 }
 429