tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update comments to conform to the new, Doxygen friendly, coding standard. These are structural changes only. There is NO NEW CONTENT. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@461 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
darylm503 2006-06-09 23:41:12 +00:00
parent 1f0032d8b9
commit ed72955cc8
18 changed files with 3639 additions and 5649 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
EdkModulePkg/Application/HelloWorld/HelloWorld.c
View File

@ -1,4 +1,5 @@
/*++
/** @file
This driver supports platform security service
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
@ -9,15 +10,7 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
HelloWorld.c
Abstract:
This driver supports platform security service
--*/
**/
VOID
Print (

992
EdkModulePkg/Bus/Pci/AtapiPassThru/Dxe/AtapiPassThru.c
View File

File diff suppressed because it is too large Load Diff

641
EdkModulePkg/Bus/Pci/AtapiPassThru/Dxe/AtapiPassThru.h
View File

@ -1,5 +1,4 @@
/*++
/** @file
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -9,15 +8,9 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
Module Name: AtapiPassThru.h
AtapiPassThru.h
Abstract:
Revision History
--*/
**/
#ifndef _APT_H
#define _APT_H
@ -25,12 +18,13 @@ Revision History
#include <IndustryStandard/pci22.h>
//
// bit definition
//
///
/// bit definition
///
#define bit(a) 1 << (a)
#define MAX_TARGET_ID 4
//
// IDE Registers
//
@ -49,9 +43,9 @@ typedef union {
UINT16 DeviceControl; /* when write */
} IDE_AltStatus_OR_DeviceControl;
//
// IDE registers set
//
///
/// IDE registers set
///
typedef struct {
UINT16 Data;
IDE_ERROR_OR_FEATURE Reg1;
@ -167,21 +161,21 @@ typedef struct {
//
// ATA Err Reg bitmap
//
#define BBK_ERR bit (7) /* Bad block detected */
#define UNC_ERR bit (6) /* Uncorrectable Data */
#define MC_ERR bit (5) /* Media Change */
#define IDNF_ERR bit (4) /* ID Not Found */
#define MCR_ERR bit (3) /* Media Change Requested */
#define ABRT_ERR bit (2) /* Aborted Command */
#define TK0NF_ERR bit (1) /* Track 0 Not Found */
#define AMNF_ERR bit (0) /* Address Mark Not Found */
#define BBK_ERR bit (7) ///< Bad block detected
#define UNC_ERR bit (6) ///< Uncorrectable Data
#define MC_ERR bit (5) ///< Media Change
#define IDNF_ERR bit (4) ///< ID Not Found
#define MCR_ERR bit (3) ///< Media Change Requested
#define ABRT_ERR bit (2) ///< Aborted Command
#define TK0NF_ERR bit (1) ///< Track 0 Not Found
#define AMNF_ERR bit (0) ///< Address Mark Not Found
//
// ATAPI Err Reg bitmap
//
#define SENSE_KEY_ERR (bit (7) | bit (6) | bit (5) | bit (4))
#define EOM_ERR bit (1) /* End of Media Detected */
#define ILI_ERR bit (0) /* Illegal Length Indication */
#define EOM_ERR bit (1) ///< End of Media Detected
#define ILI_ERR bit (0) ///< Illegal Length Indication
//
// Device/Head Reg
@ -201,21 +195,21 @@ typedef struct {
//
// Status Reg
//
#define BSY bit (7) /* Controller Busy */
#define DRDY bit (6) /* Drive Ready */
#define DWF bit (5) /* Drive Write Fault */
#define DSC bit (4) /* Disk Seek Complete */
#define DRQ bit (3) /* Data Request */
#define CORR bit (2) /* Corrected Data */
#define IDX bit (1) /* Index */
#define ERR bit (0) /* Error */
#define CHECK bit (0) /* Check bit for ATAPI Status Reg */
#define BSY bit (7) ///< Controller Busy
#define DRDY bit (6) ///< Drive Ready
#define DWF bit (5) ///< Drive Write Fault
#define DSC bit (4) ///< Disk Seek Complete
#define DRQ bit (3) ///< Data Request
#define CORR bit (2) ///< Corrected Data
#define IDX bit (1) ///< Index
#define ERR bit (0) ///< Error
#define CHECK bit (0) ///< Check bit for ATAPI Status Reg
//
// Device Control Reg
//
#define SRST bit (2) /* Software Reset */
#define IEN_L bit (1) /* Interrupt Enable #*/
#define SRST bit (2) ///< Software Reset
#define IEN_L bit (1) ///< Interrupt Enable
//
// ATAPI Feature Register
@ -242,55 +236,63 @@ typedef struct {
//
// function prototype
//
/**
AtapiScsiPassThruDriverEntryPoint
@param ImageHandle
@param SystemTable
@todo Add function description
@todo ImageHandle - add argument description
@todo SystemTable - add argument description
@todo add return values
--*/
EFI_STATUS
EFIAPI
AtapiScsiPassThruDriverEntryPoint (
IN EFI_HANDLE ImageHandle,
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
--*/
;
/**
RegisterAtapiScsiPassThru
@param This
@param Controller
@param PciIo
@todo Add function description
@todo This add argument description
@todo Controller add argument description
@todo PciIo add argument description
@todo add return values
**/
EFI_STATUS
RegisterAtapiScsiPassThru (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN EFI_PCI_IO_PROTOCOL *PciIo
)
/*++
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
Controller - TODO: add argument description
PciIo - TODO: add argument description
Returns:
TODO: add return values
--*/
;
/**
AtapiScsiPassThruFunction
@param This
@param Target
@param Lun
@param Packet
@param Event
@todo Add function description
@todo This - add argument description
@todo Target - add argument description
@todo Lun - add argument description
@todo Packet - add argument description
@todo Event - add argument description
@todo add return values
**/
EFI_STATUS
EFIAPI
AtapiScsiPassThruFunction (
@ -300,27 +302,20 @@ AtapiScsiPassThruFunction (
IN OUT EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,
IN EFI_EVENT Event OPTIONAL
)
/*++
;
Routine Description:
/**
AtapiScsiPassThruGetNextDevice
TODO: Add function description
Arguments:
This - TODO: add argument description
Target - TODO: add argument description
Lun - TODO: add argument description
Packet - TODO: add argument description
Event - TODO: add argument description
Returns:
@param This TODO: add argument description
@param Target TODO: add argument description
@param Lun TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
AtapiScsiPassThruGetNextDevice (
@ -328,25 +323,21 @@ AtapiScsiPassThruGetNextDevice (
IN OUT UINT32 *Target,
IN OUT UINT64 *Lun
)
/*++
;
Routine Description:
/**
AtapiScsiPassThruBuildDevicePath
TODO: Add function description
Arguments:
This - TODO: add argument description
Target - TODO: add argument description
Lun - TODO: add argument description
Returns:
@param This TODO: add argument description
@param Target TODO: add argument description
@param Lun TODO: add argument description
@param DevicePath TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
AtapiScsiPassThruBuildDevicePath (
@ -355,26 +346,21 @@ AtapiScsiPassThruBuildDevicePath (
IN UINT64 Lun,
IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath
)
/*++
;
Routine Description:
/**
AtapiScsiPassThruGetTargetLun
TODO: Add function description
Arguments:
This - TODO: add argument description
Target - TODO: add argument description
Lun - TODO: add argument description
DevicePath - TODO: add argument description
Returns:
@param This TODO: add argument description
@param DevicePath TODO: add argument description
@param Target TODO: add argument description
@param Lun TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
AtapiScsiPassThruGetTargetLun (
@ -383,48 +369,37 @@ AtapiScsiPassThruGetTargetLun (
OUT UINT32 *Target,
OUT UINT64 *Lun
)
/*++
;
Routine Description:
/**
AtapiScsiPassThruResetChannel
TODO: Add function description
Arguments:
This - TODO: add argument description
DevicePath - TODO: add argument description
Target - TODO: add argument description
Lun - TODO: add argument description
Returns:
@param This TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
AtapiScsiPassThruResetChannel (
IN EFI_SCSI_PASS_THRU_PROTOCOL *This
)
/*++
;
Routine Description:
/**
AtapiScsiPassThruResetTarget
TODO: Add function description
Arguments:
This - TODO: add argument description
Returns:
@param This TODO: add argument description
@param Target TODO: add argument description
@param Lun TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
AtapiScsiPassThruResetTarget (
@ -432,92 +407,74 @@ AtapiScsiPassThruResetTarget (
IN UINT32 Target,
IN UINT64 Lun
)
/*++
;
Routine Description:
/**
CheckSCSIRequestPacket
TODO: Add function description
Arguments:
This - TODO: add argument description
Target - TODO: add argument description
Lun - TODO: add argument description
Returns:
@param Packet TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
CheckSCSIRequestPacket (
EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
)
/*++
;
Routine Description:
/**
SubmitBlockingIoCommand
TODO: Add function description
Arguments:
Packet - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
@param Target TODO: add argument description
@param Packet TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
SubmitBlockingIoCommand (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate,
UINT32 Target,
EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
)
/*++
;
Routine Description:
/**
IsCommandValid
TODO: Add function description
Arguments:
@param Packet - TODO: add argument description
AtapiScsiPrivate - TODO: add argument description
Target - TODO: add argument description
Packet - TODO: add argument description
Returns:
TODO: add return values
@return TODO: add return values
--*/
;
BOOLEAN
IsCommandValid (
EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
)
/*++
;
Routine Description:
/**
RequestSenseCommand
TODO: Add function description
Arguments:
Packet - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
@param Target TODO: add argument description
@param Timeout TODO: add argument description
@param SenseData TODO: add argument description
@param SenseDataLength TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
RequestSenseCommand (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate,
@ -526,27 +483,24 @@ RequestSenseCommand (
VOID *SenseData,
UINT8 *SenseDataLength
)
/*++
;
Routine Description:
/**
AtapiPacketCommand
TODO: Add function description
Arguments:
AtapiScsiPrivate - TODO: add argument description
Target - TODO: add argument description
Timeout - TODO: add argument description
SenseData - TODO: add argument description
SenseDataLength - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
@param Target TODO: add argument description
@param PacketCommand TODO: add argument description
@param Buffer TODO: add argument description
@param ByteCount TODO: add argument description
@param Direction TODO: add argument description
@param TimeOutInMicroSeconds TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
AtapiPacketCommand (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate,
@ -557,313 +511,236 @@ AtapiPacketCommand (
DATA_DIRECTION Direction,
UINT64 TimeOutInMicroSeconds
)
/*++
Routine Description:
TODO: Add function description
Arguments:
AtapiScsiPrivate - TODO: add argument description
Target - TODO: add argument description
PacketCommand - TODO: add argument description
Buffer - TODO: add argument description
ByteCount - TODO: add argument description
Direction - TODO: add argument description
TimeOutInMicroSeconds - TODO: add argument description
Returns:
TODO: add return values
--*/
;
/**
ReadPortB
TODO: Add function description
@param PciIo TODO: add argument description
@param Port TODO: add argument description
TODO: add return values
**/
UINT8
ReadPortB (
IN EFI_PCI_IO_PROTOCOL *PciIo,
IN UINT16 Port
)
/*++
Routine Description:
TODO: Add function description
Arguments:
PciIo - TODO: add argument description
Port - TODO: add argument description
Returns:
TODO: add return values
--*/
;
/**
ReadPortW
TODO: Add function description
@param PciIo TODO: add argument description
@param Port TODO: add argument description
TODO: add return values
**/
UINT16
ReadPortW (
IN EFI_PCI_IO_PROTOCOL *PciIo,
IN UINT16 Port
)
/*++
Routine Description:
TODO: Add function description
Arguments:
PciIo - TODO: add argument description
Port - TODO: add argument description
Returns:
TODO: add return values
--*/
;
/**
WritePortB
TODO: Add function description
@param PciIo TODO: add argument description
@param Port TODO: add argument description
@param Data TODO: add argument description
TODO: add return values
**/
VOID
WritePortB (
IN EFI_PCI_IO_PROTOCOL *PciIo,
IN UINT16 Port,
IN UINT8 Data
)
/*++
Routine Description:
TODO: Add function description
Arguments:
PciIo - TODO: add argument description
Port - TODO: add argument description
Data - TODO: add argument description
Returns:
TODO: add return values
--*/
;
/**
WritePortW
TODO: Add function description
@param PciIo TODO: add argument description
@param Port TODO: add argument description
@param Data TODO: add argument description
TODO: add return values
**/
VOID
WritePortW (
IN EFI_PCI_IO_PROTOCOL *PciIo,
IN UINT16 Port,
IN UINT16 Data
)
/*++
;
Routine Description:
/**
StatusDRQClear
TODO: Add function description
Arguments:
PciIo - TODO: add argument description
Port - TODO: add argument description
Data - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
@param TimeOutInMicroSeconds TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
StatusDRQClear (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate,
UINT64 TimeOutInMicroSeconds
)
/*++
;
Routine Description:
/**
AltStatusDRQClear
TODO: Add function description
Arguments:
AtapiScsiPrivate - TODO: add argument description
TimeOutInMicroSeconds - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
@param TimeOutInMicroSeconds TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
AltStatusDRQClear (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate,
UINT64 TimeOutInMicroSeconds
)
/*++
;
Routine Description:
/**
StatusDRQReady
TODO: Add function description
Arguments:
AtapiScsiPrivate - TODO: add argument description
TimeOutInMicroSeconds - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
@param TimeOutInMicroSeconds TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
StatusDRQReady (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate,
UINT64 TimeOutInMicroSeconds
)
/*++
;
Routine Description:
/**
AltStatusDRQReady
TODO: Add function description
Arguments:
AtapiScsiPrivate - TODO: add argument description
TimeOutInMicroSeconds - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
@param TimeOutInMicroSeconds TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
AltStatusDRQReady (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate,
UINT64 TimeOutInMicroSeconds
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
AtapiScsiPrivate - TODO: add argument description
TimeOutInMicroSeconds - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
@param TimeoutInMicroSeconds TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
StatusWaitForBSYClear (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate,
UINT64 TimeoutInMicroSeconds
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
AtapiScsiPrivate - TODO: add argument description
TimeoutInMicroSeconds - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
@param TimeoutInMicroSeconds TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
AltStatusWaitForBSYClear (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate,
UINT64 TimeoutInMicroSeconds
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
AtapiScsiPrivate - TODO: add argument description
TimeoutInMicroSeconds - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
@param TimeoutInMicroSeconds TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
StatusDRDYReady (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate,
UINT64 TimeoutInMicroSeconds
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
AtapiScsiPrivate - TODO: add argument description
TimeoutInMicroSeconds - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
@param TimeoutInMicroSeconds TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
AltStatusDRDYReady (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate,
UINT64 TimeoutInMicroSeconds
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
AtapiScsiPrivate - TODO: add argument description
TimeoutInMicroSeconds - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
@param Buffer TODO: add argument description
@param ByteCount TODO: add argument description
@param Direction TODO: add argument description
@param TimeOutInMicroSeconds TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
AtapiPassThruPioReadWriteData (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate,
@ -872,45 +749,19 @@ AtapiPassThruPioReadWriteData (
DATA_DIRECTION Direction,
UINT64 TimeOutInMicroSeconds
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
AtapiScsiPrivate - TODO: add argument description
Buffer - TODO: add argument description
ByteCount - TODO: add argument description
Direction - TODO: add argument description
TimeOutInMicroSeconds - TODO: add argument description
Returns:
@param AtapiScsiPrivate TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
AtapiPassThruCheckErrorStatus (
ATAPI_SCSI_PASS_THRU_DEV *AtapiScsiPrivate
)
/*++
Routine Description:
TODO: Add function description
Arguments:
AtapiScsiPrivate - TODO: add argument description
Returns:
TODO: add return values
--*/
;
#endif

151
EdkModulePkg/Bus/Pci/AtapiPassThru/Dxe/ComponentName.c
View File

@ -1,5 +1,4 @@
/*++
/** @file
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -9,13 +8,9 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
Module Name: ComponentName.c
ComponentName.c
Abstract:
--*/
**/
#include "AtapiPassThru.h"
//
@ -39,9 +34,9 @@ AtapiScsiPassThruComponentNameGetControllerName (
OUT CHAR16 **ControllerName
);
//
// EFI Component Name Protocol
//
///
/// EFI Component Name Protocol
///
EFI_COMPONENT_NAME_PROTOCOL gAtapiScsiPassThruComponentName = {
AtapiScsiPassThruComponentNameGetDriverName,
AtapiScsiPassThruComponentNameGetControllerName,
@ -53,6 +48,28 @@ static EFI_UNICODE_STRING_TABLE mAtapiScsiPassThruDriverNameTable[] = {
{ NULL , NULL }
};
/**
Retrieves a Unicode string that is the user readable name of the EFI Driver.
@param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
@param 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.
@param 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.
@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
EFIAPI
AtapiScsiPassThruComponentNameGetDriverName (
@ -60,32 +77,6 @@ AtapiScsiPassThruComponentNameGetDriverName (
IN CHAR8 *Language,
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_SUCCESS - 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 LookupUnicodeString (
Language,
@ -95,6 +86,47 @@ AtapiScsiPassThruComponentNameGetDriverName (
);
}
/**
Retrieves a Unicode string that is the user readable name of the controller
that is being managed by an EFI Driver.
@param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
@param ControllerHandle The handle of a controller that the driver specified by
This is managing. This handle specifies the controller
whose name is to be returned.
@param 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.
@param 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.
@param 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.
@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
EFIAPI
AtapiScsiPassThruComponentNameGetControllerName (
@ -104,51 +136,6 @@ AtapiScsiPassThruComponentNameGetControllerName (
IN CHAR8 *Language,
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;
}

96
EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.c
View File

@ -1,20 +1,4 @@
/*++
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
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
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
CirrusLogic5430.c
Abstract:
/** @file
Cirrus Logic 5430 Controller Driver.
This driver is a sample implementation of the UGA Draw Protocol for the
Cirrus Logic 5430 family of PCI video controllers. This driver is only
@ -25,9 +9,16 @@ Abstract:
documentation on UGA for details on how to write a UGA driver that is able
to function both in the EFI pre-boot environment and from the OS runtime.
Revision History:
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
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
http://opensource.org/licenses/bsd-license.php
--*/
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
//
// Cirrus Logic 5430 Controller Driver
@ -44,6 +35,13 @@ EFI_DRIVER_BINDING_PROTOCOL gCirrusLogic5430DriverBinding = {
NULL
};
/**
CirrusLogic5430ControllerDriverSupported
TODO: This - add argument and description to function comment
TODO: Controller - add argument and description to function comment
TODO: RemainingDevicePath - add argument and description to function comment
**/
EFI_STATUS
EFIAPI
CirrusLogic5430ControllerDriverSupported (
@ -51,20 +49,6 @@ CirrusLogic5430ControllerDriverSupported (
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
)
/*++
Routine Description:
Arguments:
Returns:
None
--*/
// TODO: This - add argument and description to function comment
// TODO: Controller - add argument and description to function comment
// TODO: RemainingDevicePath - add argument and description to function comment
{
EFI_STATUS Status;
EFI_PCI_IO_PROTOCOL *PciIo;
@ -139,6 +123,13 @@ Done:
return Status;
}
/**
CirrusLogic5430ControllerDriverStart
TODO: This - add argument and description to function comment
TODO: Controller - add argument and description to function comment
TODO: RemainingDevicePath - add argument and description to function comment
**/
EFI_STATUS
EFIAPI
CirrusLogic5430ControllerDriverStart (
@ -146,20 +137,6 @@ CirrusLogic5430ControllerDriverStart (
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
)
/*++
Routine Description:
Arguments:
Returns:
None
--*/
// TODO: This - add argument and description to function comment
// TODO: Controller - add argument and description to function comment
// TODO: RemainingDevicePath - add argument and description to function comment
{
EFI_STATUS Status;
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private;
@ -253,6 +230,15 @@ Error:
return Status;
}
/**
CirrusLogic5430ControllerDriverStop
TODO: This - add argument and description to function comment
TODO: Controller - add argument and description to function comment
TODO: NumberOfChildren - add argument and description to function comment
TODO: ChildHandleBuffer - add argument and description to function comment
TODO: EFI_SUCCESS - add return value to function comment
**/
EFI_STATUS
EFIAPI
CirrusLogic5430ControllerDriverStop (
@ -261,22 +247,6 @@ CirrusLogic5430ControllerDriverStop (
IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer
)
/*++
Routine Description:
Arguments:
Returns:
None
--*/
// TODO: This - add argument and description to function comment
// TODO: Controller - add argument and description to function comment
// TODO: NumberOfChildren - add argument and description to function comment
// TODO: ChildHandleBuffer - add argument and description to function comment
// TODO: EFI_SUCCESS - add return value to function comment
{
EFI_UGA_DRAW_PROTOCOL *UgaDraw;
EFI_STATUS Status;

145
EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.h
View File

@ -1,4 +1,5 @@
/*++
/** @file
Cirrus Logic 5430 Controller Driver
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
@ -9,17 +10,7 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
CirrusLogic5430.h
Abstract:
Cirrus Logic 5430 Controller Driver
Revision History
--*/
**/
//
// Cirrus Logic 5430 Controller Driver
@ -99,78 +90,67 @@ extern EFI_COMPONENT_NAME_PROTOCOL gCirrusLogic5430ComponentName;
//
// UGA Draw Hardware abstraction internal worker functions
//
/**
TODO: Add function description
@param Private TODO: add argument description
TODO: add return values
**/
EFI_STATUS
CirrusLogic5430UgaDrawConstructor (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
Private - TODO: add argument description
Returns:
@param Private TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
CirrusLogic5430UgaDrawDestructor (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private
)
/*++
Routine Description:
TODO: Add function description
Arguments:
Private - TODO: add argument description
Returns:
TODO: add return values
--*/
;
//
// EFI 1.1 driver model prototypes for Cirrus Logic 5430 UGA Draw
//
/**
TODO: Add function description
@param ImageHandle TODO: add argument description
@param SystemTable TODO: add argument description
TODO: add return values
**/
EFI_STATUS
EFIAPI
CirrusLogic5430DriverEntryPoint (
IN EFI_HANDLE ImageHandle,
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
--*/
;
//
// EFI_DRIVER_BINDING_PROTOCOL Protocol Interface
//
/**
TODO: Add function description
@param This TODO: add argument description
@param Controller TODO: add argument description
@param RemainingDevicePath TODO: add argument description
TODO: add return values
**/
EFI_STATUS
EFIAPI
CirrusLogic5430ControllerDriverSupported (
@ -178,25 +158,18 @@ CirrusLogic5430ControllerDriverSupported (
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
This - TODO: add argument description
Controller - TODO: add argument description
RemainingDevicePath - TODO: add argument description
Returns:
@param This TODO: add argument description
@param Controller TODO: add argument description
@param RemainingDevicePath TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
CirrusLogic5430ControllerDriverStart (
@ -204,25 +177,19 @@ CirrusLogic5430ControllerDriverStart (
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
This - TODO: add argument description
Controller - TODO: add argument description
RemainingDevicePath - TODO: add argument description
Returns:
@param This TODO: add argument description
@param Controller TODO: add argument description
@param NumberOfChildren TODO: add argument description
@param ChildHandleBuffer TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
CirrusLogic5430ControllerDriverStop (
@ -231,24 +198,6 @@ CirrusLogic5430ControllerDriverStop (
IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer
)
/*++
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
Controller - TODO: add argument description
NumberOfChildren - TODO: add argument description
ChildHandleBuffer - TODO: add argument description
Returns:
TODO: add return values
--*/
;
#endif

431
EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430UgaDraw.c
View File

@ -1,4 +1,7 @@
/*++
/** @file
This file produces the graphics abstration of UGA Draw. It is called by
CirrusLogic5430.c file which deals with the EFI 1.1 driver model.
This file just does graphics.
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
@ -9,23 +12,13 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
CirrusLogic5430UgaDraw.c
Abstract:
This file produces the graphics abstration of UGA Draw. It is called by
CirrusLogic5430.c file which deals with the EFI 1.1 driver model.
This file just does graphics.
--*/
**/
#include "CirrusLogic5430.h"
//
// Video Mode structure
//
///
/// Video Mode structure
///
typedef struct {
UINT32 Width;
UINT32 Height;
@ -36,18 +29,18 @@ typedef struct {
UINT8 MiscSetting;
} CIRRUS_LOGIC_5430_VIDEO_MODES;
//
// Generic Attribute Controller Register Settings
//
///
/// Generic Attribute Controller Register Settings
///
static UINT8 AttributeController[21] = {
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F,
0x41, 0x00, 0x0F, 0x00, 0x00
};
//
// Generic Graphics Controller Register Settings
//
///
/// Generic Graphics Controller Register Settings
///
static UINT8 GraphicsController[9] = {
0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x05, 0x0F, 0xFF
};
@ -97,9 +90,9 @@ static UINT16 Seq_1024_768_256_60[15] = {
0x5b0c, 0x450d, 0x760e, 0x2b1b, 0x2f1c, 0x301d, 0x341e
};
//
// Table of supported video modes
//
///
/// Table of supported video modes
///
static CIRRUS_LOGIC_5430_VIDEO_MODES CirrusLogic5430VideoModes[] = {
{ 640, 480, 8, 60, Crtc_640_480_256_60, Seq_640_480_256_60, 0xe3 },
{ 800, 600, 8, 60, Crtc_800_600_256_60, Seq_800_600_256_60, 0xef },
@ -169,6 +162,20 @@ inw (
//
// UGA Draw Protocol Member Functions
//
/**
TODO: Add function description
@param This TODO: add argument description
@param HorizontalResolution TODO: add argument description
@param VerticalResolution TODO: add argument description
@param ColorDepth TODO: add argument description
@param RefreshRate TODO: add argument description
@retval EFI_NOT_STARTED TODO: Add description for return value
@retval EFI_INVALID_PARAMETER TODO: Add description for return value
@retval EFI_SUCCESS TODO: Add description for return value
**/
EFI_STATUS
EFIAPI
CirrusLogic5430UgaDrawGetMode (
@ -178,27 +185,6 @@ CirrusLogic5430UgaDrawGetMode (
OUT UINT32 *ColorDepth,
OUT UINT32 *RefreshRate
)
/*++
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
HorizontalResolution - TODO: add argument description
VerticalResolution - TODO: add argument description
ColorDepth - TODO: add argument description
RefreshRate - TODO: add argument description
Returns:
EFI_NOT_STARTED - TODO: Add description for return value
EFI_INVALID_PARAMETER - TODO: Add description for return value
EFI_SUCCESS - TODO: Add description for return value
--*/
{
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private;
@ -223,6 +209,20 @@ Returns:
return EFI_SUCCESS;
}
/**
TODO: Add function description
@param This TODO: add argument description
@param HorizontalResolution TODO: add argument description
@param VerticalResolution TODO: add argument description
@param ColorDepth TODO: add argument description
@param RefreshRate TODO: add argument description
@retval EFI_OUT_OF_RESOURCES TODO: Add description for return value
@retval EFI_SUCCESS TODO: Add description for return value
@retval EFI_NOT_FOUND TODO: Add description for return value
**/
EFI_STATUS
EFIAPI
CirrusLogic5430UgaDrawSetMode (
@ -232,27 +232,6 @@ CirrusLogic5430UgaDrawSetMode (
IN UINT32 ColorDepth,
IN UINT32 RefreshRate
)
/*++
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
HorizontalResolution - TODO: add argument description
VerticalResolution - TODO: add argument description
ColorDepth - TODO: add argument description
RefreshRate - TODO: add argument description
Returns:
EFI_OUT_OF_RESOURCES - TODO: Add description for return value
EFI_SUCCESS - TODO: Add description for return value
EFI_NOT_FOUND - TODO: Add description for return value
--*/
{
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private;
UINTN Index;
@ -299,6 +278,29 @@ Returns:
return EFI_NOT_FOUND;
}
/**
TODO: Add function description
@param This TODO: add argument description
@param BltBuffer TODO: add argument description
@param BltOperation TODO: add argument description
@param SourceX TODO: add argument description
@param SourceY TODO: add argument description
@param DestinationX TODO: add argument description
@param DestinationY TODO: add argument description
@param Width TODO: add argument description
@param Height TODO: add argument description
@param Delta TODO: add argument description
@retval EFI_INVALID_PARAMETER TODO: Add description for return value
@retval EFI_INVALID_PARAMETER TODO: Add description for return value
@retval EFI_INVALID_PARAMETER TODO: Add description for return value
@retval EFI_INVALID_PARAMETER TODO: Add description for return value
@retval EFI_INVALID_PARAMETER TODO: Add description for return value
@retval EFI_INVALID_PARAMETER TODO: Add description for return value
@retval EFI_SUCCESS TODO: Add description for return value
**/
EFI_STATUS
EFIAPI
CirrusLogic5430UgaDrawBlt (
@ -313,36 +315,6 @@ CirrusLogic5430UgaDrawBlt (
IN UINTN Height,
IN UINTN Delta
)
/*++
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
BltBuffer - TODO: add argument description
BltOperation - TODO: add argument description
SourceX - TODO: add argument description
SourceY - TODO: add argument description
DestinationX - TODO: add argument description
DestinationY - TODO: add argument description
Width - TODO: add argument description
Height - TODO: add argument description
Delta - TODO: add argument description
Returns:
EFI_INVALID_PARAMETER - TODO: Add description for return value
EFI_INVALID_PARAMETER - TODO: Add description for return value
EFI_INVALID_PARAMETER - TODO: Add description for return value
EFI_INVALID_PARAMETER - TODO: Add description for return value
EFI_INVALID_PARAMETER - TODO: Add description for return value
EFI_INVALID_PARAMETER - TODO: Add description for return value
EFI_SUCCESS - TODO: Add description for return value
--*/
{
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private;
EFI_TPL OriginalTPL;
@ -597,23 +569,16 @@ Returns:
// Construction and Destruction functions
//
/**
CirrusLogic5430UgaDrawConstructor
TODO: Private - add argument and description to function comment
TODO: EFI_SUCCESS - add return value to function comment
**/
EFI_STATUS
CirrusLogic5430UgaDrawConstructor (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private
)
/*++
Routine Description:
Arguments:
Returns:
None
--*/
// TODO: Private - add argument and description to function comment
// TODO: EFI_SUCCESS - add return value to function comment
{
EFI_UGA_DRAW_PROTOCOL *UgaDraw;
UINTN Index;
@ -657,50 +622,36 @@ Returns:
return EFI_SUCCESS;
}
/**
CirrusLogic5430UgaDrawDestructor
TODO: Private - add argument and description to function comment
TODO: EFI_SUCCESS - add return value to function comment
**/
EFI_STATUS
CirrusLogic5430UgaDrawDestructor (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private
)
/*++
Routine Description:
Arguments:
Returns:
None
--*/
// TODO: Private - add argument and description to function comment
// TODO: EFI_SUCCESS - add return value to function comment
{
return EFI_SUCCESS;
}
/**
TODO: Add function description
@param Private TODO: add argument description
@param Address TODO: add argument description
@param Data TODO: add argument description
TODO: add return values
**/
VOID
outb (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private,
UINTN Address,
UINT8 Data
)
/*++
Routine Description:
TODO: Add function description
Arguments:
Private - TODO: add argument description
Address - TODO: add argument description
Data - TODO: add argument description
Returns:
TODO: add return values
--*/
{
Private->PciIo->Io.Write (
Private->PciIo,
@ -712,29 +663,22 @@ Returns:
);
}
/**
TODO: Add function description
@param Private TODO: add argument description
@param Address TODO: add argument description
@param Data TODO: add argument description
TODO: add return values
**/
VOID
outw (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private,
UINTN Address,
UINT16 Data
)
/*++
Routine Description:
TODO: Add function description
Arguments:
Private - TODO: add argument description
Address - TODO: add argument description
Data - TODO: add argument description
Returns:
TODO: add return values
--*/
{
Private->PciIo->Io.Write (
Private->PciIo,
@ -746,27 +690,20 @@ Returns:
);
}
/**
TODO: Add function description
@param Private TODO: add argument description
@param Address TODO: add argument description
TODO: add return values
**/
UINT8
inb (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private,
UINTN Address
)
/*++
Routine Description:
TODO: Add function description
Arguments:
Private - TODO: add argument description
Address - TODO: add argument description
Returns:
TODO: add return values
--*/
{
UINT8 Data;
@ -781,27 +718,20 @@ Returns:
return Data;
}
/**
TODO: Add function description
@param Private TODO: add argument description
@param Address TODO: add argument description
TODO: add return values
**/
UINT16
inw (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private,
UINTN Address
)
/*++
Routine Description:
TODO: Add function description
Arguments:
Private - TODO: add argument description
Address - TODO: add argument description
Returns:
TODO: add return values
--*/
{
UINT16 Data;
@ -816,6 +746,18 @@ Returns:
return Data;
}
/**
TODO: Add function description
@param Private TODO: add argument description
@param Index TODO: add argument description
@param Red TODO: add argument description
@param Green TODO: add argument description
@param Blue TODO: add argument description
TODO: add return values
**/
VOID
SetPaletteColor (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private,
@ -824,25 +766,6 @@ SetPaletteColor (
UINT8 Green,
UINT8 Blue
)
/*++
Routine Description:
TODO: Add function description
Arguments:
Private - TODO: add argument description
Index - TODO: add argument description
Red - TODO: add argument description
Green - TODO: add argument description
Blue - TODO: add argument description
Returns:
TODO: add return values
--*/
{
outb (Private, PALETTE_INDEX_REGISTER, (UINT8) Index);
outb (Private, PALETTE_DATA_REGISTER, (UINT8) (Red >> 2));
@ -850,25 +773,18 @@ Returns:
outb (Private, PALETTE_DATA_REGISTER, (UINT8) (Blue >> 2));
}
/**
TODO: Add function description
@param Private TODO: add argument description
TODO: add return values
**/
VOID
SetDefaultPalette (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private
)
/*++
Routine Description:
TODO: Add function description
Arguments:
Private - TODO: add argument description
Returns:
TODO: add return values
--*/
{
UINTN Index;
UINTN RedIndex;
@ -886,26 +802,19 @@ Returns:
}
}
/**
TODO: Add function description
@param Private TODO: add argument description
TODO: add return values
**/
STATIC
VOID
ClearScreen (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private
)
/*++
Routine Description:
TODO: Add function description
Arguments:
Private - TODO: add argument description
Returns:
TODO: add return values
--*/
{
UINT32 Color;
@ -920,25 +829,18 @@ Returns:
);
}
/**
TODO: Add function description
@param Private TODO: add argument description
TODO: add return values
**/
VOID
DrawLogo (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private
)
/*++
Routine Description:
TODO: Add function description
Arguments:
Private - TODO: add argument description
Returns:
TODO: add return values
--*/
{
UINTN Offset;
UINTN X;
@ -968,27 +870,20 @@ Returns:
}
}
/**
TODO: Add function description
@param Private TODO: add argument description
@param ModeData TODO: add argument description
TODO: add return values
**/
VOID
InitializeGraphicsMode (
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private,
CIRRUS_LOGIC_5430_VIDEO_MODES *ModeData
)
/*++
Routine Description:
TODO: Add function description
Arguments:
Private - TODO: add argument description
ModeData - TODO: add argument description
Returns:
TODO: add return values
--*/
{
UINT8 Byte;
UINTN Index;

143
EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/ComponentName.c
View File

@ -1,5 +1,4 @@
/*++
/** @file
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -9,13 +8,7 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
ComponentName.c
Abstract:
--*/
**/
#include "CirrusLogic5430.h"
@ -59,6 +52,28 @@ static EFI_UNICODE_STRING_TABLE mCirrusLogic5430ControllerNameTable[] = {
{ NULL , NULL }
};
/**
Retrieves a Unicode string that is the user readable name of the EFI Driver.
@param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
@param 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.
@param 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.
@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
EFIAPI
CirrusLogic5430ComponentNameGetDriverName (
@ -66,32 +81,6 @@ CirrusLogic5430ComponentNameGetDriverName (
IN CHAR8 *Language,
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_SUCCESS - 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 LookupUnicodeString (
Language,
@ -101,6 +90,46 @@ CirrusLogic5430ComponentNameGetDriverName (
);
}
/**
Retrieves a Unicode string that is the user readable name of the controller
that is being managed by an EFI Driver.
@param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
@param ControllerHandle The handle of a controller that the driver specified by
This is managing. This handle specifies the controller
whose name is to be returned.
@param 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.
@param 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.
@param 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.
@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
EFIAPI
CirrusLogic5430ComponentNameGetControllerName (
@ -110,50 +139,6 @@ CirrusLogic5430ComponentNameGetControllerName (
IN CHAR8 *Language,
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.
--*/
{
EFI_UGA_DRAW_PROTOCOL *UgaDraw;
EFI_STATUS Status;

162
EdkModulePkg/Bus/Pci/IdeBus/Dxe/ComponentName.c
View File

@ -1,5 +1,4 @@
/*++
/** @file
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -9,13 +8,7 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
ComponentName.c
Abstract:
--*/
**/
#include "idebus.h"
@ -38,6 +31,28 @@ STATIC EFI_UNICODE_STRING_TABLE mIDEBusControllerNameTable[] = {
{ NULL , NULL }
};
/**
Retrieves a Unicode string that is the user readable name of the EFI Driver.
@param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
@param 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.
@param 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.
@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
EFIAPI
IDEBusComponentNameGetDriverName (
@ -45,32 +60,6 @@ IDEBusComponentNameGetDriverName (
IN CHAR8 *Language,
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_SUCCESS - 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 LookupUnicodeString (
Language,
@ -80,6 +69,47 @@ IDEBusComponentNameGetDriverName (
);
}
/**
Retrieves a Unicode string that is the user readable name of the controller
that is being managed by an EFI Driver.
@param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
@param ControllerHandle The handle of a controller that the driver specified by
This is managing. This handle specifies the controller
whose name is to be returned.
@param 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.
@param 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.
@param 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.
@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
EFIAPI
IDEBusComponentNameGetControllerName (
@ -89,51 +119,6 @@ IDEBusComponentNameGetControllerName (
IN CHAR8 *Language,
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.
--*/
{
EFI_STATUS Status;
EFI_BLOCK_IO_PROTOCOL *BlockIo;
@ -188,21 +173,16 @@ IDEBusComponentNameGetControllerName (
);
}
/**
Add the component name for the IDE/ATAPI device
@param IdeBlkIoDevicePtr A pointer to the IDE_BLK_IO_DEV instance.
**/
VOID
AddName (
IN IDE_BLK_IO_DEV *IdeBlkIoDevicePtr
)
/*++
Routine Description:
Add the component name for the IDE/ATAPI device
Arguments:
IdeBlkIoDevicePtr - A pointer to the IDE_BLK_IO_DEV instance.
Returns:
--*/
{
UINTN StringIndex;
CHAR16 ModelName[41];

261
EdkModulePkg/Bus/Pci/IdeBus/Dxe/DriverConfiguration.c
View File

@ -1,5 +1,4 @@
/*++
/** @file
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -9,13 +8,7 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
DriverConfiguration.c
Abstract:
--*/
**/
#include "idebus.h"
@ -63,27 +56,18 @@ EFI_DRIVER_CONFIGURATION_PROTOCOL gIDEBusDriverConfiguration = {
"eng"
};
/**
TODO: Add function description
@retval EFI_ABORTED TODO: Add description for return value
@retval EFI_SUCCESS TODO: Add description for return value
@retval EFI_NOT_FOUND TODO: Add description for return value
**/
EFI_STATUS
GetResponse (
VOID
)
/*++
Routine Description:
TODO: Add function description
Arguments:
None
Returns:
EFI_ABORTED - TODO: Add description for return value
EFI_SUCCESS - TODO: Add description for return value
EFI_NOT_FOUND - TODO: Add description for return value
--*/
{
EFI_STATUS Status;
EFI_INPUT_KEY Key;
@ -118,6 +102,51 @@ Returns:
}
}
/**
Allows the user to set controller specific options for a controller that a
driver is currently managing.
@param This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL
instance.
@param ControllerHandle The handle of the controller to set options on.
@param ChildHandle The handle of the child controller to set options on.
This is an optional parameter that may be NULL.
It will be NULL for device drivers, and for a bus drivers
that wish to set options for the bus controller.
It will not be NULL for a bus driver that wishes to set
options for one of its child controllers.
@param Language A pointer to a three character ISO 639-2 language
identifier. This is the language of the user interface
that should be presented to the user, 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.
@param ActionRequired A pointer to the action that the calling agent is
required to perform when this function returns.
See "Related Definitions" for a list of the actions that
the calling agent is required to perform prior to
accessing ControllerHandle again.
@retval EFI_SUCCESS The driver specified by This successfully set the
configuration options for the controller specified
by ControllerHandle..
@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 ActionRequired is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support
setting configuration options for the controller
specified by ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support the
language specified by Language.
@retval EFI_DEVICE_ERROR A device error occurred while attempt to set the
configuration options for the controller specified
by ControllerHandle and ChildHandle.
@retval EFI_OUT_RESOURCES There are not enough resources available to set the
configuration options for the controller specified
by ControllerHandle and ChildHandle.
**/
EFI_STATUS
IDEBusDriverConfigurationSetOptions (
IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
@ -126,55 +155,6 @@ IDEBusDriverConfigurationSetOptions (
IN CHAR8 *Language,
OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired
)
/*++
Routine Description:
Allows the user to set controller specific options for a controller that a
driver is currently managing.
Arguments:
This - A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL
instance.
ControllerHandle - The handle of the controller to set options on.
ChildHandle - The handle of the child controller to set options on.
This is an optional parameter that may be NULL.
It will be NULL for device drivers, and for a bus drivers
that wish to set options for the bus controller.
It will not be NULL for a bus driver that wishes to set
options for one of its child controllers.
Language - A pointer to a three character ISO 639-2 language
identifier. This is the language of the user interface
that should be presented to the user, 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.
ActionRequired - A pointer to the action that the calling agent is
required to perform when this function returns.
See "Related Definitions" for a list of the actions that
the calling agent is required to perform prior to
accessing ControllerHandle again.
Returns:
EFI_SUCCESS - The driver specified by This successfully set the
configuration options for the controller specified
by ControllerHandle..
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 - ActionRequired is NULL.
EFI_UNSUPPORTED - The driver specified by This does not support
setting configuration options for the controller
specified by ControllerHandle and ChildHandle.
EFI_UNSUPPORTED - The driver specified by This does not support the
language specified by Language.
EFI_DEVICE_ERROR - A device error occurred while attempt to set the
configuration options for the controller specified
by ControllerHandle and ChildHandle.
EFI_OUT_RESOURCES - There are not enough resources available to set the
configuration options for the controller specified
by ControllerHandle and ChildHandle.
--*/
{
EFI_STATUS Status;
UINT8 Value;
@ -232,23 +212,14 @@ IDEBusDriverConfigurationSetOptions (
return EFI_SUCCESS;
}
EFI_STATUS
IDEBusDriverConfigurationOptionsValid (
IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL
)
/*++
Routine Description:
/**
Tests to see if a controller's current configuration options are valid.
Arguments:
This - A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL
@param This A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL
instance.
ControllerHandle - The handle of the controller to test if it's current
@param ControllerHandle The handle of the controller to test if it's current
configuration options are valid.
ChildHandle - The handle of the child controller to test if it's
@param ChildHandle The handle of the child controller to test if it's
current
configuration options are valid. This is an optional
parameter that may be NULL. It will be NULL for device
@ -258,23 +229,28 @@ IDEBusDriverConfigurationOptionsValid (
wishes to test configuration options for one of
its child controllers.
Returns:
EFI_SUCCESS - The controller specified by ControllerHandle and
@retval EFI_SUCCESS The controller specified by ControllerHandle and
ChildHandle that is being managed by the driver
specified by This has a valid set of configuration
options.
EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid
@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.
EFI_UNSUPPORTED - The driver specified by This is not currently
@retval EFI_UNSUPPORTED The driver specified by This is not currently
managing the controller specified by
ControllerHandle and ChildHandle.
EFI_DEVICE_ERROR - The controller specified by ControllerHandle and
@retval EFI_DEVICE_ERROR The controller specified by ControllerHandle and
ChildHandle that is being managed by the driver
specified by This has an invalid set of
configuration options.
--*/
**/
EFI_STATUS
IDEBusDriverConfigurationOptionsValid (
IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL
)
{
EFI_STATUS Status;
UINT8 Value;
@ -300,6 +276,51 @@ IDEBusDriverConfigurationOptionsValid (
return EFI_SUCCESS;
}
/**
Forces a driver to set the default configuration options for a controller.
@param This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL
instance.
@param ControllerHandle The handle of the controller to force default
configuration options on.
@param ChildHandle The handle of the child controller to force default
configuration options on 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
force default configuration options for the bus
controller. It will not be NULL for a bus driver that
wishes to force default configuration options for one
of its child controllers.
@param DefaultType The type of default configuration options to force on
the controller specified by ControllerHandle and
ChildHandle. See Table 9-1 for legal values.
A DefaultType of 0x00000000 must be supported
by this protocol.
@param ActionRequired A pointer to the action that the calling agent
is required to perform when this function returns.
@retval EFI_SUCCESS The driver specified by This successfully forced
the default configuration options on the
controller specified by ControllerHandle and
ChildHandle.
@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 ActionRequired is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support
forcing the default configuration options on
the controller specified by ControllerHandle
and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the configuration type specified by DefaultType.
@retval EFI_DEVICE_ERROR A device error occurred while attempt to force
the default configuration options on the controller
specified by ControllerHandle and ChildHandle.
@retval EFI_OUT_RESOURCES There are not enough resources available to force
the default configuration options on the controller
specified by ControllerHandle and ChildHandle.
**/
EFI_STATUS
IDEBusDriverConfigurationForceDefaults (
IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
@ -308,56 +329,6 @@ IDEBusDriverConfigurationForceDefaults (
IN UINT32 DefaultType,
OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired
)
/*++
Routine Description:
Forces a driver to set the default configuration options for a controller.
Arguments:
This - A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL
instance.
ControllerHandle - The handle of the controller to force default
configuration options on.
ChildHandle - The handle of the child controller to force default
configuration options on 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
force default configuration options for the bus
controller. It will not be NULL for a bus driver that
wishes to force default configuration options for one
of its child controllers.
DefaultType - The type of default configuration options to force on
the controller specified by ControllerHandle and
ChildHandle. See Table 9-1 for legal values.
A DefaultType of 0x00000000 must be supported
by this protocol.
ActionRequired - A pointer to the action that the calling agent
is required to perform when this function returns.
Returns:
EFI_SUCCESS - The driver specified by This successfully forced
the default configuration options on the
controller specified by ControllerHandle and
ChildHandle.
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 - ActionRequired is NULL.
EFI_UNSUPPORTED - The driver specified by This does not support
forcing the default configuration options on
the controller specified by ControllerHandle
and ChildHandle.
EFI_UNSUPPORTED - The driver specified by This does not support
the configuration type specified by DefaultType.
EFI_DEVICE_ERROR - A device error occurred while attempt to force
the default configuration options on the controller
specified by ControllerHandle and ChildHandle.
EFI_OUT_RESOURCES - There are not enough resources available to force
the default configuration options on the controller
specified by ControllerHandle and ChildHandle.
--*/
{
UINT8 Value;

129
EdkModulePkg/Bus/Pci/IdeBus/Dxe/DriverDiagnostics.c
View File

@ -1,5 +1,4 @@
/*++
/** @file
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -9,13 +8,7 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
DriverDiagnostics.c
Abstract:
--*/
**/
#include "idebus.h"
@ -44,6 +37,63 @@ EFI_DRIVER_DIAGNOSTICS_PROTOCOL gIDEBusDriverDiagnostics = {
"eng"
};
/**
Runs diagnostics on a controller.
@param This A pointer to the EFI_DRIVER_DIAGNOSTICS_PROTOCOL
instance.
@param ControllerHandle The handle of the controller to run diagnostics on.
@param ChildHandle The handle of the child controller to run diagnostics on
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 run diagnostics on the bus
controller. It will not be NULL for a bus driver that
wishes to run diagnostics on one of its child
controllers.
@param DiagnosticType Indicates type of diagnostics to perform on the
controller specified by ControllerHandle and ChildHandle.
See "Related Definitions" for the list of supported
types.
@param Language A pointer to a three character ISO 639-2 language
identifier. This is the language in which the optional
error message should be returned in Buffer, 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.
@param ErrorType A GUID that defines the format of the data returned in
Buffer.
@param BufferSize The size, in bytes, of the data returned in Buffer.
@param Buffer A buffer that contains a Null-terminated Unicode string
plus some additional data whose format is defined by
ErrorType. Buffer is allocated by this function with
AllocatePool(), and it is the caller's responsibility
to free it with a call to FreePool().
@retval EFI_SUCCESS The controller specified by ControllerHandle and
ChildHandle passed the diagnostic.
@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 ErrorType is NULL.
@retval EFI_INVALID_PARAMETER BufferType is NULL.
@retval EFI_INVALID_PARAMETER Buffer is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support
running diagnostics for the controller specified
by ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support the
type of diagnostic specified by DiagnosticType.
@retval EFI_UNSUPPORTED The driver specified by This does not support the
language specified by Language.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to complete
the diagnostics.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to return
the status information in ErrorType, BufferSize,
and Buffer.
@retval EFI_DEVICE_ERROR The controller specified by ControllerHandle and
ChildHandle did not pass the diagnostic.
**/
EFI_STATUS
IDEBusDriverDiagnosticsRunDiagnostics (
IN EFI_DRIVER_DIAGNOSTICS_PROTOCOL *This,
@ -55,67 +105,6 @@ IDEBusDriverDiagnosticsRunDiagnostics (
OUT UINTN *BufferSize,
OUT CHAR16 **Buffer
)
/*++
Routine Description:
Runs diagnostics on a controller.
Arguments:
This - A pointer to the EFI_DRIVER_DIAGNOSTICS_PROTOCOL
instance.
ControllerHandle - The handle of the controller to run diagnostics on.
ChildHandle - The handle of the child controller to run diagnostics on
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 run diagnostics on the bus
controller. It will not be NULL for a bus driver that
wishes to run diagnostics on one of its child
controllers.
DiagnosticType - Indicates type of diagnostics to perform on the
controller specified by ControllerHandle and ChildHandle.
See "Related Definitions" for the list of supported
types.
Language - A pointer to a three character ISO 639-2 language
identifier. This is the language in which the optional
error message should be returned in Buffer, 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.
ErrorType - A GUID that defines the format of the data returned in
Buffer.
BufferSize - The size, in bytes, of the data returned in Buffer.
Buffer - A buffer that contains a Null-terminated Unicode string
plus some additional data whose format is defined by
ErrorType. Buffer is allocated by this function with
AllocatePool(), and it is the caller's responsibility
to free it with a call to FreePool().
Returns:
EFI_SUCCESS - The controller specified by ControllerHandle and
ChildHandle passed the diagnostic.
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 - ErrorType is NULL.
EFI_INVALID_PARAMETER - BufferType is NULL.
EFI_INVALID_PARAMETER - Buffer is NULL.
EFI_UNSUPPORTED - The driver specified by This does not support
running diagnostics for the controller specified
by ControllerHandle and ChildHandle.
EFI_UNSUPPORTED - The driver specified by This does not support the
type of diagnostic specified by DiagnosticType.
EFI_UNSUPPORTED - The driver specified by This does not support the
language specified by Language.
EFI_OUT_OF_RESOURCES - There are not enough resources available to complete
the diagnostics.
EFI_OUT_OF_RESOURCES - There are not enough resources available to return
the status information in ErrorType, BufferSize,
and Buffer.
EFI_DEVICE_ERROR - The controller specified by ControllerHandle and
ChildHandle did not pass the diagnostic.
--*/
{
EFI_STATUS Status;
EFI_PCI_IO_PROTOCOL *PciIo;

1364
EdkModulePkg/Bus/Pci/IdeBus/Dxe/ata.c
View File

File diff suppressed because it is too large Load Diff

1104
EdkModulePkg/Bus/Pci/IdeBus/Dxe/atapi.c
View File

File diff suppressed because it is too large Load Diff

826
EdkModulePkg/Bus/Pci/IdeBus/Dxe/ide.c
View File

File diff suppressed because it is too large Load Diff

1396
EdkModulePkg/Bus/Pci/IdeBus/Dxe/ide.h
View File

File diff suppressed because it is too large Load Diff

349
EdkModulePkg/Bus/Pci/IdeBus/Dxe/idebus.c
View File

@ -1,5 +1,4 @@
/*++
/** @file
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -9,17 +8,10 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
idebus.c
Abstract:
Revision History
@par Revision Reference:
This module is modified from DXE\IDE module for Ide Contriller Init support
--*/
**/
#include "idebus.h"
@ -44,6 +36,17 @@ EFI_DRIVER_BINDING_PROTOCOL gIDEBusDriverBinding = {
// IDEBusDriverBindingSupported
// ***********************************************************************************
//
/**
Register Driver Binding protocol for this driver.
@param[in] This -- A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
@param[in] ControllerHandle -- The handle of the controller to test.
@param[in] RemainingDevicePath -- A pointer to the remaining portion of a device path.
@retval EFI_SUCCESS Driver loaded.
@retval other Driver not loaded.
**/
EFI_STATUS
EFIAPI
IDEBusDriverBindingSupported (
@ -51,20 +54,6 @@ IDEBusDriverBindingSupported (
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
)
/*++
Routine Description:
Register Driver Binding protocol for this driver.
Arguments:
This -- A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
ControllerHandle -- The handle of the controller to test.
RemainingDevicePath -- A pointer to the remaining portion of a device path.
Returns:
EFI_SUCCESS - Driver loaded.
other - Driver not loaded.
--*/
// TODO: Controller - add argument and description to function comment
// TODO: EFI_UNSUPPORTED - add return value to function comment
{
@ -150,6 +139,19 @@ Returns:
// IDEBusDriverBindingStart
// ***********************************************************************************
//
/**
Start this driver on Controller by detecting all disks and installing
BlockIo protocol on them.
@param This Protocol instance pointer.
@param Controller Handle of device to bind driver to.
@param RemainingDevicePath Not used, always produce all possible children.
@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
EFIAPI
IDEBusDriverBindingStart (
@ -157,23 +159,6 @@ IDEBusDriverBindingStart (
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
)
/*++
Routine Description:
Start this driver on Controller by detecting all disks and installing
BlockIo protocol on them.
Arguments:
This - Protocol instance pointer.
Controller - Handle of device to bind driver to.
RemainingDevicePath - Not used, always produce all possible children.
Returns:
EFI_SUCCESS - This driver is added to ControllerHandle.
EFI_ALREADY_STARTED - This driver is already running on ControllerHandle.
other - This driver does not support this device.
--*/
{
EFI_STATUS Status;
EFI_STATUS SavedStatus;
@ -791,6 +776,18 @@ ErrorExit:
// IDEBusDriverBindingStop
// ***********************************************************************************
//
/**
Stop this driver on Controller Handle.
@param This Protocol instance pointer.
@param DeviceHandle Handle of device to stop driver on
@param NumberOfChildren Not used
@param ChildHandleBuffer Not used
@retval EFI_SUCCESS This driver is removed DeviceHandle
@retval other This driver was not removed from this device
**/
EFI_STATUS
EFIAPI
IDEBusDriverBindingStop (
@ -799,22 +796,6 @@ IDEBusDriverBindingStop (
IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer
)
/*++
Routine Description:
Stop this driver on Controller Handle.
Arguments:
This - Protocol instance pointer.
DeviceHandle - Handle of device to stop driver on
NumberOfChildren - Not used
ChildHandleBuffer - Not used
Returns:
EFI_SUCCESS - This driver is removed DeviceHandle
other - This driver was not removed from this device
--*/
// TODO: Controller - add argument and description to function comment
// TODO: EFI_DEVICE_ERROR - add return value to function comment
{
@ -912,29 +893,22 @@ IDEBusDriverBindingStop (
// DeRegisterIdeDevice
// ***********************************************************************************
//
/**
Deregister an IDE device and free resources
@param This Protocol instance pointer.
@param Controller Ide device handle
@param Handle Handle of device to deregister driver on
@return EFI_STATUS
**/
EFI_STATUS
DeRegisterIdeDevice (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN EFI_HANDLE Handle
)
/*++
Routine Description:
Deregister an IDE device and free resources
Arguments:
This - Protocol instance pointer.
Controller - Ide device handle
Handle - Handle of device to deregister driver on
Returns:
EFI_STATUS
--*/
// TODO: EFI_SUCCESS - add return value to function comment
{
EFI_STATUS Status;
@ -1015,26 +989,18 @@ Returns:
// IDEBlkIoReset
// ***********************************************************************************
//
/**
TODO: This - add argument and description to function comment
TODO: ExtendedVerification - add argument and description to function comment
TODO: EFI_DEVICE_ERROR - add return value to function comment
**/
EFI_STATUS
EFIAPI
IDEBlkIoReset (
IN EFI_BLOCK_IO_PROTOCOL *This,
IN BOOLEAN ExtendedVerification
)
/*++
Routine Description:
Arguments:
Returns:
None
--*/
// TODO: This - add argument and description to function comment
// TODO: ExtendedVerification - add argument and description to function comment
// TODO: EFI_DEVICE_ERROR - add return value to function comment
{
IDE_BLK_IO_DEV *IdeBlkIoDevice;
EFI_STATUS Status;
@ -1067,6 +1033,18 @@ Returns:
return Status;
}
/**
Read data from block io device
@param This Protocol instance pointer.
@param MediaId The media ID of the device
@param LBA Starting LBA address to read data
@param BufferSize The size of data to be read
@param Buffer Caller supplied buffer to save data
@return read data status
**/
EFI_STATUS
EFIAPI
IDEBlkIoReadBlocks (
@ -1076,25 +1054,6 @@ IDEBlkIoReadBlocks (
IN UINTN BufferSize,
OUT VOID *Buffer
)
/*++
Routine Description:
Read data from block io device
Arguments:
This - Protocol instance pointer.
MediaId - The media ID of the device
LBA - Starting LBA address to read data
BufferSize - The size of data to be read
Buffer - Caller supplied buffer to save data
Returns:
read data status
--*/
// TODO: EFI_DEVICE_ERROR - add return value to function comment
{
IDE_BLK_IO_DEV *IdeBlkIoDevice;
@ -1137,6 +1096,18 @@ Returns:
}
/**
Write data to block io device
@param This Protocol instance pointer.
@param MediaId The media ID of the device
@param LBA Starting LBA address to write data
@param BufferSize The size of data to be written
@param Buffer Caller supplied buffer to save data
@return write data status
**/
EFI_STATUS
EFIAPI
IDEBlkIoWriteBlocks (
@ -1146,25 +1117,6 @@ IDEBlkIoWriteBlocks (
IN UINTN BufferSize,
IN VOID *Buffer
)
/*++
Routine Description:
Write data to block io device
Arguments:
This - Protocol instance pointer.
MediaId - The media ID of the device
LBA - Starting LBA address to write data
BufferSize - The size of data to be written
Buffer - Caller supplied buffer to save data
Returns:
write data status
--*/
// TODO: EFI_DEVICE_ERROR - add return value to function comment
{
IDE_BLK_IO_DEV *IdeBlkIoDevice;
@ -1211,24 +1163,15 @@ Returns:
// IDEBlkIoFlushBlocks
// ***********************************************************************************
//
/**
TODO: This - add argument and description to function comment
TODO: EFI_SUCCESS - add return value to function comment
**/
EFI_STATUS
EFIAPI
IDEBlkIoFlushBlocks (
IN EFI_BLOCK_IO_PROTOCOL *This
)
/*++
Routine Description:
Arguments:
Returns:
None
--*/
// TODO: This - add argument and description to function comment
// TODO: EFI_SUCCESS - add return value to function comment
{
//
// return directly
@ -1236,6 +1179,20 @@ Returns:
return EFI_SUCCESS;
}
/**
Return the results of the Inquiry command to a drive in InquiryData.
Data format of Inquiry data is defined by the Interface GUID.
@param This Protocol instance pointer.
@param InquiryData Results of Inquiry command to device
@param InquiryDataSize Size of InquiryData in bytes.
@retval EFI_SUCCESS InquiryData valid
@retval EFI_NOT_FOUND Device does not support this data class
@retval EFI_DEVICE_ERROR Error reading InquiryData from device
@retval EFI_BUFFER_TOO_SMALL IntquiryDataSize not big enough
**/
EFI_STATUS
EFIAPI
IDEDiskInfoInquiry (
@ -1243,24 +1200,6 @@ IDEDiskInfoInquiry (
IN OUT VOID *InquiryData,
IN OUT UINT32 *InquiryDataSize
)
/*++
Routine Description:
Return the results of the Inquiry command to a drive in InquiryData.
Data format of Inquiry data is defined by the Interface GUID.
Arguments:
This - Protocol instance pointer.
InquiryData - Results of Inquiry command to device
InquiryDataSize - Size of InquiryData in bytes.
Returns:
EFI_SUCCESS - InquiryData valid
EFI_NOT_FOUND - Device does not support this data class
EFI_DEVICE_ERROR - Error reading InquiryData from device
EFI_BUFFER_TOO_SMALL - IntquiryDataSize not big enough
--*/
{
IDE_BLK_IO_DEV *IdeBlkIoDevice;
@ -1281,6 +1220,20 @@ IDEDiskInfoInquiry (
return EFI_SUCCESS;
}
/**
Return the results of the Identify command to a drive in IdentifyData.
Data format of Identify data is defined by the Interface GUID.
@param This Protocol instance pointer.
@param IdentifyData Results of Identify command to device
@param IdentifyDataSize Size of IdentifyData in bytes.
@retval EFI_SUCCESS IdentifyData valid
@retval EFI_NOT_FOUND Device does not support this data class
@retval EFI_DEVICE_ERROR Error reading IdentifyData from device
@retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough
**/
EFI_STATUS
EFIAPI
IDEDiskInfoIdentify (
@ -1288,24 +1241,6 @@ IDEDiskInfoIdentify (
IN OUT VOID *IdentifyData,
IN OUT UINT32 *IdentifyDataSize
)
/*++
Routine Description:
Return the results of the Identify command to a drive in IdentifyData.
Data format of Identify data is defined by the Interface GUID.
Arguments:
This - Protocol instance pointer.
IdentifyData - Results of Identify command to device
IdentifyDataSize - Size of IdentifyData in bytes.
Returns:
EFI_SUCCESS - IdentifyData valid
EFI_NOT_FOUND - Device does not support this data class
EFI_DEVICE_ERROR - Error reading IdentifyData from device
EFI_BUFFER_TOO_SMALL - IdentifyDataSize not big enough
--*/
{
IDE_BLK_IO_DEV *IdeBlkIoDevice;
@ -1326,6 +1261,21 @@ IDEDiskInfoIdentify (
return EFI_SUCCESS;
}
/**
Return the results of the Request Sense command to a drive in SenseData.
Data format of Sense data is defined by the Interface GUID.
@param This Protocol instance pointer.
@param SenseData Results of Request Sense command to device
@param SenseDataSize Size of SenseData in bytes.
@param SenseDataNumber Type of SenseData
@retval EFI_SUCCESS InquiryData valid
@retval EFI_NOT_FOUND Device does not support this data class
@retval EFI_DEVICE_ERROR Error reading InquiryData from device
@retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough
**/
EFI_STATUS
EFIAPI
IDEDiskInfoSenseData (
@ -1334,29 +1284,22 @@ IDEDiskInfoSenseData (
IN OUT UINT32 *SenseDataSize,
OUT UINT8 *SenseDataNumber
)
/*++
Routine Description:
Return the results of the Request Sense command to a drive in SenseData.
Data format of Sense data is defined by the Interface GUID.
Arguments:
This - Protocol instance pointer.
SenseData - Results of Request Sense command to device
SenseDataSize - Size of SenseData in bytes.
SenseDataNumber - Type of SenseData
Returns:
EFI_SUCCESS - InquiryData valid
EFI_NOT_FOUND - Device does not support this data class
EFI_DEVICE_ERROR - Error reading InquiryData from device
EFI_BUFFER_TOO_SMALL - SenseDataSize not big enough
--*/
{
return EFI_NOT_FOUND;
}
/**
Return the results of the Request Sense command to a drive in SenseData.
Data format of Sense data is defined by the Interface GUID.
@param This Protocol instance pointer.
@param IdeChannel Primary or Secondary
@param IdeDevice Master or Slave
@retval EFI_SUCCESS IdeChannel and IdeDevice are valid
@retval EFI_UNSUPPORTED This is not an IDE device
**/
EFI_STATUS
EFIAPI
IDEDiskInfoWhichIde (
@ -1364,22 +1307,6 @@ IDEDiskInfoWhichIde (
OUT UINT32 *IdeChannel,
OUT UINT32 *IdeDevice
)
/*++
Routine Description:
Return the results of the Request Sense command to a drive in SenseData.
Data format of Sense data is defined by the Interface GUID.
Arguments:
This - Protocol instance pointer.
IdeChannel - Primary or Secondary
IdeDevice - Master or Slave
Returns:
EFI_SUCCESS - IdeChannel and IdeDevice are valid
EFI_UNSUPPORTED - This is not an IDE device
--*/
{
IDE_BLK_IO_DEV *IdeBlkIoDevice;

281
EdkModulePkg/Bus/Pci/IdeBus/Dxe/idebus.h
View File

@ -1,4 +1,6 @@
/*++
/** @file
Header file for IDE Bus Driver.
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -8,18 +10,8 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
**/
idebus.h
Abstract:
Header file for IDE Bus Driver.
Revision History
++*/
// TODO: fix comment to end with --*/
#ifndef _IDE_BUS_H
#define _IDE_BUS_H
@ -94,30 +86,33 @@ extern EFI_DRIVER_BINDING_PROTOCOL gIDEBusDriverBinding;
// Prototypes
// Driver model protocol interface
//
/**
TODO: Add function description
@param ImageHandle TODO: add argument description
@param SystemTable TODO: add argument description
TODO: add return values
**/
EFI_STATUS
EFIAPI
IDEBusControllerDriverEntryPoint (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
ImageHandle - TODO: add argument description
SystemTable - TODO: add argument description
Returns:
@param This TODO: add argument description
@param Controller TODO: add argument description
@param RemainingDevicePath TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
IDEBusDriverBindingSupported (
@ -125,25 +120,18 @@ IDEBusDriverBindingSupported (
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
This - TODO: add argument description
Controller - TODO: add argument description
RemainingDevicePath - TODO: add argument description
Returns:
@param This TODO: add argument description
@param Controller TODO: add argument description
@param RemainingDevicePath TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
IDEBusDriverBindingStart (
@ -151,25 +139,19 @@ IDEBusDriverBindingStart (
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
This - TODO: add argument description
Controller - TODO: add argument description
RemainingDevicePath - TODO: add argument description
Returns:
@param This TODO: add argument description
@param Controller TODO: add argument description
@param NumberOfChildren TODO: add argument description
@param ChildHandleBuffer TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
IDEBusDriverBindingStop (
@ -178,53 +160,40 @@ IDEBusDriverBindingStop (
IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer
)
/*++
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
Controller - TODO: add argument description
NumberOfChildren - TODO: add argument description
ChildHandleBuffer - TODO: add argument description
Returns:
TODO: add return values
--*/
;
//
// Block I/O Protocol Interface
//
/**
TODO: Add function description
@param This TODO: add argument description
@param ExtendedVerification TODO: add argument description
TODO: add return values
**/
EFI_STATUS
EFIAPI
IDEBlkIoReset (
IN EFI_BLOCK_IO_PROTOCOL *This,
IN BOOLEAN ExtendedVerification
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
This - TODO: add argument description
ExtendedVerification - TODO: add argument description
Returns:
@param This TODO: add argument description
@param MediaId TODO: add argument description
@param LBA TODO: add argument description
@param BufferSize TODO: add argument description
@param Buffer TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
IDEBlkIoReadBlocks (
@ -234,27 +203,20 @@ IDEBlkIoReadBlocks (
IN UINTN BufferSize,
OUT VOID *Buffer
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
This - TODO: add argument description
MediaId - TODO: add argument description
LBA - TODO: add argument description
BufferSize - TODO: add argument description
Buffer - TODO: add argument description
Returns:
@param This TODO: add argument description
@param MediaId TODO: add argument description
@param LBA TODO: add argument description
@param BufferSize TODO: add argument description
@param Buffer TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
IDEBlkIoWriteBlocks (
@ -264,72 +226,49 @@ IDEBlkIoWriteBlocks (
IN UINTN BufferSize,
IN VOID *Buffer
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
This - TODO: add argument description
MediaId - TODO: add argument description
LBA - TODO: add argument description
BufferSize - TODO: add argument description
Buffer - TODO: add argument description
Returns:
@param This TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
IDEBlkIoFlushBlocks (
IN EFI_BLOCK_IO_PROTOCOL *This
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
This - TODO: add argument description
Returns:
@param PciIo TODO: add argument description
@param Enable TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
IDERegisterDecodeEnableorDisable (
IN EFI_PCI_IO_PROTOCOL *PciIo,
IN BOOLEAN Enable
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
PciIo - TODO: add argument description
Enable - TODO: add argument description
Returns:
@param This TODO: add argument description
@param InquiryData TODO: add argument description
@param IntquiryDataSize TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
IDEDiskInfoInquiry (
@ -337,25 +276,18 @@ IDEDiskInfoInquiry (
IN OUT VOID *InquiryData,
IN OUT UINT32 *IntquiryDataSize
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
This - TODO: add argument description
InquiryData - TODO: add argument description
IntquiryDataSize - TODO: add argument description
Returns:
@param This TODO: add argument description
@param IdentifyData TODO: add argument description
@param IdentifyDataSize TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
IDEDiskInfoIdentify (
@ -363,25 +295,19 @@ IDEDiskInfoIdentify (
IN OUT VOID *IdentifyData,
IN OUT UINT32 *IdentifyDataSize
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
This - TODO: add argument description
IdentifyData - TODO: add argument description
IdentifyDataSize - TODO: add argument description
Returns:
@param This TODO: add argument description
@param SenseData TODO: add argument description
@param SenseDataSize TODO: add argument description
@param SenseDataNumber TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
IDEDiskInfoSenseData (
@ -390,26 +316,18 @@ IDEDiskInfoSenseData (
IN OUT UINT32 *SenseDataSize,
OUT UINT8 *SenseDataNumber
)
/*++
Routine Description:
;
/**
TODO: Add function description
Arguments:
This - TODO: add argument description
SenseData - TODO: add argument description
SenseDataSize - TODO: add argument description
SenseDataNumber - TODO: add argument description
Returns:
@param This TODO: add argument description
@param IdeChannel TODO: add argument description
@param IdeDevice TODO: add argument description
TODO: add return values
--*/
;
**/
EFI_STATUS
EFIAPI
IDEDiskInfoWhichIde (
@ -417,23 +335,6 @@ IDEDiskInfoWhichIde (
OUT UINT32 *IdeChannel,
OUT UINT32 *IdeDevice
)
/*++
Routine Description:
TODO: Add function description
Arguments:
This - TODO: add argument description
IdeChannel - TODO: add argument description
IdeDevice - TODO: add argument description
Returns:
TODO: add return values
--*/
;
#endif

16
EdkModulePkg/Bus/Pci/IdeBus/Dxe/idedata.h
View File

@ -1,4 +1,6 @@
/*++
/** @file
Header file for IDE Bus Driver's Data Structures
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -8,18 +10,8 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
**/
idedata.h
Abstract:
Header file for IDE Bus Driver's Data Structures
Revision History
++*/
// TODO: fix comment to end with --*/
#ifndef _IDE_DATA_H
#define _IDE_DATA_H