[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / Smbus.h

/** @file\r
  This file declares the Smbus PPI, which provides the basic I/O interfaces that a PEIM\r
  uses to access its SMBus controller and the slave devices attached to it.\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under\r
the terms and conditions of the BSD License that accompanies this distribution.\r
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
  @par Revision Reference:\r
  This PPI is defined in Framework of EFI SmBus PPI spec.\r
  Version 0.9.\r
\r
**/\r
\r
#ifndef _PEI_SMBUS_PPI_H_\r
#define _PEI_SMBUS_PPI_H_\r
\r
#include <Ppi/Smbus2.h>\r
\r
#define EFI_PEI_SMBUS_PPI_GUID \\r
  { \\r
    0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0xb, 0xfb, 0xda } \\r
  }\r
\r
typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;\r
\r
/**\r
  Executes an SMBus operation to an SMBus controller.\r
\r
  @param[in]      PeiServices   A pointer to the system PEI Services Table.\r
  @param[in]      This          A pointer to the EFI_PEI_SMBUS_PPI instance.\r
  @param[in]      SlaveAddress  The SMBUS hardware address to which the SMBUS\r
                                device is preassigned or allocated.\r
  @param[in]      Command       This command is transmitted by the SMBus host\r
                                controller to the SMBus slave device, and the\r
                                interpretation is SMBus slave device specific.\r
  @param[in]      Operation     Signifies which particular SMBus hardware protocol\r
                                instance to use to execute the SMBus transactions.\r
  @param[in]      PecCheck      Defines if Packet Error Code (PEC) checking is\r
                                required for this operation.\r
  @param[in, out] Length        The number of bytes for this operation.\r
  @param[in, out] Buffer        Contains the value of data to execute to the SMBus\r
                                slave device.\r
\r
  @retval EFI_SUCCESS           The last data that was returned from the access\r
                                matched the poll exit criteria.\r
  @retval EFI_CRC_ERROR         The checksum is not correct (PEC is incorrect).\r
  @retval EFI_TIMEOUT           Timeout expired before the operation was completed.\r
                                Timeout is determined by the SMBus host controller device.\r
  @retval EFI_OUT_OF_RESOURCES  The request could not be completed\r
                                due to a lack of resources.\r
  @retval EFI_DEVICE_ERROR      The request was not completed because a failure\r
                                was recorded in the Host Status Register bit.\r
  @retval EFI_INVALID_PARAMETER The operation is not defined in EFI_SMBUS_OPERATION.\r
  @retval EFI_INVALID_PARAMETER Length/Buffer is NULL for operations except for\r
                                EfiSmbusQuickRead and EfiSmbusQuickWrite. Length\r
                                is outside the range of valid values.\r
  @retval EFI_UNSUPPORTED       The SMBus operation or PEC is not supported.\r
  @retval EFI_BUFFER_TOO_SMALL  Buffer is not sufficient for this operation.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION)(\r
  IN      EFI_PEI_SERVICES          **PeiServices,\r
  IN      EFI_PEI_SMBUS_PPI         *This,\r
  IN      EFI_SMBUS_DEVICE_ADDRESS  SlaveAddress,\r
  IN      EFI_SMBUS_DEVICE_COMMAND  Command,\r
  IN      EFI_SMBUS_OPERATION       Operation,\r
  IN      BOOLEAN                   PecCheck,\r
  IN OUT  UINTN                     *Length,\r
  IN OUT  VOID                      *Buffer\r
  );\r
\r
/**\r
  This function is user-defined, and is called when the SlaveAddress/Data pair happens.\r
\r
  @param[in]  PeiServices    A pointer to the system PEI Services Table.\r
  @param[in]  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
  @param[in]  SlaveAddress   The SMBUS hardware address to which the SMBUS\r
                             device is preassigned or allocated.\r
  @param[in]  Data           Data of the SMBus host notify command, which denotes that\r
                             the caller wants to be called.\r
\r
  @return Status Code returned by callback function.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_SMBUS_NOTIFY_FUNCTION)(\r
  IN      EFI_PEI_SERVICES              **PeiServices,\r
  IN      EFI_PEI_SMBUS_PPI             *SmbusPpi,\r
  IN      EFI_SMBUS_DEVICE_ADDRESS      SlaveAddress,\r
  IN      UINTN                         Data\r
  );\r
\r
/**\r
  The ArpDevice() function enumerates either the entire bus or a specific\r
  device identified by SmbusUdid.\r
\r
  @param[in]      PeiServices   A pointer to the system PEI Services Table.\r
  @param[in]      This          A pointer to the EFI_PEI_SMBUS_PPI instance.\r
  @param[in]      ArpAll        A Boolean expression that indicates if the host\r
                                drivers need to enumerate all the devices or to\r
                                enumerate only the device that is identified\r
                                by SmbusUdid. If ArpAll is TRUE, SmbusUdid and\r
                                SlaveAddress are optional and ignored if entered.\r
                                If ArpAll is FALSE, ArpDevice will enumerate\r
                                SmbusUdid, and the address will be at SlaveAddress.\r
  @param[in]      SmbusUdid     The targeted SMBus Unique Device Identifier (UDID).\r
                                The UDID may not exist for SMBus devices with fixed\r
                                addresses.\r
  @param[in, out] SlaveAddress  The new SMBus address for the slave device for\r
                                which the operation is targeted.\r
                                This address may be NULL.\r
\r
  @retval EFI_SUCCESS           The SMBus slave device address was set.\r
  @retval EFI_INVALID_PARAMETER SlaveAddress is NULL.\r
  @retval EFI_OUT_OF_RESOURCES  The request could not be completed\r
                                due to a lack of resources.\r
  @retval EFI_TIMEOUT           The SMBus slave device did not respond.\r
  @retval EFI_DEVICE_ERROR      The request was not completed because the transaction failed.\r
  @retval EFI_UNSUPPORTED       ArpDevice() is not implemented by this PEIM.\r
                                This return value is not defined in the Framework Specification.\r
                                This return value was introduced in the PI Specification.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_SMBUS_PPI_ARP_DEVICE)(\r
  IN      EFI_PEI_SERVICES          **PeiServices,\r
  IN      EFI_PEI_SMBUS_PPI         *This,\r
  IN      BOOLEAN                   ArpAll,\r
  IN      EFI_SMBUS_UDID            *SmbusUdid, OPTIONAL\r
  IN OUT  EFI_SMBUS_DEVICE_ADDRESS  *SlaveAddress OPTIONAL\r
  );\r
\r
/**\r
  The GetArpMap() function returns the mapping of all the SMBus devices\r
  that are enumerated by the SMBus host driver.\r
\r
  @param[in]      PeiServices    A pointer to the system PEI Services Table.\r
  @param[in]      This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
  @param[in, out] Length         The size of the buffer that contains the SMBus device map.\r
  @param[in, out] SmbusDeviceMap The pointer to the device map as enumerated\r
                                 by the SMBus controller driver.\r
\r
  @retval EFI_SUCCESS       The device map was returned correctly in the buffer.\r
  @retval EFI_UNSUPPORTED   GetArpMap() are not implemented by this PEIM.\r
                            This return value was not defined in the Framework Specification.\r
                            This return value was introduced in the PI Specification.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_SMBUS_PPI_GET_ARP_MAP)(\r
  IN      EFI_PEI_SERVICES          **PeiServices,\r
  IN      EFI_PEI_SMBUS_PPI         *This,\r
  IN OUT  UINTN                     *Length,\r
  IN OUT  EFI_SMBUS_DEVICE_MAP      **SmbusDeviceMap\r
  );\r
\r
/**\r
  Allows a device driver to register for a callback when the bus driver detects a state that it needs to\r
  propagate to other PEIMs that are registered for a callback.\r
\r
  The Notify() function registers all the callback functions to allow the\r
  bus driver to call these functions when the SlaveAddress/Data pair occur.\r
  All functions to be registered with EFI_PEI_SMBUS_PPI_NOTIFY must be of type\r
  EFI_PEI_SMBUS_NOTIFY_FUNCTION.\r
\r
  @param[in] PeiServices    A pointer to the system PEI Services Table.\r
  @param[in] This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
  @param[in] SlaveAddress   The address that the host controller detects as\r
                            sending a message and triggers all the registered functions.\r
  @param[in] Data           Data that the host controller detects as sending a message\r
                            and triggers all the registered functions.\r
  @param[in] NotifyFunction The function to call when the bus driver\r
                            detects the SlaveAddress and Data pair.\r
\r
  @retval EFI_SUCCESS       NotifyFunction has been registered.\r
  @retval EFI_UNSUPPORTED   Notify() are not implemented by this PEIM.\r
                            This return value is not defined in  the Framework Specification.\r
                            This return value was introduced in the PI Specification.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_SMBUS_PPI_NOTIFY)(\r
  IN      EFI_PEI_SERVICES              **PeiServices,\r
  IN      EFI_PEI_SMBUS_PPI             *This,\r
  IN      EFI_SMBUS_DEVICE_ADDRESS      SlaveAddress,\r
  IN      UINTN                         Data,\r
  IN      EFI_PEI_SMBUS_NOTIFY_FUNCTION NotifyFunction\r
  );\r
\r
///\r
/// Provides the basic I/O interfaces that a PEIM uses to access\r
/// its SMBus controller and the slave devices attached to it.\r
///\r
struct _EFI_PEI_SMBUS_PPI {\r
  ///\r
  /// Executes the SMBus operation to an SMBus slave device.\r
  ///\r
  EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION Execute;\r
\r
  ///\r
  /// Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)\r
  ///\r
  EFI_PEI_SMBUS_PPI_ARP_DEVICE        ArpDevice;\r
\r
  ///\r
  /// Allows a PEIM to retrieve the address that was allocated by the SMBus\r
  /// host controller during enumeration/ARP.\r
  ///\r
  EFI_PEI_SMBUS_PPI_GET_ARP_MAP       GetArpMap;\r
\r
  ///\r
  /// Allows a driver to register for a callback to the SMBus host\r
  /// controller driver when the bus issues a notification to the bus controller PEIM.\r
  ///\r
  EFI_PEI_SMBUS_PPI_NOTIFY            Notify;\r
};\r
\r
extern EFI_GUID gEfiPeiSmbusPpiGuid;\r
\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	This file declares the Smbus PPI, which provides the basic I/O interfaces that a PEIM\r
	3	uses to access its SMBus controller and the slave devices attached to it.\r
	4	\r
	5	Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
	6	This program and the accompanying materials are licensed and made available under\r
	7	the terms and conditions of the BSD License that accompanies this distribution.\r
	8	The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php.\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	@par Revision Reference:\r
	15	This PPI is defined in Framework of EFI SmBus PPI spec.\r
	16	Version 0.9.\r
	17	\r
	18	**/\r
	19	\r
	20	#ifndef _PEI_SMBUS_PPI_H_\r
	21	#define _PEI_SMBUS_PPI_H_\r
	22	\r
	23	#include <Ppi/Smbus2.h>\r
	24	\r
	25	#define EFI_PEI_SMBUS_PPI_GUID \\r
	26	{ \\r
	27	0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0xb, 0xfb, 0xda } \\r
	28	}\r
	29	\r
	30	typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;\r
	31	\r
	32	/**\r
	33	Executes an SMBus operation to an SMBus controller.\r
	34	\r
	35	@param[in] PeiServices A pointer to the system PEI Services Table.\r
	36	@param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
	37	@param[in] SlaveAddress The SMBUS hardware address to which the SMBUS\r
	38	device is preassigned or allocated.\r
	39	@param[in] Command This command is transmitted by the SMBus host\r
	40	controller to the SMBus slave device, and the\r
	41	interpretation is SMBus slave device specific.\r
	42	@param[in] Operation Signifies which particular SMBus hardware protocol\r
	43	instance to use to execute the SMBus transactions.\r
	44	@param[in] PecCheck Defines if Packet Error Code (PEC) checking is\r
	45	required for this operation.\r
	46	@param[in, out] Length The number of bytes for this operation.\r
	47	@param[in, out] Buffer Contains the value of data to execute to the SMBus\r
	48	slave device.\r
	49	\r
	50	@retval EFI_SUCCESS The last data that was returned from the access\r
	51	matched the poll exit criteria.\r
	52	@retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect).\r
	53	@retval EFI_TIMEOUT Timeout expired before the operation was completed.\r
	54	Timeout is determined by the SMBus host controller device.\r
	55	@retval EFI_OUT_OF_RESOURCES The request could not be completed\r
	56	due to a lack of resources.\r
	57	@retval EFI_DEVICE_ERROR The request was not completed because a failure\r
	58	was recorded in the Host Status Register bit.\r
	59	@retval EFI_INVALID_PARAMETER The operation is not defined in EFI_SMBUS_OPERATION.\r
	60	@retval EFI_INVALID_PARAMETER Length/Buffer is NULL for operations except for\r
	61	EfiSmbusQuickRead and EfiSmbusQuickWrite. Length\r
	62	is outside the range of valid values.\r
	63	@retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.\r
	64	@retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.\r
	65	\r
	66	**/\r
	67	typedef\r
	68	EFI_STATUS\r
	69	(EFIAPI *EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION)(\r
	70	IN EFI_PEI_SERVICES **PeiServices,\r
	71	IN EFI_PEI_SMBUS_PPI *This,\r
	72	IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,\r
	73	IN EFI_SMBUS_DEVICE_COMMAND Command,\r
	74	IN EFI_SMBUS_OPERATION Operation,\r
	75	IN BOOLEAN PecCheck,\r
	76	IN OUT UINTN *Length,\r
	77	IN OUT VOID *Buffer\r
	78	);\r
	79	\r
	80	/**\r
	81	This function is user-defined, and is called when the SlaveAddress/Data pair happens.\r
	82	\r
	83	@param[in] PeiServices A pointer to the system PEI Services Table.\r
	84	@param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
	85	@param[in] SlaveAddress The SMBUS hardware address to which the SMBUS\r
	86	device is preassigned or allocated.\r
	87	@param[in] Data Data of the SMBus host notify command, which denotes that\r
	88	the caller wants to be called.\r
	89	\r
	90	@return Status Code returned by callback function.\r
	91	\r
	92	**/\r
	93	typedef\r
	94	EFI_STATUS\r
	95	(EFIAPI *EFI_PEI_SMBUS_NOTIFY_FUNCTION)(\r
	96	IN EFI_PEI_SERVICES **PeiServices,\r
	97	IN EFI_PEI_SMBUS_PPI *SmbusPpi,\r
	98	IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,\r
	99	IN UINTN Data\r
	100	);\r
	101	\r
	102	/**\r
	103	The ArpDevice() function enumerates either the entire bus or a specific\r
	104	device identified by SmbusUdid.\r
	105	\r
	106	@param[in] PeiServices A pointer to the system PEI Services Table.\r
	107	@param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
	108	@param[in] ArpAll A Boolean expression that indicates if the host\r
	109	drivers need to enumerate all the devices or to\r
	110	enumerate only the device that is identified\r
	111	by SmbusUdid. If ArpAll is TRUE, SmbusUdid and\r
	112	SlaveAddress are optional and ignored if entered.\r
	113	If ArpAll is FALSE, ArpDevice will enumerate\r
	114	SmbusUdid, and the address will be at SlaveAddress.\r
	115	@param[in] SmbusUdid The targeted SMBus Unique Device Identifier (UDID).\r
	116	The UDID may not exist for SMBus devices with fixed\r
	117	addresses.\r
	118	@param[in, out] SlaveAddress The new SMBus address for the slave device for\r
	119	which the operation is targeted.\r
	120	This address may be NULL.\r
	121	\r
	122	@retval EFI_SUCCESS The SMBus slave device address was set.\r
	123	@retval EFI_INVALID_PARAMETER SlaveAddress is NULL.\r
	124	@retval EFI_OUT_OF_RESOURCES The request could not be completed\r
	125	due to a lack of resources.\r
	126	@retval EFI_TIMEOUT The SMBus slave device did not respond.\r
	127	@retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.\r
	128	@retval EFI_UNSUPPORTED ArpDevice() is not implemented by this PEIM.\r
	129	This return value is not defined in the Framework Specification.\r
	130	This return value was introduced in the PI Specification.\r
	131	\r
	132	**/\r
	133	typedef\r
	134	EFI_STATUS\r
	135	(EFIAPI *EFI_PEI_SMBUS_PPI_ARP_DEVICE)(\r
	136	IN EFI_PEI_SERVICES **PeiServices,\r
	137	IN EFI_PEI_SMBUS_PPI *This,\r
	138	IN BOOLEAN ArpAll,\r
	139	IN EFI_SMBUS_UDID *SmbusUdid, OPTIONAL\r
	140	IN OUT EFI_SMBUS_DEVICE_ADDRESS *SlaveAddress OPTIONAL\r
	141	);\r
	142	\r
	143	/**\r
	144	The GetArpMap() function returns the mapping of all the SMBus devices\r
	145	that are enumerated by the SMBus host driver.\r
	146	\r
	147	@param[in] PeiServices A pointer to the system PEI Services Table.\r
	148	@param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
	149	@param[in, out] Length The size of the buffer that contains the SMBus device map.\r
	150	@param[in, out] SmbusDeviceMap The pointer to the device map as enumerated\r
	151	by the SMBus controller driver.\r
	152	\r
	153	@retval EFI_SUCCESS The device map was returned correctly in the buffer.\r
	154	@retval EFI_UNSUPPORTED GetArpMap() are not implemented by this PEIM.\r
	155	This return value was not defined in the Framework Specification.\r
	156	This return value was introduced in the PI Specification.\r
	157	\r
	158	**/\r
	159	typedef\r
	160	EFI_STATUS\r
	161	(EFIAPI *EFI_PEI_SMBUS_PPI_GET_ARP_MAP)(\r
	162	IN EFI_PEI_SERVICES **PeiServices,\r
	163	IN EFI_PEI_SMBUS_PPI *This,\r
	164	IN OUT UINTN *Length,\r
	165	IN OUT EFI_SMBUS_DEVICE_MAP **SmbusDeviceMap\r
	166	);\r
	167	\r
	168	/**\r
	169	Allows a device driver to register for a callback when the bus driver detects a state that it needs to\r
	170	propagate to other PEIMs that are registered for a callback.\r
	171	\r
	172	The Notify() function registers all the callback functions to allow the\r
	173	bus driver to call these functions when the SlaveAddress/Data pair occur.\r
	174	All functions to be registered with EFI_PEI_SMBUS_PPI_NOTIFY must be of type\r
	175	EFI_PEI_SMBUS_NOTIFY_FUNCTION.\r
	176	\r
	177	@param[in] PeiServices A pointer to the system PEI Services Table.\r
	178	@param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
	179	@param[in] SlaveAddress The address that the host controller detects as\r
	180	sending a message and triggers all the registered functions.\r
	181	@param[in] Data Data that the host controller detects as sending a message\r
	182	and triggers all the registered functions.\r
	183	@param[in] NotifyFunction The function to call when the bus driver\r
	184	detects the SlaveAddress and Data pair.\r
	185	\r
	186	@retval EFI_SUCCESS NotifyFunction has been registered.\r
	187	@retval EFI_UNSUPPORTED Notify() are not implemented by this PEIM.\r
	188	This return value is not defined in the Framework Specification.\r
	189	This return value was introduced in the PI Specification.\r
	190	\r
	191	**/\r
	192	typedef\r
	193	EFI_STATUS\r
	194	(EFIAPI *EFI_PEI_SMBUS_PPI_NOTIFY)(\r
	195	IN EFI_PEI_SERVICES **PeiServices,\r
	196	IN EFI_PEI_SMBUS_PPI *This,\r
	197	IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,\r
	198	IN UINTN Data,\r
	199	IN EFI_PEI_SMBUS_NOTIFY_FUNCTION NotifyFunction\r
	200	);\r
	201	\r
	202	///\r
	203	/// Provides the basic I/O interfaces that a PEIM uses to access\r
	204	/// its SMBus controller and the slave devices attached to it.\r
	205	///\r
	206	struct _EFI_PEI_SMBUS_PPI {\r
	207	///\r
	208	/// Executes the SMBus operation to an SMBus slave device.\r
	209	///\r
	210	EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION Execute;\r
	211	\r
	212	///\r
	213	/// Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)\r
	214	///\r
	215	EFI_PEI_SMBUS_PPI_ARP_DEVICE ArpDevice;\r
	216	\r
	217	///\r
	218	/// Allows a PEIM to retrieve the address that was allocated by the SMBus\r
	219	/// host controller during enumeration/ARP.\r
	220	///\r
	221	EFI_PEI_SMBUS_PPI_GET_ARP_MAP GetArpMap;\r
	222	\r
	223	///\r
	224	/// Allows a driver to register for a callback to the SMBus host\r
	225	/// controller driver when the bus issues a notification to the bus controller PEIM.\r
	226	///\r
	227	EFI_PEI_SMBUS_PPI_NOTIFY Notify;\r
	228	};\r
	229	\r
	230	extern EFI_GUID gEfiPeiSmbusPpiGuid;\r
	231	\r
	232	#endif\r