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,
70 #define CMD_FLAG_MULTI_TRACK 0x80 //!< Multitrack
71 #define CMD_FLAG_MFM_ENCODING 0x40 //!< MFM Encoding Mode (Always set for read/write/format/verify)
72 #define CMD_FLAG_SKIP_MODE 0x20 //!< Skip Mode (don't use)
74 CMD_READ_TRACK = 0x02,
76 CMD_SENSE_STATUS = 0x04,
77 CMD_WRITE_DATA = 0x05,
79 CMD_RECALIBRATE = 0x07,
80 CMD_SENSE_INTERRUPT = 0x08,
81 CMD_WRITE_DEL_DATA = 0x09,
82 CMD_READ_SECTOR_ID = 0x0A,
84 CMD_READ_DEL_DATA = 0x0C,
85 CMD_FORMAT_TRACK = 0x0D,
87 CMD_SEEK_TRACK = 0x0F,
90 CMD_LOCK = 0x14, //!< Save controller parameters
97 int FDD_Install(char **Arguments);
98 void FDD_UnloadModule();
100 char *FDD_ReadDir(tVFS_Node *Node, int pos);
101 tVFS_Node *FDD_FindDir(tVFS_Node *dirNode, const char *Name);
102 int FDD_IOCtl(tVFS_Node *Node, int ID, void *Data);
103 Uint64 FDD_ReadFS(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer);
104 // --- Functions for IOCache/DrvUtil
105 Uint FDD_ReadSectors(Uint64 SectorAddr, Uint Count, void *Buffer, Uint Disk);
106 // --- Raw Disk Access
107 int FDD_ReadSector(Uint32 disk, Uint64 lba, void *Buffer);
108 int FDD_WriteSector(Uint32 Disk, Uint64 LBA, void *Buffer);
110 void FDD_IRQHandler(int Num);
111 inline void FDD_WaitIRQ();
112 void FDD_SensInt(int base, Uint8 *sr0, Uint8 *cyl);
113 int FDD_int_SendByte(int base, Uint8 Byte);
114 int FDD_int_GetByte(int base, Uint8 *Byte);
115 int FDD_Reset(int id);
116 void FDD_Recalibrate(int disk);
117 int FDD_int_SeekTrack(int disk, int head, int track);
118 void FDD_int_TimerCallback(void *Arg);
119 void FDD_int_StopMotor(void *Arg);
120 void FDD_int_StartMotor(int Disk);
121 int FDD_int_GetDims(int type, int lba, int *c, int *h, int *s, int *spt);
124 MODULE_DEFINE(0, FDD_VERSION, FDD, FDD_Install, NULL, "x86_ISADMA", NULL);
125 t_floppyDevice gFDD_Devices[2];
127 volatile int gbFDD_IrqFired = 0;
128 tDevFS_Driver gFDD_DriverInfo = {
133 .ACLs = &gVFS_ACL_EveryoneRX,
134 .Flags = VFS_FFLAG_DIRECTORY,
135 .ReadDir = FDD_ReadDir,
136 .FindDir = FDD_FindDir,
143 * \fn int FDD_Install(char **Arguments)
144 * \brief Installs floppy driver
146 int FDD_Install(char **Arguments)
149 char **args = Arguments;
151 // Determine Floppy Types (From CMOS)
154 gFDD_Devices[0].type = data >> 4;
155 gFDD_Devices[1].type = data & 0xF;
156 gFDD_Devices[0].track[0] = -1;
157 gFDD_Devices[1].track[1] = -1;
162 if(strcmp(*args, "disable")==0)
163 return MODULE_ERR_NOTNEEDED;
167 Log_Log("FDD", "Detected Disk 0: %s and Disk 1: %s", cFDD_TYPES[data>>4], cFDD_TYPES[data&0xF]);
170 return MODULE_ERR_NOTNEEDED;
173 // Install IRQ6 Handler
174 IRQ_AddHandler(6, FDD_IRQHandler);
175 // Reset Primary FDD Controller
176 if( FDD_Reset(0) != 0 ) {
177 return MODULE_ERR_MISC;
180 // Initialise Root Node
181 gFDD_DriverInfo.RootNode.CTime = gFDD_DriverInfo.RootNode.MTime
182 = gFDD_DriverInfo.RootNode.ATime = now();
184 // Initialise Child Nodes
185 gFDD_Devices[0].Node.Inode = 0;
186 gFDD_Devices[0].Node.Flags = 0;
187 gFDD_Devices[0].Node.NumACLs = 0;
188 gFDD_Devices[0].Node.Read = FDD_ReadFS;
189 gFDD_Devices[0].Node.Write = NULL;//FDD_WriteFS;
190 memcpy(&gFDD_Devices[1].Node, &gFDD_Devices[0].Node, sizeof(tVFS_Node));
192 gFDD_Devices[1].Node.Inode = 1;
195 gFDD_Devices[0].Node.Size = cFDD_SIZES[data >> 4];
196 gFDD_Devices[1].Node.Size = cFDD_SIZES[data & 0xF];
198 // Create Sector Cache
199 if( cFDD_SIZES[data >> 4] )
201 gFDD_Devices[0].CacheHandle = IOCache_Create(
202 FDD_WriteSector, 0, 512,
203 gFDD_Devices[0].Node.Size / (512*4)
204 ); // Cache is 1/4 the size of the disk
206 if( cFDD_SIZES[data & 15] )
208 gFDD_Devices[1].CacheHandle = IOCache_Create(
209 FDD_WriteSector, 0, 512,
210 gFDD_Devices[1].Node.Size / (512*4)
211 ); // Cache is 1/4 the size of the disk
214 // Register with devfs
215 DevFS_AddDevice(&gFDD_DriverInfo);
217 return MODULE_ERR_OK;
221 * \brief Prepare the module for removal
223 void FDD_UnloadModule()
226 DevFS_DelDevice( &gFDD_DriverInfo );
227 Mutex_Acquire(&glFDD);
229 Time_RemoveTimer(gFDD_Devices[i].timer);
230 FDD_int_StopMotor((void *)(Uint)i);
232 Mutex_Release(&glFDD);
237 * \fn char *FDD_ReadDir(tVFS_Node *Node, int pos)
238 * \brief Read Directory
240 char *FDD_ReadDir(tVFS_Node *UNUSED(Node), int Pos)
242 char name[2] = "0\0";
244 if(Pos >= 2 || Pos < 0) return NULL;
246 if(gFDD_Devices[Pos].type == 0) return VFS_SKIP;
254 * \fn tVFS_Node *FDD_FindDir(tVFS_Node *Node, const char *filename);
255 * \brief Find File Routine (for vfs_node)
257 tVFS_Node *FDD_FindDir(tVFS_Node *UNUSED(Node), const char *Filename)
261 ENTER("sFilename", Filename);
263 // Sanity check string
264 if(Filename == NULL) {
269 // Check string length (should be 1)
270 if(Filename[0] == '\0' || Filename[1] != '\0') {
275 // Get First character
276 i = Filename[0] - '0';
278 // Check for 1st disk and if it is present return
279 if(i == 0 && gFDD_Devices[0].type != 0) {
280 LEAVE('p', &gFDD_Devices[0].Node);
281 return &gFDD_Devices[0].Node;
284 // Check for 2nd disk and if it is present return
285 if(i == 1 && gFDD_Devices[1].type != 0) {
286 LEAVE('p', &gFDD_Devices[1].Node);
287 return &gFDD_Devices[1].Node;
295 static const char *casIOCTLS[] = {DRV_IOCTLNAMES,DRV_DISK_IOCTLNAMES,NULL};
297 * \fn int FDD_IOCtl(tVFS_Node *Node, int id, void *data)
298 * \brief Stub ioctl function
300 int FDD_IOCtl(tVFS_Node *UNUSED(Node), int ID, void *Data)
304 BASE_IOCTLS(DRV_TYPE_DISK, "FDD", FDD_VERSION, casIOCTLS);
306 case DISK_IOCTL_GETBLOCKSIZE: return 512;
314 * \fn Uint64 FDD_ReadFS(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
315 * \brief Read Data from a disk
317 Uint64 FDD_ReadFS(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
321 ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
328 if(Node->Inode != 0 && Node->Inode != 1) {
333 ret = DrvUtil_ReadBlock(Offset, Length, Buffer, FDD_ReadSectors, 512, Node->Inode);
339 * \brief Reads \a Count contiguous sectors from a disk
340 * \param SectorAddr Address of the first sector
341 * \param Count Number of sectors to read
342 * \param Buffer Destination Buffer
343 * \param Disk Disk Number
344 * \return Number of sectors read
345 * \note Used as a ::DrvUtil_ReadBlock helper
347 Uint FDD_ReadSectors(Uint64 SectorAddr, Uint Count, void *Buffer, Uint Disk)
352 if( FDD_ReadSector(Disk, SectorAddr, Buffer) != 1 )
355 Buffer = (void*)( (tVAddr)Buffer + 512 );
362 int FDD_int_ReadWriteSector(Uint32 Disk, Uint64 SectorAddr, int Write, void *Buffer)
367 int lba = SectorAddr;
368 Uint8 st0=0, st1=0, st2=0, bps=0; // Status Values
370 ENTER("iDisk XSectorAddr pBuffer", Disk, SectorAddr, Buffer);
372 base = cPORTBASE[Disk >> 1];
374 LOG("Calculating Disk Dimensions");
376 if(FDD_int_GetDims(gFDD_Devices[Disk].type, lba, &cyl, &head, &sec, &spt) != 1)
381 LOG("Cyl=%i, Head=%i, Sector=%i", cyl, head, sec);
383 Mutex_Acquire(&glFDD); // Lock to stop the motor stopping on us
384 Time_RemoveTimer(gFDD_Devices[Disk].timer); // Remove Old Timer
385 // Start motor if needed
386 if(gFDD_Devices[Disk].motorState != 2) FDD_int_StartMotor(Disk);
387 Mutex_Release(&glFDD);
389 LOG("Wait for the motor to spin up");
392 while(gFDD_Devices[Disk].motorState == 1) Threads_Yield();
394 LOG("Acquire Spinlock");
395 Mutex_Acquire(&glFDD);
399 outb(base + CALIBRATE_DRIVE, 0);
401 while(FDD_int_SeekTrack(Disk, head, (Uint8)cyl) == 0 && i++ < FDD_SEEK_TIMEOUT )
403 if( i > FDD_SEEK_TIMEOUT ) {
404 Mutex_Release(&glFDD);
408 //FDD_SensInt(base, NULL, NULL); // Wait for IRQ
411 // Read Data from DMA
412 LOG("Setting DMA for read");
413 DMA_SetChannel(2, 512, !Write); // Read/Write 512 Bytes from channel 2
415 LOG("Sending command");
417 for( i = 0; i < FDD_MAX_READWRITE_ATTEMPTS; i ++ )
420 FDD_int_SendByte(base, CMD_WRITE_DATA|CMD_FLAG_MFM_ENCODING);
422 FDD_int_SendByte(base, CMD_READ_DATA|CMD_FLAG_MFM_ENCODING);
423 FDD_int_SendByte(base, (head << 2) | (Disk&1));
424 FDD_int_SendByte(base, (Uint8)cyl);
425 FDD_int_SendByte(base, (Uint8)head);
426 FDD_int_SendByte(base, (Uint8)sec);
427 FDD_int_SendByte(base, 0x02); // Bytes Per Sector (Real BPS=128*2^{val})
428 FDD_int_SendByte(base, spt); // SPT
429 FDD_int_SendByte(base, 0x1B); // Gap Length (27 is default)
430 FDD_int_SendByte(base, 0xFF); // Data Length
435 DMA_WriteData(2, 512, Buffer);
436 LOG("Waiting for Data to be written");
440 LOG("Waiting for data to be read");
443 DMA_ReadData(2, 512, Buffer);
446 // Clear Input Buffer
447 LOG("Clearing Input Buffer");
449 FDD_int_GetByte(base, &st0);
450 FDD_int_GetByte(base, &st1);
451 FDD_int_GetByte(base, &st2);
453 // Cylinder, Head and Sector (mutilated in some way)
454 FDD_int_GetByte(base, NULL); // Cylinder
455 FDD_int_GetByte(base, NULL); // Head
456 FDD_int_GetByte(base, NULL); // Sector
457 // Should be the BPS set above (0x02)
458 FDD_int_GetByte(base, &bps);
463 LOG("Error (st0 & 0xC0) \"%s\"", cFDD_STATUSES[st0 >> 6]);
467 if(st0 & 0x08) { LOG("Drive not ready"); continue; }
468 if(st1 & 0x80) { LOG("End of Cylinder"); continue; }
469 if(st1 & 0x20) { LOG("CRC Error"); continue; }
470 if(st1 & 0x10) { LOG("Controller Timeout"); continue; }
471 if(st1 & 0x04) { LOG("No Data Found"); continue; }
472 if(st1 & 0x01 || st2 & 0x01) {
473 LOG("No Address mark found");
476 if(st2 & 0x40) { LOG("Deleted address mark"); continue; }
477 if(st2 & 0x20) { LOG("CRC error in data"); continue; }
478 if(st2 & 0x10) { LOG("Wrong Cylinder"); continue; }
479 if(st2 & 0x04) { LOG("uPD765 sector not found"); continue; }
480 if(st2 & 0x02) { LOG("Bad Cylinder"); continue; }
483 LOG("Returned BPS = 0x%02x, not 0x02", bps);
488 LOG("Floppy not writable");
489 // Return error without triggering the attempt count check
490 i = FDD_MAX_READWRITE_ATTEMPTS+1;
499 LOG("Realeasing Spinlock and setting motor to stop");
500 Mutex_Release(&glFDD);
502 if(i == FDD_MAX_READWRITE_ATTEMPTS) {
503 Log_Warning("FDD", "Exceeded %i attempts in %s the disk",
504 FDD_MAX_READWRITE_ATTEMPTS,
505 (Write ? "writing to" : "reading from")
509 // Don't turn the motor off now, wait for a while
510 gFDD_Devices[Disk].timer = Time_CreateTimer(MOTOR_OFF_DELAY, FDD_int_StopMotor, (void*)(tVAddr)Disk);
513 if( i < FDD_MAX_READWRITE_ATTEMPTS ) {
524 * \fn int FDD_ReadSector(Uint32 Disk, Uint64 SectorAddr, void *Buffer)
525 * \brief Read a sector from disk
526 * \todo Make real-hardware safe (account for read errors)
528 int FDD_ReadSector(Uint32 Disk, Uint64 SectorAddr, void *Buffer)
532 ENTER("iDisk XSectorAddr pBuffer", Disk, SectorAddr, Buffer);
534 if( IOCache_Read( gFDD_Devices[Disk].CacheHandle, SectorAddr, Buffer ) == 1 ) {
539 // Pass to general function
540 ret = FDD_int_ReadWriteSector(Disk, SectorAddr, 0, Buffer);
543 IOCache_Add( gFDD_Devices[Disk].CacheHandle, SectorAddr, Buffer );
548 LOG("Reading failed");
555 * \fn int FDD_WriteSector(Uint32 Disk, Uint64 LBA, void *Buffer)
556 * \brief Write a sector to the floppy disk
557 * \note Not Implemented
559 int FDD_WriteSector(Uint32 Disk, Uint64 LBA, void *Buffer)
561 Log_Warning("FDD", "Read Only at the moment");
566 * \fn int FDD_int_SeekTrack(int disk, int track)
567 * \brief Seek disk to selected track
569 int FDD_int_SeekTrack(int disk, int head, int track)
574 base = cPORTBASE[disk>>1];
576 // Check if seeking is needed
577 if(gFDD_Devices[disk].track[head] == track)
581 FDD_int_SendByte(base, CMD_SEEK_TRACK);
582 FDD_int_SendByte(base, (head<<2)|(disk&1));
583 FDD_int_SendByte(base, track); // Send Seek command
585 FDD_SensInt(base, &sr0, &cyl); // Wait for IRQ
586 if((sr0 & 0xF0) != 0x20) {
587 LOG("sr0 = 0x%x", sr0);
588 return 0; //Check Status
590 if(cyl != track) return 0;
592 // Set Track in structure
593 gFDD_Devices[disk].track[head] = track;
595 // Wait for Head to settle
602 * \fn int FDD_int_GetDims(int type, int lba, int *c, int *h, int *s, int *spt)
603 * \brief Get Dimensions of a disk
605 int FDD_int_GetDims(int type, int lba, int *c, int *h, int *s, int *spt)
641 //Log("1440k - lba=%i(0x%x), *s=%i,*c=%i,*h=%i", lba, lba, *s, *c, *h);
659 * \fn void FDD_IRQHandler(int Num)
660 * \brief Handles IRQ6
662 void FDD_IRQHandler(int Num)
669 * \brief Wait for an IRQ6
671 inline void FDD_WaitIRQ()
674 while(!gbFDD_IrqFired) Threads_Yield();
678 void FDD_SensInt(int base, Uint8 *sr0, Uint8 *cyl)
680 FDD_int_SendByte(base, CMD_SENSE_INTERRUPT);
681 FDD_int_GetByte(base, sr0);
682 FDD_int_GetByte(base, cyl);
686 * void FDD_int_SendByte(int base, char byte)
687 * \brief Sends a command to the controller
689 int FDD_int_SendByte(int base, Uint8 byte)
691 tTime end = now() + 1000; // 1s
693 while( (inb(base + PORT_MAINSTATUS) & 0xC0) != 0x80 && now() < end )
694 Threads_Yield(); //Delay
698 outb(base + PORT_DATA, byte);
699 // Log_Debug("FDD", "FDD_int_SendByte: Sent 0x%02x to 0x%x", byte, base);
704 Log_Warning("FDD", "FDD_int_SendByte: Timeout sending byte 0x%x to base 0x%x", byte, base);
710 * int FDD_int_GetByte(int base, char byte)
711 * \brief Receive data from fdd controller
713 int FDD_int_GetByte(int base, Uint8 *value)
715 tTime end = now() + 1000; // 1s
717 while( (inb(base + PORT_MAINSTATUS) & 0xd0) != 0xd0 && now() < end )
722 Uint8 tmp = inb(base + PORT_DATA);
723 if(value) *value = tmp;
724 // Log_Debug("FDD", "FDD_int_GetByte: Read 0x%02x from 0x%x", *value, base);
729 Log_Warning("FDD", "FDD_int_GetByte: Timeout reading byte from base 0x%x", base);
735 * \brief Recalibrate the specified disk
737 void FDD_Recalibrate(int disk)
739 ENTER("idisk", disk);
741 LOG("Starting Motor");
742 FDD_int_StartMotor(disk);
744 while(gFDD_Devices[disk].motorState == 1) Threads_Yield();
746 LOG("Sending Calibrate Command");
747 FDD_int_SendByte(cPORTBASE[disk>>1], CMD_RECALIBRATE);
748 FDD_int_SendByte(cPORTBASE[disk>>1], disk&1);
750 LOG("Waiting for IRQ");
752 FDD_SensInt(cPORTBASE[disk>>1], NULL, NULL);
754 LOG("Stopping Motor");
755 gFDD_Devices[disk].timer = Time_CreateTimer(MOTOR_OFF_DELAY, FDD_int_StopMotor, (void*)(Uint)disk);
760 * \brief Reconfigure the controller
762 int FDD_Reconfigure(int ID)
764 Uint16 base = cPORTBASE[ID];
768 FDD_int_SendByte(base, CMD_CONFIGURE);
769 FDD_int_SendByte(base, 0);
770 // Implied seek enabled, FIFO Enabled, Drive Polling Disabled, data buffer threshold 8 bytes
771 FDD_int_SendByte(base, (1 << 6) | (0 << 5) | (0 << 4) | 7);
772 FDD_int_SendByte(base, 0); // Precompensation - use default
775 FDD_int_SendByte(base, CMD_LOCK|CMD_FLAG_MULTI_TRACK);
776 FDD_int_GetByte(base, NULL);
783 * \brief Reset the specified FDD controller
785 int FDD_Reset(int id)
787 Uint16 base = cPORTBASE[id];
793 outb(base + PORT_DIGOUTPUT, 0); // Disable FDC
794 // Wait 4 microseconds - or use 1 thread delay
796 outb(base + PORT_DIGOUTPUT, 0x0C); // Re-enable FDC (DMA and Enable)
801 FDD_SensInt(base, NULL, NULL);
802 FDD_SensInt(base, NULL, NULL);
803 FDD_SensInt(base, NULL, NULL);
804 FDD_SensInt(base, NULL, NULL);
807 outb(base + PORT_DATARATE, 0); // Set data rate to 500K/s
810 FDD_int_SendByte(base, CMD_SPECIFY); // Step and Head Load Times
811 FDD_int_SendByte(base, 0xDF); // Step Rate Time, Head Unload Time (Nibble each)
812 FDD_int_SendByte(base, 0x02); // Head Load Time >> 1
815 while(FDD_int_SeekTrack(0, 0, 1) == 0 && retries --); // set track
816 if(retries < 0) return -1;
819 while(FDD_int_SeekTrack(0, 1, 1) == 0); // set track
820 if(retries < 0) return -1;
822 LOG("Recalibrating Disk");
823 FDD_Recalibrate((id<<1)|0);
824 FDD_Recalibrate((id<<1)|1);
831 * \fn void FDD_int_TimerCallback()
832 * \brief Called by timer
834 void FDD_int_TimerCallback(void *Arg)
836 int disk = (Uint)Arg;
838 if(gFDD_Devices[disk].motorState == 1)
839 gFDD_Devices[disk].motorState = 2;
840 Time_RemoveTimer(gFDD_Devices[disk].timer);
841 gFDD_Devices[disk].timer = -1;
846 * \fn void FDD_int_StartMotor(char disk)
847 * \brief Starts FDD Motor
849 void FDD_int_StartMotor(int disk)
852 state = inb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT );
853 state |= 1 << (4+disk);
854 outb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT, state );
855 gFDD_Devices[disk].motorState = 1;
856 gFDD_Devices[disk].timer = Time_CreateTimer(MOTOR_ON_DELAY, FDD_int_TimerCallback, (void*)(Uint)disk);
860 * \fn void FDD_int_StopMotor(int disk)
861 * \brief Stops FDD Motor
863 void FDD_int_StopMotor(void *Arg)
865 Uint8 state, disk = (Uint)Arg;
866 if( Mutex_IsLocked(&glFDD) ) return ;
867 ENTER("iDisk", disk);
869 state = inb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT );
870 state &= ~( 1 << (4+disk) );
871 outb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT, state );
872 gFDD_Devices[disk].motorState = 0;