IN CHAR16 c\r
);\r
\r
+/**\r
+ Test to see if this driver supports ControllerHandle. Any ControllerHandle\r
+ than contains a VgaMiniPort and PciIo protocol can be supported.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ControllerHandle Handle of device to test\r
+ @param RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
+\r
+ @retval EFI_SUCCESS This driver supports this device\r
+ @retval EFI_ALREADY_STARTED This driver is already running on this device\r
+ @retval other This driver does not support this device\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
VgaClassDriverBindingSupported (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
- \r
- Routine Description:\r
- \r
- Supported.\r
- \r
- Arguments:\r
- \r
- (Standard DriverBinding Protocol Supported() function)\r
- \r
- Returns:\r
- \r
- EFI_STATUS\r
- \r
---*/\r
-// GC_TODO: This - add argument and description to function comment\r
-// GC_TODO: Controller - add argument and description to function comment\r
-// GC_TODO: RemainingDevicePath - add argument and description to function comment\r
{\r
EFI_STATUS Status;\r
EFI_VGA_MINI_PORT_PROTOCOL *VgaMiniPort;\r
return Status;\r
}\r
\r
+/**\r
+ Start this driver on ControllerHandle by opening a PciIo and VgaMiniPort\r
+ protocol, creating VGA_CLASS_DEV device and install gEfiSimpleTextOutProtocolGuid\r
+ finnally.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ControllerHandle Handle of device to bind driver to\r
+ @param RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
+\r
+ @retval EFI_SUCCESS This driver is added to ControllerHandle\r
+ @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
+ @retval other This driver does not support this device\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
VgaClassDriverBindingStart (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
- \r
- Routine Description:\r
- \r
- Layers the Simple Text Output Protocol on top of the \r
- VGA Mini Port Protocol\r
- \r
- Arguments:\r
- \r
- (Standard DriverBinding Protocol Start() function)\r
- \r
- Returns:\r
- \r
- EFI_STATUS\r
- \r
---*/\r
-// GC_TODO: This - add argument and description to function comment\r
-// GC_TODO: Controller - add argument and description to function comment\r
-// GC_TODO: RemainingDevicePath - add argument and description to function comment\r
-// GC_TODO: EFI_OUT_OF_RESOURCES - add return value to function comment\r
{\r
EFI_STATUS Status;\r
EFI_VGA_MINI_PORT_PROTOCOL *VgaMiniPort;\r
\r
}\r
\r
+/**\r
+ Stop this driver on ControllerHandle. Support stoping any child handles\r
+ created by this driver.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ControllerHandle Handle of device to stop driver on\r
+ @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
+ children is zero stop the entire bus driver.\r
+ @param ChildHandleBuffer List of Child Handles to Stop.\r
+\r
+ @retval EFI_SUCCESS This driver is removed ControllerHandle\r
+ @retval other This driver was not removed from this device\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
VgaClassDriverBindingStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
- \r
- Routine Description:\r
- \r
- Stop.\r
- \r
- Arguments:\r
- \r
- (Standard DriverBinding Protocol Stop() function)\r
- \r
- Returns:\r
- \r
- EFI_STATUS\r
- \r
---*/\r
-// GC_TODO: This - add argument and description to function comment\r
-// GC_TODO: Controller - add argument and description to function comment\r
-// GC_TODO: NumberOfChildren - add argument and description to function comment\r
-// GC_TODO: ChildHandleBuffer - add argument and description to function comment\r
-// GC_TODO: EFI_SUCCESS - add return value to function comment\r
{\r
EFI_STATUS Status;\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *SimpleTextOut;\r
\r
return EFI_SUCCESS;\r
}\r
-//\r
-// Simple Text Output Protocol Functions\r
-//\r
+\r
+/**\r
+ Reset VgaClass device and clear output.\r
+ \r
+ @param This Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.\r
+ @param ExtendedVerification Whether need additional judgement\r
+**/\r
EFI_STATUS\r
EFIAPI\r
VgaClassReset (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- ExtendedVerification - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
VGA_CLASS_DEV *VgaClassPrivate;\r
return This->ClearScreen (This);\r
}\r
\r
+/**\r
+ Output a string to VgaClass device.\r
+ \r
+ @param This Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.\r
+ @param WString wide chars.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
VgaClassOutputString (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN CHAR16 *WString\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- WString - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
VGA_CLASS_DEV *VgaClassDev;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Detects if a Unicode char is for Box Drawing text graphics.\r
+ \r
+ @param This Pointer of EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL\r
+ @param WString Unicode chars\r
+ \r
+ @return if a Unicode char is for Box Drawing text graphics.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
VgaClassTestString (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN CHAR16 *WString\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- WString - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_UNSUPPORTED - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
while (*WString != 0x0000) {\r
if (!(IsValidAscii (*WString) || IsValidEfiCntlChar (*WString) || LibIsValidTextGraphics (*WString, NULL, NULL))) {\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Clear Screen via VgaClass device\r
+ \r
+ @param This Pointer of EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL \r
+ \r
+ @retval EFI_SUCESS Success to clear screen\r
+ @retval Others Wrong displaying mode.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
VgaClassClearScreen (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
VGA_CLASS_DEV *VgaClassDev;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Set displaying mode's attribute\r
+ \r
+ @param This Pointer of EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL \r
+ @param Attribute Mode's attribute\r
+ \r
+ @param EFI_SUCCESS Success to set attribute\r
+ @param EFI_UNSUPPORTED Wrong mode's attribute wanted to be set\r
+**/\r
EFI_STATUS\r
EFIAPI\r
VgaClassSetAttribute (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN UINTN Attribute\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- Attribute - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
- EFI_UNSUPPORTED - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
if (Attribute <= EFI_MAX_ATTRIBUTE) {\r
This->Mode->Attribute = (INT32) Attribute;\r
return EFI_UNSUPPORTED;\r
}\r
\r
+/**\r
+ Set cursor position.\r
+ \r
+ @param This Pointer of EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL \r
+ @param Column Column of new cursor position.\r
+ @param Row Row of new cursor position.\r
+ \r
+ @retval EFI_SUCCESS Sucess to set cursor's position.\r
+ @retval Others Wrong current displaying mode.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
VgaClassSetCursorPosition (\r
IN UINTN Column,\r
IN UINTN Row\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- Column - GC_TODO: add argument description\r
- Row - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_UNSUPPORTED - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
VGA_CLASS_DEV *VgaClassDev;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Enable cursor to display or not.\r
+ \r
+ @param This Pointer of EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL \r
+ @param Visible Display cursor or not.\r
+ \r
+ @retval EFI_SUCESS Success to display the cursor or not.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
VgaClassEnableCursor (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN BOOLEAN Visible\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- Visible - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
VGA_CLASS_DEV *VgaClassDev;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Query colum and row according displaying mode number\r
+ The mode:\r
+ 0: 80 * 25\r
+ 1: 80 * 50\r
+ \r
+ @param This Pointer of EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL\r
+ @param ModeNumber Mode number\r
+ @param Columns return the columen in current mode number\r
+ @param Rows return the row in current mode number.\r
+ \r
+ @return EFI_SUCCESS Sucess to get columns and rows according to mode number\r
+ @return EFI_UNSUPPORTED Unsupported mode number\r
+**/\r
EFI_STATUS\r
EFIAPI\r
VgaClassQueryMode (\r
OUT UINTN *Columns,\r
OUT UINTN *Rows\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- ModeNumber - GC_TODO: add argument description\r
- Columns - GC_TODO: add argument description\r
- Rows - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_UNSUPPORTED - GC_TODO: Add description for return value\r
- EFI_UNSUPPORTED - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
if ((INT32) ModeNumber >= This->Mode->MaxMode) {\r
*Columns = 0;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Set displaying mode number\r
+ \r
+ @param This Pointer of EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL\r
+ @param ModeNumber mode number\r
+ \r
+ @retval EFI_UNSUPPORTED Unsupported mode number in parameter\r
+ @retval EFI_SUCCESS Success to set the mode number.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
VgaClassSetMode (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN UINTN ModeNumber\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- ModeNumber - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_UNSUPPORTED - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
VGA_CLASS_DEV *VgaClassDev;\r
\r
return Status;\r
}\r
-//\r
-// Private Worker Functions\r
-//\r
+\r
+/**\r
+ Set logic cursor's position to VgaClass device\r
+ \r
+ @param VgaClassDev device instance object\r
+ @param Column cursor logic position.\r
+ @param Row cursor logic position.\r
+ @param MaxColumn max logic column\r
+ \r
+**/\r
STATIC\r
VOID\r
SetVideoCursorPosition (\r
IN UINTN Row,\r
IN UINTN MaxColumn\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- VgaClassDev - GC_TODO: add argument description\r
- Column - GC_TODO: add argument description\r
- Row - GC_TODO: add argument description\r
- MaxColumn - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
Column = Column & 0xff;\r
Row = Row & 0xff;\r
);\r
}\r
\r
+/**\r
+ Program CRTC register via PCI IO.\r
+ \r
+ @param VgaClassDev device instance object\r
+ @param Address address\r
+ @param Data data\r
+**/\r
STATIC\r
VOID\r
WriteCrtc (\r
IN UINT16 Address,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- VgaClassDev - GC_TODO: add argument description\r
- Address - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
VgaClassDev->PciIo->Io.Write (\r
VgaClassDev->PciIo,\r
);\r
}\r
\r
+/**\r
+ Detects if a Unicode char is for Box Drawing text graphics.\r
+\r
+ @param Grphic Unicode char to test.\r
+ @param PcAnsi Optional pointer to return PCANSI equivalent of Graphic.\r
+ @param Asci Optional pointer to return Ascii equivalent of Graphic.\r
+\r
+ @return TRUE if Gpaphic is a supported Unicode Box Drawing character.\r
+\r
+**/\r
STATIC\r
BOOLEAN\r
LibIsValidTextGraphics (\r
OUT CHAR8 *PcAnsi, OPTIONAL\r
OUT CHAR8 *Ascii OPTIONAL\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Detects if a Unicode char is for Box Drawing text graphics.\r
-\r
-Arguments:\r
-\r
- Grphic - Unicode char to test.\r
-\r
- PcAnsi - Optional pointer to return PCANSI equivalent of Graphic.\r
-\r
- Asci - Optional pointer to return Ascii equivalent of Graphic.\r
-\r
-Returns:\r
-\r
- TRUE if Gpaphic is a supported Unicode Box Drawing character.\r
-\r
---*/\r
-// GC_TODO: Graphic - add argument and description to function comment\r
{\r
UNICODE_TO_CHAR *Table;\r
\r
return FALSE;\r
}\r
\r
+/**\r
+ Judge whether is an ASCII char.\r
+ \r
+ @param Ascii character\r
+ @return whether is an ASCII char.\r
+**/\r
STATIC\r
BOOLEAN\r
IsValidAscii (\r
IN CHAR16 Ascii\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- Ascii - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
if ((Ascii >= 0x20) && (Ascii <= 0x7f)) {\r
return TRUE;\r
return FALSE;\r
}\r
\r
+/**\r
+ Judge whether is diplaying control character.\r
+ \r
+ @param c character\r
+ @return whether is diplaying control character.\r
+**/\r
STATIC\r
BOOLEAN\r
IsValidEfiCntlChar (\r
IN CHAR16 c\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- c - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
if (c == CHAR_NULL || c == CHAR_BACKSPACE || c == CHAR_LINEFEED || c == CHAR_CARRIAGE_RETURN) {\r
return TRUE;\r
\r
return FALSE;\r
}\r
+\r
IN OUT UINT64 *PtrCurrentMTC\r
);\r
\r
+/**\r
+\r
+ Log data record into the data logging hub\r
+\r
+ @param This - Protocol instance structure\r
+ @param DataRecordGuid - GUID that defines record contents\r
+ @param ProducerName - GUID that defines the name of the producer of the data\r
+ @param DataRecordClass - Class that defines generic record type\r
+ @param RawData - Data Log record as defined by DataRecordGuid\r
+ @param RawDataSize - Size of Data Log data in bytes\r
+\r
+ @retval EFI_SUCCESS - If data was logged\r
+ @retval EFI_OUT_OF_RESOURCES - If data was not logged due to lack of system \r
+ resources.\r
+**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
IN VOID *RawData,\r
IN UINT32 RawDataSize\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Log data record into the data logging hub\r
-\r
-Arguments:\r
-\r
- This - Protocol instance structure\r
-\r
- DataRecordGuid - GUID that defines record contents\r
-\r
- ProducerName - GUID that defines the name of the producer of the data\r
-\r
- DataRecordClass - Class that defines generic record type\r
-\r
- RawData - Data Log record as defined by DataRecordGuid\r
- \r
- RawDataSize - Size of Data Log data in bytes\r
-\r
-Returns: \r
-\r
- EFI_SUCCESS - If data was logged\r
-\r
- EFI_OUT_OF_RESOURCES - If data was not logged due to lack of system \r
- resources.\r
---*/\r
{\r
EFI_STATUS Status;\r
DATA_HUB_INSTANCE *Private;\r
return EFI_SUCCESS;\r
}\r
\r
-STATIC\r
-EFI_STATUS\r
-EFIAPI\r
-DataHubGetNextRecord (\r
- IN EFI_DATA_HUB_PROTOCOL *This,\r
- IN OUT UINT64 *MonotonicCount,\r
- IN EFI_EVENT *FilterDriverEvent, OPTIONAL\r
- OUT EFI_DATA_RECORD_HEADER **Record\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
Get a previously logged data record and the MonotonicCount for the next\r
availible Record. This allows all records or all records later \r
not yet read by the filter driver. If FilterDriverEvent is NULL and \r
MonotonicCount is zero return the first data record.\r
\r
-Arguments:\r
-\r
- This - The EFI_DATA_HUB_PROTOCOL instance.\r
- MonotonicCount - Specifies the Record to return. On input, zero means\r
- return the first record. On output, contains the next\r
- record to availible. Zero indicates no more records.\r
- FilterDriverEvent - If FilterDriverEvent is not passed in a MonotonicCount \r
- of zero, it means to return the first data record. \r
- If FilterDriverEvent is passed in, then a MonotonicCount \r
- of zero means to return the first data not yet read by \r
- FilterDriverEvent.\r
- Record - Returns a dynamically allocated memory buffer with a data \r
- record that matches MonotonicCount.\r
-\r
-Returns: \r
-\r
- EFI_SUCCESS - Data was returned in Record.\r
- EFI_INVALID_PARAMETER - FilterDriverEvent was passed in but does not exist.\r
- EFI_NOT_FOUND - MonotonicCount does not match any data record in the\r
+ @param This The EFI_DATA_HUB_PROTOCOL instance.\r
+ @param MonotonicCount Specifies the Record to return. On input, zero means\r
+ return the first record. On output, contains the next\r
+ record to availible. Zero indicates no more records.\r
+ @param FilterDriverEvent If FilterDriverEvent is not passed in a MonotonicCount \r
+ of zero, it means to return the first data record. \r
+ If FilterDriverEvent is passed in, then a MonotonicCount \r
+ of zero means to return the first data not yet read by \r
+ FilterDriverEvent.\r
+ @param Record Returns a dynamically allocated memory buffer with a data \r
+ record that matches MonotonicCount.\r
+\r
+ @retval EFI_SUCCESS - Data was returned in Record.\r
+ @retval EFI_INVALID_PARAMETER - FilterDriverEvent was passed in but does not exist.\r
+ @retval EFI_NOT_FOUND - MonotonicCount does not match any data record in the\r
system. If a MonotonicCount of zero was passed in, then\r
no data records exist in the system.\r
- EFI_OUT_OF_RESOURCES - Record was not returned due to lack of system resources.\r
+ @retval EFI_OUT_OF_RESOURCES - Record was not returned due to lack of system resources.\r
\r
---*/\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+DataHubGetNextRecord (\r
+ IN EFI_DATA_HUB_PROTOCOL *This,\r
+ IN OUT UINT64 *MonotonicCount,\r
+ IN EFI_EVENT *FilterDriverEvent, OPTIONAL\r
+ OUT EFI_DATA_RECORD_HEADER **Record\r
+ )\r
{\r
DATA_HUB_INSTANCE *Private;\r
DATA_HUB_FILTER_DRIVER *FilterDriver;\r
return EFI_SUCCESS;\r
}\r
\r
-STATIC\r
-EFI_STATUS\r
-EFIAPI\r
-DataHubRegisterFilterDriver (\r
- IN EFI_DATA_HUB_PROTOCOL * This,\r
- IN EFI_EVENT FilterEvent,\r
- IN EFI_TPL FilterTpl,\r
- IN UINT64 FilterClass,\r
- IN EFI_GUID * FilterDataRecordGuid OPTIONAL\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
This function registers the data hub filter driver that is represented \r
by FilterEvent. Only one instance of each FilterEvent can be registered.\r
After the FilterEvent is registered, it will be signaled so it can sync \r
with data records that have been recorded prior to the FilterEvent being \r
registered.\r
\r
-Arguments:\r
-\r
- This - The EFI_DATA_HUB_PROTOCOL instance.\r
- FilterEvent - The EFI_EVENT to signal whenever data that matches \r
+ @param This - The EFI_DATA_HUB_PROTOCOL instance.\r
+ @param FilterEvent - The EFI_EVENT to signal whenever data that matches \r
FilterClass is logged in the system.\r
- FilterTpl - The maximum EFI_TPL at which FilterEvent can be \r
+ @param FilterTpl - The maximum EFI_TPL at which FilterEvent can be \r
signaled. It is strongly recommended that you use the \r
lowest EFI_TPL possible.\r
- FilterClass - FilterEvent will be signaled whenever a bit in \r
+ @param FilterClass - FilterEvent will be signaled whenever a bit in \r
EFI_DATA_RECORD_HEADER.DataRecordClass is also set in \r
FilterClass. If FilterClass is zero, no class-based \r
filtering will be performed.\r
- FilterDataRecordGuid - FilterEvent will be signaled whenever FilterDataRecordGuid \r
+ @param FilterDataRecordGuid - FilterEvent will be signaled whenever FilterDataRecordGuid \r
matches EFI_DATA_RECORD_HEADER.DataRecordGuid. If \r
FilterDataRecordGuid is NULL, then no GUID-based filtering \r
will be performed. \r
-Returns: \r
\r
- EFI_SUCCESS - The filter driver event was registered.\r
- EFI_ALREADY_STARTED - FilterEvent was previously registered and cannot be \r
+ @retval EFI_SUCCESS - The filter driver event was registered.\r
+ @retval EFI_ALREADY_STARTED - FilterEvent was previously registered and cannot be \r
registered again.\r
- EFI_OUT_OF_RESOURCES - The filter driver event was not registered due to lack of \r
+ @retval EFI_OUT_OF_RESOURCES - The filter driver event was not registered due to lack of \r
system resources.\r
\r
---*/\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+DataHubRegisterFilterDriver (\r
+ IN EFI_DATA_HUB_PROTOCOL * This,\r
+ IN EFI_EVENT FilterEvent,\r
+ IN EFI_TPL FilterTpl,\r
+ IN UINT64 FilterClass,\r
+ IN EFI_GUID * FilterDataRecordGuid OPTIONAL\r
+ )\r
+\r
{\r
DATA_HUB_INSTANCE *Private;\r
DATA_HUB_FILTER_DRIVER *FilterDriver;\r
return EFI_SUCCESS;\r
}\r
\r
-STATIC\r
-EFI_STATUS\r
-EFIAPI\r
-DataHubUnregisterFilterDriver (\r
- IN EFI_DATA_HUB_PROTOCOL *This,\r
- IN EFI_EVENT FilterEvent\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Remove a Filter Driver, so it no longer gets called when data \r
information is logged.\r
\r
-Arguments:\r
-\r
- This - Protocol instance structure\r
+ @param This - Protocol instance structure\r
\r
- FilterEvent - Event that represents a filter driver that is to be \r
+ @param FilterEvent - Event that represents a filter driver that is to be \r
Unregistered.\r
\r
-Returns: \r
+ @retval EFI_SUCCESS - If FilterEvent was unregistered\r
\r
- EFI_SUCCESS - If FilterEvent was unregistered\r
+ @retval EFI_NOT_FOUND - If FilterEvent does not exist\r
\r
- EFI_NOT_FOUND - If FilterEvent does not exist\r
-\r
---*/\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+DataHubUnregisterFilterDriver (\r
+ IN EFI_DATA_HUB_PROTOCOL *This,\r
+ IN EFI_EVENT FilterEvent\r
+ )\r
{\r
DATA_HUB_INSTANCE *Private;\r
DATA_HUB_FILTER_DRIVER *FilterDriver;\r
\r
return EFI_SUCCESS;\r
}\r
-//\r
-// STATIC Worker fucntions follow\r
-//\r
-STATIC\r
-DATA_HUB_FILTER_DRIVER *\r
-FindFilterDriverByEvent (\r
- IN LIST_ENTRY *Head,\r
- IN EFI_EVENT Event\r
- )\r
-/*++\r
\r
-Routine Description:\r
+/**\r
Search the Head list for a EFI_DATA_HUB_FILTER_DRIVER member that\r
represents Event and return it.\r
\r
-Arguments:\r
-\r
- Head - Head of dual linked list of EFI_DATA_HUB_FILTER_DRIVER\r
+ @param Head - Head of dual linked list of EFI_DATA_HUB_FILTER_DRIVER\r
structures.\r
\r
- Event - Event to be search for in the Head list.\r
+ @param Event - Event to be search for in the Head list.\r
\r
-Returns: \r
-\r
- EFI_DATA_HUB_FILTER_DRIVER - Returned if Event stored in the\r
+ @retval EFI_DATA_HUB_FILTER_DRIVER - Returned if Event stored in the\r
Head doubly linked list.\r
\r
- NULL - If Event is not in the list\r
+ @retval NULL - If Event is not in the list\r
+\r
+**/\r
+STATIC\r
+DATA_HUB_FILTER_DRIVER *\r
+FindFilterDriverByEvent (\r
+ IN LIST_ENTRY *Head,\r
+ IN EFI_EVENT Event\r
+ )\r
\r
---*/\r
{\r
DATA_HUB_FILTER_DRIVER *FilterEntry;\r
LIST_ENTRY *Link;\r
return NULL;\r
}\r
\r
-STATIC\r
-EFI_DATA_RECORD_HEADER *\r
-GetNextDataRecord (\r
- IN LIST_ENTRY *Head,\r
- IN UINT64 ClassFilter,\r
- IN OUT UINT64 *PtrCurrentMTC\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
Search the Head doubly linked list for the passed in MTC. Return the \r
matching element in Head and the MTC on the next entry.\r
\r
-Arguments:\r
-\r
- Head - Head of Data Log linked list.\r
+ @param Head - Head of Data Log linked list.\r
\r
- ClassFilter - Only match the MTC if it is in the same Class as the\r
+ @param ClassFilter - Only match the MTC if it is in the same Class as the\r
ClassFilter.\r
\r
- PtrCurrentMTC - On IN contians MTC to search for. On OUT contians next\r
+ @param PtrCurrentMTC - On IN contians MTC to search for. On OUT contians next\r
MTC in the data log list or zero if at end of the list.\r
\r
-Returns:\r
+ @retval EFI_DATA_LOG_ENTRY - Return pointer to data log data from Head list.\r
\r
- EFI_DATA_LOG_ENTRY - Return pointer to data log data from Head list.\r
+ @retval NULL - If no data record exists.\r
\r
- NULL - If no data record exists.\r
+**/\r
+STATIC\r
+EFI_DATA_RECORD_HEADER *\r
+GetNextDataRecord (\r
+ IN LIST_ENTRY *Head,\r
+ IN UINT64 ClassFilter,\r
+ IN OUT UINT64 *PtrCurrentMTC\r
+ )\r
\r
---*/\r
{\r
EFI_DATA_ENTRY *LogEntry;\r
LIST_ENTRY *Link;\r
//\r
DATA_HUB_INSTANCE mPrivateData;\r
\r
-EFI_STATUS\r
-EFIAPI\r
-DataHubInstall (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
- )\r
-/*++\r
+/**\r
\r
-Routine Description:\r
Install Driver to produce Data Hub protocol. \r
\r
-Arguments:\r
- (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
+ @param ImageHandle Module's image handle\r
+ @param SystemTable Pointer of EFI_SYSTEM_TABLE\r
\r
-Returns: \r
\r
- EFI_SUCCESS - Logging Hub protocol installed\r
+ @retval EFI_SUCCESS - Logging Hub protocol installed\r
\r
- Other - No protocol installed, unload driver.\r
+ @retval Other - No protocol installed, unload driver.\r
\r
---*/\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+DataHubInstall (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
{\r
EFI_STATUS Status;\r
UINT32 HighMontonicCount;\r
);\r
return Status;\r
}\r
+\r
\r
EFI_EVENT mDataHubStdErrEvent;\r
\r
+/**\r
+ Event handler registered with the Data Hub to parse EFI_DEBUG_CODE. This\r
+ handler reads the Data Hub and sends any DEBUG info to StdErr.\r
+\r
+ @param Event - The event that occured, not used\r
+ @param Context - DataHub Protocol Pointer\r
+**/\r
STATIC\r
VOID\r
EFIAPI\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Event handler registered with the Data Hub to parse EFI_DEBUG_CODE. This\r
- handler reads the Data Hub and sends any DEBUG info to StdErr.\r
-\r
-Arguments:\r
- Event - The event that occured, not used\r
- Context - DataHub Protocol Pointer\r
-\r
-Returns:\r
- None.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_DATA_HUB_PROTOCOL *DataHub;\r
} while ((Mtc != 0) && !EFI_ERROR (Status));\r
}\r
\r
+/**\r
+ Register an event handler with the Data Hub to parse EFI_DEBUG_CODE. This\r
+ handler reads the Data Hub and sends any DEBUG info to StdErr.\r
+\r
+ @param ImageHandle - Image handle of this driver.\r
+ @param SystemTable - Pointer to EFI system table.\r
+\r
+ @retval EFI_SUCCESS - The event handler was registered.\r
+ @retval EFI_OUT_OF_RESOURCES - The event hadler was not registered due to lack of\r
+ system resources.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
DataHubStdErrInitialize (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Register an event handler with the Data Hub to parse EFI_DEBUG_CODE. This\r
- handler reads the Data Hub and sends any DEBUG info to StdErr.\r
-\r
-Arguments:\r
-\r
- ImageHandle - Image handle of this driver.\r
- SystemTable - Pointer to EFI system table.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The event handler was registered.\r
- EFI_OUT_OF_RESOURCES - The event hadler was not registered due to lack of\r
- system resources.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
UINT64 DataClass;\r
\r
return Status;\r
}\r
+\r
projects / mirror_edk2.git / commitdiff