[mirror_edk2.git] / EmulatorPkg / Library / EmuBdsLib / BdsPlatform.c

/*++ @file\r
\r
Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
Portions copyright (c) 2011, Apple Inc. All rights reserved.\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
#include "BdsPlatform.h"\r
\r
EMU_SYSTEM_CONFIGURATION mSystemConfigData;\r
\r
VOID\r
SetupVariableInit (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  UINTN                           Size;\r
\r
  Size = sizeof (mSystemConfigData);\r
  Status = gRT->GetVariable (\r
                  L"Setup",\r
                  &gEmuSystemConfigGuid,\r
                  NULL,\r
                  &Size,\r
                  (VOID *) &mSystemConfigData\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // SetupVariable is corrupt\r
    //\r
    mSystemConfigData.ConOutRow = PcdGet32 (PcdConOutColumn);\r
    mSystemConfigData.ConOutColumn = PcdGet32 (PcdConOutRow);\r
\r
    Status = gRT->SetVariable (\r
                    L"Setup",\r
                    &gEmuSystemConfigGuid,\r
                    EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
                    sizeof (mSystemConfigData),\r
                    (VOID *) &mSystemConfigData\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_ERROR, "Failed to save Setup Variable to non-volatile storage, Status = %r\n", Status));\r
    }\r
  }\r
}\r
\r
//\r
// BDS Platform Functions\r
//\r
VOID\r
EFIAPI\r
PlatformBdsInit (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Platform Bds init. Include the platform firmware vendor, revision\r
  and so crc check.\r
\r
Arguments:\r
\r
Returns:\r
\r
  None.\r
\r
**/\r
{\r
  SetupVariableInit ();\r
}\r
\r
EFI_STATUS\r
PlatformBdsConnectConsole (\r
  IN BDS_CONSOLE_CONNECT_ENTRY   *PlatformConsole\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Connect the predefined platform default console device. Always try to find\r
  and enable the vga device if have.\r
\r
Arguments:\r
\r
  PlatformConsole         - Predfined platform default console device array.\r
\r
Returns:\r
\r
  EFI_SUCCESS             - Success connect at least one ConIn and ConOut\r
                            device, there must have one ConOut device is\r
                            active vga device.\r
\r
  EFI_STATUS              - Return the status of\r
                            BdsLibConnectAllDefaultConsoles ()\r
\r
**/\r
{\r
  EFI_STATUS  Status;\r
  UINTN       Index;\r
\r
  Index   = 0;\r
  Status  = EFI_SUCCESS;\r
\r
  //\r
  // Have chance to connect the platform default console,\r
  // the platform default console is the minimue device group\r
  // the platform should support\r
  //\r
  while (PlatformConsole[Index].DevicePath != NULL) {\r
    //\r
    // Update the console variable with the connect type\r
    //\r
    if ((PlatformConsole[Index].ConnectType & CONSOLE_IN) == CONSOLE_IN) {\r
      BdsLibUpdateConsoleVariable (L"ConIn", PlatformConsole[Index].DevicePath, NULL);\r
    }\r
\r
    if ((PlatformConsole[Index].ConnectType & CONSOLE_OUT) == CONSOLE_OUT) {\r
      BdsLibUpdateConsoleVariable (L"ConOut", PlatformConsole[Index].DevicePath, NULL);\r
    }\r
\r
    if ((PlatformConsole[Index].ConnectType & STD_ERROR) == STD_ERROR) {\r
      BdsLibUpdateConsoleVariable (L"ErrOut", PlatformConsole[Index].DevicePath, NULL);\r
    }\r
\r
    Index++;\r
  }\r
  //\r
  // Connect the all the default console with current cosole variable\r
  //\r
  Status = BdsLibConnectAllDefaultConsoles ();\r
  return Status;\r
}\r
\r
VOID\r
PlatformBdsConnectSequence (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Connect with predeined platform connect sequence,\r
  the OEM/IBV can customize with their own connect sequence.\r
\r
Arguments:\r
\r
  None.\r
\r
Returns:\r
\r
  None.\r
\r
**/\r
{\r
  UINTN Index;\r
\r
  Index = 0;\r
\r
  //\r
  // Here we can get the customized platform connect sequence\r
  // Notes: we can connect with new variable which record the\r
  // last time boots connect device path sequence\r
  //\r
  while (gPlatformConnectSequence[Index] != NULL) {\r
    //\r
    // Build the platform boot option\r
    //\r
    BdsLibConnectDevicePath (gPlatformConnectSequence[Index]);\r
    Index++;\r
  }\r
\r
  //\r
  // Just use the simple policy to connect all devices\r
  //\r
  BdsLibConnectAll ();\r
}\r
\r
VOID\r
PlatformBdsGetDriverOption (\r
  IN OUT LIST_ENTRY              *BdsDriverLists\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Load the predefined driver option, OEM/IBV can customize this\r
  to load their own drivers\r
\r
Arguments:\r
\r
  BdsDriverLists  - The header of the driver option link list.\r
\r
Returns:\r
\r
  None.\r
\r
**/\r
{\r
  UINTN Index;\r
\r
  Index = 0;\r
\r
  //\r
  // Here we can get the customized platform driver option\r
  //\r
  while (gPlatformDriverOption[Index] != NULL) {\r
    //\r
    // Build the platform boot option\r
    //\r
    BdsLibRegisterNewOption (BdsDriverLists, gPlatformDriverOption[Index], NULL, L"DriverOrder");\r
    Index++;\r
  }\r
\r
}\r
\r
VOID\r
PlatformBdsDiagnostics (\r
  IN EXTENDMEM_COVERAGE_LEVEL    MemoryTestLevel,\r
  IN BOOLEAN                     QuietBoot,\r
  IN BASEM_MEMORY_TEST           BaseMemoryTest\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Perform the platform diagnostic, such like test memory. OEM/IBV also\r
  can customize this fuction to support specific platform diagnostic.\r
\r
Arguments:\r
\r
  MemoryTestLevel  - The memory test intensive level\r
\r
  QuietBoot        - Indicate if need to enable the quiet boot\r
\r
  BaseMemoryTest   - A pointer to BdsMemoryTest()\r
\r
Returns:\r
\r
  None.\r
\r
**/\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Here we can decide if we need to show\r
  // the diagnostics screen\r
  // Notes: this quiet boot code should be remove\r
  // from the graphic lib\r
  //\r
  if (QuietBoot) {\r
    EnableQuietBoot (PcdGetPtr(PcdLogoFile));\r
    //\r
    // Perform system diagnostic\r
    //\r
    Status = BaseMemoryTest (MemoryTestLevel);\r
    if (EFI_ERROR (Status)) {\r
      DisableQuietBoot ();\r
    }\r
\r
    return ;\r
  }\r
  //\r
  // Perform system diagnostic\r
  //\r
  Status = BaseMemoryTest (MemoryTestLevel);\r
}\r
\r
VOID\r
EFIAPI\r
PlatformBdsPolicyBehavior (\r
  IN OUT LIST_ENTRY                  *DriverOptionList,\r
  IN OUT LIST_ENTRY                  *BootOptionList,\r
  IN PROCESS_CAPSULES                ProcessCapsules,\r
  IN BASEM_MEMORY_TEST               BaseMemoryTest\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The function will excute with as the platform policy, current policy\r
  is driven by boot mode. IBV/OEM can customize this code for their specific\r
  policy action.\r
\r
Arguments:\r
\r
  DriverOptionList - The header of the driver option link list\r
\r
  BootOptionList   - The header of the boot option link list\r
\r
  ProcessCapsules  - A pointer to ProcessCapsules()\r
\r
  BaseMemoryTest   - A pointer to BaseMemoryTest()\r
\r
Returns:\r
\r
  None.\r
\r
**/\r
{\r
  EFI_STATUS     Status;\r
  UINT16         Timeout;\r
  EFI_BOOT_MODE  BootMode;\r
\r
  //\r
  // Init the time out value\r
  //\r
  Timeout = PcdGet16 (PcdPlatformBootTimeOut);\r
\r
  //\r
  // Load the driver option as the driver option list\r
  //\r
  PlatformBdsGetDriverOption (DriverOptionList);\r
\r
  //\r
  // Get current Boot Mode\r
  //\r
  Status = BdsLibGetBootMode (&BootMode);\r
\r
  //\r
  // Go the different platform policy with different boot mode\r
  // Notes: this part code can be change with the table policy\r
  //\r
  switch (BootMode) {\r
\r
  case BOOT_ASSUMING_NO_CONFIGURATION_CHANGES:\r
  case BOOT_WITH_MINIMAL_CONFIGURATION:\r
    //\r
    // In no-configuration boot mode, we can connect the\r
    // console directly.\r
    //\r
    BdsLibConnectAllDefaultConsoles ();\r
    PlatformBdsDiagnostics (IGNORE, TRUE, BaseMemoryTest);\r
\r
    //\r
    // Perform some platform specific connect sequence\r
    //\r
    PlatformBdsConnectSequence ();\r
\r
    //\r
    // Notes: current time out = 0 can not enter the\r
    // front page\r
    //\r
    PlatformBdsEnterFrontPage (Timeout, FALSE);\r
\r
    //\r
    // Check the boot option with the boot option list\r
    //\r
    BdsLibBuildOptionFromVar (BootOptionList, L"BootOrder");\r
    break;\r
\r
  case BOOT_ON_FLASH_UPDATE:\r
    //\r
    // Boot with the specific configuration\r
    //\r
    PlatformBdsConnectConsole (gPlatformConsole);\r
    PlatformBdsDiagnostics (EXTENSIVE, FALSE, BaseMemoryTest);\r
    BdsLibConnectAll ();\r
    ProcessCapsules (BOOT_ON_FLASH_UPDATE);\r
    break;\r
\r
  case BOOT_IN_RECOVERY_MODE:\r
    //\r
    // In recovery mode, just connect platform console\r
    // and show up the front page\r
    //\r
    PlatformBdsConnectConsole (gPlatformConsole);\r
    PlatformBdsDiagnostics (EXTENSIVE, FALSE, BaseMemoryTest);\r
\r
    //\r
    // In recovery boot mode, we still enter to the\r
    // frong page now\r
    //\r
    PlatformBdsEnterFrontPage (Timeout, FALSE);\r
    break;\r
\r
  case BOOT_WITH_FULL_CONFIGURATION:\r
  case BOOT_WITH_FULL_CONFIGURATION_PLUS_DIAGNOSTICS:\r
  case BOOT_WITH_DEFAULT_SETTINGS:\r
  default:\r
    //\r
    // Connect platform console\r
    //\r
    Status = PlatformBdsConnectConsole (gPlatformConsole);\r
    if (EFI_ERROR (Status)) {\r
      //\r
      // Here OEM/IBV can customize with defined action\r
      //\r
      PlatformBdsNoConsoleAction ();\r
    }\r
\r
    PlatformBdsDiagnostics (IGNORE, TRUE, BaseMemoryTest);\r
\r
    //\r
    // Perform some platform specific connect sequence\r
    //\r
    PlatformBdsConnectSequence ();\r
\r
    //\r
    // Give one chance to enter the setup if we\r
    // have the time out\r
    //\r
    PlatformBdsEnterFrontPage (Timeout, FALSE);\r
\r
    //\r
    // Here we have enough time to do the enumeration of boot device\r
    //\r
    BdsLibEnumerateAllBootOption (BootOptionList);\r
    break;\r
  }\r
\r
  return ;\r
\r
}\r
\r
VOID\r
EFIAPI\r
PlatformBdsBootSuccess (\r
  IN  BDS_COMMON_OPTION   *Option\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Hook point after a boot attempt succeeds. We don't expect a boot option to\r
  return, so the EFI 1.0 specification defines that you will default to an\r
  interactive mode and stop processing the BootOrder list in this case. This\r
  is alos a platform implementation and can be customized by IBV/OEM.\r
\r
Arguments:\r
\r
  Option - Pointer to Boot Option that succeeded to boot.\r
\r
Returns:\r
\r
  None.\r
\r
**/\r
{\r
  CHAR16  *TmpStr;\r
\r
  //\r
  // If Boot returned with EFI_SUCCESS and there is not in the boot device\r
  // select loop then we need to pop up a UI and wait for user input.\r
  //\r
  TmpStr = Option->StatusString;\r
  if (TmpStr != NULL) {\r
    BdsLibOutputStrings (gST->ConOut, TmpStr, Option->Description, L"\n\r", NULL);\r
    FreePool (TmpStr);\r
  }\r
}\r
\r
VOID\r
EFIAPI\r
PlatformBdsBootFail (\r
  IN  BDS_COMMON_OPTION  *Option,\r
  IN  EFI_STATUS         Status,\r
  IN  CHAR16             *ExitData,\r
  IN  UINTN              ExitDataSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Hook point after a boot attempt fails.\r
\r
Arguments:\r
\r
  Option - Pointer to Boot Option that failed to boot.\r
\r
  Status - Status returned from failed boot.\r
\r
  ExitData - Exit data returned from failed boot.\r
\r
  ExitDataSize - Exit data size returned from failed boot.\r
\r
Returns:\r
\r
  None.\r
\r
**/\r
{\r
  CHAR16  *TmpStr;\r
\r
  //\r
  // If Boot returned with failed status then we need to pop up a UI and wait\r
  // for user input.\r
  //\r
  TmpStr = Option->StatusString;\r
  if (TmpStr != NULL) {\r
    BdsLibOutputStrings (gST->ConOut, TmpStr, Option->Description, L"\n\r", NULL);\r
    FreePool (TmpStr);\r
  }\r
}\r
\r
EFI_STATUS\r
PlatformBdsNoConsoleAction (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function is remained for IBV/OEM to do some platform action,\r
  if there no console device can be connected.\r
\r
Arguments:\r
\r
  None.\r
\r
Returns:\r
\r
  EFI_SUCCESS      - Direct return success now.\r
\r
**/\r
{\r
  return EFI_SUCCESS;\r
}\r
\r
VOID\r
EFIAPI\r
PlatformBdsLockNonUpdatableFlash (\r
  VOID\r
  )\r
{\r
  return;\r
}\r
\r
/**\r
  Lock the ConsoleIn device in system table. All key\r
  presses will be ignored until the Password is typed in. The only way to\r
  disable the password is to type it in to a ConIn device.\r
\r
  @param  Password        Password used to lock ConIn device.\r
\r
  @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.\r
  @retval EFI_UNSUPPORTED Password not found\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LockKeyboards (\r
  IN  CHAR16    *Password\r
  )\r
{\r
    return EFI_UNSUPPORTED;\r
}\r
Commit	Line	Data
949f388f	1	/*++ @file\r
	2	\r
	3	Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
	4	Portions copyright (c) 2011, Apple Inc. All rights reserved.\r
d18d8a1d	5	This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
949f388f	12	\r
	13	**/\r
	14	\r
	15	#include "BdsPlatform.h"\r
	16	\r
	17	EMU_SYSTEM_CONFIGURATION mSystemConfigData;\r
	18	\r
	19	VOID\r
	20	SetupVariableInit (\r
	21	VOID\r
	22	)\r
	23	{\r
	24	EFI_STATUS Status;\r
	25	UINTN Size;\r
	26	\r
	27	Size = sizeof (mSystemConfigData);\r
	28	Status = gRT->GetVariable (\r
	29	L"Setup",\r
	30	&gEmuSystemConfigGuid,\r
	31	NULL,\r
	32	&Size,\r
	33	(VOID *) &mSystemConfigData\r
	34	);\r
	35	\r
	36	if (EFI_ERROR (Status)) {\r
	37	//\r
	38	// SetupVariable is corrupt\r
	39	//\r
	40	mSystemConfigData.ConOutRow = PcdGet32 (PcdConOutColumn);\r
	41	mSystemConfigData.ConOutColumn = PcdGet32 (PcdConOutRow);\r
	42	\r
	43	Status = gRT->SetVariable (\r
	44	L"Setup",\r
	45	&gEmuSystemConfigGuid,\r
	46	EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS,\r
	47	sizeof (mSystemConfigData),\r
	48	(VOID *) &mSystemConfigData\r
	49	);\r
	50	if (EFI_ERROR (Status)) {\r
	51	DEBUG ((EFI_D_ERROR, "Failed to save Setup Variable to non-volatile storage, Status = %r\n", Status));\r
	52	}\r
	53	}\r
	54	}\r
	55	\r
	56	//\r
	57	// BDS Platform Functions\r
	58	//\r
	59	VOID\r
	60	EFIAPI\r
	61	PlatformBdsInit (\r
	62	VOID\r
	63	)\r
	64	/*++\r
	65	\r
	66	Routine Description:\r
	67	\r
	68	Platform Bds init. Include the platform firmware vendor, revision\r
	69	and so crc check.\r
	70	\r
	71	Arguments:\r
	72	\r
	73	Returns:\r
	74	\r
	75	None.\r
76	\r
77	**/\r
78	{\r
79	SetupVariableInit ();\r
80	}\r
81	\r
82	EFI_STATUS\r
83	PlatformBdsConnectConsole (\r
84	IN BDS_CONSOLE_CONNECT_ENTRY *PlatformConsole\r
85	)\r
86	/*++\r
87	\r
88	Routine Description:\r
89	\r
90	Connect the predefined platform default console device. Always try to find\r
91	and enable the vga device if have.\r
92	\r
93	Arguments:\r
94	\r
95	PlatformConsole - Predfined platform default console device array.\r
d18d8a1d	96	\r
949f388f	97	Returns:\r
949f388f	98	\r
d18d8a1d	99	EFI_SUCCESS - Success connect at least one ConIn and ConOut\r
d18d8a1d	100	device, there must have one ConOut device is\r
949f388f	101	active vga device.\r
d18d8a1d	102	\r
d18d8a1d	103	EFI_STATUS - Return the status of\r
949f388f	104	BdsLibConnectAllDefaultConsoles ()\r
	105	\r
	106	**/\r
	107	{\r
	108	EFI_STATUS Status;\r
	109	UINTN Index;\r
	110	\r
	111	Index = 0;\r
	112	Status = EFI_SUCCESS;\r
	113	\r
	114	//\r
	115	// Have chance to connect the platform default console,\r
	116	// the platform default console is the minimue device group\r
	117	// the platform should support\r
	118	//\r
	119	while (PlatformConsole[Index].DevicePath != NULL) {\r
	120	//\r
	121	// Update the console variable with the connect type\r
	122	//\r
	123	if ((PlatformConsole[Index].ConnectType & CONSOLE_IN) == CONSOLE_IN) {\r
	124	BdsLibUpdateConsoleVariable (L"ConIn", PlatformConsole[Index].DevicePath, NULL);\r
	125	}\r
	126	\r
	127	if ((PlatformConsole[Index].ConnectType & CONSOLE_OUT) == CONSOLE_OUT) {\r
	128	BdsLibUpdateConsoleVariable (L"ConOut", PlatformConsole[Index].DevicePath, NULL);\r
	129	}\r
	130	\r
	131	if ((PlatformConsole[Index].ConnectType & STD_ERROR) == STD_ERROR) {\r
	132	BdsLibUpdateConsoleVariable (L"ErrOut", PlatformConsole[Index].DevicePath, NULL);\r
	133	}\r
	134	\r
	135	Index++;\r
	136	}\r
	137	//\r
	138	// Connect the all the default console with current cosole variable\r
	139	//\r
	140	Status = BdsLibConnectAllDefaultConsoles ();\r
	141	return Status;\r
	142	}\r
	143	\r
	144	VOID\r
	145	PlatformBdsConnectSequence (\r
	146	VOID\r
	147	)\r
	148	/*++\r
	149	\r
	150	Routine Description:\r
	151	\r
d18d8a1d	152	Connect with predeined platform connect sequence,\r
949f388f	153	the OEM/IBV can customize with their own connect sequence.\r
d18d8a1d	154	\r
949f388f	155	Arguments:\r
	156	\r
	157	None.\r
d18d8a1d	158	\r
949f388f	159	Returns:\r
	160	\r
	161	None.\r
d18d8a1d	162	\r
949f388f	163	**/\r
	164	{\r
	165	UINTN Index;\r
	166	\r
	167	Index = 0;\r
	168	\r
	169	//\r
	170	// Here we can get the customized platform connect sequence\r
	171	// Notes: we can connect with new variable which record the\r
	172	// last time boots connect device path sequence\r
	173	//\r
	174	while (gPlatformConnectSequence[Index] != NULL) {\r
	175	//\r
	176	// Build the platform boot option\r
	177	//\r
	178	BdsLibConnectDevicePath (gPlatformConnectSequence[Index]);\r
	179	Index++;\r
	180	}\r
	181	\r
	182	//\r
	183	// Just use the simple policy to connect all devices\r
	184	//\r
	185	BdsLibConnectAll ();\r
	186	}\r
	187	\r
	188	VOID\r
	189	PlatformBdsGetDriverOption (\r
	190	IN OUT LIST_ENTRY *BdsDriverLists\r
	191	)\r
	192	/*++\r
	193	\r
	194	Routine Description:\r
	195	\r
	196	Load the predefined driver option, OEM/IBV can customize this\r
	197	to load their own drivers\r
d18d8a1d	198	\r
949f388f	199	Arguments:\r
	200	\r
	201	BdsDriverLists - The header of the driver option link list.\r
d18d8a1d	202	\r
949f388f	203	Returns:\r
	204	\r
	205	None.\r
d18d8a1d	206	\r
949f388f	207	**/\r
	208	{\r
	209	UINTN Index;\r
	210	\r
	211	Index = 0;\r
	212	\r
	213	//\r
	214	// Here we can get the customized platform driver option\r
	215	//\r
	216	while (gPlatformDriverOption[Index] != NULL) {\r
	217	//\r
	218	// Build the platform boot option\r
	219	//\r
	220	BdsLibRegisterNewOption (BdsDriverLists, gPlatformDriverOption[Index], NULL, L"DriverOrder");\r
	221	Index++;\r
	222	}\r
	223	\r
	224	}\r
	225	\r
	226	VOID\r
	227	PlatformBdsDiagnostics (\r
	228	IN EXTENDMEM_COVERAGE_LEVEL MemoryTestLevel,\r
	229	IN BOOLEAN QuietBoot,\r
	230	IN BASEM_MEMORY_TEST BaseMemoryTest\r
	231	)\r
	232	/*++\r
	233	\r
	234	Routine Description:\r
	235	\r
	236	Perform the platform diagnostic, such like test memory. OEM/IBV also\r
	237	can customize this fuction to support specific platform diagnostic.\r
d18d8a1d	238	\r
949f388f	239	Arguments:\r
	240	\r
	241	MemoryTestLevel - The memory test intensive level\r
d18d8a1d	242	\r
949f388f	243	QuietBoot - Indicate if need to enable the quiet boot\r
	244	\r
	245	BaseMemoryTest - A pointer to BdsMemoryTest()\r
d18d8a1d	246	\r
949f388f	247	Returns:\r
	248	\r
	249	None.\r
d18d8a1d	250	\r
949f388f	251	**/\r
	252	{\r
	253	EFI_STATUS Status;\r
	254	\r
	255	//\r
	256	// Here we can decide if we need to show\r
	257	// the diagnostics screen\r
	258	// Notes: this quiet boot code should be remove\r
	259	// from the graphic lib\r
	260	//\r
	261	if (QuietBoot) {\r
	262	EnableQuietBoot (PcdGetPtr(PcdLogoFile));\r
	263	//\r
	264	// Perform system diagnostic\r
	265	//\r
	266	Status = BaseMemoryTest (MemoryTestLevel);\r
	267	if (EFI_ERROR (Status)) {\r
	268	DisableQuietBoot ();\r
	269	}\r
	270	\r
	271	return ;\r
	272	}\r
	273	//\r
	274	// Perform system diagnostic\r
	275	//\r
	276	Status = BaseMemoryTest (MemoryTestLevel);\r
	277	}\r
	278	\r
	279	VOID\r
	280	EFIAPI\r
	281	PlatformBdsPolicyBehavior (\r
	282	IN OUT LIST_ENTRY *DriverOptionList,\r
	283	IN OUT LIST_ENTRY *BootOptionList,\r
	284	IN PROCESS_CAPSULES ProcessCapsules,\r
	285	IN BASEM_MEMORY_TEST BaseMemoryTest\r
	286	)\r
	287	/*++\r
	288	\r
	289	Routine Description:\r
	290	\r
	291	The function will excute with as the platform policy, current policy\r
	292	is driven by boot mode. IBV/OEM can customize this code for their specific\r
	293	policy action.\r
d18d8a1d	294	\r
949f388f	295	Arguments:\r
	296	\r
	297	DriverOptionList - The header of the driver option link list\r
d18d8a1d	298	\r
949f388f	299	BootOptionList - The header of the boot option link list\r
	300	\r
	301	ProcessCapsules - A pointer to ProcessCapsules()\r
	302	\r
	303	BaseMemoryTest - A pointer to BaseMemoryTest()\r
	304	\r
	305	Returns:\r
	306	\r
	307	None.\r
d18d8a1d	308	\r
949f388f	309	**/\r
	310	{\r
	311	EFI_STATUS Status;\r
	312	UINT16 Timeout;\r
	313	EFI_BOOT_MODE BootMode;\r
	314	\r
	315	//\r
	316	// Init the time out value\r
	317	//\r
	318	Timeout = PcdGet16 (PcdPlatformBootTimeOut);\r
	319	\r
	320	//\r
	321	// Load the driver option as the driver option list\r
	322	//\r
	323	PlatformBdsGetDriverOption (DriverOptionList);\r
	324	\r
	325	//\r
	326	// Get current Boot Mode\r
	327	//\r
	328	Status = BdsLibGetBootMode (&BootMode);\r
	329	\r
	330	//\r
	331	// Go the different platform policy with different boot mode\r
	332	// Notes: this part code can be change with the table policy\r
	333	//\r
	334	switch (BootMode) {\r
	335	\r
	336	case BOOT_ASSUMING_NO_CONFIGURATION_CHANGES:\r
	337	case BOOT_WITH_MINIMAL_CONFIGURATION:\r
	338	//\r
	339	// In no-configuration boot mode, we can connect the\r
	340	// console directly.\r
	341	//\r
	342	BdsLibConnectAllDefaultConsoles ();\r
	343	PlatformBdsDiagnostics (IGNORE, TRUE, BaseMemoryTest);\r
	344	\r
	345	//\r
	346	// Perform some platform specific connect sequence\r
	347	//\r
	348	PlatformBdsConnectSequence ();\r
	349	\r
	350	//\r
	351	// Notes: current time out = 0 can not enter the\r
	352	// front page\r
	353	//\r
	354	PlatformBdsEnterFrontPage (Timeout, FALSE);\r
	355	\r
	356	//\r
	357	// Check the boot option with the boot option list\r
	358	//\r
	359	BdsLibBuildOptionFromVar (BootOptionList, L"BootOrder");\r
	360	break;\r
	361	\r
	362	case BOOT_ON_FLASH_UPDATE:\r
	363	//\r
	364	// Boot with the specific configuration\r
	365	//\r
	366	PlatformBdsConnectConsole (gPlatformConsole);\r
	367	PlatformBdsDiagnostics (EXTENSIVE, FALSE, BaseMemoryTest);\r
	368	BdsLibConnectAll ();\r
	369	ProcessCapsules (BOOT_ON_FLASH_UPDATE);\r
	370	break;\r
	371	\r
	372	case BOOT_IN_RECOVERY_MODE:\r
373	//\r
374	// In recovery mode, just connect platform console\r
375	// and show up the front page\r
376	//\r
377	PlatformBdsConnectConsole (gPlatformConsole);\r
378	PlatformBdsDiagnostics (EXTENSIVE, FALSE, BaseMemoryTest);\r
379	\r
380	//\r
381	// In recovery boot mode, we still enter to the\r
382	// frong page now\r
383	//\r
384	PlatformBdsEnterFrontPage (Timeout, FALSE);\r
385	break;\r
386	\r
387	case BOOT_WITH_FULL_CONFIGURATION:\r
388	case BOOT_WITH_FULL_CONFIGURATION_PLUS_DIAGNOSTICS:\r
389	case BOOT_WITH_DEFAULT_SETTINGS:\r
390	default:\r
391	//\r
392	// Connect platform console\r
393	//\r
394	Status = PlatformBdsConnectConsole (gPlatformConsole);\r
395	if (EFI_ERROR (Status)) {\r
396	//\r
397	// Here OEM/IBV can customize with defined action\r
398	//\r
399	PlatformBdsNoConsoleAction ();\r
400	}\r
401	\r
402	PlatformBdsDiagnostics (IGNORE, TRUE, BaseMemoryTest);\r
403	\r
404	//\r
405	// Perform some platform specific connect sequence\r
406	//\r
407	PlatformBdsConnectSequence ();\r
408	\r
409	//\r
410	// Give one chance to enter the setup if we\r
411	// have the time out\r
412	//\r
413	PlatformBdsEnterFrontPage (Timeout, FALSE);\r
414	\r
415	//\r
416	// Here we have enough time to do the enumeration of boot device\r
417	//\r
418	BdsLibEnumerateAllBootOption (BootOptionList);\r
419	break;\r
420	}\r
421	\r
422	return ;\r
423	\r
424	}\r
425	\r
426	VOID\r
427	EFIAPI\r
428	PlatformBdsBootSuccess (\r
429	IN BDS_COMMON_OPTION *Option\r
430	)\r
431	/*++\r
432	\r
433	Routine Description:\r
d18d8a1d	434	\r
949f388f	435	Hook point after a boot attempt succeeds. We don't expect a boot option to\r
	436	return, so the EFI 1.0 specification defines that you will default to an\r
	437	interactive mode and stop processing the BootOrder list in this case. This\r
	438	is alos a platform implementation and can be customized by IBV/OEM.\r
	439	\r
	440	Arguments:\r
	441	\r
	442	Option - Pointer to Boot Option that succeeded to boot.\r
	443	\r
	444	Returns:\r
d18d8a1d	445	\r
949f388f	446	None.\r
	447	\r
	448	**/\r
	449	{\r
	450	CHAR16 *TmpStr;\r
	451	\r
	452	//\r
	453	// If Boot returned with EFI_SUCCESS and there is not in the boot device\r
	454	// select loop then we need to pop up a UI and wait for user input.\r
	455	//\r
	456	TmpStr = Option->StatusString;\r
	457	if (TmpStr != NULL) {\r
	458	BdsLibOutputStrings (gST->ConOut, TmpStr, Option->Description, L"\n\r", NULL);\r
	459	FreePool (TmpStr);\r
	460	}\r
	461	}\r
	462	\r
	463	VOID\r
	464	EFIAPI\r
	465	PlatformBdsBootFail (\r
	466	IN BDS_COMMON_OPTION *Option,\r
	467	IN EFI_STATUS Status,\r
	468	IN CHAR16 *ExitData,\r
	469	IN UINTN ExitDataSize\r
	470	)\r
	471	/*++\r
	472	\r
	473	Routine Description:\r
d18d8a1d	474	\r
949f388f	475	Hook point after a boot attempt fails.\r
	476	\r
	477	Arguments:\r
d18d8a1d	478	\r
949f388f	479	Option - Pointer to Boot Option that failed to boot.\r
	480	\r
	481	Status - Status returned from failed boot.\r
	482	\r
	483	ExitData - Exit data returned from failed boot.\r
	484	\r
	485	ExitDataSize - Exit data size returned from failed boot.\r
	486	\r
	487	Returns:\r
d18d8a1d	488	\r
949f388f	489	None.\r
	490	\r
	491	**/\r
	492	{\r
	493	CHAR16 *TmpStr;\r
	494	\r
	495	//\r
	496	// If Boot returned with failed status then we need to pop up a UI and wait\r
	497	// for user input.\r
	498	//\r
	499	TmpStr = Option->StatusString;\r
	500	if (TmpStr != NULL) {\r
	501	BdsLibOutputStrings (gST->ConOut, TmpStr, Option->Description, L"\n\r", NULL);\r
	502	FreePool (TmpStr);\r
	503	}\r
	504	}\r
	505	\r
	506	EFI_STATUS\r
	507	PlatformBdsNoConsoleAction (\r
	508	VOID\r
	509	)\r
	510	/*++\r
	511	\r
	512	Routine Description:\r
d18d8a1d	513	\r
949f388f	514	This function is remained for IBV/OEM to do some platform action,\r
	515	if there no console device can be connected.\r
	516	\r
	517	Arguments:\r
d18d8a1d	518	\r
949f388f	519	None.\r
d18d8a1d	520	\r
949f388f	521	Returns:\r
d18d8a1d	522	\r
949f388f	523	EFI_SUCCESS - Direct return success now.\r
	524	\r
	525	**/\r
	526	{\r
	527	return EFI_SUCCESS;\r
	528	}\r
	529	\r
	530	VOID\r
	531	EFIAPI\r
	532	PlatformBdsLockNonUpdatableFlash (\r
	533	VOID\r
	534	)\r
	535	{\r
	536	return;\r
	537	}\r
	538	\r
	539	/**\r
	540	Lock the ConsoleIn device in system table. All key\r
	541	presses will be ignored until the Password is typed in. The only way to\r
	542	disable the password is to type it in to a ConIn device.\r
	543	\r
	544	@param Password Password used to lock ConIn device.\r
	545	\r
	546	@retval EFI_SUCCESS lock the Console In Spliter virtual handle successfully.\r
	547	@retval EFI_UNSUPPORTED Password not found\r
	548	\r
	549	**/\r
	550	EFI_STATUS\r
	551	EFIAPI\r
	552	LockKeyboards (\r
	553	IN CHAR16 *Password\r
	554	)\r
	555	{\r
	556	return EFI_UNSUPPORTED;\r
	557	}\r