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 HECK_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, 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)
140 // Determine Floppy Types (From CMOS)
143 gFDD_Devices[0].type = data >> 4;
144 gFDD_Devices[1].type = data & 0xF;
145 gFDD_Devices[0].track[0] = -1;
146 gFDD_Devices[1].track[1] = -1;
148 Log_Log("FDD", "Detected Disk 0: %s and Disk 1: %s", cFDD_TYPES[data>>4], cFDD_TYPES[data&0xF]);
151 return MODULE_ERR_NOTNEEDED;
154 // Clear FDD IRQ Flag
155 FDD_SensInt(0x3F0, NULL, NULL);
156 // Install IRQ6 Handler
157 IRQ_AddHandler(6, FDD_IRQHandler);
158 // Reset Primary FDD Controller
161 // Initialise Root Node
162 gFDD_DriverInfo.RootNode.CTime = gFDD_DriverInfo.RootNode.MTime
163 = gFDD_DriverInfo.RootNode.ATime = now();
165 // Initialise Child Nodes
166 gFDD_Devices[0].Node.Inode = 0;
167 gFDD_Devices[0].Node.Flags = 0;
168 gFDD_Devices[0].Node.NumACLs = 0;
169 gFDD_Devices[0].Node.Read = FDD_ReadFS;
170 gFDD_Devices[0].Node.Write = NULL;//FDD_WriteFS;
171 memcpy(&gFDD_Devices[1].Node, &gFDD_Devices[0].Node, sizeof(tVFS_Node));
173 gFDD_Devices[1].Node.Inode = 1;
176 gFDD_Devices[0].Node.Size = cFDD_SIZES[data >> 4];
177 gFDD_Devices[1].Node.Size = cFDD_SIZES[data & 0xF];
179 // Create Sector Cache
180 if( cFDD_SIZES[data >> 4] )
182 gFDD_Devices[0].CacheHandle = IOCache_Create(
183 FDD_WriteSector, 0, 512,
184 gFDD_Devices[0].Node.Size / (512*4)
185 ); // Cache is 1/4 the size of the disk
187 if( cFDD_SIZES[data & 15] )
189 gFDD_Devices[1].CacheHandle = IOCache_Create(
190 FDD_WriteSector, 0, 512,
191 gFDD_Devices[1].Node.Size / (512*4)
192 ); // Cache is 1/4 the size of the disk
195 // Register with devfs
196 DevFS_AddDevice(&gFDD_DriverInfo);
198 return MODULE_ERR_OK;
202 * \brief Prepare the module for removal
204 void FDD_UnloadModule()
207 //DevFS_DelDevice( &gFDD_DriverInfo );
210 Time_RemoveTimer(gFDD_Devices[i].timer);
211 FDD_int_StopMotor((void*)i);
218 * \fn char *FDD_ReadDir(tVFS_Node *Node, int pos)
219 * \brief Read Directory
221 char *FDD_ReadDir(tVFS_Node *Node, int Pos)
223 char name[2] = "0\0";
225 if(Pos >= 2 || Pos < 0) return NULL;
227 if(gFDD_Devices[Pos].type == 0) return VFS_SKIP;
235 * \fn tVFS_Node *FDD_FindDir(tVFS_Node *Node, char *filename);
236 * \brief Find File Routine (for vfs_node)
238 tVFS_Node *FDD_FindDir(tVFS_Node *Node, char *Filename)
242 ENTER("sFilename", Filename);
244 // Sanity check string
245 if(Filename == NULL) {
250 // Check string length (should be 1)
251 if(Filename[0] == '\0' || Filename[1] != '\0') {
256 // Get First character
257 i = Filename[0] - '0';
259 // Check for 1st disk and if it is present return
260 if(i == 0 && gFDD_Devices[0].type != 0) {
261 LEAVE('p', &gFDD_Devices[0].Node);
262 return &gFDD_Devices[0].Node;
265 // Check for 2nd disk and if it is present return
266 if(i == 1 && gFDD_Devices[1].type != 0) {
267 LEAVE('p', &gFDD_Devices[1].Node);
268 return &gFDD_Devices[1].Node;
276 static const char *casIOCTLS[] = {DRV_IOCTLNAMES,DRV_DISK_IOCTLNAMES,NULL};
278 * \fn int FDD_IOCtl(tVFS_Node *Node, int id, void *data)
279 * \brief Stub ioctl function
281 int FDD_IOCtl(tVFS_Node *Node, int ID, void *Data)
285 case DRV_IOCTL_TYPE: return DRV_TYPE_DISK;
286 case DRV_IOCTL_IDENT: return ModUtil_SetIdent(Data, "FDD");
287 case DRV_IOCTL_VERSION: return FDD_VERSION;
288 case DRV_IOCTL_LOOKUP: return ModUtil_LookupString((char**)casIOCTLS, Data);
290 case DISK_IOCTL_GETBLOCKSIZE: return 512;
298 * \fn Uint64 FDD_ReadFS(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
299 * \brief Read Data from a disk
301 Uint64 FDD_ReadFS(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
305 ENTER("pNode XOffset XLength pBuffer", Node, Offset, Length, Buffer);
312 if(Node->Inode != 0 && Node->Inode != 1) {
317 ret = DrvUtil_ReadBlock(Offset, Length, Buffer, FDD_ReadSectors, 512, Node->Inode);
323 * \brief Reads \a Count contiguous sectors from a disk
324 * \param SectorAddr Address of the first sector
325 * \param Count Number of sectors to read
326 * \param Buffer Destination Buffer
327 * \param Disk Disk Number
328 * \return Number of sectors read
329 * \note Used as a ::DrvUtil_ReadBlock helper
331 Uint FDD_ReadSectors(Uint64 SectorAddr, Uint Count, void *Buffer, Uint Disk)
336 if( FDD_ReadSector(Disk, SectorAddr, Buffer) != 1 )
339 Buffer = (void*)( (tVAddr)Buffer + 512 );
346 int FDD_int_ReadWriteSector(Uint32 Disk, Uint64 SectorAddr, int Write, void *Buffer)
351 int lba = SectorAddr;
352 Uint8 st0, st1, st2, rcy, rhe, rse, bps; // Status Values
354 ENTER("iDisk XSectorAddr pBuffer", Disk, SectorAddr, Buffer);
356 base = cPORTBASE[Disk >> 1];
358 LOG("Calculating Disk Dimensions");
360 if(FDD_int_GetDims(gFDD_Devices[Disk].type, lba, &cyl, &head, &sec, &spt) != 1)
365 LOG("Cyl=%i, Head=%i, Sector=%i", cyl, head, sec);
367 LOCK(&glFDD); // Lock to stop the motor stopping on us
368 Time_RemoveTimer(gFDD_Devices[Disk].timer); // Remove Old Timer
369 // Start motor if needed
370 if(gFDD_Devices[Disk].motorState != 2) FDD_int_StartMotor(Disk);
373 LOG("Wait for the motor to spin up");
376 while(gFDD_Devices[Disk].motorState == 1) Threads_Yield();
378 LOG("Acquire Spinlock");
382 outb(base + CALIBRATE_DRIVE, 0);
384 while(FDD_int_SeekTrack(Disk, head, (Uint8)cyl) == 0 && i++ < FDD_SEEK_TIMEOUT )
386 if( i > FDD_SEEK_TIMEOUT ) {
391 //FDD_SensInt(base, NULL, NULL); // Wait for IRQ
393 // Read Data from DMA
394 LOG("Setting DMA for read");
395 DMA_SetChannel(2, 512, !Write); // Read 512 Bytes from channel 2
397 LOG("Sending command");
399 //Threads_Wait(100); // Wait for Head to settle
402 for( i = 0; i < FDD_MAX_READWRITE_ATTEMPTS; i ++ )
405 FDD_int_SendByte(base, READ_SECTOR); // Was 0xE6
407 FDD_int_SendByte(base, READ_SECTOR); // Was 0xE6
408 FDD_int_SendByte(base, (head << 2) | (Disk&1));
409 FDD_int_SendByte(base, (Uint8)cyl);
410 FDD_int_SendByte(base, (Uint8)head);
411 FDD_int_SendByte(base, (Uint8)sec);
412 FDD_int_SendByte(base, 0x02); // Bytes Per Sector (Real BPS=128*2^{val})
413 FDD_int_SendByte(base, spt); // SPT
414 FDD_int_SendByte(base, 0x1B); // Gap Length (27 is default)
415 FDD_int_SendByte(base, 0xFF); // Data Length
420 DMA_WriteData(2, 512, Buffer);
421 LOG("Waiting for Data to be written");
425 LOG("Waiting for data to be read");
428 DMA_ReadData(2, 512, Buffer);
431 // Clear Input Buffer
432 LOG("Clearing Input Buffer");
434 st0 = FDD_int_GetByte(base);
435 st1 = FDD_int_GetByte(base);
436 st2 = FDD_int_GetByte(base);
438 // Cylinder, Head and Sector (mutilated in some way
439 rcy = FDD_int_GetByte(base);
440 rhe = FDD_int_GetByte(base);
441 rse = FDD_int_GetByte(base);
442 // Should be the BPS set above (0x02)
443 bps = FDD_int_GetByte(base);
448 LOG("Error (st0 & 0xC0) \"%s\"", cFDD_STATUSES[st0 >> 6]);
452 if(st0 & 0x08) { LOG("Drive not ready"); continue; }
453 if(st1 & 0x80) { LOG("End of Cylinder"); continue; }
454 if(st1 & 0x20) { LOG("CRC Error"); continue; }
455 if(st1 & 0x10) { LOG("Controller Timeout"); continue; }
456 if(st1 & 0x04) { LOG("No Data Found"); continue; }
457 if(st1 & 0x01 || st2 & 0x01) {
458 LOG("No Address mark found");
461 if(st2 & 0x40) { LOG("Deleted address mark"); continue; }
462 if(st2 & 0x20) { LOG("CRC error in data"); continue; }
463 if(st2 & 0x10) { LOG("Wrong Cylinder"); continue; }
464 if(st2 & 0x04) { LOG("uPD765 sector not found"); continue; }
465 if(st2 & 0x02) { LOG("Bad Cylinder"); continue; }
468 LOG("Returned BPS = 0x%02x, not 0x02", bps);
473 LOG("Floppy not writable");
474 i = FDD_MAX_READWRITE_ATTEMPTS+1;
483 LOG("Realeasing Spinlock and setting motor to stop");
486 if(i == FDD_MAX_READWRITE_ATTEMPTS) {
487 Log_Warning("FDD", "Exceeded %i attempts in %s the disk",
488 FDD_MAX_READWRITE_ATTEMPTS,
489 (Write ? "writing to" : "reading from")
493 // Don't turn the motor off now, wait for a while
494 gFDD_Devices[Disk].timer = Time_CreateTimer(MOTOR_OFF_DELAY, FDD_int_StopMotor, (void*)(tVAddr)Disk);
496 if( i < FDD_MAX_READWRITE_ATTEMPTS ) {
507 * \fn int FDD_ReadSector(Uint32 Disk, Uint64 SectorAddr, void *Buffer)
508 * \brief Read a sector from disk
509 * \todo Make real-hardware safe (account for read errors)
511 int FDD_ReadSector(Uint32 Disk, Uint64 SectorAddr, void *Buffer)
515 ENTER("iDisk XSectorAddr pBuffer", Disk, SectorAddr, Buffer);
517 if( IOCache_Read( gFDD_Devices[Disk].CacheHandle, SectorAddr, Buffer ) == 1 ) {
522 // Pass to general function
523 ret = FDD_int_ReadWriteSector(Disk, SectorAddr, 0, Buffer);
526 IOCache_Add( gFDD_Devices[Disk].CacheHandle, SectorAddr, Buffer );
531 LOG("Reading failed");
538 * \fn int FDD_WriteSector(Uint32 Disk, Uint64 LBA, void *Buffer)
539 * \brief Write a sector to the floppy disk
540 * \note Not Implemented
542 int FDD_WriteSector(Uint32 Disk, Uint64 LBA, void *Buffer)
544 Warning("[FDD ] Read Only at the moment");
549 * \fn int FDD_int_SeekTrack(int disk, int track)
550 * \brief Seek disk to selected track
552 int FDD_int_SeekTrack(int disk, int head, int track)
557 base = cPORTBASE[disk>>1];
559 // Check if seeking is needed
560 if(gFDD_Devices[disk].track[head] == track)
564 FDD_int_SendByte(base, SEEK_TRACK);
565 FDD_int_SendByte(base, (head<<2)|(disk&1));
566 FDD_int_SendByte(base, track); // Send Seek command
568 FDD_SensInt(base, &sr0, &cyl); // Wait for IRQ
569 if((sr0 & 0xF0) != 0x20) {
570 LOG("sr0 = 0x%x", sr0);
571 return 0; //Check Status
573 if(cyl != track) return 0;
575 // Set Track in structure
576 gFDD_Devices[disk].track[head] = track;
581 * \fn int FDD_int_GetDims(int type, int lba, int *c, int *h, int *s, int *spt)
582 * \brief Get Dimensions of a disk
584 int FDD_int_GetDims(int type, int lba, int *c, int *h, int *s, int *spt)
620 //Log("1440k - lba=%i(0x%x), *s=%i,*c=%i,*h=%i", lba, lba, *s, *c, *h);
638 * \fn void FDD_IRQHandler(int Num)
639 * \brief Handles IRQ6
641 void FDD_IRQHandler(int Num)
648 * \brief Wait for an IRQ6
650 inline void FDD_WaitIRQ()
653 while(!gbFDD_IrqFired) Threads_Yield();
657 void FDD_SensInt(int base, Uint8 *sr0, Uint8 *cyl)
659 FDD_int_SendByte(base, CHECK_INTERRUPT_STATUS);
660 if(sr0) *sr0 = FDD_int_GetByte(base);
661 else FDD_int_GetByte(base);
662 if(cyl) *cyl = FDD_int_GetByte(base);
663 else FDD_int_GetByte(base);
667 * void FDD_int_SendByte(int base, char byte)
668 * \brief Sends a command to the controller
670 void FDD_int_SendByte(int base, char byte)
676 state = inb(base + PORT_MAINSTATUS);
677 if ((state & 0xC0) == 0x80)
679 outb(base + PORT_DATA, byte);
686 Warning("FDD_int_SendByte - Timeout sending byte 0x%x to base 0x%x\n", byte, base);
691 * int FDD_int_GetByte(int base, char byte)
692 * \brief Receive data from fdd controller
694 int FDD_int_GetByte(int base)
698 for( timeout = 128; timeout--; )
700 state = inb((base + PORT_MAINSTATUS));
701 if ((state & 0xd0) == 0xd0)
702 return inb(base + PORT_DATA);
709 * \brief Recalibrate the specified disk
711 void FDD_Recalibrate(int disk)
713 ENTER("idisk", disk);
715 LOG("Starting Motor");
716 FDD_int_StartMotor(disk);
718 while(gFDD_Devices[disk].motorState == 1) Threads_Yield();
720 LOG("Sending Calibrate Command");
721 FDD_int_SendByte(cPORTBASE[disk>>1], CALIBRATE_DRIVE);
722 FDD_int_SendByte(cPORTBASE[disk>>1], disk&1);
724 LOG("Waiting for IRQ");
726 FDD_SensInt(cPORTBASE[disk>>1], NULL, NULL);
728 LOG("Stopping Motor");
729 gFDD_Devices[disk].timer = Time_CreateTimer(MOTOR_OFF_DELAY, FDD_int_StopMotor, (void*)(Uint)disk);
734 * \brief Reset the specified FDD controller
736 void FDD_Reset(int id)
738 int base = cPORTBASE[id];
742 outb(base + PORT_DIGOUTPUT, 0); // Stop Motors & Disable FDC
743 outb(base + PORT_DIGOUTPUT, 0x0C); // Re-enable FDC (DMA and Enable)
748 FDD_SensInt(base, NULL, NULL);
750 LOG("Setting Driver Info");
751 outb(base + PORT_DATARATE, 0); // Set data rate to 500K/s
752 FDD_int_SendByte(base, FIX_DRIVE_DATA); // Step and Head Load Times
753 FDD_int_SendByte(base, 0xDF); // Step Rate Time, Head Unload Time (Nibble each)
754 FDD_int_SendByte(base, 0x02); // Head Load Time >> 1
755 while(FDD_int_SeekTrack(0, 0, 1) == 0); // set track
756 while(FDD_int_SeekTrack(0, 1, 1) == 0); // set track
758 LOG("Recalibrating Disk");
759 FDD_Recalibrate((id<<1)|0);
760 FDD_Recalibrate((id<<1)|1);
766 * \fn void FDD_int_TimerCallback()
767 * \brief Called by timer
769 void FDD_int_TimerCallback(void *Arg)
773 if(gFDD_Devices[disk].motorState == 1)
774 gFDD_Devices[disk].motorState = 2;
775 Time_RemoveTimer(gFDD_Devices[disk].timer);
776 gFDD_Devices[disk].timer = -1;
781 * \fn void FDD_int_StartMotor(char disk)
782 * \brief Starts FDD Motor
784 void FDD_int_StartMotor(int disk)
787 state = inb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT );
788 state |= 1 << (4+disk);
789 outb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT, state );
790 gFDD_Devices[disk].motorState = 1;
791 gFDD_Devices[disk].timer = Time_CreateTimer(MOTOR_ON_DELAY, FDD_int_TimerCallback, (void*)(Uint)disk);
795 * \fn void FDD_int_StopMotor(int disk)
796 * \brief Stops FDD Motor
798 void FDD_int_StopMotor(void *Arg)
800 Uint8 state, disk = (int)Arg;
801 if( IS_LOCKED(&glFDD) ) return ;
802 ENTER("iDisk", disk);
804 state = inb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT );
805 state &= ~( 1 << (4+disk) );
806 outb( cPORTBASE[ disk>>1 ] + PORT_DIGOUTPUT, state );
807 gFDD_Devices[disk].motorState = 0;