tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-23 21:54:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Refine the file/function comments to follow doxygen format

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10359 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2010-04-12 04:38:44 +00:00
parent 9af300fc22
commit 18c97f53ea
15 changed files with 1844 additions and 1003 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
PcAtChipsetPkg/8254TimerDxe/8254Timer.inf
View File

@ -1,7 +1,7 @@
## @file ## @file
# #
# Copyright (c) 2005 - 2010, Intel Corporation # Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved. <BR>
# All rights reserved. This program and the accompanying materials # This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License # are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at # which accompanies this distribution. The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php # http://opensource.org/licenses/bsd-license.php
@ -9,12 +9,8 @@
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
# #
# Module Name:
# Timer.inf
#
# Abstract:
#
## ##
[Defines] [Defines]
INF_VERSION = 0x00010005 INF_VERSION = 0x00010005
BASE_NAME = Timer BASE_NAME = Timer

308
PcAtChipsetPkg/8254TimerDxe/Timer.c
View File

@ -1,7 +1,8 @@
/*++ /** @file
Timer Architectural Protocol as defined in the DXE CIS
Copyright (c) 2005 - 2006, Intel Corporation Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved. <BR>
All rights reserved. This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
@ -9,16 +10,7 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
Module Name:
Timer.c
Abstract:
Timer Architectural Protocol as defined in the DXE CIS
--*/
#include "Timer.h" #include "Timer.h"
@ -61,54 +53,33 @@ volatile UINT64 mTimerPeriod = 0;
// //
// Worker Functions // Worker Functions
// //
/**
Sets the counter value for Timer #0 in a legacy 8254 timer.
@param Count The 16-bit counter value to program into Timer #0 of the legacy 8254 timer.
**/
VOID VOID
SetPitCount ( SetPitCount (
IN UINT16 Count IN UINT16 Count
) )
/*++
Routine Description:
Sets the counter value for Timer #0 in a legacy 8254 timer.
Arguments:
Count - The 16-bit counter value to program into Timer #0 of the legacy 8254 timer.
Returns:
None
--*/
{ {
IoWrite8 (TIMER_CONTROL_PORT, 0x36); IoWrite8 (TIMER_CONTROL_PORT, 0x36);
IoWrite8 (TIMER0_COUNT_PORT, (UINT8)(Count & 0xff)); IoWrite8 (TIMER0_COUNT_PORT, (UINT8)(Count & 0xff));
IoWrite8 (TIMER0_COUNT_PORT, (UINT8)((Count >> 8) & 0xff)); IoWrite8 (TIMER0_COUNT_PORT, (UINT8)((Count >> 8) & 0xff));
} }
/**
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
**/
VOID VOID
EFIAPI EFIAPI
TimerInterruptHandler ( TimerInterruptHandler (
IN EFI_EXCEPTION_TYPE InterruptType, IN EFI_EXCEPTION_TYPE InterruptType,
IN EFI_SYSTEM_CONTEXT SystemContext IN EFI_SYSTEM_CONTEXT SystemContext
) )
/*++
Routine Description:
8254 Timer #0 Interrupt Handler
Arguments:
InterruptType - The type of interrupt that occured
SystemContext - A pointer to the system context when the interrupt occured
Returns:
None
--*/
{ {
EFI_TPL OriginalTPL; EFI_TPL OriginalTPL;
@ -126,53 +97,43 @@ Returns:
gBS->RestoreTPL (OriginalTPL); gBS->RestoreTPL (OriginalTPL);
} }
/**
This function registers the handler NotifyFunction so it is called every time
the timer interrupt fires. It also passes the amount of time since the last
handler call to the NotifyFunction. If NotifyFunction is NULL, then the
handler is unregistered. If the handler is registered, then EFI_SUCCESS is
returned. If the CPU does not support registering a timer interrupt handler,
then EFI_UNSUPPORTED is returned. If an attempt is made to register a handler
when a handler is already registered, then EFI_ALREADY_STARTED is returned.
If an attempt is made to unregister a handler when a handler is not registered,
then EFI_INVALID_PARAMETER is returned. If an error occurs attempting to
register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR
is returned.
@param This The EFI_TIMER_ARCH_PROTOCOL instance.
@param NotifyFunction The function to call when a timer interrupt fires. This
function executes at TPL_HIGH_LEVEL. The DXE Core will
register a handler for the timer interrupt, so it can know
how much time has passed. This information is used to
signal timer based events. NULL will unregister the handler.
@retval EFI_SUCCESS The timer handler was registered.
@retval EFI_UNSUPPORTED The platform does not support timer interrupts.
@retval EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already
registered.
@retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not
previously registered.
@retval EFI_DEVICE_ERROR The timer handler could not be registered.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
TimerDriverRegisterHandler ( TimerDriverRegisterHandler (
IN EFI_TIMER_ARCH_PROTOCOL *This, IN EFI_TIMER_ARCH_PROTOCOL *This,
IN EFI_TIMER_NOTIFY NotifyFunction IN EFI_TIMER_NOTIFY NotifyFunction
) )
/*++
Routine Description:
This function registers the handler NotifyFunction so it is called every time
the timer interrupt fires. It also passes the amount of time since the last
handler call to the NotifyFunction. If NotifyFunction is NULL, then the
handler is unregistered. If the handler is registered, then EFI_SUCCESS is
returned. If the CPU does not support registering a timer interrupt handler,
then EFI_UNSUPPORTED is returned. If an attempt is made to register a handler
when a handler is already registered, then EFI_ALREADY_STARTED is returned.
If an attempt is made to unregister a handler when a handler is not registered,
then EFI_INVALID_PARAMETER is returned. If an error occurs attempting to
register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR
is returned.
Arguments:
This - The EFI_TIMER_ARCH_PROTOCOL instance.
NotifyFunction - The function to call when a timer interrupt fires. This
function executes at TPL_HIGH_LEVEL. The DXE Core will
register a handler for the timer interrupt, so it can know
how much time has passed. This information is used to
signal timer based events. NULL will unregister the handler.
Returns:
EFI_SUCCESS - The timer handler was registered.
EFI_UNSUPPORTED - The platform does not support timer interrupts.
EFI_ALREADY_STARTED - NotifyFunction is not NULL, and a handler is already
registered.
EFI_INVALID_PARAMETER - NotifyFunction is NULL, and a handler was not
previously registered.
EFI_DEVICE_ERROR - The timer handler could not be registered.
--*/
{ {
// //
// Check for invalid parameters // Check for invalid parameters
@ -190,48 +151,40 @@ Returns:
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
This function adjusts the period of timer interrupts to the value specified
by TimerPeriod. If the timer period is updated, then the selected timer
period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned. If
the timer hardware is not programmable, then EFI_UNSUPPORTED is returned.
If an error occurs while attempting to update the timer period, then the
timer hardware will be put back in its state prior to this call, and
EFI_DEVICE_ERROR is returned. If TimerPeriod is 0, then the timer interrupt
is disabled. This is not the same as disabling the CPU's interrupts.
Instead, it must either turn off the timer hardware, or it must adjust the
interrupt controller so that a CPU interrupt is not generated when the timer
interrupt fires.
@param This The EFI_TIMER_ARCH_PROTOCOL instance.
@param TimerPeriod 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
by the timer hardware. If TimerPeriod is set to 0, then the
timer interrupts will be disabled.
@retval EFI_SUCCESS The timer period was changed.
@retval EFI_UNSUPPORTED The platform cannot change the period of the timer interrupt.
@retval EFI_DEVICE_ERROR The timer period could not be changed due to a device error.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
TimerDriverSetTimerPeriod ( TimerDriverSetTimerPeriod (
IN EFI_TIMER_ARCH_PROTOCOL *This, IN EFI_TIMER_ARCH_PROTOCOL *This,
IN UINT64 TimerPeriod IN UINT64 TimerPeriod
) )
/*++
Routine Description:
This function adjusts the period of timer interrupts to the value specified
by TimerPeriod. If the timer period is updated, then the selected timer
period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned. If
the timer hardware is not programmable, then EFI_UNSUPPORTED is returned.
If an error occurs while attempting to update the timer period, then the
timer hardware will be put back in its state prior to this call, and
EFI_DEVICE_ERROR is returned. If TimerPeriod is 0, then the timer interrupt
is disabled. This is not the same as disabling the CPU's interrupts.
Instead, it must either turn off the timer hardware, or it must adjust the
interrupt controller so that a CPU interrupt is not generated when the timer
interrupt fires.
Arguments:
This - The EFI_TIMER_ARCH_PROTOCOL instance.
TimerPeriod - 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
by the timer hardware. If TimerPeriod is set to 0, then the
timer interrupts will be disabled.
Returns:
EFI_SUCCESS - The timer period was changed.
EFI_UNSUPPORTED - The platform cannot change the period of the timer interrupt.
EFI_DEVICE_ERROR - The timer period could not be changed due to a device error.
--*/
{ {
UINT64 TimerCount; UINT64 TimerCount;
@ -288,35 +241,28 @@ Returns:
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
This function retrieves the period of timer interrupts in 100 ns units,
returns that value in TimerPeriod, and returns EFI_SUCCESS. If TimerPeriod
is NULL, then EFI_INVALID_PARAMETER is returned. If a TimerPeriod of 0 is
returned, then the timer is currently disabled.
@param This The EFI_TIMER_ARCH_PROTOCOL instance.
@param TimerPeriod A pointer to the timer period to retrieve in 100 ns units. If
0 is returned, then the timer is currently disabled.
@retval EFI_SUCCESS The timer period was returned in TimerPeriod.
@retval EFI_INVALID_PARAMETER TimerPeriod is NULL.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
TimerDriverGetTimerPeriod ( TimerDriverGetTimerPeriod (
IN EFI_TIMER_ARCH_PROTOCOL *This, IN EFI_TIMER_ARCH_PROTOCOL *This,
OUT UINT64 *TimerPeriod OUT UINT64 *TimerPeriod
) )
/*++
Routine Description:
This function retrieves the period of timer interrupts in 100 ns units,
returns that value in TimerPeriod, and returns EFI_SUCCESS. If TimerPeriod
is NULL, then EFI_INVALID_PARAMETER is returned. If a TimerPeriod of 0 is
returned, then the timer is currently disabled.
Arguments:
This - The EFI_TIMER_ARCH_PROTOCOL instance.
TimerPeriod - A pointer to the timer period to retrieve in 100 ns units. If
0 is returned, then the timer is currently disabled.
Returns:
EFI_SUCCESS - The timer period was returned in TimerPeriod.
EFI_INVALID_PARAMETER - TimerPeriod is NULL.
--*/
{ {
if (TimerPeriod == NULL) { if (TimerPeriod == NULL) {
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
@ -327,34 +273,28 @@ Returns:
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
This function generates a soft timer interrupt. If the platform does not support soft
timer interrupts, then EFI_UNSUPPORTED is returned. Otherwise, EFI_SUCCESS is returned.
If a handler has been registered through the EFI_TIMER_ARCH_PROTOCOL.RegisterHandler()
service, then a soft timer interrupt will be generated. If the timer interrupt is
enabled when this service is called, then the registered handler will be invoked. The
registered handler should not be able to distinguish a hardware-generated timer
interrupt from a software-generated timer interrupt.
@param This The EFI_TIMER_ARCH_PROTOCOL instance.
@retval EFI_SUCCESS The soft timer interrupt was generated.
@retval EFI_UNSUPPORTEDT The platform does not support the generation of soft timer interrupts.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
TimerDriverGenerateSoftInterrupt ( TimerDriverGenerateSoftInterrupt (
IN EFI_TIMER_ARCH_PROTOCOL *This IN EFI_TIMER_ARCH_PROTOCOL *This
) )
/*++
Routine Description:
This function generates a soft timer interrupt. If the platform does not support soft
timer interrupts, then EFI_UNSUPPORTED is returned. Otherwise, EFI_SUCCESS is returned.
If a handler has been registered through the EFI_TIMER_ARCH_PROTOCOL.RegisterHandler()
service, then a soft timer interrupt will be generated. If the timer interrupt is
enabled when this service is called, then the registered handler will be invoked. The
registered handler should not be able to distinguish a hardware-generated timer
interrupt from a software-generated timer interrupt.
Arguments:
This - The EFI_TIMER_ARCH_PROTOCOL instance.
Returns:
EFI_SUCCESS - The soft timer interrupt was generated.
EFI_UNSUPPORTEDT - The platform does not support the generation of soft timer interrupts.
--*/
{ {
EFI_STATUS Status; EFI_STATUS Status;
UINT16 IRQMask; UINT16 IRQMask;
@ -386,33 +326,23 @@ Returns:
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
Initialize the Timer Architectural Protocol driver
@param ImageHandle ImageHandle of the loaded driver
@param SystemTable Pointer to the System Table
@retval EFI_SUCCESS Timer Architectural Protocol created
@retval EFI_OUT_OF_RESOURCES Not enough resources available to initialize driver.
@retval EFI_DEVICE_ERROR A device error occured attempting to initialize the driver.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
TimerDriverInitialize ( TimerDriverInitialize (
IN EFI_HANDLE ImageHandle, IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable IN EFI_SYSTEM_TABLE *SystemTable
) )
/*++
Routine Description:
Initialize the Timer Architectural Protocol driver
Arguments:
ImageHandle - ImageHandle of the loaded driver
SystemTable - Pointer to the System Table
Returns:
EFI_SUCCESS - Timer Architectural Protocol created
EFI_OUT_OF_RESOURCES - Not enough resources available to initialize driver.
EFI_DEVICE_ERROR - A device error occured attempting to initialize the driver.
--*/
{ {
EFI_STATUS Status; EFI_STATUS Status;
UINT32 TimerVector; UINT32 TimerVector;

263
PcAtChipsetPkg/8254TimerDxe/Timer.h
View File

@ -1,24 +1,15 @@
/*++ /** @file
Private data structures
Copyright (c) 2005 - 2006, Intel Corporation Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved. <BR>
All rights reserved. This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
Module Name:
Timer.h
Abstract:
Private data structures
--*/
#ifndef _TIMER_H_ #ifndef _TIMER_H_
#define _TIMER_H_ #define _TIMER_H_
@ -52,187 +43,143 @@ Abstract:
// //
// Function Prototypes // Function Prototypes
// //
/**
Initialize the Timer Architectural Protocol driver
@param ImageHandle ImageHandle of the loaded driver
@param SystemTable Pointer to the System Table
@retval EFI_SUCCESS Timer Architectural Protocol created
@retval EFI_OUT_OF_RESOURCES Not enough resources available to initialize driver.
@retval EFI_DEVICE_ERROR A device error occured attempting to initialize the driver.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
TimerDriverInitialize ( TimerDriverInitialize (
IN EFI_HANDLE ImageHandle, IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable IN EFI_SYSTEM_TABLE *SystemTable
) )
/*++
Routine Description:
Initialize the Timer Architectural Protocol driver
Arguments:
ImageHandle - ImageHandle of the loaded driver
SystemTable - Pointer to the System Table
Returns:
EFI_SUCCESS - Timer Architectural Protocol created
EFI_OUT_OF_RESOURCES - Not enough resources available to initialize driver.
EFI_DEVICE_ERROR - A device error occured attempting to initialize the driver.
--*/
; ;
/**
This function adjusts the period of timer interrupts to the value specified
by TimerPeriod. If the timer period is updated, then the selected timer
period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned. If
the timer hardware is not programmable, then EFI_UNSUPPORTED is returned.
If an error occurs while attempting to update the timer period, then the
timer hardware will be put back in its state prior to this call, and
EFI_DEVICE_ERROR is returned. If TimerPeriod is 0, then the timer interrupt
is disabled. This is not the same as disabling the CPU's interrupts.
Instead, it must either turn off the timer hardware, or it must adjust the
interrupt controller so that a CPU interrupt is not generated when the timer
interrupt fires.
@param This The EFI_TIMER_ARCH_PROTOCOL instance.
@param TimerPeriod 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
by the timer hardware. If TimerPeriod is set to 0, then the
timer interrupts will be disabled.
@retval EFI_SUCCESS The timer period was changed.
@retval EFI_UNSUPPORTED The platform cannot change the period of the timer interrupt.
@retval EFI_DEVICE_ERROR The timer period could not be changed due to a device error.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
TimerDriverRegisterHandler ( TimerDriverRegisterHandler (
IN EFI_TIMER_ARCH_PROTOCOL *This, IN EFI_TIMER_ARCH_PROTOCOL *This,
IN EFI_TIMER_NOTIFY NotifyFunction IN EFI_TIMER_NOTIFY NotifyFunction
) )
/*++
Routine Description:
This function registers the handler NotifyFunction so it is called every time
the timer interrupt fires. It also passes the amount of time since the last
handler call to the NotifyFunction. If NotifyFunction is NULL, then the
handler is unregistered. If the handler is registered, then EFI_SUCCESS is
returned. If the CPU does not support registering a timer interrupt handler,
then EFI_UNSUPPORTED is returned. If an attempt is made to register a handler
when a handler is already registered, then EFI_ALREADY_STARTED is returned.
If an attempt is made to unregister a handler when a handler is not registered,
then EFI_INVALID_PARAMETER is returned. If an error occurs attempting to
register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR
is returned.
Arguments:
This - The EFI_TIMER_ARCH_PROTOCOL instance.
NotifyFunction - The function to call when a timer interrupt fires. This
function executes at TPL_HIGH_LEVEL. The DXE Core will
register a handler for the timer interrupt, so it can know
how much time has passed. This information is used to
signal timer based events. NULL will unregister the handler.
Returns:
EFI_SUCCESS - The timer handler was registered.
EFI_UNSUPPORTED - The platform does not support timer interrupts.
EFI_ALREADY_STARTED - NotifyFunction is not NULL, and a handler is already
registered.
EFI_INVALID_PARAMETER - NotifyFunction is NULL, and a handler was not
previously registered.
EFI_DEVICE_ERROR - The timer handler could not be registered.
--*/
; ;
/**
This function adjusts the period of timer interrupts to the value specified
by TimerPeriod. If the timer period is updated, then the selected timer
period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned. If
the timer hardware is not programmable, then EFI_UNSUPPORTED is returned.
If an error occurs while attempting to update the timer period, then the
timer hardware will be put back in its state prior to this call, and
EFI_DEVICE_ERROR is returned. If TimerPeriod is 0, then the timer interrupt
is disabled. This is not the same as disabling the CPU's interrupts.
Instead, it must either turn off the timer hardware, or it must adjust the
interrupt controller so that a CPU interrupt is not generated when the timer
interrupt fires.
@param This The EFI_TIMER_ARCH_PROTOCOL instance.
@param TimerPeriod 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
by the timer hardware. If TimerPeriod is set to 0, then the
timer interrupts will be disabled.
@retval EFI_SUCCESS The timer period was changed.
@retval EFI_UNSUPPORTED The platform cannot change the period of the timer interrupt.
@retval EFI_DEVICE_ERROR The timer period could not be changed due to a device error.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
TimerDriverSetTimerPeriod ( TimerDriverSetTimerPeriod (
IN EFI_TIMER_ARCH_PROTOCOL *This, IN EFI_TIMER_ARCH_PROTOCOL *This,
IN UINT64 TimerPeriod IN UINT64 TimerPeriod
) )
/*++
Routine Description:
This function adjusts the period of timer interrupts to the value specified
by TimerPeriod. If the timer period is updated, then the selected timer
period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned. If
the timer hardware is not programmable, then EFI_UNSUPPORTED is returned.
If an error occurs while attempting to update the timer period, then the
timer hardware will be put back in its state prior to this call, and
EFI_DEVICE_ERROR is returned. If TimerPeriod is 0, then the timer interrupt
is disabled. This is not the same as disabling the CPU's interrupts.
Instead, it must either turn off the timer hardware, or it must adjust the
interrupt controller so that a CPU interrupt is not generated when the timer
interrupt fires.
Arguments:
This - The EFI_TIMER_ARCH_PROTOCOL instance.
TimerPeriod - 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
by the timer hardware. If TimerPeriod is set to 0, then the
timer interrupts will be disabled.
Returns:
EFI_SUCCESS - The timer period was changed.
EFI_UNSUPPORTED - The platform cannot change the period of the timer interrupt.
EFI_DEVICE_ERROR - The timer period could not be changed due to a device error.
--*/
; ;
/**
This function retrieves the period of timer interrupts in 100 ns units,
returns that value in TimerPeriod, and returns EFI_SUCCESS. If TimerPeriod
is NULL, then EFI_INVALID_PARAMETER is returned. If a TimerPeriod of 0 is
returned, then the timer is currently disabled.
@param This The EFI_TIMER_ARCH_PROTOCOL instance.
@param TimerPeriod A pointer to the timer period to retrieve in 100 ns units. If
0 is returned, then the timer is currently disabled.
@retval EFI_SUCCESS The timer period was returned in TimerPeriod.
@retval EFI_INVALID_PARAMETER TimerPeriod is NULL.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
TimerDriverGetTimerPeriod ( TimerDriverGetTimerPeriod (
IN EFI_TIMER_ARCH_PROTOCOL *This, IN EFI_TIMER_ARCH_PROTOCOL *This,
OUT UINT64 *TimerPeriod OUT UINT64 *TimerPeriod
) )
/*++
Routine Description:
This function retrieves the period of timer interrupts in 100 ns units,
returns that value in TimerPeriod, and returns EFI_SUCCESS. If TimerPeriod
is NULL, then EFI_INVALID_PARAMETER is returned. If a TimerPeriod of 0 is
returned, then the timer is currently disabled.
Arguments:
This - The EFI_TIMER_ARCH_PROTOCOL instance.
TimerPeriod - A pointer to the timer period to retrieve in 100 ns units. If
0 is returned, then the timer is currently disabled.
Returns:
EFI_SUCCESS - The timer period was returned in TimerPeriod.
EFI_INVALID_PARAMETER - TimerPeriod is NULL.
--*/
; ;
/**
This function generates a soft timer interrupt. If the platform does not support soft
timer interrupts, then EFI_UNSUPPORTED is returned. Otherwise, EFI_SUCCESS is returned.
If a handler has been registered through the EFI_TIMER_ARCH_PROTOCOL.RegisterHandler()
service, then a soft timer interrupt will be generated. If the timer interrupt is
enabled when this service is called, then the registered handler will be invoked. The
registered handler should not be able to distinguish a hardware-generated timer
interrupt from a software-generated timer interrupt.
@param This The EFI_TIMER_ARCH_PROTOCOL instance.
@retval EFI_SUCCESS The soft timer interrupt was generated.
@retval EFI_UNSUPPORTEDT The platform does not support the generation of soft timer interrupts.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
TimerDriverGenerateSoftInterrupt ( TimerDriverGenerateSoftInterrupt (
IN EFI_TIMER_ARCH_PROTOCOL *This IN EFI_TIMER_ARCH_PROTOCOL *This
) )
/*++
Routine Description:
This function generates a soft timer interrupt. If the platform does not support soft
timer interrupts, then EFI_UNSUPPORTED is returned. Otherwise, EFI_SUCCESS is returned.
If a handler has been registered through the EFI_TIMER_ARCH_PROTOCOL.RegisterHandler()
service, then a soft timer interrupt will be generated. If the timer interrupt is
enabled when this service is called, then the registered handler will be invoked. The
registered handler should not be able to distinguish a hardware-generated timer
interrupt from a software-generated timer interrupt.
Arguments:
This - The EFI_TIMER_ARCH_PROTOCOL instance.
Returns:
EFI_SUCCESS - The soft timer interrupt was generated.
EFI_UNSUPPORTEDT - The platform does not support the generation of soft timer interrupts.
--*/
; ;
#endif #endif

301
PcAtChipsetPkg/IsaAcpiDxe/ComponentName.c
View File

@ -1,28 +1,60 @@
/*++ /** @file
UEFI Component Name(2) protocol implementation for IsaAcpi driver.
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved. <BR>
All rights reserved. This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
Module Name:
ComponentName.c
Abstract:
--*/
#include "PcatIsaAcpi.h" #include "PcatIsaAcpi.h"
// //
// EFI Component Name Functions // EFI Component Name Functions
// //
/**
Retrieves a Unicode string that is the user readable name of the driver.
This function retrieves the user readable name of a driver in the form of a
Unicode string. If the driver specified by This has a user readable name in
the language specified by Language, then a pointer to the driver name is
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
by This does not support the language specified by Language,
then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param Language[in] A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
languages specified in SupportedLanguages. The
number of languages supported by a driver is up
to the driver writer. Language is specified
in RFC 4646 or ISO 639-2 language code format.
@param DriverName[out] A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language.
@retval EFI_SUCCESS The Unicode string for the Driver specified by
This and the language specified by Language was
returned in DriverName.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER DriverName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PcatIsaAcpiComponentNameGetDriverName ( PcatIsaAcpiComponentNameGetDriverName (
@ -31,6 +63,74 @@ PcatIsaAcpiComponentNameGetDriverName (
OUT CHAR16 **DriverName OUT CHAR16 **DriverName
); );
/**
Retrieves a Unicode string that is the user readable name of the controller
that is being managed by a driver.
This function retrieves the user readable name of the controller specified by
ControllerHandle and ChildHandle in the form of a Unicode string. If the
driver specified by This has a user readable name in the language specified by
Language, then a pointer to the controller name is returned in ControllerName,
and EFI_SUCCESS is returned. If the driver specified by This is not currently
managing the controller specified by ControllerHandle and ChildHandle,
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param ControllerHandle[in] 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 ChildHandle[in] 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 bus
controller. It will not be NULL for a bus
driver that wishes to retrieve the name of a
child controller.
@param Language[in] A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
languages specified in SupportedLanguages. The
number of languages supported by a driver is up
to the driver writer. Language is specified in
RFC 4646 or ISO 639-2 language code format.
@param ControllerName[out] A pointer to the Unicode string to return.
This Unicode string is the name of the
controller specified by ControllerHandle and
ChildHandle in the language specified by
Language from the point of view of the driver
specified by This.
@retval EFI_SUCCESS The Unicode string for the user readable name in
the language specified by Language for the
driver specified by This was returned in
DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
EFI_HANDLE.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER ControllerName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This is not currently
managing the controller specified by
ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PcatIsaAcpiComponentNameGetControllerName ( PcatIsaAcpiComponentNameGetControllerName (
@ -69,6 +169,45 @@ EFI_UNICODE_STRING_TABLE mPcatIsaAcpiDriverNameTable[] = {
} }
}; };
/**
Retrieves a Unicode string that is the user readable name of the driver.
This function retrieves the user readable name of a driver in the form of a
Unicode string. If the driver specified by This has a user readable name in
the language specified by Language, then a pointer to the driver name is
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
by This does not support the language specified by Language,
then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param Language[in] A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
languages specified in SupportedLanguages. The
number of languages supported by a driver is up
to the driver writer. Language is specified
in RFC 4646 or ISO 639-2 language code format.
@param DriverName[out] A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language.
@retval EFI_SUCCESS The Unicode string for the Driver specified by
This and the language specified by Language was
returned in DriverName.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER DriverName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PcatIsaAcpiComponentNameGetDriverName ( PcatIsaAcpiComponentNameGetDriverName (
@ -76,32 +215,6 @@ PcatIsaAcpiComponentNameGetDriverName (
IN CHAR8 *Language, IN CHAR8 *Language,
OUT CHAR16 **DriverName OUT CHAR16 **DriverName
) )
/*++
Routine Description:
Retrieves a Unicode string that is the user readable name of the EFI Driver.
Arguments:
This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
Language - A pointer to a three character ISO 639-2 language identifier.
This is the language of the driver name that that the caller
is requesting, and it must match one of the languages specified
in SupportedLanguages. The number of languages supported by a
driver is up to the driver writer.
DriverName - A pointer to the Unicode string to return. This Unicode string
is the name of the driver specified by This in the language
specified by Language.
Returns:
EFI_SUCCES - The Unicode string for the Driver specified by This
and the language specified by Language was returned
in DriverName.
EFI_INVALID_PARAMETER - Language is NULL.
EFI_INVALID_PARAMETER - DriverName is NULL.
EFI_UNSUPPORTED - The driver specified by This does not support the
language specified by Language.
--*/
{ {
return LookupUnicodeString2 ( return LookupUnicodeString2 (
Language, Language,
@ -112,6 +225,74 @@ PcatIsaAcpiComponentNameGetDriverName (
); );
} }
/**
Retrieves a Unicode string that is the user readable name of the controller
that is being managed by a driver.
This function retrieves the user readable name of the controller specified by
ControllerHandle and ChildHandle in the form of a Unicode string. If the
driver specified by This has a user readable name in the language specified by
Language, then a pointer to the controller name is returned in ControllerName,
and EFI_SUCCESS is returned. If the driver specified by This is not currently
managing the controller specified by ControllerHandle and ChildHandle,
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param ControllerHandle[in] 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 ChildHandle[in] 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 bus
controller. It will not be NULL for a bus
driver that wishes to retrieve the name of a
child controller.
@param Language[in] A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
languages specified in SupportedLanguages. The
number of languages supported by a driver is up
to the driver writer. Language is specified in
RFC 4646 or ISO 639-2 language code format.
@param ControllerName[out] A pointer to the Unicode string to return.
This Unicode string is the name of the
controller specified by ControllerHandle and
ChildHandle in the language specified by
Language from the point of view of the driver
specified by This.
@retval EFI_SUCCESS The Unicode string for the user readable name in
the language specified by Language for the
driver specified by This was returned in
DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
EFI_HANDLE.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER ControllerName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This is not currently
managing the controller specified by
ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PcatIsaAcpiComponentNameGetControllerName ( PcatIsaAcpiComponentNameGetControllerName (
@ -121,50 +302,6 @@ PcatIsaAcpiComponentNameGetControllerName (
IN CHAR8 *Language, IN CHAR8 *Language,
OUT CHAR16 **ControllerName OUT CHAR16 **ControllerName
) )
/*++
Routine Description:
Retrieves a Unicode string that is the user readable name of the controller
that is being managed by an EFI Driver.
Arguments:
This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
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.
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
bus controller. It will not be NULL for a bus driver
that wishes to retrieve the name of a child controller.
Language - A pointer to a three character ISO 639-2 language
identifier. This is the language of the controller name
that that the caller is requesting, and it must match one
of the languages specified in SupportedLanguages. The
number of languages supported by a driver is up to the
driver writer.
ControllerName - A pointer to the Unicode string to return. This Unicode
string is the name of the controller specified by
ControllerHandle and ChildHandle in the language specified
by Language from the point of view of the driver specified
by This.
Returns:
EFI_SUCCESS - The Unicode string for the user readable name in the
language specified by Language for the driver
specified by This was returned in DriverName.
EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETER - Language is NULL.
EFI_INVALID_PARAMETER - ControllerName is NULL.
EFI_UNSUPPORTED - The driver specified by This is not currently managing
the controller specified by ControllerHandle and
ChildHandle.
EFI_UNSUPPORTED - The driver specified by This does not support the
language specified by Language.
--*/
{ {
return EFI_UNSUPPORTED; return EFI_UNSUPPORTED;
} }

191
PcAtChipsetPkg/IsaAcpiDxe/IsaAcpi.c
View File

@ -1,26 +1,15 @@
/*++ /** @file
ISA ACPI Protocol Implementation
Copyright (c) 2006, Intel Corporation Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved. <BR>
All rights reserved. This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
Module Name:
IsaAcpi.c
Abstract:
ISA ACPI Protocol Implementation
Revision History
--*/
#include "PcatIsaAcpi.h" #include "PcatIsaAcpi.h"
@ -90,22 +79,19 @@ EFI_ISA_ACPI_RESOURCE_LIST gPcatIsaAcpiDeviceList[] = {
// //
// ISA ACPI Protocol Functions // ISA ACPI Protocol Functions
// //
/**
Enumerate the ISA devices on the ISA bus.
@param Device Point to device ID instance
@param IsaAcpiDevice On return, point to resource data for Isa device
@param NextIsaAcpiDevice On return, point to resource data for next Isa device
**/
VOID VOID
IsaDeviceLookup ( IsaDeviceLookup (
IN EFI_ISA_ACPI_DEVICE_ID *Device, IN EFI_ISA_ACPI_DEVICE_ID *Device,
OUT EFI_ISA_ACPI_RESOURCE_LIST **IsaAcpiDevice, OUT EFI_ISA_ACPI_RESOURCE_LIST **IsaAcpiDevice,
OUT EFI_ISA_ACPI_RESOURCE_LIST **NextIsaAcpiDevice OUT EFI_ISA_ACPI_RESOURCE_LIST **NextIsaAcpiDevice
) )
/*++
Routine Description:
Enumerate the ISA devices on the ISA bus
Arguments:
Returns:
--*/
{ {
UINTN Index; UINTN Index;
@ -133,22 +119,23 @@ Returns:
} }
} }
/**
Enumerate the ISA devices on the ISA bus
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@retval EFI_NOT_FOUND Can not found the next Isa device.
@retval EFI_SUCESS Success retrieve the next Isa device for enumration.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaDeviceEnumerate ( IsaDeviceEnumerate (
IN EFI_ISA_ACPI_PROTOCOL *This, IN EFI_ISA_ACPI_PROTOCOL *This,
OUT EFI_ISA_ACPI_DEVICE_ID **Device OUT EFI_ISA_ACPI_DEVICE_ID **Device
) )
/*++
Routine Description:
Enumerate the ISA devices on the ISA bus
Arguments:
Returns:
--*/
{ {
EFI_ISA_ACPI_RESOURCE_LIST *IsaAcpiDevice; EFI_ISA_ACPI_RESOURCE_LIST *IsaAcpiDevice;
EFI_ISA_ACPI_RESOURCE_LIST *NextIsaAcpiDevice; EFI_ISA_ACPI_RESOURCE_LIST *NextIsaAcpiDevice;
@ -161,6 +148,17 @@ Returns:
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
Set ISA device power
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@param OnOff TRUE for setting isa device power on,
FALSE for setting isa device power off
@return EFI_SUCCESS Sucess to change power status for isa device.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaDeviceSetPower ( IsaDeviceSetPower (
@ -168,20 +166,20 @@ IsaDeviceSetPower (
IN EFI_ISA_ACPI_DEVICE_ID *Device, IN EFI_ISA_ACPI_DEVICE_ID *Device,
IN BOOLEAN OnOff IN BOOLEAN OnOff
) )
/*++
Routine Description:
Set ISA device power
Arguments:
Returns:
--*/
{ {
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
Get current resource for the specific ISA device.
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@param ResourceList On return, point to resources instances for given isa device
@retval EFI_NOT_FOUND Can not found the resource instance for given isa device
@retval EFI_SUCCESS Success to get resource instance for given isa device.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaGetCurrentResource ( IsaGetCurrentResource (
@ -189,16 +187,6 @@ IsaGetCurrentResource (
IN EFI_ISA_ACPI_DEVICE_ID *Device, IN EFI_ISA_ACPI_DEVICE_ID *Device,
OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList
) )
/*++
Routine Description:
Get current Resource of the specific ISA device
Arguments:
Returns:
--*/
{ {
IsaDeviceLookup (Device, ResourceList, NULL); IsaDeviceLookup (Device, ResourceList, NULL);
if (*ResourceList == NULL) { if (*ResourceList == NULL) {
@ -207,6 +195,15 @@ Returns:
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
Get possible resource for the specific ISA device.
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@param ResourceList On return, point to resources instances for given isa device
@retval EFI_SUCCESS Success to get resource instance for given isa device.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaGetPossibleResource ( IsaGetPossibleResource (
@ -214,19 +211,20 @@ IsaGetPossibleResource (
IN EFI_ISA_ACPI_DEVICE_ID *Device, IN EFI_ISA_ACPI_DEVICE_ID *Device,
OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList
) )
/*++
Routine Description:
Arguments:
Returns:
--*/
{ {
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
Set resource for the specific ISA device.
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@param ResourceList Point to resources instances for given isa device
@return EFI_SUCESS Success to set resource.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaSetResource ( IsaSetResource (
@ -234,19 +232,20 @@ IsaSetResource (
IN EFI_ISA_ACPI_DEVICE_ID *Device, IN EFI_ISA_ACPI_DEVICE_ID *Device,
IN EFI_ISA_ACPI_RESOURCE_LIST *ResourceList IN EFI_ISA_ACPI_RESOURCE_LIST *ResourceList
) )
/*++
Routine Description:
Arguments:
Returns:
--*/
{ {
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
Enable/Disable the specific ISA device.
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@param Enable Enable/Disable
@return EFI_SUCESS Success to enable/disable.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaEnableDevice ( IsaEnableDevice (
@ -254,53 +253,43 @@ IsaEnableDevice (
IN EFI_ISA_ACPI_DEVICE_ID *Device, IN EFI_ISA_ACPI_DEVICE_ID *Device,
IN BOOLEAN Enable IN BOOLEAN Enable
) )
/*++
Routine Description:
Arguments:
Returns:
--*/
{ {
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
Initialize the specific ISA device.
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@return EFI_SUCESS Success to initialize.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaInitDevice ( IsaInitDevice (
IN EFI_ISA_ACPI_PROTOCOL *This, IN EFI_ISA_ACPI_PROTOCOL *This,
IN EFI_ISA_ACPI_DEVICE_ID *Device IN EFI_ISA_ACPI_DEVICE_ID *Device
) )
/*++
Routine Description:
Arguments:
Returns:
--*/
{ {
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
Initialize the ISA interface.
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@return EFI_SUCESS Success to initialize ISA interface.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaInterfaceInit ( IsaInterfaceInit (
IN EFI_ISA_ACPI_PROTOCOL *This IN EFI_ISA_ACPI_PROTOCOL *This
) )
/*++
Routine Description:
Arguments:
Returns:
--*/
{ {
return EFI_SUCCESS; return EFI_SUCCESS;
} }

12
PcAtChipsetPkg/IsaAcpiDxe/IsaAcpi.inf
View File

@ -1,7 +1,8 @@
## @file ## @file
# # Component description file for PCAT ISA ACPI driver
# Copyright (c) 2005 - 2010, Intel Corporation #
# All rights reserved. This program and the accompanying materials # Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved. <BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License # are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at # which accompanies this distribution. The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php # http://opensource.org/licenses/bsd-license.php
@ -9,11 +10,6 @@
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
# #
# Module Name:
# IsaAcpi.inf
#
# Abstract:
# Component description file for PCAT ISA ACPI driver
# #
## ##

100
PcAtChipsetPkg/IsaAcpiDxe/PcatIsaAcpi.c
View File

@ -1,14 +1,14 @@
/** @file /** @file
EFI PCAT ISA ACPI Driver for a Generic PC Platform EFI PCAT ISA ACPI Driver for a Generic PC Platform
Copyright (c) 2006, 2009, Intel Corporation Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved. <BR>
All rights reserved. This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/ **/
@ -26,22 +26,20 @@ EFI_DRIVER_BINDING_PROTOCOL gPcatIsaAcpiDriverBinding = {
NULL NULL
}; };
/**
the entry point of the PcatIsaAcpi driver.
@param ImageHandle Handle for driver image
@param SystemTable Point to EFI_SYSTEM_TABLE
@return Sucess or not for installing driver binding protocol
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PcatIsaAcpiDriverEntryPoint ( PcatIsaAcpiDriverEntryPoint (
IN EFI_HANDLE ImageHandle, IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable IN EFI_SYSTEM_TABLE *SystemTable
) )
/*++
Routine Description:
the entry point of the PcatIsaAcpi driver
Arguments:
Returns:
--*/
{ {
return EfiLibInstallDriverBindingComponentName2 ( return EfiLibInstallDriverBindingComponentName2 (
ImageHandle, ImageHandle,
@ -53,6 +51,17 @@ PcatIsaAcpiDriverEntryPoint (
); );
} }
/**
ControllerDriver Protocol Method
@param This Driver Binding protocol instance pointer.
@param Controller Handle of device to test.
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver supports this device.
@retval other This driver does not support this device.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PcatIsaAcpiDriverBindingSupported ( PcatIsaAcpiDriverBindingSupported (
@ -60,17 +69,6 @@ PcatIsaAcpiDriverBindingSupported (
IN EFI_HANDLE Controller, IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
) )
/*++
Routine Description:
ControllerDriver Protocol Method
Arguments:
Returns:
--*/
{ {
EFI_STATUS Status; EFI_STATUS Status;
EFI_PCI_IO_PROTOCOL *PciIo; EFI_PCI_IO_PROTOCOL *PciIo;
@ -131,6 +129,18 @@ Returns:
return Status; return Status;
} }
/**
Install EFI_ISA_ACPI_PROTOCOL.
@param This Driver Binding protocol instance pointer.
@param ControllerHandle Handle of device to bind driver to.
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver is added to ControllerHandle
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
@retval other This driver does not support this device
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PcatIsaAcpiDriverBindingStart ( PcatIsaAcpiDriverBindingStart (
@ -138,16 +148,6 @@ PcatIsaAcpiDriverBindingStart (
IN EFI_HANDLE Controller, IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
) )
/*++
Routine Description:
Install EFI_ISA_ACPI_PROTOCOL
Arguments:
Returns:
--*/
{ {
EFI_STATUS Status; EFI_STATUS Status;
EFI_PCI_IO_PROTOCOL *PciIo; EFI_PCI_IO_PROTOCOL *PciIo;
@ -246,6 +246,21 @@ Done:
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
Stop this driver on ControllerHandle. Support stopping any child handles
created by this driver.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to stop driver on
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
children is zero stop the entire bus driver.
@param ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCESS This driver is removed ControllerHandle
@retval other This driver was not removed from this device
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PcatIsaAcpiDriverBindingStop ( PcatIsaAcpiDriverBindingStop (
@ -254,15 +269,6 @@ PcatIsaAcpiDriverBindingStop (
IN UINTN NumberOfChildren, IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer IN EFI_HANDLE *ChildHandleBuffer
) )
/*++
Routine Description:
Arguments:
Returns:
--*/
{ {
EFI_STATUS Status; EFI_STATUS Status;
EFI_ISA_ACPI_PROTOCOL *IsaAcpi; EFI_ISA_ACPI_PROTOCOL *IsaAcpi;

135
PcAtChipsetPkg/IsaAcpiDxe/PcatIsaAcpi.h
View File

@ -1,7 +1,8 @@
/*++ /** @file
EFI PCAT ISA ACPI Driver for a Generic PC Platform
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved. <BR>
All rights reserved. This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
@ -9,18 +10,7 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
Module Name:
PcatIsaAcpi.h
Abstract:
EFI PCAT ISA ACPI Driver for a Generic PC Platform
Revision History
--*/
#ifndef _PCAT_ISA_ACPI_H_ #ifndef _PCAT_ISA_ACPI_H_
#define _PCAT_ISA_ACPI_H_ #define _PCAT_ISA_ACPI_H_
@ -68,6 +58,17 @@ extern EFI_COMPONENT_NAME_PROTOCOL gPcatIsaAcpiComponentName;
// //
// Prototypes for Driver model protocol interface // Prototypes for Driver model protocol interface
// //
/**
ControllerDriver Protocol Method
@param This Driver Binding protocol instance pointer.
@param Controller Handle of device to test.
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver supports this device.
@retval other This driver does not support this device.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PcatIsaAcpiDriverBindingSupported ( PcatIsaAcpiDriverBindingSupported (
@ -76,6 +77,18 @@ PcatIsaAcpiDriverBindingSupported (
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
); );
/**
Install EFI_ISA_ACPI_PROTOCOL.
@param This Driver Binding protocol instance pointer.
@param ControllerHandle Handle of device to bind driver to.
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver is added to ControllerHandle
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
@retval other This driver does not support this device
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PcatIsaAcpiDriverBindingStart ( PcatIsaAcpiDriverBindingStart (
@ -84,6 +97,20 @@ PcatIsaAcpiDriverBindingStart (
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
); );
/**
Stop this driver on ControllerHandle. Support stopping any child handles
created by this driver.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to stop driver on
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
children is zero stop the entire bus driver.
@param ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCESS This driver is removed ControllerHandle
@retval other This driver was not removed from this device
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PcatIsaAcpiDriverBindingStop ( PcatIsaAcpiDriverBindingStop (
@ -96,6 +123,17 @@ PcatIsaAcpiDriverBindingStop (
// //
// Prototypes for the ISA ACPI protocol interface // Prototypes for the ISA ACPI protocol interface
// //
/**
Enumerate the ISA devices on the ISA bus
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@retval EFI_NOT_FOUND Can not found the next Isa device.
@retval EFI_SUCESS Success retrieve the next Isa device for enumration.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaDeviceEnumerate ( IsaDeviceEnumerate (
@ -103,6 +141,17 @@ IsaDeviceEnumerate (
OUT EFI_ISA_ACPI_DEVICE_ID **Device OUT EFI_ISA_ACPI_DEVICE_ID **Device
); );
/**
Set ISA device power
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@param OnOff TRUE for setting isa device power on,
FALSE for setting isa device power off
@return EFI_SUCCESS Sucess to change power status for isa device.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaDeviceSetPower ( IsaDeviceSetPower (
@ -111,6 +160,16 @@ IsaDeviceSetPower (
IN BOOLEAN OnOff IN BOOLEAN OnOff
); );
/**
Get current resource for the specific ISA device.
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@param ResourceList On return, point to resources instances for given isa device
@retval EFI_NOT_FOUND Can not found the resource instance for given isa device
@retval EFI_SUCCESS Success to get resource instance for given isa device.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaGetCurrentResource ( IsaGetCurrentResource (
@ -119,6 +178,15 @@ IsaGetCurrentResource (
OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList
); );
/**
Get possible resource for the specific ISA device.
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@param ResourceList On return, point to resources instances for given isa device
@retval EFI_SUCCESS Success to get resource instance for given isa device.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaGetPossibleResource ( IsaGetPossibleResource (
@ -127,6 +195,16 @@ IsaGetPossibleResource (
OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList
); );
/**
Set resource for the specific ISA device.
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@param ResourceList Point to resources instances for given isa device
@return EFI_SUCESS Success to set resource.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaSetResource ( IsaSetResource (
@ -135,6 +213,16 @@ IsaSetResource (
IN EFI_ISA_ACPI_RESOURCE_LIST *ResourceList IN EFI_ISA_ACPI_RESOURCE_LIST *ResourceList
); );
/**
Enable/Disable the specific ISA device.
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@param Enable Enable/Disable
@return EFI_SUCESS Success to enable/disable.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaEnableDevice ( IsaEnableDevice (
@ -143,6 +231,15 @@ IsaEnableDevice (
IN BOOLEAN Enable IN BOOLEAN Enable
); );
/**
Initialize the specific ISA device.
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@param Device Point to device ID instance
@return EFI_SUCESS Success to initialize.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaInitDevice ( IsaInitDevice (
@ -150,6 +247,14 @@ IsaInitDevice (
IN EFI_ISA_ACPI_DEVICE_ID *Device IN EFI_ISA_ACPI_DEVICE_ID *Device
); );
/**
Initialize the ISA interface.
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
@return EFI_SUCESS Success to initialize ISA interface.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
IsaInterfaceInit ( IsaInterfaceInit (

44
PcAtChipsetPkg/KbcResetDxe/Reset.c
View File

@ -1,7 +1,8 @@
/*++ /** @file
Reset Architectural Protocol implementation
Copyright (c) 2006, Intel Corporation Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved. <BR>
All rights reserved. This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
@ -9,17 +10,19 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: **/
Reset.c
Abstract:
Reset Architectural Protocol implementation
--*/
#include "Reset.h" #include "Reset.h"
/**
Reset the system.
@param ResetType warm or cold
@param ResetStatus possible cause of reset
@param DataSize Size of ResetData in bytes
@param ResetData Optional Unicode string
**/
VOID VOID
EFIAPI EFIAPI
KbcResetSystem ( KbcResetSystem (
@ -28,25 +31,6 @@ KbcResetSystem (
IN UINTN DataSize, IN UINTN DataSize,
IN VOID *ResetData OPTIONAL IN VOID *ResetData OPTIONAL
) )
/*++
Routine Description:
Reset the system.
Arguments:
ResetType - warm or cold
ResetStatus - possible cause of reset
DataSize - Size of ResetData in bytes
ResetData - Optional Unicode string
For details, see efiapi.h
Returns:
Does not return if the reset takes place.
EFI_INVALID_PARAMETER If ResetType is invalid.
--*/
{ {
UINT8 Data; UINT8 Data;

71
PcAtChipsetPkg/KbcResetDxe/Reset.h
View File

@ -1,7 +1,9 @@
/*++ /** @file
Copyright (c) 2006, Intel Corporation Definitions for reset
All rights reserved. This program and the accompanying materials
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved. <BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
@ -9,14 +11,7 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: **/
Reset.h
Abstract:
some definitions for reset
--*/
#ifndef _KBC_RESET_H #ifndef _KBC_RESET_H
#define _KBC_RESET_H #define _KBC_RESET_H
@ -30,30 +25,34 @@ Abstract:
#include <Protocol/Reset.h> #include <Protocol/Reset.h>
/**
Initialize the state information for the Reset Architectural Protocol
@param ImageHandle Handle of the loaded driver
@param SystemTable Pointer to the System Table
@retval EFI_SUCCESS Thread can be successfully created
@retval EFI_OUT_OF_RESOURCES Cannot allocate protocol data structure
@retval EFI_DEVICE_ERROR Cannot create the timer service
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
InitializeReset ( InitializeReset (
IN EFI_HANDLE ImageHandle, IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable IN EFI_SYSTEM_TABLE *SystemTable
) )
/*++
Routine Description:
TODO: Add function description
Arguments:
ImageHandle - TODO: add argument description
SystemTable - TODO: add argument description
Returns:
TODO: add return values
--*/
; ;
/**
Reset the system.
@param ResetType warm or cold
@param ResetStatus possible cause of reset
@param DataSize Size of ResetData in bytes
@param ResetData Optional Unicode string
**/
VOID VOID
EFIAPI EFIAPI
KbcResetSystem ( KbcResetSystem (
@ -62,24 +61,6 @@ KbcResetSystem (
IN UINTN DataSize, IN UINTN DataSize,
IN VOID *ResetData OPTIONAL IN VOID *ResetData OPTIONAL
) )
/*++
Routine Description:
TODO: Add function description
Arguments:
ResetType - TODO: add argument description
ResetStatus - TODO: add argument description
DataSize - TODO: add argument description
ResetData - TODO: add argument description
Returns:
TODO: add return values
--*/
; ;
#endif #endif

44
PcAtChipsetPkg/KbcResetDxe/ResetEntry.c
View File

@ -1,17 +1,15 @@
/*++ /** @file
Driver entry for KbcReset driver.
Copyright (c) 2009, Intel Corporation Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved. <BR>
All rights reserved. This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
--*/
#include "Reset.h" #include "Reset.h"
@ -21,33 +19,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
EFI_HANDLE mResetHandle = NULL; EFI_HANDLE mResetHandle = NULL;
/**
Initialize the state information for the Reset Architectural Protocol
@param ImageHandle Handle of the loaded driver
@param SystemTable Pointer to the System Table
@retval EFI_SUCCESS Thread can be successfully created
@retval EFI_OUT_OF_RESOURCES Cannot allocate protocol data structure
@retval EFI_DEVICE_ERROR Cannot create the timer service
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
InitializeReset ( InitializeReset (
IN EFI_HANDLE ImageHandle, IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable IN EFI_SYSTEM_TABLE *SystemTable
) )
/*++
Routine Description:
Initialize the state information for the Reset Architectural Protocol
Arguments:
ImageHandle of the loaded driver
Pointer to the System Table
Returns:
Status
EFI_SUCCESS - thread can be successfully created
EFI_OUT_OF_RESOURCES - cannot allocate protocol data structure
EFI_DEVICE_ERROR - cannot create the timer service
--*/
// TODO: SystemTable - add argument and description to function comment
{ {
EFI_STATUS Status; EFI_STATUS Status;

4
PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcatRealTimeClockRuntimeDxe.inf
View File

@ -5,8 +5,8 @@
# This driver provides GetTime, SetTime, GetWakeupTime, SetWakeupTime services to Runtime Service Table. # This driver provides GetTime, SetTime, GetWakeupTime, SetWakeupTime services to Runtime Service Table.
# It will install a tagging protocol with gEfiRealTimeClockArchProtocolGuid. # It will install a tagging protocol with gEfiRealTimeClockArchProtocolGuid.
# #
# Copyright (c) 2006 - 2010, Intel Corporation. <BR> # Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved. <BR>
# All rights reserved. This program and the accompanying materials # This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License # are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at # which accompanies this distribution. The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php # http://opensource.org/licenses/bsd-license.php

395
PcAtChipsetPkg/PciHostBridgeDxe/PciHostBridge.c
View File

@ -1,15 +1,14 @@
/** @file /** @file
Pci Host Bridge driver:
Provides the basic interfaces to abstract a PCI Host Bridge Resource Allocation Provides the basic interfaces to abstract a PCI Host Bridge Resource Allocation
Copyright (c) 2008 - 2009, Intel Corporation<BR> All rights Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved. <BR>
reserved. This program and the accompanying materials are This program and the accompanying materials are
licensed and made available under the terms and conditions of the BSD License licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/ **/
@ -79,26 +78,22 @@ PCI_HOST_BRIDGE_INSTANCE mPciHostBridgeInstanceTemplate = {
// //
// Implementation // Implementation
// //
/**
Entry point of this driver
@param ImageHandle Handle of driver image
@param SystemTable Point to EFI_SYSTEM_TABLE
@retval EFI_OUT_OF_RESOURCES Can not allocate memory resource
@retval EFI_DEVICE_ERROR Can not install the protocol instance
@retval EFI_SUCCESS Success to initialize the Pci host bridge.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
InitializePciHostBridge ( InitializePciHostBridge (
IN EFI_HANDLE ImageHandle, IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable IN EFI_SYSTEM_TABLE *SystemTable
) )
/*++
Routine Description:
Entry point of this driver
Arguments:
ImageHandle -
SystemTable -
Returns:
--*/
{ {
EFI_STATUS Status; EFI_STATUS Status;
UINTN Loop1; UINTN Loop1;
@ -194,24 +189,76 @@ Returns:
} }
/**
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] PciResAlloc 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 EFI_STATUS
EFIAPI EFIAPI
NotifyPhase( NotifyPhase(
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This, IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase
) )
/*++
Routine Description:
Enter a certain phase of the PCI enumeration process
Arguments:
This -- The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance
Phase -- The phase during enumeration
Returns:
--*/
{ {
PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance; PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;
PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance; PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance;
@ -460,28 +507,34 @@ Returns:
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
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 EFI_STATUS
EFIAPI EFIAPI
GetNextRootBridge( GetNextRootBridge(
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This, IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *This,
IN OUT EFI_HANDLE *RootBridgeHandle IN OUT EFI_HANDLE *RootBridgeHandle
) )
/*++
Routine Description:
Return the device handle of the next PCI root bridge that is associated with
this Host Bridge
Arguments:
This -- The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
RootBridgeHandle -- Returns the device handle of the next PCI Root Bridge.
On input, it holds the RootBridgeHandle returned by the most
recent call to GetNextRootBridge().The handle for the first
PCI Root Bridge is returned if RootBridgeHandle is NULL on input
Returns:
--*/
{ {
BOOLEAN NoRootBridge; BOOLEAN NoRootBridge;
LIST_ENTRY *List; LIST_ENTRY *List;
@ -528,6 +581,44 @@ Returns:
} }
} }
/**
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 EFI_STATUS
EFIAPI EFIAPI
GetAttributes( GetAttributes(
@ -535,20 +626,6 @@ GetAttributes(
IN EFI_HANDLE RootBridgeHandle, IN EFI_HANDLE RootBridgeHandle,
OUT UINT64 *Attributes OUT UINT64 *Attributes
) )
/*++
Routine Description:
Returns the attributes of a PCI Root Bridge.
Arguments:
This -- The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
RootBridgeHandle -- The device handle of the PCI Root Bridge
that the caller is interested in
Attribute -- The pointer to attributes of the PCI Root Bridge
Returns:
--*/
{ {
LIST_ENTRY *List; LIST_ENTRY *List;
PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance; PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;
@ -577,6 +654,21 @@ Returns:
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
/**
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 EFI_STATUS
EFIAPI EFIAPI
StartBusEnumeration( StartBusEnumeration(
@ -584,20 +676,6 @@ StartBusEnumeration(
IN EFI_HANDLE RootBridgeHandle, IN EFI_HANDLE RootBridgeHandle,
OUT VOID **Configuration OUT VOID **Configuration
) )
/*++
Routine Description:
This is the request from the PCI enumerator to set up
the specified PCI Root Bridge for bus enumeration process.
Arguments:
This -- The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
RootBridgeHandle -- The PCI Root Bridge to be set up
Configuration -- Pointer to the pointer to the PCI bus resource descriptor
Returns:
--*/
{ {
LIST_ENTRY *List; LIST_ENTRY *List;
PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance; PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;
@ -653,6 +731,30 @@ Returns:
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
/**
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 EFI_STATUS
EFIAPI EFIAPI
SetBusNumbers( SetBusNumbers(
@ -660,20 +762,6 @@ SetBusNumbers(
IN EFI_HANDLE RootBridgeHandle, IN EFI_HANDLE RootBridgeHandle,
IN VOID *Configuration IN VOID *Configuration
) )
/*++
Routine Description:
This function programs the PCI Root Bridge hardware so that
it decodes the specified PCI bus range
Arguments:
This -- The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
RootBridgeHandle -- The PCI Root Bridge whose bus range is to be programmed
Configuration -- The pointer to the PCI bus resource descriptor
Returns:
--*/
{ {
LIST_ENTRY *List; LIST_ENTRY *List;
PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance; PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;
@ -746,6 +834,31 @@ Returns:
} }
/**
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 EFI_STATUS
EFIAPI EFIAPI
SubmitResources( SubmitResources(
@ -753,19 +866,6 @@ SubmitResources(
IN EFI_HANDLE RootBridgeHandle, IN EFI_HANDLE RootBridgeHandle,
IN VOID *Configuration IN VOID *Configuration
) )
/*++
Routine Description:
Submits the I/O and memory resource requirements for the specified PCI Root Bridge
Arguments:
This -- The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
RootBridgeHandle -- The PCI Root Bridge whose I/O and memory resource requirements
are being submitted
Configuration -- The pointer to the PCI I/O and PCI memory resource descriptor
Returns:
--*/
{ {
LIST_ENTRY *List; LIST_ENTRY *List;
PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance; PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;
@ -883,6 +983,26 @@ Returns:
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
/**
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 EFI_STATUS
EFIAPI EFIAPI
GetProposedResources( GetProposedResources(
@ -890,21 +1010,6 @@ GetProposedResources(
IN EFI_HANDLE RootBridgeHandle, IN EFI_HANDLE RootBridgeHandle,
OUT VOID **Configuration OUT VOID **Configuration
) )
/*++
Routine Description:
This function returns the proposed resource settings for the specified
PCI Root Bridge
Arguments:
This -- The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
RootBridgeHandle -- The PCI Root Bridge handle
Configuration -- The pointer to the pointer to the PCI I/O
and memory resource descriptor
Returns:
--*/
{ {
LIST_ENTRY *List; LIST_ENTRY *List;
PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance; PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;
@ -1053,6 +1158,12 @@ Returns:
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
/**
Update attribute for PCI root bridge for specifc device.
@param RootBridge Point to PCI root bridge.
@param PciAddress The specific device PCI address
**/
STATIC STATIC
VOID VOID
UpdateRootBridgeAttributes ( UpdateRootBridgeAttributes (
@ -1151,6 +1262,33 @@ UpdateRootBridgeAttributes (
RootBridge->Supports = Attributes; RootBridge->Supports = Attributes;
} }
/**
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 EFI_STATUS
EFIAPI EFIAPI
PreprocessController ( PreprocessController (
@ -1159,21 +1297,6 @@ PreprocessController (
IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS PciAddress, IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS PciAddress,
IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase
) )
/*++
Routine Description:
This function is called for all the PCI controllers that the PCI
bus driver finds. Can be used to Preprogram the controller.
Arguments:
This -- The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
RootBridgeHandle -- The PCI Root Bridge handle
PciBusAddress -- Address of the controller on the PCI bus
Phase -- The Phase during resource allocation
Returns:
EFI_SUCCESS
--*/
{ {
PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance; PCI_HOST_BRIDGE_INSTANCE *HostBridgeInstance;
PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance; PCI_ROOT_BRIDGE_INSTANCE *RootBridgeInstance;

4
PcAtChipsetPkg/PciHostBridgeDxe/PciHostBridgeDxe.inf
View File

@ -2,8 +2,8 @@
# #
# Component description file a sinngle segment PCI Host Bridge driver. # Component description file a sinngle segment PCI Host Bridge driver.
# #
# Copyright (c) 2008 - 2010, Intel Corporation. <BR> # Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved. <BR>
# All rights reserved. This program and the accompanying materials # This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License # are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at # which accompanies this distribution. The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php # http://opensource.org/licenses/bsd-license.php

965
PcAtChipsetPkg/PciHostBridgeDxe/PciRootBridgeIo.c
View File

File diff suppressed because it is too large Load Diff