IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_SUCCESS - The device is supported by this driver.\r
EFI_UNSUPPORTED - The device is not supported by this driver.\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of \r
resources.\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE * ChildHandleBuffer OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of \r
resources.\r
\r
---*/\r
+**/\r
;\r
\r
//\r
IN EFI_ISA_ACPI_RESOURCE_LIST *IsaDeviceResourceList,\r
OUT EFI_DEVICE_PATH_PROTOCOL **ChildDevicePath\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
resources.\r
EFI_DEVICE_ERROR - Can not create child device.\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN ISA_IO_DEVICE *IsaIoDevice,\r
IN EFI_ISA_ACPI_RESOURCE_LIST *IsaDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
EFI_SUCCESS - Initial success.\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_SUCCESS - The device is supported by this driver.\r
EFI_UNSUPPORTED - The device is not supported by this driver.\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
EFI_ISA_ACPI_PROTOCOL *IsaAcpi;\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of \r
resources.\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
EFI_PCI_IO_PROTOCOL *PciIo;\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE * ChildHandleBuffer OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of \r
resources.\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
UINTN Index;\r
IN EFI_ISA_ACPI_RESOURCE_LIST *IsaDeviceResourceList,\r
OUT EFI_DEVICE_PATH_PROTOCOL **ChildDevicePath\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
resources.\r
EFI_DEVICE_ERROR - Can not create child device.\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
ISA_IO_DEVICE *IsaIoDevice;\r
},\r
};\r
\r
+/**\r
+ report a error Status code of PCI bus driver controller\r
+\r
+ @param Code - The error status code.\r
+ \r
+ @Return EFI_SUCCESS - Success to report status code.\r
+**/\r
EFI_STATUS\r
ReportErrorStatusCode (\r
EFI_STATUS_CODE_VALUE Code\r
)\r
-/*++\r
-\r
-Routine Description:\r
\r
- report a error Status code of PCI bus driver controller\r
-\r
-Arguments:\r
-\r
- Code - The error status code.\r
- \r
-Returns:\r
-\r
- EFI_SUCCESS - Success to report status code.\r
- \r
-\r
---*/\r
{\r
return REPORT_STATUS_CODE (\r
EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
//\r
// Driver Support Functions\r
//\r
+/**\r
+\r
+ Initializes an ISA I/O Instance\r
\r
+ @param IsaIoDevice - The iso device to be initialized.\r
+ @param IsaDeviceResourceList - The resource list.\r
+ \r
+ @retval EFI_SUCCESS - Initial success.\r
+ \r
+**/\r
EFI_STATUS\r
InitializeIsaIoInstance (\r
IN ISA_IO_DEVICE *IsaIoDevice,\r
IN EFI_ISA_ACPI_RESOURCE_LIST *IsaDeviceResourceList\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Initializes an ISA I/O Instance\r
-\r
-Arguments:\r
-\r
- IsaIoDevice - The iso device to be initialized.\r
- IsaDeviceResourceList - The resource list.\r
- \r
-Returns:\r
-\r
- EFI_SUCCESS - Initial success.\r
- \r
---*/\r
{\r
//\r
// Initializes an ISA I/O Instance\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Performs an ISA I/O Read Cycle\r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+ @param Width - Signifies the width of the I/O operation.\r
+ @param Offset - The offset in ISA I/O space to start the I/O operation. \r
+ @param Count - The number of I/O operations to perform. \r
+ @param Buffer - The destination buffer to store the results\r
+\r
+ @retval EFI_SUCCESS - The data was read from the device sucessfully.\r
+ @retval EFI_UNSUPPORTED - The Offset is not valid for this device.\r
+ @retval EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.\r
+ @retval EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaIoIoRead (\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Performs an ISA I/O Read Cycle\r
\r
-Arguments:\r
-\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- Width - Signifies the width of the I/O operation.\r
- Offset - The offset in ISA I/O space to start the I/O operation. \r
- Count - The number of I/O operations to perform. \r
- Buffer - The destination buffer to store the results\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The data was read from the device sucessfully.\r
- EFI_UNSUPPORTED - The Offset is not valid for this device.\r
- EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.\r
- EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
ISA_IO_DEVICE *IsaIoDevice;\r
return Status;\r
}\r
\r
+/**\r
+ Performs an ISA I/O Write Cycle\r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+ @param Width - Signifies the width of the I/O operation.\r
+ @param Offset - The offset in ISA I/O space to start the I/O operation. \r
+ @param Count - The number of I/O operations to perform. \r
+ @param Buffer - The source buffer to write data from\r
+\r
+ @Retval EFI_SUCCESS - The data was writen to the device sucessfully.\r
+ @Retval EFI_UNSUPPORTED - The Offset is not valid for this device.\r
+ @Retval EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.\r
+ @Retval EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaIoIoWrite (\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Performs an ISA I/O Write Cycle\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- Width - Signifies the width of the I/O operation.\r
- Offset - The offset in ISA I/O space to start the I/O operation. \r
- Count - The number of I/O operations to perform. \r
- Buffer - The source buffer to write data from\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The data was writen to the device sucessfully.\r
- EFI_UNSUPPORTED - The Offset is not valid for this device.\r
- EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.\r
- EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
ISA_IO_DEVICE *IsaIoDevice;\r
return Status;\r
}\r
\r
+/**\r
+ Writes an 8 bit I/O Port\r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+ @param Offset - The offset in ISA IO space to start the IO operation. \r
+ @param Value - The data to write port.\r
+\r
+ @retval EFI_SUCCESS - Success.\r
+ @retval EFI_INVALID_PARAMETER - Parameter is invalid.\r
+ @retval EFI_UNSUPPORTED - The address range specified by Offset is not valid.\r
+ @retval EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
+ \r
+**/\r
EFI_STATUS\r
WritePort (\r
IN EFI_ISA_IO_PROTOCOL *This,\r
IN UINT32 Offset,\r
IN UINT8 Value\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Writes an 8 bit I/O Port\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- Offset - The offset in ISA IO space to start the IO operation. \r
- Value - The data to write port.\r
- \r
-Returns:\r
\r
- EFI_SUCCESS - Success.\r
- EFI_INVALID_PARAMETER - Parameter is invalid.\r
- EFI_UNSUPPORTED - The address range specified by Offset is not valid.\r
- EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
- \r
---*/\r
{\r
EFI_STATUS Status;\r
ISA_IO_DEVICE *IsaIoDevice;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Writes I/O operation base address and count number to a 8 bit I/O Port.\r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+ @param AddrOffset - The address' offset.\r
+ @param PageOffset - The page's offest.\r
+ @param CountOffset - The count's offset.\r
+ @param BaseAddress - The base address.\r
+ @param Count - The number of I/O operations to perform. \r
+ \r
+ @retval EFI_SUCCESS - Success.\r
+ @retval EFI_INVALID_PARAMETER - Parameter is invalid.\r
+ @retval EFI_UNSUPPORTED - The address range specified by these Offsets and Count is not valid.\r
+ @retval EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
+\r
+**/\r
EFI_STATUS\r
WriteDmaPort (\r
IN EFI_ISA_IO_PROTOCOL *This,\r
IN UINT32 BaseAddress,\r
IN UINT16 Count\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Writes I/O operation base address and count number to a 8 bit I/O Port.\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- AddrOffset - The address' offset.\r
- PageOffset - The page's offest.\r
- CountOffset - The count's offset.\r
- BaseAddress - The base address.\r
- Count - The number of I/O operations to perform. \r
- \r
-Returns:\r
\r
- EFI_SUCCESS - Success.\r
- EFI_INVALID_PARAMETER - Parameter is invalid.\r
- EFI_UNSUPPORTED - The address range specified by these Offsets and Count is not valid.\r
- EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Unmaps a memory region for DMA\r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+ @param Mapping - The mapping value returned from EFI_ISA_IO.Map().\r
+\r
+ @retval EFI_SUCCESS - The range was unmapped.\r
+ @retval EFI_DEVICE_ERROR - The data was not committed to the target system memory.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaIoUnmap (\r
IN EFI_ISA_IO_PROTOCOL *This,\r
IN VOID *Mapping\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Unmaps a memory region for DMA\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- Mapping - The mapping value returned from EFI_ISA_IO.Map().\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The range was unmapped.\r
- EFI_DEVICE_ERROR - The data was not committed to the target system memory.\r
-\r
---*/\r
{\r
ISA_MAP_INFO *IsaMapInfo;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Flushes a DMA buffer\r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+\r
+ @retval EFI_SUCCESS - The buffers were flushed.\r
+ @retval EFI_DEVICE_ERROR - The buffers were not flushed due to a hardware error.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaIoFlush (\r
IN EFI_ISA_IO_PROTOCOL *This\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Flushes a DMA buffer\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
\r
-Returns:\r
-\r
- EFI_SUCCESS - The buffers were flushed.\r
- EFI_DEVICE_ERROR - The buffers were not flushed due to a hardware error.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
ISA_IO_DEVICE *IsaIoDevice;\r
return Status;\r
}\r
\r
+/**\r
+ Verifies access to an ISA device\r
+\r
+ @param IsaIoDevice - The ISA device to be verified.\r
+ @param Type - The Access type. The input must be either IsaAccessTypeMem or IsaAccessTypeIo.\r
+ @param Width - Signifies the width of the memory operation.\r
+ @param Count - The number of memory operations to perform. \r
+ @param Offset - The offset in ISA memory space to start the memory operation. \r
+ \r
+ @retval EFI_SUCCESS - Verify success.\r
+ @retval EFI_INVALID_PARAMETER - One of the parameters has an invalid value.\r
+ @retval EFI_UNSUPPORTED - The device ont support the access type.\r
+\r
+**/\r
EFI_STATUS\r
IsaIoVerifyAccess (\r
IN ISA_IO_DEVICE *IsaIoDevice,\r
IN UINTN Count,\r
IN OUT UINT32 *Offset\r
)\r
-/*++\r
-\r
-Routine Description:\r
\r
- Verifies access to an ISA device\r
-\r
-Arguments:\r
-\r
- IsaIoDevice - The ISA device to be verified.\r
- Type - The Access type. The input must be either IsaAccessTypeMem or IsaAccessTypeIo.\r
- Width - Signifies the width of the memory operation.\r
- Count - The number of memory operations to perform. \r
- Offset - The offset in ISA memory space to start the memory operation. \r
- \r
-Returns:\r
-\r
- EFI_SUCCESS - Verify success.\r
- EFI_INVALID_PARAMETER - One of the parameters has an invalid value.\r
- EFI_UNSUPPORTED - The device ont support the access type.\r
-\r
---*/\r
{\r
EFI_ISA_ACPI_RESOURCE *Item;\r
EFI_STATUS Status;\r
return Status;\r
}\r
\r
+/**\r
+\r
+ Performs an ISA Memory Read Cycle\r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+ @param Width - Signifies the width of the memory operation.\r
+ @param Offset - The offset in ISA memory space to start the memory operation. \r
+ @param Count - The number of memory operations to perform. \r
+ @param Buffer - The destination buffer to store the results\r
+ \r
+ @retval EFI_SUCCESS - The data was read from the device successfully.\r
+ @retval EFI_UNSUPPORTED - The Offset is not valid for this device.\r
+ @retval EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.\r
+ @retval EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaIoMemRead (\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Performs an ISA Memory Read Cycle\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- Width - Signifies the width of the memory operation.\r
- Offset - The offset in ISA memory space to start the memory operation. \r
- Count - The number of memory operations to perform. \r
- Buffer - The destination buffer to store the results\r
- \r
-Returns:\r
-\r
- EFI_SUCCESS - The data was read from the device successfully.\r
- EFI_UNSUPPORTED - The Offset is not valid for this device.\r
- EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.\r
- EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
\r
---*/\r
{\r
EFI_STATUS Status;\r
ISA_IO_DEVICE *IsaIoDevice;\r
return Status;\r
}\r
\r
+/**\r
+ Performs an ISA Memory Write Cycle\r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance. \r
+ @param Width - Signifies the width of the memory operation.\r
+ @param Offset - The offset in ISA memory space to start the memory operation. \r
+ @param Count - The number of memory operations to perform. \r
+ @param Buffer - The source buffer to write data from\r
+\r
+ @retval EFI_SUCCESS - The data was written to the device sucessfully.\r
+ @retval EFI_UNSUPPORTED - The Offset is not valid for this device.\r
+ @retval EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.\r
+ @retval EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaIoMemWrite (\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Performs an ISA Memory Write Cycle\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance. \r
- Width - Signifies the width of the memory operation.\r
- Offset - The offset in ISA memory space to start the memory operation. \r
- Count - The number of memory operations to perform. \r
- Buffer - The source buffer to write data from\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The data was written to the device sucessfully.\r
- EFI_UNSUPPORTED - The Offset is not valid for this device.\r
- EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.\r
- EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
ISA_IO_DEVICE *IsaIoDevice;\r
return Status;\r
}\r
\r
+/**\r
+ Performs an ISA I/O Copy Memory \r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+ @param Width - Signifies the width of the memory copy operation.\r
+ @param DestOffset - The offset of the destination \r
+ @param SrcOffset - The offset of the source\r
+ @param Count - The number of memory copy operations to perform\r
+\r
+ @retval EFI_SUCCESS - The data was copied sucessfully.\r
+ @retval EFI_UNSUPPORTED - The DestOffset or SrcOffset is not valid for this device.\r
+ @retval EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.\r
+ @retval EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaIoCopyMem (\r
IN UINT32 SrcOffset,\r
IN UINTN Count\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Performs an ISA I/O Copy Memory \r
-\r
-Arguments:\r
\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- Width - Signifies the width of the memory copy operation.\r
- DestOffset - The offset of the destination \r
- SrcOffset - The offset of the source\r
- Count - The number of memory copy operations to perform\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The data was copied sucessfully.\r
- EFI_UNSUPPORTED - The DestOffset or SrcOffset is not valid for this device.\r
- EFI_INVALID_PARAMETER - Width or Count, or both, were invalid.\r
- EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of resources.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
ISA_IO_DEVICE *IsaIoDevice;\r
return Status;\r
}\r
\r
+/**\r
+ Maps a memory region for DMA, note this implementation\r
+ only supports slave read/write operation to save code size.\r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+ @param Operation - Indicates the type of DMA (slave or bus master), and if \r
+ the DMA operation is going to read or write to system memory. \r
+ @param ChannelNumber - The slave channel number to use for this DMA operation. \r
+ If Operation and ChannelAttributes shows that this device \r
+ performs bus mastering DMA, then this field is ignored. \r
+ The legal range for this field is 0..7. \r
+ @param ChannelAttributes - The attributes of the DMA channel to use for this DMA operation\r
+ @param HostAddress - The system memory address to map to the device. \r
+ @param NumberOfBytes - On input the number of bytes to map. On output the number \r
+ of bytes that were mapped.\r
+ @param DeviceAddress - The resulting map address for the bus master device to use \r
+ to access the hosts HostAddress. \r
+ @param Mapping - A resulting value to pass to EFI_ISA_IO.Unmap().\r
+\r
+ @retval EFI_SUCCESS - The range was mapped for the returned NumberOfBytes.\r
+ @retval EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.\r
+ @retval EFI_UNSUPPORTED - The HostAddress can not be mapped as a common buffer.\r
+ @retval EFI_DEVICE_ERROR - The system hardware could not map the requested address.\r
+ @retval EFI_OUT_OF_RESOURCES - The memory pages could not be allocated.\r
+\r
+**/\r
STATIC\r
EFI_STATUS\r
IsaIoMap_OnlySupportSlaveReadWrite (\r
OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,\r
OUT VOID **Mapping\r
)\r
-/*++\r
-\r
-Routine Description:\r
\r
- Maps a memory region for DMA, note this implementation\r
- only supports slave read/write operation to save code size.\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- Operation - Indicates the type of DMA (slave or bus master), and if \r
- the DMA operation is going to read or write to system memory. \r
- ChannelNumber - The slave channel number to use for this DMA operation. \r
- If Operation and ChannelAttributes shows that this device \r
- performs bus mastering DMA, then this field is ignored. \r
- The legal range for this field is 0..7. \r
- ChannelAttributes - The attributes of the DMA channel to use for this DMA operation\r
- HostAddress - The system memory address to map to the device. \r
- NumberOfBytes - On input the number of bytes to map. On output the number \r
- of bytes that were mapped.\r
- DeviceAddress - The resulting map address for the bus master device to use \r
- to access the hosts HostAddress. \r
- Mapping - A resulting value to pass to EFI_ISA_IO.Unmap().\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The range was mapped for the returned NumberOfBytes.\r
- EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.\r
- EFI_UNSUPPORTED - The HostAddress can not be mapped as a common buffer.\r
- EFI_DEVICE_ERROR - The system hardware could not map the requested address.\r
- EFI_OUT_OF_RESOURCES - The memory pages could not be allocated.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_PHYSICAL_ADDRESS PhysicalAddress;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Maps a memory region for DMA. This implementation implement the \r
+ the full mapping support.\r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+ @param Operation - Indicates the type of DMA (slave or bus master), and if \r
+ the DMA operation is going to read or write to system memory. \r
+ @param ChannelNumber - The slave channel number to use for this DMA operation. \r
+ If Operation and ChannelAttributes shows that this device \r
+ performs bus mastering DMA, then this field is ignored. \r
+ The legal range for this field is 0..7. \r
+ @param ChannelAttributes - The attributes of the DMA channel to use for this DMA operation\r
+ @param HostAddress - The system memory address to map to the device. \r
+ @param NumberOfBytes - On input the number of bytes to map. On output the number \r
+ of bytes that were mapped.\r
+ @param DeviceAddress - The resulting map address for the bus master device to use \r
+ - to access the hosts HostAddress. \r
+ @param Mapping - A resulting value to pass to EFI_ISA_IO.Unmap().\r
+\r
+ @retval EFI_SUCCESS - The range was mapped for the returned NumberOfBytes.\r
+ @retval EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.\r
+ @retval EFI_UNSUPPORTED - The HostAddress can not be mapped as a common buffer.\r
+ @retval EFI_DEVICE_ERROR - The system hardware could not map the requested address.\r
+ @retval EFI_OUT_OF_RESOURCES - The memory pages could not be allocated.\r
+\r
+**/\r
STATIC\r
EFI_STATUS\r
IsaIoMap_FullSupport (\r
OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,\r
OUT VOID **Mapping\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Maps a memory region for DMA. This implementation implement the \r
- the full mapping support.\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- Operation - Indicates the type of DMA (slave or bus master), and if \r
- the DMA operation is going to read or write to system memory. \r
- ChannelNumber - The slave channel number to use for this DMA operation. \r
- If Operation and ChannelAttributes shows that this device \r
- performs bus mastering DMA, then this field is ignored. \r
- The legal range for this field is 0..7. \r
- ChannelAttributes - The attributes of the DMA channel to use for this DMA operation\r
- HostAddress - The system memory address to map to the device. \r
- NumberOfBytes - On input the number of bytes to map. On output the number \r
- of bytes that were mapped.\r
- DeviceAddress - The resulting map address for the bus master device to use \r
- - to access the hosts HostAddress. \r
- Mapping - A resulting value to pass to EFI_ISA_IO.Unmap().\r
-\r
-Returns:\r
\r
- EFI_SUCCESS - The range was mapped for the returned NumberOfBytes.\r
- EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.\r
- EFI_UNSUPPORTED - The HostAddress can not be mapped as a common buffer.\r
- EFI_DEVICE_ERROR - The system hardware could not map the requested address.\r
- EFI_OUT_OF_RESOURCES - The memory pages could not be allocated.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
BOOLEAN Master;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Maps a memory region for DMA\r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+ @param Operation - Indicates the type of DMA (slave or bus master), and if \r
+ the DMA operation is going to read or write to system memory. \r
+ @param ChannelNumber - The slave channel number to use for this DMA operation. \r
+ If Operation and ChannelAttributes shows that this device \r
+ performs bus mastering DMA, then this field is ignored. \r
+ The legal range for this field is 0..7. \r
+ @param ChannelAttributes - The attributes of the DMA channel to use for this DMA operation\r
+ @param HostAddress - The system memory address to map to the device. \r
+ @param NumberOfBytes - On input the number of bytes to map. On output the number \r
+ of bytes that were mapped.\r
+ @param DeviceAddress - The resulting map address for the bus master device to use \r
+ - to access the hosts HostAddress. \r
+ @param Mapping - A resulting value to pass to EFI_ISA_IO.Unmap().\r
+\r
+\r
+ @retval EFI_SUCCESS - The range was mapped for the returned NumberOfBytes.\r
+ @retval EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.\r
+ @retval EFI_UNSUPPORTED - The HostAddress can not be mapped as a common buffer.\r
+ @retval EFI_DEVICE_ERROR - The system hardware could not map the requested address.\r
+ @retval EFI_OUT_OF_RESOURCES - The memory pages could not be allocated.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaIoMap (\r
OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,\r
OUT VOID **Mapping\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Maps a memory region for DMA\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- Operation - Indicates the type of DMA (slave or bus master), and if \r
- the DMA operation is going to read or write to system memory. \r
- ChannelNumber - The slave channel number to use for this DMA operation. \r
- If Operation and ChannelAttributes shows that this device \r
- performs bus mastering DMA, then this field is ignored. \r
- The legal range for this field is 0..7. \r
- ChannelAttributes - The attributes of the DMA channel to use for this DMA operation\r
- HostAddress - The system memory address to map to the device. \r
- NumberOfBytes - On input the number of bytes to map. On output the number \r
- of bytes that were mapped.\r
- DeviceAddress - The resulting map address for the bus master device to use \r
- - to access the hosts HostAddress. \r
- Mapping - A resulting value to pass to EFI_ISA_IO.Unmap().\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The range was mapped for the returned NumberOfBytes.\r
- EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.\r
- EFI_UNSUPPORTED - The HostAddress can not be mapped as a common buffer.\r
- EFI_DEVICE_ERROR - The system hardware could not map the requested address.\r
- EFI_OUT_OF_RESOURCES - The memory pages could not be allocated.\r
\r
---*/\r
{\r
//\r
// Or unset Feature Flag PcdIsaBusSupportDma to disable support for ISA DMA.\r
);\r
}\r
}\r
+\r
+/**\r
+ Allocates a common buffer for DMA\r
+\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+ @param Type - The type allocation to perform.\r
+ @param MemoryType - The type of memory to allocate.\r
+ @param Pages - The number of pages to allocate.\r
+ @param HostAddress - A pointer to store the base address of the allocated range.\r
+ @param Attributes - The requested bit mask of attributes for the allocated range.\r
+\r
+ @retval EFI_SUCCESS - The requested memory pages were allocated.\r
+ @retval EFI_INVALID_PARAMETER - Type is invalid or MemoryType is invalid or HostAddress is NULL\r
+ @retval EFI_UNSUPPORTED - Attributes is unsupported or the memory range specified \r
+ by HostAddress, Pages, and Type is not available for common buffer use.\r
+ @retval EFI_OUT_OF_RESOURCES - The memory pages could not be allocated.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaIoAllocateBuffer (\r
OUT VOID **HostAddress,\r
IN UINT64 Attributes\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Allocates a common buffer for DMA\r
-\r
-Arguments:\r
-\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- Type - The type allocation to perform.\r
- MemoryType - The type of memory to allocate.\r
- Pages - The number of pages to allocate.\r
- HostAddress - A pointer to store the base address of the allocated range.\r
- Attributes - The requested bit mask of attributes for the allocated range.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The requested memory pages were allocated.\r
- EFI_INVALID_PARAMETER - Type is invalid or MemoryType is invalid or HostAddress is NULL\r
- EFI_UNSUPPORTED - Attributes is unsupported or the memory range specified \r
- by HostAddress, Pages, and Type is not available for common buffer use.\r
- EFI_OUT_OF_RESOURCES - The memory pages could not be allocated.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_PHYSICAL_ADDRESS PhysicalAddress;\r
return Status;\r
}\r
\r
-EFI_STATUS\r
-EFIAPI\r
-IsaIoFreeBuffer (\r
- IN EFI_ISA_IO_PROTOCOL *This,\r
- IN UINTN Pages,\r
- IN VOID *HostAddress\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
Frees a common buffer \r
\r
-Arguments:\r
+ @param This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
+ @param Pages - The number of pages to free.\r
+ @param HostAddress - The base address of the allocated range.\r
\r
- This - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- Pages - The number of pages to free.\r
- HostAddress - The base address of the allocated range.\r
\r
-Returns:\r
+ @retval EFI_SUCCESS - The requested memory pages were freed.\r
+ @retval EFI_INVALID_PARAMETER - The memory was not allocated with EFI_ISA_IO.AllocateBufer().\r
\r
- EFI_SUCCESS - The requested memory pages were freed.\r
- EFI_INVALID_PARAMETER - The memory was not allocated with EFI_ISA_IO.AllocateBufer().\r
+**/\r
\r
---*/\r
+EFI_STATUS\r
+EFIAPI\r
+IsaIoFreeBuffer (\r
+ IN EFI_ISA_IO_PROTOCOL *This,\r
+ IN UINTN Pages,\r
+ IN VOID *HostAddress\r
+ )\r
{\r
EFI_STATUS Status;\r
EFI_PHYSICAL_ADDRESS PhysicalAddress;\r
/**@file\r
\r
- \r
Copyright (c) 2006 - 2007, Intel Corporation.<BR>\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
);\r
}\r
\r
+/**\r
+ Add the component name for the floppy device\r
+\r
+ @param FdcDev - A pointer to the FDC_BLK_IO_DEV instance.\r
+\r
+**/\r
VOID\r
AddName (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
\r
- Routine Description:\r
- \r
- Add the component name for the floppy device\r
-\r
- Arguments:\r
- \r
- FdcDev - A pointer to the FDC_BLK_IO_DEV instance.\r
-\r
- Returns:\r
-\r
- None\r
- \r
---*/\r
{\r
CHAR16 FloppyDriveName[FLOPPY_DRIVE_NAME_ASCII_LEN + 1];\r
\r
);\r
\r
}\r
+\r
/**@file\r
\r
- \r
Copyright (c) 2006 - 2007, Intel Corporation.<BR>\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
AddName (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
return Status;\r
}\r
\r
-\r
+/**\r
+ Test controller is a Floppy Disk Controller\r
+ \r
+ @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
+ @param Controller driver's controller\r
+ @param RemainingDevicePath children device path\r
+ \r
+ @retval EFI_UNSUPPORTED controller is not floppy disk\r
+ @retval EFI_SUCCESS controller is floppy disk\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FdcControllerDriverSupported (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- ControllerDriver Protocol Method\r
-\r
-Arguments:\r
-\r
-Returns:\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_ISA_IO_PROTOCOL *IsaIo;\r
return Status;\r
}\r
\r
+/**\r
+ Create floppy control instance on controller.\r
+ \r
+ @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
+ @param Controller driver controller handle\r
+ @param RemainingDevicePath Children's device path\r
+ \r
+ @retval whether success to create floppy control instance.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FdcControllerDriverStart (\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
---*/\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
FDC_BLK_IO_DEV *FdcDev;\r
return Status;\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
FdcControllerDriverStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Arguments:\r
-\r
- Returns:\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_BLOCK_IO_PROTOCOL *BlkIo;\r
\r
return EFI_SUCCESS;\r
}\r
+\r
//\r
// EFI Driver Binding Protocol Functions\r
//\r
+/**\r
+ Test controller is a Floppy Disk Controller\r
+ \r
+ @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
+ @param Controller driver's controller\r
+ @param RemainingDevicePath children device path\r
+ \r
+ @retval EFI_UNSUPPORTED controller is not floppy disk\r
+ @retval EFI_SUCCESS controller is floppy disk\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FdcControllerDriverSupported (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\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
- Controller - GC_TODO: add argument description\r
- RemainingDevicePath - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Create floppy control instance on controller.\r
+ \r
+ @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
+ @param Controller driver controller handle\r
+ @param RemainingDevicePath Children's device path\r
+ \r
+ @retval whether success to create floppy control instance.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FdcControllerDriverStart (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\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
- Controller - GC_TODO: add argument description\r
- RemainingDevicePath - GC_TODO: add argument description\r
+;\r
\r
-Returns:\r
+/**\r
+ Stop this driver on ControllerHandle. Support stoping any child handles\r
+ created by this driver.\r
\r
- GC_TODO: add return values\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
---*/\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
FdcControllerDriverStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\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
- Controller - GC_TODO: add argument description\r
- NumberOfChildren - GC_TODO: add argument description\r
- ChildHandleBuffer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
//\r
// EFI Block I/O Protocol Functions\r
//\r
+/**\r
+ Reset the Floppy Logic Drive, call the FddReset function \r
+ \r
+ @param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
+ @param ExtendedVerification BOOLEAN: Indicate that the driver may perform a more \r
+ exhaustive verification operation of the device during \r
+ reset, now this par is ignored in this driver \r
+ @retval EFI_SUCCESS: The Floppy Logic Drive is reset\r
+ @retval EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly \r
+ and can not be reset\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FdcReset (\r
IN EFI_BLOCK_IO_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
\r
+/**\r
+ Flush block via fdd controller\r
+ \r
+ @param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
+ @return EFI_SUCCESS\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FddFlushBlocks (\r
IN EFI_BLOCK_IO_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
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Read the requested number of blocks from the device \r
+ \r
+ @param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
+ @param MediaId UINT32: The media id that the read request is for \r
+ @param LBA EFI_LBA: The starting logic block address to read from on the device\r
+ @param BufferSize UINTN: The size of the Buffer in bytes\r
+ @param Buffer VOID *: A pointer to the destination buffer for the data\r
+ \r
+ @retval EFI_SUCCESS: The data was read correctly from the device\r
+ @retval EFI_DEVICE_ERROR:The device reported an error while attempting to perform\r
+ the read operation\r
+ @retval EFI_NO_MEDIA: There is no media in the device\r
+ @retval EFI_MEDIA_CHANGED: The MediaId is not for the current media\r
+ @retval EFI_BAD_BUFFER_SIZE: The BufferSize parameter is not a multiple of the \r
+ intrinsic block size of the device\r
+ @retval EFI_INVALID_PARAMETER:The read request contains LBAs that are not valid, \r
+ or the buffer is not on proper alignment \r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FddReadBlocks (\r
IN UINTN BufferSize,\r
OUT VOID *Buffer\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
- MediaId - GC_TODO: add argument description\r
- LBA - GC_TODO: add argument description\r
- BufferSize - GC_TODO: add argument description\r
- Buffer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Write a specified number of blocks to the device \r
+ \r
+ @param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
+ @param MediaId UINT32: The media id that the write request is for \r
+ @param LBA EFI_LBA: The starting logic block address to be written\r
+ @param BufferSize UINTN: The size in bytes in Buffer\r
+ @param Buffer VOID *: A pointer to the source buffer for the data\r
+ \r
+ @retval EFI_SUCCESS: The data were written correctly to the device\r
+ @retval EFI_WRITE_PROTECTED: The device can not be written to \r
+ @retval EFI_NO_MEDIA: There is no media in the device\r
+ @retval EFI_MEDIA_CHANGED: The MediaId is not for the current media\r
+ @retval EFI_DEVICE_ERROR: The device reported an error while attempting to perform \r
+ the write operation \r
+ @retval EFI_BAD_BUFFER_SIZE: The BufferSize parameter is not a multiple of the \r
+ intrinsic block size of the device\r
+ @retval EFI_INVALID_PARAMETER:The write request contains LBAs that are not valid, \r
+ or the buffer is not on proper alignment \r
+**/\r
EFI_STATUS\r
EFIAPI\r
FddWriteBlocks (\r
IN UINTN BufferSize,\r
IN VOID *Buffer\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
- MediaId - GC_TODO: add argument description\r
- LBA - GC_TODO: add argument description\r
- BufferSize - GC_TODO: add argument description\r
- Buffer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
//\r
// Prototypes of internal functions\r
//\r
+/**\r
+\r
+ Detect the floppy drive is presented or not\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
+ @retval EFI_SUCCESS Drive is presented\r
+ @retval EFI_NOT_FOUND Drive is not presented\r
+\r
+**/\r
EFI_STATUS\r
DiscoverFddDevice (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\r
+/**\r
\r
---*/\r
-;\r
+ Do recalibrate and see the drive is presented or not\r
+ Set the media parameters\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
+ @return the drive is presented or not\r
\r
+**/\r
EFI_STATUS\r
FddIdentify (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\r
+/**\r
\r
---*/\r
-;\r
+ Reset the Floppy Logic Drive\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
+ \r
+ @retval EFI_SUCCESS: The Floppy Logic Drive is reset\r
+ @retval EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly and\r
+ can not be reset\r
\r
+**/\r
EFI_STATUS\r
FddReset (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\r
+/**\r
\r
---*/\r
-;\r
+ Turn the drive's motor on\r
+ The drive's motor must be on before any command can be executed\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
+ \r
+ @retval EFI_SUCCESS: Turn the drive's motor on successfully\r
+ @retval EFI_DEVICE_ERROR: The drive is busy, so can not turn motor on\r
+ @retval EFI_INVALID_PARAMETER: Fail to Set timer(Cancel timer)\r
\r
+**/\r
EFI_STATUS\r
MotorOn (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\r
+/**\r
\r
---*/\r
-;\r
+ Set a Timer and when Timer goes off, turn the motor off\r
+ \r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
+ \r
+ @retval EFI_SUCCESS: Set the Timer successfully\r
+ @retval EFI_INVALID_PARAMETER: Fail to Set the timer\r
\r
+**/\r
EFI_STATUS\r
MotorOff (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Detect the disk in the drive is changed or not\r
+ \r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ \r
+ @retval EFI_SUCCESS: No disk media change\r
+ @retval EFI_DEVICE_ERROR: Fail to do the recalibrate or seek operation\r
+ @retval EFI_NO_MEDIA: No disk in the drive\r
+ @retval EFI_MEDIA_CHANGED: There is a new disk in the drive\r
+**/\r
EFI_STATUS\r
DisketChanged (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Do the Specify command, this command sets DMA operation\r
+ and the initial values for each of the three internal\r
+ times: HUT, SRT and HLT\r
+ \r
+ @param This Pointer to instance of FDC_BLK_IO_DEV\r
+ \r
+ @retval EFI_SUCCESS: Execute the Specify command successfully\r
+ @retval EFI_DEVICE_ERROR: Fail to execute the command\r
+\r
+**/\r
EFI_STATUS\r
Specify (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Set the head of floppy drive to track 0\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @retval EFI_SUCCESS: Execute the Recalibrate operation successfully\r
+ @retval EFI_DEVICE_ERROR: Fail to execute the Recalibrate operation\r
+\r
+**/\r
EFI_STATUS\r
Recalibrate (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Set the head of floppy drive to the new cylinder\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @param Lba EFI_LBA : The logic block address want to seek\r
+ \r
+ @retval EFI_SUCCESS: Execute the Seek operation successfully\r
+ @retval EFI_DEVICE_ERROR: Fail to execute the Seek operation\r
+\r
+**/\r
EFI_STATUS\r
Seek (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN EFI_LBA Lba\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Lba - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Do the Sense Interrupt Status command, this command\r
+ resets the interrupt signal\r
+ \r
+ \r
+ @param StatusRegister0 UINT8 *: Be used to save Status Register 0 read from FDC\r
+ @param PresentCylinderNumber UINT8 *: Be used to save present cylinder number\r
+ read from FDC\r
+ \r
+ @retval EFI_SUCCESS: Execute the Sense Interrupt Status command successfully\r
+ @retval EFI_DEVICE_ERROR: Fail to execute the command\r
+\r
+**/\r
EFI_STATUS\r
SenseIntStatus (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN OUT UINT8 *StatusRegister0,\r
IN OUT UINT8 *PresentCylinderNumber\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- StatusRegister0 - GC_TODO: add argument description\r
- PresentCylinderNumber - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Do the Sense Drive Status command\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @param Lba EFI_LBA : Logic block address\r
+ \r
+ @retval EFI_SUCCESS: Execute the Sense Drive Status command successfully\r
+ @retval EFI_DEVICE_ERROR: Fail to execute the command\r
+ @retval EFI_WRITE_PROTECTED:The disk is write protected\r
+\r
+**/\r
EFI_STATUS\r
SenseDrvStatus (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN EFI_LBA Lba\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Lba - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Update the disk media properties and if necessary\r
+ reinstall Block I/O interface\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ \r
+ @retval EFI_SUCCESS: Do the operation successfully\r
+ @retval EFI_DEVICE_ERROR: Fail to the operation\r
+\r
+**/\r
EFI_STATUS\r
DetectMedia (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Set the data rate and so on\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+\r
+ @retval EFI_SUCCESS success to set the data rate\r
+**/\r
EFI_STATUS\r
Setup (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Read or Write a number of blocks in the same cylinder\r
+ \r
+ @param FdcDev A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @param HostAddress device address \r
+ @param Lba The starting logic block address to read from on the device\r
+ @param NumberOfBlocks The number of block wanted to be read or write\r
+ @param Read Operation type: read or write\r
+ \r
+ @retval EFI_SUCCESS Success operate\r
+\r
+**/\r
EFI_STATUS\r
ReadWriteDataSector (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINTN NumberOfBlocks,\r
IN BOOLEAN Read\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- HostAddress - GC_TODO: add argument description\r
- Lba - GC_TODO: add argument description\r
- NumberOfBlocks - GC_TODO: add argument description\r
- Read - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Fill in FDD command's parameter\r
+ \r
+ @param FdcDev Pointer to instance of FDC_BLK_IO_DEV\r
+ @param Lba The starting logic block address to read from on the device\r
+ @param Command FDD command\r
+\r
+**/\r
VOID\r
FillPara (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN EFI_LBA Lba,\r
IN FDD_COMMAND_PACKET1 *Command\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Lba - GC_TODO: add argument description\r
- Command - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Read result byte from Data Register of FDC\r
+ \r
+ @param FdcDev Pointer to instance of FDC_BLK_IO_DEV\r
+ @param Pointer UINT8 *: Be used to save result byte read from FDC\r
+ \r
+ \r
+ @retval EFI_SUCCESS: Read result byte from FDC successfully\r
+ @retval EFI_DEVICE_ERROR: The FDC is not ready to be read\r
+\r
+**/\r
EFI_STATUS\r
DataInByte (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINT8 *Pointer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Pointer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Write command byte to Data Register of FDC\r
+ \r
+ @param FdcDev Pointer to instance of FDC_BLK_IO_DEV\r
+ @param Pointer Be used to save command byte written to FDC\r
+ \r
+ @retval EFI_SUCCESS: Write command byte to FDC successfully\r
+ @retval EFI_DEVICE_ERROR: The FDC is not ready to be written\r
+\r
+**/\r
EFI_STATUS\r
DataOutByte (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINT8 *Pointer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Pointer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Detect the specified floppy logic drive is busy or\r
+ not within a period of time\r
+ \r
+ @param Disk Indicate it is drive A or drive B\r
+ @param TimeoutInSeconds the time period for waiting\r
+ \r
+ @retval EFI_SUCCESS: The drive and command are not busy\r
+ @retval EFI_TIMEOUT: The drive or command is still busy after a period time that\r
+ set by TimeoutInSeconds\r
+\r
+**/\r
EFI_STATUS\r
FddWaitForBSYClear (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINTN TimeoutInSeconds\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- TimeoutInSeconds - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\r
+/**\r
\r
---*/\r
-;\r
+ Routine Description: Determine whether FDC is ready to write or read\r
+ \r
+ @param FdcDev Pointer to instance of FDC_BLK_IO_DEV\r
+ @param Dio BOOLEAN: Indicate the FDC is waiting to write or read\r
+ @param TimeoutInSeconds UINTN: The time period for waiting\r
+ \r
+ @retval EFI_SUCCESS: FDC is ready to write or read\r
+ @retval EFI_NOT_READY: FDC is not ready within the specified time period\r
\r
+**/\r
EFI_STATUS\r
FddDRQReady (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN BOOLEAN Dio,\r
IN UINTN TimeoutInSeconds\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Dio - GC_TODO: add argument description\r
- TimeoutInSeconds - GC_TODO: add argument description\r
+;\r
\r
-Returns:\r
+/**\r
+ Set FDC control structure's attribute according to\r
+ result \r
\r
- GC_TODO: add return values\r
+ @param Result Point to result structure\r
+ @param FdcDev FDC control structure\r
\r
---*/\r
-;\r
+ @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @param EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
+**/\r
EFI_STATUS\r
CheckResult (\r
IN FDD_RESULT_PACKET *Result,\r
IN OUT FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- Result - GC_TODO: add argument description\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Check the drive status information\r
+ \r
+ @param StatusRegister3 the value of Status Register 3\r
+ \r
+ @retval EFI_SUCCESS The disk is not write protected\r
+ @retval EFI_WRITE_PROTECTED: The disk is write protected\r
+\r
+**/\r
EFI_STATUS\r
CheckStatus3 (\r
IN UINT8 StatusRegister3\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- StatusRegister3 - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Calculate the number of block in the same cylinder\r
+ according to LBA\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @param LBA EFI_LBA: The starting logic block address\r
+ @param NumberOfBlocks UINTN: The number of blocks\r
+ \r
+ @return The number of blocks in the same cylinder which the starting\r
+ logic block address is LBA\r
+\r
+**/\r
UINTN\r
GetTransferBlockCount (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN EFI_LBA LBA,\r
IN UINTN NumberOfBlocks\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- LBA - GC_TODO: add argument description\r
- NumberOfBlocks - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ When the Timer(2s) off, turn the drive's motor off\r
+ \r
+ @param Event EFI_EVENT: Event(the timer) whose notification function is being\r
+ invoked\r
+ @param Context VOID *: Pointer to the notification function's context\r
+\r
+**/\r
VOID\r
EFIAPI\r
FddTimerProc (\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- Event - GC_TODO: add argument description\r
- Context - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Read I/O port for FDC\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @param Offset The offset address of port\r
+\r
+**/\r
UINT8\r
FdcReadPort (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINT32 Offset\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Offset - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Write I/O port for FDC\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @param Offset The offset address of port\r
+\r
+**/\r
VOID\r
FdcWritePort (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINT32 Offset,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
+;\r
\r
- FdcDev - GC_TODO: add argument description\r
- Offset - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
+/**\r
+ Read or Write a number of blocks to floppy device\r
\r
-Returns:\r
+ @param This Pointer to instance of EFI_BLOCK_IO_PROTOCOL\r
+ @param MediaId The media id of read/write request\r
+ @param LBA The starting logic block address to read from on the device\r
+ @param BufferSize The size of the Buffer in bytes\r
+ @param Operation - GC_TODO: add argument description\r
+ Buffer - GC_TODO: add argument description\r
\r
- GC_TODO: add return values\r
-\r
---*/\r
-;\r
+ @retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
+ @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
+ @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @retval EFI_NO_MEDIA - GC_TODO: Add description for return value\r
+ @retval EFI_MEDIA_CHANGED - GC_TODO: Add description for return value\r
+ @retval EFI_WRITE_PROTECTED - GC_TODO: Add description for return value\r
+ @retval EFI_BAD_BUFFER_SIZE - GC_TODO: Add description for return value\r
+ @retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
+ @retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
+ @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
+ @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
+**/\r
EFI_STATUS\r
FddReadWriteBlocks (\r
IN EFI_BLOCK_IO_PROTOCOL *This,\r
IN BOOLEAN Operation,\r
OUT VOID *Buffer\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
- MediaId - GC_TODO: add argument description\r
- LBA - GC_TODO: add argument description\r
- BufferSize - GC_TODO: add argument description\r
- Operation - GC_TODO: add argument description\r
- Buffer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Common interface for free cache \r
+ \r
+ @param FdcDec Pointer of FDC_BLK_IO_DEV instance\r
+ \r
+**/\r
VOID\r
FdcFreeCache (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
#endif\r
+\r
\r
#include "IsaFloppy.h"\r
\r
+/**\r
+ Reset the Floppy Logic Drive, call the FddReset function \r
+ \r
+ @param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
+ @param ExtendedVerification BOOLEAN: Indicate that the driver may perform a more \r
+ exhaustive verification operation of the device during \r
+ reset, now this par is ignored in this driver \r
+ @retval EFI_SUCCESS: The Floppy Logic Drive is reset\r
+ @retval EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly \r
+ and can not be reset\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FdcReset (\r
IN EFI_BLOCK_IO_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
- \r
- Routine Description: Reset the Floppy Logic Drive, call the FddReset function \r
- Parameters:\r
- This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
- ExtendedVerification BOOLEAN: Indicate that the driver may perform a more \r
- exhaustive verification operation of the device during \r
- reset, now this par is ignored in this driver \r
- Returns:\r
- EFI_SUCCESS: The Floppy Logic Drive is reset\r
- EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly \r
- and can not be reset\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: This - add argument and description to function comment\r
-// GC_TODO: ExtendedVerification - add argument and description to function comment\r
{\r
FDC_BLK_IO_DEV *FdcDev;\r
\r
return FddReset (FdcDev);\r
}\r
\r
+/**\r
+ Flush block via fdd controller\r
+ \r
+ @param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
+ @return EFI_SUCCESS\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FddFlushBlocks (\r
IN EFI_BLOCK_IO_PROTOCOL *This\r
)\r
-/*++\r
- \r
- Routine Description: \r
- Parameters:\r
- This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
- Returns:\r
- EFI_SUCCESS: \r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: This - add argument and description to function comment\r
{\r
//\r
// Not supported yet\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Common report status code interface\r
+ \r
+ @param This Pointer of FDC_BLK_IO_DEV instance\r
+ @param Read Error type: read or write?\r
+**/\r
STATIC\r
VOID\r
FddReportStatus (\r
IN EFI_BLOCK_IO_PROTOCOL *This,\r
IN BOOLEAN Read\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
- Read - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
FDC_BLK_IO_DEV *FdcDev;\r
\r
);\r
}\r
\r
+/**\r
+ Read the requested number of blocks from the device \r
+ \r
+ @param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
+ @param MediaId UINT32: The media id that the read request is for \r
+ @param LBA EFI_LBA: The starting logic block address to read from on the device\r
+ @param BufferSize UINTN: The size of the Buffer in bytes\r
+ @param Buffer VOID *: A pointer to the destination buffer for the data\r
+ \r
+ @retval EFI_SUCCESS: The data was read correctly from the device\r
+ @retval EFI_DEVICE_ERROR:The device reported an error while attempting to perform\r
+ the read operation\r
+ @retval EFI_NO_MEDIA: There is no media in the device\r
+ @retval EFI_MEDIA_CHANGED: The MediaId is not for the current media\r
+ @retval EFI_BAD_BUFFER_SIZE: The BufferSize parameter is not a multiple of the \r
+ intrinsic block size of the device\r
+ @retval EFI_INVALID_PARAMETER:The read request contains LBAs that are not valid, \r
+ or the buffer is not on proper alignment \r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FddReadBlocks (\r
IN UINTN BufferSize,\r
OUT VOID *Buffer\r
)\r
-/*++\r
-\r
- Routine Description: Read the requested number of blocks from the device \r
- Parameters:\r
- This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
- MediaId UINT32: The media id that the read request is for \r
- LBA EFI_LBA: The starting logic block address to read from on the device\r
- BufferSize UINTN: The size of the Buffer in bytes\r
- Buffer VOID *: A pointer to the destination buffer for the data\r
- Returns:\r
- EFI_SUCCESS: The data was read correctly from the device\r
- EFI_DEVICE_ERROR:The device reported an error while attempting to perform\r
- the read operation\r
- EFI_NO_MEDIA: There is no media in the device\r
- EFI_MEDIA_CHANGED: The MediaId is not for the current media\r
- EFI_BAD_BUFFER_SIZE: The BufferSize parameter is not a multiple of the \r
- intrinsic block size of the device\r
- EFI_INVALID_PARAMETER:The read request contains LBAs that are not valid, \r
- or the buffer is not on proper alignment \r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: This - add argument and description to function comment\r
-// GC_TODO: MediaId - add argument and description to function comment\r
-// GC_TODO: LBA - add argument and description to function comment\r
-// GC_TODO: BufferSize - add argument and description to function comment\r
-// GC_TODO: Buffer - add argument and description to function comment\r
{\r
EFI_STATUS Status;\r
\r
return Status;\r
}\r
\r
+/**\r
+ Write a specified number of blocks to the device \r
+ \r
+ @param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
+ @param MediaId UINT32: The media id that the write request is for \r
+ @param LBA EFI_LBA: The starting logic block address to be written\r
+ @param BufferSize UINTN: The size in bytes in Buffer\r
+ @param Buffer VOID *: A pointer to the source buffer for the data\r
+ \r
+ @retval EFI_SUCCESS: The data were written correctly to the device\r
+ @retval EFI_WRITE_PROTECTED: The device can not be written to \r
+ @retval EFI_NO_MEDIA: There is no media in the device\r
+ @retval EFI_MEDIA_CHANGED: The MediaId is not for the current media\r
+ @retval EFI_DEVICE_ERROR: The device reported an error while attempting to perform \r
+ the write operation \r
+ @retval EFI_BAD_BUFFER_SIZE: The BufferSize parameter is not a multiple of the \r
+ intrinsic block size of the device\r
+ @retval EFI_INVALID_PARAMETER:The write request contains LBAs that are not valid, \r
+ or the buffer is not on proper alignment \r
+**/\r
EFI_STATUS\r
EFIAPI\r
FddWriteBlocks (\r
IN UINTN BufferSize,\r
IN VOID *Buffer\r
)\r
-/*++\r
-\r
- Routine Description: Write a specified number of blocks to the device \r
- Parameters:\r
- This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
- MediaId UINT32: The media id that the write request is for \r
- LBA EFI_LBA: The starting logic block address to be written\r
- BufferSize UINTN: The size in bytes in Buffer\r
- Buffer VOID *: A pointer to the source buffer for the data\r
- Returns :\r
- EFI_SUCCESS: The data were written correctly to the device\r
- EFI_WRITE_PROTECTED: The device can not be written to \r
- EFI_NO_MEDIA: There is no media in the device\r
- EFI_MEDIA_CHANGED: The MediaId is not for the current media\r
- EFI_DEVICE_ERROR: The device reported an error while attempting to perform \r
- the write operation \r
- EFI_BAD_BUFFER_SIZE: The BufferSize parameter is not a multiple of the \r
- intrinsic block size of the device\r
- EFI_INVALID_PARAMETER:The write request contains LBAs that are not valid, \r
- or the buffer is not on proper alignment \r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: function comment is missing 'Returns:'\r
-// GC_TODO: This - add argument and description to function comment\r
-// GC_TODO: MediaId - add argument and description to function comment\r
-// GC_TODO: LBA - add argument and description to function comment\r
-// GC_TODO: BufferSize - add argument and description to function comment\r
-// GC_TODO: Buffer - add argument and description to function comment\r
{\r
EFI_STATUS Status;\r
\r
return Status;\r
}\r
\r
+/**\r
+ Read or Write a number of blocks to floppy device\r
+\r
+ @param This Pointer to instance of EFI_BLOCK_IO_PROTOCOL\r
+ @param MediaId The media id of read/write request\r
+ @param LBA The starting logic block address to read from on the device\r
+ @param BufferSize The size of the Buffer in bytes\r
+ @param Operation - GC_TODO: add argument description\r
+ Buffer - GC_TODO: add argument description\r
+\r
+ @retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
+ @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
+ @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @retval EFI_NO_MEDIA - GC_TODO: Add description for return value\r
+ @retval EFI_MEDIA_CHANGED - GC_TODO: Add description for return value\r
+ @retval EFI_WRITE_PROTECTED - GC_TODO: Add description for return value\r
+ @retval EFI_BAD_BUFFER_SIZE - GC_TODO: Add description for return value\r
+ @retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
+ @retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
+ @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
+ @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
+\r
+**/\r
EFI_STATUS\r
FddReadWriteBlocks (\r
IN EFI_BLOCK_IO_PROTOCOL *This,\r
IN BOOLEAN Operation,\r
OUT VOID *Buffer\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
- MediaId - GC_TODO: add argument description\r
- LBA - GC_TODO: add argument description\r
- BufferSize - GC_TODO: add argument description\r
- Operation - GC_TODO: add argument description\r
- Buffer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
- EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
- EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
- EFI_NO_MEDIA - GC_TODO: Add description for return value\r
- EFI_MEDIA_CHANGED - GC_TODO: Add description for return value\r
- EFI_WRITE_PROTECTED - GC_TODO: Add description for return value\r
- EFI_BAD_BUFFER_SIZE - GC_TODO: Add description for return value\r
- EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
- EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
- EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
- EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
EFI_BLOCK_IO_MEDIA *Media;\r
FDC_BLK_IO_DEV *FdcDev;\r
\r
}\r
\r
+/**\r
+ Common interface for free cache \r
+ \r
+ @param FdcDec Pointer of FDC_BLK_IO_DEV instance\r
+ \r
+**/\r
VOID\r
FdcFreeCache (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
if (FdcDev->Cache) {\r
gBS->FreePool (FdcDev->Cache);\r
\r
#include "IsaFloppy.h"\r
\r
+/**\r
+\r
+ Detect the floppy drive is presented or not\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
+ @retval EFI_SUCCESS Drive is presented\r
+ @retval EFI_NOT_FOUND Drive is not presented\r
+\r
+**/\r
EFI_STATUS\r
DiscoverFddDevice (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
- Routine Description: Detect the floppy drive is presented or not\r
- Parameters:\r
- FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
- Returns:\r
- EFI_SUCCESS Drive is presented\r
- EFI_NOT_FOUND Drive is not presented\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
{\r
EFI_STATUS Status;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+\r
+ Do recalibrate and see the drive is presented or not\r
+ Set the media parameters\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
+ @return the drive is presented or not\r
+\r
+**/\r
EFI_STATUS\r
FddIdentify (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
- Routine Description: Do recalibrate and see the drive is presented or not\r
- Set the media parameters\r
- Parameters:\r
- FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
- Returns:\r
- EFI_SUCCESS:\r
- EFI_DEVICE_ERROR:\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
{\r
EFI_STATUS Status;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+\r
+ Reset the Floppy Logic Drive\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
+ \r
+ @retval EFI_SUCCESS: The Floppy Logic Drive is reset\r
+ @retval EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly and\r
+ can not be reset\r
+\r
+**/\r
EFI_STATUS\r
FddReset (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
- Routine Description: Reset the Floppy Logic Drive\r
- Parameters:\r
- FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
- Returns:\r
- EFI_SUCCESS: The Floppy Logic Drive is reset\r
- EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly and\r
- can not be reset\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
{\r
UINT8 data;\r
UINT8 StatusRegister0;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+\r
+ Turn the drive's motor on\r
+ The drive's motor must be on before any command can be executed\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
+ \r
+ @retval EFI_SUCCESS: Turn the drive's motor on successfully\r
+ @retval EFI_DEVICE_ERROR: The drive is busy, so can not turn motor on\r
+ @retval EFI_INVALID_PARAMETER: Fail to Set timer(Cancel timer)\r
+\r
+**/\r
EFI_STATUS\r
MotorOn (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
- Routine Description: Turn the drive's motor on\r
- The drive's motor must be on before any command can be executed\r
- Parameters:\r
- FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
- Returns:\r
- EFI_SUCCESS: Turn the drive's motor on successfully\r
- EFI_DEVICE_ERROR: The drive is busy, so can not turn motor on\r
- EFI_INVALID_PARAMETER: Fail to Set timer(Cancel timer)\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
{\r
EFI_STATUS Status;\r
UINT8 data;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+\r
+ Set a Timer and when Timer goes off, turn the motor off\r
+ \r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
+ \r
+ @retval EFI_SUCCESS: Set the Timer successfully\r
+ @retval EFI_INVALID_PARAMETER: Fail to Set the timer\r
+\r
+**/\r
EFI_STATUS\r
MotorOff (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
- Routine Description: Set a Timer and when Timer goes off, turn the motor off\r
- Parameters:\r
- FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
- Returns:\r
- EFI_SUCCESS: Set the Timer successfully\r
- EFI_INVALID_PARAMETER: Fail to Set the timer\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
{\r
//\r
// Set the timer : 2s\r
return gBS->SetTimer (FdcDev->Event, TimerRelative, 20000000);\r
}\r
\r
+/**\r
+ Detect the disk in the drive is changed or not\r
+ \r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ \r
+ @retval EFI_SUCCESS: No disk media change\r
+ @retval EFI_DEVICE_ERROR: Fail to do the recalibrate or seek operation\r
+ @retval EFI_NO_MEDIA: No disk in the drive\r
+ @retval EFI_MEDIA_CHANGED: There is a new disk in the drive\r
+**/\r
EFI_STATUS\r
DisketChanged (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
- Routine Description: Detect the disk in the drive is changed or not\r
- Parameters:\r
- FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
- Returns:\r
- EFI_SUCCESS: No disk media change\r
- EFI_DEVICE_ERROR: Fail to do the recalibrate or seek operation\r
- EFI_NO_MEDIA: No disk in the drive\r
- EFI_MEDIA_CHANGED: There is a new disk in the drive\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
{\r
EFI_STATUS Status;\r
UINT8 data;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Do the Specify command, this command sets DMA operation\r
+ and the initial values for each of the three internal\r
+ times: HUT, SRT and HLT\r
+ \r
+ @param This Pointer to instance of FDC_BLK_IO_DEV\r
+ \r
+ @retval EFI_SUCCESS: Execute the Specify command successfully\r
+ @retval EFI_DEVICE_ERROR: Fail to execute the command\r
+\r
+**/\r
EFI_STATUS\r
Specify (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
- Routine Description: Do the Specify command, this command sets DMA operation\r
- and the initial values for each of the three internal\r
- times: HUT, SRT and HLT\r
- Parameters:\r
- None\r
- Returns:\r
- EFI_SUCCESS: Execute the Specify command successfully\r
- EFI_DEVICE_ERROR: Fail to execute the command\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
{\r
FDD_SPECIFY_CMD Command;\r
UINTN Index;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Set the head of floppy drive to track 0\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @retval EFI_SUCCESS: Execute the Recalibrate operation successfully\r
+ @retval EFI_DEVICE_ERROR: Fail to execute the Recalibrate operation\r
+\r
+**/\r
EFI_STATUS\r
Recalibrate (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
- Routine Description: Set the head of floppy drive to track 0\r
- Parameters:\r
- FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
- Returns:\r
- EFI_SUCCESS: Execute the Recalibrate operation successfully\r
- EFI_DEVICE_ERROR: Fail to execute the Recalibrate operation\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
{\r
FDD_COMMAND_PACKET2 Command;\r
UINTN Index;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Set the head of floppy drive to the new cylinder\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @param Lba EFI_LBA : The logic block address want to seek\r
+ \r
+ @retval EFI_SUCCESS: Execute the Seek operation successfully\r
+ @retval EFI_DEVICE_ERROR: Fail to execute the Seek operation\r
+\r
+**/\r
EFI_STATUS\r
Seek (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN EFI_LBA Lba\r
)\r
-/*++\r
-\r
- Routine Description: Set the head of floppy drive to the new cylinder\r
- Parameters:\r
- FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
- Lba EFI_LBA : The logic block address want to seek\r
- Returns:\r
- EFI_SUCCESS: Execute the Seek operation successfully\r
- EFI_DEVICE_ERROR: Fail to execute the Seek operation\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: Lba - add argument and description to function comment\r
{\r
FDD_SEEK_CMD Command;\r
UINT8 EndOfTrack;\r
}\r
}\r
\r
+/**\r
+ Do the Sense Interrupt Status command, this command\r
+ resets the interrupt signal\r
+ \r
+ \r
+ @param StatusRegister0 UINT8 *: Be used to save Status Register 0 read from FDC\r
+ @param PresentCylinderNumber UINT8 *: Be used to save present cylinder number\r
+ read from FDC\r
+ \r
+ @retval EFI_SUCCESS: Execute the Sense Interrupt Status command successfully\r
+ @retval EFI_DEVICE_ERROR: Fail to execute the command\r
+\r
+**/\r
EFI_STATUS\r
SenseIntStatus (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN OUT UINT8 *StatusRegister0,\r
IN OUT UINT8 *PresentCylinderNumber\r
)\r
-/*++\r
-\r
- Routine Description: Do the Sense Interrupt Status command, this command\r
- resets the interrupt signal\r
- Parameters:\r
- StatusRegister0 UINT8 *: Be used to save Status Register 0 read from FDC\r
- PresentCylinderNumber UINT8 *: Be used to save present cylinder number\r
- read from FDC\r
- Returns:\r
- EFI_SUCCESS: Execute the Sense Interrupt Status command successfully\r
- EFI_DEVICE_ERROR: Fail to execute the command\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: StatusRegister0 - add argument and description to function comment\r
-// GC_TODO: PresentCylinderNumber - add argument and description to function comment\r
{\r
UINT8 command;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Do the Sense Drive Status command\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @param Lba EFI_LBA : Logic block address\r
+ \r
+ @retval EFI_SUCCESS: Execute the Sense Drive Status command successfully\r
+ @retval EFI_DEVICE_ERROR: Fail to execute the command\r
+ @retval EFI_WRITE_PROTECTED:The disk is write protected\r
+\r
+**/\r
EFI_STATUS\r
SenseDrvStatus (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN EFI_LBA Lba\r
)\r
-/*++\r
-\r
- Routine Description: Do the Sense Drive Status command\r
- Parameters:\r
- FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
- Lba EFI_LBA : Logic block address\r
- Returns:\r
- EFI_SUCCESS: Execute the Sense Drive Status command successfully\r
- EFI_DEVICE_ERROR: Fail to execute the command\r
- EFI_WRITE_PROTECTED:The disk is write protected\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: Lba - add argument and description to function comment\r
{\r
FDD_COMMAND_PACKET2 Command;\r
UINT8 Head;\r
return CheckStatus3 (StatusRegister3);\r
}\r
\r
+/**\r
+ Update the disk media properties and if necessary\r
+ reinstall Block I/O interface\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ \r
+ @retval EFI_SUCCESS: Do the operation successfully\r
+ @retval EFI_DEVICE_ERROR: Fail to the operation\r
+\r
+**/\r
EFI_STATUS\r
DetectMedia (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
- Routine Description: Update the disk media properties and if necessary\r
- reinstall Block I/O interface\r
- Parameters:\r
- FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
- Returns:\r
- EFI_SUCCESS: Do the operation successfully\r
- EFI_DEVICE_ERROR: Fail to the operation\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
{\r
EFI_STATUS Status;\r
BOOLEAN bReset;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Set the data rate and so on\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+\r
+ @retval EFI_SUCCESS success to set the data rate\r
+**/\r
EFI_STATUS\r
Setup (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
- Routine Description: Set the data rate and so on\r
- Parameters:\r
- None\r
- Returns:\r
- EFI_SUCCESS:\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
{\r
EFI_STATUS Status;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Read or Write a number of blocks in the same cylinder\r
+ \r
+ @param FdcDev A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @param HostAddress device address \r
+ @param Lba The starting logic block address to read from on the device\r
+ @param NumberOfBlocks The number of block wanted to be read or write\r
+ @param Read Operation type: read or write\r
+ \r
+ @retval EFI_SUCCESS Success operate\r
+\r
+**/\r
EFI_STATUS\r
ReadWriteDataSector (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINTN NumberOfBlocks,\r
IN BOOLEAN Read\r
)\r
-/*++\r
-\r
- Routine Description: Read or Write a number of blocks in the same cylinder\r
- Parameters:\r
- FdcDev FDC_BLK_IO_DEV * : A pointer to Data Structure FDC_BLK_IO_DEV\r
- Buffer VOID *:\r
- Lba EFI_LBA:\r
- NumberOfBlocks UINTN:\r
- Read BOOLEAN:\r
- Returns:\r
- EFI_SUCCESS:\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: HostAddress - add argument and description to function comment\r
-// GC_TODO: Lba - add argument and description to function comment\r
-// GC_TODO: NumberOfBlocks - add argument and description to function comment\r
-// GC_TODO: Read - add argument and description to function comment\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
-// GC_TODO: EFI_TIMEOUT - add return value to function comment\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
{\r
EFI_STATUS Status;\r
FDD_COMMAND_PACKET1 Command;\r
return CheckResult (&Result, FdcDev);\r
}\r
\r
+/**\r
+ Fill in FDD command's parameter\r
+ \r
+ @param FdcDev Pointer to instance of FDC_BLK_IO_DEV\r
+ @param Lba The starting logic block address to read from on the device\r
+ @param Command FDD command\r
+\r
+**/\r
VOID\r
FillPara (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN EFI_LBA Lba,\r
IN FDD_COMMAND_PACKET1 *Command\r
)\r
-/*++\r
-\r
- Routine Description: Fill in Parameter\r
- Parameters:\r
- Returns:\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: Lba - add argument and description to function comment\r
-// GC_TODO: Command - add argument and description to function comment\r
{\r
UINT8 EndOfTrack;\r
\r
Command->DataLength = DISK_1440K_DTL;\r
}\r
\r
+/**\r
+ Read result byte from Data Register of FDC\r
+ \r
+ @param FdcDev Pointer to instance of FDC_BLK_IO_DEV\r
+ @param Pointer UINT8 *: Be used to save result byte read from FDC\r
+ \r
+ \r
+ @retval EFI_SUCCESS: Read result byte from FDC successfully\r
+ @retval EFI_DEVICE_ERROR: The FDC is not ready to be read\r
+\r
+**/\r
EFI_STATUS\r
DataInByte (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN OUT UINT8 *Pointer\r
)\r
-/*++\r
-\r
- Routine Description: Read result byte from Data Register of FDC\r
- Parameters:\r
- Pointer UINT8 *: Be used to save result byte read from FDC\r
- Returns:\r
- EFI_SUCCESS: Read result byte from FDC successfully\r
- EFI_DEVICE_ERROR: The FDC is not ready to be read\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: Pointer - add argument and description to function comment\r
{\r
UINT8 data;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Write command byte to Data Register of FDC\r
+ \r
+ @param FdcDev Pointer to instance of FDC_BLK_IO_DEV\r
+ @param Pointer Be used to save command byte written to FDC\r
+ \r
+ @retval EFI_SUCCESS: Write command byte to FDC successfully\r
+ @retval EFI_DEVICE_ERROR: The FDC is not ready to be written\r
+\r
+**/\r
EFI_STATUS\r
DataOutByte (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINT8 *Pointer\r
)\r
-/*++\r
-\r
- Routine Description: Write command byte to Data Register of FDC\r
- Parameters:\r
- Pointer UINT8 *: Be used to save command byte written to FDC\r
- Returns:\r
- EFI_SUCCESS: Write command byte to FDC successfully\r
- EFI_DEVICE_ERROR: The FDC is not ready to be written\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: Pointer - add argument and description to function comment\r
{\r
UINT8 data;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Detect the specified floppy logic drive is busy or\r
+ not within a period of time\r
+ \r
+ @param Disk Indicate it is drive A or drive B\r
+ @param TimeoutInSeconds the time period for waiting\r
+ \r
+ @retval EFI_SUCCESS: The drive and command are not busy\r
+ @retval EFI_TIMEOUT: The drive or command is still busy after a period time that\r
+ set by TimeoutInSeconds\r
+\r
+**/\r
EFI_STATUS\r
FddWaitForBSYClear (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINTN TimeoutInSeconds\r
)\r
-/*++\r
-\r
- Routine Description: Detect the specified floppy logic drive is busy or\r
- not within a period of time\r
- Parameters:\r
- Disk EFI_FDC_DISK: Indicate it is drive A or drive B\r
- TimeoutInSeconds UINTN: the time period for waiting\r
- Returns:\r
- EFI_SUCCESS: The drive and command are not busy\r
- EFI_TIMEOUT: The drive or command is still busy after a period time that\r
- set by TimeoutInSeconds\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: TimeoutInSeconds - add argument and description to function comment\r
{\r
UINTN Delay;\r
UINT8 StatusRegister;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+\r
+ Routine Description: Determine whether FDC is ready to write or read\r
+ \r
+ @param FdcDev Pointer to instance of FDC_BLK_IO_DEV\r
+ @param Dio BOOLEAN: Indicate the FDC is waiting to write or read\r
+ @param TimeoutInSeconds UINTN: The time period for waiting\r
+ \r
+ @retval EFI_SUCCESS: FDC is ready to write or read\r
+ @retval EFI_NOT_READY: FDC is not ready within the specified time period\r
+\r
+**/\r
EFI_STATUS\r
FddDRQReady (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN BOOLEAN Dio,\r
IN UINTN TimeoutInSeconds\r
)\r
-/*++\r
-\r
- Routine Description: Determine whether FDC is ready to write or read\r
- Parameters:\r
- Dio BOOLEAN: Indicate the FDC is waiting to write or read\r
- TimeoutInSeconds UINTN: The time period for waiting\r
- Returns:\r
- EFI_SUCCESS: FDC is ready to write or read\r
- EFI_NOT_READY: FDC is not ready within the specified time period\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: Dio - add argument and description to function comment\r
-// GC_TODO: TimeoutInSeconds - add argument and description to function comment\r
{\r
UINTN Delay;\r
UINT8 StatusRegister;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Set FDC control structure's attribute according to\r
+ result \r
+\r
+ @param Result Point to result structure\r
+ @param FdcDev FDC control structure\r
+\r
+ @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @param EFI_SUCCESS - GC_TODO: Add description for return value\r
+\r
+**/\r
EFI_STATUS\r
CheckResult (\r
IN FDD_RESULT_PACKET *Result,\r
IN OUT FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- Result - GC_TODO: add argument description\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
- EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
- EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
//\r
// Check Status Register0\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Check the drive status information\r
+ \r
+ @param StatusRegister3 the value of Status Register 3\r
+ \r
+ @retval EFI_SUCCESS The disk is not write protected\r
+ @retval EFI_WRITE_PROTECTED: The disk is write protected\r
+\r
+**/\r
EFI_STATUS\r
CheckStatus3 (\r
IN UINT8 StatusRegister3\r
)\r
-/*++\r
-\r
- Routine Description: Check the drive status information\r
- Parameters:\r
- StatusRegister3 UINT8: the value of Status Register 3\r
- Returns:\r
- EFI_SUCCESS:\r
- EFI_WRITE_PROTECTED: The disk is write protected\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: StatusRegister3 - add argument and description to function comment\r
{\r
if (StatusRegister3 & STS3_WP) {\r
return EFI_WRITE_PROTECTED;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Calculate the number of block in the same cylinder\r
+ according to LBA\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @param LBA EFI_LBA: The starting logic block address\r
+ @param NumberOfBlocks UINTN: The number of blocks\r
+ \r
+ @return The number of blocks in the same cylinder which the starting\r
+ logic block address is LBA\r
+\r
+**/\r
UINTN\r
GetTransferBlockCount (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN EFI_LBA LBA,\r
IN UINTN NumberOfBlocks\r
)\r
-/*++\r
-\r
- Routine Description: Calculate the number of block in the same cylinder\r
- according to LBA\r
- Parameters:\r
- FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
- LBA EFI_LBA: The starting logic block address\r
- NumberOfBlocks UINTN: The number of blocks\r
- Returns:\r
- UINTN : The number of blocks in the same cylinder which the starting\r
- logic block address is LBA\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: LBA - add argument and description to function comment\r
-// GC_TODO: NumberOfBlocks - add argument and description to function comment\r
{\r
UINT8 EndOfTrack;\r
UINT8 Head;\r
}\r
}\r
\r
+/**\r
+ When the Timer(2s) off, turn the drive's motor off\r
+ \r
+ @param Event EFI_EVENT: Event(the timer) whose notification function is being\r
+ invoked\r
+ @param Context VOID *: Pointer to the notification function's context\r
+\r
+**/\r
VOID\r
EFIAPI\r
FddTimerProc (\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
-\r
- Routine Description: When the Timer(2s) off, turn the drive's motor off\r
- Parameters:\r
- Event EFI_EVENT: Event(the timer) whose notification function is being\r
- invoked\r
- Context VOID *: Pointer to the notification function's context\r
- Returns:\r
- VOID\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: Event - add argument and description to function comment\r
-// GC_TODO: Context - add argument and description to function comment\r
{\r
FDC_BLK_IO_DEV *FdcDev;\r
UINT8 data;\r
MicroSecondDelay (500);\r
}\r
\r
+/**\r
+ Read I/O port for FDC\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @param Offset The offset address of port\r
+\r
+**/\r
UINT8\r
FdcReadPort (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINT32 Offset\r
)\r
-/*++\r
-\r
- Routine Description: Read I/O port for FDC\r
- Parameters:\r
- Returns:\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: Offset - add argument and description to function comment\r
{\r
UINT8 Data;\r
\r
return Data;\r
}\r
\r
+/**\r
+ Write I/O port for FDC\r
+ \r
+ @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
+ @param Offset The offset address of port\r
+\r
+**/\r
VOID\r
FdcWritePort (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINT32 Offset,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
- Routine Description: Write I/O port for FDC\r
- Parameters:\r
- Returns:\r
-\r
---*/\r
-// GC_TODO: function comment is missing 'Arguments:'\r
-// GC_TODO: FdcDev - add argument and description to function comment\r
-// GC_TODO: Offset - add argument and description to function comment\r
-// GC_TODO: Data - add argument and description to function comment\r
{\r
\r
//\r
&Data\r
);\r
}\r
+\r
IN SERIAL_DEV *SerialDevice,\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
CHAR16 SerialPortName[sizeof (SERIAL_PORT_NAME)];\r
\r
IN SERIAL_DEV *SerialDevice,\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
/**@file\r
- Serial driver for standard UARTS on an ISA bus.\r
+ Serial driver for standard UARTS on an ISA bus.\r
\r
Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
return Status;\r
}\r
\r
+/**\r
+ Check to see if this driver supports the given controller\r
+\r
+ @param This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
+ @param Controller - The handle of the controller to test.\r
+ @param RemainingDevicePath - A pointer to the remaining portion of a device path.\r
\r
+ @return EFI_SUCCESS - This driver can support the given controller\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
SerialControllerDriverSupported (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Check to see if this driver supports the given controller\r
-\r
- Arguments:\r
\r
- This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- Controller - The handle of the controller to test.\r
- RemainingDevicePath - A pointer to the remaining portion of a device path.\r
-\r
- Returns:\r
-\r
- EFI_SUCCESS - This driver can support the given controller\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r
return Status;\r
}\r
\r
+/**\r
+ Start to management the controller passed in\r
+\r
+ @param This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
+ @param Controller - The handle of the controller to test.\r
+ @param RemainingDevicePath - A pointer to the remaining portion of a device path.\r
+\r
+ @return EFI_SUCCESS - Driver is started successfully\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
SerialControllerDriverStart (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Start to management the controller passed in\r
-\r
- Arguments:\r
-\r
- This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- Controller - The handle of the controller to test.\r
- RemainingDevicePath - A pointer to the remaining portion of a device path.\r
\r
- Returns:\r
-\r
- EFI_SUCCESS - Driver is started successfully\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_ISA_IO_PROTOCOL *IsaIo;\r
return Status;\r
}\r
\r
+/**\r
+ Disconnect this driver with the controller, uninstall related protocol instance\r
+\r
+ @param This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
+ @param Controller - The handle of the controller to test.\r
+ @param NumberOfChildren - Number of child device.\r
+ @param RemainingDevicePath - A pointer to the remaining portion of a device path.\r
+\r
+ @retval EFI_SUCCESS - Operation successfully\r
+ @retval EFI_DEVICE_ERROR - Cannot stop the driver successfully\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
SerialControllerDriverStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Disconnect this driver with the controller, uninstall related protocol instance\r
-\r
- Arguments:\r
-\r
- This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- Controller - The handle of the controller to test.\r
- NumberOfChildren - Number of child device.\r
- RemainingDevicePath - A pointer to the remaining portion of a device path.\r
-\r
- Returns:\r
\r
- EFI_SUCCESS - Operation successfully\r
- EFI_DEVICE_ERROR - Cannot stop the driver successfully\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
UINTN Index;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Detect whether specific FIFO is full or not\r
+\r
+ @param Fifo - A pointer to the Data Structure SERIAL_DEV_FIFO\r
+\r
+ @return whether specific FIFO is full or not\r
+\r
+**/\r
BOOLEAN\r
IsaSerialFifoFull (\r
IN SERIAL_DEV_FIFO *Fifo\r
)\r
-/*++\r
\r
- Routine Description:\r
-\r
- Detect whether specific FIFO is full or not\r
-\r
- Arguments:\r
-\r
- Fifo - A pointer to the Data Structure SERIAL_DEV_FIFO\r
-\r
- Returns:\r
-\r
- TRUE - the FIFO is full\r
- FALSE - the FIFO is not full\r
-\r
---*/\r
{\r
if (Fifo->Surplus == 0) {\r
return TRUE;\r
return FALSE;\r
}\r
\r
+/**\r
+ Detect whether specific FIFO is empty or not\r
+\r
+ \r
+ @param Fifo - A pointer to the Data Structure SERIAL_DEV_FIFO\r
+\r
+ @return whether specific FIFO is empty or not\r
+\r
+**/\r
BOOLEAN\r
IsaSerialFifoEmpty (\r
IN SERIAL_DEV_FIFO *Fifo\r
)\r
-/*++\r
-\r
- Routine Description:\r
\r
- Detect whether specific FIFO is empty or not\r
-\r
- Arguments:\r
-\r
- Fifo - A pointer to the Data Structure SERIAL_DEV_FIFO\r
-\r
- Returns:\r
-\r
- TRUE - the FIFO is empty\r
- FALSE - the FIFO is not empty\r
-\r
---*/\r
{\r
if (Fifo->Surplus == SERIAL_MAX_BUFFER_SIZE) {\r
return TRUE;\r
return FALSE;\r
}\r
\r
+/**\r
+ Add data to specific FIFO\r
+\r
+ @param Fifo - A pointer to the Data Structure SERIAL_DEV_FIFO\r
+ @param Data - the data added to FIFO\r
+\r
+ @retval EFI_SUCCESS - Add data to specific FIFO successfully\r
+ @retval EFI_OUT_OF_RESOURCE - Failed to add data because FIFO is already full\r
+\r
+**/\r
EFI_STATUS\r
IsaSerialFifoAdd (\r
IN SERIAL_DEV_FIFO *Fifo,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Add data to specific FIFO\r
-\r
- Arguments:\r
\r
- Fifo - A pointer to the Data Structure SERIAL_DEV_FIFO\r
- Data - the data added to FIFO\r
-\r
- Returns:\r
-\r
- EFI_SUCCESS - Add data to specific FIFO successfully\r
- EFI_OUT_OF_RESOURCE - Failed to add data because FIFO is already full\r
-\r
---*/\r
{\r
//\r
// if FIFO full can not add data\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Remove data from specific FIFO\r
+\r
+ @param Fifo - A pointer to the Data Structure SERIAL_DEV_FIFO\r
+ @param Data - the data removed from FIFO\r
+\r
+ @retval EFI_SUCCESS - Remove data from specific FIFO successfully\r
+ @retval EFI_OUT_OF_RESOURCE - Failed to remove data because FIFO is empty\r
+\r
+**/\r
EFI_STATUS\r
IsaSerialFifoRemove (\r
IN SERIAL_DEV_FIFO *Fifo,\r
OUT UINT8 *Data\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Remove data from specific FIFO\r
-\r
- Arguments:\r
-\r
- Fifo - A pointer to the Data Structure SERIAL_DEV_FIFO\r
- Data - the data removed from FIFO\r
\r
- Returns:\r
- EFI_SUCCESS - Remove data from specific FIFO successfully\r
- EFI_OUT_OF_RESOURCE - Failed to remove data because FIFO is empty\r
-\r
---*/\r
{\r
//\r
// if FIFO is empty, no data can remove\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Reads and writes all avaliable data.\r
+\r
+ @param SerialDevice - The device to flush\r
+\r
+ @retval EFI_SUCCESS - Data was read/written successfully.\r
+ @retval EFI_OUT_OF_RESOURCE - Failed because software receive FIFO is full. Note, when\r
+ this happens, pending writes are not done.\r
+\r
+**/\r
EFI_STATUS\r
IsaSerialReceiveTransmit (\r
IN SERIAL_DEV *SerialDevice\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Reads and writes all avaliable data.\r
-\r
- Arguments:\r
-\r
- SerialDevice - The device to flush\r
-\r
- Returns:\r
-\r
- EFI_SUCCESS - Data was read/written successfully.\r
- EFI_OUT_OF_RESOURCE - Failed because software receive FIFO is full. Note, when\r
- this happens, pending writes are not done.\r
\r
---*/\r
{\r
SERIAL_PORT_LSR Lsr;\r
UINT8 Data;\r
\r
return EFI_SUCCESS;\r
}\r
+\r
//\r
// Interface Functions\r
//\r
+/**\r
+ Reset serial device\r
+\r
+ @param This - Pointer to EFI_SERIAL_IO_PROTOCOL\r
+\r
+ @retval EFI_SUCCESS - Reset successfully\r
+ @retval EFI_DEVICE_ERROR - Failed to reset\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaSerialReset (\r
IN EFI_SERIAL_IO_PROTOCOL *This\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Reset serial device\r
-\r
- Arguments:\r
-\r
- This - Pointer to EFI_SERIAL_IO_PROTOCOL\r
-\r
- Returns:\r
-\r
- EFI_SUCCESS - Reset successfully\r
- EFI_DEVICE_ERROR - Failed to reset\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
SERIAL_DEV *SerialDevice;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Set new attributes to a serial device\r
+\r
+ @param This - Pointer to EFI_SERIAL_IO_PROTOCOL\r
+ @param BaudRate - The baudrate of the serial device\r
+ @param ReceiveFifoDepth - The depth of receive FIFO buffer\r
+ @param Timeout - The request timeout for a single char\r
+ @param Parity - The type of parity used in serial device\r
+ @param DataBits - Number of databits used in serial device\r
+ @param StopBits - Number of stopbits used in serial device\r
+\r
+ @retval EFI_SUCCESS - The new attributes were set\r
+ @retval EFI_INVALID_PARAMETERS - One or more attributes have an unsupported value\r
+ @retval EFI_UNSUPPORTED - Data Bits can not set to 5 or 6\r
+ @retval EFI_DEVICE_ERROR - The serial device is not functioning correctly (no return)\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaSerialSetAttributes (\r
IN UINT8 DataBits,\r
IN EFI_STOP_BITS_TYPE StopBits\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Set new attributes to a serial device\r
-\r
- Arguments:\r
-\r
- This - Pointer to EFI_SERIAL_IO_PROTOCOL\r
- BaudRate - The baudrate of the serial device\r
- ReceiveFifoDepth - The depth of receive FIFO buffer\r
- Timeout - The request timeout for a single char\r
- Parity - The type of parity used in serial device\r
- DataBits - Number of databits used in serial device\r
- StopBits - Number of stopbits used in serial device\r
-\r
- Returns:\r
-\r
- EFI_SUCCESS - The new attributes were set\r
- EFI_INVALID_PARAMETERS - One or more attributes have an unsupported value\r
- EFI_UNSUPPORTED - Data Bits can not set to 5 or 6\r
- EFI_DEVICE_ERROR - The serial device is not functioning correctly (no return)\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
SERIAL_DEV *SerialDevice;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Set Control Bits\r
+\r
+ @param This - Pointer to EFI_SERIAL_IO_PROTOCOL\r
+ @param Control - Control bits that can be settable\r
+\r
+ @retval EFI_SUCCESS - New Control bits were set successfully\r
+ @retval EFI_UNSUPPORTED - The Control bits wanted to set are not supported\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaSerialSetControl (\r
IN EFI_SERIAL_IO_PROTOCOL *This,\r
IN UINT32 Control\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Set Control Bits\r
-\r
- Arguments:\r
-\r
- This - Pointer to EFI_SERIAL_IO_PROTOCOL\r
- Control - Control bits that can be settable\r
-\r
- Returns:\r
-\r
- EFI_SUCCESS - New Control bits were set successfully\r
- EFI_UNSUPPORTED - The Control bits wanted to set are not supported\r
-\r
---*/\r
{\r
SERIAL_DEV *SerialDevice;\r
SERIAL_PORT_MCR Mcr;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Get ControlBits\r
+\r
+ @param This - Pointer to EFI_SERIAL_IO_PROTOCOL\r
+ @param Control - Control signals of the serial device\r
+\r
+ @retval EFI_SUCCESS - Get Control signals successfully\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaSerialGetControl (\r
IN EFI_SERIAL_IO_PROTOCOL *This,\r
OUT UINT32 *Control\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Get ControlBits\r
-\r
- Arguments:\r
-\r
- This - Pointer to EFI_SERIAL_IO_PROTOCOL\r
- Control - Control signals of the serial device\r
-\r
- Returns:\r
-\r
- EFI_SUCCESS - Get Control signals successfully\r
-\r
---*/\r
{\r
SERIAL_DEV *SerialDevice;\r
SERIAL_PORT_MSR Msr;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Write the specified number of bytes to serial device\r
+\r
+ @param This - Pointer to EFI_SERIAL_IO_PROTOCOL\r
+ @param BufferSize - On input the size of Buffer, on output the amount of\r
+ data actually written\r
+ @param Buffer - The buffer of data to write\r
+\r
+ @retval EFI_SUCCESS - The data were written successfully\r
+ @retval EFI_DEVICE_ERROR - The device reported an error\r
+ @retval EFI_TIMEOUT - The write operation was stopped due to timeout\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaSerialWrite (\r
IN OUT UINTN *BufferSize,\r
IN VOID *Buffer\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Write the specified number of bytes to serial device\r
-\r
- Arguments:\r
-\r
- This - Pointer to EFI_SERIAL_IO_PROTOCOL\r
- BufferSize - On input the size of Buffer, on output the amount of\r
- data actually written\r
- Buffer - The buffer of data to write\r
-\r
- Returns:\r
-\r
- EFI_SUCCESS - The data were written successfully\r
- EFI_DEVICE_ERROR - The device reported an error\r
- EFI_TIMEOUT - The write operation was stopped due to timeout\r
-\r
---*/\r
{\r
SERIAL_DEV *SerialDevice;\r
UINT8 *CharBuffer;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Read the specified number of bytes from serial device\r
+\r
+ @param This - Pointer to EFI_SERIAL_IO_PROTOCOL\r
+ @param BufferSize - On input the size of Buffer, on output the amount of\r
+ data returned in buffer\r
+ @param Buffer - The buffer to return the data into\r
+\r
+ @retval EFI_SUCCESS - The data were read successfully\r
+ @retval EFI_DEVICE_ERROR - The device reported an error\r
+ @retval EFI_TIMEOUT - The read operation was stopped due to timeout\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaSerialRead (\r
IN OUT UINTN *BufferSize,\r
OUT VOID *Buffer\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Read the specified number of bytes from serial device\r
-\r
- Arguments:\r
-\r
- This - Pointer to EFI_SERIAL_IO_PROTOCOL\r
- BufferSize - On input the size of Buffer, on output the amount of\r
- data returned in buffer\r
- Buffer - The buffer to return the data into\r
-\r
- Returns:\r
-\r
- EFI_SUCCESS - The data were read successfully\r
- EFI_DEVICE_ERROR - The device reported an error\r
- EFI_TIMEOUT - The read operation was stopped due to timeout\r
-\r
---*/\r
{\r
SERIAL_DEV *SerialDevice;\r
UINT32 Index;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Use scratchpad register to test if this serial port is present\r
+\r
+ @param SerialDevice - Pointer to serial device structure\r
+\r
+ @return if this serial port is present\r
+**/\r
BOOLEAN\r
IsaSerialPortPresent (\r
IN SERIAL_DEV *SerialDevice\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Use scratchpad register to test if this serial port is present\r
-\r
- Arguments:\r
-\r
- SerialDevice - Pointer to serial device structure\r
-\r
- Returns:\r
\r
- TRUE - The serial port is present\r
- FALSE - The serial port is NOT present\r
-\r
---*/\r
{\r
UINT8 Temp;\r
BOOLEAN Status;\r
return Status;\r
}\r
\r
+/**\r
+ Use IsaIo protocol to read serial port\r
+\r
+ @param IsaIo - Pointer to EFI_ISA_IO_PROTOCOL instance\r
+ @param BaseAddress - Serial port register group base address\r
+ @param Offset - Offset in register group\r
+\r
+ @return Data read from serial port\r
+\r
+**/\r
UINT8\r
IsaSerialReadPort (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINT16 BaseAddress,\r
IN UINT32 Offset\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Use IsaIo protocol to read serial port\r
-\r
- Arguments:\r
-\r
- IsaIo - Pointer to EFI_ISA_IO_PROTOCOL instance\r
- BaseAddress - Serial port register group base address\r
- Offset - Offset in register group\r
-\r
- Returns:\r
-\r
- Data read from serial port\r
-\r
---*/\r
{\r
UINT8 Data;\r
\r
return Data;\r
}\r
\r
+/**\r
+ Use IsaIo protocol to write serial port\r
+\r
+ @param IsaIo - Pointer to EFI_ISA_IO_PROTOCOL instance\r
+ @param BaseAddress - Serial port register group base address\r
+ @param Offset - Offset in register group\r
+ @param Data - data which is to be written to some serial port register\r
+\r
+**/\r
VOID\r
IsaSerialWritePort (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINT32 Offset,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Use IsaIo protocol to write serial port\r
-\r
- Arguments:\r
-\r
- IsaIo - Pointer to EFI_ISA_IO_PROTOCOL instance\r
- BaseAddress - Serial port register group base address\r
- Offset - Offset in register group\r
- Data - data which is to be written to some serial port register\r
-\r
- Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
//\r
// Use IsaIo to access IO\r
//\r
STATIC UINTN mWaitForValueTimeOut = KEYBOARD_WAITFORVALUE_TIMEOUT;\r
\r
+/**\r
+ Read data register \r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+\r
+ @return return the value \r
+\r
+**/\r
STATIC\r
UINT8\r
KeyReadDataRegister (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
EFI_ISA_IO_PROTOCOL *IsaIo;\r
UINT8 Data;\r
return Data;\r
}\r
\r
+/**\r
+ Write data register\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Data value wanted to be written\r
+\r
+**/\r
STATIC\r
VOID\r
KeyWriteDataRegister (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - 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
EFI_ISA_IO_PROTOCOL *IsaIo;\r
\r
//\r
}\r
\r
+/**\r
+ Read status register\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+\r
+ @return value in status register\r
+\r
+**/\r
UINT8\r
KeyReadStatusRegister (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
EFI_ISA_IO_PROTOCOL *IsaIo;\r
UINT8 Data;\r
\r
}\r
\r
+/**\r
+ Write command register \r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Data The value wanted to be written\r
+\r
+**/\r
+\r
STATIC\r
VOID\r
KeyWriteCommandRegister (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - 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
EFI_ISA_IO_PROTOCOL *IsaIo;\r
\r
\r
}\r
\r
+/**\r
+ Display error message\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param ErrMsg Unicode string of error message\r
+ \r
+**/\r
STATIC\r
VOID\r
KeyboardError (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN CHAR16 *ErrMsg\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Display error message\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
-// GC_TODO: ConsoleIn - add argument and description to function comment\r
-// GC_TODO: ErrMsg - add argument and description to function comment\r
{\r
ConsoleIn->KeyboardErr = TRUE;\r
\r
//\r
}\r
\r
-VOID\r
-EFIAPI\r
-KeyboardTimerHandler (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Timer event handler: read a series of scancodes from 8042\r
and put them into memory scancode buffer.\r
it read as much scancodes to either fill\r
the memory buffer or empty the keyboard buffer.\r
It is registered as running under TPL_NOTIFY\r
\r
-Arguments:\r
-\r
- Event - The timer event\r
- Context - A KEYBOARD_CONSOLE_IN_DEV pointer\r
+ @param Event - The timer event\r
+ @param Context - A KEYBOARD_CONSOLE_IN_DEV pointer\r
\r
-Returns:\r
+**/\r
+VOID\r
+EFIAPI\r
+KeyboardTimerHandler (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
\r
---*/\r
{\r
UINT8 Data;\r
EFI_TPL OldTpl;\r
return ;\r
}\r
\r
+/**\r
+ Read several bytes from the scancode buffer without removing them.\r
+ This function is called to see if there are enough bytes of scancode\r
+ representing a single key.\r
+\r
+ @param Count - Number of bytes to be read\r
+ @param Buf - Store the results\r
+\r
+ @retval EFI_SUCCESS success to scan the keyboard code\r
+ @retval EFI_NOT_READY invalid parameter\r
+**/\r
STATIC\r
EFI_STATUS\r
GetScancodeBufHead (\r
IN UINT32 Count,\r
OUT UINT8 *Buf\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Read several bytes from the scancode buffer without removing them.\r
- This function is called to see if there are enough bytes of scancode\r
- representing a single key.\r
-\r
-Arguments:\r
-\r
- Count - Number of bytes to be read\r
- Buf - Store the results\r
-\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
-// GC_TODO: ConsoleIn - add argument and description to function comment\r
-// GC_TODO: EFI_NOT_READY - add return value to function comment\r
-// GC_TODO: EFI_SUCCESS - add return value to function comment\r
{\r
UINT32 Index;\r
UINT32 Pos;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+\r
+ Read & remove several bytes from the scancode buffer.\r
+ This function is usually called after GetScancodeBufHead()\r
+\r
+ @param Count - Number of bytes to be read\r
+ @param Buf - Store the results\r
+\r
+ @retval EFI_SUCCESS success to scan the keyboard code\r
+ @retval EFI_NOT_READY invalid parameter\r
+**/\r
STATIC\r
EFI_STATUS\r
PopScancodeBufHead (\r
IN UINT32 Count,\r
OUT UINT8 *Buf\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Read & remove several bytes from the scancode buffer.\r
- This function is usually called after GetScancodeBufHead()\r
-\r
-Arguments:\r
-\r
- Count - Number of bytes to be read\r
- Buf - Store the results\r
-\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
-// GC_TODO: ConsoleIn - add argument and description to function comment\r
-// GC_TODO: EFI_NOT_READY - add return value to function comment\r
-// GC_TODO: EFI_SUCCESS - add return value to function comment\r
{\r
UINT32 Index;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Read key value \r
+\r
+ @param ConsoleIn - Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Data - Pointer to outof buffer for keeping key value\r
+\r
+ @retval EFI_TIMEOUT Status resigter time out\r
+ @retval EFI_SUCCESS Success to read keyboard\r
+\r
+**/\r
EFI_STATUS\r
KeyboardRead (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
OUT UINT8 *Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
-\r
-Returns:\r
\r
- EFI_TIMEOUT - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
UINT32 TimeOut;\r
UINT32 RegFilled;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ write key to keyboard\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Data value wanted to be written\r
+\r
+ @retval EFI_TIMEOUT - GC_TODO: Add description for return value\r
+ @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
+\r
+**/\r
STATIC\r
EFI_STATUS\r
KeyboardWrite (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_TIMEOUT - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
UINT32 TimeOut;\r
UINT32 RegEmptied;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Issue keyboard command\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Data The buff holding the command \r
+\r
+ @retval EFI_TIMEOUT Keyboard is not ready to issuing \r
+ @retval EFI_SUCCESS Success to issue keyboard command\r
+\r
+**/\r
STATIC\r
EFI_STATUS\r
KeyboardCommand (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_TIMEOUT - GC_TODO: Add description for return value\r
- EFI_TIMEOUT - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
UINT32 TimeOut;\r
UINT32 RegEmptied;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ wait for a specific value to be presented on\r
+ 8042 Data register by keyboard and then read it,\r
+ used in keyboard commands ack\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Value the value wanted to be waited.\r
+\r
+ @retval EFI_TIMEOUT Fail to get specific value in given time\r
+ @retval EFI_SUCCESS Success to get specific value in given time.\r
+ \r
+**/\r
STATIC\r
EFI_STATUS\r
KeyboardWaitForValue (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN UINT8 Value\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- wait for a specific value to be presented on\r
- 8042 Data register by keyboard and then read it,\r
- used in keyboard commands ack\r
-\r
-Arguments:\r
-\r
- ConsoleIn - The KEYBOARD_CONSOLE_IN_DEV instance pointer\r
- Value - The value to be waited for\r
-\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
-// GC_TODO: EFI_SUCCESS - add return value to function comment\r
-// GC_TODO: EFI_TIMEOUT - add return value to function comment\r
{\r
UINT8 Data;\r
UINT32 TimeOut;\r
\r
}\r
\r
-EFI_STATUS\r
-UpdateStatusLights (\r
- IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Show keyboard status lights according to\r
indicators in ConsoleIn.\r
\r
-Arguments:\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ \r
+ @return status\r
\r
-Returns:\r
-\r
---*/\r
-// GC_TODO: ConsoleIn - add argument and description to function comment\r
+**/\r
+EFI_STATUS\r
+UpdateStatusLights (\r
+ IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
+ )\r
{\r
EFI_STATUS Status;\r
UINT8 Command;\r
return Status;\r
}\r
\r
-EFI_STATUS\r
-KeyGetchar (\r
- IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Get scancode from scancode buffer\r
and translate into EFI-scancode and unicode defined by EFI spec\r
The function is always called in TPL_NOTIFY\r
\r
-Arguments:\r
-\r
- ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer\r
+ @param ConsoleIn KEYBOARD_CONSOLE_IN_DEV instance pointer\r
\r
-Returns:\r
+ @retval EFI_NOT_READY - Input from console not ready yet.\r
+ @retval EFI_SUCCESS - Function executed successfully.\r
\r
- EFI_NOT_READY - Input from console not ready yet.\r
- EFI_SUCCESS - Function executed successfully.\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+KeyGetchar (\r
+ IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
+ )\r
{\r
EFI_STATUS Status;\r
UINT8 ScanCode;\r
return EFI_SUCCESS;\r
}\r
\r
-EFI_STATUS\r
-InitKeyboard (\r
- IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
- IN BOOLEAN ExtendedVerification\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Perform 8042 controller and keyboard Initialization\r
If ExtendedVerification is TRUE, do additional test for\r
the keyboard interface\r
\r
-Arguments:\r
-\r
- ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer\r
- ExtendedVerification - indicates a thorough initialization\r
+ @param ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer\r
+ @param ExtendedVerification - indicates a thorough initialization\r
\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
-// GC_TODO: EFI_SUCCESS - add return value to function comment\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
+ @retval EFI_DEVICE_ERROR Fail to init keyboard\r
+ @retval EFI_SUCCESS Success to init keyboard\r
+**/\r
+EFI_STATUS\r
+InitKeyboard (\r
+ IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
+ IN BOOLEAN ExtendedVerification\r
+ )\r
{\r
EFI_STATUS Status;\r
EFI_STATUS Status1;\r
\r
}\r
\r
-EFI_STATUS\r
-DisableKeyboard (\r
- IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Disable the keyboard interface of the 8042 controller\r
\r
-Arguments:\r
-\r
- ConsoleIn - the device instance\r
-\r
-Returns:\r
+ @param ConsoleIn - the device instance\r
\r
- EFI_STATUS\r
+ @return status of issuing disable command\r
\r
---*/\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
+**/\r
+EFI_STATUS\r
+DisableKeyboard (\r
+ IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
+ )\r
{\r
EFI_STATUS Status;\r
\r
\r
return TRUE;\r
}\r
+\r
IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This\r
);\r
\r
+/**\r
+ @param RegsiteredData - A pointer to a buffer that is filled in with the keystroke \r
+ state data for the key that was registered.\r
+ @param InputData - A pointer to a buffer that is filled in with the keystroke \r
+ state data for the key that was pressed.\r
+\r
+ @retval TRUE - Key be pressed matches a registered key.\r
+ @retval FALSE - Match failed. \r
+ \r
+**/\r
STATIC\r
BOOLEAN\r
IsKeyRegistered (\r
IN EFI_KEY_DATA *RegsiteredData,\r
IN EFI_KEY_DATA *InputData\r
)\r
-/*++\r
-\r
-Routine Description:\r
+;\r
\r
-Arguments:\r
+/**\r
+ Reads the next keystroke from the input device. The WaitForKey Event can \r
+ be used to test for existance of a keystroke via WaitForEvent () call.\r
\r
- RegsiteredData - A pointer to a buffer that is filled in with the keystroke \r
- state data for the key that was registered.\r
- InputData - A pointer to a buffer that is filled in with the keystroke \r
- state data for the key that was pressed.\r
+ \r
+ @param ConsoleInDev - Ps2 Keyboard private structure\r
+ @param KeyData - A pointer to a buffer that is filled in with the keystroke \r
+ state data for the key that was pressed.\r
\r
-Returns:\r
- TRUE - Key be pressed matches a registered key.\r
- FLASE - Match failed. \r
\r
---*/\r
-;\r
+ @retval EFI_SUCCESS - The keystroke information was returned.\r
+ @retval EFI_NOT_READY - There was no keystroke data availiable.\r
+ @retval EFI_DEVICE_ERROR - The keystroke information was not returned due to \r
+ hardware errors.\r
+ @retval EFI_INVALID_PARAMETER - KeyData is NULL. \r
+\r
+**/\r
STATIC\r
EFI_STATUS\r
KeyboardReadKeyStrokeWorker (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleInDev,\r
OUT EFI_KEY_DATA *KeyData\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Reads the next keystroke from the input device. The WaitForKey Event can \r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
-\r
- Arguments:\r
- ConsoleInDev - Ps2 Keyboard private structure\r
- KeyData - A pointer to a buffer that is filled in with the keystroke \r
- state data for the key that was pressed.\r
-\r
- Returns:\r
- EFI_SUCCESS - The keystroke information was returned.\r
- EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keystroke information was not returned due to \r
- hardware errors.\r
- EFI_INVALID_PARAMETER - KeyData is NULL. \r
\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_TPL OldTpl;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ logic reset keyboard\r
+ Implement SIMPLE_TEXT_IN.Reset()\r
+ Perform 8042 controller and keyboard initialization\r
+\r
+ @param This Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r
+ @param ExtendedVerification Indicate that the driver may perform a more \r
+ exhaustive verification operation of the device during \r
+ reset, now this par is ignored in this driver \r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardEfiReset (\r
IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Implement SIMPLE_TEXT_IN.Reset()\r
- Perform 8042 controller and keyboard initialization\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
-// GC_TODO: This - add argument and description to function comment\r
-// GC_TODO: ExtendedVerification - add argument and description to function comment\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
-// GC_TODO: EFI_SUCCESS - add return value to function comment\r
{\r
EFI_STATUS Status;\r
KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Implement SIMPLE_TEXT_IN.ReadKeyStroke().\r
+ Retrieve key values for driver user.\r
+\r
+ @param This Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r
+ @param Key The output buffer for key value \r
+\r
+ @retval EFI_SUCCESS success to read key stroke\r
+**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardReadKeyStroke (\r
IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
OUT EFI_INPUT_KEY *Key\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Implement SIMPLE_TEXT_IN.ReadKeyStroke().\r
- Retrieve key values for driver user.\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
-// GC_TODO: This - add argument and description to function comment\r
-// GC_TODO: Key - add argument and description to function comment\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
-// GC_TODO: EFI_NOT_READY - add return value to function comment\r
-// GC_TODO: EFI_SUCCESS - add return value to function comment\r
{\r
EFI_STATUS Status;\r
KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;\r
\r
}\r
\r
+/**\r
+ Event notification function for SIMPLE_TEXT_IN.WaitForKey event\r
+ Signal the event if there is key available\r
+\r
+ @param Event the event object\r
+ @param Context waitting context\r
+\r
+**/\r
VOID\r
EFIAPI\r
KeyboardWaitForKey (\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Event notification function for SIMPLE_TEXT_IN.WaitForKey event\r
- Signal the event if there is key available\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
-// GC_TODO: Event - add argument and description to function comment\r
-// GC_TODO: Context - add argument and description to function comment\r
{\r
EFI_TPL OldTpl;\r
KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;\r
return ;\r
}\r
\r
+/**\r
+ Check keyboard for given key value\r
+ \r
+ @param This Point to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r
+ \r
+ @retval EFI_SUCCESS success check keyboard value\r
+**/\r
EFI_STATUS\r
KeyboardCheckForKey (\r
IN EFI_SIMPLE_TEXT_INPUT_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
KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Judge whether is a registed key\r
+\r
+ @param RegsiteredData - A pointer to a buffer that is filled in with the keystroke \r
+ state data for the key that was registered.\r
+ @param InputData - A pointer to a buffer that is filled in with the keystroke \r
+ state data for the key that was pressed.\r
+\r
+ @retval TRUE - Key be pressed matches a registered key.\r
+ @retval FLASE - Match failed. \r
+ \r
+**/\r
STATIC\r
BOOLEAN\r
IsKeyRegistered (\r
IN EFI_KEY_DATA *RegsiteredData,\r
IN EFI_KEY_DATA *InputData\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
- RegsiteredData - A pointer to a buffer that is filled in with the keystroke \r
- state data for the key that was registered.\r
- InputData - A pointer to a buffer that is filled in with the keystroke \r
- state data for the key that was pressed.\r
\r
-Returns:\r
- TRUE - Key be pressed matches a registered key.\r
- FLASE - Match failed. \r
- \r
---*/\r
{\r
ASSERT (RegsiteredData != NULL && InputData != NULL);\r
\r
\r
}\r
\r
+/**\r
+ Event notification function for SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event\r
+ Signal the event if there is key available\r
+\r
+ @param Event event object\r
+ @param Context waiting context\r
+\r
+**/\r
VOID\r
EFIAPI\r
KeyboardWaitForKeyEx (\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
-\r
-Routine Description:\r
\r
- Event notification function for SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event\r
- Signal the event if there is key available\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
{\r
KEYBOARD_CONSOLE_IN_DEV *ConsoleInDev;\r
\r
\r
}\r
\r
+/**\r
+ Reset the input device and optionaly run diagnostics\r
+\r
+ @param This - Protocol instance pointer.\r
+ @param ExtendedVerification - Driver may perform diagnostics on reset.\r
+\r
+ @retval EFI_SUCCESS - The device was reset.\r
+ @retval EFI_DEVICE_ERROR - The device is not functioning properly and could \r
+ not be reset.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardEfiResetEx (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Reset the input device and optionaly run diagnostics\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ExtendedVerification - Driver may perform diagnostics on reset.\r
\r
- Returns:\r
- EFI_SUCCESS - The device was reset.\r
- EFI_DEVICE_ERROR - The device is not functioning properly and could \r
- not be reset.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
KEYBOARD_CONSOLE_IN_DEV *ConsoleInDev;\r
return EFI_SUCCESS;\r
}\r
\r
-EFI_STATUS\r
-EFIAPI\r
-KeyboardReadKeyStrokeEx (\r
- IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
- OUT EFI_KEY_DATA *KeyData\r
- )\r
-/*++\r
-\r
- Routine Description:\r
+/**\r
Reads the next keystroke from the input device. The WaitForKey Event can \r
be used to test for existance of a keystroke via WaitForEvent () call.\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke \r
+\r
+ @param This - Protocol instance pointer.\r
+ @param KeyData - A pointer to a buffer that is filled in with the keystroke \r
state data for the key that was pressed.\r
\r
- Returns:\r
- EFI_SUCCESS - The keystroke information was returned.\r
- EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keystroke information was not returned due to \r
+ @retval EFI_SUCCESS - The keystroke information was returned.\r
+ @retval EFI_NOT_READY - There was no keystroke data availiable.\r
+ @retval EFI_DEVICE_ERROR - The keystroke information was not returned due to \r
hardware errors.\r
- EFI_INVALID_PARAMETER - KeyData is NULL. \r
+ @retval EFI_INVALID_PARAMETER - KeyData is NULL. \r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+KeyboardReadKeyStrokeEx (\r
+ IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
+ OUT EFI_KEY_DATA *KeyData\r
+ )\r
\r
---*/\r
{\r
KEYBOARD_CONSOLE_IN_DEV *ConsoleInDev;\r
\r
\r
}\r
\r
+/**\r
+ Set certain state for the input device.\r
+\r
+ @param This - Protocol instance pointer.\r
+ @param KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the \r
+ state for the input device.\r
+\r
+ @retval EFI_SUCCESS - The device state was set successfully.\r
+ @retval EFI_DEVICE_ERROR - The device is not functioning correctly and could \r
+ not have the setting adjusted.\r
+ @retval EFI_UNSUPPORTED - The device does not have the ability to set its state.\r
+ @retval EFI_INVALID_PARAMETER - KeyToggleState is NULL. \r
+\r
+**/ \r
EFI_STATUS\r
EFIAPI\r
KeyboardSetState (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN EFI_KEY_TOGGLE_STATE *KeyToggleState\r
)\r
-/*++\r
\r
- Routine Description:\r
- Set certain state for the input device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the \r
- state for the input device.\r
-\r
- Returns:\r
- EFI_SUCCESS - The device state was set successfully.\r
- EFI_DEVICE_ERROR - The device is not functioning correctly and could \r
- not have the setting adjusted.\r
- EFI_UNSUPPORTED - The device does not have the ability to set its state.\r
- EFI_INVALID_PARAMETER - KeyToggleState is NULL. \r
-\r
---*/ \r
{\r
EFI_STATUS Status;\r
KEYBOARD_CONSOLE_IN_DEV *ConsoleInDev;\r
return Status;\r
\r
}\r
+\r
+/**\r
+ Register a notification function for a particular keystroke for the input device.\r
+\r
+ @param This - Protocol instance pointer.\r
+ @param KeyData - A pointer to a buffer that is filled in with the keystroke \r
+ information data for the key that was pressed.\r
+ @param KeyNotificationFunction - Points to the function to be called when the key \r
+ sequence is typed specified by KeyData. \r
+ @param NotifyHandle - Points to the unique handle assigned to the registered notification. \r
+\r
+ @retval EFI_SUCCESS - The notification function was registered successfully.\r
+ @retval EFI_OUT_OF_RESOURCES - Unable to allocate resources for necesssary data structures.\r
+ @retval EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL. \r
+ \r
+**/ \r
EFI_STATUS\r
EFIAPI\r
KeyboardRegisterKeyNotify (\r
IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r
OUT EFI_HANDLE *NotifyHandle\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Register a notification function for a particular keystroke for the input device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke \r
- information data for the key that was pressed.\r
- KeyNotificationFunction - Points to the function to be called when the key \r
- sequence is typed specified by KeyData. \r
- NotifyHandle - Points to the unique handle assigned to the registered notification. \r
-\r
- Returns:\r
- EFI_SUCCESS - The notification function was registered successfully.\r
- EFI_OUT_OF_RESOURCES - Unable to allocate resources for necesssary data structures.\r
- EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL. \r
- \r
---*/ \r
{\r
EFI_STATUS Status;\r
KEYBOARD_CONSOLE_IN_DEV *ConsoleInDev;\r
\r
}\r
\r
+/**\r
+ Remove a registered notification function from a particular keystroke.\r
+\r
+ @param This - Protocol instance pointer. \r
+ @param NotificationHandle - The handle of the notification function being unregistered.\r
+\r
+ \r
+ @retval EFI_SUCCESS - The notification function was unregistered successfully.\r
+ @retval EFI_INVALID_PARAMETER - The NotificationHandle is invalid.\r
+ @retval EFI_NOT_FOUND - Can not find the matching entry in database. \r
+ \r
+**/ \r
EFI_STATUS\r
EFIAPI\r
KeyboardUnregisterKeyNotify (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN EFI_HANDLE NotificationHandle\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Remove a registered notification function from a particular keystroke.\r
-\r
- Arguments:\r
- This - Protocol instance pointer. \r
- NotificationHandle - The handle of the notification function being unregistered.\r
-\r
- Returns:\r
- EFI_SUCCESS - The notification function was unregistered successfully.\r
- EFI_INVALID_PARAMETER - The NotificationHandle is invalid.\r
- EFI_NOT_FOUND - Can not find the matching entry in database. \r
- \r
---*/ \r
{\r
EFI_STATUS Status;\r
KEYBOARD_CONSOLE_IN_DEV *ConsoleInDev;\r
NULL\r
};\r
\r
+/**\r
+ Test controller is a keyboard Controller\r
+ \r
+ @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
+ @param Controller driver's controller\r
+ @param RemainingDevicePath children device path\r
+ \r
+ @retval EFI_UNSUPPORTED controller is not floppy disk\r
+ @retval EFI_SUCCESS controller is floppy disk\r
+**/\r
EFI_STATUS\r
EFIAPI\r
KbdControllerDriverSupported (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- ControllerDriver Protocol Method\r
-\r
-Arguments:\r
-\r
-Returns:\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_ISA_IO_PROTOCOL *IsaIo;\r
return Status;\r
}\r
\r
+/**\r
+ Create KEYBOARD_CONSOLE_IN_DEV instance on controller.\r
+ \r
+ @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
+ @param Controller driver controller handle\r
+ @param RemainingDevicePath Children's device path\r
+ \r
+ @retval whether success to create floppy control instance.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
KbdControllerDriverStart (\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
---*/\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_INVALID_PARAMETER - add return value to function comment\r
{\r
EFI_STATUS Status;\r
EFI_STATUS Status1;\r
return Status;\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
KbdControllerDriverStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Arguments:\r
-\r
- Returns:\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_INPUT_PROTOCOL *ConIn;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Free the waiting key notify list.\r
+ \r
+ @param ListHead Pointer to list head\r
+**/\r
STATIC\r
EFI_STATUS\r
KbdFreeNotifyList (\r
IN OUT LIST_ENTRY *ListHead\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
- ListHead - The list head\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - Free the notify list successfully\r
- EFI_INVALID_PARAMETER - ListHead is invalid.\r
-\r
---*/\r
{\r
KEYBOARD_CONSOLE_IN_EX_NOTIFY *NotifyNode;\r
\r
\r
return Status;\r
}\r
+\r
//\r
// Driver entry point\r
//\r
+/**\r
+ The user Entry Point for module Ps2Keyboard. The user code starts with this function.\r
+\r
+ @param[in] ImageHandle The firmware allocated handle for the EFI image. \r
+ @param[in] SystemTable A pointer to the EFI System Table.\r
+ \r
+ @retval EFI_SUCCESS The entry point is executed successfully.\r
+ @retval other Some error occurs when executing this entry point.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
InstallPs2KeyboardDriver (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ImageHandle - GC_TODO: add argument description\r
- SystemTable - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
#define KEYBOARD_8042_DATA_REGISTER 0x60\r
//\r
// Other functions that are used among .c files\r
//\r
+/**\r
+ Show keyboard status lights according to\r
+ indicators in ConsoleIn.\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ \r
+ @return status\r
\r
+**/\r
EFI_STATUS\r
UpdateStatusLights (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Show keyboard status light for ScrollLock, NumLock and CapsLock\r
- according to indicators in ConsoleIn.\r
-\r
-Arguments:\r
-\r
- ConsoleIn - driver private structure\r
+;\r
\r
-Returns:\r
+/**\r
+ write key to keyboard\r
\r
- EFI_SUCCESS - Show the status light successfully.\r
- EFI_TIMEOUT - Timeout when operating read/write on registers.\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Data value wanted to be written\r
\r
---*/ \r
-;\r
+ @retval EFI_TIMEOUT - GC_TODO: Add description for return value\r
+ @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
+**/\r
EFI_STATUS\r
KeyboardRead (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
OUT UINT8 *Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
+;\r
\r
- ConsoleIn - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
+/**\r
+ Get scancode from scancode buffer\r
+ and translate into EFI-scancode and unicode defined by EFI spec\r
+ The function is always called in TPL_NOTIFY\r
\r
-Returns:\r
+ @param ConsoleIn KEYBOARD_CONSOLE_IN_DEV instance pointer\r
\r
- GC_TODO: add return values\r
-\r
---*/\r
-;\r
+ @retval EFI_NOT_READY - Input from console not ready yet.\r
+ @retval EFI_SUCCESS - Function executed successfully.\r
\r
+**/\r
EFI_STATUS\r
KeyGetchar (\r
IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\r
+/**\r
+ Perform 8042 controller and keyboard Initialization\r
+ If ExtendedVerification is TRUE, do additional test for\r
+ the keyboard interface\r
\r
---*/\r
-;\r
+ @param ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer\r
+ @param ExtendedVerification - indicates a thorough initialization\r
\r
+ @retval EFI_DEVICE_ERROR Fail to init keyboard\r
+ @retval EFI_SUCCESS Success to init keyboard\r
+**/\r
EFI_STATUS\r
InitKeyboard (\r
IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
- ExtendedVerification - GC_TODO: add argument description\r
+;\r
\r
-Returns:\r
+/**\r
+ Disable the keyboard interface of the 8042 controller\r
\r
- GC_TODO: add return values\r
+ @param ConsoleIn - the device instance\r
\r
---*/\r
-;\r
+ @return status of issuing disable command\r
\r
+**/\r
EFI_STATUS\r
DisableKeyboard (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\r
+/**\r
+ Timer event handler: read a series of scancodes from 8042\r
+ and put them into memory scancode buffer.\r
+ it read as much scancodes to either fill\r
+ the memory buffer or empty the keyboard buffer.\r
+ It is registered as running under TPL_NOTIFY\r
\r
---*/\r
-;\r
+ @param Event - The timer event\r
+ @param Context - A KEYBOARD_CONSOLE_IN_DEV pointer\r
\r
+**/\r
VOID\r
EFIAPI\r
KeyboardTimerHandler (\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- Event - GC_TODO: add argument description\r
- Context - GC_TODO: add argument description\r
+;\r
\r
-Returns:\r
+/**\r
+ logic reset keyboard\r
+ Implement SIMPLE_TEXT_IN.Reset()\r
+ Perform 8042 controller and keyboard initialization\r
\r
- GC_TODO: add return values\r
-\r
---*/\r
-;\r
+ @param This Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r
+ @param ExtendedVerification Indicate that the driver may perform a more \r
+ exhaustive verification operation of the device during \r
+ reset, now this par is ignored in this driver \r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardEfiReset (\r
IN EFI_SIMPLE_TEXT_INPUT_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
\r
- GC_TODO: add return values\r
+/**\r
+ Implement SIMPLE_TEXT_IN.ReadKeyStroke().\r
+ Retrieve key values for driver user.\r
\r
---*/\r
-;\r
+ @param This Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r
+ @param Key The output buffer for key value \r
\r
+ @retval EFI_SUCCESS success to read key stroke\r
+**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardReadKeyStroke (\r
IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
OUT EFI_INPUT_KEY *Key\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
- Key - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\r
+/**\r
+ Event notification function for SIMPLE_TEXT_IN.WaitForKey event\r
+ Signal the event if there is key available\r
\r
---*/\r
-;\r
+ @param Event the event object\r
+ @param Context waitting context\r
\r
+**/\r
VOID\r
EFIAPI\r
KeyboardWaitForKey (\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- Event - GC_TODO: add argument description\r
- Context - GC_TODO: add argument description\r
+;\r
\r
-Returns:\r
+/**\r
+ Read status register\r
\r
- GC_TODO: add return values\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
\r
---*/\r
-;\r
+ @return value in status register\r
\r
+**/\r
UINT8\r
KeyReadStatusRegister (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
/**\r
)\r
;\r
\r
+/**\r
+ Event notification function for SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event\r
+ Signal the event if there is key available\r
+\r
+ @param Event event object\r
+ @param Context waiting context\r
+\r
+**/\r
VOID\r
EFIAPI\r
KeyboardWaitForKeyEx (\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Event notification function for SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event\r
- Signal the event if there is key available\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/ \r
; \r
\r
//\r
// Simple Text Input Ex protocol function prototypes\r
//\r
\r
+/**\r
+ Reset the input device and optionaly run diagnostics\r
+\r
+ @param This - Protocol instance pointer.\r
+ @param ExtendedVerification - Driver may perform diagnostics on reset.\r
+\r
+ @retval EFI_SUCCESS - The device was reset.\r
+ @retval EFI_DEVICE_ERROR - The device is not functioning properly and could \r
+ not be reset.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardEfiResetEx (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
+;\r
\r
- Routine Description:\r
- Reset the input device and optionaly run diagnostics\r
+/**\r
+ Reads the next keystroke from the input device. The WaitForKey Event can \r
+ be used to test for existance of a keystroke via WaitForEvent () call.\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ExtendedVerification - Driver may perform diagnostics on reset.\r
\r
- Returns:\r
- EFI_SUCCESS - The device was reset.\r
- EFI_DEVICE_ERROR - The device is not functioning properly and could \r
- not be reset.\r
+ @param This - Protocol instance pointer.\r
+ @param KeyData - A pointer to a buffer that is filled in with the keystroke \r
+ state data for the key that was pressed.\r
\r
---*/\r
-;\r
+ @retval EFI_SUCCESS - The keystroke information was returned.\r
+ @retval EFI_NOT_READY - There was no keystroke data availiable.\r
+ @retval EFI_DEVICE_ERROR - The keystroke information was not returned due to \r
+ hardware errors.\r
+ @retval EFI_INVALID_PARAMETER - KeyData is NULL. \r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardReadKeyStrokeEx (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
OUT EFI_KEY_DATA *KeyData\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Reads the next keystroke from the input device. The WaitForKey Event can \r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
+;\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke \r
- state data for the key that was pressed.\r
+/**\r
+ Set certain state for the input device.\r
\r
- Returns:\r
- EFI_SUCCESS - The keystroke information was returned.\r
- EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keystroke information was not returned due to \r
- hardware errors.\r
- EFI_INVALID_PARAMETER - KeyData is NULL. \r
+ @param This - Protocol instance pointer.\r
+ @param KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the \r
+ state for the input device.\r
\r
---*/\r
-;\r
+ @retval EFI_SUCCESS - The device state was set successfully.\r
+ @retval EFI_DEVICE_ERROR - The device is not functioning correctly and could \r
+ not have the setting adjusted.\r
+ @retval EFI_UNSUPPORTED - The device does not have the ability to set its state.\r
+ @retval EFI_INVALID_PARAMETER - KeyToggleState is NULL. \r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
KeyboardSetState (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN EFI_KEY_TOGGLE_STATE *KeyToggleState\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Set certain state for the input device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the \r
- state for the input device.\r
- \r
- Returns: \r
- EFI_SUCCESS - The device state was set successfully.\r
- EFI_DEVICE_ERROR - The device is not functioning correctly and could \r
- not have the setting adjusted.\r
- EFI_UNSUPPORTED - The device does not have the ability to set its state.\r
- EFI_INVALID_PARAMETER - KeyToggleState is NULL. \r
-\r
---*/ \r
;\r
\r
+/**\r
+ Register a notification function for a particular keystroke for the input device.\r
+\r
+ @param This - Protocol instance pointer.\r
+ @param KeyData - A pointer to a buffer that is filled in with the keystroke \r
+ information data for the key that was pressed.\r
+ @param KeyNotificationFunction - Points to the function to be called when the key \r
+ sequence is typed specified by KeyData. \r
+ @param NotifyHandle - Points to the unique handle assigned to the registered notification. \r
+\r
+ @retval EFI_SUCCESS - The notification function was registered successfully.\r
+ @retval EFI_OUT_OF_RESOURCES - Unable to allocate resources for necesssary data structures.\r
+ @retval EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL. \r
+ \r
+**/ \r
EFI_STATUS\r
EFIAPI\r
KeyboardRegisterKeyNotify (\r
IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r
OUT EFI_HANDLE *NotifyHandle\r
)\r
-/*++\r
+;\r
\r
- Routine Description:\r
- Register a notification function for a particular keystroke for the input device.\r
+/**\r
+ Remove a registered notification function from a particular keystroke.\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke \r
- information data for the key that was pressed.\r
- KeyNotificationFunction - Points to the function to be called when the key \r
- sequence is typed specified by KeyData. \r
- NotifyHandle - Points to the unique handle assigned to the registered notification. \r
+ @param This - Protocol instance pointer. \r
+ @param NotificationHandle - The handle of the notification function being unregistered.\r
\r
- Returns:\r
- EFI_SUCCESS - The notification function was registered successfully.\r
- EFI_OUT_OF_RESOURCES - Unable to allocate resources for necesssary data structures.\r
- EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL. \r
+ \r
+ @retval EFI_SUCCESS - The notification function was unregistered successfully.\r
+ @retval EFI_INVALID_PARAMETER - The NotificationHandle is invalid.\r
+ @retval EFI_NOT_FOUND - Can not find the matching entry in database. \r
\r
---*/ \r
-;\r
-\r
+**/ \r
EFI_STATUS\r
EFIAPI\r
KeyboardUnregisterKeyNotify (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN EFI_HANDLE NotificationHandle\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Remove a registered notification function from a particular keystroke.\r
-\r
- Arguments:\r
- This - Protocol instance pointer. \r
- NotificationHandle - The handle of the notification function being unregistered.\r
-\r
- Returns:\r
- EFI_SUCCESS - The notification function was unregistered successfully.\r
- EFI_INVALID_PARAMETER - The NotificationHandle is invalid.\r
- EFI_NOT_FOUND - Can not find the matching entry in database. \r
- \r
---*/ \r
;\r
\r
#endif\r
\r
UINT8 ResolutionTbl[MAX_CMR] = { 0, 1, 2, 3 };\r
\r
+/**\r
+ Issue self test command via IsaIo interface.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return EFI_SUCCESS Success to do keyboard self testing.\r
+ @return others Fail to do keyboard self testing.\r
+**/\r
EFI_STATUS\r
KbcSelfTest (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_DEVICE_ERROR - 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
UINT8 Data;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Issue command to enable keyboard AUX functionality.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
KbcEnableAux (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
//\r
// Send 8042 enable mouse command\r
return Out8042Command (IsaIo, ENABLE_AUX);\r
}\r
\r
+/**\r
+ Issue command to disable keyboard AUX functionality.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
KbcDisableAux (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
//\r
// Send 8042 disable mouse command\r
return Out8042Command (IsaIo, DISABLE_AUX);\r
}\r
\r
+/**\r
+ Issue command to enable keyboard.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
KbcEnableKb (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
//\r
// Send 8042 enable keyboard command\r
return Out8042Command (IsaIo, ENABLE_KB);\r
}\r
\r
+/**\r
+ Issue command to disable keyboard.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
KbcDisableKb (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
//\r
// Send 8042 disable keyboard command\r
return Out8042Command (IsaIo, DISABLE_KB);\r
}\r
\r
+/**\r
+ Issue command to check keyboard status.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param KeyboardEnable return whether keyboard is enable.\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
CheckKbStatus (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
OUT BOOLEAN *KeyboardEnable\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- KeyboardEnable - 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
UINT8 Data;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Issue command to reset keyboard.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
PS2MouseReset (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
- EFI_DEVICE_ERROR - 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
UINT8 Data;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Issue command to set mouse's sample rate\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param SampleRate value of sample rate \r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
PS2MouseSetSampleRate (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN MOUSE_SR SampleRate\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- SampleRate - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
return Status;\r
}\r
\r
+/**\r
+ Issue command to set mouse's resolution.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Resolution value of resolution\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
PS2MouseSetResolution (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN MOUSE_RE Resolution\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- Resolution - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
return Status;\r
}\r
\r
+/**\r
+ Issue command to set mouse's scaling.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Scaling value of scaling\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
PS2MouseSetScaling (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN MOUSE_SF Scaling\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- Scaling - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
UINT8 Command;\r
\r
return Out8042AuxCommand (IsaIo, Command, FALSE);\r
}\r
\r
+/**\r
+ Issue command to enable Ps2 mouse.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
PS2MouseEnable (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
//\r
// Send auxiliary command to enable mouse\r
return Out8042AuxCommand (IsaIo, ENABLE_CMD, FALSE);\r
}\r
\r
-EFI_STATUS\r
-PS2MouseGetPacket (\r
- PS2_MOUSE_ABSOLUTE_POINTER_DEV *MouseAbsolutePointerDev\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Get mouse packet . Only care first 3 bytes\r
\r
-Arguments:\r
+ @param MouseDev Pointer of PS2 Mouse Private Data Structure \r
\r
- MouseDev - Pointer of PS2 Mouse Private Data Structure \r
+ @retval EFI_NOT_READY Mouse Device not ready to input data packet, or some error happened during getting the packet\r
+ @retval EFI_SUCCESS The data packet is gotten successfully.\r
\r
-Returns:\r
-\r
- EFI_NOT_READY - Mouse Device not ready to input data packet, or some error happened during getting the packet\r
- EFI_SUCCESS - The data packet is gotten successfully.\r
+**/\r
+EFI_STATUS\r
+PS2MouseGetPacket (\r
+ PS2_MOUSE_ABSOLUTE_POINTER_DEV *MouseAbsolutePointerDev\r
+ )\r
\r
---*/\r
{\r
EFI_STATUS Status;\r
BOOLEAN KeyboardEnable;\r
}\r
}\r
\r
+/**\r
+ Read data via IsaIo protocol with given number.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Buffer Buffer receive data of mouse\r
+ @param BufSize The size of buffer\r
+ @param State Check input or read data\r
+ \r
+ @return status of reading mouse data.\r
+**/\r
EFI_STATUS\r
PS2MouseRead (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN OUT UINTN *BufSize,\r
IN UINTN State\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- Buffer - GC_TODO: add argument description\r
- BufSize - GC_TODO: add argument description\r
- State - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
UINTN BytesRead;\r
*BufSize = BytesRead;\r
return Status;\r
}\r
+\r
//\r
// 8042 I/O function\r
//\r
+/**\r
+ I/O work flow of outing 8042 command.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Command I/O command.\r
+ \r
+ @retval EFI_SUCCESS Success to excute I/O work flow\r
+ @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
EFI_STATUS\r
Out8042Command (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINT8 Command\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- Command - 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
UINT8 Data;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ I/O work flow of outing 8042 data.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Data Data value\r
+ \r
+ @retval EFI_SUCCESS Success to excute I/O work flow\r
+ @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
EFI_STATUS\r
Out8042Data (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- Data - 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
UINT8 temp;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ I/O work flow of in 8042 data.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Data Data value\r
+ \r
+ @retval EFI_SUCCESS Success to excute I/O work flow\r
+ @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
EFI_STATUS\r
In8042Data (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN OUT UINT8 *Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_TIMEOUT - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
UINTN Delay;\r
UINT8 temp;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ I/O work flow of outing 8042 Aux command.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Command Aux I/O command\r
+ @param Resend Whether need resend the Aux command.\r
+ \r
+ @retval EFI_SUCCESS Success to excute I/O work flow\r
+ @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
EFI_STATUS\r
Out8042AuxCommand (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINT8 Command,\r
IN BOOLEAN Resend\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- Command - GC_TODO: add argument description\r
- Resend - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
- EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
- EFI_DEVICE_ERROR - 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
UINT8 Data;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ I/O work flow of outing 8042 Aux data.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Command Aux I/O command\r
+ \r
+ @retval EFI_SUCCESS Success to excute I/O work flow\r
+ @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
EFI_STATUS\r
Out8042AuxData (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- Data - 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
UINT8 Temp;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ I/O work flow of in 8042 Aux data.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Data Buffer holding return value.\r
+ \r
+ @retval EFI_SUCCESS Success to excute I/O work flow\r
+ @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
EFI_STATUS\r
In8042AuxData (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN OUT UINT8 *Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- Data - 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
\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ Check keyboard controller status, if it is output buffer full and for auxiliary device\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @retval EFI_SUCCESS Keyboard controller is ready\r
+ @retval EFI_NOT_READY Keyboard controller is not ready\r
+**/\r
EFI_STATUS\r
CheckForInput (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_NOT_READY - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
UINT8 Data;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ I/O work flow to wait input buffer empty in given time.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Timeout Wating time.\r
+ \r
+ @retval EFI_TIMEOUT if input is still not empty in given time.\r
+ @retval EFI_SUCCESS input is empty.\r
+**/\r
EFI_STATUS\r
WaitInputEmpty (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINTN Timeout\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- Timeout - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_TIMEOUT - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
UINTN Delay;\r
UINT8 Data;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ I/O work flow to wait output buffer full in given time.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Timeout given time\r
+ \r
+ @retval EFI_TIMEOUT output is not full in given time\r
+ @retval EFI_SUCCESS output is full in given time.\r
+**/\r
EFI_STATUS\r
WaitOutputFull (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINTN Timeout\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_TIMEOUT - GC_TODO: Add description for return value\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
UINTN Delay;\r
UINT8 Data;\r
\r
return EFI_SUCCESS;\r
}\r
+\r
/**@file\r
PS2 Mouse Communication Interface \r
-\r
\r
Copyright (c) 2006 - 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
// 0 - output buffer empty\r
// 1 - keyboard controller data in output buffer\r
//\r
+\r
+/**\r
+ Issue self test command via IsaIo interface.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return EFI_SUCCESS Success to do keyboard self testing.\r
+ @return others Fail to do keyboard self testing.\r
+**/\r
EFI_STATUS\r
KbcSelfTest (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Issue command to enable keyboard AUX functionality.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
KbcEnableAux (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Issue command to disable keyboard AUX functionality.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
KbcDisableAux (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Issue command to enable keyboard.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
KbcEnableKb (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Issue command to disable keyboard.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
KbcDisableKb (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Issue command to check keyboard status.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param KeyboardEnable return whether keyboard is enable.\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
CheckKbStatus (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
OUT BOOLEAN *KeyboardEnable\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- KeyboardEnable - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Issue command to reset keyboard.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
PS2MouseReset (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Issue command to set mouse's sample rate\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param SampleRate value of sample rate \r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
PS2MouseSetSampleRate (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN MOUSE_SR SampleRate\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- SampleRate - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Issue command to set mouse's resolution.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Resolution value of resolution\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
PS2MouseSetResolution (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN MOUSE_RE Resolution\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- Resolution - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Issue command to set mouse's scaling.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Scaling value of scaling\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
PS2MouseSetScaling (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN MOUSE_SF Scaling\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
- Scaling - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Issue command to enable Ps2 mouse.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @return Status of command issuing.\r
+**/\r
EFI_STATUS\r
PS2MouseEnable (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- IsaIo - GC_TODO: add argument description\r
+;\r
\r
-Returns:\r
+/**\r
+ Get mouse packet . Only care first 3 bytes\r
\r
- GC_TODO: add return values\r
+ @param MouseDev Pointer of PS2 Mouse Private Data Structure \r
\r
---*/\r
-;\r
+ @retval EFI_NOT_READY Mouse Device not ready to input data packet, or some error happened during getting the packet\r
+ @retval EFI_SUCCESS The data packet is gotten successfully.\r
\r
+**/\r
EFI_STATUS\r
PS2MouseGetPacket (\r
PS2_MOUSE_ABSOLUTE_POINTER_DEV *MouseAbsolutePointerDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- MouseDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Read data via IsaIo protocol with given number.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Buffer Buffer receive data of mouse\r
+ @param BufSize The size of buffer\r
+ @param State Check input or read data\r
+ \r
+ @return status of reading mouse data.\r
+**/\r
EFI_STATUS\r
PS2MouseRead (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
//\r
// 8042 I/O function\r
//\r
+/**\r
+ I/O work flow of outing 8042 command.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Command I/O command.\r
+ \r
+ @retval EFI_SUCCESS Success to excute I/O work flow\r
+ @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
EFI_STATUS\r
Out8042Command (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINT8 Command\r
);\r
\r
+/**\r
+ I/O work flow of in 8042 data.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Data Data value\r
+ \r
+ @retval EFI_SUCCESS Success to excute I/O work flow\r
+ @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
EFI_STATUS\r
In8042Data (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN OUT UINT8 *Data\r
);\r
\r
+/**\r
+ I/O work flow of outing 8042 data.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Data Data value\r
+ \r
+ @retval EFI_SUCCESS Success to excute I/O work flow\r
+ @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
EFI_STATUS\r
Out8042Data (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINT8 Data\r
);\r
\r
+/**\r
+ I/O work flow of outing 8042 Aux command.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Command Aux I/O command\r
+ @param Resend Whether need resend the Aux command.\r
+ \r
+ @retval EFI_SUCCESS Success to excute I/O work flow\r
+ @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
EFI_STATUS\r
Out8042AuxCommand (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN BOOLEAN Resend\r
);\r
\r
+/**\r
+ I/O work flow of in 8042 Aux data.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Data Buffer holding return value.\r
+ \r
+ @retval EFI_SUCCESS Success to excute I/O work flow\r
+ @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
EFI_STATUS\r
In8042AuxData (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN OUT UINT8 *Data\r
);\r
\r
+/**\r
+ I/O work flow of outing 8042 Aux data.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Command Aux I/O command\r
+ \r
+ @retval EFI_SUCCESS Success to excute I/O work flow\r
+ @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
EFI_STATUS\r
Out8042AuxData (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINT8 Data\r
);\r
\r
+/**\r
+ Check keyboard controller status, if it is output buffer full and for auxiliary device\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ \r
+ @retval EFI_SUCCESS Keyboard controller is ready\r
+ @retval EFI_NOT_READY Keyboard controller is not ready\r
+**/\r
EFI_STATUS\r
CheckForInput (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
);\r
\r
+/**\r
+ I/O work flow to wait input buffer empty in given time.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Timeout Wating time.\r
+ \r
+ @retval EFI_TIMEOUT if input is still not empty in given time.\r
+ @retval EFI_SUCCESS input is empty.\r
+**/\r
EFI_STATUS\r
WaitInputEmpty (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINTN Timeout\r
);\r
\r
+/**\r
+ I/O work flow to wait output buffer full in given time.\r
+ \r
+ @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+ @param Timeout given time\r
+ \r
+ @retval EFI_TIMEOUT output is not full in given time\r
+ @retval EFI_SUCCESS output is full in given time.\r
+**/\r
EFI_STATUS\r
WaitOutputFull (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
NULL\r
};\r
\r
+/**\r
+ Test to see if this driver supports ControllerHandle. Any ControllerHandle\r
+ than contains a IsaIo 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
PS2MouseAbsolutePointerDriverSupported (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- ControllerDriver Protocol Method\r
-\r
-Arguments:\r
-\r
-Returns:\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_ISA_IO_PROTOCOL *IsaIo;\r
return Status;\r
}\r
\r
+/**\r
+ Start this driver on ControllerHandle by opening a IsaIo\r
+ protocol, creating PS2_MOUSE_ABSOLUTE_POINTER_DEV device and install gEfiAbsolutePointerProtocolGuid\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
PS2MouseAbsolutePointerDriverStart (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Start protocol interfaces for the mouse device handles.\r
-\r
-Arguments:\r
- This - Protocol instance pointer.\r
- Controller - Handle of device to bind driver to.\r
- RemainingDevicePath - Not used.\r
-\r
-Returns:\r
- EFI_SUCCESS - This driver is added to DeviceHandle.\r
- other - Errors occurred.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_STATUS EmptyStatus;\r
return Status;\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
PS2MouseAbsolutePointerDriverStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
-\r
- Routine Description:\r
-\r
- Arguments:\r
-\r
- Returns:\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
-// GC_TODO: EFI_SUCCESS - add return value to function comment\r
{\r
EFI_STATUS Status;\r
EFI_ABSOLUTE_POINTER_PROTOCOL *AbsolutePointerProtocol;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Reset the Mouse and do BAT test for it, if ExtendedVerification isTRUE and there is a mouse device connectted to system\r
+\r
+ @param This - Pointer of simple pointer Protocol.\r
+ @param ExtendedVerification - Whether configure mouse parameters. True: do; FALSE: skip.\r
+\r
+\r
+ @retval EFI_SUCCESS - The command byte is written successfully.\r
+ @retval EFI_DEVICE_ERROR - Errors occurred during reseting keyboard.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
MouseAbsolutePointerReset (\r
IN EFI_ABSOLUTE_POINTER_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Reset the Mouse and do BAT test for it, if ExtendedVerification isTRUE and there is a mouse device connectted to system\r
-\r
-Arguments:\r
-\r
- This - Pointer of simple pointer Protocol.\r
- ExtendedVerification - Whether configure mouse parameters. True: do; FALSE: skip.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The command byte is written successfully.\r
- EFI_DEVICE_ERROR - Errors occurred during reseting keyboard.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
PS2_MOUSE_ABSOLUTE_POINTER_DEV *MouseAbsolutePointerDev;\r
return Status;\r
}\r
\r
-BOOLEAN\r
-CheckMouseAbsolutePointerConnect (\r
- IN PS2_MOUSE_ABSOLUTE_POINTER_DEV *MouseAbsolutePointerDev\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Check whether there is Ps/2 mouse device in system\r
\r
-Arguments:\r
-\r
- PS2_MOUSE_DEV - Mouse Private Data Structure\r
+ @param PS2_MOUSE_DEV - Mouse Private Data Structure\r
\r
-Returns:\r
+ @retval TRUE - Keyboard in System.\r
+ @retval FALSE - Keyboard not in System.\r
\r
- TRUE - Keyboard in System.\r
- FALSE - Keyboard not in System.\r
+**/\r
+BOOLEAN\r
+CheckMouseAbsolutePointerConnect (\r
+ IN PS2_MOUSE_ABSOLUTE_POINTER_DEV *MouseAbsolutePointerDev\r
+ )\r
\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
return FALSE;\r
}\r
\r
+/**\r
+ Get and Clear mouse status.\r
+ \r
+ @param This - Pointer of simple pointer Protocol.\r
+ @param State - Output buffer holding status.\r
+\r
+ @retval EFI_INVALID_PARAMETER Output buffer is invalid.\r
+ @retval EFI_NOT_READY Mouse is not changed status yet.\r
+ @retval EFI_SUCCESS Mouse status is changed and get successful.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
MouseAbsolutePointerGetState (\r
IN EFI_ABSOLUTE_POINTER_PROTOCOL *This,\r
IN OUT EFI_ABSOLUTE_POINTER_STATE *State\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
- State - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
- EFI_NOT_READY - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
PS2_MOUSE_ABSOLUTE_POINTER_DEV *MouseAbsolutePointerDev;\r
EFI_TPL OldTpl;\r
return EFI_SUCCESS;\r
}\r
\r
-VOID\r
-EFIAPI\r
-MouseAbsolutePointerWaitForInput (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
Event notification function for SIMPLE_POINTER.WaitForInput event\r
Signal the event if there is input from mouse\r
\r
-Arguments:\r
+ @param Event event object\r
+ @param Context event context\r
\r
-Returns:\r
+**/\r
\r
---*/\r
+VOID\r
+EFIAPI\r
+MouseAbsolutePointerWaitForInput (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
// GC_TODO: Event - add argument and description to function comment\r
// GC_TODO: Context - add argument and description to function comment\r
{\r
\r
}\r
\r
+/**\r
+ Event notification function for TimerEvent event\r
+ If mouse device is connected to system, try to get the mouse packet data\r
+\r
+ @param Event - TimerEvent in PS2_MOUSE_DEV\r
+ @param Context - Pointer to PS2_MOUSE_DEV structure\r
+\r
+**/\r
VOID\r
EFIAPI\r
PollMouseAbsolutePointer(\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Event notification function for TimerEvent event\r
- If mouse device is connected to system, try to get the mouse packet data\r
-\r
-Arguments:\r
-\r
- Event - TimerEvent in PS2_MOUSE_DEV\r
- Context - Pointer to PS2_MOUSE_DEV structure\r
\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
PS2_MOUSE_ABSOLUTE_POINTER_DEV *MouseAbsolutePointerDev;\r
\r
\r
return Status;\r
}\r
+\r
KbcSelfTest (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
UINT8 Data;\r
KbcEnableAux (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
{\r
//\r
// Send 8042 enable mouse command\r
KbcDisableAux (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
{\r
//\r
// Send 8042 disable mouse command\r
KbcEnableKb (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
{\r
//\r
// Send 8042 enable keyboard command\r
KbcDisableKb (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
{\r
//\r
// Send 8042 disable keyboard command\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
OUT BOOLEAN *KeyboardEnable\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
UINT8 Data;\r
PS2MouseReset (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
UINT8 Data;\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN MOUSE_SR SampleRate\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN MOUSE_RE Resolution\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN MOUSE_SF Scaling\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
{\r
UINT8 Command;\r
\r
PS2MouseEnable (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
{\r
//\r
// Send auxiliary command to enable mouse\r
PS2MouseGetPacket (\r
PS2_MOUSE_DEV *MouseDev\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_NOT_READY - Mouse Device not ready to input data packet, or some error happened during getting the packet\r
EFI_SUCCESS - The data packet is gotten successfully.\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
BOOLEAN KeyboardEnable;\r
IN OUT UINTN *BufSize,\r
IN UINTN State\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
UINTN BytesRead;\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINT8 Command\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
UINT8 Data;\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINT8 Data\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
UINT8 temp;\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN OUT UINT8 *Data\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_TIMEOUT - GC_TODO: Add description for return value\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
UINTN Delay;\r
UINT8 temp;\r
IN UINT8 Command,\r
IN BOOLEAN Resend\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
UINT8 Data;\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINT8 Data\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
UINT8 Temp;\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN OUT UINT8 *Data\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
\r
CheckForInput (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_NOT_READY - GC_TODO: Add description for return value\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
UINT8 Data;\r
\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINTN Timeout\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_TIMEOUT - GC_TODO: Add description for return value\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
UINTN Delay;\r
UINT8 Data;\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN UINTN Timeout\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_TIMEOUT - GC_TODO: Add description for return value\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
UINTN Delay;\r
UINT8 Data;\r
KbcSelfTest (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
KbcEnableAux (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
KbcDisableAux (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
KbcEnableKb (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
KbcDisableKb (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
OUT BOOLEAN *KeyboardEnable\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PS2MouseReset (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN MOUSE_SR SampleRate\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN MOUSE_RE Resolution\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_ISA_IO_PROTOCOL *IsaIo,\r
IN MOUSE_SF Scaling\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PS2MouseEnable (\r
IN EFI_ISA_IO_PROTOCOL *IsaIo\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PS2MouseGetPacket (\r
PS2_MOUSE_DEV *MouseDev\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
Returns:\r
\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
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
Start protocol interfaces for the mouse device handles.\r
EFI_SUCCESS - This driver is added to DeviceHandle.\r
other - Errors occurred.\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
EFI_STATUS EmptyStatus;\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
Returns:\r
\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
IN EFI_SIMPLE_POINTER_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_SUCCESS - The command byte is written successfully.\r
EFI_DEVICE_ERROR - Errors occurred during reseting keyboard.\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
PS2_MOUSE_DEV *MouseDev;\r
CheckMouseConnect (\r
IN PS2_MOUSE_DEV *MouseDev\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
TRUE - Keyboard in System.\r
FALSE - Keyboard not in System.\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
\r
IN EFI_SIMPLE_POINTER_PROTOCOL *This,\r
IN OUT EFI_SIMPLE_POINTER_STATE *State\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_NOT_READY - GC_TODO: Add description for return value\r
EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
PS2_MOUSE_DEV *MouseDev;\r
EFI_TPL OldTpl;\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
Returns:\r
\r
---*/\r
+**/\r
// GC_TODO: Event - add argument and description to function comment\r
// GC_TODO: Context - add argument and description to function comment\r
{\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
PS2_MOUSE_DEV *MouseDev;\r
\r
IN UINT8 Operation,\r
OUT UINT16 *PtrCommand\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: Command - add argument and description to function comment\r
// TODO: Offset - add argument and description to function comment\r
PciCapabilitySupport (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
{\r
\r
IN OUT UINT8 *Offset,\r
OUT UINT8 *NextRegBlock OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
Locate cap reg.\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_UNSUPPORTED - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
IN UINT8 Operation,\r
OUT UINT16 *PtrCommand\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
PciCapabilitySupport (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN OUT UINT8 *Offset,\r
OUT UINT8 *NextRegBlock OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
\r
InitializePciDevicePool (\r
VOID\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
InitializeListHead (&gPciDevicePool);\r
InsertRootBridge (\r
PCI_IO_DEVICE *RootBridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
\r
PCI_IO_DEVICE *Bridge,\r
PCI_IO_DEVICE *PciDeviceNode\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
\r
DestroyRootBridge (\r
IN PCI_IO_DEVICE *RootBridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
DestroyPciDeviceTree (RootBridge);\r
FreePciDevice (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
\r
DestroyPciDeviceTree (\r
IN PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
LIST_ENTRY *CurrentLink;\r
DestroyRootBridgeByHandle (\r
EFI_HANDLE Controller\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
{\r
IN PCI_IO_DEVICE *PciIoDevice,\r
OUT EFI_HANDLE *Handle OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_SUCCESS - The PCI device is successfully registered.\r
Others - An error occurred when registering the PCI device.\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
VOID *PlatformOpRomBuffer;\r
EFI_HANDLE RootBridgeHandle,\r
PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
\r
IN EFI_HANDLE Controller,\r
IN EFI_HANDLE Handle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
IN OUT UINT8 *NumberOfChildren,\r
IN OUT EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_NOT_READY - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_UNSUPPORTED - add return value to function comment\r
StartPciDevices (\r
IN EFI_HANDLE Controller\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
PCI_IO_DEVICE *RootBridge;\r
EFI_HANDLE ThisHostBridge;\r
CreateRootBridge (\r
IN EFI_HANDLE RootBridgeHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
\r
EFI_STATUS Status;\r
GetRootBridgeByHandle (\r
EFI_HANDLE RootBridgeHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
PCI_IO_DEVICE *RootBridgeDev;\r
LIST_ENTRY *CurrentLink;\r
IN PCI_IO_DEVICE *Bridge,\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
\r
PCI_IO_DEVICE *Temp;\r
ActiveVGADeviceOnTheSameSegment (\r
IN PCI_IO_DEVICE *VgaDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
LIST_ENTRY *CurrentLink;\r
PCI_IO_DEVICE *Temp;\r
ActiveVGADeviceOnTheRootBridge (\r
IN PCI_IO_DEVICE *RootBridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
LIST_ENTRY *CurrentLink;\r
PCI_IO_DEVICE *Temp;\r
IN EFI_DEVICE_PATH_PROTOCOL *HpcDevicePath,\r
OUT UINT64 *PciAddress\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath,\r
OUT UINT64 *PciAddress\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: RootBridge - add argument and description to function comment\r
// TODO: RemainingDevicePath - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
InitializePciDevicePool (\r
VOID\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
InsertRootBridge (\r
PCI_IO_DEVICE *RootBridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PCI_IO_DEVICE *Bridge,\r
PCI_IO_DEVICE *PciDeviceNode\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
DestroyRootBridge (\r
IN PCI_IO_DEVICE *RootBridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
DestroyPciDeviceTree (\r
IN PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
DestroyRootBridgeByHandle (\r
EFI_HANDLE Controller\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN PCI_IO_DEVICE *PciIoDevice,\r
OUT EFI_HANDLE *Handle OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
EFI_HANDLE RootBridgeHandle,\r
PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_HANDLE Controller,\r
IN EFI_HANDLE Handle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN OUT UINT8 *NumberOfChildren,\r
IN OUT EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
StartPciDevices (\r
IN EFI_HANDLE Controller\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
PCI_IO_DEVICE *\r
CreateRootBridge (\r
IN EFI_HANDLE RootBridgeHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
PCI_IO_DEVICE *\r
GetRootBridgeByHandle (\r
EFI_HANDLE RootBridgeHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
RootBridgeExisted (\r
IN EFI_HANDLE RootBridgeHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
IN PCI_IO_DEVICE *Bridge,\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
PCI_IO_DEVICE *\r
ActiveVGADeviceOnTheSameSegment (\r
IN PCI_IO_DEVICE *VgaDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
PCI_IO_DEVICE *\r
ActiveVGADeviceOnTheRootBridge (\r
IN PCI_IO_DEVICE *RootBridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_DEVICE_PATH_PROTOCOL *HpcDevicePath,\r
OUT UINT64 *PciAddress\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath,\r
OUT UINT64 *PciAddress\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
FreePciDevice (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
InitializePciDriverOverrideInstance (\r
PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL *This,\r
IN OUT EFI_HANDLE *DriverImageHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: DriverImageHandle - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
IN PCI_IO_DEVICE *PciIoDevice,\r
IN EFI_HANDLE DriverImageHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: DriverImageHandle - add argument and description to function comment\r
// TODO: EFI_OUT_OF_RESOURCES - add return value to function comment\r
InitializePciDriverOverrideInstance (\r
PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN PCI_IO_DEVICE *PciIoDevice,\r
IN EFI_HANDLE DriverImageHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL *This,\r
IN OUT EFI_HANDLE *DriverImageHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
PciEnumerator (\r
IN EFI_HANDLE Controller\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Controller - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc,\r
IN PCI_IO_DEVICE *RootBridgeDev\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciResAlloc - add argument and description to function comment\r
// TODO: RootBridgeDev - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
IN UINT64 RomBase,\r
IN UINT64 MaxLength\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: RomBase - add argument and description to function comment\r
// TODO: MaxLength - add argument and description to function comment\r
IN UINT8 StartBusNumber,\r
OUT UINT8 *SubBusNumber\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: StartBusNumber - add argument and description to function comment\r
// TODO: SubBusNumber - add argument and description to function comment\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc,\r
IN PCI_IO_DEVICE *RootBridgeDev\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciResAlloc - add argument and description to function comment\r
// TODO: RootBridgeDev - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
GetMaxOptionRomSize (\r
IN PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
{\r
LIST_ENTRY *CurrentLink;\r
PciHostBridgeDeviceAttribute (\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciResAlloc - add argument and description to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
OUT UINT64 *Mem64ResStatus,\r
OUT UINT64 *PMem64ResStatus\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: AcpiConfig - add argument and description to function comment\r
// TODO: IoResStatus - add argument and description to function comment\r
// TODO: Mem32ResStatus - add argument and description to function comment\r
RejectPciDevice (\r
IN PCI_IO_DEVICE *PciDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciDevice - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_ABORTED - add return value to function comment\r
IsRejectiveDevice (\r
IN PCI_RESOURCE_NODE *PciResNode\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciResNode - add argument and description to function comment\r
{\r
PCI_IO_DEVICE *Temp;\r
IN PCI_RESOURCE_NODE *PciResNode1,\r
IN PCI_RESOURCE_NODE *PciResNode2\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciResNode1 - add argument and description to function comment\r
// TODO: PciResNode2 - add argument and description to function comment\r
{\r
GetMaxResourceConsumerDevice (\r
IN PCI_RESOURCE_NODE *ResPool\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: ResPool - add argument and description to function comment\r
{\r
PCI_RESOURCE_NODE *Temp;\r
IN UINT64 Mem64ResStatus,\r
IN UINT64 PMem64ResStatus\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: IoPool - add argument and description to function comment\r
// TODO: Mem32Pool - add argument and description to function comment\r
// TODO: PMem32Pool - add argument and description to function comment\r
IN PCI_RESOURCE_NODE *PMem64Node,\r
OUT VOID **pConfig\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: IoNode - add argument and description to function comment\r
// TODO: Mem32Node - add argument and description to function comment\r
OUT UINT64 *Mem64Base,\r
OUT UINT64 *PMem64Base\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: pConfig - add argument and description to function comment\r
// TODO: IoBase - add argument and description to function comment\r
// TODO: Mem32Base - add argument and description to function comment\r
PciBridgeEnumerator (\r
IN PCI_IO_DEVICE *BridgeDev\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: BridgeDev - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
PciBridgeResourceAllocator (\r
IN PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
OUT UINT64 *Mem64Base,\r
OUT UINT64 *PMem64Base\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: IoBase - add argument and description to function comment\r
// TODO: Mem32Base - add argument and description to function comment\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc,\r
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciResAlloc - add argument and description to function comment\r
// TODO: Phase - add argument and description to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
IN UINT8 Func,\r
IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: Bus - add argument and description to function comment\r
// TODO: Device - add argument and description to function comment\r
IN OUT UINT8 *NumberOfChildren,\r
IN OUT EFI_HANDLE * ChildHandleBuffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
Status code.\r
\r
---*/\r
+**/\r
// TODO: RemainingDevicePath - add argument and description to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
SearchHostBridgeHandle (\r
IN EFI_HANDLE RootBridgeHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: RootBridgeHandle - add argument and description to function comment\r
{\r
EFI_HANDLE HostBridgeHandle;\r
AddHostBridgeEnumerator (\r
IN EFI_HANDLE HostBridgeHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: HostBridgeHandle - add argument and description to function comment\r
// TODO: EFI_ABORTED - add return value to function comment\r
// TODO: EFI_ABORTED - add return value to function comment\r
PciEnumerator (\r
IN EFI_HANDLE Controller\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc,\r
IN PCI_IO_DEVICE *RootBridgeDev\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT64 RomBase,\r
IN UINT64 MaxLength\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT8 StartBusNumber,\r
OUT UINT8 *SubBusNumber\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc,\r
IN PCI_IO_DEVICE *RootBridgeDev\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
UINT64\r
GetMaxOptionRomSize (\r
IN PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PciHostBridgeDeviceAttribute (\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
OUT UINT64 *Mem64ResStatus,\r
OUT UINT64 *PMem64ResStatus\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
RejectPciDevice (\r
IN PCI_IO_DEVICE *PciDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
IsRejectiveDevice (\r
IN PCI_RESOURCE_NODE *PciResNode\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
PCI_RESOURCE_NODE *\r
IN PCI_RESOURCE_NODE *PciResNode1,\r
IN PCI_RESOURCE_NODE *PciResNode2\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
PCI_RESOURCE_NODE *\r
GetMaxResourceConsumerDevice (\r
IN PCI_RESOURCE_NODE *ResPool\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT64 Mem64ResStatus,\r
IN UINT64 PMem64ResStatus\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN PCI_RESOURCE_NODE *PMem64Node,\r
OUT VOID **pConfig\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
OUT UINT64 *Mem64Base,\r
OUT UINT64 *PMem64Base\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PciBridgeEnumerator (\r
IN PCI_IO_DEVICE *BridgeDev\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PciBridgeResourceAllocator (\r
IN PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
OUT UINT64 *Mem64Base,\r
OUT UINT64 *PMem64Base\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PciHostBridgeP2CProcess (\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc,\r
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT8 Func,\r
IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN OUT UINT8 *NumberOfChildren,\r
IN OUT EFI_HANDLE * ChildHandleBuffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
SearchHostBridgeHandle (\r
IN EFI_HANDLE RootBridgeHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
AddHostBridgeEnumerator (\r
IN EFI_HANDLE HostBridgeHandle\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
UINT8 Device,\r
UINT8 Func\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciRootBridgeIo - add argument and description to function comment\r
// TODO: Pci - add argument and description to function comment\r
// TODO: Bus - add argument and description to function comment\r
IN PCI_IO_DEVICE *Bridge,\r
UINT8 StartBusNumber\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: StartBusNumber - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
IN UINT8 Func,\r
OUT PCI_IO_DEVICE **PciDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
Status code.\r
\r
---*/\r
+**/\r
// TODO: EFI_OUT_OF_RESOURCES - add return value to function comment\r
// TODO: EFI_OUT_OF_RESOURCES - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
UINT8 Device,\r
UINT8 Func\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: Pci - add argument and description to function comment\r
// TODO: Bus - add argument and description to function comment\r
UINT8 Device,\r
UINT8 Func\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: Pci - add argument and description to function comment\r
// TODO: Bus - add argument and description to function comment\r
UINT8 Device,\r
UINT8 Func\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: Pci - add argument and description to function comment\r
// TODO: Bus - add argument and description to function comment\r
IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath,\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: ParentDevicePath - add argument and description to function comment\r
// TODO: PciIoDevice - add argument and description to function comment\r
{\r
OUT UINT32 *BarLengthValue,\r
OUT UINT32 *OriginalBarValue\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_NOT_FOUND - The bar don't exist.\r
EFI_SUCCESS - The bar exist.\r
\r
---*/\r
+**/\r
{\r
EFI_PCI_IO_PROTOCOL *PciIo;\r
UINT32 OriginalValue;\r
IN UINT16 *OldCommand,\r
IN UINT16 *OldBridgeControl\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: Command - add argument and description to function comment\r
// TODO: BridgeControl - add argument and description to function comment\r
IN UINT16 BridgeControl,\r
IN UINTN Option\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
Set the supported or current attributes of a PCI device\r
\r
Returns:\r
\r
---*/\r
+**/\r
\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_SUCCESS Always success\r
\r
\r
---*/\r
+**/\r
{\r
UINT64 Attributes;\r
\r
IN PCI_IO_DEVICE *PciIoDevice,\r
IN UINT8 StatusIndex\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: StatusIndex - add argument and description to function comment\r
// TODO: EFI_UNSUPPORTED - add return value to function comment\r
ProcessOptionRomLight (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
DetermineDeviceAttribute (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
UpdatePciInfo (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_UNSUPPORTED - add return value to function comment\r
{\r
IN UINT64 *Alignment,\r
IN UINT64 NewAlignment\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Alignment - add argument and description to function comment\r
// TODO: NewAlignment - add argument and description to function comment\r
{\r
IN UINTN Offset,\r
IN UINTN BarIndex\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: Offset - add argument and description to function comment\r
// TODO: BarIndex - add argument and description to function comment\r
InitializePciDevice (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
InitializePpb (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
InitializeP2C (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
UINT8 Device,\r
UINT8 Func\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciRootBridgeIo - add argument and description to function comment\r
// TODO: Pci - add argument and description to function comment\r
// TODO: Bus - add argument and description to function comment\r
PciEnumeratorLight (\r
IN EFI_HANDLE Controller\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Controller - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
OUT UINT16 *MaxBus,\r
OUT UINT16 *BusRange\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
Status Code.\r
\r
---*/\r
+**/\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
{\r
StartManagingRootBridge (\r
IN PCI_IO_DEVICE *RootBridgeDev\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: RootBridgeDev - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
IsPciDeviceRejected (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
TRUE This device should be rejected\r
FALSE This device shouldn't be rejected\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
{\r
EFI_STATUS Status;\r
IN PCI_IO_DEVICE *Bridge,\r
IN UINT8 StartBusNumber\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
EFI_SUCCESS - TODO: Add description for return value\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
PCI_TYPE00 Pci;\r
UINT8 Device,\r
UINT8 Func\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN PCI_IO_DEVICE *Bridge,\r
UINT8 StartBusNumber\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
UINT8 Func,\r
PCI_IO_DEVICE **PciDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
PCI_IO_DEVICE *\r
UINT8 Device,\r
UINT8 Func\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
PCI_IO_DEVICE *\r
UINT8 Device,\r
UINT8 Func\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
PCI_IO_DEVICE *\r
UINT8 Device,\r
UINT8 Func\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_DEVICE_PATH_PROTOCOL *\r
IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath,\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
OUT UINT32 *BarLengthValue,\r
OUT UINT32 *OriginalBarValue\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT16 *OldCommand,\r
IN UINT16 *OldBridgeControl\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT16 BridgeControl,\r
IN UINTN Option\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN PCI_IO_DEVICE *PciIoDevice,\r
IN UINT8 StatusIndex\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
DetermineDeviceAttribute (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
UpdatePciInfo (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
VOID\r
IN UINT64 *Alignment,\r
IN UINT64 NewAlignment\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
UINTN\r
IN UINTN Offset,\r
IN UINTN BarIndex\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
InitializePciDevice (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
InitializePpb (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
InitializeP2C (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
PCI_IO_DEVICE *\r
UINT8 Device,\r
UINT8 Func\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PciEnumeratorLight (\r
IN EFI_HANDLE Controller\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
OUT UINT16 *MaxBus,\r
OUT UINT16 *BusRange\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
StartManagingRootBridge (\r
IN PCI_IO_DEVICE *RootBridgeDev\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
IsPciDeviceRejected (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Event - add argument and description to function comment\r
// TODO: Context - add argument and description to function comment\r
{\r
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath1,\r
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath2\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: DevicePath1 - add argument and description to function comment\r
// TODO: DevicePath2 - add argument and description to function comment\r
{\r
InitializeHotPlugSupport (\r
VOID\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_UNSUPPORTED - add return value to function comment\r
// TODO: EFI_OUT_OF_RESOURCES - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
IN EFI_DEVICE_PATH_PROTOCOL *HpbDevicePath,\r
OUT UINTN *HpIndex\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: HpbDevicePath - add argument and description to function comment\r
{\r
UINTN Index;\r
IN EFI_DEVICE_PATH_PROTOCOL *HpcDevicePath,\r
OUT UINTN *HpIndex\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
UINTN Index;\r
\r
IN UINTN HpIndex,\r
OUT EFI_EVENT *Event\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: HpIndex - add argument and description to function comment\r
// TODO: Event - add argument and description to function comment\r
{\r
AllRootHPCInitialized (\r
IN UINTN TimeoutInMicroSeconds\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_SUCCESS - All root hpc's initialization is finished before the timeout\r
EFI_TIMEOUT - Time out\r
\r
---*/\r
+**/\r
{\r
UINT32 Delay;\r
UINTN Index;\r
IsSHPC (\r
PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
GetResourcePaddingForHpb (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
IsPciHotPlugBus (\r
PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath1,\r
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath2\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
InitializeHotPlugSupport (\r
VOID\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IsPciHotPlugBus (\r
PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
IN EFI_DEVICE_PATH_PROTOCOL *HpbDevicePath,\r
OUT UINTN *HpIndex\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
IN EFI_DEVICE_PATH_PROTOCOL *HpcDevicePath,\r
OUT UINTN *HpIndex\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN HpIndex,\r
OUT EFI_EVENT *Event\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
AllRootHPCInitialized (\r
IN UINTN TimeoutInMicroSeconds\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_SUCCESS - All root hpc's initialization is finished before the timeout\r
EFI_TIMEOUT - Time out\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IsSHPC (\r
PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
GetResourcePaddingForHpb (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
IN PCI_IO_DEVICE *PciIoDevice,\r
IN EFI_STATUS_CODE_VALUE Code\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: Code - add argument and description to function comment\r
{\r
InitializePciIoInstance (\r
PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
IN UINTN Count,\r
UINT64 *Offset\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: BarIndex - add argument and description to function comment\r
// TODO: Type - add argument and description to function comment\r
IN UINTN Count,\r
IN UINT64 *Offset\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: Width - add argument and description to function comment\r
// TODO: Count - add argument and description to function comment\r
IN UINT64 Delay,\r
OUT UINT64 *Result\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Width - add argument and description to function comment\r
// TODO: BarIndex - add argument and description to function comment\r
IN UINT64 Delay,\r
OUT UINT64 *Result\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Width - add argument and description to function comment\r
// TODO: BarIndex - add argument and description to function comment\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Width - add argument and description to function comment\r
// TODO: BarIndex - add argument and description to function comment\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Width - add argument and description to function comment\r
// TODO: BarIndex - add argument and description to function comment\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Width - add argument and description to function comment\r
// TODO: BarIndex - add argument and description to function comment\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Width - add argument and description to function comment\r
// TODO: BarIndex - add argument and description to function comment\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Width - add argument and description to function comment\r
// TODO: Offset - add argument and description to function comment\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Width - add argument and description to function comment\r
// TODO: Offset - add argument and description to function comment\r
IN UINT64 SrcOffset,\r
IN UINTN Count\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Width - add argument and description to function comment\r
// TODO: DestBarIndex - add argument and description to function comment\r
OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,\r
OUT VOID **Mapping\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Operation - add argument and description to function comment\r
// TODO: HostAddress - add argument and description to function comment\r
IN EFI_PCI_IO_PROTOCOL *This,\r
IN VOID *Mapping\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Mapping - add argument and description to function comment\r
{\r
OUT VOID **HostAddress,\r
IN UINT64 Attributes\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Type - add argument and description to function comment\r
// TODO: MemoryType - add argument and description to function comment\r
IN UINTN Pages,\r
IN VOID *HostAddress\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Pages - add argument and description to function comment\r
// TODO: HostAddress - add argument and description to function comment\r
PciIoFlush (\r
IN EFI_PCI_IO_PROTOCOL *This\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
{\r
EFI_STATUS Status;\r
OUT UINTN *Device,\r
OUT UINTN *Function\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Segment - add argument and description to function comment\r
// TODO: Bus - add argument and description to function comment\r
UINT8 BarIndex,\r
PCI_BAR_TYPE BarType\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: BarIndex - add argument and description to function comment\r
// TODO: BarType - add argument and description to function comment\r
IN UINT64 Attributes,\r
IN EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION Operation\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: Attributes - add argument and description to function comment\r
// TODO: Operation - add argument and description to function comment\r
IN PCI_IO_DEVICE *PciIoDevice,\r
IN EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION Operation\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: Operation - add argument and description to function comment\r
// TODO: EFI_UNSUPPORTED - add return value to function comment\r
IN UINT64 Attributes,\r
OUT UINT64 *Result OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Operation - add argument and description to function comment\r
// TODO: Attributes - add argument and description to function comment\r
OUT UINT64 *Supports, OPTIONAL\r
OUT VOID **Resources OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: BarIndex - add argument and description to function comment\r
// TODO: Supports - add argument and description to function comment\r
IN OUT UINT64 *Offset,\r
IN OUT UINT64 *Length\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: Attributes - add argument and description to function comment\r
// TODO: BarIndex - add argument and description to function comment\r
IN EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION Operation,\r
IN UINT64 Attributes\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: Operation - add argument and description to function comment\r
// TODO: Attributes - add argument and description to function comment\r
IN PCI_IO_DEVICE *PciDevice1,\r
IN PCI_IO_DEVICE *PciDevice2\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciDevice1 - add argument and description to function comment\r
// TODO: PciDevice2 - add argument and description to function comment\r
{\r
InitializePciIoInstance (\r
PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN Count,\r
UINT64 *Offset\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN Count,\r
IN UINT64 *Offset\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT64 Delay,\r
OUT UINT64 *Result\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT64 Delay,\r
OUT UINT64 *Result\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN Count,\r
IN OUT VOID *Buffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT64 SrcOffset,\r
IN UINTN Count\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,\r
OUT VOID **Mapping\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_PCI_IO_PROTOCOL *This,\r
IN VOID *Mapping\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
OUT VOID **HostAddress,\r
IN UINT64 Attributes\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN Pages,\r
IN VOID *HostAddress\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PciIoFlush (\r
IN EFI_PCI_IO_PROTOCOL *This\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
OUT UINTN *Device,\r
OUT UINTN *Function\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
UINT8 BarIndex,\r
PCI_BAR_TYPE BarType\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT64 Attributes,\r
IN EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION Operation\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN PCI_IO_DEVICE *PciIoDevice,\r
IN EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION Operation\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT64 Attributes,\r
OUT UINT64 *Result OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
OUT UINT64 *Supports, OPTIONAL\r
OUT VOID **Resources OPTIONAL\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN OUT UINT64 *Offset,\r
IN OUT UINT64 *Length\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION Operation,\r
IN UINT64 Attributes\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
IN PCI_IO_DEVICE *PciDevice1,\r
IN PCI_IO_DEVICE *PciDevice2\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
InstallHotPlugRequestProtocol (\r
IN EFI_STATUS *Status\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
EFI_HANDLE Handle;\r
\r
InstallPciHotplugGuid (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
\r
UninstallPciHotplugGuid (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
EFI_STATUS Status;\r
\r
GetBackPcCardBar (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
UINT32 Address;\r
\r
EFI_HANDLE RootBridgeHandle,\r
IN PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
PCI_IO_DEVICE *Temp;\r
PciHostBridgeResourceAllocator_WithoutHotPlugDeviceSupport (\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciResAlloc - add argument and description to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
// TODO: EFI_OUT_OF_RESOURCES - add return value to function comment\r
PciHostBridgeResourceAllocator_WithHotPlugDeviceSupport (\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
EFI Status.\r
\r
---*/\r
+**/\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
OUT UINT8 *SubBusNumber,\r
OUT UINT8 *PaddedBusRange\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: StartBusNumber - add argument and description to function comment\r
// TODO: SubBusNumber - add argument and description to function comment\r
OUT UINT8 *SubBusNumber,\r
OUT UINT8 *PaddedBusRange\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_DEVICE_ERROR - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
PciRootBridgeP2CProcess (\r
IN PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
PciHostBridgeP2CProcess (\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciResAlloc - add argument and description to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
PciHostBridgeEnumerator (\r
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_OUT_OF_RESOURCES - add return value to function comment\r
// TODO: EFI_OUT_OF_RESOURCES - add return value to function comment\r
// TODO: EFI_OUT_OF_RESOURCES - add return value to function comment\r
InstallHotPlugRequestProtocol (\r
IN EFI_STATUS *Status\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
VOID\r
InstallPciHotplugGuid (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
VOID\r
UninstallPciHotplugGuid (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
VOID\r
GetBackPcCardBar (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
EFI_HANDLE RootBridgeHandle,\r
IN PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PciHostBridgeResourceAllocator (\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
OUT UINT8 *SubBusNumber,\r
OUT UINT8 *PaddedBusRange\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PciRootBridgeP2CProcess (\r
IN PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PciHostBridgeP2CProcess (\r
IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PciHostBridgeEnumerator (\r
EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
/**\r
GetOpRomInfo (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
Returns:\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_NOT_FOUND - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
IN PCI_IO_DEVICE *PciDevice,\r
IN UINT64 RomBase\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
Returns:\r
\r
---*/\r
+**/\r
// TODO: PciDevice - add argument and description to function comment\r
// TODO: RomBase - add argument and description to function comment\r
// TODO: EFI_OUT_OF_RESOURCES - add return value to function comment\r
IN UINT32 RomBar,\r
IN BOOLEAN Enable\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
Returns:\r
\r
---*/\r
+**/\r
// TODO: PciDevice - add argument and description to function comment\r
// TODO: RomBarIndex - add argument and description to function comment\r
// TODO: RomBar - add argument and description to function comment\r
ProcessOpRomImage (\r
PCI_IO_DEVICE *PciDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
EFI Status.\r
\r
---*/\r
+**/\r
{\r
UINT8 Indicator;\r
UINT32 ImageSize;\r
GetOpRomInfo (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN PCI_IO_DEVICE *PciDevice,\r
IN UINT64 RomBase\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT32 RomBar,\r
IN BOOLEAN Enable\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
ProcessOpRomImage (\r
PCI_IO_DEVICE *PciDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
ResetPowerManagementFeature (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_UNSUPPORTED - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
ResetPowerManagementFeature (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
OUT UINT64 *Start,\r
IN UINT64 Length\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Start - add argument and description to function comment\r
// TODO: Length - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
OUT UINT64 *Start,\r
IN UINT64 Length\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Start - add argument and description to function comment\r
// TODO: Length - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
PCI_RESOURCE_NODE *Bridge,\r
PCI_RESOURCE_NODE *ResNode\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: ResNode - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
PCI_RESOURCE_NODE *Res,\r
BOOLEAN TypeMerge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Dst - add argument and description to function comment\r
// TODO: Res - add argument and description to function comment\r
// TODO: TypeMerge - add argument and description to function comment\r
CalculateApertureIo16 (\r
IN PCI_RESOURCE_NODE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
CalculateResourceAperture (\r
IN PCI_RESOURCE_NODE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
PCI_RESOURCE_NODE *Mem64Node,\r
PCI_RESOURCE_NODE *PMem64Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciDev - add argument and description to function comment\r
// TODO: IoNode - add argument and description to function comment\r
// TODO: Mem32Node - add argument and description to function comment\r
IN PCI_BAR_TYPE ResType,\r
IN PCI_RESOURCE_USAGE ResUsage\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciDev - add argument and description to function comment\r
// TODO: Length - add argument and description to function comment\r
// TODO: Alignment - add argument and description to function comment\r
IN PCI_RESOURCE_NODE *Mem64Node,\r
IN PCI_RESOURCE_NODE *PMem64Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: IoNode - add argument and description to function comment\r
// TODO: Mem32Node - add argument and description to function comment\r
PCI_RESOURCE_NODE *Mem64Node,\r
PCI_RESOURCE_NODE *PMem64Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
//\r
IN PCI_RESOURCE_NODE *Mem64Node,\r
IN PCI_RESOURCE_NODE *PMem64Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: Mem32Node - add argument and description to function comment\r
// TODO: PMem32Node - add argument and description to function comment\r
IN PCI_IO_DEVICE *Bridge,\r
IN UINT32 Decode\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
{\r
- /*++\r
+ /**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
if ((Bridge->Decodes) & Decode) {\r
return TRUE;\r
}\r
IN UINT64 Base,\r
IN PCI_RESOURCE_NODE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Base - add argument and description to function comment\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: EFI_OUT_OF_RESOURCES - add return value to function comment\r
IN UINT64 Base,\r
IN PCI_RESOURCE_NODE *Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Base - add argument and description to function comment\r
// TODO: Node - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
IN UINT64 Base,\r
IN PCI_RESOURCE_NODE *Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Base - add argument and description to function comment\r
// TODO: Node - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
IN UINT32 OptionRomBase,\r
IN BOOLEAN Enable\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
Returns:\r
\r
---*/\r
+**/\r
// TODO: PciDevice - add argument and description to function comment\r
// TODO: OptionRomBase - add argument and description to function comment\r
// TODO: Enable - add argument and description to function comment\r
ResourceRequestExisted (\r
IN PCI_RESOURCE_NODE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
if (Bridge != NULL) {\r
if (!IsListEmpty (&Bridge->ChildList) || Bridge->Length != 0) {\r
PCI_RESOURCE_NODE *ResourcePool,\r
PCI_BAR_TYPE ResourceType\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: ResourcePool - add argument and description to function comment\r
// TODO: ResourceType - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
PCI_RESOURCE_NODE *Mem64Pool,\r
PCI_RESOURCE_NODE *PMem64Pool\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciDev - add argument and description to function comment\r
// TODO: IoBridge - add argument and description to function comment\r
// TODO: Mem32Bridge - add argument and description to function comment\r
DestroyResourceTree (\r
IN PCI_RESOURCE_NODE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Bridge - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
IN PCI_BAR_TYPE ResType,\r
IN PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Base - add argument and description to function comment\r
// TODO: Length - add argument and description to function comment\r
// TODO: ResType - add argument and description to function comment\r
PCI_RESOURCE_NODE *Mem64Node,\r
PCI_RESOURCE_NODE *PMem64Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciDev - add argument and description to function comment\r
// TODO: IoNode - add argument and description to function comment\r
// TODO: Mem32Node - add argument and description to function comment\r
IN UINT64 Base,\r
IN PCI_RESOURCE_NODE *Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: Base - add argument and description to function comment\r
// TODO: Node - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
PCI_RESOURCE_NODE *Mem64Node,\r
PCI_RESOURCE_NODE *PMem64Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
// TODO: PciDev - add argument and description to function comment\r
// TODO: IoNode - add argument and description to function comment\r
// TODO: Mem32Node - add argument and description to function comment\r
GetResourcePaddingPpb (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
{\r
if (gPciHotPlugInit) {\r
if (PciIoDevice->ResourcePaddingDescriptors == NULL) {\r
OUT UINT64 *Start,\r
IN UINT64 Length\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
OUT UINT64 *Start,\r
IN UINT64 Length\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PCI_RESOURCE_NODE *Bridge,\r
PCI_RESOURCE_NODE *ResNode\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PCI_RESOURCE_NODE *Res,\r
BOOLEAN TypeMerge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
CalculateApertureIo16 (\r
IN PCI_RESOURCE_NODE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
CalculateResourceAperture (\r
IN PCI_RESOURCE_NODE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PCI_RESOURCE_NODE *Mem64Node,\r
PCI_RESOURCE_NODE *PMem64Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
PCI_RESOURCE_NODE *\r
IN PCI_BAR_TYPE ResType,\r
IN PCI_RESOURCE_USAGE ResUsage\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN PCI_RESOURCE_NODE *Mem64Node,\r
IN PCI_RESOURCE_NODE *PMem64Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PCI_RESOURCE_NODE *Mem64Node,\r
PCI_RESOURCE_NODE *PMem64Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN PCI_RESOURCE_NODE *Mem64Node,\r
IN PCI_RESOURCE_NODE *PMem64Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
IN PCI_IO_DEVICE *Bridge,\r
IN UINT32 Decode\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT64 Base,\r
IN PCI_RESOURCE_NODE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT64 Base,\r
IN PCI_RESOURCE_NODE *Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT64 Base,\r
IN PCI_RESOURCE_NODE *Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT32 OptionRomBase,\r
IN BOOLEAN Enable\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
BOOLEAN\r
ResourceRequestExisted (\r
IN PCI_RESOURCE_NODE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PCI_RESOURCE_NODE *ResourcePool,\r
PCI_BAR_TYPE ResourceType\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PCI_RESOURCE_NODE *Mem64Pool,\r
PCI_RESOURCE_NODE *PMem64Pool\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
DestroyResourceTree (\r
IN PCI_RESOURCE_NODE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN PCI_BAR_TYPE ResType,\r
IN PCI_IO_DEVICE *Bridge\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PCI_RESOURCE_NODE *Mem64Node,\r
PCI_RESOURCE_NODE *PMem64Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINT64 Base,\r
IN PCI_RESOURCE_NODE *Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PCI_RESOURCE_NODE *Mem64Node,\r
PCI_RESOURCE_NODE *PMem64Node\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
VOID\r
GetResourcePaddingPpb (\r
IN PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN PCI_IO_DEVICE *Bridge,\r
IN UINT8 StartBusNumber\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
None\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
IN UINT64 RomAddress,\r
IN UINT64 RomLength\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
{\r
EFI_PCI_ROM_IMAGE_MAPPING *TempMapping;\r
\r
IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo,\r
PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
Returns:\r
\r
---*/\r
+**/\r
// TODO: This - add argument and description to function comment\r
// TODO: PciRootBridgeIo - add argument and description to function comment\r
// TODO: PciIoDevice - add argument and description to function comment\r
PciRomGetImageMapping (\r
PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
Returns:\r
\r
---*/\r
+**/\r
// TODO: PciIoDevice - add argument and description to function comment\r
// TODO: EFI_SUCCESS - add return value to function comment\r
{\r
IN UINT64 RomAddress,\r
IN UINT64 RomLength\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
\r
IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo,\r
PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
PciRomGetImageMapping (\r
PCI_IO_DEVICE *PciIoDevice\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
EFI_SUCCESS\r
EFI_DEVICE_ERROR\r
\r
---*/\r
+**/\r
// TODO: ImageHandle - add argument and description to function comment\r
// TODO: SystemTable - add argument and description to function comment\r
{\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
EFI_SUCCESS\r
\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
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
Returns:\r
\r
\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
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
Returns:\r
\r
\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
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
Driver Entry Point.\r
\r
Returns:\r
EFI_STATUS\r
---*/\r
+**/\r
{\r
return EfiLibInstallDriverBindingComponentName2 (\r
ImageHandle,\r
@retval RETURN_INVALID_PARAMETER The source data is corrupted, or\r
The GUID in InputSection does not match this instance guid.\r
\r
---*/\r
+**/\r
RETURN_STATUS\r
EFIAPI\r
TianoDecompress (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
//\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN CHAR16 *WString\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN CHAR16 *WString\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
VgaClassClearScreen (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN UINTN Attribute\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN UINTN Column,\r
IN UINTN Row\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN BOOLEAN Visible\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
OUT UINTN *Columns,\r
OUT UINTN *Rows\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
EFI_STATUS\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN UINTN ModeNumber\r
)\r
-/*++\r
+/**\r
\r
Routine Description:\r
\r
\r
GC_TODO: add return values\r
\r
---*/\r
+**/\r
;\r
\r
#endif\r
UINTN PciLibAddress;\r
\r
PciLibAddress = PciCfgAddressConvert ((EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS *) &Address);\r
- switch (Width) {\r
+ switch (Width) {\r
case EfiPeiPciCfgWidthUint8:\r
* (UINT8 *) Buffer = PciRead8 (PciLibAddress);\r
break;\r
default:\r
return EFI_INVALID_PARAMETER;\r
}\r
- return EFI_SUCCESS;\r
+ return EFI_SUCCESS;\r
}\r
\r
\r
\r
default:\r
return EFI_INVALID_PARAMETER;\r
- }\r
- return EFI_SUCCESS;\r
+ }\r
+ return EFI_SUCCESS;\r
}\r
\r
\r
UINTN PciLibAddress;\r
\r
PciLibAddress = PciCfgAddressConvert ((EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS *) &Address);\r
- switch (Width) {\r
+ switch (Width) {\r
case EfiPeiPciCfgWidthUint8:\r
PciAndThenOr8 (PciLibAddress, (UINT8)~ClearBits, (UINT8)SetBits);\r
break;\r
default:\r
return EFI_INVALID_PARAMETER;\r
}\r
- return EFI_SUCCESS;\r
+ return EFI_SUCCESS;\r
}\r
+\r
return EFI_SUCCESS;\r
}\r
\r
-\r
+/**\r
+ Module's entry function. \r
+ This routine will install EFI_PEI_PCI_CFG2_PPI or EFI_PEI_PCI_CFG_PPI\r
+ according to PeiServices's version.\r
+ \r
+ @param FfsHeader Image's header\r
+ @param PeiServices Pointer of EFI_PEI_SERVICES\r
+ @return Whether success to install service\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeimInitializePciCfg (\r
\r
return Status;\r
}\r
+\r
/**@file\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
- SectionExtraction.c\r
- \r
-Abstract:\r
-\r
Section Extraction Protocol implementation.\r
\r
Stream database is implemented as a linked list of section streams,\r
\r
3) A support protocol is not found, and the data is not available to be read\r
without it. This results in EFI_PROTOCOL_ERROR.\r
- \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
+\r
**/\r
\r
#include "SectionExtraction.h"\r
CloseSectionStream\r
};\r
\r
+/**\r
+ Entry point of the section extraction code. Initializes an instance of the \r
+ section extraction interface and installs it on a new handle.\r
+\r
+ @param ImageHandle EFI_HANDLE: A handle for the image that is initializing this driver\r
+ @param SystemTable EFI_SYSTEM_TABLE: A pointer to the EFI system table \r
+\r
+ @retval EFI_SUCCESS Driver initialized successfully\r
+ @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
SectionExtractionEntryPoint (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
-\r
-Routine Description: \r
- Entry point of the section extraction code. Initializes an instance of the \r
- section extraction interface and installs it on a new handle.\r
-\r
-Arguments: \r
- ImageHandle EFI_HANDLE: A handle for the image that is initializing this driver\r
- SystemTable EFI_SYSTEM_TABLE: A pointer to the EFI system table \r
-\r
-Returns: \r
- EFI_SUCCESS: Driver initialized successfully\r
- EFI_OUT_OF_RESOURCES: Could not allocate needed resources\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
return Status;\r
}\r
\r
+/**\r
+ SEP member function. This function creates and returns a new section stream\r
+ handle to represent the new section stream.\r
+\r
+ @param This Indicates the calling context.\r
+ @param SectionStreamLength Size in bytes of the section stream.\r
+ @param SectionStream Buffer containing the new section stream.\r
+ @param SectionStreamHandle A pointer to a caller allocated UINTN that on output\r
+ contains the new section stream handle.\r
+\r
+ @retval EFI_SUCCESS\r
+ @retval EFI_OUT_OF_RESOURCES memory allocation failed.\r
+ @retval EFI_INVALID_PARAMETER section stream does not end concident with end of\r
+ last section.\r
+\r
+**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
IN VOID *SectionStream,\r
OUT UINTN *SectionStreamHandle\r
)\r
-/*++\r
-\r
-Routine Description:\r
- SEP member function. This function creates and returns a new section stream\r
- handle to represent the new section stream.\r
-\r
-Arguments:\r
- This - Indicates the calling context.\r
- SectionStreamLength - Size in bytes of the section stream.\r
- SectionStream - Buffer containing the new section stream.\r
- SectionStreamHandle - A pointer to a caller allocated UINTN that on output\r
- contains the new section stream handle.\r
-\r
-Returns:\r
- EFI_SUCCESS\r
- EFI_OUT_OF_RESOURCES - memory allocation failed.\r
- EFI_INVALID_PARAMETER - section stream does not end concident with end of\r
- last section.\r
-\r
---*/\r
{\r
//\r
// Check to see section stream looks good...\r
);\r
}\r
\r
+/**\r
+ SEP member function. Retrieves requested section from section stream.\r
+\r
+ @param This: Pointer to SEP instance.\r
+ @param SectionStreamHandle: The section stream from which to extract the requested\r
+ section.\r
+ @param SectionType: A pointer to the type of section to search for.\r
+ @param SectionDefinitionGuid: If the section type is EFI_SECTION_GUID_DEFINED, then\r
+ SectionDefinitionGuid indicates which of these types\r
+ of sections to search for.\r
+ @param SectionInstance: Indicates which instance of the requested section to\r
+ return.\r
+ @param Buffer: Double indirection to buffer. If *Buffer is non-null on\r
+ input, then the buffer is caller allocated. If\r
+ *Buffer is NULL, then the buffer is callee allocated.\r
+ In either case, the requried buffer size is returned\r
+ in *BufferSize.\r
+ @param BufferSize: On input, indicates the size of *Buffer if *Buffer is\r
+ non-null on input. On output, indicates the required\r
+ size (allocated size if callee allocated) of *Buffer.\r
+ @param AuthenticationStatus: Indicates the authentication status of the retrieved\r
+ section.\r
+\r
+ \r
+ @retval EFI_SUCCESS: Section was retrieved successfully\r
+ @retval EFI_PROTOCOL_ERROR: A GUID defined section was encountered in the section \r
+ stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED\r
+ bit set, but there was no corresponding GUIDed Section \r
+ Extraction Protocol in the handle database. *Buffer is \r
+ unmodified.\r
+ @retval EFI_NOT_FOUND: An error was encountered when parsing the SectionStream.\r
+ This indicates the SectionStream is not correctly \r
+ formatted.\r
+ @retval EFI_NOT_FOUND: The requested section does not exist.\r
+ @retval EFI_OUT_OF_RESOURCES: The system has insufficient resources to process the \r
+ request.\r
+ @retval EFI_INVALID_PARAMETER: The SectionStreamHandle does not exist.\r
+ @retval EFI_WARN_TOO_SMALL: The size of the caller allocated input buffer is \r
+ insufficient to contain the requested section. The \r
+ input buffer is filled and contents are section contents\r
+ are truncated.\r
+\r
+**/ \r
STATIC\r
EFI_STATUS\r
EFIAPI\r
IN OUT UINTN *BufferSize,\r
OUT UINT32 *AuthenticationStatus\r
)\r
-/*++\r
\r
-Routine Description:\r
- SEP member function. Retrieves requested section from section stream.\r
-\r
-Arguments: \r
- This: Pointer to SEP instance.\r
- SectionStreamHandle: The section stream from which to extract the requested\r
- section.\r
- SectionType: A pointer to the type of section to search for.\r
- SectionDefinitionGuid: If the section type is EFI_SECTION_GUID_DEFINED, then\r
- SectionDefinitionGuid indicates which of these types\r
- of sections to search for.\r
- SectionInstance: Indicates which instance of the requested section to\r
- return.\r
- Buffer: Double indirection to buffer. If *Buffer is non-null on\r
- input, then the buffer is caller allocated. If\r
- *Buffer is NULL, then the buffer is callee allocated.\r
- In either case, the requried buffer size is returned\r
- in *BufferSize.\r
- BufferSize: On input, indicates the size of *Buffer if *Buffer is\r
- non-null on input. On output, indicates the required\r
- size (allocated size if callee allocated) of *Buffer.\r
- AuthenticationStatus: Indicates the authentication status of the retrieved\r
- section.\r
-\r
-Returns: \r
- EFI_SUCCESS: Section was retrieved successfully\r
- EFI_PROTOCOL_ERROR: A GUID defined section was encountered in the section \r
- stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED\r
- bit set, but there was no corresponding GUIDed Section \r
- Extraction Protocol in the handle database. *Buffer is \r
- unmodified.\r
- EFI_NOT_FOUND: An error was encountered when parsing the SectionStream.\r
- This indicates the SectionStream is not correctly \r
- formatted.\r
- EFI_NOT_FOUND: The requested section does not exist.\r
- EFI_OUT_OF_RESOURCES: The system has insufficient resources to process the \r
- request.\r
- EFI_INVALID_PARAMETER: The SectionStreamHandle does not exist.\r
- EFI_WARN_TOO_SMALL: The size of the caller allocated input buffer is \r
- insufficient to contain the requested section. The \r
- input buffer is filled and contents are section contents\r
- are truncated.\r
-\r
---*/\r
{\r
CORE_SECTION_STREAM_NODE *StreamNode;\r
EFI_TPL OldTpl;\r
return Status;\r
}\r
\r
+/**\r
+ SEP member function. Deletes an existing section stream\r
+\r
+ @param This - Indicates the calling context.\r
+ @param StreamHandleToClose - Indicates the stream to close\r
+\r
+ @retval EFI_SUCCESS\r
+ @retval EFI_OUT_OF_RESOURCES - memory allocation failed.\r
+ @retval EFI_INVALID_PARAMETER - section stream does not end concident with end of\r
+ last section.\r
\r
+**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
IN EFI_SECTION_EXTRACTION_PROTOCOL *This,\r
IN UINTN StreamHandleToClose\r
)\r
-/*++\r
-\r
-Routine Description:\r
- SEP member function. Deletes an existing section stream\r
-\r
-Arguments:\r
- This - Indicates the calling context.\r
- StreamHandleToClose - Indicates the stream to close\r
\r
-Returns:\r
- EFI_SUCCESS\r
- EFI_OUT_OF_RESOURCES - memory allocation failed.\r
- EFI_INVALID_PARAMETER - section stream does not end concident with end of\r
- last section.\r
-\r
---*/\r
{\r
CORE_SECTION_STREAM_NODE *StreamNode;\r
EFI_TPL OldTpl;\r
return Status;\r
}\r
\r
+/**\r
+ Worker function. Determine if the input stream:child matches the input type.\r
+\r
+ @param Stream - Indicates the section stream associated with the child\r
+ @param Child - Indicates the child to check\r
+ @param SearchType - Indicates the type of section to check against for\r
+ @param SectionDefinitionGuid - Indicates the GUID to check against if the type is\r
+ EFI_SECTION_GUID_DEFINED\r
+\r
+ @retval TRUE - The child matches\r
+ @retval FALSE - The child doesn't match\r
\r
+**/\r
STATIC\r
BOOLEAN\r
ChildIsType (\r
IN EFI_SECTION_TYPE SearchType,\r
IN EFI_GUID *SectionDefinitionGuid\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Worker function. Determine if the input stream:child matches the input type.\r
-\r
-Arguments:\r
- Stream - Indicates the section stream associated with the child\r
- Child - Indicates the child to check\r
- SearchType - Indicates the type of section to check against for\r
- SectionDefinitionGuid - Indicates the GUID to check against if the type is\r
- EFI_SECTION_GUID_DEFINED\r
-Returns:\r
- TRUE - The child matches\r
- FALSE - The child doesn't match\r
-\r
---*/\r
{\r
EFI_GUID_DEFINED_SECTION *GuidedSection;\r
\r
return CompareGuid (&GuidedSection->SectionDefinitionGuid, SectionDefinitionGuid);\r
}\r
\r
+/**\r
+ Worker function Recursively searches / builds section stream database\r
+ looking for requested section.\r
\r
+\r
+ @param SourceStream - Indicates the section stream in which to do the search.\r
+ @param SearchType - Indicates the type of section to search for.\r
+ @param SectionInstance - Indicates which instance of section to find. This is\r
+ an in/out parameter to deal with recursions.\r
+ @param SectionDefinitionGuid - Guid of section definition\r
+ @param FoundChild - Output indicating the child node that is found.\r
+ @param FoundStream - Output indicating which section stream the child was\r
+ found in. If this stream was generated as a result of\r
+ an encapsulation section, the streamhandle is visible\r
+ within the SEP driver only.\r
+ @param AuthenticationStatus- Indicates the authentication status of the found section.\r
+\r
+ @retval EFI_SUCCESS - Child node was found and returned.\r
+ @retval EFI_OUT_OF_RESOURCES- Memory allocation failed.\r
+ @retval EFI_NOT_FOUND - Requested child node does not exist.\r
+ @retval EFI_PROTOCOL_ERROR - a required GUIDED section extraction protocol does not\r
+ exist\r
+\r
+**/\r
STATIC\r
EFI_STATUS\r
FindChildNode (\r
OUT CORE_SECTION_STREAM_NODE **FoundStream,\r
OUT UINT32 *AuthenticationStatus\r
)\r
-/*++\r
\r
-Routine Description:\r
- Worker function Recursively searches / builds section stream database\r
- looking for requested section.\r
-\r
-Arguments:\r
- SourceStream - Indicates the section stream in which to do the search.\r
- SearchType - Indicates the type of section to search for.\r
- SectionInstance - Indicates which instance of section to find. This is\r
- an in/out parameter to deal with recursions.\r
- SectionDefinitionGuid - Guid of section definition\r
- FoundChild - Output indicating the child node that is found.\r
- FoundStream - Output indicating which section stream the child was\r
- found in. If this stream was generated as a result of\r
- an encapsulation section, the streamhandle is visible\r
- within the SEP driver only.\r
- AuthenticationStatus- Indicates the authentication status of the found section.\r
-\r
-Returns:\r
- EFI_SUCCESS - Child node was found and returned.\r
- EFI_OUT_OF_RESOURCES- Memory allocation failed.\r
- EFI_NOT_FOUND - Requested child node does not exist.\r
- EFI_PROTOCOL_ERROR - a required GUIDED section extraction protocol does not\r
- exist\r
-\r
---*/\r
{\r
CORE_SECTION_CHILD_NODE *CurrentChildNode;\r
CORE_SECTION_CHILD_NODE *RecursedChildNode;\r
}\r
}\r
\r
-\r
-STATIC\r
-EFI_STATUS\r
-CreateChildNode (\r
- IN CORE_SECTION_STREAM_NODE *Stream,\r
- IN UINT32 ChildOffset,\r
- OUT CORE_SECTION_CHILD_NODE **ChildNode\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
Worker function. Constructor for new child nodes.\r
\r
-Arguments:\r
- Stream - Indicates the section stream in which to add the child.\r
- ChildOffset - Indicates the offset in Stream that is the beginning\r
+ @param Stream - Indicates the section stream in which to add the child.\r
+ @param ChildOffset - Indicates the offset in Stream that is the beginning\r
of the child section.\r
- ChildNode - Indicates the Callee allocated and initialized child.\r
+ @param ChildNode - Indicates the Callee allocated and initialized child.\r
\r
-Returns:\r
- EFI_SUCCESS - Child node was found and returned.\r
- EFI_OUT_OF_RESOURCES- Memory allocation failed.\r
- EFI_PROTOCOL_ERROR - Encapsulation sections produce new stream handles when\r
+ @retval EFI_SUCCESS - Child node was found and returned.\r
+ @retval EFI_OUT_OF_RESOURCES- Memory allocation failed.\r
+ @retval EFI_PROTOCOL_ERROR - Encapsulation sections produce new stream handles when\r
the child node is created. If the section type is GUID\r
defined, and the extraction GUID does not exist, and\r
producing the stream requires the GUID, then a protocol\r
error is generated and no child is produced.\r
Values returned by OpenSectionStreamEx.\r
\r
---*/\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+CreateChildNode (\r
+ IN CORE_SECTION_STREAM_NODE *Stream,\r
+ IN UINT32 ChildOffset,\r
+ OUT CORE_SECTION_CHILD_NODE **ChildNode\r
+ )\r
{\r
EFI_STATUS Status;\r
EFI_COMMON_SECTION_HEADER *SectionHeader;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Worker function. Constructor for RPN event if needed to keep AuthenticationStatus\r
+ cache correct when a missing GUIDED_SECTION_EXTRACTION_PROTOCOL appears...\r
\r
+ @param ParentStream - Indicates the parent of the ecnapsulation section (child)\r
+ @param ChildNode - Indicates the child node that is the encapsulation section.\r
+\r
+**/\r
STATIC\r
VOID\r
CreateGuidedExtractionRpnEvent (\r
IN CORE_SECTION_STREAM_NODE *ParentStream,\r
IN CORE_SECTION_CHILD_NODE *ChildNode\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Worker function. Constructor for RPN event if needed to keep AuthenticationStatus\r
- cache correct when a missing GUIDED_SECTION_EXTRACTION_PROTOCOL appears...\r
-\r
-Arguments:\r
- ParentStream - Indicates the parent of the ecnapsulation section (child)\r
- ChildNode - Indicates the child node that is the encapsulation section.\r
-\r
-Returns:\r
- None\r
-\r
---*/\r
{\r
RPN_EVENT_CONTEXT *Context;\r
\r
);\r
}\r
\r
- \r
+/**\r
+ RPN callback function. Removes a stale section stream and re-initializes it\r
+ with an updated AuthenticationStatus.\r
+\r
+ @param Event - The event that fired\r
+ @param RpnContext - A pointer to the context that allows us to identify\r
+ the relevent encapsulation...\r
+\r
+**/ \r
STATIC\r
VOID\r
EFIAPI\r
IN EFI_EVENT Event,\r
IN VOID *RpnContext\r
)\r
-/*++\r
-\r
-Routine Description:\r
- RPN callback function. Removes a stale section stream and re-initializes it\r
- with an updated AuthenticationStatus.\r
-\r
-Arguments:\r
- Event - The event that fired\r
- RpnContext - A pointer to the context that allows us to identify\r
- the relevent encapsulation...\r
-\r
-Returns:\r
- None\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_GUID_DEFINED_SECTION *GuidedHeader;\r
gBS->FreePool (Context);\r
} \r
\r
+/**\r
+ Worker function. Destructor for child nodes.\r
\r
+ @param ChildNode - Indicates the node to destroy\r
+\r
+**/\r
STATIC\r
VOID\r
FreeChildNode (\r
IN CORE_SECTION_CHILD_NODE *ChildNode\r
)\r
-/*++\r
\r
-Routine Description:\r
- Worker function. Destructor for child nodes.\r
-\r
-Arguments:\r
- ChildNode - Indicates the node to destroy\r
-\r
-Returns:\r
- none\r
-\r
---*/\r
{\r
ASSERT (ChildNode->Signature == CORE_SECTION_CHILD_SIGNATURE);\r
//\r
gBS->FreePool (ChildNode);\r
} \r
\r
+/**\r
+ Worker function. Constructor for section streams.\r
+\r
+ @param SectionStreamLength - Size in bytes of the section stream.\r
+ @param SectionStream - Buffer containing the new section stream.\r
+ @param AllocateBuffer - Indicates whether the stream buffer is to be copied\r
+ or the input buffer is to be used in place.\r
+ @param AuthenticationStatus- Indicates the default authentication status for the\r
+ new stream.\r
+ @param SectionStreamHandle - A pointer to a caller allocated section stream handle.\r
+\r
+ \r
+ @retval EFI_SUCCESS - Stream was added to stream database.\r
+ @retval EFI_OUT_OF_RESOURCES - memory allocation failed.\r
\r
+**/\r
STATIC\r
EFI_STATUS\r
OpenSectionStreamEx (\r
IN UINT32 AuthenticationStatus, \r
OUT UINTN *SectionStreamHandle\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Worker function. Constructor for section streams.\r
-\r
- Arguments:\r
- SectionStreamLength - Size in bytes of the section stream.\r
- SectionStream - Buffer containing the new section stream.\r
- AllocateBuffer - Indicates whether the stream buffer is to be copied\r
- or the input buffer is to be used in place.\r
- AuthenticationStatus- Indicates the default authentication status for the\r
- new stream.\r
- SectionStreamHandle - A pointer to a caller allocated section stream handle.\r
-\r
- Returns:\r
- EFI_SUCCESS - Stream was added to stream database.\r
- EFI_OUT_OF_RESOURCES - memory allocation failed.\r
\r
---*/\r
{\r
CORE_SECTION_STREAM_NODE *NewStream;\r
EFI_TPL OldTpl;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Worker function. Search stream database for requested stream handle.\r
\r
+ @param SearchHandle - Indicates which stream to look for.\r
+ @param FoundStream - Output pointer to the found stream.\r
+\r
+ @retval EFI_SUCCESS - StreamHandle was found and *FoundStream contains\r
+ the stream node.\r
+ @retval EFI_NOT_FOUND - SearchHandle was not found in the stream database.\r
+\r
+**/\r
STATIC\r
EFI_STATUS\r
FindStreamNode (\r
IN UINTN SearchHandle,\r
OUT CORE_SECTION_STREAM_NODE **FoundStream\r
)\r
-/*++\r
\r
- Routine Description:\r
- Worker function. Search stream database for requested stream handle.\r
-\r
- Arguments:\r
- SearchHandle - Indicates which stream to look for.\r
- FoundStream - Output pointer to the found stream.\r
-\r
- Returns:\r
- EFI_SUCCESS - StreamHandle was found and *FoundStream contains\r
- the stream node.\r
- EFI_NOT_FOUND - SearchHandle was not found in the stream database.\r
-\r
---*/\r
{ \r
CORE_SECTION_STREAM_NODE *StreamNode;\r
\r
return EFI_NOT_FOUND;\r
}\r
\r
+/**\r
+\r
+ Check if a stream is valid.\r
+\r
+ @param SectionStream - The section stream to be checked\r
+ @param SectionStreamLength - The length of section stream\r
\r
+ @return if a stream is valid.\r
+**/\r
STATIC\r
BOOLEAN\r
IsValidSectionStream (\r
IN VOID *SectionStream,\r
IN UINTN SectionStreamLength\r
)\r
-/*++\r
\r
-Routine Description:\r
- Check if a stream is valid.\r
-\r
-Arguments:\r
- SectionStream - The section stream to be checked\r
- SectionStreamLength - The length of section stream\r
-\r
-Returns:\r
- TRUE\r
- FALSE\r
-\r
---*/\r
{\r
UINTN TotalLength;\r
UINTN SectionLength;\r
return FALSE;\r
}\r
\r
-EFI_EVENT\r
-CoreCreateProtocolNotifyEvent (\r
- IN EFI_GUID *ProtocolGuid,\r
- IN EFI_TPL NotifyTpl,\r
- IN EFI_EVENT_NOTIFY NotifyFunction,\r
- IN VOID *NotifyContext,\r
- OUT VOID **Registration,\r
- IN BOOLEAN SignalFlag\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Create a protocol notification event and return it.\r
\r
-Arguments:\r
-\r
- ProtocolGuid - Protocol to register notification event on.\r
+ @param ProtocolGuid - Protocol to register notification event on.\r
\r
- NotifyTpl - Maximum TPL to signal the NotifyFunction.\r
+ @param NotifyTpl - Maximum TPL to signal the NotifyFunction.\r
\r
- NotifyFuncition - EFI notification routine.\r
+ @param NotifyFuncition - EFI notification routine.\r
\r
- NotifyContext - Context passed into Event when it is created.\r
+ @param NotifyContext - Context passed into Event when it is created.\r
\r
- Registration - Registration key returned from RegisterProtocolNotify().\r
+ @param Registration - Registration key returned from RegisterProtocolNotify().\r
\r
- SignalFlag - Boolean value to decide whether kick the event after register or not.\r
+ @param SignalFlag - Boolean value to decide whether kick the event after register or not.\r
\r
-Returns:\r
+ @Return The EFI_EVENT that has been registered to be signaled when a ProtocolGuid\r
+ is added to the system.\r
\r
- The EFI_EVENT that has been registered to be signaled when a ProtocolGuid\r
- is added to the system.\r
-\r
---*/\r
+**/\r
+EFI_EVENT\r
+CoreCreateProtocolNotifyEvent (\r
+ IN EFI_GUID *ProtocolGuid,\r
+ IN EFI_TPL NotifyTpl,\r
+ IN EFI_EVENT_NOTIFY NotifyFunction,\r
+ IN VOID *NotifyContext,\r
+ OUT VOID **Registration,\r
+ IN BOOLEAN SignalFlag\r
+ )\r
{\r
EFI_STATUS Status;\r
EFI_EVENT Event;\r
/**@file\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
- SectionExtraction.c\r
- \r
-Abstract:\r
-\r
Section Extraction Protocol implementation.\r
\r
Stream database is implemented as a linked list of section streams,\r
\r
3) A support protocol is not found, and the data is not available to be read\r
without it. This results in EFI_PROTOCOL_ERROR.\r
- \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
**/\r
\r
#ifndef _SECION_EXTRACTION_H_\r
-\r
/** @file\r
Serial I/O status code reporting worker.\r
\r
\r
return EFI_SUCCESS;\r
}\r
+\r
\r
return EFI_SUCCESS;\r
}\r
+\r
-\r
/** @file\r
Generic PeiStatusCode Module.\r
\r
-\r
/** @file\r
Heade file of status code PEIM\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: PeiStatusCode.h\r
-\r
**/\r
\r
#ifndef __PEI_STATUS_CODE_H__\r
IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL\r
);\r
\r
-#endif\r
+#endif //__PEI_STATUS_CODE_H__\r
+\r
+\r
-\r
/** @file\r
Serial I/O status code reporting worker.\r
\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: SerialStatusCodeWorker.c\r
-\r
**/\r
\r
#include "PeiStatusCode.h"\r
\r
return EFI_SUCCESS;\r
}\r
+\r
/** @file\r
-\r
+ Framework PEIM to provide the Variable functionality\r
+ \r
Copyright (c) 2006 - 2008 Intel Corporation. <BR>\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
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
Module Name:\r
\r
- Variable.c\r
-\r
-Abstract:\r
-\r
- Framework PEIM to provide the Variable functionality\r
-\r
**/\r
\r
\r
\r
EFI_GUID mEfiVariableIndexTableGuid = EFI_VARIABLE_INDEX_TABLE_GUID;\r
\r
+/**\r
+ Provide the functionality of the variable services.\r
+\r
+ @param FfsHeadher - The FFS file header\r
+ @param PeiServices - General purpose services available to every PEIM.\r
+\r
+ @return Status - EFI_SUCCESS if the interface could be successfully\r
+ installed\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeimInitializeVariableServices (\r
IN EFI_FFS_FILE_HEADER *FfsHeader,\r
IN EFI_PEI_SERVICES **PeiServices\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Provide the functionality of the variable services.\r
-\r
-Arguments:\r
-\r
- FfsHeadher - The FFS file header\r
- PeiServices - General purpose services available to every PEIM.\r
-\r
-Returns:\r
-\r
- Status - EFI_SUCCESS if the interface could be successfully\r
- installed\r
-\r
---*/\r
{\r
//\r
// Publish the variable capability to other modules\r
\r
}\r
\r
-VARIABLE_HEADER *\r
-GetStartPointer (\r
- IN VARIABLE_STORE_HEADER *VarStoreHeader\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
This code gets the pointer to the first variable memory pointer byte\r
\r
-Arguments:\r
-\r
- VarStoreHeader Pointer to the Variable Store Header.\r
-\r
-Returns:\r
+ @param VarStoreHeader Pointer to the Variable Store Header.\r
\r
- VARIABLE_HEADER* Pointer to last unavailable Variable Header\r
+ @Return VARIABLE_HEADER* Pointer to last unavailable Variable Header\r
\r
---*/\r
+**/\r
+VARIABLE_HEADER *\r
+GetStartPointer (\r
+ IN VARIABLE_STORE_HEADER *VarStoreHeader\r
+ )\r
{\r
//\r
// The end of variable store\r
return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);\r
}\r
\r
-VARIABLE_HEADER *\r
-GetEndPointer (\r
- IN VARIABLE_STORE_HEADER *VarStoreHeader\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
This code gets the pointer to the last variable memory pointer byte\r
\r
-Arguments:\r
+ @param VarStoreHeader Pointer to the Variable Store Header.\r
\r
- VarStoreHeader Pointer to the Variable Store Header.\r
+ @Return VARIABLE_HEADER* Pointer to last unavailable Variable Header\r
\r
-Returns:\r
-\r
- VARIABLE_HEADER* Pointer to last unavailable Variable Header\r
+**/\r
+VARIABLE_HEADER *\r
+GetEndPointer (\r
+ IN VARIABLE_STORE_HEADER *VarStoreHeader\r
+ )\r
\r
---*/\r
{\r
//\r
// The end of variable store\r
return (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN) VarStoreHeader + VarStoreHeader->Size);\r
}\r
\r
+/**\r
+\r
+ This code checks if variable header is valid or not.\r
+\r
+ @param Variable Pointer to the Variable Header.\r
+\r
+ @retval TRUE Variable header is valid.\r
+ @retval FALSE Variable header is not valid.\r
+\r
+**/\r
STATIC\r
BOOLEAN\r
EFIAPI\r
IsValidVariableHeader (\r
IN VARIABLE_HEADER *Variable\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- This code checks if variable header is valid or not.\r
-\r
-Arguments:\r
- Variable Pointer to the Variable Header.\r
-\r
-Returns:\r
- TRUE Variable header is valid.\r
- FALSE Variable header is not valid.\r
-\r
---*/\r
{\r
if (Variable == NULL || Variable->StartId != VARIABLE_DATA ) {\r
return FALSE;\r
return TRUE;\r
}\r
\r
+/**\r
+ This code gets the size of name of variable.\r
+\r
+ @param Variable Pointer to the Variable Header.\r
\r
+ @Return UINTN Size of variable in bytes\r
+\r
+**/\r
UINTN\r
NameSizeOfVariable (\r
IN VARIABLE_HEADER *Variable\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- This code gets the size of name of variable.\r
-\r
-Arguments:\r
-\r
- Variable Pointer to the Variable Header.\r
-\r
-Returns:\r
-\r
- UINTN Size of variable in bytes\r
-\r
---*/\r
{\r
if (Variable->State == (UINT8) (-1) ||\r
Variable->DataSize == (UINT32) -1 ||\r
return (UINTN) Variable->NameSize;\r
}\r
\r
-UINTN\r
-DataSizeOfVariable (\r
- IN VARIABLE_HEADER *Variable\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
This code gets the size of name of variable.\r
\r
-Arguments:\r
-\r
- Variable Pointer to the Variable Header.\r
+ @param Variable Pointer to the Variable Header.\r
\r
-Returns:\r
+ @Return UINTN Size of variable in bytes\r
\r
- UINTN Size of variable in bytes\r
-\r
---*/\r
+**/\r
+UINTN\r
+DataSizeOfVariable (\r
+ IN VARIABLE_HEADER *Variable\r
+ )\r
{\r
if (Variable->State == (UINT8) -1 ||\r
Variable->DataSize == (UINT32) -1 ||\r
return (UINTN) Variable->DataSize;\r
}\r
\r
-CHAR16 *\r
-GetVariableNamePtr (\r
- IN VARIABLE_HEADER *Variable\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
This code gets the pointer to the variable name.\r
\r
-Arguments:\r
+ @param Variable Pointer to the Variable Header.\r
\r
- Variable Pointer to the Variable Header.\r
+ @Return CHAR16* Pointer to Variable Name\r
\r
-Returns:\r
-\r
- CHAR16* Pointer to Variable Name\r
+**/\r
+CHAR16 *\r
+GetVariableNamePtr (\r
+ IN VARIABLE_HEADER *Variable\r
+ )\r
\r
---*/\r
{\r
\r
return (CHAR16 *) (Variable + 1);\r
}\r
\r
+/**\r
+ This code gets the pointer to the variable data.\r
+\r
+ @param Variable Pointer to the Variable Header.\r
+\r
+ @Return UINT8* Pointer to Variable Data\r
\r
+**/\r
UINT8 *\r
GetVariableDataPtr (\r
IN VARIABLE_HEADER *Variable\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- This code gets the pointer to the variable data.\r
-\r
-Arguments:\r
-\r
- Variable Pointer to the Variable Header.\r
-\r
-Returns:\r
-\r
- UINT8* Pointer to Variable Data\r
-\r
---*/\r
{\r
UINTN Value;\r
\r
return (UINT8 *) Value;\r
}\r
\r
-VARIABLE_HEADER *\r
-GetNextVariablePtr (\r
- IN VARIABLE_HEADER *Variable\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
This code gets the pointer to the next variable header.\r
\r
-Arguments:\r
+ @param Variable Pointer to the Variable Header.\r
\r
- Variable Pointer to the Variable Header.\r
+ @Return VARIABLE_HEADER* Pointer to next variable header.\r
\r
-Returns:\r
-\r
- VARIABLE_HEADER* Pointer to next variable header.\r
+**/\r
+VARIABLE_HEADER *\r
+GetNextVariablePtr (\r
+ IN VARIABLE_HEADER *Variable\r
+ )\r
\r
---*/\r
{\r
UINTN Value;\r
\r
return (VARIABLE_HEADER *) HEADER_ALIGN (Value);\r
}\r
\r
+/**\r
+ This code gets the pointer to the variable name.\r
+\r
+ @param VarStoreHeader Pointer to the Variable Store Header.\r
\r
+ @retval EfiRaw Variable store is raw\r
+ @retval EfiValid Variable store is valid\r
+ @retval EfiInvalid Variable store is invalid\r
+\r
+**/\r
STATIC\r
VARIABLE_STORE_STATUS\r
EFIAPI\r
GetVariableStoreStatus (\r
IN VARIABLE_STORE_HEADER *VarStoreHeader\r
)\r
-/*++\r
-\r
-Routine Description:\r
\r
- This code gets the pointer to the variable name.\r
-\r
-Arguments:\r
-\r
- VarStoreHeader Pointer to the Variable Store Header.\r
-\r
-Returns:\r
-\r
- EfiRaw Variable store is raw\r
- EfiValid Variable store is valid\r
- EfiInvalid Variable store is invalid\r
-\r
---*/\r
{\r
if (VarStoreHeader->Signature == VARIABLE_STORE_SIGNATURE &&\r
VarStoreHeader->Format == VARIABLE_STORE_FORMATTED &&\r
}\r
}\r
\r
+/**\r
+ This function compares a variable with variable entries in database\r
+\r
+ @param Variable - Pointer to the variable in our database\r
+ @param VariableName - Name of the variable to compare to 'Variable'\r
+ @param VendorGuid - GUID of the variable to compare to 'Variable'\r
+ @param PtrTrack - Variable Track Pointer structure that contains\r
+ Variable Information.\r
+\r
+ @Retval EFI_SUCCESS - Found match variable\r
+ @retval EFI_NOT_FOUND - Variable not found\r
+\r
+**/\r
STATIC\r
EFI_STATUS\r
CompareWithValidVariable (\r
IN CONST EFI_GUID *VendorGuid,\r
OUT VARIABLE_POINTER_TRACK *PtrTrack\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- This function compares a variable with variable entries in database\r
-\r
-Arguments:\r
\r
- Variable - Pointer to the variable in our database\r
- VariableName - Name of the variable to compare to 'Variable'\r
- VendorGuid - GUID of the variable to compare to 'Variable'\r
- PtrTrack - Variable Track Pointer structure that contains\r
- Variable Information.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - Found match variable\r
- EFI_NOT_FOUND - Variable not found\r
-\r
---*/\r
{\r
VOID *Point;\r
\r
return EFI_NOT_FOUND;\r
}\r
\r
+/**\r
+ This code finds variable in storage blocks (Non-Volatile)\r
+\r
+ @param PeiServices - General purpose services available to every PEIM.\r
+ @param VariableName - Name of the variable to be found\r
+ @param VendorGuid - Vendor GUID to be found.\r
+ @param PtrTrack - Variable Track Pointer structure that contains\r
+ Variable Information.\r
+\r
+ @retval EFI_SUCCESS - Variable found successfully\r
+ @retval EFI_NOT_FOUND - Variable not found\r
+ @retval EFI_INVALID_PARAMETER - Invalid variable name\r
+\r
+**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
IN CONST EFI_GUID *VendorGuid,\r
OUT VARIABLE_POINTER_TRACK *PtrTrack\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- This code finds variable in storage blocks (Non-Volatile)\r
-\r
-Arguments:\r
-\r
- PeiServices - General purpose services available to every PEIM.\r
- VariableName - Name of the variable to be found\r
- VendorGuid - Vendor GUID to be found.\r
- PtrTrack - Variable Track Pointer structure that contains\r
- Variable Information.\r
-\r
-Returns:\r
\r
- EFI_SUCCESS - Variable found successfully\r
- EFI_NOT_FOUND - Variable not found\r
- EFI_INVALID_PARAMETER - Invalid variable name\r
-\r
---*/\r
{\r
EFI_HOB_GUID_TYPE *GuidHob;\r
VARIABLE_STORE_HEADER *VariableStoreHeader;\r
return EFI_NOT_FOUND;\r
}\r
\r
-EFI_STATUS\r
-EFIAPI\r
-PeiGetVariable (\r
- IN EFI_PEI_SERVICES **PeiServices,\r
- IN CHAR16 *VariableName,\r
- IN EFI_GUID * VendorGuid,\r
- OUT UINT32 *Attributes OPTIONAL,\r
- IN OUT UINTN *DataSize,\r
- OUT VOID *Data\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Provide the read variable functionality of the variable services.\r
\r
-Arguments:\r
-\r
- PeiServices - General purpose services available to every PEIM.\r
+ @param PeiServices - General purpose services available to every PEIM.\r
\r
- VariableName - The variable name\r
+ @param VariableName - The variable name\r
\r
- VendorGuid - The vendor's GUID\r
+ @param VendorGuid - The vendor's GUID\r
\r
- Attributes - Pointer to the attribute\r
+ @param Attributes - Pointer to the attribute\r
\r
- DataSize - Size of data\r
+ @param DataSize - Size of data\r
\r
- Data - Pointer to data\r
+ @param Data - Pointer to data\r
\r
-Returns:\r
+ @retval EFI_SUCCESS - The interface could be successfully installed\r
\r
- EFI_SUCCESS - The interface could be successfully installed\r
+ @retval EFI_NOT_FOUND - The variable could not be discovered\r
\r
- EFI_NOT_FOUND - The variable could not be discovered\r
+ @retval EFI_BUFFER_TOO_SMALL - The caller buffer is not large enough\r
\r
- EFI_BUFFER_TOO_SMALL - The caller buffer is not large enough\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiGetVariable (\r
+ IN EFI_PEI_SERVICES **PeiServices,\r
+ IN CHAR16 *VariableName,\r
+ IN EFI_GUID * VendorGuid,\r
+ OUT UINT32 *Attributes OPTIONAL,\r
+ IN OUT UINTN *DataSize,\r
+ OUT VOID *Data\r
+ )\r
\r
---*/\r
{\r
VARIABLE_POINTER_TRACK Variable;\r
UINTN VarDataSize;\r
}\r
}\r
\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-PeiGetVariable2 (\r
- IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
- IN CONST CHAR16 *VariableName,\r
- IN CONST EFI_GUID *VariableGuid,\r
- OUT UINT32 *Attributes,\r
- IN OUT UINTN *DataSize,\r
- OUT VOID *Data\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Provide the read variable functionality of the variable services.\r
\r
-Arguments:\r
-\r
- PeiServices - General purpose services available to every PEIM.\r
+ @param PeiServices - General purpose services available to every PEIM.\r
\r
- VariableName - The variable name\r
+ @param VariableName - The variable name\r
\r
- VendorGuid - The vendor's GUID\r
+ @param VendorGuid - The vendor's GUID\r
\r
- Attributes - Pointer to the attribute\r
+ @param Attributes - Pointer to the attribute\r
\r
- DataSize - Size of data\r
+ @param DataSize - Size of data\r
\r
- Data - Pointer to data\r
+ @param Data - Pointer to data\r
\r
-Returns:\r
+ @retval EFI_SUCCESS - The interface could be successfully installed\r
\r
- EFI_SUCCESS - The interface could be successfully installed\r
+ @retval EFI_NOT_FOUND - The variable could not be discovered\r
\r
- EFI_NOT_FOUND - The variable could not be discovered\r
+ @retval EFI_BUFFER_TOO_SMALL - The caller buffer is not large enough\r
\r
- EFI_BUFFER_TOO_SMALL - The caller buffer is not large enough\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiGetVariable2 (\r
+ IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
+ IN CONST CHAR16 *VariableName,\r
+ IN CONST EFI_GUID *VariableGuid,\r
+ OUT UINT32 *Attributes,\r
+ IN OUT UINTN *DataSize,\r
+ OUT VOID *Data\r
+ )\r
\r
---*/\r
{\r
return PeiGetVariable (\r
GetPeiServicesTablePointer (),\r
);\r
}\r
\r
-EFI_STATUS\r
-EFIAPI\r
-PeiGetNextVariableName (\r
- IN EFI_PEI_SERVICES **PeiServices,\r
- IN OUT UINTN *VariableNameSize,\r
- IN OUT CHAR16 *VariableName,\r
- IN OUT EFI_GUID *VendorGuid\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Provide the get next variable functionality of the variable services.\r
\r
-Arguments:\r
+ @param PeiServices - General purpose services available to every PEIM.\r
+ @param VariabvleNameSize - The variable name's size.\r
+ @param VariableName - A pointer to the variable's name.\r
+ @param VendorGuid - A pointer to the EFI_GUID structure.\r
\r
- PeiServices - General purpose services available to every PEIM.\r
- VariabvleNameSize - The variable name's size.\r
- VariableName - A pointer to the variable's name.\r
- VendorGuid - A pointer to the EFI_GUID structure.\r
+ @param VariableNameSize - Size of the variable name\r
\r
- VariableNameSize - Size of the variable name\r
+ @param VariableName - The variable name\r
\r
- VariableName - The variable name\r
+ @param VendorGuid - The vendor's GUID\r
\r
- VendorGuid - The vendor's GUID\r
+ @retval EFI_SUCCESS - The interface could be successfully installed\r
\r
-Returns:\r
+ @retval EFI_NOT_FOUND - The variable could not be discovered\r
\r
- EFI_SUCCESS - The interface could be successfully installed\r
-\r
- EFI_NOT_FOUND - The variable could not be discovered\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiGetNextVariableName (\r
+ IN EFI_PEI_SERVICES **PeiServices,\r
+ IN OUT UINTN *VariableNameSize,\r
+ IN OUT CHAR16 *VariableName,\r
+ IN OUT EFI_GUID *VendorGuid\r
+ )\r
\r
---*/\r
{\r
VARIABLE_POINTER_TRACK Variable;\r
UINTN VarNameSize;\r
return EFI_NOT_FOUND;\r
}\r
\r
-EFI_STATUS\r
-EFIAPI\r
-PeiGetNextVariableName2 (\r
- IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
- IN OUT UINTN *VariableNameSize,\r
- IN OUT CHAR16 *VariableName,\r
- IN OUT EFI_GUID *VariableGuid\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Provide the get next variable functionality of the variable services.\r
\r
-Arguments:\r
+ @param PeiServices - General purpose services available to every PEIM.\r
+ @param VariabvleNameSize - The variable name's size.\r
+ @param VariableName - A pointer to the variable's name.\r
+ @param VariableGuid - A pointer to the EFI_GUID structure.\r
\r
- PeiServices - General purpose services available to every PEIM.\r
- VariabvleNameSize - The variable name's size.\r
- VariableName - A pointer to the variable's name.\r
- VariableGuid - A pointer to the EFI_GUID structure.\r
+ @param VariableNameSize - Size of the variable name\r
\r
- VariableNameSize - Size of the variable name\r
+ @param VariableName - The variable name\r
\r
- VariableName - The variable name\r
+ @param VendorGuid - The vendor's GUID\r
\r
- VendorGuid - The vendor's GUID\r
\r
-Returns:\r
+ @retval EFI_SUCCESS - The interface could be successfully installed\r
\r
- EFI_SUCCESS - The interface could be successfully installed\r
+ @retval EFI_NOT_FOUND - The variable could not be discovered\r
\r
- EFI_NOT_FOUND - The variable could not be discovered\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiGetNextVariableName2 (\r
+ IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
+ IN OUT UINTN *VariableNameSize,\r
+ IN OUT CHAR16 *VariableName,\r
+ IN OUT EFI_GUID *VariableGuid\r
+ )\r
\r
---*/\r
{\r
return PeiGetNextVariableName (\r
GetPeiServicesTablePointer (),\r
VariableGuid\r
);\r
}\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
- Variable.h\r
-\r
-Abstract:\r
-\r
- Tiano PEIM to provide the variable functionality\r
-\r
**/\r
\r
#ifndef _PEI_VARIABLE_H\r
IN EFI_FFS_FILE_HEADER *FfsHeader,\r
IN EFI_PEI_SERVICES **PeiServices\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FfsHeader - TODO: add argument description\r
- PeiServices - TODO: add argument description\r
-\r
-Returns:\r
-\r
- TODO: add return values\r
-\r
---*/\r
;\r
\r
EFI_STATUS\r
IN OUT UINTN *DataSize,\r
OUT VOID *Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- TODO: Add function description\r
-\r
-Arguments:\r
-\r
- PeiServices - TODO: add argument description\r
- VariableName - TODO: add argument description\r
- VendorGuid - TODO: add argument description\r
- Attributes - TODO: add argument description\r
- DataSize - TODO: add argument description\r
- Data - TODO: add argument description\r
-\r
-Returns:\r
-\r
- TODO: add return values\r
-\r
---*/\r
;\r
\r
EFI_STATUS\r
IN OUT UINTN *DataSize,\r
OUT VOID *Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Provide the read variable functionality of the variable services.\r
-\r
-Arguments:\r
-\r
- PeiServices - General purpose services available to every PEIM.\r
-\r
- VariableName - The variable name\r
-\r
- VendorGuid - The vendor's GUID\r
-\r
- Attributes - Pointer to the attribute\r
-\r
- DataSize - Size of data\r
-\r
- Data - Pointer to data\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The interface could be successfully installed\r
-\r
- EFI_NOT_FOUND - The variable could not be discovered\r
-\r
- EFI_BUFFER_TOO_SMALL - The caller buffer is not large enough\r
-\r
---*/\r
; \r
\r
EFI_STATUS\r
IN OUT CHAR16 *VariableName,\r
IN OUT EFI_GUID *VariableGuid\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Provide the get next variable functionality of the variable services.\r
-\r
-Arguments:\r
-\r
- PeiServices - General purpose services available to every PEIM.\r
- VariabvleNameSize - The variable name's size.\r
- VariableName - A pointer to the variable's name.\r
- VariableGuid - A pointer to the EFI_GUID structure.\r
-\r
- VariableNameSize - Size of the variable name\r
-\r
- VariableName - The variable name\r
-\r
- VendorGuid - The vendor's GUID\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The interface could be successfully installed\r
-\r
- EFI_NOT_FOUND - The variable could not be discovered\r
-\r
---*/\r
;\r
\r
EFI_STATUS\r
IN OUT CHAR16 *VariableName,\r
IN OUT EFI_GUID *VendorGuid\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- TODO: Add function description\r
-\r
-Arguments:\r
-\r
- PeiServices - TODO: add argument description\r
- VariableNameSize - TODO: add argument description\r
- VariableName - TODO: add argument description\r
- VendorGuid - TODO: add argument description\r
-\r
-Returns:\r
-\r
- TODO: add return values\r
-\r
---*/\r
;\r
\r
/**\r
projects / mirror_edk2.git / commitdiff