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

Code scrub for VgaMiniPortDxe. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8608 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
xli24 2009-06-19 08:26:33 +00:00
parent 3dcb601895
commit 269e4559ae
4 changed files with 212 additions and 237 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

164
IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/ComponentName.c
View File

@ -1,7 +1,7 @@
/** @file
Implementation of EFI_COMPONENT_NAME_PROTOCOL for VgaminiPort driver.
Implements EFI Component Name Protocol for VGA Mini Port Driver.
Copyright (c) 2006 - 2007 Intel Corporation. All rights reserved
Copyright (c) 2006 - 2009 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
@ -14,135 +14,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include "VgaMiniPort.h"
//
// EFI Component Name Functions
//
/**
Retrieves a Unicode string that is the user readable name of the driver.
This function retrieves the user readable name of a driver in the form of a
Unicode string. If the driver specified by This has a user readable name in
the language specified by Language, then a pointer to the driver name is
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
by This does not support the language specified by Language,
then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param Language[in] A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
languages specified in SupportedLanguages. The
number of languages supported by a driver is up
to the driver writer. Language is specified
in RFC 4646 or ISO 639-2 language code format.
@param DriverName[out] A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language.
@retval EFI_SUCCESS The Unicode string for the Driver specified by
This and the language specified by Language was
returned in DriverName.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER DriverName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/
EFI_STATUS
EFIAPI
PciVgaMiniPortComponentNameGetDriverName (
IN EFI_COMPONENT_NAME_PROTOCOL *This,
IN CHAR8 *Language,
OUT CHAR16 **DriverName
);
/**
Retrieves a Unicode string that is the user readable name of the controller
that is being managed by a driver.
This function retrieves the user readable name of the controller specified by
ControllerHandle and ChildHandle in the form of a Unicode string. If the
driver specified by This has a user readable name in the language specified by
Language, then a pointer to the controller name is returned in ControllerName,
and EFI_SUCCESS is returned. If the driver specified by This is not currently
managing the controller specified by ControllerHandle and ChildHandle,
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param ControllerHandle[in] The handle of a controller that the driver
specified by This is managing. This handle
specifies the controller whose name is to be
returned.
@param ChildHandle[in] The handle of the child controller to retrieve
the name of. This is an optional parameter that
may be NULL. It will be NULL for device
drivers. It will also be NULL for a bus drivers
that wish to retrieve the name of the bus
controller. It will not be NULL for a bus
driver that wishes to retrieve the name of a
child controller.
@param Language[in] A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
languages specified in SupportedLanguages. The
number of languages supported by a driver is up
to the driver writer. Language is specified in
RFC 4646 or ISO 639-2 language code format.
@param ControllerName[out] A pointer to the Unicode string to return.
This Unicode string is the name of the
controller specified by ControllerHandle and
ChildHandle in the language specified by
Language from the point of view of the driver
specified by This.
@retval EFI_SUCCESS The Unicode string for the user readable name in
the language specified by Language for the
driver specified by This was returned in
DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
EFI_HANDLE.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER ControllerName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This is not currently
managing the controller specified by
ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/
EFI_STATUS
EFIAPI
PciVgaMiniPortComponentNameGetControllerName (
IN EFI_COMPONENT_NAME_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL,
IN CHAR8 *Language,
OUT CHAR16 **ControllerName
);
//
// EFI Component Name Protocol
@ -184,10 +55,9 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mPciVgaMiniPortDriverName
by This does not support the language specified by Language,
then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
@param This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param Language[in] A pointer to a Null-terminated ASCII string
@param Language A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
@ -195,8 +65,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mPciVgaMiniPortDriverName
number of languages supported by a driver is up
to the driver writer. Language is specified
in RFC 4646 or ISO 639-2 language code format.
@param DriverName[out] A pointer to the Unicode string to return.
@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.
@ -204,11 +73,8 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mPciVgaMiniPortDriverName
@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.
@ -243,15 +109,13 @@ PciVgaMiniPortComponentNameGetDriverName (
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
@param This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param ControllerHandle[in] The handle of a controller that the driver
@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[in] The handle of the child controller to retrieve
@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
@ -259,8 +123,7 @@ PciVgaMiniPortComponentNameGetDriverName (
controller. It will not be NULL for a bus
driver that wishes to retrieve the name of a
child controller.
@param Language[in] A pointer to a Null-terminated ASCII string
@param Language A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
@ -268,8 +131,7 @@ PciVgaMiniPortComponentNameGetDriverName (
number of languages supported by a driver is up
to the driver writer. Language is specified in
RFC 4646 or ISO 639-2 language code format.
@param ControllerName[out] A pointer to the Unicode string to return.
@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
@ -280,20 +142,14 @@ PciVgaMiniPortComponentNameGetDriverName (
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.

69
IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPort.c
View File

@ -1,6 +1,7 @@
/** @file
Implements EFI Driver Binding Protocol and VGA Mini Port Protocol for VGA Mini Port Driver.
Copyright (c) 2006 Intel Corporation. All rights reserved
Copyright (c) 2006 - 2009 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
@ -34,12 +35,16 @@ EFI_DRIVER_BINDING_PROTOCOL gPciVgaMiniPortDriverBinding = {
};
/**
Driver entry point for VgaMiniPort driver.
Entrypoint of VGA Mini Port Driver.
@param ImageHandle Driver image handle.
@param SystemTable Point to EFI_SYSTEM_TABLE.
This function is the entrypoint of UVGA Mini Port Driver. It installs Driver Binding
Protocols together with Component Name Protocols.
@param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The entry point is executed successfully.
@retval Status of install driver binding protocol.
**/
EFI_STATUS
EFIAPI
@ -48,7 +53,9 @@ PciVgaMiniPortDriverEntryPoint (
IN EFI_SYSTEM_TABLE *SystemTable
)
{
return EfiLibInstallDriverBindingComponentName2 (
EFI_STATUS Status;
Status = EfiLibInstallDriverBindingComponentName2 (
ImageHandle,
SystemTable,
&gPciVgaMiniPortDriverBinding,
@ -56,13 +63,14 @@ PciVgaMiniPortDriverEntryPoint (
&gPciVgaMiniPortComponentName,
&gPciVgaMiniPortComponentName2
);
ASSERT_EFI_ERROR (Status);
return EFI_SUCCESS;
}
/**
Supported.
(Standard DriverBinding Protocol Supported() function)
Check whether VGA Mini Port driver supports this device.
@param This The driver binding protocol.
@param Controller The controller handle to check.
@ -135,9 +143,10 @@ Done:
/**
Install VGA Mini Port Protocol onto VGA device handles
Starts the VGA device with this driver.
(Standard DriverBinding Protocol Start() function)
This function consumes PCI I/O Protocol, and installs VGA Mini Port Protocol
onto the VGA device handle.
@param This The driver binding instance.
@param Controller The controller to check.
@ -179,16 +188,8 @@ PciVgaMiniPortDriverBindingStart (
//
// Allocate the private device structure
//
Status = gBS->AllocatePool (
EfiBootServicesData,
sizeof (PCI_VGA_MINI_PORT_DEV),
(VOID **) &PciVgaMiniPortPrivate
);
if (EFI_ERROR (Status)) {
goto Done;
}
ZeroMem (PciVgaMiniPortPrivate, sizeof (PCI_VGA_MINI_PORT_DEV));
PciVgaMiniPortPrivate = AllocateZeroPool (sizeof (PCI_VGA_MINI_PORT_DEV));
ASSERT (PciVgaMiniPortPrivate != NULL);
//
// Initialize the private device structure
@ -207,7 +208,7 @@ PciVgaMiniPortDriverBindingStart (
PciVgaMiniPortPrivate->VgaMiniPort.MaxMode = 1;
//
// Install Vga Mini Port Protocol
// Install VGA Mini Port Protocol
//
Status = gBS->InstallMultipleProtocolInterfaces (
&Controller,
@ -224,7 +225,7 @@ Done:
Controller
);
if (PciVgaMiniPortPrivate != NULL) {
gBS->FreePool (PciVgaMiniPortPrivate);
FreePool (PciVgaMiniPortPrivate);
}
}
@ -233,9 +234,10 @@ Done:
/**
Stop.
Stop the VGA device with this driver.
(Standard DriverBinding Protocol Stop() function)
This function uninstalls VGA Mini Port Protocol from the VGA device handle,
and closes PCI I/O Protocol.
@param This The driver binding protocol.
@param Controller The controller to release.
@ -290,7 +292,7 @@ PciVgaMiniPortDriverBindingStop (
Controller
);
gBS->FreePool (PciVgaMiniPortPrivate);
FreePool (PciVgaMiniPortPrivate);
return EFI_SUCCESS;
}
@ -299,13 +301,18 @@ PciVgaMiniPortDriverBindingStop (
//
/**
Thunk function of EFI_VGA_MINI_PORT_SET_MODE.
Sets the text display mode of a VGA controller.
@param This Point to instance of EFI_VGA_MINI_PORT_PROTOCOL.
@param ModeNumber Mode number.
This function implements EFI_VGA_MINI_PORT_PROTOCOL.SetMode().
If ModeNumber exceeds the valid range, then EFI_UNSUPPORTED is returned.
Otherwise, EFI_SUCCESS is directly returned without real operation.
@retval EFI_UNSUPPORTED Invalid mode number.
@retval EFI_SUCCESS Success.
@param This Protocol instance pointer.
@param ModeNumber Mode number. 0 - 80x25 1-80x50
@retval EFI_SUCCESS The mode was set
@retval EFI_UNSUPPORTED ModeNumber is not supported.
@retval EFI_DEVICE_ERROR The device is not functioning properly.
**/
EFI_STATUS

146
IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPort.h
View File

@ -1,6 +1,7 @@
/** @file
Internal include file for VGA Mini Port Driver.
Copyright (c) 2006 - 2007 Intel Corporation. All rights reserved
Copyright (c) 2006 - 2009 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
@ -34,6 +35,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/MemoryAllocationLib.h>
#include <IndustryStandard/Pci22.h>
@ -62,9 +64,7 @@ typedef struct {
// Driver Binding Protocol functions
//
/**
Supported.
(Standard DriverBinding Protocol Supported() function)
Check whether VGA Mini Port driver supports this device.
@param This The driver binding protocol.
@param Controller The controller handle to check.
@ -83,9 +83,10 @@ PciVgaMiniPortDriverBindingSupported (
);
/**
Install VGA Mini Port Protocol onto VGA device handles
Starts the VGA device with this driver.
(Standard DriverBinding Protocol Start() function)
This function consumes PCI I/O Protocol, and installs VGA Mini Port Protocol
onto the VGA device handle.
@param This The driver binding instance.
@param Controller The controller to check.
@ -105,9 +106,10 @@ PciVgaMiniPortDriverBindingStart (
);
/**
Stop.
Stop the VGA device with this driver.
(Standard DriverBinding Protocol Stop() function)
This function uninstalls VGA Mini Port Protocol from the VGA device handle,
and closes PCI I/O Protocol.
@param This The driver binding protocol.
@param Controller The controller to release.
@ -128,17 +130,135 @@ PciVgaMiniPortDriverBindingStop (
IN EFI_HANDLE *ChildHandleBuffer
);
//
// EFI Component Name Functions
//
/**
Retrieves a Unicode string that is the user readable name of the driver.
This function retrieves the user readable name of a driver in the form of a
Unicode string. If the driver specified by This has a user readable name in
the language specified by Language, then a pointer to the driver name is
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
by This does not support the language specified by Language,
then EFI_UNSUPPORTED is returned.
@param This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param Language A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
languages specified in SupportedLanguages. The
number of languages supported by a driver is up
to the driver writer. Language is specified
in RFC 4646 or ISO 639-2 language code format.
@param DriverName 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
PciVgaMiniPortComponentNameGetDriverName (
IN EFI_COMPONENT_NAME_PROTOCOL *This,
IN CHAR8 *Language,
OUT CHAR16 **DriverName
);
/**
Retrieves a Unicode string that is the user readable name of the controller
that is being managed by a driver.
This function retrieves the user readable name of the controller specified by
ControllerHandle and ChildHandle in the form of a Unicode string. If the
driver specified by This has a user readable name in the language specified by
Language, then a pointer to the controller name is returned in ControllerName,
and EFI_SUCCESS is returned. If the driver specified by This is not currently
managing the controller specified by ControllerHandle and ChildHandle,
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
@param This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
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 Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
languages specified in SupportedLanguages. The
number of languages supported by a driver is up
to the driver writer. Language is specified in
RFC 4646 or ISO 639-2 language code format.
@param ControllerName 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
PciVgaMiniPortComponentNameGetControllerName (
IN EFI_COMPONENT_NAME_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL,
IN CHAR8 *Language,
OUT CHAR16 **ControllerName
);
//
// VGA Mini Port Protocol functions
//
/**
Thunk function of EFI_VGA_MINI_PORT_SET_MODE.
Sets the text display mode of a VGA controller.
@param This Point to instance of EFI_VGA_MINI_PORT_PROTOCOL.
@param ModeNumber Mode number.
This function implements EFI_VGA_MINI_PORT_PROTOCOL.SetMode().
If ModeNumber exceeds the valid range, then EFI_UNSUPPORTED is returned.
Otherwise, EFI_SUCCESS is directly returned without real operation.
@retval EFI_UNSUPPORTED Invalid mode number.
@retval EFI_SUCCESS Success.
@param This Protocol instance pointer.
@param ModeNumber Mode number. 0 - 80x25 1-80x50
@retval EFI_SUCCESS The mode was set
@retval EFI_UNSUPPORTED ModeNumber is not supported.
@retval EFI_DEVICE_ERROR The device is not functioning properly.
**/
EFI_STATUS

18
IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPortDxe.inf
View File

@ -1,8 +1,5 @@
#/** @file
# Component name for module VgaMiniPort
#
# FIX ME!
# Copyright (c) 2006 - 2009, Intel Corporation.
# VGA Mini Port Driver that manages VGA device and produces VGA Mini Port Protocol.
#
# All rights reserved. This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
@ -21,7 +18,6 @@
FILE_GUID = 15C5E761-58D8-461a-9173-CAB020916264
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
EFI_SPECIFICATION_VERSION = 0x00020000
ENTRY_POINT = PciVgaMiniPortDriverEntryPoint
#
@ -38,24 +34,20 @@
VgaMiniPort.c
VgaMiniPort.h
[Packages]
MdePkg/MdePkg.dec
MdeModulePkg/MdeModulePkg.dec
IntelFrameworkPkg/IntelFrameworkPkg.dec
IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec
[LibraryClasses]
UefiLib
DebugLib
UefiBootServicesTableLib
UefiDriverEntryPoint
BaseMemoryLib
MemoryAllocationLib
[Protocols]
gEfiPciIoProtocolGuid # PROTOCOL ALWAYS_CONSUMED
gEfiComponentName2ProtocolGuid
gEfiVgaMiniPortProtocolGuid
gEfiPciIoProtocolGuid ## TO_START
gEfiVgaMiniPortProtocolGuid ## BY_START