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
49 #include "readwrite.h"
52 * Global controller info structures. Each controller gets one. Since the system
53 * will probably have only one, with four being a very unlikely maximum, a static
54 * global array is easiest to deal with.
56 static CONTROLLER_INFO gControllerInfo
[MAX_CONTROLLERS
];
57 static ULONG gNumberOfControllers
= 0;
59 /* Queue thread management */
60 static KEVENT QueueThreadTerminate
;
61 static PVOID QueueThreadObject
;
64 static VOID NTAPI
MotorStopDpcFunc(PKDPC UnusedDpc
,
65 PVOID DeferredContext
,
66 PVOID SystemArgument1
,
67 PVOID SystemArgument2
)
69 * FUNCTION: Stop the floppy motor
71 * UnusedDpc: DPC object that's going off
72 * DeferredContext: called with DRIVE_INFO for drive to turn off
73 * SystemArgument1: unused
74 * SystemArgument2: unused
76 * - Must set an event to let other threads know we're done turning off the motor
77 * - Called back at DISPATCH_LEVEL
80 PCONTROLLER_INFO ControllerInfo
= (PCONTROLLER_INFO
)DeferredContext
;
82 UNREFERENCED_PARAMETER(SystemArgument1
);
83 UNREFERENCED_PARAMETER(SystemArgument2
);
84 UNREFERENCED_PARAMETER(UnusedDpc
);
86 ASSERT(KeGetCurrentIrql() == DISPATCH_LEVEL
);
87 ASSERT(ControllerInfo
);
89 KdPrint(("floppy: MotorStopDpcFunc called\n"));
91 HwTurnOffMotor(ControllerInfo
);
92 ControllerInfo
->StopDpcQueued
= FALSE
;
93 KeSetEvent(&ControllerInfo
->MotorStoppedEvent
, EVENT_INCREMENT
, FALSE
);
97 VOID NTAPI
StartMotor(PDRIVE_INFO DriveInfo
)
99 * FUNCTION: Start the motor, taking into account proper handling of the timer race
101 * DriveInfo: drive to start
103 * - Never call HwTurnOnMotor() directly
104 * - This protocol manages a race between the cancel timer and the requesting thread.
105 * You wouldn't want to turn on the motor and then cancel the timer, because the
106 * cancel dpc might fire in the meantime, and that'd un-do what you just did. If you
107 * cancel the timer first, but KeCancelTimer returns false, the dpc is already running,
108 * so you have to wait until the dpc is completly done running, or else you'll race
109 * with the turner-offer
110 * - PAGED_CODE because we wait
116 KdPrint(("floppy: StartMotor called\n"));
118 if(DriveInfo
->ControllerInfo
->StopDpcQueued
&& !KeCancelTimer(&DriveInfo
->ControllerInfo
->MotorTimer
))
120 /* Motor turner-offer is already running; wait for it to finish */
121 KdPrint(("floppy: StartMotor: motor turner-offer is already running; waiting for it\n"));
122 KeWaitForSingleObject(&DriveInfo
->ControllerInfo
->MotorStoppedEvent
, Executive
, KernelMode
, FALSE
, NULL
);
123 KdPrint(("floppy: StartMotor: wait satisfied\n"));
126 DriveInfo
->ControllerInfo
->StopDpcQueued
= FALSE
;
128 if(HwTurnOnMotor(DriveInfo
) != STATUS_SUCCESS
)
129 KdPrint(("floppy: StartMotor(): warning: HwTurnOnMotor failed\n"));
133 VOID NTAPI
StopMotor(PCONTROLLER_INFO ControllerInfo
)
135 * FUNCTION: Stop all motors on the controller
137 * DriveInfo: Drive to stop
139 * - Never call HwTurnOffMotor() directly
140 * - This manages the timer cancelation race (see StartMotor for details).
141 * All we have to do is set up a timer.
144 LARGE_INTEGER StopTime
;
146 ASSERT(ControllerInfo
);
148 KdPrint(("floppy: StopMotor called\n"));
150 /* one relative second, in 100-ns units */
151 StopTime
.QuadPart
= 10000000;
152 StopTime
.QuadPart
*= -1;
154 KeClearEvent(&ControllerInfo
->MotorStoppedEvent
);
155 KeSetTimer(&ControllerInfo
->MotorTimer
, StopTime
, &ControllerInfo
->MotorStopDpc
);
156 ControllerInfo
->StopDpcQueued
= TRUE
;
160 VOID NTAPI
WaitForControllerInterrupt(PCONTROLLER_INFO ControllerInfo
)
162 * FUNCTION: Wait for the controller to interrupt, and then clear the event
164 * ControllerInfo: Controller to wait for
166 * - There is a small chance that an unexpected or spurious interrupt could
167 * be lost with this clear/wait/clear scheme used in this driver. This is
168 * deemed to be an acceptable risk due to the unlikeliness of the scenario,
169 * and the fact that it'll probably work fine next time.
170 * - PAGED_CODE because it waits
174 ASSERT(ControllerInfo
);
176 KeWaitForSingleObject(&ControllerInfo
->SynchEvent
, Executive
, KernelMode
, FALSE
, NULL
);
177 KeClearEvent(&ControllerInfo
->SynchEvent
);
181 static NTSTATUS NTAPI
CreateClose(PDEVICE_OBJECT DeviceObject
,
184 * FUNCTION: Dispatch function called for Create and Close IRPs
186 * DeviceObject: DeviceObject that is the target of the IRP
187 * Irp: IRP to process
189 * STATUS_SUCCESS in all cases
191 * - The Microsoft sample drivers tend to return FILE_OPENED in Information, so I do too.
192 * - No reason to fail the device open
193 * - No state to track, so this routine is easy
194 * - Can be called <= DISPATCH_LEVEL
196 * TODO: Figure out why this isn't getting called
199 UNREFERENCED_PARAMETER(DeviceObject
);
201 KdPrint(("floppy: CreateClose called\n"));
203 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
204 Irp
->IoStatus
.Information
= FILE_OPENED
;
206 IoCompleteRequest(Irp
, IO_DISK_INCREMENT
);
208 return STATUS_SUCCESS
;
212 static NTSTATUS NTAPI
Recalibrate(PDRIVE_INFO DriveInfo
)
214 * FUNCTION: Start the recalibration process
216 * DriveInfo: Pointer to the driveinfo struct associated with the targeted drive
218 * STATUS_SUCCESS on successful starting of the process
219 * STATUS_IO_DEVICE_ERROR if it fails
221 * - Sometimes you have to do two recalibrations, particularly if the disk has <80 tracks.
222 * - PAGED_CODE because we wait
231 /* first turn on the motor */
232 /* Must stop after every start, prior to return */
233 StartMotor(DriveInfo
);
235 /* set the data rate */
236 KdPrint(("floppy: FIXME: UN-HARDCODE DATA RATE\n"));
237 if(HwSetDataRate(DriveInfo
->ControllerInfo
, 0) != STATUS_SUCCESS
)
239 KdPrint(("floppy: Recalibrate: HwSetDataRate failed\n"));
240 StopMotor(DriveInfo
->ControllerInfo
);
241 return STATUS_IO_DEVICE_ERROR
;
244 /* clear the event just in case the last call forgot */
245 KeClearEvent(&DriveInfo
->ControllerInfo
->SynchEvent
);
247 /* sometimes you have to do this twice; we'll just do it twice all the time since
248 * we don't know if the people calling this Recalibrate routine expect a disk to
249 * even be in the drive, and if so, if that disk is formatted.
251 for(i
= 0; i
< 2; i
++)
253 /* Send the command */
254 Status
= HwRecalibrate(DriveInfo
);
255 if(Status
!= STATUS_SUCCESS
)
257 KdPrint(("floppy: Recalibrate: HwRecalibrate returned error\n"));
261 WaitForControllerInterrupt(DriveInfo
->ControllerInfo
);
263 /* Get the results */
264 Status
= HwRecalibrateResult(DriveInfo
->ControllerInfo
);
265 if(Status
!= STATUS_SUCCESS
)
267 KdPrint(("floppy: Recalibrate: HwRecalibrateResult returned error\n"));
272 KeClearEvent(&DriveInfo
->ControllerInfo
->SynchEvent
);
274 /* Must stop after every start, prior to return */
275 StopMotor(DriveInfo
->ControllerInfo
);
281 NTSTATUS NTAPI
ResetChangeFlag(PDRIVE_INFO DriveInfo
)
283 * FUNCTION: Reset the drive's change flag (as reflected in the DIR)
285 * DriveInfo: the drive to reset
287 * STATUS_SUCCESS if the changeline is cleared
288 * STATUS_NO_MEDIA_IN_DEVICE if the changeline cannot be cleared
289 * STATUS_IO_DEVICE_ERROR if the controller cannot be communicated with
291 * - Change reset procedure: recalibrate, seek 1, seek 0
292 * - If the line is still set after that, there's clearly no disk in the
293 * drive, so we return STATUS_NO_MEDIA_IN_DEVICE
294 * - PAGED_CODE because we wait
302 KdPrint(("floppy: ResetChangeFlag called\n"));
304 /* Try to recalibrate. We don't care if it works. */
305 Recalibrate(DriveInfo
);
307 /* clear spurious interrupts in prep for seeks */
308 KeClearEvent(&DriveInfo
->ControllerInfo
->SynchEvent
);
310 /* must re-start the drive because Recalibrate() stops it */
311 StartMotor(DriveInfo
);
314 if(HwSeek(DriveInfo
, 1) != STATUS_SUCCESS
)
316 KdPrint(("floppy: ResetChangeFlag(): HwSeek failed; returning STATUS_IO_DEVICE_ERROR\n"));
317 StopMotor(DriveInfo
->ControllerInfo
);
318 return STATUS_IO_DEVICE_ERROR
;
321 WaitForControllerInterrupt(DriveInfo
->ControllerInfo
);
323 if(HwSenseInterruptStatus(DriveInfo
->ControllerInfo
) != STATUS_SUCCESS
)
325 KdPrint(("floppy: ResetChangeFlag(): HwSenseInterruptStatus failed; bailing out\n"));
326 StopMotor(DriveInfo
->ControllerInfo
);
327 return STATUS_IO_DEVICE_ERROR
;
331 if(HwSeek(DriveInfo
, 0) != STATUS_SUCCESS
)
333 KdPrint(("floppy: ResetChangeFlag(): HwSeek failed; returning STATUS_IO_DEVICE_ERROR\n"));
334 StopMotor(DriveInfo
->ControllerInfo
);
335 return STATUS_IO_DEVICE_ERROR
;
338 WaitForControllerInterrupt(DriveInfo
->ControllerInfo
);
340 if(HwSenseInterruptStatus(DriveInfo
->ControllerInfo
) != STATUS_SUCCESS
)
342 KdPrint(("floppy: ResetChangeFlag(): HwSenseInterruptStatus #2 failed; bailing\n"));
343 StopMotor(DriveInfo
->ControllerInfo
);
344 return STATUS_IO_DEVICE_ERROR
;
347 /* Check the change bit */
348 if(HwDiskChanged(DriveInfo
, &DiskChanged
) != STATUS_SUCCESS
)
350 KdPrint(("floppy: ResetChangeFlag(): HwDiskChagned failed; returning STATUS_IO_DEVICE_ERROR\n"));
351 StopMotor(DriveInfo
->ControllerInfo
);
352 return STATUS_IO_DEVICE_ERROR
;
355 StopMotor(DriveInfo
->ControllerInfo
);
357 /* if the change flag is still set, there's probably no media in the drive. */
359 return STATUS_NO_MEDIA_IN_DEVICE
;
361 /* else we're done! */
362 return STATUS_SUCCESS
;
366 static VOID NTAPI
Unload(PDRIVER_OBJECT DriverObject
)
368 * FUNCTION: Unload the driver from memory
370 * DriverObject - The driver that is being unloaded
376 UNREFERENCED_PARAMETER(DriverObject
);
378 KdPrint(("floppy: unloading\n"));
380 KeSetEvent(&QueueThreadTerminate
, 0, FALSE
);
381 KeWaitForSingleObject(QueueThreadObject
, Executive
, KernelMode
, FALSE
, 0);
382 ObDereferenceObject(QueueThreadObject
);
384 for(i
= 0; i
< gNumberOfControllers
; i
++)
386 if(!gControllerInfo
[i
].Initialized
)
389 for(j
= 0; j
< gControllerInfo
[i
].NumberOfDrives
; j
++)
391 if(!gControllerInfo
[i
].DriveInfo
[j
].Initialized
)
394 if(gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
)
398 RtlInitUnicodeString(&Link
, gControllerInfo
[i
].DriveInfo
[j
].SymLinkBuffer
);
399 IoDeleteSymbolicLink(&Link
);
401 RtlInitUnicodeString(&Link
, gControllerInfo
[i
].DriveInfo
[j
].ArcPathBuffer
);
402 IoDeassignArcName(&Link
);
404 IoDeleteDevice(gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
);
408 IoDisconnectInterrupt(gControllerInfo
[i
].InterruptObject
);
410 /* Power down the controller */
411 if(HwPowerOff(&gControllerInfo
[i
]) != STATUS_SUCCESS
)
412 KdPrint(("floppy: unload: warning: HwPowerOff failed\n"));
417 static NTSTATUS NTAPI
ConfigCallback(PVOID Context
,
418 PUNICODE_STRING PathName
,
419 INTERFACE_TYPE BusType
,
421 PKEY_VALUE_FULL_INFORMATION
*BusInformation
,
422 CONFIGURATION_TYPE ControllerType
,
423 ULONG ControllerNumber
,
424 PKEY_VALUE_FULL_INFORMATION
*ControllerInformation
,
425 CONFIGURATION_TYPE PeripheralType
,
426 ULONG PeripheralNumber
,
427 PKEY_VALUE_FULL_INFORMATION
*PeripheralInformation
)
429 * FUNCTION: Callback to IoQueryDeviceDescription, which tells us about our controllers
433 * BusType: Type of the bus that our controller is on
434 * BusNumber: Number of the bus that our controller is on
435 * BusInformation: Unused
436 * ControllerType: Unused
437 * ControllerNumber: Number of the controller that we're adding
438 * ControllerInformation: Full configuration information for our controller
439 * PeripheralType: Unused
440 * PeripheralNumber: Unused
441 * PeripheralInformation: Full configuration information for each drive on our controller
443 * STATUS_SUCCESS in all cases
445 * - The only documentation I've found about the contents of these structures is
446 * from the various Microsoft floppy samples and from the DDK headers. They're
447 * very vague, though, so I'm only mostly sure that this stuff is correct, as
448 * the MS samples do things completely differently than I have done them. Seems
449 * to work in my VMWare, though.
450 * - Basically, the function gets all of the information (port, dma, irq) about the
451 * controller, and then loops through all of the drives presented in PeripheralInformation.
452 * - Each controller has a CONTROLLER_INFO created for it, and each drive has a DRIVE_INFO.
453 * - Device objects are created for each drive (not controller), as that's the targeted
454 * device in the eyes of the rest of the OS. Each DRIVE_INFO points to a single CONTROLLER_INFO.
455 * - We only support up to four controllers in the whole system, each of which supports up to four
459 PKEY_VALUE_FULL_INFORMATION ControllerFullDescriptor
= ControllerInformation
[IoQueryDeviceConfigurationData
];
460 PCM_FULL_RESOURCE_DESCRIPTOR ControllerResourceDescriptor
= (PCM_FULL_RESOURCE_DESCRIPTOR
)((PCHAR
)ControllerFullDescriptor
+
461 ControllerFullDescriptor
->DataOffset
);
463 PKEY_VALUE_FULL_INFORMATION PeripheralFullDescriptor
= PeripheralInformation
[IoQueryDeviceConfigurationData
];
464 PCM_FULL_RESOURCE_DESCRIPTOR PeripheralResourceDescriptor
= (PCM_FULL_RESOURCE_DESCRIPTOR
)((PCHAR
)PeripheralFullDescriptor
+
465 PeripheralFullDescriptor
->DataOffset
);
467 PCM_PARTIAL_RESOURCE_DESCRIPTOR PartialDescriptor
;
468 PCM_FLOPPY_DEVICE_DATA FloppyDeviceData
;
472 UNREFERENCED_PARAMETER(PeripheralType
);
473 UNREFERENCED_PARAMETER(PeripheralNumber
);
474 UNREFERENCED_PARAMETER(BusInformation
);
475 UNREFERENCED_PARAMETER(Context
);
476 UNREFERENCED_PARAMETER(ControllerType
);
477 UNREFERENCED_PARAMETER(PathName
);
480 KdPrint(("floppy: ConfigCallback called with ControllerNumber %d\n", ControllerNumber
));
482 gControllerInfo
[gNumberOfControllers
].ControllerNumber
= ControllerNumber
;
483 gControllerInfo
[gNumberOfControllers
].InterfaceType
= BusType
;
484 gControllerInfo
[gNumberOfControllers
].BusNumber
= BusNumber
;
486 /* Get controller interrupt level/vector, dma channel, and port base */
487 for(i
= 0; i
< ControllerResourceDescriptor
->PartialResourceList
.Count
; i
++)
489 KeInitializeEvent(&gControllerInfo
[gNumberOfControllers
].SynchEvent
, NotificationEvent
, FALSE
);
491 PartialDescriptor
= &ControllerResourceDescriptor
->PartialResourceList
.PartialDescriptors
[i
];
493 if(PartialDescriptor
->Type
== CmResourceTypeInterrupt
)
495 gControllerInfo
[gNumberOfControllers
].Level
= PartialDescriptor
->u
.Interrupt
.Level
;
496 gControllerInfo
[gNumberOfControllers
].Vector
= PartialDescriptor
->u
.Interrupt
.Vector
;
498 if(PartialDescriptor
->Flags
& CM_RESOURCE_INTERRUPT_LATCHED
)
499 gControllerInfo
[gNumberOfControllers
].InterruptMode
= Latched
;
501 gControllerInfo
[gNumberOfControllers
].InterruptMode
= LevelSensitive
;
504 else if(PartialDescriptor
->Type
== CmResourceTypePort
)
506 PHYSICAL_ADDRESS TranslatedAddress
;
507 ULONG AddressSpace
= 0x1; /* I/O Port Range */
509 if(!HalTranslateBusAddress(BusType
, BusNumber
, PartialDescriptor
->u
.Port
.Start
, &AddressSpace
, &TranslatedAddress
))
511 KdPrint(("floppy: HalTranslateBusAddress failed; returning\n"));
512 return STATUS_IO_DEVICE_ERROR
;
515 if(AddressSpace
== 0)
516 gControllerInfo
[gNumberOfControllers
].BaseAddress
= MmMapIoSpace(TranslatedAddress
, FDC_PORT_BYTES
, MmNonCached
);
518 gControllerInfo
[gNumberOfControllers
].BaseAddress
= (PUCHAR
)TranslatedAddress
.u
.LowPart
;
521 else if(PartialDescriptor
->Type
== CmResourceTypeDma
)
522 gControllerInfo
[gNumberOfControllers
].Dma
= PartialDescriptor
->u
.Dma
.Channel
;
525 /* Start with 0 drives, then go looking */
526 gControllerInfo
[gNumberOfControllers
].NumberOfDrives
= 0;
528 /* learn about drives attached to controller */
529 for(i
= 0; i
< PeripheralResourceDescriptor
->PartialResourceList
.Count
; i
++)
531 PDRIVE_INFO DriveInfo
= &gControllerInfo
[gNumberOfControllers
].DriveInfo
[i
];
533 PartialDescriptor
= &PeripheralResourceDescriptor
->PartialResourceList
.PartialDescriptors
[i
];
535 if(PartialDescriptor
->Type
!= CmResourceTypeDeviceSpecific
)
538 FloppyDeviceData
= (PCM_FLOPPY_DEVICE_DATA
)(PartialDescriptor
+ 1);
540 DriveInfo
->ControllerInfo
= &gControllerInfo
[gNumberOfControllers
];
541 DriveInfo
->UnitNumber
= i
;
543 DriveInfo
->FloppyDeviceData
.MaxDensity
= FloppyDeviceData
->MaxDensity
;
544 DriveInfo
->FloppyDeviceData
.MountDensity
= FloppyDeviceData
->MountDensity
;
545 DriveInfo
->FloppyDeviceData
.StepRateHeadUnloadTime
= FloppyDeviceData
->StepRateHeadUnloadTime
;
546 DriveInfo
->FloppyDeviceData
.HeadLoadTime
= FloppyDeviceData
->HeadLoadTime
;
547 DriveInfo
->FloppyDeviceData
.MotorOffTime
= FloppyDeviceData
->MotorOffTime
;
548 DriveInfo
->FloppyDeviceData
.SectorLengthCode
= FloppyDeviceData
->SectorLengthCode
;
549 DriveInfo
->FloppyDeviceData
.SectorPerTrack
= FloppyDeviceData
->SectorPerTrack
;
550 DriveInfo
->FloppyDeviceData
.ReadWriteGapLength
= FloppyDeviceData
->ReadWriteGapLength
;
551 DriveInfo
->FloppyDeviceData
.FormatGapLength
= FloppyDeviceData
->FormatGapLength
;
552 DriveInfo
->FloppyDeviceData
.FormatFillCharacter
= FloppyDeviceData
->FormatFillCharacter
;
553 DriveInfo
->FloppyDeviceData
.HeadSettleTime
= FloppyDeviceData
->HeadSettleTime
;
554 DriveInfo
->FloppyDeviceData
.MotorSettleTime
= FloppyDeviceData
->MotorSettleTime
;
555 DriveInfo
->FloppyDeviceData
.MaximumTrackValue
= FloppyDeviceData
->MaximumTrackValue
;
556 DriveInfo
->FloppyDeviceData
.DataTransferLength
= FloppyDeviceData
->DataTransferLength
;
558 /* Once it's all set up, acknowledge its existance in the controller info object */
559 gControllerInfo
[gNumberOfControllers
].NumberOfDrives
++;
562 gControllerInfo
[gNumberOfControllers
].Populated
= TRUE
;
563 gNumberOfControllers
++;
565 return STATUS_SUCCESS
;
569 static BOOLEAN NTAPI
Isr(PKINTERRUPT Interrupt
,
570 PVOID ServiceContext
)
572 * FUNCTION: Interrupt service routine for the controllers
574 * Interrupt: Interrupt object representing the interrupt that occured
575 * ServiceContext: Pointer to the ControllerInfo object that caused the interrupt
577 * TRUE in all cases (see notes)
579 * - We should always be the target of the interrupt, being an edge-triggered ISA interrupt, but
580 * this won't be the case with a level-sensitive system like PCI
581 * - Note that it probably doesn't matter if the interrupt isn't dismissed, as it's edge-triggered.
582 * It probably won't keep re-interrupting.
583 * - There are two different ways to dismiss a floppy interrupt. If the command has a result phase
584 * (see intel datasheet), you dismiss the interrupt by reading the first data byte. If it does
585 * not, you dismiss the interrupt by doing a Sense Interrupt command. Again, because it's edge-
586 * triggered, this is safe to not do here, as we can just wait for the DPC.
587 * - Either way, we don't want to do this here. The controller shouldn't interrupt again, so we'll
588 * schedule a DPC to take care of it.
589 * - This driver really cannot shrare interrupts, as I don't know how to conclusively say
590 * whether it was our controller that interrupted or not. I just have to assume that any time
591 * my ISR gets called, it was my board that called it. Dumb design, yes, but it goes back to
592 * the semantics of ISA buses. That, and I don't know much about ISA drivers. :-)
593 * UPDATE: The high bit of Status Register A seems to work on non-AT controllers.
597 PCONTROLLER_INFO ControllerInfo
= (PCONTROLLER_INFO
)ServiceContext
;
599 UNREFERENCED_PARAMETER(Interrupt
);
601 ASSERT(ControllerInfo
);
603 KdPrint(("floppy: ISR called\n"));
606 * Due to the stupidity of the drive/controller relationship on the floppy drive, only one device object
607 * can have an active interrupt pending. Due to the nature of these IRPs, though, there will only ever
608 * be one thread expecting an interrupt at a time, and furthermore, Interrupts (outside of spurious ones)
609 * won't ever happen unless a thread is expecting them. Therefore, all we have to do is signal an event
610 * and we're done. Queue a DPC and leave.
612 KeInsertQueueDpc(&ControllerInfo
->Dpc
, NULL
, NULL
);
618 VOID NTAPI
DpcForIsr(PKDPC UnusedDpc
,
620 PVOID SystemArgument1
,
621 PVOID SystemArgument2
)
623 * FUNCTION: This DPC gets queued by every ISR. Does the real per-interrupt work.
625 * UnusedDpc: Pointer to the DPC object that represents our function
626 * DeviceObject: Device that this DPC is running for
628 * Context: Pointer to our ControllerInfo struct
630 * - This function just kicks off whatever the SynchEvent is and returns. We depend on
631 * the thing that caused the drive to interrupt to handle the work of clearing the interrupt.
632 * This enables us to get back to PASSIVE_LEVEL and not hog system time on a really stupid,
633 * slow, screwed-up piece of hardare.
634 * - If nothing is waiting for us to set the event, the interrupt is effectively lost and will
635 * never be dismissed. I wonder if this will become a problem.
636 * - Called at DISPATCH_LEVEL
639 PCONTROLLER_INFO ControllerInfo
= (PCONTROLLER_INFO
)Context
;
641 UNREFERENCED_PARAMETER(UnusedDpc
);
642 UNREFERENCED_PARAMETER(SystemArgument1
);
643 UNREFERENCED_PARAMETER(SystemArgument2
);
645 ASSERT(ControllerInfo
);
647 KdPrint(("floppy: DpcForIsr called\n"));
649 KeSetEvent(&ControllerInfo
->SynchEvent
, EVENT_INCREMENT
, FALSE
);
653 static NTSTATUS NTAPI
InitController(PCONTROLLER_INFO ControllerInfo
)
655 * FUNCTION: Initialize a newly-found controller
657 * ControllerInfo: pointer to the controller to be initialized
659 * STATUS_SUCCESS if the controller is successfully initialized
660 * STATUS_IO_DEVICE_ERROR otherwise
665 UCHAR HeadUnloadTime
;
669 ASSERT(ControllerInfo
);
671 KdPrint(("floppy: InitController called with Controller 0x%x\n", ControllerInfo
));
673 KeClearEvent(&ControllerInfo
->SynchEvent
);
675 KdPrint(("floppy: InitController: resetting the controller\n"));
677 /* Reset the controller */
678 if(HwReset(ControllerInfo
) != STATUS_SUCCESS
)
680 KdPrint(("floppy: InitController: unable to reset controller\n"));
681 return STATUS_IO_DEVICE_ERROR
;
684 KdPrint(("floppy: InitController: setting data rate\n"));
687 if(HwSetDataRate(ControllerInfo
, DRSR_DSEL_500KBPS
) != STATUS_SUCCESS
)
689 KdPrint(("floppy: InitController: unable to set data rate\n"));
690 return STATUS_IO_DEVICE_ERROR
;
693 KdPrint(("floppy: InitController: waiting for initial interrupt\n"));
695 /* Wait for an interrupt */
696 WaitForControllerInterrupt(ControllerInfo
);
698 /* Reset means you have to clear each of the four interrupts (one per drive) */
699 for(i
= 0; i
< MAX_DRIVES_PER_CONTROLLER
; i
++)
701 KdPrint(("floppy: InitController: Sensing interrupt %d\n", i
));
703 if(HwSenseInterruptStatus(ControllerInfo
) != STATUS_SUCCESS
)
705 KdPrint(("floppy: InitController: Unable to clear interrupt 0x%x\n", i
));
706 return STATUS_IO_DEVICE_ERROR
;
710 KdPrint(("floppy: InitController: done sensing interrupts\n"));
712 /* Next, see if we have the right version to do implied seek */
713 if(HwGetVersion(ControllerInfo
) == VERSION_ENHANCED
)
715 /* If so, set that up -- all defaults below except first TRUE for EIS */
716 if(HwConfigure(ControllerInfo
, TRUE
, TRUE
, FALSE
, 0, 0) != STATUS_SUCCESS
)
718 KdPrint(("floppy: InitController: unable to set up implied seek\n"));
719 ControllerInfo
->ImpliedSeeks
= FALSE
;
723 KdPrint(("floppy: InitController: implied seeks set!\n"));
724 ControllerInfo
->ImpliedSeeks
= TRUE
;
728 * FIXME: Figure out the answer to the below
730 * I must admit that I'm really confused about the Model 30 issue. At least one
731 * important bit (the disk change bit in the DIR) is flipped if this is a Model 30
732 * controller. However, at least one other floppy driver believes that there are only
733 * two computers that are guaranteed to have a Model 30 controller:
737 * ...and another driver only lists a config option for "thinkpad", that flips
738 * the change line. A third driver doesn't mention the Model 30 issue at all.
740 * What I can't tell is whether or not the average, run-of-the-mill computer now has
741 * a Model 30 controller. For the time being, I'm going to wire this to FALSE,
742 * and just not support the computers mentioned above, while I try to figure out
743 * how ubiquitous these newfangled 30 thingies are.
745 //ControllerInfo->Model30 = TRUE;
746 ControllerInfo
->Model30
= FALSE
;
750 KdPrint(("floppy: InitController: enhanced version not supported; disabling implied seeks\n"));
751 ControllerInfo
->ImpliedSeeks
= FALSE
;
752 ControllerInfo
->Model30
= FALSE
;
756 KdPrint(("FLOPPY: FIXME: Figure out speed\n"));
757 HeadLoadTime
= SPECIFY_HLT_500K
;
758 HeadUnloadTime
= SPECIFY_HUT_500K
;
759 StepRateTime
= SPECIFY_SRT_500K
;
761 KdPrint(("floppy: InitController: issuing specify command to controller\n"));
763 /* Don't disable DMA --> enable dma (dumb & confusing) */
764 if(HwSpecify(ControllerInfo
, HeadLoadTime
, HeadUnloadTime
, StepRateTime
, FALSE
) != STATUS_SUCCESS
)
766 KdPrint(("floppy: InitController: unable to specify options\n"));
767 return STATUS_IO_DEVICE_ERROR
;
770 /* Init the stop stuff */
771 KeInitializeDpc(&ControllerInfo
->MotorStopDpc
, MotorStopDpcFunc
, ControllerInfo
);
772 KeInitializeTimer(&ControllerInfo
->MotorTimer
);
773 KeInitializeEvent(&ControllerInfo
->MotorStoppedEvent
, NotificationEvent
, FALSE
);
774 ControllerInfo
->StopDpcQueued
= FALSE
;
777 * Recalibrate each drive on the controller (depends on StartMotor, which depends on the timer stuff above)
778 * We don't even know if there is a disk in the drive, so this may not work, but that's OK.
780 for(i
= 0; i
< ControllerInfo
->NumberOfDrives
; i
++)
782 KdPrint(("floppy: InitController: recalibrating drive 0x%x on controller 0x%x\n", i
, ControllerInfo
));
783 Recalibrate(&ControllerInfo
->DriveInfo
[i
]);
786 KdPrint(("floppy: InitController: done initializing; returning STATUS_SUCCESS\n"));
788 return STATUS_SUCCESS
;
792 static BOOLEAN NTAPI
AddControllers(PDRIVER_OBJECT DriverObject
)
794 * FUNCTION: Called on initialization to find our controllers and build device and controller objects for them
796 * DriverObject: Our driver's DriverObject (so we can create devices against it)
798 * FALSE if we can't allocate a device, adapter, or interrupt object, or if we fail to find any controllers
799 * TRUE otherwise (i.e. we have at least one fully-configured controller)
801 * - Currently we only support ISA buses.
802 * - BUG: Windows 2000 seems to clobber the response from the IoQueryDeviceDescription callback, so now we
803 * just test a boolean value in the first object to see if it was completely populated. The same value
804 * is tested for each controller before we build device objects for it.
806 * - Report resource usage to the HAL
809 INTERFACE_TYPE InterfaceType
= Isa
;
810 CONFIGURATION_TYPE ControllerType
= DiskController
;
811 CONFIGURATION_TYPE PeripheralType
= FloppyDiskPeripheral
;
813 DEVICE_DESCRIPTION DeviceDescription
;
819 /* Find our controllers on all ISA buses */
820 IoQueryDeviceDescription(&InterfaceType
, 0, &ControllerType
, 0, &PeripheralType
, 0, ConfigCallback
, 0);
823 * w2k breaks the return val from ConfigCallback, so we have to hack around it, rather than just
824 * looking for a return value from ConfigCallback. We expect at least one controller.
826 if(!gControllerInfo
[0].Populated
)
828 KdPrint(("floppy: AddControllers: failed to get controller info from registry\n"));
832 /* Now that we have a controller, set it up with the system */
833 for(i
= 0; i
< gNumberOfControllers
; i
++)
835 /* 0: Report resource usage to the kernel, to make sure they aren't assigned to anyone else */
836 /* FIXME: Implement me. */
838 /* 1: Set up interrupt */
839 gControllerInfo
[i
].MappedVector
= HalGetInterruptVector(gControllerInfo
[i
].InterfaceType
, gControllerInfo
[i
].BusNumber
,
840 gControllerInfo
[i
].Level
, gControllerInfo
[i
].Vector
,
841 &gControllerInfo
[i
].MappedLevel
, &Affinity
);
843 /* Must set up the DPC before we connect the interrupt */
844 KeInitializeDpc(&gControllerInfo
[i
].Dpc
, DpcForIsr
, &gControllerInfo
[i
]);
846 KdPrint(("floppy: Connecting interrupt %d to controller%d (object 0x%x)\n", gControllerInfo
[i
].MappedVector
,
847 i
, &gControllerInfo
[i
]));
849 /* NOTE: We cannot share our interrupt, even on level-triggered buses. See Isr() for details. */
850 if(IoConnectInterrupt(&gControllerInfo
[i
].InterruptObject
, Isr
, &gControllerInfo
[i
], 0, gControllerInfo
[i
].MappedVector
,
851 gControllerInfo
[i
].MappedLevel
, gControllerInfo
[i
].MappedLevel
, gControllerInfo
[i
].InterruptMode
,
852 FALSE
, Affinity
, 0) != STATUS_SUCCESS
)
854 KdPrint(("floppy: AddControllers: unable to connect interrupt\n"));
859 memset(&DeviceDescription
, 0, sizeof(DeviceDescription
));
860 DeviceDescription
.Version
= DEVICE_DESCRIPTION_VERSION
;
861 DeviceDescription
.DmaChannel
= gControllerInfo
[i
].Dma
;
862 DeviceDescription
.InterfaceType
= gControllerInfo
[i
].InterfaceType
;
863 DeviceDescription
.BusNumber
= gControllerInfo
[i
].BusNumber
;
864 DeviceDescription
.MaximumLength
= 2*18*512; /* based on a 1.44MB floppy */
866 /* DMA 0,1,2,3 are 8-bit; 4,5,6,7 are 16-bit (4 is chain i think) */
867 DeviceDescription
.DmaWidth
= gControllerInfo
[i
].Dma
> 3 ? Width16Bits
: Width8Bits
;
869 gControllerInfo
[i
].AdapterObject
= HalGetAdapter(&DeviceDescription
, &gControllerInfo
[i
].MapRegisters
);
871 if(!gControllerInfo
[i
].AdapterObject
)
873 KdPrint(("floppy: AddControllers: unable to allocate an adapter object\n"));
874 IoDisconnectInterrupt(gControllerInfo
[i
].InterruptObject
);
878 /* 2b: Initialize the new controller */
879 if(InitController(&gControllerInfo
[i
]) != STATUS_SUCCESS
)
881 KdPrint(("floppy: AddControllers():Unable to set up controller %d - initialization failed\n", i
));
882 IoDisconnectInterrupt(gControllerInfo
[i
].InterruptObject
);
886 /* 2c: Set the controller's initlized flag so we know to release stuff in Unload */
887 gControllerInfo
[i
].Initialized
= TRUE
;
889 /* 3: per-drive setup */
890 for(j
= 0; j
< gControllerInfo
[i
].NumberOfDrives
; j
++)
892 WCHAR DeviceNameBuf
[MAX_DEVICE_NAME
];
893 UNICODE_STRING DeviceName
;
894 UNICODE_STRING LinkName
;
895 UNICODE_STRING ArcPath
;
898 KdPrint(("floppy: AddControllers(): Configuring drive %d on controller %d\n", i
, j
));
901 * 3a: create a device object for the drive
902 * Controllers and drives are 0-based, so the combos are:
913 DriveNumber
= (UCHAR
)(i
*4 + j
); /* loss of precision is OK; there are only 16 of 'em */
915 swprintf(DeviceNameBuf
, L
"\\Device\\Floppy%d", DriveNumber
);
916 RtlInitUnicodeString(&DeviceName
, DeviceNameBuf
);
918 if(IoCreateDevice(DriverObject
, sizeof(PVOID
), &DeviceName
,
919 FILE_DEVICE_DISK
, FILE_REMOVABLE_MEDIA
| FILE_FLOPPY_DISKETTE
, FALSE
,
920 &gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
) != STATUS_SUCCESS
)
922 KdPrint(("floppy: AddControllers: unable to register a Device object\n"));
923 IoDisconnectInterrupt(gControllerInfo
[i
].InterruptObject
);
924 continue; /* continue on to next drive */
927 KdPrint(("floppy: AddControllers: New device: %S (0x%x)\n", DeviceNameBuf
, gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
));
929 /* 3b.5: Create an ARC path in case we're booting from this drive */
930 swprintf(gControllerInfo
[i
].DriveInfo
[j
].ArcPathBuffer
,
931 L
"\\ArcName\\multi(%d)disk(%d)fdisk(%d)", gControllerInfo
[i
].BusNumber
, i
, DriveNumber
);
933 RtlInitUnicodeString(&ArcPath
, gControllerInfo
[i
].DriveInfo
[j
].ArcPathBuffer
);
934 IoAssignArcName(&ArcPath
, &DeviceName
);
936 /* 3c: Set flags up */
937 gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
->Flags
|= DO_DIRECT_IO
;
939 /* 3d: Create a symlink */
940 swprintf(gControllerInfo
[i
].DriveInfo
[j
].SymLinkBuffer
, L
"\\DosDevices\\%c:", DriveNumber
+ 'A');
941 RtlInitUnicodeString(&LinkName
, gControllerInfo
[i
].DriveInfo
[j
].SymLinkBuffer
);
942 if(IoCreateSymbolicLink(&LinkName
, &DeviceName
) != STATUS_SUCCESS
)
944 KdPrint(("floppy: AddControllers: Unable to create a symlink for drive %d\n", DriveNumber
));
945 IoDisconnectInterrupt(gControllerInfo
[i
].InterruptObject
);
946 IoDeassignArcName(&ArcPath
);
947 continue; /* continue to next drive */
950 /* 3e: Set up the DPC */
951 IoInitializeDpcRequest(gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
, DpcForIsr
);
953 /* 3f: Point the device extension at our DriveInfo struct */
954 gControllerInfo
[i
].DriveInfo
[j
].DeviceObject
->DeviceExtension
= &gControllerInfo
[i
].DriveInfo
[j
];
956 /* 3g: neat comic strip */
958 /* 3h: set the initial media type to unknown */
959 memset(&gControllerInfo
[i
].DriveInfo
[j
].DiskGeometry
, 0, sizeof(DISK_GEOMETRY
));
960 gControllerInfo
[i
].DriveInfo
[j
].DiskGeometry
.MediaType
= Unknown
;
962 /* 3i: Now that we're done, set the Initialized flag so we know to free this in Unload */
963 gControllerInfo
[i
].DriveInfo
[j
].Initialized
= TRUE
;
967 KdPrint(("floppy: AddControllers: --------------------------------------------> finished adding controllers\n"));
973 VOID NTAPI
SignalMediaChanged(PDEVICE_OBJECT DeviceObject
,
976 * FUNCTION: Process an IRP when the media has changed, and possibly notify the user
978 * DeviceObject: DeviceObject associated with the IRP
979 * Irp: IRP that we're failing due to change
981 * - This procedure is documented in the DDK by "Notifying the File System of Possible Media Changes",
982 * "IoSetHardErrorOrVerifyDevice", and by "Responding to Check-Verify Requests from the File System".
983 * - Callable at <= DISPATCH_LEVEL
986 PDRIVE_INFO DriveInfo
= DeviceObject
->DeviceExtension
;
988 KdPrint(("floppy: SignalMediaChanged called\n"));
990 DriveInfo
->DiskChangeCount
++;
992 /* If volume is not mounted, do NOT set verify and return STATUS_IO_DEVICE_ERROR */
993 if(!(DeviceObject
->Vpb
->Flags
& VPB_MOUNTED
))
995 Irp
->IoStatus
.Status
= STATUS_IO_DEVICE_ERROR
;
996 Irp
->IoStatus
.Information
= 0;
1000 /* Notify the filesystem that it will need to verify the volume */
1001 DeviceObject
->Flags
|= DO_VERIFY_VOLUME
;
1002 Irp
->IoStatus
.Status
= STATUS_VERIFY_REQUIRED
;
1003 Irp
->IoStatus
.Information
= 0;
1006 * If this is a user-based, threaded request, let the IO manager know to pop up a box asking
1007 * the user to supply the correct media, but only if the error (which we just picked out above)
1008 * is deemed by the IO manager to be "user induced". The reason we don't just unconditionally
1009 * call IoSetHardError... is because MS might change the definition of "user induced" some day,
1010 * and we don't want to have to remember to re-code this.
1012 if(Irp
->Tail
.Overlay
.Thread
&& IoIsErrorUserInduced(Irp
->IoStatus
.Status
))
1013 IoSetHardErrorOrVerifyDevice(Irp
, DeviceObject
);
1017 static VOID NTAPI
QueueThread(PVOID Context
)
1019 * FUNCTION: Thread that manages the queue and dispatches any queued requests
1025 PIO_STACK_LOCATION Stack
;
1026 PDEVICE_OBJECT DeviceObject
;
1030 UNREFERENCED_PARAMETER(Context
);
1032 Objects
[0] = &QueueSemaphore
;
1033 Objects
[1] = &QueueThreadTerminate
;
1037 KeWaitForMultipleObjects(2, Objects
, WaitAny
, Executive
, KernelMode
, FALSE
, NULL
, NULL
);
1039 if(KeReadStateEvent(&QueueThreadTerminate
))
1041 KdPrint(("floppy: QueueThread terminating\n"));
1045 KdPrint(("floppy: QueueThread: servicing an IRP\n"));
1047 Irp
= IoCsqRemoveNextIrp(&Csq
, 0);
1049 /* we won't get an irp if it was canceled */
1052 KdPrint(("floppy: QueueThread: IRP queue empty\n"));
1056 DeviceObject
= (PDEVICE_OBJECT
)Irp
->Tail
.Overlay
.DriverContext
[0];
1058 ASSERT(DeviceObject
);
1060 Stack
= IoGetCurrentIrpStackLocation(Irp
);
1062 /* Decide what to do with the IRP */
1063 switch(Stack
->MajorFunction
)
1067 ReadWritePassive(DeviceObject
->DeviceExtension
, Irp
);
1070 case IRP_MJ_DEVICE_CONTROL
:
1071 DeviceIoctlPassive(DeviceObject
->DeviceExtension
, Irp
);
1075 KdPrint(("floppy: QueueThread(): Unrecognized irp: mj: 0x%x\n", Stack
->MajorFunction
));
1076 Irp
->IoStatus
.Status
= STATUS_NOT_SUPPORTED
;
1077 Irp
->IoStatus
.Information
= 0;
1078 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
1084 NTSTATUS NTAPI
DriverEntry(PDRIVER_OBJECT DriverObject
,
1085 PUNICODE_STRING RegistryPath
)
1087 * FUNCTION: Entry-point for the driver
1089 * DriverObject: Our driver object
1090 * RegistryPath: Unused
1092 * STATUS_SUCCESS on successful initialization of at least one drive
1093 * STATUS_NO_SUCH_DEVICE if we didn't find even one drive
1094 * STATUS_UNSUCCESSFUL otherwise
1097 HANDLE ThreadHandle
;
1099 UNREFERENCED_PARAMETER(RegistryPath
);
1102 * Set up dispatch routines
1104 DriverObject
->MajorFunction
[IRP_MJ_CREATE
] = (PDRIVER_DISPATCH
)CreateClose
;
1105 DriverObject
->MajorFunction
[IRP_MJ_CLOSE
] = (PDRIVER_DISPATCH
)CreateClose
;
1106 DriverObject
->MajorFunction
[IRP_MJ_READ
] = (PDRIVER_DISPATCH
)ReadWrite
;
1107 DriverObject
->MajorFunction
[IRP_MJ_WRITE
] = (PDRIVER_DISPATCH
)ReadWrite
;
1108 DriverObject
->MajorFunction
[IRP_MJ_DEVICE_CONTROL
] = (PDRIVER_DISPATCH
)DeviceIoctl
;
1110 DriverObject
->DriverUnload
= Unload
;
1113 * We depend on some zeroes in these structures. I know this is supposed to be
1114 * initialized to 0 by the complier but this makes me feel beter.
1116 memset(&gControllerInfo
, 0, sizeof(gControllerInfo
));
1119 * Set up queue. This routine cannot fail (trust me, I wrote it).
1121 IoCsqInitialize(&Csq
, CsqInsertIrp
, CsqRemoveIrp
, CsqPeekNextIrp
,
1122 CsqAcquireLock
, CsqReleaseLock
, CsqCompleteCanceledIrp
);
1127 KeInitializeSpinLock(&IrpQueueLock
);
1130 * ...and the queue list itself
1132 InitializeListHead(&IrpQueue
);
1135 * The queue is counted by a semaphore. The queue management thread
1136 * blocks on this semaphore, so if requests come in faster than the queue
1137 * thread can handle them, the semaphore count goes up.
1139 KeInitializeSemaphore(&QueueSemaphore
, 0, 0x7fffffff);
1142 * Event to terminate that thread
1144 KeInitializeEvent(&QueueThreadTerminate
, NotificationEvent
, FALSE
);
1147 * Create the queue processing thread. Save its handle in the global variable
1148 * ThreadHandle so we can wait on its termination during Unload.
1150 if(PsCreateSystemThread(&ThreadHandle
, 0, 0, 0, 0, QueueThread
, 0) != STATUS_SUCCESS
)
1152 KdPrint(("floppy: Unable to create system thread; failing init\n"));
1153 return STATUS_INSUFFICIENT_RESOURCES
;
1156 if(ObReferenceObjectByHandle(ThreadHandle
, STANDARD_RIGHTS_ALL
, NULL
, KernelMode
, &QueueThreadObject
, NULL
) != STATUS_SUCCESS
)
1158 KdPrint(("floppy: Unable to reference returned thread handle; failing init\n"));
1159 return STATUS_UNSUCCESSFUL
;
1163 * Close the handle, now that we have the object pointer and a reference of our own.
1164 * The handle will certainly not be valid in the context of the caller next time we
1165 * need it, as handles are process-specific.
1167 ZwClose(ThreadHandle
);
1170 * Start the device discovery proces. Returns STATUS_SUCCESS if
1171 * it finds even one drive attached to one controller.
1173 if(!AddControllers(DriverObject
))
1174 return STATUS_NO_SUCH_DEVICE
;
1176 return STATUS_SUCCESS
;