3 * Floppy Disk Access Code
9 #include <tpl_drv_disk.h>
16 // --- Current Version
17 #define FDD_VERSION ((0<<8)|(75))
20 #define FDD_SEEK_TIMEOUT 10 // Timeout for a seek operation
21 #define MOTOR_ON_DELAY 500 // Miliseconds
22 #define MOTOR_OFF_DELAY 2000 // Miliseconds
23 #define FDD_MAX_READWRITE_ATTEMPTS 16
27 * \brief Representation of a floppy drive
29 typedef struct sFloppyDrive
32 volatile int motorState; //2 - On, 1 - Spinup, 0 - Off
37 tIOCache *CacheHandle;
42 * \brief Cached Sector
47 Uint16 sector; // Allows 32Mb of addressable space (Plenty for FDD)
52 static const char *cFDD_TYPES[] = {"None", "360kB 5.25\"", "1.2MB 5.25\"", "720kB 3.5\"", "1.44MB 3.5\"", "2.88MB 3.5\"" };
53 static const int cFDD_SIZES[] = { 0, 360*1024, 1200*1024, 720*1024, 1440*1024, 2880*1024 };
54 static const short cPORTBASE[] = { 0x3F0, 0x370 };
56 static const char *cFDD_STATUSES[] = {NULL, "Error", "Invalid command", "Drive not ready"};
63 PORT_MAINSTATUS = 0x4,
71 FIX_DRIVE_DATA = 0x03,
72 CHECK_DRIVE_STATUS = 0x04,
73 CALIBRATE_DRIVE = 0x07,
74 CHECK_INTERRUPT_STATUS = 0x08,
76 READ_SECTOR_ID = 0x4A,
81 WRITE_DELETE_SECTOR = 0xC9,
82 READ_DELETE_SECTOR = 0xCC,
87 int FDD_Install(char **Arguments);
88 void FDD_UnloadModule();
90 char *FDD_ReadDir(tVFS_Node *Node, int pos);
91 tVFS_Node *FDD_FindDir(tVFS_Node *dirNode, const char *Name);
92 int FDD_IOCtl(tVFS_Node *Node, int ID, void *Data);
93 Uint64 FDD_ReadFS(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer);
94 // --- Functions for IOCache/DrvUtil
95 Uint FDD_ReadSectors(Uint64 SectorAddr, Uint Count, void *Buffer, Uint Disk);
96 // --- Raw Disk Access
97 int FDD_ReadSector(Uint32 disk, Uint64 lba, void *Buffer);
98 int FDD_WriteSector(Uint32 Disk, Uint64 LBA, void *Buffer);
100 void FDD_IRQHandler(int Num);
101 inline void FDD_WaitIRQ();
102 void FDD_SensInt(int base, Uint8 *sr0, Uint8 *cyl);
103 void FDD_int_SendByte(int base, char byte);
104 int FDD_int_GetByte(int base);
105 void FDD_Reset(int id);
106 void FDD_Recalibrate(int disk);
107 int FDD_int_SeekTrack(int disk, int head, int track);
108 void FDD_int_TimerCallback(void *Arg);
109 void FDD_int_StopMotor(void *Arg);
110 void FDD_int_StartMotor(int Disk);
111 int FDD_int_GetDims(int type, int lba, int *c, int *h, int *s, int *spt);
114 MODULE_DEFINE(0, FDD_VERSION, FDD, FDD_Install, NULL, "ISADMA", NULL);
115 t_floppyDevice gFDD_Devices[2];
117 volatile int gbFDD_IrqFired = 0;
118 tDevFS_Driver gFDD_DriverInfo = {
123 .ACLs = &gVFS_ACL_EveryoneRX,
124 .Flags = VFS_FFLAG_DIRECTORY,
125 .ReadDir = FDD_ReadDir,
126 .FindDir = FDD_FindDir,
133 * \fn int FDD_Install(char **Arguments)
134 * \brief Installs floppy driver
136 int FDD_Install(char **Arguments)
139 char **args = Arguments;
141 // Determine Floppy Types (From CMOS)
144 gFDD_Devices[0].type = data >> 4;
145 gFDD_Devices[1].type = data & 0xF;
146 gFDD_Devices[0].track[0] = -1;
147 gFDD_Devices[1].track[1] = -1;
152 if(strcmp(*args, "disable")==0)
153 return MODULE_ERR_NOTNEEDED;
157 Log_Log("FDD", "Detected Disk 0: %s and Disk 1: %s", cFDD_TYPES[data>>4], cFDD_TYPES[data&0xF]);
160 return MODULE_ERR_NOTNEEDED;
163 // Clear FDD IRQ Flag
164 FDD_SensInt(0x3F0, NULL, NULL);
165 // Install IRQ6 Handler
166 IRQ_AddHandler(6, FDD_IRQHandler);
167 // Reset Primary FDD Controller
170 // Initialise Root Node
171 gFDD_DriverInfo.RootNode.CTime = gFDD_DriverInfo.RootNode.MTime
172 = gFDD_DriverInfo.RootNode.ATime = now();
174 // Initialise Child Nodes
175 gFDD_Devices[0].Node.Inode = 0;
176 gFDD_Devices[0].Node.Flags = 0;
177 gFDD_Devices[0].Node.NumACLs = 0;
178 gFDD_Devices[0].Node.Read = FDD_ReadFS;
179 gFDD_Devices[0].Node.Write = NULL;//FDD_WriteFS;
180 memcpy(&gFDD_Devices[1].Node, &gFDD_Devices[0].Node, sizeof(tVFS_Node));
182 gFDD_Devices[1].Node.Inode = 1;
185 gFDD_Devices[0].Node.Size = cFDD_SIZES[data >> 4];
186 gFDD_Devices[1].Node.Size = cFDD_SIZES[data & 0xF];
188 // Create Sector Cache
189 if( cFDD_SIZES[data >> 4] )
191 gFDD_Devices[0].CacheHandle = IOCache_Create(
192 FDD_WriteSector, 0, 512,
193 gFDD_Devices[0].Node.Size / (512*4)
194 ); // Cache is 1/4 the size of the disk
196 if( cFDD_SIZES[data & 15] )
198 gFDD_Devices[1].CacheHandle = IOCache_Create(
199 FDD_WriteSector, 0, 512,
200 gFDD_Devices[1].Node.Size / (512*4)
201 ); // Cache is 1/4 the size of the disk
204 // Register with devfs
205 DevFS_AddDevice(&gFDD_DriverInfo);
207 return MODULE_ERR_OK;
211 * \brief Prepare the module for removal
213 void FDD_UnloadModule()
216 DevFS_DelDevice( &gFDD_DriverInfo );
217 Mutex_Acquire(&glFDD);
219 Time_RemoveTimer(gFDD_Devices[i].timer);
220 FDD_int_StopMotor((void *)(Uint)i);
222 Mutex_Release(&glFDD);
227 * \fn char *FDD_ReadDir(tVFS_Node *Node, int pos)
228 * \brief Read Directory
230 char *FDD_ReadDir(tVFS_Node *UNUSED(Node), int Pos)
232 char name[2] = "0\0";
234 if(Pos >= 2 || Pos < 0) return NULL;
236 if(gFDD_Devices[Pos].type == 0) return VFS_SKIP;
244 * \fn tVFS_Node *FDD_FindDir(tVFS_Node *Node, const char *filename);
245 * \brief Find File Routine (for vfs_node)
247 tVFS_Node *FDD_FindDir(tVFS_Node *UNUSED(Node), const char *Filename)
251 ENTER("sFilename", Filename);
253 // Sanity check string
254 if(Filename == NULL) {
259 // Check string length (should be 1)
260 if(Filename[0] == '\0' || Filename[1] != '\0') {
265 // Get First character
266 i = Filename[0] - '0';
268 // Check for 1st disk and if it is present return
269 if(i == 0 && gFDD_Devices[0].type != 0) {
270 LEAVE('p', &gFDD_Devices[0].Node);
271 return &gFDD_Devices[0].Node;
274 // Check for 2nd disk and if it is present return
275 if(i == 1 && gFDD_Devices[1].type != 0) {
276 LEAVE('p', &gFDD_Devices[1].Node);
277 return &gFDD_Devices[1].Node;
285 static const char *casIOCTLS[] = {DRV_IOCTLNAMES,DRV_DISK_IOCTLNAMES,NULL};
287 * \fn int FDD_IOCtl(tVFS_Node *Node, int id, void *data)
288 * \brief Stub ioctl function
290 int FDD_IOCtl(tVFS_Node *UNUSED(Node), int ID, void *Data)
294 BASE_IOCTLS(DRV_TYPE_DISK, "FDD", FDD_VERSION, casIOCTLS);
296 case DISK_IOCTL_GETBLOCKSIZE: return 512;
304 * \fn Uint64 FDD_ReadFS(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
305 * \brief Read Data from a disk
307 Uint64 FDD_ReadFS(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
311 ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
318 if(Node->Inode != 0 && Node->Inode != 1) {
323 ret = DrvUtil_ReadBlock(Offset, Length, Buffer, FDD_ReadSectors, 512, Node->Inode);
329 * \brief Reads \a Count contiguous sectors from a disk
330 * \param SectorAddr Address of the first sector
331 * \param Count Number of sectors to read
332 * \param Buffer Destination Buffer
333 * \param Disk Disk Number
334 * \return Number of sectors read
335 * \note Used as a ::DrvUtil_ReadBlock helper
337 Uint FDD_ReadSectors(Uint64 SectorAddr, Uint Count, void *Buffer, Uint Disk)
342 if( FDD_ReadSector(Disk, SectorAddr, Buffer) != 1 )
345 Buffer = (void*)( (tVAddr)Buffer + 512 );
352 int FDD_int_ReadWriteSector(Uint32 Disk, Uint64 SectorAddr, int Write, void *Buffer)
357 int lba = SectorAddr;
358 Uint8 st0, st1, st2, rcy, rhe, rse, bps; // Status Values
360 ENTER("iDisk XSectorAddr pBuffer", Disk, SectorAddr, Buffer);
362 base = cPORTBASE[Disk >> 1];
364 LOG("Calculating Disk Dimensions");
366 if(FDD_int_GetDims(gFDD_Devices[Disk].type, lba, &cyl, &head, &sec, &spt) != 1)
371 LOG("Cyl=%i, Head=%i, Sector=%i", cyl, head, sec);
373 Mutex_Acquire(&glFDD); // Lock to stop the motor stopping on us
374 Time_RemoveTimer(gFDD_Devices[Disk].timer); // Remove Old Timer
375 // Start motor if needed
376 if(gFDD_Devices[Disk].motorState != 2) FDD_int_StartMotor(Disk);
377 Mutex_Release(&glFDD);
379 LOG("Wait for the motor to spin up");
382 while(gFDD_Devices[Disk].motorState == 1) Threads_Yield();
384 LOG("Acquire Spinlock");
385 Mutex_Acquire(&glFDD);
388 outb(base + CALIBRATE_DRIVE, 0);
390 while(FDD_int_SeekTrack(Disk, head, (Uint8)cyl) == 0 && i++ < FDD_SEEK_TIMEOUT )
392 if( i > FDD_SEEK_TIMEOUT ) {
393 Mutex_Release(&glFDD);
397 //FDD_SensInt(base, NULL, NULL); // Wait for IRQ
399 // Read Data from DMA
400 LOG("Setting DMA for read");
401 DMA_SetChannel(2, 512, !Write); // Read/Write 512 Bytes from channel 2
403 LOG("Sending command");
405 //Threads_Wait(100); // Wait for Head to settle
408 for( i = 0; i < FDD_MAX_READWRITE_ATTEMPTS; i ++ )
411 FDD_int_SendByte(base, READ_SECTOR); // Was 0xE6
413 FDD_int_SendByte(base, READ_SECTOR); // Was 0xE6
414 FDD_int_SendByte(base, (head << 2) | (Disk&1));
415 FDD_int_SendByte(base, (Uint8)cyl);
416 FDD_int_SendByte(base, (Uint8)head);
417 FDD_int_SendByte(base, (Uint8)sec);
418 FDD_int_SendByte(base, 0x02); // Bytes Per Sector (Real BPS=128*2^{val})
419 FDD_int_SendByte(base, spt); // SPT
420 FDD_int_SendByte(base, 0x1B); // Gap Length (27 is default)
421 FDD_int_SendByte(base, 0xFF); // Data Length
426 DMA_WriteData(2, 512, Buffer);
427 LOG("Waiting for Data to be written");
431 LOG("Waiting for data to be read");
434 DMA_ReadData(2, 512, Buffer);
437 // Clear Input Buffer
438 LOG("Clearing Input Buffer");
440 st0 = FDD_int_GetByte(base);
441 st1 = FDD_int_GetByte(base);
442 st2 = FDD_int_GetByte(base);
444 // Cylinder, Head and Sector (mutilated in some way)
445 rcy = FDD_int_GetByte(base);
446 rhe = FDD_int_GetByte(base);
447 rse = FDD_int_GetByte(base);
448 // Should be the BPS set above (0x02)
449 bps = FDD_int_GetByte(base);
454 LOG("Error (st0 & 0xC0) \"%s\"", cFDD_STATUSES[st0 >> 6]);
458 if(st0 & 0x08) { LOG("Drive not ready"); continue; }
459 if(st1 & 0x80) { LOG("End of Cylinder"); continue; }
460 if(st1 & 0x20) { LOG("CRC Error"); continue; }
461 if(st1 & 0x10) { LOG("Controller Timeout"); continue; }
462 if(st1 & 0x04) { LOG("No Data Found"); continue; }
463 if(st1 & 0x01 || st2 & 0x01) {
464 LOG("No Address mark found");
467 if(st2 & 0x40) { LOG("Deleted address mark"); continue; }
468 if(st2 & 0x20) { LOG("CRC error in data"); continue; }
469 if(st2 & 0x10) { LOG("Wrong Cylinder"); continue; }
470 if(st2 & 0x04) { LOG("uPD765 sector not found"); continue; }
471 if(st2 & 0x02) { LOG("Bad Cylinder"); continue; }
474 LOG("Returned BPS = 0x%02x, not 0x02", bps);
479 LOG("Floppy not writable");
480 i = FDD_MAX_READWRITE_ATTEMPTS+1;
489 LOG("Realeasing Spinlock and setting motor to stop");
490 Mutex_Release(&glFDD);
492 if(i == FDD_MAX_READWRITE_ATTEMPTS) {
493 Log_Warning("FDD", "Exceeded %i attempts in %s the disk",
494 FDD_MAX_READWRITE_ATTEMPTS,
495 (Write ? "writing to" : "reading from")
499 // Don't turn the motor off now, wait for a while
500 gFDD_Devices[Disk].timer = Time_CreateTimer(MOTOR_OFF_DELAY, FDD_int_StopMotor, (void*)(tVAddr)Disk);
503 if( i < FDD_MAX_READWRITE_ATTEMPTS ) {
514 * \fn int FDD_ReadSector(Uint32 Disk, Uint64 SectorAddr, void *Buffer)
515 * \brief Read a sector from disk
516 * \todo Make real-hardware safe (account for read errors)
518 int FDD_ReadSector(Uint32 Disk, Uint64 SectorAddr, void *Buffer)
522 ENTER("iDisk XSectorAddr pBuffer", Disk, SectorAddr, Buffer);
524 if( IOCache_Read( gFDD_Devices[Disk].CacheHandle, SectorAddr, Buffer ) == 1 ) {
529 // Pass to general function
530 ret = FDD_int_ReadWriteSector(Disk, SectorAddr, 0, Buffer);
533 IOCache_Add( gFDD_Devices[Disk].CacheHandle, SectorAddr, Buffer );
538 LOG("Reading failed");
545 * \fn int FDD_WriteSector(Uint32 Disk, Uint64 LBA, void *Buffer)
546 * \brief Write a sector to the floppy disk
547 * \note Not Implemented
549 int FDD_WriteSector(Uint32 Disk, Uint64 LBA, void *Buffer)
551 Warning("[FDD ] Read Only at the moment");
556 * \fn int FDD_int_SeekTrack(int disk, int track)
557 * \brief Seek disk to selected track
559 int FDD_int_SeekTrack(int disk, int head, int track)
564 base = cPORTBASE[disk>>1];
566 // Check if seeking is needed
567 if(gFDD_Devices[disk].track[head] == track)
571 FDD_int_SendByte(base, SEEK_TRACK);
572 FDD_int_SendByte(base, (head<<2)|(disk&1));
573 FDD_int_SendByte(base, track); // Send Seek command
575 FDD_SensInt(base, &sr0, &cyl); // Wait for IRQ
576 if((sr0 & 0xF0) != 0x20) {
577 LOG("sr0 = 0x%x", sr0);
578 return 0; //Check Status
580 if(cyl != track) return 0;
582 // Set Track in structure
583 gFDD_Devices[disk].track[head] = track;
588 * \fn int FDD_int_GetDims(int type, int lba, int *c, int *h, int *s, int *spt)
589 * \brief Get Dimensions of a disk
591 int FDD_int_GetDims(int type, int lba, int *c, int *h, int *s, int *spt)
627 //Log("1440k - lba=%i(0x%x), *s=%i,*c=%i,*h=%i", lba, lba, *s, *c, *h);
645 * \fn void FDD_IRQHandler(int Num)
646 * \brief Handles IRQ6
648 void FDD_IRQHandler(int Num)
655 * \brief Wait for an IRQ6
657 inline void FDD_WaitIRQ()
660 while(!gbFDD_IrqFired) Threads_Yield();
664 void FDD_SensInt(int base, Uint8 *sr0, Uint8 *cyl)
666 FDD_int_SendByte(base, CHECK_INTERRUPT_STATUS);
667 if(sr0) *sr0 = FDD_int_GetByte(base);
668 else FDD_int_GetByte(base);
669 if(cyl) *cyl = FDD_int_GetByte(base);
670 else FDD_int_GetByte(base);
674 * void FDD_int_SendByte(int base, char byte)
675 * \brief Sends a command to the controller
677 void FDD_int_SendByte(int base, char byte)
681 while( (inb(base + PORT_MAINSTATUS) & 0xC0) != 0x80 && timeout-- )
686 outb(base + PORT_DATA, byte);
690 Log_Warning("FDD", "FDD_int_SendByte: Timeout sending byte 0x%x to base 0x%x\n", byte, base);
695 * int FDD_int_GetByte(int base, char byte)
696 * \brief Receive data from fdd controller
698 int FDD_int_GetByte(int base)
702 while( (inb(base + PORT_MAINSTATUS) & 0xd0) != 0xd0 && timeout-- )
707 return inb(base + PORT_DATA);
711 Log_Warning("FDD", "FDD_int_GetByte: Timeout reading byte from base 0x%x\n", base);
717 * \brief Recalibrate the specified disk
719 void FDD_Recalibrate(int disk)
721 ENTER("idisk", disk);
723 LOG("Starting Motor");
724 FDD_int_StartMotor(disk);
726 while(gFDD_Devices[disk].motorState == 1) Threads_Yield();
728 LOG("Sending Calibrate Command");
729 FDD_int_SendByte(cPORTBASE[disk>>1], CALIBRATE_DRIVE);
730 FDD_int_SendByte(cPORTBASE[disk>>1], disk&1);
732 LOG("Waiting for IRQ");
734 FDD_SensInt(cPORTBASE[disk>>1], NULL, NULL);
736 LOG("Stopping Motor");
737 gFDD_Devices[disk].timer = Time_CreateTimer(MOTOR_OFF_DELAY, FDD_int_StopMotor, (void*)(Uint)disk);
742 * \brief Reset the specified FDD controller
744 void FDD_Reset(int id)
746 int base = cPORTBASE[id];
750 outb(base + PORT_DIGOUTPUT, 0); // Stop Motors & Disable FDC
751 outb(base + PORT_DIGOUTPUT, 0x0C); // Re-enable FDC (DMA and Enable)
756 FDD_SensInt(base, NULL, NULL);
758 LOG("Setting Driver Info");
759 outb(base + PORT_DATARATE, 0); // Set data rate to 500K/s
760 FDD_int_SendByte(base, FIX_DRIVE_DATA); // Step and Head Load Times
761 FDD_int_SendByte(base, 0xDF); // Step Rate Time, Head Unload Time (Nibble each)
762 FDD_int_SendByte(base, 0x02); // Head Load Time >> 1
763 while(FDD_int_SeekTrack(0, 0, 1) == 0); // set track
764 while(FDD_int_SeekTrack(0, 1, 1) == 0); // set track
766 LOG("Recalibrating Disk");
767 FDD_Recalibrate((id<<1)|0);
768 FDD_Recalibrate((id<<1)|1);
774 * \fn void FDD_int_TimerCallback()
775 * \brief Called by timer
777 void FDD_int_TimerCallback(void *Arg)
779 int disk = (Uint)Arg;
781 if(gFDD_Devices[disk].motorState == 1)
782 gFDD_Devices[disk].motorState = 2;
783 Time_RemoveTimer(gFDD_Devices[disk].timer);
784 gFDD_Devices[disk].timer = -1;
789 * \fn void FDD_int_StartMotor(char disk)
790 * \brief Starts FDD Motor
792 void FDD_int_StartMotor(int disk)
795 state = inb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT );
796 state |= 1 << (4+disk);
797 outb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT, state );
798 gFDD_Devices[disk].motorState = 1;
799 gFDD_Devices[disk].timer = Time_CreateTimer(MOTOR_ON_DELAY, FDD_int_TimerCallback, (void*)(Uint)disk);
803 * \fn void FDD_int_StopMotor(int disk)
804 * \brief Stops FDD Motor
806 void FDD_int_StopMotor(void *Arg)
808 Uint8 state, disk = (Uint)Arg;
809 if( Mutex_IsLocked(&glFDD) ) return ;
810 ENTER("iDisk", disk);
812 state = inb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT );
813 state &= ~( 1 << (4+disk) );
814 outb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT, state );
815 gFDD_Devices[disk].motorState = 0;