-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation \r
-All rights reserved. This program and the accompanying materials \r
-are licensed and made available under the terms and conditions of the BSD License \r
-which accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
-\r
-Module Name:\r
-\r
- CirrusLogic5430.c\r
- \r
-Abstract:\r
-\r
+/** @file\r
Cirrus Logic 5430 Controller Driver.\r
This driver is a sample implementation of the UGA Draw Protocol for the\r
Cirrus Logic 5430 family of PCI video controllers. This driver is only\r
documentation on UGA for details on how to write a UGA driver that is able\r
to function both in the EFI pre-boot environment and from the OS runtime.\r
\r
-Revision History:\r
+ Copyright (c) 2006, Intel Corporation \r
+ All rights reserved. This program and the accompanying materials \r
+ are licensed and made available under the terms and conditions of the BSD License \r
+ which accompanies this distribution. The full text of the license may be found at \r
+ http://opensource.org/licenses/bsd-license.php \r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
---*/\r
+**/\r
\r
//\r
// Cirrus Logic 5430 Controller Driver\r
NULL\r
};\r
\r
+/**\r
+ CirrusLogic5430ControllerDriverSupported\r
+\r
+ TODO: This - add argument and description to function comment\r
+ TODO: Controller - add argument and description to function comment\r
+ TODO: RemainingDevicePath - add argument and description to function comment\r
+**/\r
EFI_STATUS\r
EFIAPI\r
CirrusLogic5430ControllerDriverSupported (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
-// TODO: This - add argument and description to function comment\r
-// TODO: Controller - add argument and description to function comment\r
-// TODO: RemainingDevicePath - add argument and description to function comment\r
{\r
EFI_STATUS Status;\r
EFI_PCI_IO_PROTOCOL *PciIo;\r
return Status;\r
}\r
\r
+/**\r
+ CirrusLogic5430ControllerDriverStart\r
+\r
+ TODO: This - add argument and description to function comment\r
+ TODO: Controller - add argument and description to function comment\r
+ TODO: RemainingDevicePath - add argument and description to function comment\r
+**/\r
EFI_STATUS\r
EFIAPI\r
CirrusLogic5430ControllerDriverStart (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
-// TODO: This - add argument and description to function comment\r
-// TODO: Controller - add argument and description to function comment\r
-// TODO: RemainingDevicePath - add argument and description to function comment\r
{\r
EFI_STATUS Status;\r
CIRRUS_LOGIC_5430_PRIVATE_DATA *Private;\r
return Status;\r
}\r
\r
+/**\r
+ CirrusLogic5430ControllerDriverStop\r
+\r
+ TODO: This - add argument and description to function comment\r
+ TODO: Controller - add argument and description to function comment\r
+ TODO: NumberOfChildren - add argument and description to function comment\r
+ TODO: ChildHandleBuffer - add argument and description to function comment\r
+ TODO: EFI_SUCCESS - add return value to function comment\r
+**/\r
EFI_STATUS\r
EFIAPI\r
CirrusLogic5430ControllerDriverStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
-// TODO: This - add argument and description to function comment\r
-// TODO: Controller - add argument and description to function comment\r
-// TODO: NumberOfChildren - add argument and description to function comment\r
-// TODO: ChildHandleBuffer - add argument and description to function comment\r
-// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
EFI_UGA_DRAW_PROTOCOL *UgaDraw;\r
EFI_STATUS Status;\r