From: vanjeff Date: Mon, 6 Jul 2009 03:15:53 +0000 (+0000) Subject: updated function headers. X-Git-Tag: edk2-stable201903~17555 X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=516e9f28634173a9a38bd3c18c58e875a75b8251 updated function headers. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8753 6f19259b-4bc3-4df7-8a09-765794883524 --- diff --git a/IntelFrameworkPkg/Include/Ppi/Smbus.h b/IntelFrameworkPkg/Include/Ppi/Smbus.h index 89d3ecf251..9cfe330f3d 100644 --- a/IntelFrameworkPkg/Include/Ppi/Smbus.h +++ b/IntelFrameworkPkg/Include/Ppi/Smbus.h @@ -33,19 +33,19 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI; /** Executes an SMBus operation to an SMBus controller. - @param PeiServices A pointer to the system PEI Services Table. - @param This A pointer to the EFI_PEI_SMBUS_PPI instance. - @param SlaveAddress The SMBUS hardware address to which the SMBUS - device is preassigned or allocated. - @param Command This command is transmitted by the SMBus host - controller to the SMBus slave device and the interpretation is - SMBus slave device specific. - @param Operation Signifies which particular SMBus hardware protocol - instance that it will use to execute the SMBus transactions. - @param PecCheck Defines if Packet Error Code (PEC) checking is required - for this operation. - @param Length Signifies the number of bytes that this operation will do. - @param Buffer Contains the value of data to execute to the SMBus slave device. + @param[in] PeiServices A pointer to the system PEI Services Table. + @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance. + @param[in] SlaveAddress The SMBUS hardware address to which the SMBUS + device is preassigned or allocated. + @param[in] Command This command is transmitted by the SMBus host + controller to the SMBus slave device and the interpretation is + SMBus slave device specific. + @param[in] Operation Signifies which particular SMBus hardware protocol + instance that it will use to execute the SMBus transactions. + @param[in] PecCheck Defines if Packet Error Code (PEC) checking is required + for this operation. + @param[in, out] Length Signifies the number of bytes that this operation will do. + @param[in, out] Buffer Contains the value of data to execute to the SMBus slave device. @retval EFI_SUCCESS The last data that was returned from the access matched the poll exit criteria. @@ -79,12 +79,12 @@ EFI_STATUS /** CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY. - @param PeiServices A pointer to the system PEI Services Table. - @param This A pointer to the EFI_PEI_SMBUS_PPI instance. - @param SlaveAddress The SMBUS hardware address to which the SMBUS - device is preassigned or allocated. - @param Data Data of the SMBus host notify command that - the caller wants to be called. + @param[in] PeiServices A pointer to the system PEI Services Table. + @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance. + @param[in] SlaveAddress The SMBUS hardware address to which the SMBUS + device is preassigned or allocated. + @param[in] Data Data of the SMBus host notify command that + the caller wants to be called. @return Status Code returned by callback function. @@ -102,17 +102,17 @@ EFI_STATUS The ArpDevice() function enumerates the entire bus or enumerates a specific device that is identified by SmbusUdid. - @param PeiServices A pointer to the system PEI Services Table. - @param This A pointer to the EFI_PEI_SMBUS_PPI instance. - @param ArpAll A Boolean expression that indicates if the host drivers need - to enumerate all the devices or enumerate only the device that is identified - by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional. - If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address - will be at SlaveAddress. - @param SmbusUdid The targeted SMBus Unique Device Identifier (UDID). - The UDID may not exist for SMBus devices with fixed addresses. - @param SlaveAddress The new SMBus address for the slave device for - which the operation is targeted. + @param[in] PeiServices A pointer to the system PEI Services Table. + @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance. + @param[in] ArpAll A Boolean expression that indicates if the host drivers need + to enumerate all the devices or enumerate only the device that is identified + by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional. + If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address + will be at SlaveAddress. + @param[in] SmbusUdid The targeted SMBus Unique Device Identifier (UDID). + The UDID may not exist for SMBus devices with fixed addresses. + @param[in, out] SlaveAddress The new SMBus address for the slave device for + which the operation is targeted. @retval EFI_SUCCESS The SMBus slave device address was set. @retval EFI_INVALID_PARAMETER SlaveAddress is NULL. @@ -136,11 +136,11 @@ EFI_STATUS The GetArpMap() function returns the mapping of all the SMBus devices that are enumerated by the SMBus host driver. - @param PeiServices A pointer to the system PEI Services Table. - @param This A pointer to the EFI_PEI_SMBUS_PPI instance. - @param Length Size of the buffer that contains the SMBus device map. - @param SmbusDeviceMap The pointer to the device map as enumerated - by the SMBus controller driver. + @param[in] PeiServices A pointer to the system PEI Services Table. + @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance. + @param[in, out] Length Size of the buffer that contains the SMBus device map. + @param[in, out] SmbusDeviceMap The pointer to the device map as enumerated + by the SMBus controller driver. @retval EFI_SUCCESS The device map was returned correctly in the buffer. @@ -161,16 +161,16 @@ EFI_STATUS The Notify() function registers all the callback functions to allow the bus driver to call these functions when the SlaveAddress/Data pair happens. - @param PeiServices A pointer to the system PEI Services Table. - @param This A pointer to the EFI_PEI_SMBUS_PPI instance. - @param SlaveAddress Address that the host controller detects as - sending a message and calls all the registered functions. - @param Data Data that the host controller detects as sending a message - and calls all the registered functions. - @param NotifyFunction The function to call when the bus driver - detects the SlaveAddress and Data pair. + @param[in] PeiServices A pointer to the system PEI Services Table. + @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance. + @param[in] SlaveAddress Address that the host controller detects as + sending a message and calls all the registered functions. + @param[in] Data Data that the host controller detects as sending a message + and calls all the registered functions. + @param[in] NotifyFunction The function to call when the bus driver + detects the SlaveAddress and Data pair. - @retval EFI_SUCCESS NotifyFunction has been registered. + @retval EFI_SUCCESS NotifyFunction has been registered. **/ typedef diff --git a/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h b/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h index a14ca9411a..a1fa539996 100644 --- a/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h +++ b/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h @@ -102,7 +102,7 @@ typedef enum{ typedef EFI_STATUS (EFIAPI *EFI_GET_ROOT_HPC_LIST)( - IN EFI_PCI_HOT_PLUG_INIT_PROTOCOL *This, + IN EFI_PCI_HOT_PLUG_INIT_PROTOCOL *This, OUT UINTN *HpcCount, OUT EFI_HPC_LOCATION **HpcList ); @@ -137,7 +137,7 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_INITIALIZE_ROOT_HPC)( - IN EFI_PCI_HOT_PLUG_INIT_PROTOCOL *This, + IN EFI_PCI_HOT_PLUG_INIT_PROTOCOL *This, IN EFI_DEVICE_PATH_PROTOCOL *HpcDevicePath, IN UINT64 HpcPciAddress, IN EFI_EVENT Event, OPTIONAL @@ -175,7 +175,7 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_GET_HOT_PLUG_PADDING)( - IN EFI_PCI_HOT_PLUG_INIT_PROTOCOL *This, + IN EFI_PCI_HOT_PLUG_INIT_PROTOCOL *This, IN EFI_DEVICE_PATH_PROTOCOL *HpcDevicePath, IN UINT64 HpcPciAddress, OUT EFI_HPC_STATE *HpcState,