2 * ReactOS Floppy Driver
3 * Copyright (C) 2004, Vizzini (vizzini@plasmic.com)
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 * PROJECT: ReactOS Floppy Driver
21 * PURPOSE: Main floppy driver routines
22 * PROGRAMMER: Vizzini (vizzini@plasmic.com)
24 * 15-Feb-2004 vizzini - Created
26 * - This driver is only designed to work with ISA-bus floppy controllers. This
27 * won't work on PCI-based controllers or on anything else with level-sensitive
28 * interrupts without modification. I don't think these controllers exist.
30 * ---- General to-do items ----
31 * TODO: Figure out why CreateClose isn't called any more. Seems to correspond
32 * with the driver not being unloadable.
33 * TODO: Think about StopDpcQueued -- could be a race; too tired atm to tell
34 * TODO: Clean up drive start/stop responsibilities (currently a mess...)
36 * ---- Support for proper media detection ----
37 * TODO: Handle MFM flag
38 * TODO: Un-hardcode the data rate from various places
39 * TODO: Proper media detection (right now we're hardcoded to 1.44)
40 * TODO: Media detection based on sector 1
51 #include "readwrite.h"
54 * Global controller info structures. Each controller gets one. Since the system
55 * will probably have only one, with four being a very unlikely maximum, a static
56 * global array is easiest to deal with.
58 static CONTROLLER_INFO gControllerInfo
[MAX_CONTROLLERS
];
59 static ULONG gNumberOfControllers
= 0;
61 /* Queue thread management */
62 static KEVENT QueueThreadTerminate
;
63 static PVOID QueueThreadObject
;
66 static VOID NTAPI
MotorStopDpcFunc(PKDPC UnusedDpc
,
67 PVOID DeferredContext
,
68 PVOID SystemArgument1
,
69 PVOID SystemArgument2
)
71 * FUNCTION: Stop the floppy motor
73 * UnusedDpc: DPC object that's going off
74 * DeferredContext: called with DRIVE_INFO for drive to turn off
75 * SystemArgument1: unused
76 * SystemArgument2: unused
78 * - Must set an event to let other threads know we're done turning off the motor
79 * - Called back at DISPATCH_LEVEL
82 PCONTROLLER_INFO ControllerInfo
= (PCONTROLLER_INFO
)DeferredContext
;
84 UNREFERENCED_PARAMETER(SystemArgument1
);
85 UNREFERENCED_PARAMETER(SystemArgument2
);
86 UNREFERENCED_PARAMETER(UnusedDpc
);
88 ASSERT(KeGetCurrentIrql() == DISPATCH_LEVEL
);
89 ASSERT(ControllerInfo
);
91 DPRINT("floppy: MotorStopDpcFunc called\n");
93 HwTurnOffMotor(ControllerInfo
);
94 ControllerInfo
->StopDpcQueued
= FALSE
;
95 KeSetEvent(&ControllerInfo
->MotorStoppedEvent
, EVENT_INCREMENT
, FALSE
);
99 VOID NTAPI
StartMotor(PDRIVE_INFO DriveInfo
)
101 * FUNCTION: Start the motor, taking into account proper handling of the timer race
103 * DriveInfo: drive to start
105 * - Never call HwTurnOnMotor() directly
106 * - This protocol manages a race between the cancel timer and the requesting thread.
107 * You wouldn't want to turn on the motor and then cancel the timer, because the
108 * cancel dpc might fire in the meantime, and that'd un-do what you just did. If you
109 * cancel the timer first, but KeCancelTimer returns false, the dpc is already running,
110 * so you have to wait until the dpc is completly done running, or else you'll race
111 * with the turner-offer
112 * - PAGED_CODE because we wait
118 DPRINT("floppy: StartMotor called\n");
120 if(DriveInfo
->ControllerInfo
->StopDpcQueued
&& !KeCancelTimer(&DriveInfo
->ControllerInfo
->MotorTimer
))
122 /* Motor turner-offer is already running; wait for it to finish */
123 DPRINT("floppy: StartMotor: motor turner-offer is already running; waiting for it\n");
124 KeWaitForSingleObject(&DriveInfo
->ControllerInfo
->MotorStoppedEvent
, Executive
, KernelMode
, FALSE
, NULL
);
125 DPRINT("floppy: StartMotor: wait satisfied\n");
128 DriveInfo
->ControllerInfo
->StopDpcQueued
= FALSE
;
130 if(HwTurnOnMotor(DriveInfo
) != STATUS_SUCCESS
)
132 DPRINT("floppy: StartMotor(): warning: HwTurnOnMotor failed\n");
137 VOID NTAPI
StopMotor(PCONTROLLER_INFO ControllerInfo
)
139 * FUNCTION: Stop all motors on the controller
141 * DriveInfo: Drive to stop
143 * - Never call HwTurnOffMotor() directly
144 * - This manages the timer cancelation race (see StartMotor for details).
145 * All we have to do is set up a timer.
148 LARGE_INTEGER StopTime
;
150 ASSERT(ControllerInfo
);
152 DPRINT("floppy: StopMotor called\n");
154 /* one relative second, in 100-ns units */
155 StopTime
.QuadPart
= 10000000;
156 StopTime
.QuadPart
*= -1;
158 KeClearEvent(&ControllerInfo
->MotorStoppedEvent
);
159 KeSetTimer(&ControllerInfo
->MotorTimer
, StopTime
, &ControllerInfo
->MotorStopDpc
);
160 ControllerInfo
->StopDpcQueued
= TRUE
;
164 VOID NTAPI
WaitForControllerInterrupt(PCONTROLLER_INFO ControllerInfo
)
166 * FUNCTION: Wait for the controller to interrupt, and then clear the event
168 * ControllerInfo: Controller to wait for
170 * - There is a small chance that an unexpected or spurious interrupt could
171 * be lost with this clear/wait/clear scheme used in this driver. This is
172 * deemed to be an acceptable risk due to the unlikeliness of the scenario,
173 * and the fact that it'll probably work fine next time.
174 * - PAGED_CODE because it waits
178 ASSERT(ControllerInfo
);
180 KeWaitForSingleObject(&ControllerInfo
->SynchEvent
, Executive
, KernelMode
, FALSE
, NULL
);
181 KeClearEvent(&ControllerInfo
->SynchEvent
);
185 static NTSTATUS NTAPI
CreateClose(PDEVICE_OBJECT DeviceObject
,
188 * FUNCTION: Dispatch function called for Create and Close IRPs
190 * DeviceObject: DeviceObject that is the target of the IRP
191 * Irp: IRP to process
193 * STATUS_SUCCESS in all cases
195 * - The Microsoft sample drivers tend to return FILE_OPENED in Information, so I do too.
196 * - No reason to fail the device open
197 * - No state to track, so this routine is easy
198 * - Can be called <= DISPATCH_LEVEL
200 * TODO: Figure out why this isn't getting called
203 UNREFERENCED_PARAMETER(DeviceObject
);
205 DPRINT("floppy: CreateClose called\n");
207 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
208 Irp
->IoStatus
.Information
= FILE_OPENED
;
210 IoCompleteRequest(Irp
, IO_DISK_INCREMENT
);
212 return STATUS_SUCCESS
;
216 static NTSTATUS NTAPI
Recalibrate(PDRIVE_INFO DriveInfo
)
218 * FUNCTION: Start the recalibration process
220 * DriveInfo: Pointer to the driveinfo struct associated with the targeted drive
222 * STATUS_SUCCESS on successful starting of the process
223 * STATUS_IO_DEVICE_ERROR if it fails
225 * - Sometimes you have to do two recalibrations, particularly if the disk has <80 tracks.
226 * - PAGED_CODE because we wait
235 /* first turn on the motor */
236 /* Must stop after every start, prior to return */
237 StartMotor(DriveInfo
);
239 /* set the data rate */
240 DPRINT("floppy: FIXME: UN-HARDCODE DATA RATE\n");
241 if(HwSetDataRate(DriveInfo
->ControllerInfo
, 0) != STATUS_SUCCESS
)
243 DPRINT("floppy: Recalibrate: HwSetDataRate failed\n");
244 StopMotor(DriveInfo
->ControllerInfo
);
245 return STATUS_IO_DEVICE_ERROR
;
248 /* clear the event just in case the last call forgot */
249 KeClearEvent(&DriveInfo
->ControllerInfo
->SynchEvent
);
251 /* sometimes you have to do this twice; we'll just do it twice all the time since
252 * we don't know if the people calling this Recalibrate routine expect a disk to
253 * even be in the drive, and if so, if that disk is formatted.
255 for(i
= 0; i
< 2; i
++)
257 /* Send the command */
258 Status
= HwRecalibrate(DriveInfo
);
259 if(Status
!= STATUS_SUCCESS
)
261 DPRINT("floppy: Recalibrate: HwRecalibrate returned error\n");
265 WaitForControllerInterrupt(DriveInfo
->ControllerInfo
);
267 /* Get the results */
268 Status
= HwRecalibrateResult(DriveInfo
->ControllerInfo
);
269 if(Status
!= STATUS_SUCCESS
)
271 DPRINT("floppy: Recalibrate: HwRecalibrateResult returned error\n");
276 KeClearEvent(&DriveInfo
->ControllerInfo
->SynchEvent
);
278 /* Must stop after every start, prior to return */
279 StopMotor(DriveInfo
->ControllerInfo
);
285 NTSTATUS NTAPI
ResetChangeFlag(PDRIVE_INFO DriveInfo
)
287 * FUNCTION: Reset the drive's change flag (as reflected in the DIR)
289 * DriveInfo: the drive to reset
291 * STATUS_SUCCESS if the changeline is cleared
292 * STATUS_NO_MEDIA_IN_DEVICE if the changeline cannot be cleared
293 * STATUS_IO_DEVICE_ERROR if the controller cannot be communicated with
295 * - Change reset procedure: recalibrate, seek 1, seek 0
296 * - If the line is still set after that, there's clearly no disk in the
297 * drive, so we return STATUS_NO_MEDIA_IN_DEVICE
298 * - PAGED_CODE because we wait
306 DPRINT("floppy: ResetChangeFlag called\n");
308 /* Try to recalibrate. We don't care if it works. */
309 Recalibrate(DriveInfo
);
311 /* clear spurious interrupts in prep for seeks */
312 KeClearEvent(&DriveInfo
->ControllerInfo
->SynchEvent
);
314 /* must re-start the drive because Recalibrate() stops it */
315 StartMotor(DriveInfo
);
318 if(HwSeek(DriveInfo
, 1) != STATUS_SUCCESS
)
320 DPRINT("floppy: ResetChangeFlag(): HwSeek failed; returning STATUS_IO_DEVICE_ERROR\n");
321 StopMotor(DriveInfo
->ControllerInfo
);
322 return STATUS_IO_DEVICE_ERROR
;
325 WaitForControllerInterrupt(DriveInfo
->ControllerInfo
);
327 if(HwSenseInterruptStatus(DriveInfo
->ControllerInfo
) != STATUS_SUCCESS
)
329 DPRINT("floppy: ResetChangeFlag(): HwSenseInterruptStatus failed; bailing out\n");
330 StopMotor(DriveInfo
->ControllerInfo
);
331 return STATUS_IO_DEVICE_ERROR
;
335 if(HwSeek(DriveInfo
, 0) != STATUS_SUCCESS
)
337 DPRINT("floppy: ResetChangeFlag(): HwSeek failed; returning STATUS_IO_DEVICE_ERROR\n");
338 StopMotor(DriveInfo
->ControllerInfo
);
339 return STATUS_IO_DEVICE_ERROR
;
342 WaitForControllerInterrupt(DriveInfo
->ControllerInfo
);
344 if(HwSenseInterruptStatus(DriveInfo
->ControllerInfo
) != STATUS_SUCCESS
)
346 DPRINT("floppy: ResetChangeFlag(): HwSenseInterruptStatus #2 failed; bailing\n");
347 StopMotor(DriveInfo
->ControllerInfo
);
348 return STATUS_IO_DEVICE_ERROR
;
351 /* Check the change bit */
352 if(HwDiskChanged(DriveInfo
, &DiskChanged
) != STATUS_SUCCESS
)
354 DPRINT("floppy: ResetChangeFlag(): HwDiskChagned failed; returning STATUS_IO_DEVICE_ERROR\n");
355 StopMotor(DriveInfo
->ControllerInfo
);
356 return STATUS_IO_DEVICE_ERROR
;
359 StopMotor(DriveInfo
->ControllerInfo
);
361 /* if the change flag is still set, there's probably no media in the drive. */
363 return STATUS_NO_MEDIA_IN_DEVICE
;
365 /* else we're done! */
366 return STATUS_SUCCESS
;
370 static VOID NTAPI
Unload(PDRIVER_OBJECT DriverObject
)
372 * FUNCTION: Unload the driver from memory
374 * DriverObject - The driver that is being unloaded
380 UNREFERENCED_PARAMETER(DriverObject
);
382 DPRINT("floppy: unloading\n");
384 KeSetEvent(&QueueThreadTerminate
, 0, FALSE
);
385 KeWaitForSingleObject(QueueThreadObject
, Executive
, KernelMode
, FALSE
, 0);
386 ObDereferenceObject(QueueThreadObject
);
388 for(i
= 0; i
< gNumberOfControllers
; i
++)
390 if(!gControllerInfo
[i
].Initialized
)
393 for(j
= 0; j
< gControllerInfo
[i
].NumberOfDrives
; j
++)
395 if(!gControllerInfo
[i
].DriveInfo
[j
].Initialized
)
398 if(gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
)
402 RtlInitUnicodeString(&Link
, gControllerInfo
[i
].DriveInfo
[j
].SymLinkBuffer
);
403 IoDeleteSymbolicLink(&Link
);
405 RtlInitUnicodeString(&Link
, gControllerInfo
[i
].DriveInfo
[j
].ArcPathBuffer
);
406 IoDeassignArcName(&Link
);
408 IoDeleteDevice(gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
);
412 IoDisconnectInterrupt(gControllerInfo
[i
].InterruptObject
);
414 /* Power down the controller */
415 if(HwPowerOff(&gControllerInfo
[i
]) != STATUS_SUCCESS
)
417 DPRINT("floppy: unload: warning: HwPowerOff failed\n");
423 static NTSTATUS NTAPI
ConfigCallback(PVOID Context
,
424 PUNICODE_STRING PathName
,
425 INTERFACE_TYPE BusType
,
427 PKEY_VALUE_FULL_INFORMATION
*BusInformation
,
428 CONFIGURATION_TYPE ControllerType
,
429 ULONG ControllerNumber
,
430 PKEY_VALUE_FULL_INFORMATION
*ControllerInformation
,
431 CONFIGURATION_TYPE PeripheralType
,
432 ULONG PeripheralNumber
,
433 PKEY_VALUE_FULL_INFORMATION
*PeripheralInformation
)
435 * FUNCTION: Callback to IoQueryDeviceDescription, which tells us about our controllers
439 * BusType: Type of the bus that our controller is on
440 * BusNumber: Number of the bus that our controller is on
441 * BusInformation: Unused
442 * ControllerType: Unused
443 * ControllerNumber: Number of the controller that we're adding
444 * ControllerInformation: Full configuration information for our controller
445 * PeripheralType: Unused
446 * PeripheralNumber: Unused
447 * PeripheralInformation: Full configuration information for each drive on our controller
449 * STATUS_SUCCESS in all cases
451 * - The only documentation I've found about the contents of these structures is
452 * from the various Microsoft floppy samples and from the DDK headers. They're
453 * very vague, though, so I'm only mostly sure that this stuff is correct, as
454 * the MS samples do things completely differently than I have done them. Seems
455 * to work in my VMWare, though.
456 * - Basically, the function gets all of the information (port, dma, irq) about the
457 * controller, and then loops through all of the drives presented in PeripheralInformation.
458 * - Each controller has a CONTROLLER_INFO created for it, and each drive has a DRIVE_INFO.
459 * - Device objects are created for each drive (not controller), as that's the targeted
460 * device in the eyes of the rest of the OS. Each DRIVE_INFO points to a single CONTROLLER_INFO.
461 * - We only support up to four controllers in the whole system, each of which supports up to four
465 PKEY_VALUE_FULL_INFORMATION ControllerFullDescriptor
= ControllerInformation
[IoQueryDeviceConfigurationData
];
466 PCM_FULL_RESOURCE_DESCRIPTOR ControllerResourceDescriptor
= (PCM_FULL_RESOURCE_DESCRIPTOR
)((PCHAR
)ControllerFullDescriptor
+
467 ControllerFullDescriptor
->DataOffset
);
469 PKEY_VALUE_FULL_INFORMATION PeripheralFullDescriptor
= PeripheralInformation
[IoQueryDeviceConfigurationData
];
470 PCM_FULL_RESOURCE_DESCRIPTOR PeripheralResourceDescriptor
= (PCM_FULL_RESOURCE_DESCRIPTOR
)((PCHAR
)PeripheralFullDescriptor
+
471 PeripheralFullDescriptor
->DataOffset
);
473 PCM_PARTIAL_RESOURCE_DESCRIPTOR PartialDescriptor
;
474 PCM_FLOPPY_DEVICE_DATA FloppyDeviceData
;
478 UNREFERENCED_PARAMETER(PeripheralType
);
479 UNREFERENCED_PARAMETER(PeripheralNumber
);
480 UNREFERENCED_PARAMETER(BusInformation
);
481 UNREFERENCED_PARAMETER(Context
);
482 UNREFERENCED_PARAMETER(ControllerType
);
483 UNREFERENCED_PARAMETER(PathName
);
486 DPRINT("floppy: ConfigCallback called with ControllerNumber %d\n", ControllerNumber
);
488 gControllerInfo
[gNumberOfControllers
].ControllerNumber
= ControllerNumber
;
489 gControllerInfo
[gNumberOfControllers
].InterfaceType
= BusType
;
490 gControllerInfo
[gNumberOfControllers
].BusNumber
= BusNumber
;
492 /* Get controller interrupt level/vector, dma channel, and port base */
493 for(i
= 0; i
< ControllerResourceDescriptor
->PartialResourceList
.Count
; i
++)
495 KeInitializeEvent(&gControllerInfo
[gNumberOfControllers
].SynchEvent
, NotificationEvent
, FALSE
);
497 PartialDescriptor
= &ControllerResourceDescriptor
->PartialResourceList
.PartialDescriptors
[i
];
499 if(PartialDescriptor
->Type
== CmResourceTypeInterrupt
)
501 gControllerInfo
[gNumberOfControllers
].Level
= PartialDescriptor
->u
.Interrupt
.Level
;
502 gControllerInfo
[gNumberOfControllers
].Vector
= PartialDescriptor
->u
.Interrupt
.Vector
;
504 if(PartialDescriptor
->Flags
& CM_RESOURCE_INTERRUPT_LATCHED
)
505 gControllerInfo
[gNumberOfControllers
].InterruptMode
= Latched
;
507 gControllerInfo
[gNumberOfControllers
].InterruptMode
= LevelSensitive
;
510 else if(PartialDescriptor
->Type
== CmResourceTypePort
)
512 PHYSICAL_ADDRESS TranslatedAddress
;
513 ULONG AddressSpace
= 0x1; /* I/O Port Range */
515 if(!HalTranslateBusAddress(BusType
, BusNumber
, PartialDescriptor
->u
.Port
.Start
, &AddressSpace
, &TranslatedAddress
))
517 DPRINT("floppy: HalTranslateBusAddress failed; returning\n");
518 return STATUS_IO_DEVICE_ERROR
;
521 if(AddressSpace
== 0)
522 gControllerInfo
[gNumberOfControllers
].BaseAddress
= MmMapIoSpace(TranslatedAddress
, FDC_PORT_BYTES
, MmNonCached
);
524 gControllerInfo
[gNumberOfControllers
].BaseAddress
= (PUCHAR
)TranslatedAddress
.u
.LowPart
;
527 else if(PartialDescriptor
->Type
== CmResourceTypeDma
)
528 gControllerInfo
[gNumberOfControllers
].Dma
= PartialDescriptor
->u
.Dma
.Channel
;
531 /* Start with 0 drives, then go looking */
532 gControllerInfo
[gNumberOfControllers
].NumberOfDrives
= 0;
534 /* learn about drives attached to controller */
535 for(i
= 0; i
< PeripheralResourceDescriptor
->PartialResourceList
.Count
; i
++)
537 PDRIVE_INFO DriveInfo
= &gControllerInfo
[gNumberOfControllers
].DriveInfo
[i
];
539 PartialDescriptor
= &PeripheralResourceDescriptor
->PartialResourceList
.PartialDescriptors
[i
];
541 if(PartialDescriptor
->Type
!= CmResourceTypeDeviceSpecific
)
544 FloppyDeviceData
= (PCM_FLOPPY_DEVICE_DATA
)(PartialDescriptor
+ 1);
546 DriveInfo
->ControllerInfo
= &gControllerInfo
[gNumberOfControllers
];
547 DriveInfo
->UnitNumber
= i
;
549 DriveInfo
->FloppyDeviceData
.MaxDensity
= FloppyDeviceData
->MaxDensity
;
550 DriveInfo
->FloppyDeviceData
.MountDensity
= FloppyDeviceData
->MountDensity
;
551 DriveInfo
->FloppyDeviceData
.StepRateHeadUnloadTime
= FloppyDeviceData
->StepRateHeadUnloadTime
;
552 DriveInfo
->FloppyDeviceData
.HeadLoadTime
= FloppyDeviceData
->HeadLoadTime
;
553 DriveInfo
->FloppyDeviceData
.MotorOffTime
= FloppyDeviceData
->MotorOffTime
;
554 DriveInfo
->FloppyDeviceData
.SectorLengthCode
= FloppyDeviceData
->SectorLengthCode
;
555 DriveInfo
->FloppyDeviceData
.SectorPerTrack
= FloppyDeviceData
->SectorPerTrack
;
556 DriveInfo
->FloppyDeviceData
.ReadWriteGapLength
= FloppyDeviceData
->ReadWriteGapLength
;
557 DriveInfo
->FloppyDeviceData
.FormatGapLength
= FloppyDeviceData
->FormatGapLength
;
558 DriveInfo
->FloppyDeviceData
.FormatFillCharacter
= FloppyDeviceData
->FormatFillCharacter
;
559 DriveInfo
->FloppyDeviceData
.HeadSettleTime
= FloppyDeviceData
->HeadSettleTime
;
560 DriveInfo
->FloppyDeviceData
.MotorSettleTime
= FloppyDeviceData
->MotorSettleTime
;
561 DriveInfo
->FloppyDeviceData
.MaximumTrackValue
= FloppyDeviceData
->MaximumTrackValue
;
562 DriveInfo
->FloppyDeviceData
.DataTransferLength
= FloppyDeviceData
->DataTransferLength
;
564 /* Once it's all set up, acknowledge its existance in the controller info object */
565 gControllerInfo
[gNumberOfControllers
].NumberOfDrives
++;
568 gControllerInfo
[gNumberOfControllers
].Populated
= TRUE
;
569 gNumberOfControllers
++;
571 return STATUS_SUCCESS
;
575 static BOOLEAN NTAPI
Isr(PKINTERRUPT Interrupt
,
576 PVOID ServiceContext
)
578 * FUNCTION: Interrupt service routine for the controllers
580 * Interrupt: Interrupt object representing the interrupt that occured
581 * ServiceContext: Pointer to the ControllerInfo object that caused the interrupt
583 * TRUE in all cases (see notes)
585 * - We should always be the target of the interrupt, being an edge-triggered ISA interrupt, but
586 * this won't be the case with a level-sensitive system like PCI
587 * - Note that it probably doesn't matter if the interrupt isn't dismissed, as it's edge-triggered.
588 * It probably won't keep re-interrupting.
589 * - There are two different ways to dismiss a floppy interrupt. If the command has a result phase
590 * (see intel datasheet), you dismiss the interrupt by reading the first data byte. If it does
591 * not, you dismiss the interrupt by doing a Sense Interrupt command. Again, because it's edge-
592 * triggered, this is safe to not do here, as we can just wait for the DPC.
593 * - Either way, we don't want to do this here. The controller shouldn't interrupt again, so we'll
594 * schedule a DPC to take care of it.
595 * - This driver really cannot shrare interrupts, as I don't know how to conclusively say
596 * whether it was our controller that interrupted or not. I just have to assume that any time
597 * my ISR gets called, it was my board that called it. Dumb design, yes, but it goes back to
598 * the semantics of ISA buses. That, and I don't know much about ISA drivers. :-)
599 * UPDATE: The high bit of Status Register A seems to work on non-AT controllers.
603 PCONTROLLER_INFO ControllerInfo
= (PCONTROLLER_INFO
)ServiceContext
;
605 UNREFERENCED_PARAMETER(Interrupt
);
607 ASSERT(ControllerInfo
);
609 DPRINT("floppy: ISR called\n");
612 * Due to the stupidity of the drive/controller relationship on the floppy drive, only one device object
613 * can have an active interrupt pending. Due to the nature of these IRPs, though, there will only ever
614 * be one thread expecting an interrupt at a time, and furthermore, Interrupts (outside of spurious ones)
615 * won't ever happen unless a thread is expecting them. Therefore, all we have to do is signal an event
616 * and we're done. Queue a DPC and leave.
618 KeInsertQueueDpc(&ControllerInfo
->Dpc
, NULL
, NULL
);
624 VOID NTAPI
DpcForIsr(PKDPC UnusedDpc
,
626 PVOID SystemArgument1
,
627 PVOID SystemArgument2
)
629 * FUNCTION: This DPC gets queued by every ISR. Does the real per-interrupt work.
631 * UnusedDpc: Pointer to the DPC object that represents our function
632 * DeviceObject: Device that this DPC is running for
634 * Context: Pointer to our ControllerInfo struct
636 * - This function just kicks off whatever the SynchEvent is and returns. We depend on
637 * the thing that caused the drive to interrupt to handle the work of clearing the interrupt.
638 * This enables us to get back to PASSIVE_LEVEL and not hog system time on a really stupid,
639 * slow, screwed-up piece of hardare.
640 * - If nothing is waiting for us to set the event, the interrupt is effectively lost and will
641 * never be dismissed. I wonder if this will become a problem.
642 * - Called at DISPATCH_LEVEL
645 PCONTROLLER_INFO ControllerInfo
= (PCONTROLLER_INFO
)Context
;
647 UNREFERENCED_PARAMETER(UnusedDpc
);
648 UNREFERENCED_PARAMETER(SystemArgument1
);
649 UNREFERENCED_PARAMETER(SystemArgument2
);
651 ASSERT(ControllerInfo
);
653 DPRINT("floppy: DpcForIsr called\n");
655 KeSetEvent(&ControllerInfo
->SynchEvent
, EVENT_INCREMENT
, FALSE
);
659 static NTSTATUS NTAPI
InitController(PCONTROLLER_INFO ControllerInfo
)
661 * FUNCTION: Initialize a newly-found controller
663 * ControllerInfo: pointer to the controller to be initialized
665 * STATUS_SUCCESS if the controller is successfully initialized
666 * STATUS_IO_DEVICE_ERROR otherwise
671 UCHAR HeadUnloadTime
;
675 ASSERT(ControllerInfo
);
677 DPRINT("floppy: InitController called with Controller 0x%x\n", ControllerInfo
);
679 KeClearEvent(&ControllerInfo
->SynchEvent
);
681 DPRINT("floppy: InitController: resetting the controller\n");
683 /* Reset the controller */
684 if(HwReset(ControllerInfo
) != STATUS_SUCCESS
)
686 DPRINT("floppy: InitController: unable to reset controller\n");
687 return STATUS_IO_DEVICE_ERROR
;
690 DPRINT("floppy: InitController: setting data rate\n");
693 if(HwSetDataRate(ControllerInfo
, DRSR_DSEL_500KBPS
) != STATUS_SUCCESS
)
695 DPRINT("floppy: InitController: unable to set data rate\n");
696 return STATUS_IO_DEVICE_ERROR
;
699 DPRINT("floppy: InitController: waiting for initial interrupt\n");
701 /* Wait for an interrupt */
702 WaitForControllerInterrupt(ControllerInfo
);
704 /* Reset means you have to clear each of the four interrupts (one per drive) */
705 for(i
= 0; i
< MAX_DRIVES_PER_CONTROLLER
; i
++)
707 DPRINT("floppy: InitController: Sensing interrupt %d\n", i
);
709 if(HwSenseInterruptStatus(ControllerInfo
) != STATUS_SUCCESS
)
711 DPRINT("floppy: InitController: Unable to clear interrupt 0x%x\n", i
);
712 return STATUS_IO_DEVICE_ERROR
;
716 DPRINT("floppy: InitController: done sensing interrupts\n");
718 /* Next, see if we have the right version to do implied seek */
719 if(HwGetVersion(ControllerInfo
) == VERSION_ENHANCED
)
721 /* If so, set that up -- all defaults below except first TRUE for EIS */
722 if(HwConfigure(ControllerInfo
, TRUE
, TRUE
, FALSE
, 0, 0) != STATUS_SUCCESS
)
724 DPRINT("floppy: InitController: unable to set up implied seek\n");
725 ControllerInfo
->ImpliedSeeks
= FALSE
;
729 DPRINT("floppy: InitController: implied seeks set!\n");
730 ControllerInfo
->ImpliedSeeks
= TRUE
;
734 * FIXME: Figure out the answer to the below
736 * I must admit that I'm really confused about the Model 30 issue. At least one
737 * important bit (the disk change bit in the DIR) is flipped if this is a Model 30
738 * controller. However, at least one other floppy driver believes that there are only
739 * two computers that are guaranteed to have a Model 30 controller:
743 * ...and another driver only lists a config option for "thinkpad", that flips
744 * the change line. A third driver doesn't mention the Model 30 issue at all.
746 * What I can't tell is whether or not the average, run-of-the-mill computer now has
747 * a Model 30 controller. For the time being, I'm going to wire this to FALSE,
748 * and just not support the computers mentioned above, while I try to figure out
749 * how ubiquitous these newfangled 30 thingies are.
751 //ControllerInfo->Model30 = TRUE;
752 ControllerInfo
->Model30
= FALSE
;
756 DPRINT("floppy: InitController: enhanced version not supported; disabling implied seeks\n");
757 ControllerInfo
->ImpliedSeeks
= FALSE
;
758 ControllerInfo
->Model30
= FALSE
;
762 DPRINT("FLOPPY: FIXME: Figure out speed\n");
763 HeadLoadTime
= SPECIFY_HLT_500K
;
764 HeadUnloadTime
= SPECIFY_HUT_500K
;
765 StepRateTime
= SPECIFY_SRT_500K
;
767 DPRINT("floppy: InitController: issuing specify command to controller\n");
769 /* Don't disable DMA --> enable dma (dumb & confusing) */
770 if(HwSpecify(ControllerInfo
, HeadLoadTime
, HeadUnloadTime
, StepRateTime
, FALSE
) != STATUS_SUCCESS
)
772 DPRINT("floppy: InitController: unable to specify options\n");
773 return STATUS_IO_DEVICE_ERROR
;
776 /* Init the stop stuff */
777 KeInitializeDpc(&ControllerInfo
->MotorStopDpc
, MotorStopDpcFunc
, ControllerInfo
);
778 KeInitializeTimer(&ControllerInfo
->MotorTimer
);
779 KeInitializeEvent(&ControllerInfo
->MotorStoppedEvent
, NotificationEvent
, FALSE
);
780 ControllerInfo
->StopDpcQueued
= FALSE
;
783 * Recalibrate each drive on the controller (depends on StartMotor, which depends on the timer stuff above)
784 * We don't even know if there is a disk in the drive, so this may not work, but that's OK.
786 for(i
= 0; i
< ControllerInfo
->NumberOfDrives
; i
++)
788 DPRINT("floppy: InitController: recalibrating drive 0x%x on controller 0x%x\n", i
, ControllerInfo
);
789 Recalibrate(&ControllerInfo
->DriveInfo
[i
]);
792 DPRINT("floppy: InitController: done initializing; returning STATUS_SUCCESS\n");
794 return STATUS_SUCCESS
;
798 static BOOLEAN NTAPI
AddControllers(PDRIVER_OBJECT DriverObject
)
800 * FUNCTION: Called on initialization to find our controllers and build device and controller objects for them
802 * DriverObject: Our driver's DriverObject (so we can create devices against it)
804 * FALSE if we can't allocate a device, adapter, or interrupt object, or if we fail to find any controllers
805 * TRUE otherwise (i.e. we have at least one fully-configured controller)
807 * - Currently we only support ISA buses.
808 * - BUG: Windows 2000 seems to clobber the response from the IoQueryDeviceDescription callback, so now we
809 * just test a boolean value in the first object to see if it was completely populated. The same value
810 * is tested for each controller before we build device objects for it.
812 * - Report resource usage to the HAL
815 INTERFACE_TYPE InterfaceType
= Isa
;
816 CONFIGURATION_TYPE ControllerType
= DiskController
;
817 CONFIGURATION_TYPE PeripheralType
= FloppyDiskPeripheral
;
819 DEVICE_DESCRIPTION DeviceDescription
;
825 /* Find our controllers on all ISA buses */
826 IoQueryDeviceDescription(&InterfaceType
, 0, &ControllerType
, 0, &PeripheralType
, 0, ConfigCallback
, 0);
829 * w2k breaks the return val from ConfigCallback, so we have to hack around it, rather than just
830 * looking for a return value from ConfigCallback. We expect at least one controller.
832 if(!gControllerInfo
[0].Populated
)
834 DPRINT("floppy: AddControllers: failed to get controller info from registry\n");
838 /* Now that we have a controller, set it up with the system */
839 for(i
= 0; i
< gNumberOfControllers
; i
++)
841 /* 0: Report resource usage to the kernel, to make sure they aren't assigned to anyone else */
842 /* FIXME: Implement me. */
844 /* 1: Set up interrupt */
845 gControllerInfo
[i
].MappedVector
= HalGetInterruptVector(gControllerInfo
[i
].InterfaceType
, gControllerInfo
[i
].BusNumber
,
846 gControllerInfo
[i
].Level
, gControllerInfo
[i
].Vector
,
847 &gControllerInfo
[i
].MappedLevel
, &Affinity
);
849 /* Must set up the DPC before we connect the interrupt */
850 KeInitializeDpc(&gControllerInfo
[i
].Dpc
, DpcForIsr
, &gControllerInfo
[i
]);
852 DPRINT("floppy: Connecting interrupt %d to controller%d (object 0x%x)\n", gControllerInfo
[i
].MappedVector
,
853 i
, &gControllerInfo
[i
]);
855 /* NOTE: We cannot share our interrupt, even on level-triggered buses. See Isr() for details. */
856 if(IoConnectInterrupt(&gControllerInfo
[i
].InterruptObject
, Isr
, &gControllerInfo
[i
], 0, gControllerInfo
[i
].MappedVector
,
857 gControllerInfo
[i
].MappedLevel
, gControllerInfo
[i
].MappedLevel
, gControllerInfo
[i
].InterruptMode
,
858 FALSE
, Affinity
, 0) != STATUS_SUCCESS
)
860 DPRINT("floppy: AddControllers: unable to connect interrupt\n");
865 memset(&DeviceDescription
, 0, sizeof(DeviceDescription
));
866 DeviceDescription
.Version
= DEVICE_DESCRIPTION_VERSION
;
867 DeviceDescription
.DmaChannel
= gControllerInfo
[i
].Dma
;
868 DeviceDescription
.InterfaceType
= gControllerInfo
[i
].InterfaceType
;
869 DeviceDescription
.BusNumber
= gControllerInfo
[i
].BusNumber
;
870 DeviceDescription
.MaximumLength
= 2*18*512; /* based on a 1.44MB floppy */
872 /* DMA 0,1,2,3 are 8-bit; 4,5,6,7 are 16-bit (4 is chain i think) */
873 DeviceDescription
.DmaWidth
= gControllerInfo
[i
].Dma
> 3 ? Width16Bits
: Width8Bits
;
875 gControllerInfo
[i
].AdapterObject
= HalGetAdapter(&DeviceDescription
, &gControllerInfo
[i
].MapRegisters
);
877 if(!gControllerInfo
[i
].AdapterObject
)
879 DPRINT("floppy: AddControllers: unable to allocate an adapter object\n");
880 IoDisconnectInterrupt(gControllerInfo
[i
].InterruptObject
);
884 /* 2b: Initialize the new controller */
885 if(InitController(&gControllerInfo
[i
]) != STATUS_SUCCESS
)
887 DPRINT("floppy: AddControllers():Unable to set up controller %d - initialization failed\n", i
);
888 IoDisconnectInterrupt(gControllerInfo
[i
].InterruptObject
);
892 /* 2c: Set the controller's initlized flag so we know to release stuff in Unload */
893 gControllerInfo
[i
].Initialized
= TRUE
;
895 /* 3: per-drive setup */
896 for(j
= 0; j
< gControllerInfo
[i
].NumberOfDrives
; j
++)
898 WCHAR DeviceNameBuf
[MAX_DEVICE_NAME
];
899 UNICODE_STRING DeviceName
;
900 UNICODE_STRING LinkName
;
901 UNICODE_STRING ArcPath
;
904 DPRINT("floppy: AddControllers(): Configuring drive %d on controller %d\n", i
, j
);
907 * 3a: create a device object for the drive
908 * Controllers and drives are 0-based, so the combos are:
919 DriveNumber
= (UCHAR
)(i
*4 + j
); /* loss of precision is OK; there are only 16 of 'em */
921 swprintf(DeviceNameBuf
, L
"\\Device\\Floppy%d", DriveNumber
);
922 RtlInitUnicodeString(&DeviceName
, DeviceNameBuf
);
924 if(IoCreateDevice(DriverObject
, sizeof(PVOID
), &DeviceName
,
925 FILE_DEVICE_DISK
, FILE_REMOVABLE_MEDIA
| FILE_FLOPPY_DISKETTE
, FALSE
,
926 &gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
) != STATUS_SUCCESS
)
928 DPRINT("floppy: AddControllers: unable to register a Device object\n");
929 IoDisconnectInterrupt(gControllerInfo
[i
].InterruptObject
);
930 continue; /* continue on to next drive */
933 DPRINT("floppy: AddControllers: New device: %S (0x%x)\n", DeviceNameBuf
, gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
);
935 /* 3b.5: Create an ARC path in case we're booting from this drive */
936 swprintf(gControllerInfo
[i
].DriveInfo
[j
].ArcPathBuffer
,
937 L
"\\ArcName\\multi(%d)disk(%d)fdisk(%d)", gControllerInfo
[i
].BusNumber
, i
, DriveNumber
);
939 RtlInitUnicodeString(&ArcPath
, gControllerInfo
[i
].DriveInfo
[j
].ArcPathBuffer
);
940 IoAssignArcName(&ArcPath
, &DeviceName
);
942 /* 3c: Set flags up */
943 gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
->Flags
|= DO_DIRECT_IO
;
945 /* 3d: Create a symlink */
946 swprintf(gControllerInfo
[i
].DriveInfo
[j
].SymLinkBuffer
, L
"\\DosDevices\\%c:", DriveNumber
+ 'A');
947 RtlInitUnicodeString(&LinkName
, gControllerInfo
[i
].DriveInfo
[j
].SymLinkBuffer
);
948 if(IoCreateSymbolicLink(&LinkName
, &DeviceName
) != STATUS_SUCCESS
)
950 DPRINT("floppy: AddControllers: Unable to create a symlink for drive %d\n", DriveNumber
);
951 IoDisconnectInterrupt(gControllerInfo
[i
].InterruptObject
);
952 IoDeassignArcName(&ArcPath
);
953 continue; /* continue to next drive */
956 /* 3e: Set up the DPC */
957 IoInitializeDpcRequest(gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
, DpcForIsr
);
959 /* 3f: Point the device extension at our DriveInfo struct */
960 gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
->DeviceExtension
= &gControllerInfo
[i
].DriveInfo
[j
];
962 /* 3g: neat comic strip */
964 /* 3h: set the initial media type to unknown */
965 memset(&gControllerInfo
[i
].DriveInfo
[j
].DiskGeometry
, 0, sizeof(DISK_GEOMETRY
));
966 gControllerInfo
[i
].DriveInfo
[j
].DiskGeometry
.MediaType
= Unknown
;
968 /* 3i: Now that we're done, set the Initialized flag so we know to free this in Unload */
969 gControllerInfo
[i
].DriveInfo
[j
].Initialized
= TRUE
;
973 DPRINT("floppy: AddControllers: --------------------------------------------> finished adding controllers\n");
979 VOID NTAPI
SignalMediaChanged(PDEVICE_OBJECT DeviceObject
,
982 * FUNCTION: Process an IRP when the media has changed, and possibly notify the user
984 * DeviceObject: DeviceObject associated with the IRP
985 * Irp: IRP that we're failing due to change
987 * - This procedure is documented in the DDK by "Notifying the File System of Possible Media Changes",
988 * "IoSetHardErrorOrVerifyDevice", and by "Responding to Check-Verify Requests from the File System".
989 * - Callable at <= DISPATCH_LEVEL
992 PDRIVE_INFO DriveInfo
= DeviceObject
->DeviceExtension
;
994 DPRINT("floppy: SignalMediaChanged called\n");
996 DriveInfo
->DiskChangeCount
++;
998 /* If volume is not mounted, do NOT set verify and return STATUS_IO_DEVICE_ERROR */
999 if(!(DeviceObject
->Vpb
->Flags
& VPB_MOUNTED
))
1001 Irp
->IoStatus
.Status
= STATUS_IO_DEVICE_ERROR
;
1002 Irp
->IoStatus
.Information
= 0;
1006 /* Notify the filesystem that it will need to verify the volume */
1007 DeviceObject
->Flags
|= DO_VERIFY_VOLUME
;
1008 Irp
->IoStatus
.Status
= STATUS_VERIFY_REQUIRED
;
1009 Irp
->IoStatus
.Information
= 0;
1012 * If this is a user-based, threaded request, let the IO manager know to pop up a box asking
1013 * the user to supply the correct media, but only if the error (which we just picked out above)
1014 * is deemed by the IO manager to be "user induced". The reason we don't just unconditionally
1015 * call IoSetHardError... is because MS might change the definition of "user induced" some day,
1016 * and we don't want to have to remember to re-code this.
1018 if(Irp
->Tail
.Overlay
.Thread
&& IoIsErrorUserInduced(Irp
->IoStatus
.Status
))
1019 IoSetHardErrorOrVerifyDevice(Irp
, DeviceObject
);
1023 static VOID NTAPI
QueueThread(PVOID Context
)
1025 * FUNCTION: Thread that manages the queue and dispatches any queued requests
1031 PIO_STACK_LOCATION Stack
;
1032 PDEVICE_OBJECT DeviceObject
;
1036 UNREFERENCED_PARAMETER(Context
);
1038 Objects
[0] = &QueueSemaphore
;
1039 Objects
[1] = &QueueThreadTerminate
;
1043 KeWaitForMultipleObjects(2, Objects
, WaitAny
, Executive
, KernelMode
, FALSE
, NULL
, NULL
);
1045 if(KeReadStateEvent(&QueueThreadTerminate
))
1047 DPRINT("floppy: QueueThread terminating\n");
1051 DPRINT("floppy: QueueThread: servicing an IRP\n");
1053 Irp
= IoCsqRemoveNextIrp(&Csq
, 0);
1055 /* we won't get an irp if it was canceled */
1058 DPRINT("floppy: QueueThread: IRP queue empty\n");
1062 DeviceObject
= (PDEVICE_OBJECT
)Irp
->Tail
.Overlay
.DriverContext
[0];
1064 ASSERT(DeviceObject
);
1066 Stack
= IoGetCurrentIrpStackLocation(Irp
);
1068 /* Decide what to do with the IRP */
1069 switch(Stack
->MajorFunction
)
1073 ReadWritePassive(DeviceObject
->DeviceExtension
, Irp
);
1076 case IRP_MJ_DEVICE_CONTROL
:
1077 DeviceIoctlPassive(DeviceObject
->DeviceExtension
, Irp
);
1081 DPRINT("floppy: QueueThread(): Unrecognized irp: mj: 0x%x\n", Stack
->MajorFunction
);
1082 Irp
->IoStatus
.Status
= STATUS_NOT_SUPPORTED
;
1083 Irp
->IoStatus
.Information
= 0;
1084 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
1090 NTSTATUS NTAPI
DriverEntry(PDRIVER_OBJECT DriverObject
,
1091 PUNICODE_STRING RegistryPath
)
1093 * FUNCTION: Entry-point for the driver
1095 * DriverObject: Our driver object
1096 * RegistryPath: Unused
1098 * STATUS_SUCCESS on successful initialization of at least one drive
1099 * STATUS_NO_SUCH_DEVICE if we didn't find even one drive
1100 * STATUS_UNSUCCESSFUL otherwise
1103 HANDLE ThreadHandle
;
1105 UNREFERENCED_PARAMETER(RegistryPath
);
1108 * Set up dispatch routines
1110 DriverObject
->MajorFunction
[IRP_MJ_CREATE
] = (PDRIVER_DISPATCH
)CreateClose
;
1111 DriverObject
->MajorFunction
[IRP_MJ_CLOSE
] = (PDRIVER_DISPATCH
)CreateClose
;
1112 DriverObject
->MajorFunction
[IRP_MJ_READ
] = (PDRIVER_DISPATCH
)ReadWrite
;
1113 DriverObject
->MajorFunction
[IRP_MJ_WRITE
] = (PDRIVER_DISPATCH
)ReadWrite
;
1114 DriverObject
->MajorFunction
[IRP_MJ_DEVICE_CONTROL
] = (PDRIVER_DISPATCH
)DeviceIoctl
;
1116 DriverObject
->DriverUnload
= Unload
;
1119 * We depend on some zeroes in these structures. I know this is supposed to be
1120 * initialized to 0 by the complier but this makes me feel beter.
1122 memset(&gControllerInfo
, 0, sizeof(gControllerInfo
));
1125 * Set up queue. This routine cannot fail (trust me, I wrote it).
1127 IoCsqInitialize(&Csq
, CsqInsertIrp
, CsqRemoveIrp
, CsqPeekNextIrp
,
1128 CsqAcquireLock
, CsqReleaseLock
, CsqCompleteCanceledIrp
);
1133 KeInitializeSpinLock(&IrpQueueLock
);
1136 * ...and the queue list itself
1138 InitializeListHead(&IrpQueue
);
1141 * The queue is counted by a semaphore. The queue management thread
1142 * blocks on this semaphore, so if requests come in faster than the queue
1143 * thread can handle them, the semaphore count goes up.
1145 KeInitializeSemaphore(&QueueSemaphore
, 0, 0x7fffffff);
1148 * Event to terminate that thread
1150 KeInitializeEvent(&QueueThreadTerminate
, NotificationEvent
, FALSE
);
1153 * Create the queue processing thread. Save its handle in the global variable
1154 * ThreadHandle so we can wait on its termination during Unload.
1156 if(PsCreateSystemThread(&ThreadHandle
, 0, 0, 0, 0, QueueThread
, 0) != STATUS_SUCCESS
)
1158 DPRINT("floppy: Unable to create system thread; failing init\n");
1159 return STATUS_INSUFFICIENT_RESOURCES
;
1162 if(ObReferenceObjectByHandle(ThreadHandle
, STANDARD_RIGHTS_ALL
, NULL
, KernelMode
, &QueueThreadObject
, NULL
) != STATUS_SUCCESS
)
1164 DPRINT("floppy: Unable to reference returned thread handle; failing init\n");
1165 return STATUS_UNSUCCESSFUL
;
1169 * Close the handle, now that we have the object pointer and a reference of our own.
1170 * The handle will certainly not be valid in the context of the caller next time we
1171 * need it, as handles are process-specific.
1173 ZwClose(ThreadHandle
);
1176 * Start the device discovery proces. Returns STATUS_SUCCESS if
1177 * it finds even one drive attached to one controller.
1179 if(!AddControllers(DriverObject
))
1180 return STATUS_NO_SUCH_DEVICE
;
1182 return STATUS_SUCCESS
;