2 * PROJECT: ReactOS PCI Bus Driver
3 * LICENSE: BSD - See COPYING.ARM in the top level directory
4 * FILE: drivers/bus/pci/utils.c
5 * PURPOSE: Utility/Helper Support Code
6 * PROGRAMMERS: ReactOS Portable Systems Group
9 /* INCLUDES *******************************************************************/
15 /* GLOBALS ********************************************************************/
17 ULONG PciDebugPortsCount
;
19 RTL_RANGE_LIST PciIsaBitExclusionList
;
20 RTL_RANGE_LIST PciVgaAndIsaBitExclusionList
;
22 /* FUNCTIONS ******************************************************************/
26 PciUnicodeStringStrStr(IN PUNICODE_STRING InputString
,
27 IN PCUNICODE_STRING EqualString
,
28 IN BOOLEAN CaseInSensitive
)
30 UNICODE_STRING PartialString
;
31 LONG EqualChars
, TotalChars
;
33 /* Build a partial string with the smaller substring */
34 PartialString
.Length
= EqualString
->Length
;
35 PartialString
.MaximumLength
= InputString
->MaximumLength
;;
36 PartialString
.Buffer
= InputString
->Buffer
;
38 /* Check how many characters that need comparing */
40 TotalChars
= (InputString
->Length
- EqualString
->Length
) / sizeof(WCHAR
);
42 /* If the substring is bigger, just fail immediately */
43 if (TotalChars
< 0) return FALSE
;
45 /* Keep checking each character */
46 while (!RtlEqualUnicodeString(EqualString
, &PartialString
, CaseInSensitive
))
48 /* Continue checking until all the required characters are equal */
49 PartialString
.Buffer
++;
50 PartialString
.MaximumLength
-= sizeof(WCHAR
);
51 if (++EqualChars
> TotalChars
) return FALSE
;
54 /* The string is equal */
60 PciStringToUSHORT(IN PWCHAR String
,
64 ULONG Low
, High
, Length
;
67 /* Initialize everything to zero */
72 /* Get the character and set the high byte based on the previous one */
76 /* Check for numbers */
77 if ( Char
>= '0' && Char
<= '9' )
79 /* Convert them to a byte */
82 else if ( Char
>= 'A' && Char
<= 'F' )
84 /* Convert upper-case hex letters into a byte */
87 else if ( Char
>= 'a' && Char
<= 'f' )
89 /* Convert lower-case hex letters into a byte */
94 /* Invalid string, fail the conversion */
98 /* Combine the high and low byte */
101 /* If 4 letters have been reached, the 16-bit integer should exist */
104 /* Return it to the caller */
113 PciIsSuiteVersion(IN USHORT SuiteMask
)
116 RTL_OSVERSIONINFOEXW VersionInfo
;
118 /* Initialize the version information */
119 RtlZeroMemory(&VersionInfo
, sizeof(RTL_OSVERSIONINFOEXW
));
120 VersionInfo
.dwOSVersionInfoSize
= sizeof(RTL_OSVERSIONINFOEXW
);
121 VersionInfo
.wSuiteMask
= SuiteMask
;
123 /* Set the comparison mask and return if the passed suite mask matches */
124 VER_SET_CONDITION(Mask
, VER_SUITENAME
, VER_AND
);
125 return NT_SUCCESS(RtlVerifyVersionInfo(&VersionInfo
, VER_SUITENAME
, Mask
));
130 PciIsDatacenter(VOID
)
137 /* Assume this isn't Datacenter */
140 /* First, try opening the setup key */
141 Status
= PciGetRegistryValue(L
"",
142 L
"\\REGISTRY\\MACHINE\\SYSTEM\\CurrentControlSet\\Services\\setupdd",
147 if (!NT_SUCCESS(Status
))
149 /* This is not an in-progress Setup boot, so query the suite version */
150 Result
= PciIsSuiteVersion(VER_SUITE_DATACENTER
);
154 /* This scenario shouldn't happen yet, since SetupDD isn't used */
159 /* Return if this is Datacenter or not */
165 PciOpenKey(IN PWCHAR KeyName
,
167 IN ACCESS_MASK DesiredAccess
,
168 OUT PHANDLE KeyHandle
,
169 OUT PNTSTATUS KeyStatus
)
172 OBJECT_ATTRIBUTES ObjectAttributes
;
173 UNICODE_STRING KeyString
;
176 /* Initialize the object attributes */
177 RtlInitUnicodeString(&KeyString
, KeyName
);
178 InitializeObjectAttributes(&ObjectAttributes
,
180 OBJ_CASE_INSENSITIVE
,
184 /* Open the key, returning a boolean, and the status, if requested */
185 Status
= ZwOpenKey(KeyHandle
, DesiredAccess
, &ObjectAttributes
);
186 if (KeyStatus
) *KeyStatus
= Status
;
187 return NT_SUCCESS(Status
);
192 PciGetRegistryValue(IN PWCHAR ValueName
,
194 IN HANDLE RootHandle
,
196 OUT PVOID
*OutputBuffer
,
197 OUT PULONG OutputLength
)
200 PKEY_VALUE_PARTIAL_INFORMATION PartialInfo
;
201 ULONG NeededLength
, ActualLength
;
202 UNICODE_STRING ValueString
;
206 /* So we know what to free at the end of the body */
211 /* Open the key by name, rooted off the handle passed */
212 Result
= PciOpenKey(KeyName
,
219 /* Query for the size that's needed for the value that was passed in */
220 RtlInitUnicodeString(&ValueString
, ValueName
);
221 Status
= ZwQueryValueKey(KeyHandle
,
223 KeyValuePartialInformation
,
227 ASSERT(!NT_SUCCESS(Status
));
228 if (Status
!= STATUS_BUFFER_TOO_SMALL
) break;
230 /* Allocate an appropriate buffer for the size that was returned */
231 ASSERT(NeededLength
!= 0);
232 Status
= STATUS_INSUFFICIENT_RESOURCES
;
233 PartialInfo
= ExAllocatePoolWithTag(PagedPool
,
236 if (!PartialInfo
) break;
238 /* Query the actual value information now that the size is known */
239 Status
= ZwQueryValueKey(KeyHandle
,
241 KeyValuePartialInformation
,
245 if (!NT_SUCCESS(Status
)) break;
247 /* Make sure it's of the type that the caller expects */
248 Status
= STATUS_INVALID_PARAMETER
;
249 if (PartialInfo
->Type
!= Type
) break;
251 /* Subtract the registry-specific header, to get the data size */
252 ASSERT(NeededLength
== ActualLength
);
253 NeededLength
-= sizeof(KEY_VALUE_PARTIAL_INFORMATION
);
255 /* Allocate a buffer to hold the data and return it to the caller */
256 Status
= STATUS_INSUFFICIENT_RESOURCES
;
257 *OutputBuffer
= ExAllocatePoolWithTag(PagedPool
,
260 if (!*OutputBuffer
) break;
262 /* Copy the data into the buffer and return its length to the caller */
263 RtlCopyMemory(*OutputBuffer
, PartialInfo
->Data
, NeededLength
);
264 if (OutputLength
) *OutputLength
= NeededLength
;
265 Status
= STATUS_SUCCESS
;
268 /* Close any opened keys and free temporary allocations */
269 if (KeyHandle
) ZwClose(KeyHandle
);
270 if (PartialInfo
) ExFreePoolWithTag(PartialInfo
, 0);
276 PciBuildDefaultExclusionLists(VOID
)
280 ASSERT(PciIsaBitExclusionList
.Count
== 0);
281 ASSERT(PciVgaAndIsaBitExclusionList
.Count
== 0);
283 /* Initialize the range lists */
284 RtlInitializeRangeList(&PciIsaBitExclusionList
);
285 RtlInitializeRangeList(&PciVgaAndIsaBitExclusionList
);
287 /* Loop x86 I/O ranges */
288 for (Start
= 0x100; Start
<= 0xFEFF; Start
+= 0x400)
290 /* Add the ISA I/O ranges */
291 Status
= RtlAddRange(&PciIsaBitExclusionList
,
295 RTL_RANGE_LIST_ADD_IF_CONFLICT
,
298 if (!NT_SUCCESS(Status
)) break;
300 /* Add the ISA I/O ranges */
301 Status
= RtlAddRange(&PciVgaAndIsaBitExclusionList
,
305 RTL_RANGE_LIST_ADD_IF_CONFLICT
,
308 if (!NT_SUCCESS(Status
)) break;
310 /* Add the VGA I/O range for Monochrome Video */
311 Status
= RtlAddRange(&PciVgaAndIsaBitExclusionList
,
315 RTL_RANGE_LIST_ADD_IF_CONFLICT
,
318 if (!NT_SUCCESS(Status
)) break;
320 /* Add the VGA I/O range for certain CGA adapters */
321 Status
= RtlAddRange(&PciVgaAndIsaBitExclusionList
,
325 RTL_RANGE_LIST_ADD_IF_CONFLICT
,
328 if (!NT_SUCCESS(Status
)) break;
330 /* Success, ranges added done */
333 RtlFreeRangeList(&PciIsaBitExclusionList
);
334 RtlFreeRangeList(&PciVgaAndIsaBitExclusionList
);
340 PciFindParentPciFdoExtension(IN PDEVICE_OBJECT DeviceObject
,
343 PPCI_FDO_EXTENSION DeviceExtension
;
344 PPCI_PDO_EXTENSION SearchExtension
, FoundExtension
;
346 /* Assume we'll find nothing */
347 SearchExtension
= DeviceObject
->DeviceExtension
;
348 FoundExtension
= NULL
;
350 /* Check if a lock was specified */
353 /* Wait for the lock to be released */
354 KeEnterCriticalRegion();
355 KeWaitForSingleObject(Lock
, Executive
, KernelMode
, FALSE
, NULL
);
358 /* Now search for the extension */
359 DeviceExtension
= (PPCI_FDO_EXTENSION
)PciFdoExtensionListHead
.Next
;
360 while (DeviceExtension
)
362 /* Acquire this device's lock */
363 KeEnterCriticalRegion();
364 KeWaitForSingleObject(&DeviceExtension
->ChildListLock
,
370 /* Scan all children PDO, stop when no more PDOs, or found it */
371 for (FoundExtension
= DeviceExtension
->ChildPdoList
;
372 FoundExtension
&& (FoundExtension
!= SearchExtension
);
373 FoundExtension
= FoundExtension
->Next
);
375 /* If we found it, break out */
376 if (FoundExtension
) break;
378 /* Release this device's lock */
379 KeSetEvent(&DeviceExtension
->ChildListLock
, IO_NO_INCREMENT
, FALSE
);
380 KeLeaveCriticalRegion();
382 /* Move to the next device */
383 DeviceExtension
= (PPCI_FDO_EXTENSION
)DeviceExtension
->List
.Next
;
386 /* Check if we had acquired a lock previously */
390 KeSetEvent(Lock
, IO_NO_INCREMENT
, FALSE
);
391 KeLeaveCriticalRegion();
394 /* Return which extension was found, if any */
395 return DeviceExtension
;
400 PciInsertEntryAtTail(IN PSINGLE_LIST_ENTRY ListHead
,
401 IN PPCI_FDO_EXTENSION DeviceExtension
,
404 PSINGLE_LIST_ENTRY NextEntry
;
407 /* Check if a lock was specified */
410 /* Wait for the lock to be released */
411 KeEnterCriticalRegion();
412 KeWaitForSingleObject(Lock
, Executive
, KernelMode
, FALSE
, NULL
);
415 /* Loop the list until we get to the end, then insert this entry there */
416 for (NextEntry
= ListHead
; NextEntry
->Next
; NextEntry
= NextEntry
->Next
);
417 NextEntry
->Next
= &DeviceExtension
->List
;
419 /* Check if we had acquired a lock previously */
423 KeSetEvent(Lock
, IO_NO_INCREMENT
, FALSE
);
424 KeLeaveCriticalRegion();
430 PciInsertEntryAtHead(IN PSINGLE_LIST_ENTRY ListHead
,
431 IN PSINGLE_LIST_ENTRY Entry
,
436 /* Check if a lock was specified */
439 /* Wait for the lock to be released */
440 KeEnterCriticalRegion();
441 KeWaitForSingleObject(Lock
, Executive
, KernelMode
, FALSE
, NULL
);
444 /* Make the entry point to the current head and make the head point to it */
445 Entry
->Next
= ListHead
->Next
;
446 ListHead
->Next
= Entry
;
448 /* Check if we had acquired a lock previously */
452 KeSetEvent(Lock
, IO_NO_INCREMENT
, FALSE
);
453 KeLeaveCriticalRegion();
459 PcipLinkSecondaryExtension(IN PSINGLE_LIST_ENTRY List
,
461 IN PPCI_SECONDARY_EXTENSION SecondaryExtension
,
462 IN PCI_SIGNATURE ExtensionType
,
467 /* Setup the extension data, and insert it into the primary's list */
468 SecondaryExtension
->ExtensionType
= ExtensionType
;
469 SecondaryExtension
->Destructor
= Destructor
;
470 PciInsertEntryAtHead(List
, &SecondaryExtension
->List
, Lock
);
475 PciGetDeviceProperty(IN PDEVICE_OBJECT DeviceObject
,
476 IN DEVICE_REGISTRY_PROPERTY DeviceProperty
,
477 OUT PVOID
*OutputBuffer
)
480 ULONG BufferLength
, ResultLength
;
484 /* Query the requested property size */
485 Status
= IoGetDeviceProperty(DeviceObject
,
490 if (Status
!= STATUS_BUFFER_TOO_SMALL
)
492 /* Call should've failed with buffer too small! */
493 DPRINT1("PCI - Unexpected status from GetDeviceProperty, saw %08X, expected %08X.\n",
495 STATUS_BUFFER_TOO_SMALL
);
496 *OutputBuffer
= NULL
;
497 ASSERTMSG(FALSE
, "PCI Successfully did the impossible!");
501 /* Allocate the required buffer */
502 Buffer
= ExAllocatePoolWithTag(PagedPool
, BufferLength
, 'BicP');
505 /* No memory, fail the request */
506 DPRINT1("PCI - Failed to allocate DeviceProperty buffer (%d bytes).\n", BufferLength
);
507 Status
= STATUS_INSUFFICIENT_RESOURCES
;
511 /* Do the actual property query call */
512 Status
= IoGetDeviceProperty(DeviceObject
,
517 if (!NT_SUCCESS(Status
)) break;
519 /* Return the buffer to the caller */
520 ASSERT(BufferLength
== ResultLength
);
521 *OutputBuffer
= Buffer
;
522 return STATUS_SUCCESS
;
526 return STATUS_UNSUCCESSFUL
;
531 PciSendIoctl(IN PDEVICE_OBJECT DeviceObject
,
532 IN ULONG IoControlCode
,
533 IN PVOID InputBuffer
,
534 IN ULONG InputBufferLength
,
535 IN PVOID OutputBuffer
,
536 IN ULONG OutputBufferLength
)
541 IO_STATUS_BLOCK IoStatusBlock
;
542 PDEVICE_OBJECT AttachedDevice
;
545 /* Initialize the pending IRP event */
546 KeInitializeEvent(&Event
, SynchronizationEvent
, FALSE
);
548 /* Get a reference to the root PDO (ACPI) */
549 AttachedDevice
= IoGetAttachedDeviceReference(DeviceObject
);
550 if (!AttachedDevice
) return STATUS_INVALID_PARAMETER
;
552 /* Build the requested IOCTL IRP */
553 Irp
= IoBuildDeviceIoControlRequest(IoControlCode
,
562 if (!Irp
) return STATUS_INSUFFICIENT_RESOURCES
;
564 /* Send the IOCTL to the driver */
565 Status
= IoCallDriver(AttachedDevice
, Irp
);
566 if (Status
== STATUS_PENDING
)
568 /* Wait for a response */
569 KeWaitForSingleObject(&Event
,
574 Status
= Irp
->IoStatus
.Status
;
577 /* Take away the reference we took and return the result to the caller */
578 ObDereferenceObject(AttachedDevice
);
582 PPCI_SECONDARY_EXTENSION
584 PciFindNextSecondaryExtension(IN PSINGLE_LIST_ENTRY ListHead
,
585 IN PCI_SIGNATURE ExtensionType
)
587 PSINGLE_LIST_ENTRY NextEntry
;
588 PPCI_SECONDARY_EXTENSION Extension
;
591 for (NextEntry
= ListHead
; NextEntry
; NextEntry
= NextEntry
->Next
)
593 /* Grab each extension and check if it's the one requested */
594 Extension
= CONTAINING_RECORD(NextEntry
, PCI_SECONDARY_EXTENSION
, List
);
595 if (Extension
->ExtensionType
== ExtensionType
) return Extension
;
598 /* Nothing was found */
604 PciGetHackFlags(IN USHORT VendorId
,
606 IN USHORT SubVendorId
,
607 IN USHORT SubSystemId
,
610 PPCI_HACK_ENTRY HackEntry
;
612 ULONG LastWeight
, MatchWeight
;
615 /* Initialize the variables before looping */
618 ASSERT(PciHackTable
);
620 /* Scan the hack table */
621 for (HackEntry
= PciHackTable
;
622 HackEntry
->VendorID
!= PCI_INVALID_VENDORID
;
625 /* Check if there's an entry for this device */
626 if ((HackEntry
->DeviceID
== DeviceId
) &&
627 (HackEntry
->VendorID
== VendorId
))
629 /* This is a basic match */
630 EntryFlags
= HackEntry
->Flags
;
633 /* Does the entry have revision information? */
634 if (EntryFlags
& PCI_HACK_HAS_REVISION_INFO
)
636 /* Check if the revision matches, if so, this is a better match */
637 if (HackEntry
->RevisionID
!= RevisionId
) continue;
641 /* Does the netry have subsystem information? */
642 if (EntryFlags
& PCI_HACK_HAS_SUBSYSTEM_INFO
)
644 /* Check if it matches, if so, this is the best possible match */
645 if ((HackEntry
->SubVendorID
!= SubVendorId
) ||
646 (HackEntry
->SubSystemID
!= SubSystemId
))
653 /* Is this the best match yet? */
654 if (MatchWeight
> LastWeight
)
656 /* This is the best match for now, use this as the hack flags */
657 HackFlags
= HackEntry
->HackFlags
;
658 LastWeight
= MatchWeight
;
663 /* Return the best match */
669 PciIsCriticalDeviceClass(IN UCHAR BaseClass
,
672 /* Check for system or bridge devices */
673 if (BaseClass
== PCI_CLASS_BASE_SYSTEM_DEV
)
675 /* Interrupt controlers are critical */
676 return SubClass
== PCI_SUBCLASS_SYS_INTERRUPT_CTLR
;
678 else if (BaseClass
== PCI_CLASS_BRIDGE_DEV
)
680 /* ISA Bridges are critical */
681 return SubClass
== PCI_SUBCLASS_BR_ISA
;
685 /* All display controllers are critical */
686 return BaseClass
== PCI_CLASS_DISPLAY_CTLR
;
692 PciFindPdoByFunction(IN PPCI_FDO_EXTENSION DeviceExtension
,
693 IN ULONG FunctionNumber
,
694 IN PPCI_COMMON_HEADER PciData
)
697 PPCI_PDO_EXTENSION PdoExtension
;
699 /* Get the current IRQL when this call was made */
700 Irql
= KeGetCurrentIrql();
702 /* Is this a low-IRQL call? */
703 if (Irql
< DISPATCH_LEVEL
)
705 /* Acquire this device's lock */
706 KeEnterCriticalRegion();
707 KeWaitForSingleObject(&DeviceExtension
->ChildListLock
,
714 /* Loop every child PDO */
715 for (PdoExtension
= DeviceExtension
->ChildPdoList
;
717 PdoExtension
= PdoExtension
->Next
)
719 /* Find only enumerated PDOs */
720 if (!PdoExtension
->ReportedMissing
)
722 /* Check if the function number and header data matches */
723 if ((FunctionNumber
== PdoExtension
->Slot
.u
.AsULONG
) &&
724 (PdoExtension
->VendorId
== PciData
->VendorID
) &&
725 (PdoExtension
->DeviceId
== PciData
->DeviceID
) &&
726 (PdoExtension
->RevisionId
== PciData
->RevisionID
))
728 /* This is considered to be the same PDO */
734 /* Was this a low-IRQL call? */
735 if (Irql
< DISPATCH_LEVEL
)
737 /* Release this device's lock */
738 KeSetEvent(&DeviceExtension
->ChildListLock
, IO_NO_INCREMENT
, FALSE
);
739 KeLeaveCriticalRegion();
742 /* If the search found something, this is non-NULL, otherwise it's NULL */
748 PciIsDeviceOnDebugPath(IN PPCI_PDO_EXTENSION DeviceExtension
)
752 /* Check for too many, or no, debug ports */
753 ASSERT(PciDebugPortsCount
<= MAX_DEBUGGING_DEVICES_SUPPORTED
);
754 if (!PciDebugPortsCount
) return FALSE
;
756 /* eVb has not been able to test such devices yet */
763 PciGetBiosConfig(IN PPCI_PDO_EXTENSION DeviceExtension
,
764 OUT PPCI_COMMON_HEADER PciData
)
766 HANDLE KeyHandle
, SubKeyHandle
;
767 OBJECT_ATTRIBUTES ObjectAttributes
;
768 UNICODE_STRING KeyName
, KeyValue
;
770 WCHAR DataBuffer
[sizeof(KEY_VALUE_PARTIAL_INFORMATION
) + PCI_COMMON_HDR_LENGTH
];
771 PKEY_VALUE_PARTIAL_INFORMATION PartialInfo
= (PVOID
)DataBuffer
;
776 /* Open the PCI key */
777 Status
= IoOpenDeviceRegistryKey(DeviceExtension
->ParentFdoExtension
->
778 PhysicalDeviceObject
,
782 if (!NT_SUCCESS(Status
)) return Status
;
784 /* Create a volatile BIOS configuration key */
785 RtlInitUnicodeString(&KeyName
, L
"BiosConfig");
786 InitializeObjectAttributes(&ObjectAttributes
,
791 Status
= ZwCreateKey(&SubKeyHandle
,
799 if (!NT_SUCCESS(Status
)) return Status
;
801 /* Create the key value based on the device and function number */
803 L
"DEV_%02x&FUN_%02x",
804 DeviceExtension
->Slot
.u
.bits
.DeviceNumber
,
805 DeviceExtension
->Slot
.u
.bits
.FunctionNumber
);
806 RtlInitUnicodeString(&KeyValue
, Buffer
);
808 /* Query the value information (PCI BIOS configuration header) */
809 Status
= ZwQueryValueKey(SubKeyHandle
,
811 KeyValuePartialInformation
,
815 ZwClose(SubKeyHandle
);
816 if (!NT_SUCCESS(Status
)) return Status
;
818 /* If any information was returned, go ahead and copy its data */
819 ASSERT(PartialInfo
->DataLength
== PCI_COMMON_HDR_LENGTH
);
820 RtlCopyMemory(PciData
, PartialInfo
->Data
, PCI_COMMON_HDR_LENGTH
);
826 PciSaveBiosConfig(IN PPCI_PDO_EXTENSION DeviceExtension
,
827 IN PPCI_COMMON_HEADER PciData
)
829 HANDLE KeyHandle
, SubKeyHandle
;
830 OBJECT_ATTRIBUTES ObjectAttributes
;
831 UNICODE_STRING KeyName
, KeyValue
;
836 /* Open the PCI key */
837 Status
= IoOpenDeviceRegistryKey(DeviceExtension
->ParentFdoExtension
->
838 PhysicalDeviceObject
,
840 KEY_READ
| KEY_WRITE
,
842 if (!NT_SUCCESS(Status
)) return Status
;
844 /* Create a volatile BIOS configuration key */
845 RtlInitUnicodeString(&KeyName
, L
"BiosConfig");
846 InitializeObjectAttributes(&ObjectAttributes
,
851 Status
= ZwCreateKey(&SubKeyHandle
,
852 KEY_READ
| KEY_WRITE
,
859 if (!NT_SUCCESS(Status
)) return Status
;
861 /* Create the key value based on the device and function number */
863 L
"DEV_%02x&FUN_%02x",
864 DeviceExtension
->Slot
.u
.bits
.DeviceNumber
,
865 DeviceExtension
->Slot
.u
.bits
.FunctionNumber
);
866 RtlInitUnicodeString(&KeyValue
, Buffer
);
868 /* Set the value data (the PCI BIOS configuration header) */
869 Status
= ZwSetValueKey(SubKeyHandle
,
874 PCI_COMMON_HDR_LENGTH
);
875 ZwClose(SubKeyHandle
);
881 PciReadDeviceCapability(IN PPCI_PDO_EXTENSION DeviceExtension
,
883 IN ULONG CapabilityId
,
884 OUT PPCI_CAPABILITIES_HEADER Buffer
,
887 ULONG CapabilityCount
= 0;
889 /* If the device has no capabilility list, fail */
890 if (!Offset
) return 0;
892 /* Validate a PDO with capabilities, a valid buffer, and a valid length */
893 ASSERT(DeviceExtension
->ExtensionType
== PciPdoExtensionType
);
894 ASSERT(DeviceExtension
->CapabilitiesPtr
!= 0);
896 ASSERT(Length
>= sizeof(PCI_CAPABILITIES_HEADER
));
898 /* Loop all capabilities */
901 /* Make sure the pointer is spec-aligned and spec-sized */
902 ASSERT((Offset
>= PCI_COMMON_HDR_LENGTH
) && ((Offset
& 0x3) == 0));
904 /* Read the capability header */
905 PciReadDeviceConfig(DeviceExtension
,
908 sizeof(PCI_CAPABILITIES_HEADER
));
910 /* Check if this is the capability being looked up */
911 if ((Buffer
->CapabilityID
== CapabilityId
) || !(CapabilityId
))
913 /* Check if was at a valid offset and length */
914 if ((Offset
) && (Length
> sizeof(PCI_CAPABILITIES_HEADER
)))
917 ASSERT(Length
<= (sizeof(PCI_COMMON_CONFIG
) - Offset
));
919 /* Now read the whole capability data into the buffer */
920 PciReadDeviceConfig(DeviceExtension
,
921 (PVOID
)((ULONG_PTR
)Buffer
+
922 sizeof(PCI_CAPABILITIES_HEADER
)),
923 Offset
+ sizeof(PCI_CAPABILITIES_HEADER
),
924 Length
- sizeof(PCI_CAPABILITIES_HEADER
));
927 /* Return the offset where the capability was found */
931 /* Try the next capability instead */
933 Offset
= Buffer
->Next
;
935 /* There can't be more than 48 capabilities (256 bytes max) */
936 if (CapabilityCount
> 48)
938 /* Fail, since this is basically a broken PCI device */
939 DPRINT1("PCI device %p capabilities list is broken.\n", DeviceExtension
);
944 /* Capability wasn't found, fail */
950 PciCanDisableDecodes(IN PPCI_PDO_EXTENSION DeviceExtension
,
951 IN PPCI_COMMON_HEADER Config
,
952 IN ULONGLONG HackFlags
,
953 IN BOOLEAN ForPowerDown
)
955 UCHAR BaseClass
, SubClass
;
958 /* Is there a device extension or should the PCI header be used? */
961 /* Never disable decodes for a debug PCI Device */
962 if (DeviceExtension
->OnDebugPath
) return FALSE
;
964 /* Hack flags will be obtained from the extension, not the caller */
965 ASSERT(HackFlags
== 0);
967 /* Get hacks and classification from the device extension */
968 HackFlags
= DeviceExtension
->HackFlags
;
969 SubClass
= DeviceExtension
->SubClass
;
970 BaseClass
= DeviceExtension
->BaseClass
;
974 /* There must be a PCI header, go read the classification information */
975 ASSERT(Config
!= NULL
);
976 BaseClass
= Config
->BaseClass
;
977 SubClass
= Config
->SubClass
;
980 /* Check for hack flags that prevent disabling the decodes */
981 if (HackFlags
& (PCI_HACK_PRESERVE_COMMAND
|
982 PCI_HACK_CB_SHARE_CMD_BITS
|
983 PCI_HACK_DONT_DISABLE_DECODES
))
989 /* Is this a VGA adapter? */
990 if ((BaseClass
== PCI_CLASS_DISPLAY_CTLR
) &&
991 (SubClass
== PCI_SUBCLASS_VID_VGA_CTLR
))
993 /* Never disable decodes if this is for power down */
997 /* Check for legacy devices */
998 if (BaseClass
== PCI_CLASS_PRE_20
)
1000 /* Never disable video adapter cards if this is for power down */
1001 if (SubClass
== PCI_SUBCLASS_PRE_20_VGA
) return ForPowerDown
;
1003 else if (BaseClass
== PCI_CLASS_DISPLAY_CTLR
)
1005 /* Never disable VGA adapters if this is for power down */
1006 if (SubClass
== PCI_SUBCLASS_VID_VGA_CTLR
) return ForPowerDown
;
1008 else if (BaseClass
== PCI_CLASS_BRIDGE_DEV
)
1010 /* Check for legacy bridges */
1011 if ((SubClass
== PCI_SUBCLASS_BR_ISA
) ||
1012 (SubClass
== PCI_SUBCLASS_BR_EISA
) ||
1013 (SubClass
== PCI_SUBCLASS_BR_MCA
) ||
1014 (SubClass
== PCI_SUBCLASS_BR_HOST
) ||
1015 (SubClass
== PCI_SUBCLASS_BR_OTHER
))
1017 /* Never disable these */
1020 else if ((SubClass
== PCI_SUBCLASS_BR_PCI_TO_PCI
) ||
1021 (SubClass
== PCI_SUBCLASS_BR_CARDBUS
))
1023 /* This is a supported bridge, but does it have a VGA card? */
1024 if (!DeviceExtension
)
1026 /* Read the bridge control flag from the PCI header */
1027 IsVga
= Config
->u
.type1
.BridgeControl
& PCI_ENABLE_BRIDGE_VGA
;
1031 /* Read the cached flag in the device extension */
1032 IsVga
= DeviceExtension
->Dependent
.type1
.VgaBitSet
;
1035 /* Never disable VGA adapters if this is for power down */
1036 if (IsVga
) return ForPowerDown
;
1040 /* Finally, never disable decodes if there's no power management */
1041 return !(HackFlags
& PCI_HACK_NO_PM_CAPS
);
1046 PciClassifyDeviceType(IN PPCI_PDO_EXTENSION PdoExtension
)
1048 ASSERT(PdoExtension
->ExtensionType
== PciPdoExtensionType
);
1050 /* Differenriate between devices and bridges */
1051 if (PdoExtension
->BaseClass
!= PCI_CLASS_BRIDGE_DEV
) return PciTypeDevice
;
1053 /* The PCI Bus driver handles only CardBus and PCI bridges (plus host) */
1054 if (PdoExtension
->SubClass
== PCI_SUBCLASS_BR_HOST
) return PciTypeHostBridge
;
1055 if (PdoExtension
->SubClass
== PCI_SUBCLASS_BR_PCI_TO_PCI
) return PciTypePciBridge
;
1056 if (PdoExtension
->SubClass
== PCI_SUBCLASS_BR_CARDBUS
) return PciTypeCardbusBridge
;
1058 /* Any other kind of bridge is treated like a device */
1059 return PciTypeDevice
;
1064 PciExecuteCriticalSystemRoutine(IN ULONG_PTR IpiContext
)
1066 PPCI_IPI_CONTEXT Context
= (PPCI_IPI_CONTEXT
)IpiContext
;
1068 /* Check if the IPI is already running */
1069 if (!InterlockedDecrement(&Context
->RunCount
))
1071 /* Nope, this is the first instance, so execute the IPI function */
1072 Context
->Function(Context
->PdoExtension
, Context
->Context
);
1074 /* Notify anyone that was spinning that they can stop now */
1075 Context
->Barrier
= 0;
1079 /* Spin until it has finished running */
1080 while (Context
->Barrier
);
1089 PciIsSlotPresentInParentMethod(IN PPCI_PDO_EXTENSION PdoExtension
,
1093 PACPI_METHOD_ARGUMENT Argument
;
1094 ACPI_EVAL_INPUT_BUFFER InputBuffer
;
1095 PACPI_EVAL_OUTPUT_BUFFER OutputBuffer
;
1100 /* Assume slot is not part of the parent method */
1103 /* Allocate a 2KB buffer for the method return parameters */
1104 Length
= sizeof(ACPI_EVAL_OUTPUT_BUFFER
) + 2048;
1105 OutputBuffer
= ExAllocatePoolWithTag(PagedPool
, Length
, 'BicP');
1108 /* Clear out the output buffer */
1109 RtlZeroMemory(OutputBuffer
, Length
);
1111 /* Initialize the input buffer with the method requested */
1112 InputBuffer
.Signature
= 0;
1113 *(PULONG
)InputBuffer
.MethodName
= Method
;
1114 InputBuffer
.Signature
= ACPI_EVAL_INPUT_BUFFER_SIGNATURE
;
1116 /* Send it to the ACPI driver */
1117 Status
= PciSendIoctl(PdoExtension
->ParentFdoExtension
->PhysicalDeviceObject
,
1118 IOCTL_ACPI_EVAL_METHOD
,
1120 sizeof(ACPI_EVAL_INPUT_BUFFER
),
1123 if (NT_SUCCESS(Status
))
1125 /* Scan all output arguments */
1126 for (i
= 0; i
< OutputBuffer
->Count
; i
++)
1128 /* Make sure it's an integer */
1129 Argument
= &OutputBuffer
->Argument
[i
];
1130 if (Argument
->Type
!= ACPI_METHOD_ARGUMENT_INTEGER
) continue;
1132 /* Check if the argument matches this PCI slot structure */
1133 if (Argument
->Argument
== ((PdoExtension
->Slot
.u
.bits
.DeviceNumber
) |
1134 ((PdoExtension
->Slot
.u
.bits
.FunctionNumber
) << 16)))
1136 /* This slot has been found, return it */
1143 /* Finished with the buffer, free it */
1144 ExFreePoolWithTag(OutputBuffer
, 0);
1147 /* Return if the slot was found */
1153 PciGetLengthFromBar(IN ULONG Bar
)
1157 /* I/O addresses vs. memory addresses start differently due to alignment */
1158 Length
= 1 << ((Bar
& PCI_ADDRESS_IO_SPACE
) ? 2 : 4);
1160 /* Keep going until a set bit */
1161 while (!(Length
& Bar
) && (Length
)) Length
<<= 1;
1163 /* Return the length (might be 0 on 64-bit because it's the low-word) */
1164 if ((Bar
& PCI_ADDRESS_MEMORY_TYPE_MASK
) != PCI_TYPE_64BIT
) ASSERT(Length
);
1170 PciCreateIoDescriptorFromBarLimit(PIO_RESOURCE_DESCRIPTOR ResourceDescriptor
,
1174 ULONG CurrentBar
, BarLength
, BarMask
;
1175 BOOLEAN Is64BitBar
= FALSE
;
1177 /* Check if the BAR is nor I/O nor memory */
1178 CurrentBar
= BarArray
[0];
1179 if (!(CurrentBar
& ~PCI_ADDRESS_IO_SPACE
))
1181 /* Fail this descriptor */
1182 ResourceDescriptor
->Type
= CmResourceTypeNull
;
1186 /* Set default flag and clear high words */
1187 ResourceDescriptor
->Flags
= 0;
1188 ResourceDescriptor
->u
.Generic
.MaximumAddress
.HighPart
= 0;
1189 ResourceDescriptor
->u
.Generic
.MinimumAddress
.LowPart
= 0;
1190 ResourceDescriptor
->u
.Generic
.MinimumAddress
.HighPart
= 0;
1192 /* Check for ROM Address */
1195 /* Clean up the BAR to get just the address */
1196 CurrentBar
&= PCI_ADDRESS_ROM_ADDRESS_MASK
;
1199 /* Invalid ar, fail this descriptor */
1200 ResourceDescriptor
->Type
= CmResourceTypeNull
;
1204 /* ROM Addresses are always read only */
1205 ResourceDescriptor
->Flags
= CM_RESOURCE_MEMORY_READ_ONLY
;
1208 /* Compute the length, assume it's the alignment for now */
1209 BarLength
= PciGetLengthFromBar(CurrentBar
);
1210 ResourceDescriptor
->u
.Generic
.Length
= BarLength
;
1211 ResourceDescriptor
->u
.Generic
.Alignment
= BarLength
;
1213 /* Check what kind of BAR this is */
1214 if (CurrentBar
& PCI_ADDRESS_IO_SPACE
)
1216 /* Use correct mask to decode the address */
1217 BarMask
= PCI_ADDRESS_IO_ADDRESS_MASK
;
1219 /* Set this as an I/O Port descriptor */
1220 ResourceDescriptor
->Type
= CmResourceTypePort
;
1221 ResourceDescriptor
->Flags
= CM_RESOURCE_PORT_IO
;
1225 /* Use correct mask to decode the address */
1226 BarMask
= PCI_ADDRESS_MEMORY_ADDRESS_MASK
;
1228 /* Set this as a memory descriptor */
1229 ResourceDescriptor
->Type
= CmResourceTypeMemory
;
1231 /* Check if it's 64-bit or 20-bit decode */
1232 if ((CurrentBar
& PCI_ADDRESS_MEMORY_TYPE_MASK
) == PCI_TYPE_64BIT
)
1234 /* The next BAR has the high word, read it */
1235 ResourceDescriptor
->u
.Port
.MaximumAddress
.HighPart
= BarArray
[1];
1238 else if ((CurrentBar
& PCI_ADDRESS_MEMORY_TYPE_MASK
) == PCI_TYPE_20BIT
)
1240 /* Use the correct mask to decode the address */
1241 BarMask
= ~0xFFF0000F;
1244 /* Check if the BAR is listed as prefetchable memory */
1245 if (CurrentBar
& PCI_ADDRESS_MEMORY_PREFETCHABLE
)
1247 /* Mark the descriptor in the same way */
1248 ResourceDescriptor
->Flags
|= CM_RESOURCE_MEMORY_PREFETCHABLE
;
1252 /* Now write down the maximum address based on the base + length */
1253 ResourceDescriptor
->u
.Port
.MaximumAddress
.QuadPart
= (CurrentBar
& BarMask
) +
1256 /* Return if this is a 64-bit BAR, so the loop code knows to skip the next one */
1262 PciDecodeEnable(IN PPCI_PDO_EXTENSION PdoExtension
,
1264 OUT PUSHORT Command
)
1266 USHORT CommandValue
;
1269 * If decodes are being disabled, make sure it's allowed, and in both cases,
1270 * make sure that a hackflag isn't preventing touching the decodes at all.
1272 if (((Enable
) || (PciCanDisableDecodes(PdoExtension
, 0, 0, 0))) &&
1273 !(PdoExtension
->HackFlags
& PCI_HACK_PRESERVE_COMMAND
))
1275 /* Did the caller already have a command word? */
1278 /* Use the caller's */
1279 CommandValue
= *Command
;
1283 /* Otherwise, read the current command */
1284 PciReadDeviceConfig(PdoExtension
,
1286 FIELD_OFFSET(PCI_COMMON_HEADER
, Command
),
1290 /* Turn off decodes by default */
1291 CommandValue
&= ~(PCI_ENABLE_IO_SPACE
|
1292 PCI_ENABLE_MEMORY_SPACE
|
1293 PCI_ENABLE_BUS_MASTER
);
1295 /* If requested, enable the decodes that were enabled at init time */
1296 if (Enable
) CommandValue
|= PdoExtension
->CommandEnables
&
1297 (PCI_ENABLE_IO_SPACE
|
1298 PCI_ENABLE_MEMORY_SPACE
|
1299 PCI_ENABLE_BUS_MASTER
);
1301 /* Update the command word */
1302 PciWriteDeviceConfig(PdoExtension
,
1304 FIELD_OFFSET(PCI_COMMON_HEADER
, Command
),
1311 PciQueryBusInformation(IN PPCI_PDO_EXTENSION PdoExtension
,
1312 IN PPNP_BUS_INFORMATION
* Buffer
)
1314 PPNP_BUS_INFORMATION BusInfo
;
1316 /* Allocate a structure for the bus information */
1317 BusInfo
= ExAllocatePoolWithTag(PagedPool
,
1318 sizeof(PNP_BUS_INFORMATION
),
1320 if (!BusInfo
) return STATUS_INSUFFICIENT_RESOURCES
;
1322 /* Write the correct GUID and bus type identifier, and fill the bus number */
1323 BusInfo
->BusTypeGuid
= GUID_BUS_TYPE_PCI
;
1324 BusInfo
->LegacyBusType
= PCIBus
;
1325 BusInfo
->BusNumber
= PdoExtension
->ParentFdoExtension
->BaseBus
;
1326 return STATUS_SUCCESS
;
1331 PciDetermineSlotNumber(IN PPCI_PDO_EXTENSION PdoExtension
,
1332 OUT PULONG SlotNumber
)
1334 PPCI_FDO_EXTENSION ParentExtension
;
1337 PSLOT_INFO SlotInfo
;
1339 /* Check if a $PIR from the BIOS is used (legacy IRQ routing) */
1340 ParentExtension
= PdoExtension
->ParentFdoExtension
;
1341 DPRINT1("Slot lookup for %d.%d.%d\n",
1342 ParentExtension
? ParentExtension
->BaseBus
: -1,
1343 PdoExtension
->Slot
.u
.bits
.DeviceNumber
,
1344 PdoExtension
->Slot
.u
.bits
.FunctionNumber
);
1345 if ((PciIrqRoutingTable
) && (ParentExtension
))
1347 /* Read every slot information entry */
1348 SlotInfo
= &PciIrqRoutingTable
->Slot
[0];
1349 DPRINT1("PIR$ %p is %lx bytes, slot 0 is at: %lx\n",
1350 PciIrqRoutingTable
, PciIrqRoutingTable
->TableSize
, SlotInfo
);
1351 while (SlotInfo
< (PSLOT_INFO
)((ULONG_PTR
)PciIrqRoutingTable
+
1352 PciIrqRoutingTable
->TableSize
))
1354 DPRINT1("Slot Info: %d.%d->#%d\n",
1355 SlotInfo
->BusNumber
,
1356 SlotInfo
->DeviceNumber
,
1357 SlotInfo
->SlotNumber
);
1359 /* Check if this slot information matches the PDO being queried */
1360 if ((ParentExtension
->BaseBus
== SlotInfo
->BusNumber
) &&
1361 (PdoExtension
->Slot
.u
.bits
.DeviceNumber
== SlotInfo
->DeviceNumber
>> 3) &&
1362 (SlotInfo
->SlotNumber
))
1364 /* We found it, return it and return success */
1365 *SlotNumber
= SlotInfo
->SlotNumber
;
1366 return STATUS_SUCCESS
;
1369 /* Try the next slot */
1374 /* Otherwise, grab the parent FDO and check if it's the root */
1375 if (PCI_IS_ROOT_FDO(ParentExtension
))
1377 /* The root FDO doesn't have a slot number */
1378 Status
= STATUS_UNSUCCESSFUL
;
1382 /* Otherwise, query the slot/UI address/number as a device property */
1383 Status
= IoGetDeviceProperty(ParentExtension
->PhysicalDeviceObject
,
1384 DevicePropertyUINumber
,
1390 /* Return the status of this endeavour */
1396 PciGetDeviceCapabilities(IN PDEVICE_OBJECT DeviceObject
,
1397 IN OUT PDEVICE_CAPABILITIES DeviceCapability
)
1402 PDEVICE_OBJECT AttachedDevice
;
1403 PIO_STACK_LOCATION IoStackLocation
;
1404 IO_STATUS_BLOCK IoStatusBlock
;
1407 /* Zero out capabilities and set undefined values to start with */
1408 RtlZeroMemory(DeviceCapability
, sizeof(DEVICE_CAPABILITIES
));
1409 DeviceCapability
->Size
= sizeof(DEVICE_CAPABILITIES
);
1410 DeviceCapability
->Version
= 1;
1411 DeviceCapability
->Address
= -1;
1412 DeviceCapability
->UINumber
= -1;
1414 /* Build the wait event for the IOCTL */
1415 KeInitializeEvent(&Event
, SynchronizationEvent
, FALSE
);
1417 /* Find the device the PDO is attached to */
1418 AttachedDevice
= IoGetAttachedDeviceReference(DeviceObject
);
1420 /* And build an IRP for it */
1421 Irp
= IoBuildSynchronousFsdRequest(IRP_MJ_PNP
,
1430 /* The IRP failed, fail the request as well */
1431 ObDereferenceObject(AttachedDevice
);
1432 return STATUS_INSUFFICIENT_RESOURCES
;
1435 /* Set default status */
1436 Irp
->IoStatus
.Information
= 0;
1437 Irp
->IoStatus
.Status
= STATUS_NOT_SUPPORTED
;
1439 /* Get a stack location in this IRP */
1440 IoStackLocation
= IoGetNextIrpStackLocation(Irp
);
1441 ASSERT(IoStackLocation
);
1443 /* Initialize it as a query capabilities IRP, with no completion routine */
1444 RtlZeroMemory(IoStackLocation
, sizeof(IO_STACK_LOCATION
));
1445 IoStackLocation
->MajorFunction
= IRP_MJ_PNP
;
1446 IoStackLocation
->MinorFunction
= IRP_MN_QUERY_CAPABILITIES
;
1447 IoStackLocation
->Parameters
.DeviceCapabilities
.Capabilities
= DeviceCapability
;
1448 IoSetCompletionRoutine(Irp
, NULL
, NULL
, FALSE
, FALSE
, FALSE
);
1450 /* Send the IOCTL to the driver */
1451 Status
= IoCallDriver(AttachedDevice
, Irp
);
1452 if (Status
== STATUS_PENDING
)
1454 /* Wait for a response and update the actual status */
1455 KeWaitForSingleObject(&Event
,
1460 Status
= Irp
->IoStatus
.Status
;
1463 /* Done, dereference the attached device and return the final result */
1464 ObDereferenceObject(AttachedDevice
);
1470 PciQueryPowerCapabilities(IN PPCI_PDO_EXTENSION PdoExtension
,
1471 IN PDEVICE_CAPABILITIES DeviceCapability
)
1473 PDEVICE_OBJECT DeviceObject
;
1475 DEVICE_CAPABILITIES AttachedCaps
;
1476 DEVICE_POWER_STATE NewPowerState
, DevicePowerState
, DeviceWakeLevel
, DeviceWakeState
;
1477 SYSTEM_POWER_STATE SystemWakeState
, DeepestWakeState
, CurrentState
;
1479 /* Nothing is known at first */
1480 DeviceWakeState
= PowerDeviceUnspecified
;
1481 SystemWakeState
= DeepestWakeState
= PowerSystemUnspecified
;
1483 /* Get the PCI capabilities for the parent PDO */
1484 DeviceObject
= PdoExtension
->ParentFdoExtension
->PhysicalDeviceObject
;
1485 Status
= PciGetDeviceCapabilities(DeviceObject
, &AttachedCaps
);
1486 ASSERT(NT_SUCCESS(Status
));
1487 if (!NT_SUCCESS(Status
)) return Status
;
1489 /* Check if there's not an existing device state for S0 */
1490 if (!AttachedCaps
.DeviceState
[PowerSystemWorking
])
1492 /* Set D0<->S0 mapping */
1493 AttachedCaps
.DeviceState
[PowerSystemWorking
] = PowerDeviceD0
;
1496 /* Check if there's not an existing device state for S3 */
1497 if (!AttachedCaps
.DeviceState
[PowerSystemShutdown
])
1499 /* Set D3<->S3 mapping */
1500 AttachedCaps
.DeviceState
[PowerSystemShutdown
] = PowerDeviceD3
;
1503 /* Check for a PDO with broken, or no, power capabilities */
1504 if (PdoExtension
->HackFlags
& PCI_HACK_NO_PM_CAPS
)
1506 /* Unknown wake device states */
1507 DeviceCapability
->DeviceWake
= PowerDeviceUnspecified
;
1508 DeviceCapability
->SystemWake
= PowerSystemUnspecified
;
1510 /* No device state support */
1511 DeviceCapability
->DeviceD1
= FALSE
;
1512 DeviceCapability
->DeviceD2
= FALSE
;
1514 /* No waking from any low-power device state is supported */
1515 DeviceCapability
->WakeFromD0
= FALSE
;
1516 DeviceCapability
->WakeFromD1
= FALSE
;
1517 DeviceCapability
->WakeFromD2
= FALSE
;
1518 DeviceCapability
->WakeFromD3
= FALSE
;
1520 /* For the rest, copy whatever the parent PDO had */
1521 RtlCopyMemory(DeviceCapability
->DeviceState
,
1522 AttachedCaps
.DeviceState
,
1523 sizeof(DeviceCapability
->DeviceState
));
1524 return STATUS_SUCCESS
;
1527 /* The PCI Device has power capabilities, so read which ones are supported */
1528 DeviceCapability
->DeviceD1
= PdoExtension
->PowerCapabilities
.Support
.D1
;
1529 DeviceCapability
->DeviceD2
= PdoExtension
->PowerCapabilities
.Support
.D2
;
1530 DeviceCapability
->WakeFromD0
= PdoExtension
->PowerCapabilities
.Support
.PMED0
;
1531 DeviceCapability
->WakeFromD1
= PdoExtension
->PowerCapabilities
.Support
.PMED1
;
1532 DeviceCapability
->WakeFromD2
= PdoExtension
->PowerCapabilities
.Support
.PMED2
;
1534 /* Can the attached device wake from D3? */
1535 if (AttachedCaps
.DeviceWake
!= PowerDeviceD3
)
1537 /* It can't, so check if this PDO supports hot D3 wake */
1538 DeviceCapability
->WakeFromD3
= PdoExtension
->PowerCapabilities
.Support
.PMED3Hot
;
1542 /* It can, is this the root bus? */
1543 if (PCI_IS_ROOT_FDO(PdoExtension
->ParentFdoExtension
))
1545 /* This is the root bus, so just check if it supports hot D3 wake */
1546 DeviceCapability
->WakeFromD3
= PdoExtension
->PowerCapabilities
.Support
.PMED3Hot
;
1550 /* Take the minimums? -- need to check with briang at work */
1555 /* Now loop each system power state to determine its device state mapping */
1556 for (CurrentState
= PowerSystemWorking
;
1557 CurrentState
< PowerSystemMaximum
;
1560 /* Read the current mapping from the attached device */
1561 DevicePowerState
= AttachedCaps
.DeviceState
[CurrentState
];
1562 NewPowerState
= DevicePowerState
;
1564 /* The attachee suports D1, but this PDO does not */
1565 if ((NewPowerState
== PowerDeviceD1
) &&
1566 !(PdoExtension
->PowerCapabilities
.Support
.D1
))
1568 /* Fall back to D2 */
1569 NewPowerState
= PowerDeviceD2
;
1572 /* The attachee supports D2, but this PDO does not */
1573 if ((NewPowerState
== PowerDeviceD2
) &&
1574 !(PdoExtension
->PowerCapabilities
.Support
.D2
))
1576 /* Fall back to D3 */
1577 NewPowerState
= PowerDeviceD3
;
1580 /* Set the mapping based on the best state supported */
1581 DeviceCapability
->DeviceState
[CurrentState
] = NewPowerState
;
1583 /* Check if sleep states are being processed, and a mapping was found */
1584 if ((CurrentState
< PowerSystemHibernate
) &&
1585 (NewPowerState
!= PowerDeviceUnspecified
))
1587 /* Save this state as being the deepest one found until now */
1588 DeepestWakeState
= CurrentState
;
1592 * Finally, check if the computed sleep state is within the states that
1593 * this device can wake the system from, and if it's higher or equal to
1594 * the sleep state mapping that came from the attachee, assuming that it
1595 * had a valid mapping to begin with.
1597 * It this is the case, then make sure that the computed sleep state is
1598 * matched by the device's ability to actually wake from that state.
1600 * For devices that support D3, the PCI device only needs Hot D3 as long
1601 * as the attachee's state is less than D3. Otherwise, if the attachee
1602 * might also be at D3, this would require a Cold D3 wake, so check that
1603 * the device actually support this.
1605 if ((CurrentState
< AttachedCaps
.SystemWake
) &&
1606 (NewPowerState
>= DevicePowerState
) &&
1607 (DevicePowerState
!= PowerDeviceUnspecified
) &&
1608 (((NewPowerState
== PowerDeviceD0
) && (DeviceCapability
->WakeFromD0
)) ||
1609 ((NewPowerState
== PowerDeviceD1
) && (DeviceCapability
->WakeFromD1
)) ||
1610 ((NewPowerState
== PowerDeviceD2
) && (DeviceCapability
->WakeFromD2
)) ||
1611 ((NewPowerState
== PowerDeviceD3
) &&
1612 (PdoExtension
->PowerCapabilities
.Support
.PMED3Hot
) &&
1613 ((DevicePowerState
< PowerDeviceD3
) ||
1614 (PdoExtension
->PowerCapabilities
.Support
.PMED3Cold
)))))
1616 /* The mapping is valid, so this will be the lowest wake state */
1617 SystemWakeState
= CurrentState
;
1618 DeviceWakeState
= NewPowerState
;
1622 /* Read the current wake level */
1623 DeviceWakeLevel
= PdoExtension
->PowerState
.DeviceWakeLevel
;
1625 /* Check if the attachee's wake levels are valid, and the PDO's is higher */
1626 if ((AttachedCaps
.SystemWake
!= PowerSystemUnspecified
) &&
1627 (AttachedCaps
.DeviceWake
!= PowerDeviceUnspecified
) &&
1628 (DeviceWakeLevel
!= PowerDeviceUnspecified
) &&
1629 (DeviceWakeLevel
>= AttachedCaps
.DeviceWake
))
1631 /* Inherit the system wake from the attachee, and this PDO's wake level */
1632 DeviceCapability
->SystemWake
= AttachedCaps
.SystemWake
;
1633 DeviceCapability
->DeviceWake
= DeviceWakeLevel
;
1635 /* Now check if the wake level is D0, but the PDO doesn't support it */
1636 if ((DeviceCapability
->DeviceWake
== PowerDeviceD0
) &&
1637 !(DeviceCapability
->WakeFromD0
))
1640 DeviceCapability
->DeviceWake
= PowerDeviceD1
;
1643 /* Now check if the wake level is D1, but the PDO doesn't support it */
1644 if ((DeviceCapability
->DeviceWake
== PowerDeviceD1
) &&
1645 !(DeviceCapability
->WakeFromD1
))
1648 DeviceCapability
->DeviceWake
= PowerDeviceD2
;
1651 /* Now check if the wake level is D2, but the PDO doesn't support it */
1652 if ((DeviceCapability
->DeviceWake
== PowerDeviceD2
) &&
1653 !(DeviceCapability
->WakeFromD2
))
1656 DeviceCapability
->DeviceWake
= PowerDeviceD3
;
1659 /* Now check if the wake level is D3, but the PDO doesn't support it */
1660 if ((DeviceCapability
->DeviceWake
== PowerDeviceD3
) &&
1661 !(DeviceCapability
->WakeFromD3
))
1663 /* Then no valid wake state exists */
1664 DeviceCapability
->DeviceWake
= PowerDeviceUnspecified
;
1665 DeviceCapability
->SystemWake
= PowerSystemUnspecified
;
1668 /* Check if no valid wake state was found */
1669 if ((DeviceCapability
->DeviceWake
== PowerDeviceUnspecified
) ||
1670 (DeviceCapability
->SystemWake
== PowerSystemUnspecified
))
1672 /* Check if one was computed earlier */
1673 if ((SystemWakeState
!= PowerSystemUnspecified
) &&
1674 (DeviceWakeState
!= PowerDeviceUnspecified
))
1676 /* Use the wake state that had been computed earlier */
1677 DeviceCapability
->DeviceWake
= DeviceWakeState
;
1678 DeviceCapability
->SystemWake
= SystemWakeState
;
1680 /* If that state was D3, then the device supports Hot/Cold D3 */
1681 if (DeviceWakeState
== PowerDeviceD3
) DeviceCapability
->WakeFromD3
= TRUE
;
1686 * Finally, check for off states (lower than S3, such as hibernate) and
1687 * make sure that the device both supports waking from D3 as well as
1688 * supports a Cold wake
1690 if ((DeviceCapability
->SystemWake
> PowerSystemSleeping3
) &&
1691 ((DeviceCapability
->DeviceWake
!= PowerDeviceD3
) ||
1692 !(PdoExtension
->PowerCapabilities
.Support
.PMED3Cold
)))
1694 /* It doesn't, so pick the computed lowest wake state from earlier */
1695 DeviceCapability
->SystemWake
= DeepestWakeState
;
1698 /* Set the PCI Specification mandated maximum latencies for transitions */
1699 DeviceCapability
->D1Latency
= 0;
1700 DeviceCapability
->D2Latency
= 2;
1701 DeviceCapability
->D3Latency
= 100;
1704 ASSERT(DeviceCapability
->DeviceState
[PowerSystemWorking
] == PowerDeviceD0
);
1708 /* No valid sleep states, no latencies to worry about */
1709 DeviceCapability
->D1Latency
= 0;
1710 DeviceCapability
->D2Latency
= 0;
1711 DeviceCapability
->D3Latency
= 0;
1714 /* This function always succeeds, even without power management support */
1715 return STATUS_SUCCESS
;
1720 PciQueryCapabilities(IN PPCI_PDO_EXTENSION PdoExtension
,
1721 IN OUT PDEVICE_CAPABILITIES DeviceCapability
)
1725 /* A PDO ID is never unique, and its address is its function and device */
1726 DeviceCapability
->UniqueID
= FALSE
;
1727 DeviceCapability
->Address
= PdoExtension
->Slot
.u
.bits
.FunctionNumber
|
1728 (PdoExtension
->Slot
.u
.bits
.DeviceNumber
<< 16);
1730 /* Check for host bridges */
1731 if ((PdoExtension
->BaseClass
== PCI_CLASS_BRIDGE_DEV
) &&
1732 (PdoExtension
->SubClass
== PCI_SUBCLASS_BR_HOST
))
1734 /* Raw device opens to a host bridge are acceptable */
1735 DeviceCapability
->RawDeviceOK
= TRUE
;
1739 /* Otherwise, other PDOs cannot be directly opened */
1740 DeviceCapability
->RawDeviceOK
= FALSE
;
1743 /* PCI PDOs are pretty fixed things */
1744 DeviceCapability
->LockSupported
= FALSE
;
1745 DeviceCapability
->EjectSupported
= FALSE
;
1746 DeviceCapability
->Removable
= FALSE
;
1747 DeviceCapability
->DockDevice
= FALSE
;
1749 /* The slot number is stored as a device property, go query it */
1750 PciDetermineSlotNumber(PdoExtension
, &DeviceCapability
->UINumber
);
1752 /* Finally, query and power capabilities and convert them for PnP usage */
1753 Status
= PciQueryPowerCapabilities(PdoExtension
, DeviceCapability
);
1755 /* Dump the capabilities if it all worked, and return the status */
1756 if (NT_SUCCESS(Status
)) PciDebugDumpQueryCapabilities(DeviceCapability
);