3 * Floppy Disk Access Code
\r
8 #include <fs_devfs.h>
\r
9 #include <tpl_drv_common.h>
\r
14 // === CONSTANTS ===
\r
15 // --- Current Version
\r
16 #define FDD_VERSION ((0<<8)|(75))
\r
19 #define USE_CACHE 1 // Use Sector Cache
\r
20 #define CACHE_SIZE 32 // Number of cachable sectors
\r
21 #define FDD_SEEK_TIMEOUT 10 // Timeout for a seek operation
\r
22 #define MOTOR_ON_DELAY 500 // Miliseconds
\r
23 #define MOTOR_OFF_DELAY 2000 // Miliseconds
\r
27 * \brief Representation of a floppy drive
\r
31 volatile int motorState; //2 - On, 1 - Spinup, 0 - Off
\r
38 * \brief Cached Sector
\r
43 Uint16 sector; // Allows 32Mb of addressable space (Plenty for FDD)
\r
47 // === CONSTANTS ===
\r
48 static const char *cFDD_TYPES[] = {"None", "360kB 5.25\"", "1.2MB 5.25\"", "720kB 3.5\"", "1.44MB 3.5\"", "2.88MB 3.5\"" };
\r
49 static const int cFDD_SIZES[] = { 0, 360*1024, 1200*1024, 720*1024, 1440*1024, 2880*1024 };
\r
50 static const short cPORTBASE[] = { 0x3F0, 0x370 };
\r
55 PORT_DIGOUTPUT = 0x2,
\r
56 PORT_MAINSTATUS = 0x4,
\r
57 PORT_DATARATE = 0x4,
\r
59 PORT_DIGINPUT = 0x7,
\r
60 PORT_CONFIGCTRL = 0x7
\r
63 enum FloppyCommands {
\r
64 FIX_DRIVE_DATA = 0x03,
\r
65 HECK_DRIVE_STATUS = 0x04,
\r
66 CALIBRATE_DRIVE = 0x07,
\r
67 CHECK_INTERRUPT_STATUS = 0x08,
\r
69 READ_SECTOR_ID = 0x4A,
\r
70 FORMAT_TRACK = 0x4D,
\r
73 WRITE_SECTOR = 0xC5,
\r
74 WRITE_DELETE_SECTOR = 0xC9,
\r
75 READ_DELETE_SECTOR = 0xCC,
\r
78 // === PROTOTYPES ===
\r
80 int FDD_Install(char **Arguments);
\r
81 char *FDD_ReadDir(tVFS_Node *Node, int pos);
\r
82 tVFS_Node *FDD_FindDir(tVFS_Node *dirNode, char *Name);
\r
83 int FDD_IOCtl(tVFS_Node *Node, int ID, void *Data);
\r
84 Uint64 FDD_ReadFS(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer);
\r
85 // --- Raw Disk Access
\r
86 int FDD_ReadSector(int disk, int lba, void *buf);
\r
88 void FDD_IRQHandler(int Num);
\r
90 void FDD_SensInt(int base, Uint8 *sr0, Uint8 *cyl);
\r
91 inline void FDD_AquireSpinlock();
\r
92 inline void FDD_FreeSpinlock();
\r
94 inline void FDD_AquireCacheSpinlock();
\r
95 inline void FDD_FreeCacheSpinlock();
\r
97 void FDD_int_SendByte(int base, char byte);
\r
98 int FDD_int_GetByte(int base);
\r
99 void FDD_Reset(int id);
\r
100 void FDD_Recalibrate(int disk);
\r
101 int FDD_int_SeekTrack(int disk, int head, int track);
\r
102 void FDD_int_TimerCallback(int arg);
\r
103 void FDD_int_StopMotor(int disk);
\r
104 void FDD_int_StartMotor(int disk);
\r
105 int FDD_int_GetDims(int type, int lba, int *c, int *h, int *s, int *spt);
\r
108 MODULE_DEFINE(0, FDD_VERSION, FDD, FDD_Install, NULL, NULL);
\r
109 t_floppyDevice gFDD_Devices[2];
\r
110 volatile int fdd_inUse = 0;
\r
111 volatile int fdd_irq6 = 0;
\r
112 tDevFS_Driver gFDD_DriverInfo = {
\r
117 .ACLs = &gVFS_ACL_EveryoneRX,
\r
118 .Flags = VFS_FFLAG_DIRECTORY,
\r
119 .ReadDir = FDD_ReadDir,
\r
120 .FindDir = FDD_FindDir,
\r
125 int siFDD_CacheInUse = 0;
\r
126 int siFDD_SectorCacheSize = CACHE_SIZE;
\r
127 t_floppySector sFDD_SectorCache[CACHE_SIZE];
\r
132 * \fn int FDD_Install(char **Arguments)
\r
133 * \brief Installs floppy driver
\r
135 int FDD_Install(char **Arguments)
\r
139 // Determine Floppy Types (From CMOS)
\r
142 gFDD_Devices[0].type = data >> 4;
\r
143 gFDD_Devices[1].type = data & 0xF;
\r
144 gFDD_Devices[0].track[0] = -1;
\r
145 gFDD_Devices[1].track[1] = -1;
\r
147 // Clear FDD IRQ Flag
\r
148 FDD_SensInt(0x3F0, NULL, NULL);
\r
149 // Install IRQ6 Handler
\r
150 IRQ_AddHandler(6, FDD_IRQHandler);
\r
151 // Reset Primary FDD Controller
\r
154 Log("[FDD ] Detected Disk 0: %s and Disk 1: %s\n", cFDD_TYPES[data>>4], cFDD_TYPES[data&0xF]);
\r
156 // Initialise Root Node
\r
157 gFDD_DriverInfo.RootNode.CTime = gFDD_DriverInfo.RootNode.MTime
\r
158 = gFDD_DriverInfo.RootNode.ATime = now();
\r
160 // Initialise Child Nodes
\r
161 gFDD_Devices[0].Node.Inode = 0;
\r
162 gFDD_Devices[0].Node.Flags = 0;
\r
163 gFDD_Devices[0].Node.NumACLs = 0;
\r
164 gFDD_Devices[0].Node.Read = FDD_ReadFS;
\r
165 gFDD_Devices[0].Node.Write = NULL;//fdd_writeFS;
\r
166 memcpy(&gFDD_Devices[1].Node, &gFDD_Devices[0].Node, sizeof(tVFS_Node));
\r
168 gFDD_Devices[1].Node.Inode = 1;
\r
171 gFDD_Devices[0].Node.Size = cFDD_SIZES[data >> 4];
\r
172 gFDD_Devices[1].Node.Size = cFDD_SIZES[data & 0xF];
\r
174 // Create Sector Cache
\r
176 //sFDD_SectorCache = malloc(sizeof(*sFDD_SectorCache)*CACHE_SIZE);
\r
177 //siFDD_SectorCacheSize = CACHE_SIZE;
\r
180 // Register with devfs
\r
181 DevFS_AddDevice(&gFDD_DriverInfo);
\r
187 * \fn char *FDD_ReadDir(tVFS_Node *Node, int pos)
\r
188 * \brief Read Directory
\r
190 char *FDD_ReadDir(tVFS_Node *Node, int pos)
\r
192 char name[2] = "0\0";
\r
193 //Update Accessed Time
\r
194 //gFDD_DrvInfo.rootNode.atime = now();
\r
197 if(pos >= 2 || pos < 0)
\r
200 if(gFDD_Devices[pos].type == 0)
\r
206 return strdup(name);
\r
210 * \fn tVFS_Node *FDD_FindDir(tVFS_Node *Node, char *filename);
\r
211 * \brief Find File Routine (for vfs_node)
\r
213 tVFS_Node *FDD_FindDir(tVFS_Node *Node, char *filename)
\r
217 ENTER("sfilename", filename);
\r
219 // Sanity check string
\r
220 if(filename == NULL) {
\r
225 // Check string length (should be 1)
\r
226 if(filename[0] == '\0' || filename[1] != '\0') {
\r
231 // Get First character
\r
232 i = filename[0] - '0';
\r
234 // Check for 1st disk and if it is present return
\r
235 if(i == 0 && gFDD_Devices[0].type != 0) {
\r
236 LEAVE('p', &gFDD_Devices[0].Node);
\r
237 return &gFDD_Devices[0].Node;
\r
240 // Check for 2nd disk and if it is present return
\r
241 if(i == 1 && gFDD_Devices[1].type != 0) {
\r
242 LEAVE('p', &gFDD_Devices[1].Node);
\r
243 return &gFDD_Devices[1].Node;
\r
246 // Else return null
\r
252 * \fn int FDD_IOCtl(tVFS_Node *node, int id, void *data)
\r
253 * \brief Stub ioctl function
\r
255 int FDD_IOCtl(tVFS_Node *node, int id, void *data)
\r
259 case DRV_IOCTL_TYPE: return DRV_TYPE_DISK;
\r
260 case DRV_IOCTL_IDENT: memcpy(data, "FDD\0", 4); return 1;
\r
261 case DRV_IOCTL_VERSION: return FDD_VERSION;
\r
267 * \fn Uint64 fdd_readFS(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer)
\r
268 * \brief Read Data from a disk
\r
270 Uint64 FDD_ReadFS(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer)
\r
276 ENTER("xoff xlen pbuffer", off, len, buffer);
\r
283 if(node->Inode != 0 && node->Inode != 1) {
\r
288 disk = node->Inode;
\r
290 // Update Accessed Time
\r
291 node->ATime = now();
\r
293 if((off & 0x1FF) || (len & 0x1FF))
\r
295 // Un-Aligned Offset/Length
\r
296 int startOff = off>>9;
\r
297 int sectOff = off&0x1FF;
\r
298 int sectors = (len+0x1FF)>>9;
\r
300 LOG("Non-aligned Read");
\r
302 //Read Starting Sector
\r
303 if(!FDD_ReadSector(disk, startOff, buf))
\r
305 memcpy(buffer, (char*)(buf+sectOff), len>512-sectOff?512-sectOff:len);
\r
307 //If the data size is one sector or less
\r
308 if(len <= 512-sectOff) {
\r
310 return len; //Return
\r
312 buffer += 512-sectOff;
\r
314 //Read Middle Sectors
\r
315 for(i=1;i<sectors-1;i++) {
\r
316 if(!FDD_ReadSector(disk, startOff+i, buf)) {
\r
320 memcpy(buffer, buf, 512);
\r
325 if(!FDD_ReadSector(disk, startOff+i, buf))
\r
327 memcpy(buffer, buf, (len&0x1FF)-sectOff);
\r
334 int count = len >> 9;
\r
335 int sector = off >> 9;
\r
336 LOG("Aligned Read");
\r
337 //Aligned Offset and Length - Simple Code
\r
338 for(i=0;i<count;i++)
\r
340 FDD_ReadSector(disk, sector, buf);
\r
341 memcpy(buffer, buf, 512);
\r
351 * \fn int FDD_ReadSector(int disk, int lba, void *buf)
\r
352 * \fn Read a sector from disk
\r
354 int FDD_ReadSector(int disk, int lba, void *buf)
\r
356 int cyl, head, sec;
\r
360 ENTER("idisk xlba pbuf", disk, lba, buf);
\r
363 FDD_AquireCacheSpinlock();
\r
364 for(i=0;i<siFDD_SectorCacheSize;i++)
\r
366 if(sFDD_SectorCache[i].timestamp == 0) continue;
\r
367 if(sFDD_SectorCache[i].disk == disk
\r
368 && sFDD_SectorCache[i].sector == lba) {
\r
369 LOG("Found %i in cache %i", lba, i);
\r
370 memcpy(buf, sFDD_SectorCache[i].data, 512);
\r
371 sFDD_SectorCache[i].timestamp = now();
\r
372 FDD_FreeCacheSpinlock();
\r
377 LOG("Read %i from Disk", lba);
\r
378 FDD_FreeCacheSpinlock();
\r
381 base = cPORTBASE[disk>>1];
\r
383 LOG("Calculating Disk Dimensions");
\r
385 if(FDD_int_GetDims(gFDD_Devices[disk].type, lba, &cyl, &head, &sec, &spt) != 1) {
\r
390 // Remove Old Timer
\r
391 Time_RemoveTimer(gFDD_Devices[disk].timer);
\r
392 // Check if Motor is on
\r
393 if(gFDD_Devices[disk].motorState == 0) {
\r
394 FDD_int_StartMotor(disk);
\r
397 LOG("Wait for Motor Spinup");
\r
400 while(gFDD_Devices[disk].motorState == 1) Threads_Yield();
\r
402 LOG("C:%i,H:%i,S:%i", cyl, head, sec);
\r
403 LOG("Acquire Spinlock");
\r
405 FDD_AquireSpinlock();
\r
408 outb(base+CALIBRATE_DRIVE, 0);
\r
410 while(FDD_int_SeekTrack(disk, head, (Uint8)cyl) == 0 && i++ < FDD_SEEK_TIMEOUT ) Threads_Yield();
\r
411 //FDD_SensInt(base, NULL, NULL); // Wait for IRQ
\r
413 LOG("Setting DMA for read");
\r
415 //Read Data from DMA
\r
416 DMA_SetChannel(2, 512, 1); // Read 512 Bytes
\r
418 LOG("Sending read command");
\r
420 //Threads_Wait(100); // Wait for Head to settle
\r
422 FDD_int_SendByte(base, READ_SECTOR); // Was 0xE6
\r
423 FDD_int_SendByte(base, (head << 2) | (disk&1));
\r
424 FDD_int_SendByte(base, (Uint8)cyl);
\r
425 FDD_int_SendByte(base, (Uint8)head);
\r
426 FDD_int_SendByte(base, (Uint8)sec);
\r
427 FDD_int_SendByte(base, 0x02); // Bytes Per Sector (Real BPS=128*2^{val})
\r
428 FDD_int_SendByte(base, spt); // SPT
\r
429 FDD_int_SendByte(base, 0x1B); // Gap Length (27 is default)
\r
430 FDD_int_SendByte(base, 0xFF); // Data Length
\r
433 LOG("Waiting for Data to be read");
\r
436 // Read Data from DMA
\r
437 LOG(" FDD_ReadSector: Reading Data");
\r
438 DMA_ReadData(2, 512, buf);
\r
440 // Clear Input Buffer
\r
441 LOG("Clearing Input Buffer");
\r
442 FDD_int_GetByte(base); FDD_int_GetByte(base); FDD_int_GetByte(base);
\r
443 FDD_int_GetByte(base); FDD_int_GetByte(base); FDD_int_GetByte(base); FDD_int_GetByte(base);
\r
445 LOG("Realeasing Spinlock and Setting motor to stop");
\r
446 // Release Spinlock
\r
447 FDD_FreeSpinlock();
\r
449 //Set timer to turn off motor affter a gap
\r
450 gFDD_Devices[disk].timer = Time_CreateTimer(MOTOR_OFF_DELAY, FDD_int_StopMotor, (void*)disk); //One Shot Timer
454 FDD_AquireCacheSpinlock();
\r
456 for(i=0;i<siFDD_SectorCacheSize;i++)
\r
458 if(sFDD_SectorCache[i].timestamp == 0) {
\r
462 if(sFDD_SectorCache[i].timestamp < sFDD_SectorCache[oldest].timestamp)
\r
465 sFDD_SectorCache[oldest].timestamp = now();
\r
466 sFDD_SectorCache[oldest].disk = disk;
\r
467 sFDD_SectorCache[oldest].sector = lba;
\r
468 memcpy(sFDD_SectorCache[oldest].data, buf, 512);
\r
469 FDD_FreeCacheSpinlock();
\r
478 * \fn int FDD_int_SeekTrack(int disk, int track)
\r
479 * \brief Seek disk to selected track
\r
481 int FDD_int_SeekTrack(int disk, int head, int track)
\r
486 base = cPORTBASE[disk>>1];
\r
488 // Check if seeking is needed
\r
489 if(gFDD_Devices[disk].track[head] == track)
\r
493 FDD_int_SendByte(base, SEEK_TRACK);
\r
494 FDD_int_SendByte(base, (head<<2)|(disk&1));
\r
495 FDD_int_SendByte(base, track); // Send Seek command
\r
497 FDD_SensInt(base, &sr0, &cyl); // Wait for IRQ
\r
498 if((sr0 & 0xF0) != 0x20) {
499 LOG("sr0 = 0x%x", sr0);
500 return 0; //Check Status
502 if(cyl != track) return 0;
\r
504 // Set Track in structure
\r
505 gFDD_Devices[disk].track[head] = track;
\r
510 * \fn int FDD_int_GetDims(int type, int lba, int *c, int *h, int *s, int *spt)
\r
511 * \brief Get Dimensions of a disk
\r
513 int FDD_int_GetDims(int type, int lba, int *c, int *h, int *s, int *spt)
\r
522 *s = (lba % 9) + 1;
\r
524 *h = (lba / 9) & 1;
\r
530 *s = (lba % 15) + 1;
\r
532 *h = (lba / 15) & 1;
\r
538 *s = (lba % 9) + 1;
\r
540 *h = (lba / 9) & 1;
\r
546 *s = (lba % 18) + 1;
\r
548 *h = (lba / 18) & 1;
\r
554 *s = (lba % 36) + 1;
\r
556 *h = (lba / 32) & 1;
\r
566 * \fn void FDD_IRQHandler(int Num)
\r
567 * \brief Handles IRQ6
\r
569 void FDD_IRQHandler(int Num)
\r
575 * \fn FDD_WaitIRQ()
\r
576 * \brief Wait for an IRQ6
\r
581 while(!fdd_irq6) Threads_Yield();
\r
585 void FDD_SensInt(int base, Uint8 *sr0, Uint8 *cyl)
\r
587 FDD_int_SendByte(base, CHECK_INTERRUPT_STATUS);
\r
588 if(sr0) *sr0 = FDD_int_GetByte(base);
\r
589 else FDD_int_GetByte(base);
\r
590 if(cyl) *cyl = FDD_int_GetByte(base);
\r
591 else FDD_int_GetByte(base);
\r
594 void FDD_AquireSpinlock()
\r
601 inline void FDD_FreeSpinlock()
\r
607 inline void FDD_AquireCacheSpinlock()
\r
609 while(siFDD_CacheInUse) Threads_Yield();
\r
610 siFDD_CacheInUse = 1;
\r
612 inline void FDD_FreeCacheSpinlock()
\r
614 siFDD_CacheInUse = 0;
\r
619 * void FDD_int_SendByte(int base, char byte)
\r
620 * \brief Sends a command to the controller
\r
622 void FDD_int_SendByte(int base, char byte)
\r
624 volatile int state;
\r
626 for( ; timeout--; )
\r
628 state = inb(base + PORT_MAINSTATUS);
\r
629 if ((state & 0xC0) == 0x80)
\r
631 outb(base + PORT_DATA, byte);
\r
637 Warning("FDD_int_SendByte - Timeout sending byte 0x%x to base 0x%x\n", byte, base);
\r
642 * int FDD_int_GetByte(int base, char byte)
\r
643 * \brief Receive data from fdd controller
\r
645 int FDD_int_GetByte(int base)
\r
647 volatile int state;
\r
649 for( timeout = 128; timeout--; )
\r
651 state = inb((base + PORT_MAINSTATUS));
\r
652 if ((state & 0xd0) == 0xd0)
\r
653 return inb(base + PORT_DATA);
\r
660 * \brief Recalibrate the specified disk
\r
662 void FDD_Recalibrate(int disk)
\r
664 ENTER("idisk", disk);
\r
666 LOG("Starting Motor");
\r
667 FDD_int_StartMotor(disk);
\r
669 while(gFDD_Devices[disk].motorState == 1) Threads_Yield();
\r
671 LOG("Sending Calibrate Command");
\r
672 FDD_int_SendByte(cPORTBASE[disk>>1], CALIBRATE_DRIVE);
\r
673 FDD_int_SendByte(cPORTBASE[disk>>1], disk&1);
\r
675 LOG("Waiting for IRQ");
\r
677 FDD_SensInt(cPORTBASE[disk>>1], NULL, NULL);
\r
679 LOG("Stopping Motor");
\r
680 FDD_int_StopMotor(disk);
\r
685 * \brief Reset the specified FDD controller
\r
687 void FDD_Reset(int id)
\r
689 int base = cPORTBASE[id];
\r
693 outb(base + PORT_DIGOUTPUT, 0); // Stop Motors & Disable FDC
\r
694 outb(base + PORT_DIGOUTPUT, 0x0C); // Re-enable FDC (DMA and Enable)
\r
696 LOG("Awaiting IRQ");
\r
699 FDD_SensInt(base, NULL, NULL);
\r
701 LOG("Setting Driver Info");
\r
702 outb(base + PORT_DATARATE, 0); // Set data rate to 500K/s
\r
703 FDD_int_SendByte(base, FIX_DRIVE_DATA); // Step and Head Load Times
\r
704 FDD_int_SendByte(base, 0xDF); // Step Rate Time, Head Unload Time (Nibble each)
\r
705 FDD_int_SendByte(base, 0x02); // Head Load Time >> 1
\r
706 while(FDD_int_SeekTrack(0, 0, 1) == 0); // set track
\r
707 while(FDD_int_SeekTrack(0, 1, 1) == 0); // set track
\r
709 LOG("Recalibrating Disk");
\r
710 FDD_Recalibrate((id<<1)|0);
\r
711 FDD_Recalibrate((id<<1)|1);
717 * \fn void FDD_int_TimerCallback()
\r
718 * \brief Called by timer
\r
720 void FDD_int_TimerCallback(int arg)
\r
722 ENTER("iarg", arg);
\r
723 if(gFDD_Devices[arg].motorState == 1)
\r
724 gFDD_Devices[arg].motorState = 2;
\r
725 Time_RemoveTimer(gFDD_Devices[arg].timer);
\r
726 gFDD_Devices[arg].timer = -1;
\r
731 * \fn void FDD_int_StartMotor(char disk)
\r
732 * \brief Starts FDD Motor
\r
734 void FDD_int_StartMotor(int disk)
\r
737 state = inb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT );
\r
738 state |= 1 << (4+disk);
\r
739 outb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT, state );
\r
740 gFDD_Devices[disk].motorState = 1;
\r
741 gFDD_Devices[disk].timer = Time_CreateTimer(MOTOR_ON_DELAY, FDD_int_TimerCallback, (void*)disk); //One Shot Timer
\r
745 * \fn void FDD_int_StopMotor(int disk)
\r
746 * \brief Stops FDD Motor
\r
748 void FDD_int_StopMotor(int disk)
\r
751 state = inb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT );
\r
752 state &= ~( 1 << (4+disk) );
\r
753 outb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT, state );
\r
754 gFDD_Devices[disk].motorState = 0;
\r
758 * \fn void ModuleUnload()
\r
759 * \brief Prepare the module for removal
\r
761 void ModuleUnload()
\r
764 FDD_AquireSpinlock();
\r
766 Time_RemoveTimer(gFDD_Devices[i].timer);
\r
767 FDD_int_StopMotor(i);
\r