[mirror_edk2.git] / OvmfPkg / Include / Library / QemuFwCfgLib.h

/** @file\r
  QEMU/KVM Firmware Configuration access\r
\r
  Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>\r
  Copyright (C) 2013, Red Hat, Inc.\r
\r
  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 __FW_CFG_LIB__\r
#define __FW_CFG_LIB__\r
\r
//\r
// The size, in bytes, of names of firmware configuration files, including at\r
// least one terminating NUL byte.\r
//\r
#define QEMU_FW_CFG_FNAME_SIZE 56\r
\r
typedef enum {\r
  QemuFwCfgItemSignature            = 0x0000,\r
  QemuFwCfgItemInterfaceVersion     = 0x0001,\r
  QemuFwCfgItemSystemUuid           = 0x0002,\r
  QemuFwCfgItemRamSize              = 0x0003,\r
  QemuFwCfgItemGraphicsEnabled      = 0x0004,\r
  QemuFwCfgItemSmpCpuCount          = 0x0005,\r
  QemuFwCfgItemMachineId            = 0x0006,\r
  QemuFwCfgItemKernelAddress        = 0x0007,\r
  QemuFwCfgItemKernelSize           = 0x0008,\r
  QemuFwCfgItemKernelCommandLine    = 0x0009,\r
  QemuFwCfgItemInitrdAddress        = 0x000a,\r
  QemuFwCfgItemInitrdSize           = 0x000b,\r
  QemuFwCfgItemBootDevice           = 0x000c,\r
  QemuFwCfgItemNumaData             = 0x000d,\r
  QemuFwCfgItemBootMenu             = 0x000e,\r
  QemuFwCfgItemMaximumCpuCount      = 0x000f,\r
  QemuFwCfgItemKernelEntry          = 0x0010,\r
  QemuFwCfgItemKernelData           = 0x0011,\r
  QemuFwCfgItemInitrdData           = 0x0012,\r
  QemuFwCfgItemCommandLineAddress   = 0x0013,\r
  QemuFwCfgItemCommandLineSize      = 0x0014,\r
  QemuFwCfgItemCommandLineData      = 0x0015,\r
  QemuFwCfgItemKernelSetupAddress   = 0x0016,\r
  QemuFwCfgItemKernelSetupSize      = 0x0017,\r
  QemuFwCfgItemKernelSetupData      = 0x0018,\r
  QemuFwCfgItemFileDir              = 0x0019,\r
\r
  QemuFwCfgItemX86AcpiTables        = 0x8000,\r
  QemuFwCfgItemX86SmbiosTables      = 0x8001,\r
  QemuFwCfgItemX86Irq0Override      = 0x8002,\r
  QemuFwCfgItemX86E820Table         = 0x8003,\r
  QemuFwCfgItemX86HpetData          = 0x8004,\r
\r
} FIRMWARE_CONFIG_ITEM;\r
\r
\r
/**\r
  Returns a boolean indicating if the firmware configuration interface\r
  is available or not.\r
\r
  This function may change fw_cfg state.\r
\r
  @retval    TRUE   The interface is available\r
  @retval    FALSE  The interface is not available\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
QemuFwCfgIsAvailable (\r
  VOID\r
  );\r
\r
\r
/**\r
  Selects a firmware configuration item for reading.\r
\r
  Following this call, any data read from this item will start from\r
  the beginning of the configuration item's data.\r
\r
  @param[in] QemuFwCfgItem - Firmware Configuration item to read\r
\r
**/\r
VOID\r
EFIAPI\r
QemuFwCfgSelectItem (\r
  IN FIRMWARE_CONFIG_ITEM   QemuFwCfgItem\r
  );\r
\r
\r
/**\r
  Reads firmware configuration bytes into a buffer\r
\r
  If called multiple times, then the data read will\r
  continue at the offset of the firmware configuration\r
  item where the previous read ended.\r
\r
  @param[in] Size - Size in bytes to read\r
  @param[in] Buffer - Buffer to store data into\r
\r
**/\r
VOID\r
EFIAPI\r
QemuFwCfgReadBytes (\r
  IN UINTN                  Size,\r
  IN VOID                   *Buffer  OPTIONAL\r
  );\r
\r
\r
/**\r
  Writes firmware configuration bytes from a buffer\r
\r
  If called multiple times, then the data written will\r
  continue at the offset of the firmware configuration\r
  item where the previous write ended.\r
\r
  @param[in] Size - Size in bytes to write\r
  @param[in] Buffer - Buffer to read data from\r
\r
**/\r
VOID\r
EFIAPI\r
QemuFwCfgWriteBytes (\r
  IN UINTN                  Size,\r
  IN VOID                   *Buffer\r
  );\r
\r
\r
/**\r
  Reads a UINT8 firmware configuration value\r
\r
  @return    Value of Firmware Configuration item read\r
\r
**/\r
UINT8\r
EFIAPI\r
QemuFwCfgRead8 (\r
  VOID\r
  );\r
\r
\r
/**\r
  Reads a UINT16 firmware configuration value\r
\r
  @return    Value of Firmware Configuration item read\r
\r
**/\r
UINT16\r
EFIAPI\r
QemuFwCfgRead16 (\r
  VOID\r
  );\r
\r
\r
/**\r
  Reads a UINT32 firmware configuration value\r
\r
  @return    Value of Firmware Configuration item read\r
\r
**/\r
UINT32\r
EFIAPI\r
QemuFwCfgRead32 (\r
  VOID\r
  );\r
\r
\r
/**\r
  Reads a UINT64 firmware configuration value\r
\r
  @return    Value of Firmware Configuration item read\r
\r
**/\r
UINT64\r
EFIAPI\r
QemuFwCfgRead64 (\r
  VOID\r
  );\r
\r
\r
/**\r
  Find the configuration item corresponding to the firmware configuration file.\r
\r
  @param[in]  Name - Name of file to look up.\r
  @param[out] Item - Configuration item corresponding to the file, to be passed\r
                     to QemuFwCfgSelectItem ().\r
  @param[out] Size - Number of bytes in the file.\r
\r
  @return    RETURN_SUCCESS       If file is found.\r
             RETURN_NOT_FOUND     If file is not found.\r
             RETURN_UNSUPPORTED   If firmware configuration is unavailable.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
QemuFwCfgFindFile (\r
  IN   CONST CHAR8           *Name,\r
  OUT  FIRMWARE_CONFIG_ITEM  *Item,\r
  OUT  UINTN                 *Size\r
  );\r
\r
\r
/**\r
  Returns a boolean indicating if the firmware configuration interface is\r
  available for library-internal purposes.\r
\r
  This function never changes fw_cfg state.\r
\r
  @retval    TRUE   The interface is available internally.\r
  @retval    FALSE  The interface is not available internally.\r
**/\r
BOOLEAN\r
EFIAPI\r
InternalQemuFwCfgIsAvailable (\r
  VOID\r
  );\r
\r
\r
/**\r
  Determine if S3 support is explicitly enabled.\r
\r
  @retval  TRUE   if S3 support is explicitly enabled.\r
           FALSE  otherwise. This includes unavailability of the firmware\r
                  configuration interface.\r
**/\r
BOOLEAN\r
EFIAPI\r
QemuFwCfgS3Enabled (\r
  VOID\r
  );\r
\r
#endif\r
\r
Commit	Line	Data
f1ec65ba	1	/** @file\r
	2	QEMU/KVM Firmware Configuration access\r
	3	\r
29874a8c	4	Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>\r
0dc231c9 LE	5	Copyright (C) 2013, Red Hat, Inc.\r
0dc231c9 LE	6	\r
f1ec65ba	7	This program and the accompanying materials\r
	8	are licensed and made available under the terms and conditions of the BSD License\r
	9	which accompanies this distribution. The full text of the license may be found at\r
	10	http://opensource.org/licenses/bsd-license.php\r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	\r
	15	**/\r
	16	\r
	17	#ifndef __FW_CFG_LIB__\r
	18	#define __FW_CFG_LIB__\r
	19	\r
6a904296 LE	20	//\r
	21	// The size, in bytes, of names of firmware configuration files, including at\r
	22	// least one terminating NUL byte.\r
	23	//\r
	24	#define QEMU_FW_CFG_FNAME_SIZE 56\r
	25	\r
f1ec65ba	26	typedef enum {\r
	27	QemuFwCfgItemSignature = 0x0000,\r
	28	QemuFwCfgItemInterfaceVersion = 0x0001,\r
	29	QemuFwCfgItemSystemUuid = 0x0002,\r
	30	QemuFwCfgItemRamSize = 0x0003,\r
	31	QemuFwCfgItemGraphicsEnabled = 0x0004,\r
	32	QemuFwCfgItemSmpCpuCount = 0x0005,\r
	33	QemuFwCfgItemMachineId = 0x0006,\r
	34	QemuFwCfgItemKernelAddress = 0x0007,\r
	35	QemuFwCfgItemKernelSize = 0x0008,\r
	36	QemuFwCfgItemKernelCommandLine = 0x0009,\r
	37	QemuFwCfgItemInitrdAddress = 0x000a,\r
	38	QemuFwCfgItemInitrdSize = 0x000b,\r
	39	QemuFwCfgItemBootDevice = 0x000c,\r
	40	QemuFwCfgItemNumaData = 0x000d,\r
	41	QemuFwCfgItemBootMenu = 0x000e,\r
	42	QemuFwCfgItemMaximumCpuCount = 0x000f,\r
	43	QemuFwCfgItemKernelEntry = 0x0010,\r
	44	QemuFwCfgItemKernelData = 0x0011,\r
	45	QemuFwCfgItemInitrdData = 0x0012,\r
	46	QemuFwCfgItemCommandLineAddress = 0x0013,\r
	47	QemuFwCfgItemCommandLineSize = 0x0014,\r
	48	QemuFwCfgItemCommandLineData = 0x0015,\r
	49	QemuFwCfgItemKernelSetupAddress = 0x0016,\r
	50	QemuFwCfgItemKernelSetupSize = 0x0017,\r
	51	QemuFwCfgItemKernelSetupData = 0x0018,\r
0ac9bc9b	52	QemuFwCfgItemFileDir = 0x0019,\r
f1ec65ba	53	\r
	54	QemuFwCfgItemX86AcpiTables = 0x8000,\r
	55	QemuFwCfgItemX86SmbiosTables = 0x8001,\r
	56	QemuFwCfgItemX86Irq0Override = 0x8002,\r
	57	QemuFwCfgItemX86E820Table = 0x8003,\r
	58	QemuFwCfgItemX86HpetData = 0x8004,\r
	59	\r
	60	} FIRMWARE_CONFIG_ITEM;\r
	61	\r
	62	\r
	63	/**\r
	64	Returns a boolean indicating if the firmware configuration interface\r
	65	is available or not.\r
	66	\r
0dc231c9 LE	67	This function may change fw_cfg state.\r
0dc231c9 LE	68	\r
f1ec65ba	69	@retval TRUE The interface is available\r
	70	@retval FALSE The interface is not available\r
	71	\r
	72	**/\r
	73	BOOLEAN\r
	74	EFIAPI\r
	75	QemuFwCfgIsAvailable (\r
	76	VOID\r
	77	);\r
	78	\r
	79	\r
	80	/**\r
	81	Selects a firmware configuration item for reading.\r
	82	\r
	83	Following this call, any data read from this item will start from\r
	84	the beginning of the configuration item's data.\r
	85	\r
	86	@param[in] QemuFwCfgItem - Firmware Configuration item to read\r
	87	\r
	88	**/\r
	89	VOID\r
	90	EFIAPI\r
	91	QemuFwCfgSelectItem (\r
	92	IN FIRMWARE_CONFIG_ITEM QemuFwCfgItem\r
	93	);\r
	94	\r
	95	\r
	96	/**\r
	97	Reads firmware configuration bytes into a buffer\r
	98	\r
	99	If called multiple times, then the data read will\r
	100	continue at the offset of the firmware configuration\r
	101	item where the previous read ended.\r
	102	\r
	103	@param[in] Size - Size in bytes to read\r
	104	@param[in] Buffer - Buffer to store data into\r
	105	\r
	106	**/\r
	107	VOID\r
	108	EFIAPI\r
	109	QemuFwCfgReadBytes (\r
	110	IN UINTN Size,\r
	111	IN VOID *Buffer OPTIONAL\r
	112	);\r
	113	\r
	114	\r
29874a8c	115	/**\r
	116	Writes firmware configuration bytes from a buffer\r
	117	\r
	118	If called multiple times, then the data written will\r
	119	continue at the offset of the firmware configuration\r
	120	item where the previous write ended.\r
	121	\r
	122	@param[in] Size - Size in bytes to write\r
	123	@param[in] Buffer - Buffer to read data from\r
	124	\r
	125	**/\r
	126	VOID\r
	127	EFIAPI\r
	128	QemuFwCfgWriteBytes (\r
	129	IN UINTN Size,\r
	130	IN VOID *Buffer\r
	131	);\r
	132	\r
	133	\r
f1ec65ba	134	/**\r
	135	Reads a UINT8 firmware configuration value\r
	136	\r
	137	@return Value of Firmware Configuration item read\r
	138	\r
	139	**/\r
	140	UINT8\r
	141	EFIAPI\r
	142	QemuFwCfgRead8 (\r
	143	VOID\r
	144	);\r
	145	\r
	146	\r
	147	/**\r
	148	Reads a UINT16 firmware configuration value\r
	149	\r
	150	@return Value of Firmware Configuration item read\r
	151	\r
	152	**/\r
	153	UINT16\r
	154	EFIAPI\r
	155	QemuFwCfgRead16 (\r
	156	VOID\r
	157	);\r
	158	\r
	159	\r
	160	/**\r
	161	Reads a UINT32 firmware configuration value\r
	162	\r
	163	@return Value of Firmware Configuration item read\r
	164	\r
	165	**/\r
	166	UINT32\r
	167	EFIAPI\r
	168	QemuFwCfgRead32 (\r
	169	VOID\r
	170	);\r
	171	\r
	172	\r
	173	/**\r
	174	Reads a UINT64 firmware configuration value\r
	175	\r
	176	@return Value of Firmware Configuration item read\r
	177	\r
	178	**/\r
	179	UINT64\r
	180	EFIAPI\r
	181	QemuFwCfgRead64 (\r
	182	VOID\r
	183	);\r
	184	\r
	185	\r
0ac9bc9b	186	/**\r
	187	Find the configuration item corresponding to the firmware configuration file.\r
	188	\r
	189	@param[in] Name - Name of file to look up.\r
	190	@param[out] Item - Configuration item corresponding to the file, to be passed\r
	191	to QemuFwCfgSelectItem ().\r
	192	@param[out] Size - Number of bytes in the file.\r
	193	\r
	194	@return RETURN_SUCCESS If file is found.\r
	195	RETURN_NOT_FOUND If file is not found.\r
	196	RETURN_UNSUPPORTED If firmware configuration is unavailable.\r
	197	\r
	198	**/\r
	199	RETURN_STATUS\r
	200	EFIAPI\r
	201	QemuFwCfgFindFile (\r
	202	IN CONST CHAR8 *Name,\r
	203	OUT FIRMWARE_CONFIG_ITEM *Item,\r
	204	OUT UINTN *Size\r
	205	);\r
0dc231c9 LE	206	\r
	207	\r
	208	/**\r
	209	Returns a boolean indicating if the firmware configuration interface is\r
	210	available for library-internal purposes.\r
	211	\r
	212	This function never changes fw_cfg state.\r
	213	\r
	214	@retval TRUE The interface is available internally.\r
	215	@retval FALSE The interface is not available internally.\r
	216	**/\r
	217	BOOLEAN\r
	218	EFIAPI\r
	219	InternalQemuFwCfgIsAvailable (\r
	220	VOID\r
	221	);\r
	222	\r
14eb7a5b LE	223	\r
	224	/**\r
	225	Determine if S3 support is explicitly enabled.\r
	226	\r
	227	@retval TRUE if S3 support is explicitly enabled.\r
	228	FALSE otherwise. This includes unavailability of the firmware\r
	229	configuration interface.\r
	230	**/\r
	231	BOOLEAN\r
	232	EFIAPI\r
	233	QemuFwCfgS3Enabled (\r
	234	VOID\r
	235	);\r
	236	\r
f1ec65ba	237	#endif\r
f1ec65ba	238	\r