From ed72955cc855cd232ba75ff8dde334569f90f913 Mon Sep 17 00:00:00 2001 From: darylm503 Date: Fri, 9 Jun 2006 23:41:12 +0000 Subject: 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 --- .../Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.c | 96 ++--- .../Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.h | 155 +++----- .../Pci/CirrusLogic/Dxe/CirrusLogic5430UgaDraw.c | 439 ++++++++------------- .../Bus/Pci/CirrusLogic/Dxe/ComponentName.c | 157 ++++---- 4 files changed, 323 insertions(+), 524 deletions(-) (limited to 'EdkModulePkg/Bus/Pci/CirrusLogic') diff --git a/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.c b/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.c index 91d6accd99..68c483071c 100644 --- a/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.c +++ b/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.c @@ -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; diff --git a/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.h b/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.h index 79ca7e0293..b1984c8865 100644 --- a/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.h +++ b/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.h @@ -1,25 +1,16 @@ -/*++ - -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.h - -Abstract: - +/** @file Cirrus Logic 5430 Controller Driver -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 @@ -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: +; +// +// EFI 1.1 driver model prototypes for Cirrus Logic 5430 UGA Draw +// +/** TODO: Add function description -Arguments: - - Private - TODO: add argument description - -Returns: + @param ImageHandle TODO: add argument description + @param SystemTable TODO: add argument description TODO: add return values ---*/ -; - -// -// EFI 1.1 driver model prototypes for Cirrus Logic 5430 UGA Draw -// +**/ EFI_STATUS EFIAPI CirrusLogic5430DriverEntryPoint ( IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable ) -/*++ - -Routine Description: +; +// +// EFI_DRIVER_BINDING_PROTOCOL Protocol Interface +// +/** 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_DRIVER_BINDING_PROTOCOL Protocol Interface -// +**/ 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 diff --git a/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430UgaDraw.c b/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430UgaDraw.c index c33918b675..60e0582cf0 100644 --- a/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430UgaDraw.c +++ b/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430UgaDraw.c @@ -1,31 +1,24 @@ -/*++ - -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: - - CirrusLogic5430UgaDraw.c - -Abstract: - +/** @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 + 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. + +**/ #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: ); } -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: + @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 + ) { UINT8 Data; @@ -781,27 +718,20 @@ Returns: return Data; } -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: + @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 + ) { 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)); } -VOID -SetDefaultPalette ( - 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 ---*/ +**/ +VOID +SetDefaultPalette ( + CIRRUS_LOGIC_5430_PRIVATE_DATA *Private + ) { UINTN Index; UINTN RedIndex; @@ -886,26 +802,19 @@ Returns: } } -STATIC -VOID -ClearScreen ( - 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 ---*/ +**/ +STATIC +VOID +ClearScreen ( + CIRRUS_LOGIC_5430_PRIVATE_DATA *Private + ) { UINT32 Color; @@ -920,25 +829,18 @@ Returns: ); } -VOID -DrawLogo ( - 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 ---*/ +**/ +VOID +DrawLogo ( + CIRRUS_LOGIC_5430_PRIVATE_DATA *Private + ) { UINTN Offset; UINTN X; @@ -968,27 +870,20 @@ Returns: } } -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: + @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 + ) { UINT8 Byte; UINTN Index; diff --git a/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/ComponentName.c b/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/ComponentName.c index 5c10b6d7b4..933899fa12 100644 --- a/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/ComponentName.c +++ b/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/ComponentName.c @@ -1,21 +1,14 @@ -/*++ +/** @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 + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php -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. + 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; -- cgit v1.2.3