[mirror_edk2.git] / MdePkg / Include / Protocol / FormBrowser.h

/** @file\r
  The EFI_FORM_BROWSER_PROTOCOL is the interface to the EFI \r
  Configuration Driver.  This will allow the caller to direct the \r
  configuration driver to use either the HII database or use the passed \r
  in packet of data.  This will also allow the caller to post messages \r
  into the configuration drivers internal mailbox.\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:  FormBrowser.h\r
\r
  @par Revision Reference:\r
  This protocol is defined in HII spec 0.92.\r
\r
**/\r
\r
#ifndef __FORM_BROWSER_H__\r
#define __FORM_BROWSER_H__\r
\r
\r
#define EFI_FORM_BROWSER_PROTOCOL_GUID \\r
  { \\r
    0xe5a1333e, 0xe1b4, 0x4d55, {0xce, 0xeb, 0x35, 0xc3, 0xef, 0x13, 0x34, 0x43 } \\r
  }\r
\r
typedef struct _EFI_FORM_BROWSER_PROTOCOL EFI_FORM_BROWSER_PROTOCOL;\r
\r
typedef struct {\r
  UINT32  Length;\r
  UINT16  Type;\r
  UINT8   Data[1];\r
} EFI_HII_PACKET;\r
\r
typedef struct {\r
  EFI_HII_IFR_PACK    *IfrData;\r
  EFI_HII_STRING_PACK *StringData;\r
} EFI_IFR_PACKET;\r
\r
typedef struct {\r
  UINTN LeftColumn;\r
  UINTN RightColumn;\r
  UINTN TopRow;\r
  UINTN BottomRow;\r
} EFI_SCREEN_DESCRIPTOR;\r
\r
/**\r
  Provides direction to the configuration driver whether to use the HII \r
  database or a passed-in set of data. This function also establishes a \r
Commit	Line	Data
878ddf1f	1	/** @file\r
	2	The EFI_FORM_BROWSER_PROTOCOL is the interface to the EFI \r
	3	Configuration Driver. This will allow the caller to direct the \r
	4	configuration driver to use either the HII database or use the passed \r
	5	in packet of data. This will also allow the caller to post messages \r
	6	into the configuration drivers internal mailbox.\r
	7	\r
	8	Copyright (c) 2006, Intel Corporation \r
	9	All rights reserved. This program and the accompanying materials \r
	10	are licensed and made available under the terms and conditions of the BSD License \r
	11	which accompanies this distribution. The full text of the license may be found at \r
	12	http://opensource.org/licenses/bsd-license.php \r
	13	\r
	14	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	15	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	16	\r
	17	Module Name: FormBrowser.h\r
	18	\r
	19	@par Revision Reference:\r
	20	This protocol is defined in HII spec 0.92.\r
	21	\r
	22	**/\r
	23	\r
	24	#ifndef __FORM_BROWSER_H__\r
	25	#define __FORM_BROWSER_H__\r
	26	\r
	27	\r
	28	#define EFI_FORM_BROWSER_PROTOCOL_GUID \\r
	29	{ \\r
	30	0xe5a1333e, 0xe1b4, 0x4d55, {0xce, 0xeb, 0x35, 0xc3, 0xef, 0x13, 0x34, 0x43 } \\r
	31	}\r
	32	\r
	33	typedef struct _EFI_FORM_BROWSER_PROTOCOL EFI_FORM_BROWSER_PROTOCOL;\r
	34	\r
	35	typedef struct {\r
	36	UINT32 Length;\r
	37	UINT16 Type;\r
	38	UINT8 Data[1];\r
	39	} EFI_HII_PACKET;\r
	40	\r
	41	typedef struct {\r
	42	EFI_HII_IFR_PACK *IfrData;\r
	43	EFI_HII_STRING_PACK *StringData;\r
	44	} EFI_IFR_PACKET;\r
	45	\r
	46	typedef struct {\r
	47	UINTN LeftColumn;\r
	48	UINTN RightColumn;\r
	49	UINTN TopRow;\r
	50	UINTN BottomRow;\r
	51	} EFI_SCREEN_DESCRIPTOR;\r
	52	\r
	53	/**\r
	54	Provides direction to the configuration driver whether to use the HII \r
	55	database or a passed-in set of data. This function also establishes a \r
	56