From 24115e44926b33c763f81026690f20efd913daf2 Mon Sep 17 00:00:00 2001 From: ydong10 Date: Fri, 17 Sep 2010 10:42:10 +0000 Subject: [PATCH] RefRefine soma code to make code run safely. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10885 6f19259b-4bc3-4df7-8a09-765794883524 --- PcAtChipsetPkg/8254TimerDxe/Timer.c | 10 +- PcAtChipsetPkg/8254TimerDxe/Timer.h | 2 +- .../8259InterruptControllerDxe/8259.c | 8 +- .../8259InterruptControllerDxe/8259.h | 100 +++++++ .../Bus/Pci/IdeControllerDxe/ComponentName.c | 2 +- .../Bus/Pci/IdeControllerDxe/IdeController.h | 10 +- PcAtChipsetPkg/IsaAcpiDxe/PcatIsaAcpi.c | 2 +- PcAtChipsetPkg/KbcResetDxe/ResetEntry.c | 2 +- .../Library/SerialIoLib/SerialPortLib.c | 4 +- .../PcatRealTimeClockRuntimeDxe/PcRtc.c | 32 +-- .../PcatRealTimeClockRuntimeDxe/PcRtc.h | 32 +-- .../PciHostBridgeDxe/PciHostBridge.c | 142 +++++----- .../PciHostBridgeDxe/PciHostBridge.h | 257 +++++++++++++++++- .../PciHostBridgeDxe/PciRootBridgeIo.c | 74 ++--- 14 files changed, 507 insertions(+), 170 deletions(-) diff --git a/PcAtChipsetPkg/8254TimerDxe/Timer.c b/PcAtChipsetPkg/8254TimerDxe/Timer.c index b57ccda727..da7d6af578 100644 --- a/PcAtChipsetPkg/8254TimerDxe/Timer.c +++ b/PcAtChipsetPkg/8254TimerDxe/Timer.c @@ -69,7 +69,7 @@ SetPitCount ( } /** - 8254 Timer #0 Interrupt Handler + 8254 Timer #0 Interrupt Handler. @param InterruptType The type of interrupt that occured @param SystemContext A pointer to the system context when the interrupt occured @@ -87,9 +87,9 @@ TimerInterruptHandler ( mLegacy8259->EndOfInterrupt (mLegacy8259, Efi8259Irq0); - if (mTimerNotifyFunction) { + if (mTimerNotifyFunction != NULL) { // - // BUGBUG : This does not handle missed timer interrupts + // @bug : This does not handle missed timer interrupts // mTimerNotifyFunction (mTimerPeriod); } @@ -311,9 +311,9 @@ TimerDriverGenerateSoftInterrupt ( // OriginalTPL = gBS->RaiseTPL (TPL_HIGH_LEVEL); - if (mTimerNotifyFunction) { + if (mTimerNotifyFunction != NULL) { // - // BUGBUG : This does not handle missed timer interrupts + // @bug : This does not handle missed timer interrupts // mTimerNotifyFunction (mTimerPeriod); } diff --git a/PcAtChipsetPkg/8254TimerDxe/Timer.h b/PcAtChipsetPkg/8254TimerDxe/Timer.h index 53de04fb7e..26935d8775 100644 --- a/PcAtChipsetPkg/8254TimerDxe/Timer.h +++ b/PcAtChipsetPkg/8254TimerDxe/Timer.h @@ -78,7 +78,7 @@ TimerDriverInitialize ( @param This The EFI_TIMER_ARCH_PROTOCOL instance. - @param TimerPeriod The rate to program the timer interrupt in 100 nS units. If + @param NotifyFunction The rate to program the timer interrupt in 100 nS units. If the timer hardware is not programmable, then EFI_UNSUPPORTED is returned. If the timer is programmable, then the timer period will be rounded up to the nearest timer period that is supported diff --git a/PcAtChipsetPkg/8259InterruptControllerDxe/8259.c b/PcAtChipsetPkg/8259InterruptControllerDxe/8259.c index 7b9067f89a..3defe0ed08 100644 --- a/PcAtChipsetPkg/8259InterruptControllerDxe/8259.c +++ b/PcAtChipsetPkg/8259InterruptControllerDxe/8259.c @@ -17,7 +17,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. // // Global for the Legacy 8259 Protocol that is produced by this driver // -EFI_LEGACY_8259_PROTOCOL m8259 = { +EFI_LEGACY_8259_PROTOCOL mInterrupt8259 = { Interrupt8259SetVectorBase, Interrupt8259GetMask, Interrupt8259SetMask, @@ -592,13 +592,13 @@ Install8259 ( // Clear all pending interrupt // for (Irq = Efi8259Irq0; Irq <= Efi8259Irq15; Irq++) { - Interrupt8259EndOfInterrupt (&m8259, Irq); + Interrupt8259EndOfInterrupt (&mInterrupt8259, Irq); } // // Set the 8259 Master base to 0x68 and the 8259 Slave base to 0x70 // - Status = Interrupt8259SetVectorBase (&m8259, PROTECTED_MODE_BASE_VECTOR_MASTER, PROTECTED_MODE_BASE_VECTOR_SLAVE); + Status = Interrupt8259SetVectorBase (&mInterrupt8259, PROTECTED_MODE_BASE_VECTOR_MASTER, PROTECTED_MODE_BASE_VECTOR_SLAVE); // // Set all 8259 interrupts to edge triggered and disabled @@ -612,7 +612,7 @@ Install8259 ( &m8259Handle, &gEfiLegacy8259ProtocolGuid, EFI_NATIVE_INTERFACE, - &m8259 + &mInterrupt8259 ); return Status; } diff --git a/PcAtChipsetPkg/8259InterruptControllerDxe/8259.h b/PcAtChipsetPkg/8259InterruptControllerDxe/8259.h index fff068a0df..0d4c1e8223 100644 --- a/PcAtChipsetPkg/8259InterruptControllerDxe/8259.h +++ b/PcAtChipsetPkg/8259InterruptControllerDxe/8259.h @@ -47,7 +47,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. // Protocol Function Prototypes +/** + Sets the base address for the 8259 master and slave PICs. + @param[in] This Indicates the EFI_LEGACY_8259_PROTOCOL instance. + @param[in] MasterBase Interrupt vectors for IRQ0-IRQ7. + @param[in] SlaveBase Interrupt vectors for IRQ8-IRQ15. + + @retval EFI_SUCCESS The 8259 PIC was programmed successfully. + @retval EFI_DEVICE_ERROR There was an error while writing to the 8259 PIC. + +**/ EFI_STATUS EFIAPI Interrupt8259SetVectorBase ( @@ -56,6 +66,19 @@ Interrupt8259SetVectorBase ( IN UINT8 SlaveBase ); +/** + Gets the current 16-bit real mode and 32-bit protected-mode IRQ masks. + + @param[in] This Indicates the EFI_LEGACY_8259_PROTOCOL instance. + @param[out] LegacyMask 16-bit mode interrupt mask for IRQ0-IRQ15. + @param[out] LegacyEdgeLevel 16-bit mode edge/level mask for IRQ-IRQ15. + @param[out] ProtectedMask 32-bit mode interrupt mask for IRQ0-IRQ15. + @param[out] ProtectedEdgeLevel 32-bit mode edge/level mask for IRQ0-IRQ15. + + @retval EFI_SUCCESS The 8259 PIC was programmed successfully. + @retval EFI_DEVICE_ERROR There was an error while reading the 8259 PIC. + +**/ EFI_STATUS EFIAPI Interrupt8259GetMask ( @@ -66,6 +89,19 @@ Interrupt8259GetMask ( OUT UINT16 *ProtectedEdgeLevel OPTIONAL ); +/** + Sets the current 16-bit real mode and 32-bit protected-mode IRQ masks. + + @param[in] This Indicates the EFI_LEGACY_8259_PROTOCOL instance. + @param[in] LegacyMask 16-bit mode interrupt mask for IRQ0-IRQ15. + @param[in] LegacyEdgeLevel 16-bit mode edge/level mask for IRQ-IRQ15. + @param[in] ProtectedMask 32-bit mode interrupt mask for IRQ0-IRQ15. + @param[in] ProtectedEdgeLevel 32-bit mode edge/level mask for IRQ0-IRQ15. + + @retval EFI_SUCCESS The 8259 PIC was programmed successfully. + @retval EFI_DEVICE_ERROR There was an error while writing the 8259 PIC. + +**/ EFI_STATUS EFIAPI Interrupt8259SetMask ( @@ -76,6 +112,18 @@ Interrupt8259SetMask ( IN UINT16 *ProtectedEdgeLevel OPTIONAL ); +/** + Sets the mode of the PICs. + + @param[in] This Indicates the EFI_LEGACY_8259_PROTOCOL instance. + @param[in] Mode 16-bit real or 32-bit protected mode. + @param[in] Mask The value with which to set the interrupt mask. + @param[in] EdgeLevel The value with which to set the edge/level mask. + + @retval EFI_SUCCESS The mode was set successfully. + @retval EFI_INVALID_PARAMETER The mode was not set. + +**/ EFI_STATUS EFIAPI Interrupt8259SetMode ( @@ -85,6 +133,17 @@ Interrupt8259SetMode ( IN UINT16 *EdgeLevel OPTIONAL ); +/** + Translates the IRQ into a vector. + + @param[in] This Indicates the EFI_LEGACY_8259_PROTOCOL instance. + @param[in] Irq IRQ0-IRQ15. + @param[out] Vector The vector that is assigned to the IRQ. + + @retval EFI_SUCCESS The Vector that matches Irq was returned. + @retval EFI_INVALID_PARAMETER Irq is not valid. + +**/ EFI_STATUS EFIAPI Interrupt8259GetVector ( @@ -93,6 +152,17 @@ Interrupt8259GetVector ( OUT UINT8 *Vector ); +/** + Enables the specified IRQ. + + @param[in] This Indicates the EFI_LEGACY_8259_PROTOCOL instance. + @param[in] Irq IRQ0-IRQ15. + @param[in] LevelTriggered 0 = Edge triggered; 1 = Level triggered. + + @retval EFI_SUCCESS The Irq was enabled on the 8259 PIC. + @retval EFI_INVALID_PARAMETER The Irq is not valid. + +**/ EFI_STATUS EFIAPI Interrupt8259EnableIrq ( @@ -101,6 +171,16 @@ Interrupt8259EnableIrq ( IN BOOLEAN LevelTriggered ); +/** + Disables the specified IRQ. + + @param[in] This Indicates the EFI_LEGACY_8259_PROTOCOL instance. + @param[in] Irq IRQ0-IRQ15. + + @retval EFI_SUCCESS The Irq was disabled on the 8259 PIC. + @retval EFI_INVALID_PARAMETER The Irq is not valid. + +**/ EFI_STATUS EFIAPI Interrupt8259DisableIrq ( @@ -108,6 +188,16 @@ Interrupt8259DisableIrq ( IN EFI_8259_IRQ Irq ); +/** + Reads the PCI configuration space to get the interrupt number that is assigned to the card. + + @param[in] This Indicates the EFI_LEGACY_8259_PROTOCOL instance. + @param[in] PciHandle PCI function for which to return the vector. + @param[out] Vector IRQ number that corresponds to the interrupt line. + + @retval EFI_SUCCESS The interrupt line value was read successfully. + +**/ EFI_STATUS EFIAPI Interrupt8259GetInterruptLine ( @@ -116,6 +206,16 @@ Interrupt8259GetInterruptLine ( OUT UINT8 *Vector ); +/** + Issues the End of Interrupt (EOI) commands to PICs. + + @param[in] This Indicates the EFI_LEGACY_8259_PROTOCOL instance. + @param[in] Irq The interrupt for which to issue the EOI command. + + @retval EFI_SUCCESS The EOI command was issued. + @retval EFI_INVALID_PARAMETER The Irq is not valid. + +**/ EFI_STATUS EFIAPI Interrupt8259EndOfInterrupt ( diff --git a/PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/ComponentName.c b/PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/ComponentName.c index 5e56a62f47..a78bed7572 100644 --- a/PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/ComponentName.c +++ b/PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/ComponentName.c @@ -107,7 +107,7 @@ IdeControllerComponentNameGetDriverName ( @param ControllerHandle The handle of a controller that the driver specified by This is managing. This handle specifies the controller whose name is to be returned. - @param OPTIONAL The handle of the child controller to retrieve the name + @param ChildHandle OPTIONAL The handle of the child controller to retrieve the name of. This is an optional parameter that may be NULL. It will be NULL for device drivers. It will also be NULL for a bus drivers that wish to retrieve the name of the diff --git a/PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/IdeController.h b/PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/IdeController.h index 581361d24f..79763496ee 100644 --- a/PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/IdeController.h +++ b/PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/IdeController.h @@ -12,8 +12,8 @@ **/ -#ifndef _IDE_CONTROLLER_H -#define _IDE_CONTROLLER_H +#ifndef _IDE_CONTROLLER_H_ +#define _IDE_CONTROLLER_H_ #include #include @@ -155,7 +155,7 @@ EFIAPI IdeInitNotifyPhase ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN EFI_IDE_CONTROLLER_ENUM_PHASE Phase, - OUT UINT8 Channel + IN UINT8 Channel ) ; @@ -219,7 +219,7 @@ IdeInitCalculateMode ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN UINT8 Channel, IN UINT8 Device, - IN EFI_ATA_COLLECTIVE_MODE **SupportedModes + OUT EFI_ATA_COLLECTIVE_MODE **SupportedModes ) ; @@ -285,7 +285,7 @@ IdeControllerComponentNameGetDriverName ( @param ControllerHandle The handle of a controller that the driver specified by This is managing. This handle specifies the controller whose name is to be returned. - @param OPTIONAL The handle of the child controller to retrieve the name + @param OPTIONAL ChildHandle The handle of the child controller to retrieve the name of. This is an optional parameter that may be NULL. It will be NULL for device drivers. It will also be NULL for a bus drivers that wish to retrieve the name of the diff --git a/PcAtChipsetPkg/IsaAcpiDxe/PcatIsaAcpi.c b/PcAtChipsetPkg/IsaAcpiDxe/PcatIsaAcpi.c index 468f193955..8e6d8b7f82 100644 --- a/PcAtChipsetPkg/IsaAcpiDxe/PcatIsaAcpi.c +++ b/PcAtChipsetPkg/IsaAcpiDxe/PcatIsaAcpi.c @@ -242,7 +242,7 @@ PcatIsaAcpiDriverBindingStart ( Done: if (EFI_ERROR (Status)) { - if (PciIo) { + if (PciIo != NULL) { PciIo->Attributes ( PciIo, EfiPciIoAttributeOperationDisable, diff --git a/PcAtChipsetPkg/KbcResetDxe/ResetEntry.c b/PcAtChipsetPkg/KbcResetDxe/ResetEntry.c index 0457fe63b5..03b425019d 100644 --- a/PcAtChipsetPkg/KbcResetDxe/ResetEntry.c +++ b/PcAtChipsetPkg/KbcResetDxe/ResetEntry.c @@ -63,7 +63,7 @@ KbcResetSystem ( } /** - Initialize the state information for the Reset Architectural Protocol + Initialize the state information for the Reset Architectural Protocol. @param ImageHandle Handle of the loaded driver @param SystemTable Pointer to the System Table diff --git a/PcAtChipsetPkg/Library/SerialIoLib/SerialPortLib.c b/PcAtChipsetPkg/Library/SerialIoLib/SerialPortLib.c index 3c39f37432..6bf705312d 100644 --- a/PcAtChipsetPkg/Library/SerialIoLib/SerialPortLib.c +++ b/PcAtChipsetPkg/Library/SerialIoLib/SerialPortLib.c @@ -137,7 +137,7 @@ SerialPortWrite ( Result = NumberOfBytes; - while (NumberOfBytes--) { + while ((NumberOfBytes--) != 0) { // // Wait for the serail port to be ready. // @@ -178,7 +178,7 @@ SerialPortRead ( Result = NumberOfBytes; - while (NumberOfBytes--) { + while ((NumberOfBytes--) != 0) { // // Wait for the serail port to be ready. // diff --git a/PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcRtc.c b/PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcRtc.c index 659c01e57a..6c7e0ca6d7 100644 --- a/PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcRtc.c +++ b/PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcRtc.c @@ -382,7 +382,7 @@ PcRtcSetTime ( // Read Register B, and inhibit updates of the RTC // RegisterB.Data = RtcRead (RTC_ADDRESS_REGISTER_B); - RegisterB.Bits.SET = 1; + RegisterB.Bits.Set = 1; RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data); ConvertEfiTimeToRtcTime (&RtcTime, RegisterB, &Century); @@ -398,7 +398,7 @@ PcRtcSetTime ( // // Allow updates of the RTC registers // - RegisterB.Bits.SET = 0; + RegisterB.Bits.Set = 0; RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data); // @@ -488,7 +488,7 @@ PcRtcGetWakeupTime ( // // Get the Time/Date/Daylight Savings values. // - *Enabled = RegisterB.Bits.AIE; + *Enabled = RegisterB.Bits.Aie; if (*Enabled) { Time->Second = RtcRead (RTC_ADDRESS_SECONDS_ALARM); Time->Minute = RtcRead (RTC_ADDRESS_MINUTES_ALARM); @@ -531,7 +531,7 @@ PcRtcGetWakeupTime ( return EFI_DEVICE_ERROR; } - *Pending = RegisterC.Bits.AF; + *Pending = RegisterC.Bits.Af; return EFI_SUCCESS; } @@ -614,7 +614,7 @@ PcRtcSetWakeupTime ( // RegisterB.Data = RtcRead (RTC_ADDRESS_REGISTER_B); - RegisterB.Bits.SET = 1; + RegisterB.Bits.Set = 1; RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data); if (Enable) { @@ -627,15 +627,15 @@ PcRtcSetWakeupTime ( RtcWrite (RTC_ADDRESS_MINUTES_ALARM, RtcTime.Minute); RtcWrite (RTC_ADDRESS_HOURS_ALARM, RtcTime.Hour); - RegisterB.Bits.AIE = 1; + RegisterB.Bits.Aie = 1; } else { - RegisterB.Bits.AIE = 0; + RegisterB.Bits.Aie = 0; } // // Allow updates of the RTC registers // - RegisterB.Bits.SET = 0; + RegisterB.Bits.Set = 0; RtcWrite (RTC_ADDRESS_REGISTER_B, RegisterB.Data); // @@ -707,7 +707,7 @@ ConvertRtcTimeToEfiTime ( Time->Hour = (UINT8) (Time->Hour & 0x7f); - if (RegisterB.Bits.DM == 0) { + if (RegisterB.Bits.Dm == 0) { Time->Year = CheckAndConvertBcd8ToDecimal8 ((UINT8) Time->Year); Time->Month = CheckAndConvertBcd8ToDecimal8 (Time->Month); Time->Day = CheckAndConvertBcd8ToDecimal8 (Time->Day); @@ -728,7 +728,7 @@ ConvertRtcTimeToEfiTime ( // // If time is in 12 hour format, convert it to 24 hour format // - if (RegisterB.Bits.MIL == 0) { + if (RegisterB.Bits.Mil == 0) { if (IsPM && Time->Hour < 12) { Time->Hour = (UINT8) (Time->Hour + 12); } @@ -764,7 +764,7 @@ RtcWaitToUpdate ( // RegisterD.Data = RtcRead (RTC_ADDRESS_REGISTER_D); - if (RegisterD.Bits.VRT == 0) { + if (RegisterD.Bits.Vrt == 0) { return EFI_DEVICE_ERROR; } // @@ -772,14 +772,14 @@ RtcWaitToUpdate ( // Timeout = (Timeout / 10) + 1; RegisterA.Data = RtcRead (RTC_ADDRESS_REGISTER_A); - while (RegisterA.Bits.UIP == 1 && Timeout > 0) { + while (RegisterA.Bits.Uip == 1 && Timeout > 0) { MicroSecondDelay (10); RegisterA.Data = RtcRead (RTC_ADDRESS_REGISTER_A); Timeout--; } RegisterD.Data = RtcRead (RTC_ADDRESS_REGISTER_D); - if (Timeout == 0 || RegisterD.Bits.VRT == 0) { + if (Timeout == 0 || RegisterD.Bits.Vrt == 0) { return EFI_DEVICE_ERROR; } @@ -914,7 +914,7 @@ ConvertEfiTimeToRtcTime ( // // Adjust hour field if RTC is in 12 hour mode // - if (RegisterB.Bits.MIL == 0) { + if (RegisterB.Bits.Mil == 0) { if (Time->Hour < 12) { IsPM = FALSE; } @@ -932,7 +932,7 @@ ConvertEfiTimeToRtcTime ( Time->Year = (UINT16) (Time->Year % 100); - if (RegisterB.Bits.DM == 0) { + if (RegisterB.Bits.Dm == 0) { Time->Year = DecimalToBcd8 ((UINT8) Time->Year); Time->Month = DecimalToBcd8 (Time->Month); Time->Day = DecimalToBcd8 (Time->Day); @@ -943,7 +943,7 @@ ConvertEfiTimeToRtcTime ( // // If we are in 12 hour mode and PM is set, then set bit 7 of the Hour field. // - if (RegisterB.Bits.MIL == 0 && IsPM) { + if (RegisterB.Bits.Mil == 0 && IsPM) { Time->Hour = (UINT8) (Time->Hour | 0x80); } } diff --git a/PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcRtc.h b/PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcRtc.h index 85492f7b59..d38c8e1464 100644 --- a/PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcRtc.h +++ b/PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcRtc.h @@ -84,9 +84,9 @@ typedef struct { // Register A // typedef struct { - UINT8 RS : 4; // Rate Selection Bits - UINT8 DV : 3; // Divisor - UINT8 UIP : 1; // Update in progress + UINT8 Rs : 4; // Rate Selection Bits + UINT8 Dv : 3; // Divisor + UINT8 Uip : 1; // Update in progress } RTC_REGISTER_A_BITS; typedef union { @@ -98,14 +98,14 @@ typedef union { // Register B // typedef struct { - UINT8 DSE : 1; // 0 - Daylight saving disabled 1 - Daylight savings enabled - UINT8 MIL : 1; // 0 - 12 hour mode 1 - 24 hour mode - UINT8 DM : 1; // 0 - BCD Format 1 - Binary Format - UINT8 SQWE : 1; // 0 - Disable SQWE output 1 - Enable SQWE output - UINT8 UIE : 1; // 0 - Update INT disabled 1 - Update INT enabled - UINT8 AIE : 1; // 0 - Alarm INT disabled 1 - Alarm INT Enabled - UINT8 PIE : 1; // 0 - Periodic INT disabled 1 - Periodic INT Enabled - UINT8 SET : 1; // 0 - Normal operation. 1 - Updates inhibited + UINT8 Dse : 1; // 0 - Daylight saving disabled 1 - Daylight savings enabled + UINT8 Mil : 1; // 0 - 12 hour mode 1 - 24 hour mode + UINT8 Dm : 1; // 0 - BCD Format 1 - Binary Format + UINT8 Sqwe : 1; // 0 - Disable SQWE output 1 - Enable SQWE output + UINT8 Uie : 1; // 0 - Update INT disabled 1 - Update INT enabled + UINT8 Aie : 1; // 0 - Alarm INT disabled 1 - Alarm INT Enabled + UINT8 Pie : 1; // 0 - Periodic INT disabled 1 - Periodic INT Enabled + UINT8 Set : 1; // 0 - Normal operation. 1 - Updates inhibited } RTC_REGISTER_B_BITS; typedef union { @@ -118,10 +118,10 @@ typedef union { // typedef struct { UINT8 Reserved : 4; // Read as zero. Can not be written. - UINT8 UF : 1; // Update End Interrupt Flag - UINT8 AF : 1; // Alarm Interrupt Flag - UINT8 PF : 1; // Periodic Interrupt Flag - UINT8 IRQF : 1; // Iterrupt Request Flag = PF & PIE | AF & AIE | UF & UIE + UINT8 Uf : 1; // Update End Interrupt Flag + UINT8 Af : 1; // Alarm Interrupt Flag + UINT8 Pf : 1; // Periodic Interrupt Flag + UINT8 Irqf : 1; // Iterrupt Request Flag = PF & PIE | AF & AIE | UF & UIE } RTC_REGISTER_C_BITS; typedef union { @@ -134,7 +134,7 @@ typedef union { // typedef struct { UINT8 Reserved : 7; // Read as zero. Can not be written. - UINT8 VRT : 1; // Valid RAM and Time + UINT8 Vrt : 1; // Valid RAM and Time } RTC_REGISTER_D_BITS; typedef union { diff --git a/PcAtChipsetPkg/PciHostBridgeDxe/PciHostBridge.c b/PcAtChipsetPkg/PciHostBridgeDxe/PciHostBridge.c index b05b415349..27a54461cd 100644 --- a/PcAtChipsetPkg/PciHostBridgeDxe/PciHostBridge.c +++ b/PcAtChipsetPkg/PciHostBridgeDxe/PciHostBridge.c @@ -67,6 +67,7 @@ PCI_HOST_BRIDGE_INSTANCE mPciHostBridgeInstanceTemplate = { // // Implementation // + /** Entry point of this driver @@ -200,7 +201,7 @@ InitializePciHostBridge ( required here. This notification can be used to perform any chipsetspecific programming. - @param[in] PciResAlloc The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL + @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL @param[in] Phase The phase during enumeration @retval EFI_NOT_READY This phase cannot be entered at this time. For example, this error @@ -309,7 +310,7 @@ NotifyPhase( // // Get the number of '1' in Alignment. // - BitsOfAlignment = HighBitSet64 (RootBridgeInstance->ResAllocNode[Index].Alignment) + 1; + BitsOfAlignment = (UINTN) (HighBitSet64 (RootBridgeInstance->ResAllocNode[Index].Alignment) + 1); switch (Index) { @@ -485,7 +486,7 @@ NotifyPhase( For D945 implementation, there is only one root bridge in PCI host bridge. @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL - @param[in][out] RootBridgeHandle Returns the device handle of the next PCI root bridge. + @param[in, out] RootBridgeHandle Returns the device handle of the next PCI root bridge. @retval EFI_SUCCESS If parameter RootBridgeHandle = NULL, then return the first Rootbridge handle of the specific Host bridge and return EFI_SUCCESS. @@ -835,7 +836,7 @@ SubmitResources( PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance; PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance; UINT8 *Temp; - EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *ptr; + EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *Ptr; UINT64 AddrLen; UINT64 Alignment; @@ -862,30 +863,30 @@ SubmitResources( RootBridgeInstance = DRIVER_INSTANCE_FROM_LIST_ENTRY (List); if (RootBridgeHandle == RootBridgeInstance->Handle) { while ( *Temp == 0x8A) { - ptr = (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *) Temp ; + Ptr = (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *) Temp ; // // Check Address Length // - if (ptr->AddrLen > 0xffffffff) { + if (Ptr->AddrLen > 0xffffffff) { return EFI_INVALID_PARAMETER; } // // Check address range alignment // - if (ptr->AddrRangeMax >= 0xffffffff || ptr->AddrRangeMax != (GetPowerOfTwo64 (ptr->AddrRangeMax + 1) - 1)) { + if (Ptr->AddrRangeMax >= 0xffffffff || Ptr->AddrRangeMax != (GetPowerOfTwo64 (Ptr->AddrRangeMax + 1) - 1)) { return EFI_INVALID_PARAMETER; } - switch (ptr->ResType) { + switch (Ptr->ResType) { case 0: // // Check invalid Address Sapce Granularity // - if (ptr->AddrSpaceGranularity != 32) { + if (Ptr->AddrSpaceGranularity != 32) { return EFI_INVALID_PARAMETER; } @@ -893,14 +894,14 @@ SubmitResources( // check the memory resource request is supported by PCI root bridge // if (RootBridgeInstance->RootBridgeAttrib == EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM && - ptr->SpecificFlag == 0x06) { + Ptr->SpecificFlag == 0x06) { return EFI_INVALID_PARAMETER; } - AddrLen = ptr->AddrLen; - Alignment = ptr->AddrRangeMax; - if (ptr->AddrSpaceGranularity == 32) { - if (ptr->SpecificFlag == 0x06) { + AddrLen = Ptr->AddrLen; + Alignment = Ptr->AddrRangeMax; + if (Ptr->AddrSpaceGranularity == 32) { + if (Ptr->SpecificFlag == 0x06) { // // Apply from GCD // @@ -913,8 +914,8 @@ SubmitResources( } } - if (ptr->AddrSpaceGranularity == 64) { - if (ptr->SpecificFlag == 0x06) { + if (Ptr->AddrSpaceGranularity == 64) { + if (Ptr->SpecificFlag == 0x06) { RootBridgeInstance->ResAllocNode[TypePMem64].Status = ResSubmitted; } else { RootBridgeInstance->ResAllocNode[TypeMem64].Status = ResSubmitted; @@ -923,8 +924,8 @@ SubmitResources( break; case 1: - AddrLen = (UINTN)ptr->AddrLen; - Alignment = (UINTN)ptr->AddrRangeMax; + AddrLen = (UINTN) Ptr->AddrLen; + Alignment = (UINTN) Ptr->AddrRangeMax; RootBridgeInstance->ResAllocNode[TypeIo].Length = AddrLen; RootBridgeInstance->ResAllocNode[TypeIo].Alignment = Alignment; RootBridgeInstance->ResAllocNode[TypeIo].Status = ResRequested; @@ -982,7 +983,7 @@ GetProposedResources( UINTN Number; VOID *Buffer; UINT8 *Temp; - EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *ptr; + EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *Ptr; UINT64 ResStatus; Buffer = NULL; @@ -1017,7 +1018,7 @@ GetProposedResources( Temp = Buffer; for (Index = 0; Index < TypeBus; Index ++) { if (RootBridgeInstance->ResAllocNode[Index].Status != ResNone) { - ptr = (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *) Temp ; + Ptr = (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *) Temp ; ResStatus = RootBridgeInstance->ResAllocNode[Index].Status; switch (Index) { @@ -1026,81 +1027,81 @@ GetProposedResources( // // Io // - ptr->Desc = 0x8A; - ptr->Len = 0x2B; - ptr->ResType = 1; - ptr->GenFlag = 0; - ptr->SpecificFlag = 0; - ptr->AddrRangeMin = RootBridgeInstance->ResAllocNode[Index].Base; - ptr->AddrRangeMax = 0; - ptr->AddrTranslationOffset = \ + Ptr->Desc = 0x8A; + Ptr->Len = 0x2B; + Ptr->ResType = 1; + Ptr->GenFlag = 0; + Ptr->SpecificFlag = 0; + Ptr->AddrRangeMin = RootBridgeInstance->ResAllocNode[Index].Base; + Ptr->AddrRangeMax = 0; + Ptr->AddrTranslationOffset = \ (ResStatus == ResAllocated) ? EFI_RESOURCE_SATISFIED : EFI_RESOURCE_LESS; - ptr->AddrLen = RootBridgeInstance->ResAllocNode[Index].Length; + Ptr->AddrLen = RootBridgeInstance->ResAllocNode[Index].Length; break; case TypeMem32: // // Memory 32 // - ptr->Desc = 0x8A; - ptr->Len = 0x2B; - ptr->ResType = 0; - ptr->GenFlag = 0; - ptr->SpecificFlag = 0; - ptr->AddrSpaceGranularity = 32; - ptr->AddrRangeMin = RootBridgeInstance->ResAllocNode[Index].Base; - ptr->AddrRangeMax = 0; - ptr->AddrTranslationOffset = \ + Ptr->Desc = 0x8A; + Ptr->Len = 0x2B; + Ptr->ResType = 0; + Ptr->GenFlag = 0; + Ptr->SpecificFlag = 0; + Ptr->AddrSpaceGranularity = 32; + Ptr->AddrRangeMin = RootBridgeInstance->ResAllocNode[Index].Base; + Ptr->AddrRangeMax = 0; + Ptr->AddrTranslationOffset = \ (ResStatus == ResAllocated) ? EFI_RESOURCE_SATISFIED : EFI_RESOURCE_LESS; - ptr->AddrLen = RootBridgeInstance->ResAllocNode[Index].Length; + Ptr->AddrLen = RootBridgeInstance->ResAllocNode[Index].Length; break; case TypePMem32: // // Prefetch memory 32 // - ptr->Desc = 0x8A; - ptr->Len = 0x2B; - ptr->ResType = 0; - ptr->GenFlag = 0; - ptr->SpecificFlag = 6; - ptr->AddrSpaceGranularity = 32; - ptr->AddrRangeMin = 0; - ptr->AddrRangeMax = 0; - ptr->AddrTranslationOffset = EFI_RESOURCE_NONEXISTENT; - ptr->AddrLen = 0; + Ptr->Desc = 0x8A; + Ptr->Len = 0x2B; + Ptr->ResType = 0; + Ptr->GenFlag = 0; + Ptr->SpecificFlag = 6; + Ptr->AddrSpaceGranularity = 32; + Ptr->AddrRangeMin = 0; + Ptr->AddrRangeMax = 0; + Ptr->AddrTranslationOffset = EFI_RESOURCE_NONEXISTENT; + Ptr->AddrLen = 0; break; case TypeMem64: // // Memory 64 // - ptr->Desc = 0x8A; - ptr->Len = 0x2B; - ptr->ResType = 0; - ptr->GenFlag = 0; - ptr->SpecificFlag = 0; - ptr->AddrSpaceGranularity = 64; - ptr->AddrRangeMin = 0; - ptr->AddrRangeMax = 0; - ptr->AddrTranslationOffset = EFI_RESOURCE_NONEXISTENT; - ptr->AddrLen = 0; + Ptr->Desc = 0x8A; + Ptr->Len = 0x2B; + Ptr->ResType = 0; + Ptr->GenFlag = 0; + Ptr->SpecificFlag = 0; + Ptr->AddrSpaceGranularity = 64; + Ptr->AddrRangeMin = 0; + Ptr->AddrRangeMax = 0; + Ptr->AddrTranslationOffset = EFI_RESOURCE_NONEXISTENT; + Ptr->AddrLen = 0; break; case TypePMem64: // // Prefetch memory 64 // - ptr->Desc = 0x8A; - ptr->Len = 0x2B; - ptr->ResType = 0; - ptr->GenFlag = 0; - ptr->SpecificFlag = 6; - ptr->AddrSpaceGranularity = 64; - ptr->AddrRangeMin = 0; - ptr->AddrRangeMax = 0; - ptr->AddrTranslationOffset = EFI_RESOURCE_NONEXISTENT; - ptr->AddrLen = 0; + Ptr->Desc = 0x8A; + Ptr->Len = 0x2B; + Ptr->ResType = 0; + Ptr->GenFlag = 0; + Ptr->SpecificFlag = 6; + Ptr->AddrSpaceGranularity = 64; + Ptr->AddrRangeMin = 0; + Ptr->AddrRangeMax = 0; + Ptr->AddrTranslationOffset = EFI_RESOURCE_NONEXISTENT; + Ptr->AddrLen = 0; break; }; @@ -1128,7 +1129,6 @@ GetProposedResources( @param RootBridge Point to PCI root bridge. @param PciAddress The specific device PCI address **/ -STATIC VOID UpdateRootBridgeAttributes ( IN PCI_ROOT_BRIDGE_INSTANCE *RootBridge, @@ -1256,7 +1256,7 @@ UpdateRootBridgeAttributes ( EFI_STATUS EFIAPI PreprocessController ( - IN struct _EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This, + IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This, IN EFI_HANDLE RootBridgeHandle, IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS PciAddress, IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase diff --git a/PcAtChipsetPkg/PciHostBridgeDxe/PciHostBridge.h b/PcAtChipsetPkg/PciHostBridgeDxe/PciHostBridge.h index 42a3d591c0..f81982985a 100644 --- a/PcAtChipsetPkg/PciHostBridgeDxe/PciHostBridge.h +++ b/PcAtChipsetPkg/PciHostBridgeDxe/PciHostBridge.h @@ -66,20 +66,75 @@ typedef struct { #define INSTANCE_FROM_RESOURCE_ALLOCATION_THIS(a) \ CR(a, PCI_HOST_BRIDGE_INSTANCE, ResAlloc, PCI_HOST_BRIDGE_SIGNATURE) - -// -// Driver Entry Point -// -EFI_STATUS -EFIAPI -EfiMain ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ); // // HostBridge Resource Allocation interface // + +/** + These are the notifications from the PCI bus driver that it is about to enter a certain + phase of the PCI enumeration process. + + This member function can be used to notify the host bridge driver to perform specific actions, + including any chipset-specific initialization, so that the chipset is ready to enter the next phase. + Eight notification points are defined at this time. See belows: + EfiPciHostBridgeBeginEnumeration Resets the host bridge PCI apertures and internal data + structures. The PCI enumerator should issue this notification + before starting a fresh enumeration process. Enumeration cannot + be restarted after sending any other notification such as + EfiPciHostBridgeBeginBusAllocation. + EfiPciHostBridgeBeginBusAllocation The bus allocation phase is about to begin. No specific action is + required here. This notification can be used to perform any + chipset-specific programming. + EfiPciHostBridgeEndBusAllocation The bus allocation and bus programming phase is complete. No + specific action is required here. This notification can be used to + perform any chipset-specific programming. + EfiPciHostBridgeBeginResourceAllocation + The resource allocation phase is about to begin. No specific + action is required here. This notification can be used to perform + any chipset-specific programming. + EfiPciHostBridgeAllocateResources Allocates resources per previously submitted requests for all the PCI + root bridges. These resource settings are returned on the next call to + GetProposedResources(). Before calling NotifyPhase() with a Phase of + EfiPciHostBridgeAllocateResource, the PCI bus enumerator is responsible + for gathering I/O and memory requests for + all the PCI root bridges and submitting these requests using + SubmitResources(). This function pads the resource amount + to suit the root bridge hardware, takes care of dependencies between + the PCI root bridges, and calls the Global Coherency Domain (GCD) + with the allocation request. In the case of padding, the allocated range + could be bigger than what was requested. + EfiPciHostBridgeSetResources Programs the host bridge hardware to decode previously allocated + resources (proposed resources) for all the PCI root bridges. After the + hardware is programmed, reassigning resources will not be supported. + The bus settings are not affected. + EfiPciHostBridgeFreeResources Deallocates resources that were previously allocated for all the PCI + root bridges and resets the I/O and memory apertures to their initial + state. The bus settings are not affected. If the request to allocate + resources fails, the PCI enumerator can use this notification to + deallocate previous resources, adjust the requests, and retry + allocation. + EfiPciHostBridgeEndResourceAllocation The resource allocation phase is completed. No specific action is + required here. This notification can be used to perform any chipsetspecific + programming. + + @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL + @param[in] Phase The phase during enumeration + + @retval EFI_NOT_READY This phase cannot be entered at this time. For example, this error + is valid for a Phase of EfiPciHostBridgeAllocateResources if + SubmitResources() has not been called for one or more + PCI root bridges before this call + @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. This error is valid + for a Phase of EfiPciHostBridgeSetResources. + @retval EFI_INVALID_PARAMETER Invalid phase parameter + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + This error is valid for a Phase of EfiPciHostBridgeAllocateResources if the + previously submitted resource requests cannot be fulfilled or + were only partially fulfilled. + @retval EFI_SUCCESS The notification was accepted without any errors. + +**/ EFI_STATUS EFIAPI NotifyPhase( @@ -87,6 +142,28 @@ NotifyPhase( IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase ); +/** + Return the device handle of the next PCI root bridge that is associated with this Host Bridge. + + This function is called multiple times to retrieve the device handles of all the PCI root bridges that + are associated with this PCI host bridge. Each PCI host bridge is associated with one or more PCI + root bridges. On each call, the handle that was returned by the previous call is passed into the + interface, and on output the interface returns the device handle of the next PCI root bridge. The + caller can use the handle to obtain the instance of the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL + for that root bridge. When there are no more PCI root bridges to report, the interface returns + EFI_NOT_FOUND. A PCI enumerator must enumerate the PCI root bridges in the order that they + are returned by this function. + For D945 implementation, there is only one root bridge in PCI host bridge. + + @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL + @param[in, out] RootBridgeHandle Returns the device handle of the next PCI root bridge. + + @retval EFI_SUCCESS If parameter RootBridgeHandle = NULL, then return the first Rootbridge handle of the + specific Host bridge and return EFI_SUCCESS. + @retval EFI_NOT_FOUND Can not find the any more root bridge in specific host bridge. + @retval EFI_INVALID_PARAMETER RootBridgeHandle is not an EFI_HANDLE that was + returned on a previous call to GetNextRootBridge(). +**/ EFI_STATUS EFIAPI GetNextRootBridge( @@ -94,6 +171,44 @@ GetNextRootBridge( IN OUT EFI_HANDLE *RootBridgeHandle ); +/** + Returns the allocation attributes of a PCI root bridge. + + The function returns the allocation attributes of a specific PCI root bridge. The attributes can vary + from one PCI root bridge to another. These attributes are different from the decode-related + attributes that are returned by the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.GetAttributes() member function. The + RootBridgeHandle parameter is used to specify the instance of the PCI root bridge. The device + handles of all the root bridges that are associated with this host bridge must be obtained by calling + GetNextRootBridge(). The attributes are static in the sense that they do not change during or + after the enumeration process. The hardware may provide mechanisms to change the attributes on + the fly, but such changes must be completed before EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL is + installed. The permitted values of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ATTRIBUTES are defined in + "Related Definitions" below. The caller uses these attributes to combine multiple resource requests. + For example, if the flag EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM is set, the PCI bus enumerator needs to + include requests for the prefetchable memory in the nonprefetchable memory pool and not request any + prefetchable memory. + Attribute Description + ------------------------------------ ---------------------------------------------------------------------- + EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM If this bit is set, then the PCI root bridge does not support separate + windows for nonprefetchable and prefetchable memory. A PCI bus + driver needs to include requests for prefetchable memory in the + nonprefetchable memory pool. + + EFI_PCI_HOST_BRIDGE_MEM64_DECODE If this bit is set, then the PCI root bridge supports 64-bit memory + windows. If this bit is not set, the PCI bus driver needs to include + requests for a 64-bit memory address in the corresponding 32-bit + memory pool. + + @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL + @param[in] RootBridgeHandle The device handle of the PCI root bridge in which the caller is interested. Type + EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI 2.0 Specification. + @param[out] Attributes The pointer to attribte of root bridge, it is output parameter + + @retval EFI_INVALID_PARAMETER Attribute pointer is NULL + @retval EFI_INVALID_PARAMETER RootBridgehandle is invalid. + @retval EFI_SUCCESS Success to get attribute of interested root bridge. + +**/ EFI_STATUS EFIAPI GetAttributes( @@ -102,6 +217,21 @@ GetAttributes( OUT UINT64 *Attributes ); +/** + Sets up the specified PCI root bridge for the bus enumeration process. + + This member function sets up the root bridge for bus enumeration and returns the PCI bus range + over which the search should be performed in ACPI 2.0 resource descriptor format. + + @param[in] This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance. + @param[in] RootBridgeHandle The PCI Root Bridge to be set up. + @param[out] Configuration Pointer to the pointer to the PCI bus resource descriptor. + + @retval EFI_INVALID_PARAMETER Invalid Root bridge's handle + @retval EFI_OUT_OF_RESOURCES Fail to allocate ACPI resource descriptor tag. + @retval EFI_SUCCESS Sucess to allocate ACPI resource descriptor. + +**/ EFI_STATUS EFIAPI StartBusEnumeration( @@ -110,6 +240,30 @@ StartBusEnumeration( OUT VOID **Configuration ); +/** + Programs the PCI root bridge hardware so that it decodes the specified PCI bus range. + + This member function programs the specified PCI root bridge to decode the bus range that is + specified by the input parameter Configuration. + The bus range information is specified in terms of the ACPI 2.0 resource descriptor format. + + @param[in] This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance + @param[in] RootBridgeHandle The PCI Root Bridge whose bus range is to be programmed + @param[in] Configuration The pointer to the PCI bus resource descriptor + + @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle. + @retval EFI_INVALID_PARAMETER Configuration is NULL. + @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI 2.0 resource descriptor. + @retval EFI_INVALID_PARAMETER Configuration does not include a valid ACPI 2.0 bus resource descriptor. + @retval EFI_INVALID_PARAMETER Configuration includes valid ACPI 2.0 resource descriptors other than + bus descriptors. + @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptors. + @retval EFI_INVALID_PARAMETER "Address Range Minimum" is invalid for this root bridge. + @retval EFI_INVALID_PARAMETER "Address Range Length" is invalid for this root bridge. + @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. + @retval EFI_SUCCESS The bus range for the PCI root bridge was programmed. + +**/ EFI_STATUS EFIAPI SetBusNumbers( @@ -118,6 +272,31 @@ SetBusNumbers( IN VOID *Configuration ); +/** + Submits the I/O and memory resource requirements for the specified PCI root bridge. + + This function is used to submit all the I/O and memory resources that are required by the specified + PCI root bridge. The input parameter Configuration is used to specify the following: + - The various types of resources that are required + - The associated lengths in terms of ACPI 2.0 resource descriptor format + + @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance. + @param[in] RootBridgeHandle The PCI root bridge whose I/O and memory resource requirements are being submitted. + @param[in] Configuration The pointer to the PCI I/O and PCI memory resource descriptor. + + @retval EFI_SUCCESS The I/O and memory resource requests for a PCI root bridge were accepted. + @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle. + @retval EFI_INVALID_PARAMETER Configuration is NULL. + @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI 2.0 resource descriptor. + @retval EFI_INVALID_PARAMETER Configuration includes requests for one or more resource types that are + not supported by this PCI root bridge. This error will happen if the caller + did not combine resources according to Attributes that were returned by + GetAllocAttributes(). + @retval EFI_INVALID_PARAMETER Address Range Maximum" is invalid. + @retval EFI_INVALID_PARAMETER "Address Range Length" is invalid for this PCI root bridge. + @retval EFI_INVALID_PARAMETER "Address Space Granularity" is invalid for this PCI root bridge. + +**/ EFI_STATUS EFIAPI SubmitResources( @@ -126,6 +305,26 @@ SubmitResources( IN VOID *Configuration ); +/** + Returns the proposed resource settings for the specified PCI root bridge. + + This member function returns the proposed resource settings for the specified PCI root bridge. The + proposed resource settings are prepared when NotifyPhase() is called with a Phase of + EfiPciHostBridgeAllocateResources. The output parameter Configuration + specifies the following: + - The various types of resources, excluding bus resources, that are allocated + - The associated lengths in terms of ACPI 2.0 resource descriptor format + + @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance. + @param[in] RootBridgeHandle The PCI root bridge handle. Type EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI 2.0 Specification. + @param[out] Configuration The pointer to the pointer to the PCI I/O and memory resource descriptor. + + @retval EFI_SUCCESS The requested parameters were returned. + @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle. + @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + +**/ EFI_STATUS EFIAPI GetProposedResources( @@ -134,6 +333,33 @@ GetProposedResources( OUT VOID **Configuration ); +/** + Provides the hooks from the PCI bus driver to every PCI controller (device/function) at various + stages of the PCI enumeration process that allow the host bridge driver to preinitialize individual + PCI controllers before enumeration. + + This function is called during the PCI enumeration process. No specific action is expected from this + member function. It allows the host bridge driver to preinitialize individual PCI controllers before + enumeration. + + @param This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance. + @param RootBridgeHandle The associated PCI root bridge handle. Type EFI_HANDLE is defined in + InstallProtocolInterface() in the UEFI 2.0 Specification. + @param PciAddress The address of the PCI device on the PCI bus. This address can be passed to the + EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL member functions to access the PCI + configuration space of the device. See Table 12-1 in the UEFI 2.0 Specification for + the definition of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS. + @param Phase The phase of the PCI device enumeration. + + @retval EFI_SUCCESS The requested parameters were returned. + @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle. + @retval EFI_INVALID_PARAMETER Phase is not a valid phase that is defined in + EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE. + @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. The PCI enumerator should + not enumerate this device, including its child devices if it is a PCI-to-PCI + bridge. + +**/ EFI_STATUS EFIAPI PreprocessController ( @@ -249,7 +475,18 @@ typedef struct { #define DRIVER_INSTANCE_FROM_LIST_ENTRY(a) \ CR(a, PCI_ROOT_BRIDGE_INSTANCE, Link, PCI_ROOT_BRIDGE_SIGNATURE) +/** + + Construct the Pci Root Bridge Io protocol + + @param Protocol Point to protocol instance + @param HostBridgeHandle Handle of host bridge + @param Attri Attribute of host bridge + @param ResAppeture ResourceAppeture for host bridge + + @retval EFI_SUCCESS Success to initialize the Pci Root Bridge. +**/ EFI_STATUS RootBridgeConstructor ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *Protocol, diff --git a/PcAtChipsetPkg/PciHostBridgeDxe/PciRootBridgeIo.c b/PcAtChipsetPkg/PciHostBridgeDxe/PciRootBridgeIo.c index a33836569b..cd39f2bbf7 100644 --- a/PcAtChipsetPkg/PciHostBridgeDxe/PciRootBridgeIo.c +++ b/PcAtChipsetPkg/PciHostBridgeDxe/PciRootBridgeIo.c @@ -145,7 +145,7 @@ RootBridgeIoMemRead ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, - IN OUT VOID *Buffer + OUT VOID *Buffer ); /** @@ -162,7 +162,7 @@ RootBridgeIoMemRead ( responsible for aligning the Address if required. @param[in] Count The number of memory operations to perform. Bytes moved is Width size * Count, starting at Address. - @param[out] Buffer For read operations, the destination buffer to store the results. For + @param[in] Buffer For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. @@ -177,7 +177,7 @@ RootBridgeIoMemWrite ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, - IN OUT VOID *Buffer + IN VOID *Buffer ); /** @@ -185,11 +185,11 @@ RootBridgeIoMemWrite ( @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param[in] Width Signifies the width of the memory operations. - @param[in] Address The base address of the I/O operation. The caller is responsible for + @param[in] UserAddress The base address of the I/O operation. The caller is responsible for aligning the Address if required. @param[in] Count The number of I/O operations to perform. Bytes moved is Width size * Count, starting at Address. - @param[out] Buffer For read operations, the destination buffer to store the results. For + @param[out] UserBuffer For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. @@ -205,7 +205,7 @@ RootBridgeIoIoRead ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 UserAddress, IN UINTN Count, - IN OUT VOID *UserBuffer + OUT VOID *UserBuffer ); /** @@ -213,11 +213,11 @@ RootBridgeIoIoRead ( @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param[in] Width Signifies the width of the memory operations. - @param[in] Address The base address of the I/O operation. The caller is responsible for + @param[in] UserAddress The base address of the I/O operation. The caller is responsible for aligning the Address if required. @param[in] Count The number of I/O operations to perform. Bytes moved is Width size * Count, starting at Address. - @param[out] Buffer For read operations, the destination buffer to store the results. For + @param[in] UserBuffer For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. @@ -233,7 +233,7 @@ RootBridgeIoIoWrite ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 UserAddress, IN UINTN Count, - IN OUT VOID *UserBuffer + IN VOID *UserBuffer ); /** @@ -300,7 +300,7 @@ RootBridgeIoPciRead ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, - IN OUT VOID *Buffer + OUT VOID *Buffer ); /** @@ -317,7 +317,7 @@ RootBridgeIoPciRead ( @param[in] Address The address within the PCI configuration space for the PCI controller. @param[in] Count The number of PCI configuration operations to perform. Bytes moved is Width size * Count, starting at Address. - @param[out] Buffer For read operations, the destination buffer to store the results. For + @param[in] Buffer For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. @@ -333,7 +333,7 @@ RootBridgeIoPciWrite ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, - IN OUT VOID *Buffer + IN VOID *Buffer ); /** @@ -346,7 +346,7 @@ RootBridgeIoPciWrite ( @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param[in] Operation Indicates if the bus master is going to read or write to system memory. @param[in] HostAddress The system memory address to map to the PCI controller. - @param[in][out] NumberOfBytes On input the number of bytes to map. On output the number of bytes that were mapped. + @param[in, out] NumberOfBytes On input the number of bytes to map. On output the number of bytes that were mapped. @param[out] DeviceAddress The resulting map address for the bus master PCI controller to use to access the system memory's HostAddress. @param[out] Mapping The value to pass to Unmap() when the bus master DMA operation is complete. @@ -523,9 +523,9 @@ RootBridgeIoGetAttributes ( MEMORY_WRITE_COMBINE, MEMORY_CACHED, and MEMORY_DISABLE are not set, then ResourceBase and ResourceLength are ignored, and may be NULL. - @param[in][out] ResourceBase A pointer to the base address of the resource range to be modified + @param[in, out] ResourceBase A pointer to the base address of the resource range to be modified by the attributes specified by Attributes. - @param[in][out] ResourceLength A pointer to the length of the resource range to be modified by the + @param[in, out] ResourceLength A pointer to the length of the resource range to be modified by the attributes specified by Attributes. @retval EFI_SUCCESS The current configuration of this PCI root bridge was returned in Resources. @@ -866,7 +866,7 @@ RootBridgeIoCheckParameter ( @param[in] UserAddress The address within the PCI configuration space for the PCI controller. @param[in] Count The number of PCI configuration operations to perform. Bytes moved is Width size * Count, starting at Address. - @param[out] UserBuffer For read operations, the destination buffer to store the results. For + @param[in, out] UserBuffer For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. @@ -958,7 +958,7 @@ RootBridgeIoMemRW ( @param[in] UserAddress The address within the PCI configuration space for the PCI controller. @param[in] Count The number of PCI configuration operations to perform. Bytes moved is Width size * Count, starting at Address. - @param[out] UserBuffer For read operations, the destination buffer to store the results. For + @param[in, out] UserBuffer For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. @@ -1044,7 +1044,7 @@ RootBridgeIoIoRW ( @param[in] UserAddress The address within the PCI configuration space for the PCI controller. @param[in] Count The number of PCI configuration operations to perform. Bytes moved is Width size * Count, starting at Address. - @param[out] UserBuffer For read operations, the destination buffer to store the results. For + @param[in, out] UserBuffer For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. @@ -1219,7 +1219,7 @@ RootBridgeIoPollMem ( } NumberOfTicks += 1; - while (NumberOfTicks) { + while (NumberOfTicks != 0) { mMetronome->WaitForTick (mMetronome, 1); @@ -1320,7 +1320,7 @@ RootBridgeIoPollIo ( } NumberOfTicks += 1; - while (NumberOfTicks) { + while (NumberOfTicks != 0) { mMetronome->WaitForTick (mMetronome, 1); @@ -1369,7 +1369,7 @@ RootBridgeIoMemRead ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, - IN OUT VOID *Buffer + OUT VOID *Buffer ) { return RootBridgeIoMemRW (This, FALSE, Width, Address, Count, Buffer); @@ -1389,7 +1389,7 @@ RootBridgeIoMemRead ( responsible for aligning the Address if required. @param[in] Count The number of memory operations to perform. Bytes moved is Width size * Count, starting at Address. - @param[out] Buffer For read operations, the destination buffer to store the results. For + @param[in] Buffer For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. @@ -1404,7 +1404,7 @@ RootBridgeIoMemWrite ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, - IN OUT VOID *Buffer + IN VOID *Buffer ) { return RootBridgeIoMemRW (This, TRUE, Width, Address, Count, Buffer); @@ -1435,7 +1435,7 @@ RootBridgeIoIoRead ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, - IN OUT VOID *Buffer + OUT VOID *Buffer ) { return RootBridgeIoIoRW (This, FALSE, Width, Address, Count, Buffer); @@ -1450,7 +1450,7 @@ RootBridgeIoIoRead ( aligning the Address if required. @param[in] Count The number of I/O operations to perform. Bytes moved is Width size * Count, starting at Address. - @param[out] Buffer For read operations, the destination buffer to store the results. For + @param[in] Buffer For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. @@ -1466,7 +1466,7 @@ RootBridgeIoIoWrite ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, - IN OUT VOID *Buffer + IN VOID *Buffer ) { return RootBridgeIoIoRW (This, TRUE, Width, Address, Count, Buffer); @@ -1499,7 +1499,7 @@ RootBridgeIoIoWrite ( EFI_STATUS EFIAPI RootBridgeIoCopyMem ( - IN struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This, + IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This, IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 DestAddress, IN UINT64 SrcAddress, @@ -1591,7 +1591,7 @@ RootBridgeIoPciRead ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, - IN OUT VOID *Buffer + OUT VOID *Buffer ) { return RootBridgeIoPciRW (This, FALSE, Width, Address, Count, Buffer); @@ -1611,7 +1611,7 @@ RootBridgeIoPciRead ( @param[in] Address The address within the PCI configuration space for the PCI controller. @param[in] Count The number of PCI configuration operations to perform. Bytes moved is Width size * Count, starting at Address. - @param[out] Buffer For read operations, the destination buffer to store the results. For + @param[in] Buffer For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. @@ -1627,7 +1627,7 @@ RootBridgeIoPciWrite ( IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, - IN OUT VOID *Buffer + IN VOID *Buffer ) { return RootBridgeIoPciRW (This, TRUE, Width, Address, Count, Buffer); @@ -1643,7 +1643,7 @@ RootBridgeIoPciWrite ( @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param[in] Operation Indicates if the bus master is going to read or write to system memory. @param[in] HostAddress The system memory address to map to the PCI controller. - @param[in][out] NumberOfBytes On input the number of bytes to map. On output the number of bytes that were mapped. + @param[in, out] NumberOfBytes On input the number of bytes to map. On output the number of bytes that were mapped. @param[out] DeviceAddress The resulting map address for the bus master PCI controller to use to access the system memory's HostAddress. @param[out] Mapping The value to pass to Unmap() when the bus master DMA operation is complete. @@ -1872,7 +1872,7 @@ RootBridgeIoAllocateBuffer ( // // Validate Attributes // - if (Attributes & EFI_PCI_ATTRIBUTE_INVALID_FOR_ALLOCATE_BUFFER) { + if ((Attributes & EFI_PCI_ATTRIBUTE_INVALID_FOR_ALLOCATE_BUFFER) != 0) { return EFI_UNSUPPORTED; } @@ -2000,11 +2000,11 @@ RootBridgeIoGetAttributes ( // // Set the return value for Supported and Attributes // - if (Supported) { + if (Supported != NULL) { *Supported = PrivateData->Supports; } - if (Attributes) { + if (Attributes != NULL) { *Attributes = PrivateData->Attributes; } @@ -2031,9 +2031,9 @@ RootBridgeIoGetAttributes ( MEMORY_WRITE_COMBINE, MEMORY_CACHED, and MEMORY_DISABLE are not set, then ResourceBase and ResourceLength are ignored, and may be NULL. - @param[in][out] ResourceBase A pointer to the base address of the resource range to be modified + @param[in, out] ResourceBase A pointer to the base address of the resource range to be modified by the attributes specified by Attributes. - @param[in][out] ResourceLength A pointer to the length of the resource range to be modified by the + @param[in, out] ResourceLength A pointer to the length of the resource range to be modified by the attributes specified by Attributes. @retval EFI_SUCCESS The current configuration of this PCI root bridge was returned in Resources. @@ -2054,7 +2054,7 @@ RootBridgeIoSetAttributes ( PrivateData = DRIVER_INSTANCE_FROM_PCI_ROOT_BRIDGE_IO_THIS(This); - if (Attributes) { + if (Attributes != 0) { if ((Attributes & (~(PrivateData->Supports))) != 0) { return EFI_UNSUPPORTED; } -- 2.39.2