[mirror_edk2.git] / EmbeddedPkg / Drivers / ConsolePrefDxe / ConsolePrefDxe.c

/** @file\r
*\r
*  Copyright (c) 2017, Linaro, Ltd. All rights reserved.\r
*\r
*  SPDX-License-Identifier: BSD-2-Clause-Patent\r
*\r
**/\r
\r
#include <Uefi.h>\r
#include <IndustryStandard/Acpi.h>\r
#include <libfdt.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
\r
#include <Protocol/AcpiTable.h>\r
#include <Protocol/AcpiSystemDescriptionTable.h>\r
\r
#include "ConsolePrefDxe.h"\r
\r
#define SPCR_SIG    EFI_ACPI_2_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE\r
\r
extern  UINT8                     ConsolePrefHiiBin[];\r
extern  UINT8                     ConsolePrefDxeStrings[];\r
\r
typedef struct {\r
  VENDOR_DEVICE_PATH              VendorDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL        End;\r
} HII_VENDOR_DEVICE_PATH;\r
\r
STATIC HII_VENDOR_DEVICE_PATH     mConsolePrefDxeVendorDevicePath = {\r
  {\r
    {\r
      HARDWARE_DEVICE_PATH,\r
      HW_VENDOR_DP,\r
      {\r
        (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r
        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
      }\r
    },\r
    CONSOLE_PREF_FORMSET_GUID\r
  },\r
  {\r
    END_DEVICE_PATH_TYPE,\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
    {\r
      (UINT8) (END_DEVICE_PATH_LENGTH),\r
      (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
    }\r
  }\r
};\r
\r
STATIC EFI_EVENT                  mReadyToBootEvent;\r
\r
STATIC\r
EFI_STATUS\r
InstallHiiPages (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  EFI_HII_HANDLE                  HiiHandle;\r
  EFI_HANDLE                      DriverHandle;\r
\r
  DriverHandle = NULL;\r
  Status = gBS->InstallMultipleProtocolInterfaces (&DriverHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  &mConsolePrefDxeVendorDevicePath,\r
                  NULL);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  HiiHandle = HiiAddPackages (&gConsolePrefFormSetGuid,\r
                              DriverHandle,\r
                              ConsolePrefDxeStrings,\r
                              ConsolePrefHiiBin,\r
                              NULL);\r
\r
  if (HiiHandle == NULL) {\r
    gBS->UninstallMultipleProtocolInterfaces (DriverHandle,\r
           &gEfiDevicePathProtocolGuid,\r
           &mConsolePrefDxeVendorDevicePath,\r
           NULL);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC\r
VOID\r
RemoveDtStdoutPath (\r
  VOID\r
)\r
{\r
  VOID        *Dtb;\r
  INT32       Node;\r
  INT32       Error;\r
  EFI_STATUS  Status;\r
\r
  Status = EfiGetSystemConfigurationTable (&gFdtTableGuid, &Dtb);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_INFO, "%a: could not retrieve DT blob - %r\n", __FUNCTION__,\r
      Status));\r
    return;\r
  }\r
\r
  Node = fdt_path_offset (Dtb, "/chosen");\r
  if (Node < 0) {\r
    return;\r
  }\r
\r
  Error = fdt_delprop (Dtb, Node, "stdout-path");\r
  if (Error) {\r
    DEBUG ((DEBUG_INFO, "%a: Failed to delete 'stdout-path' property: %a\n",\r
      __FUNCTION__, fdt_strerror (Error)));\r
  }\r
}\r
\r
STATIC\r
VOID\r
RemoveSpcrTable (\r
  VOID\r
  )\r
{\r
  EFI_ACPI_SDT_PROTOCOL           *Sdt;\r
  EFI_ACPI_TABLE_PROTOCOL         *AcpiTable;\r
  EFI_STATUS                      Status;\r
  UINTN                           TableIndex;\r
  EFI_ACPI_SDT_HEADER             *TableHeader;\r
  EFI_ACPI_TABLE_VERSION          TableVersion;\r
  UINTN                           TableKey;\r
\r
  Status = gBS->LocateProtocol (&gEfiAcpiTableProtocolGuid, NULL,\r
                  (VOID **)&AcpiTable);\r
  if (EFI_ERROR (Status)) {\r
    return;\r
  }\r
\r
  Status = gBS->LocateProtocol (&gEfiAcpiSdtProtocolGuid, NULL, (VOID **)&Sdt);\r
  if (EFI_ERROR (Status)) {\r
    return;\r
  }\r
\r
  TableIndex  = 0;\r
  TableKey    = 0;\r
  TableHeader = NULL;\r
\r
  do {\r
    Status = Sdt->GetAcpiTable (TableIndex++, &TableHeader, &TableVersion,\r
                    &TableKey);\r
    if (EFI_ERROR (Status)) {\r
      break;\r
    }\r
\r
    if (TableHeader->Signature != SPCR_SIG) {\r
      continue;\r
    }\r
\r
    Status = AcpiTable->UninstallAcpiTable (AcpiTable, TableKey);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_WARN, "%a: failed to uninstall SPCR table - %r\n",\r
        __FUNCTION__, Status));\r
    }\r
    break;\r
  } while (TRUE);\r
}\r
\r
STATIC\r
VOID\r
EFIAPI\r
OnReadyToBoot (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  )\r
{\r
  CONSOLE_PREF_VARSTORE_DATA      ConsolePref;\r
  UINTN                           BufferSize;\r
  EFI_STATUS                      Status;\r
  VOID                            *Gop;\r
\r
  BufferSize = sizeof (ConsolePref);\r
  Status = gRT->GetVariable (CONSOLE_PREF_VARIABLE_NAME,\r
                  &gConsolePrefFormSetGuid, NULL, &BufferSize, &ConsolePref);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR,\r
      "%a: variable '%s' could not be read - bailing!\n", __FUNCTION__,\r
      CONSOLE_PREF_VARIABLE_NAME));\r
    return;\r
  }\r
\r
  if (ConsolePref.Console == CONSOLE_PREF_SERIAL) {\r
    DEBUG ((DEBUG_INFO,\r
      "%a: serial console preferred - doing nothing\n", __FUNCTION__));\r
    return;\r
  }\r
\r
  //\r
  // Check if any GOP instances exist: if so, disable stdout-path and SPCR\r
  //\r
  Status = gBS->LocateProtocol (&gEfiGraphicsOutputProtocolGuid, NULL, &Gop);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_INFO,\r
      "%a: no GOP instances found - doing nothing (%r)\n", __FUNCTION__,\r
      Status));\r
    return;\r
  }\r
\r
  RemoveDtStdoutPath ();\r
  RemoveSpcrTable ();\r
}\r
\r
/**\r
  The entry point for ConsolePrefDxe driver.\r
\r
  @param[in] ImageHandle     The image handle of the driver.\r
  @param[in] SystemTable     The system table.\r
\r
  @retval EFI_ALREADY_STARTED     The driver already exists in system.\r
  @retval EFI_OUT_OF_RESOURCES    Fail to execute entry point due to lack of\r
                                  resources.\r
  @retval EFI_SUCCESS             All the related protocols are installed on\r
                                  the driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsolePrefDxeEntryPoint (\r
  IN EFI_HANDLE                   ImageHandle,\r
  IN EFI_SYSTEM_TABLE             *SystemTable\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  CONSOLE_PREF_VARSTORE_DATA      ConsolePref;\r
  UINTN                           BufferSize;\r
\r
  //\r
  // Get the current console preference from the ConsolePref variable.\r
  //\r
  BufferSize = sizeof (ConsolePref);\r
  Status = gRT->GetVariable (CONSOLE_PREF_VARIABLE_NAME,\r
                  &gConsolePrefFormSetGuid, NULL, &BufferSize, &ConsolePref);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_INFO,\r
      "%a: no console preference found, defaulting to graphical\n",\r
      __FUNCTION__));\r
    ConsolePref.Console = CONSOLE_PREF_GRAPHICAL;\r
  }\r
\r
  if (!EFI_ERROR (Status) &&\r
      ConsolePref.Console != CONSOLE_PREF_GRAPHICAL &&\r
      ConsolePref.Console != CONSOLE_PREF_SERIAL) {\r
    DEBUG ((DEBUG_WARN, "%a: invalid value for %s, defaulting to graphical\n",\r
      __FUNCTION__, CONSOLE_PREF_VARIABLE_NAME));\r
    ConsolePref.Console = CONSOLE_PREF_GRAPHICAL;\r
    Status = EFI_INVALID_PARAMETER; // trigger setvar below\r
  }\r
\r
  //\r
  // Write the newly selected value back to the variable store.\r
  //\r
  if (EFI_ERROR (Status)) {\r
    ZeroMem (&ConsolePref.Reserved, sizeof (ConsolePref.Reserved));\r
    Status = gRT->SetVariable (CONSOLE_PREF_VARIABLE_NAME,\r
                    &gConsolePrefFormSetGuid,\r
                    EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
                    sizeof (ConsolePref), &ConsolePref);\r
\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR, "%a: gRT->SetVariable () failed - %r\n",\r
        __FUNCTION__, Status));\r
      return Status;\r
    }\r
  }\r
\r
  Status = gBS->CreateEventEx (EVT_NOTIFY_SIGNAL, TPL_CALLBACK,\r
                  OnReadyToBoot, NULL, &gEfiEventReadyToBootGuid,\r
                  &mReadyToBootEvent);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return InstallHiiPages ();\r
}\r
Commit	Line	Data
d8e36289 AB	1	/** @file\r
	2	*\r
	3	* Copyright (c) 2017, Linaro, Ltd. All rights reserved.\r
	4	*\r
878b807a	5	* SPDX-License-Identifier: BSD-2-Clause-Patent\r
d8e36289 AB	6	*\r
	7	**/\r
	8	\r
	9	#include <Uefi.h>\r
	10	#include <IndustryStandard/Acpi.h>\r
	11	#include <libfdt.h>\r
	12	#include <Library/BaseLib.h>\r
	13	#include <Library/DebugLib.h>\r
	14	#include <Library/DevicePathLib.h>\r
	15	#include <Library/HiiLib.h>\r
	16	#include <Library/UefiBootServicesTableLib.h>\r
	17	#include <Library/UefiBootServicesTableLib.h>\r
	18	#include <Library/UefiDriverEntryPoint.h>\r
	19	#include <Library/UefiLib.h>\r
	20	#include <Library/UefiRuntimeServicesTableLib.h>\r
	21	\r
	22	#include <Protocol/AcpiTable.h>\r
	23	#include <Protocol/AcpiSystemDescriptionTable.h>\r
	24	\r
	25	#include "ConsolePrefDxe.h"\r
	26	\r
	27	#define SPCR_SIG EFI_ACPI_2_0_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE\r
	28	\r
	29	extern UINT8 ConsolePrefHiiBin[];\r
	30	extern UINT8 ConsolePrefDxeStrings[];\r
	31	\r
	32	typedef struct {\r
	33	VENDOR_DEVICE_PATH VendorDevicePath;\r
	34	EFI_DEVICE_PATH_PROTOCOL End;\r
	35	} HII_VENDOR_DEVICE_PATH;\r
	36	\r
	37	STATIC HII_VENDOR_DEVICE_PATH mConsolePrefDxeVendorDevicePath = {\r
	38	{\r
	39	{\r
	40	HARDWARE_DEVICE_PATH,\r
	41	HW_VENDOR_DP,\r
	42	{\r
	43	(UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r
	44	(UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
	45	}\r
	46	},\r
	47	CONSOLE_PREF_FORMSET_GUID\r
	48	},\r
	49	{\r
	50	END_DEVICE_PATH_TYPE,\r
	51	END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
	52	{\r
	53	(UINT8) (END_DEVICE_PATH_LENGTH),\r
	54	(UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
	55	}\r
	56	}\r
	57	};\r
	58	\r
	59	STATIC EFI_EVENT mReadyToBootEvent;\r
	60	\r
	61	STATIC\r
	62	EFI_STATUS\r
	63	InstallHiiPages (\r
	64	VOID\r
	65	)\r
	66	{\r
	67	EFI_STATUS Status;\r
	68	EFI_HII_HANDLE HiiHandle;\r
	69	EFI_HANDLE DriverHandle;\r
70	\r
71	DriverHandle = NULL;\r
72	Status = gBS->InstallMultipleProtocolInterfaces (&DriverHandle,\r
73	&gEfiDevicePathProtocolGuid,\r
74	&mConsolePrefDxeVendorDevicePath,\r
75	NULL);\r
76	if (EFI_ERROR (Status)) {\r
77	return Status;\r
78	}\r
79	\r
80	HiiHandle = HiiAddPackages (&gConsolePrefFormSetGuid,\r
81	DriverHandle,\r
82	ConsolePrefDxeStrings,\r
83	ConsolePrefHiiBin,\r
84	NULL);\r
85	\r
86	if (HiiHandle == NULL) {\r
87	gBS->UninstallMultipleProtocolInterfaces (DriverHandle,\r
88	&gEfiDevicePathProtocolGuid,\r
89	&mConsolePrefDxeVendorDevicePath,\r
90	NULL);\r
91	return EFI_OUT_OF_RESOURCES;\r
92	}\r
93	return EFI_SUCCESS;\r
94	}\r
95	\r
96	STATIC\r
97	VOID\r
98	RemoveDtStdoutPath (\r
99	VOID\r
100	)\r
101	{\r
102	VOID *Dtb;\r
103	INT32 Node;\r
104	INT32 Error;\r
105	EFI_STATUS Status;\r
106	\r
107	Status = EfiGetSystemConfigurationTable (&gFdtTableGuid, &Dtb);\r
108	if (EFI_ERROR (Status)) {\r
109	DEBUG ((DEBUG_INFO, "%a: could not retrieve DT blob - %r\n", __FUNCTION__,\r
110	Status));\r
111	return;\r
112	}\r
113	\r
114	Node = fdt_path_offset (Dtb, "/chosen");\r
115	if (Node < 0) {\r
116	return;\r
117	}\r
118	\r
119	Error = fdt_delprop (Dtb, Node, "stdout-path");\r
120	if (Error) {\r
121	DEBUG ((DEBUG_INFO, "%a: Failed to delete 'stdout-path' property: %a\n",\r
122	__FUNCTION__, fdt_strerror (Error)));\r
123	}\r
124	}\r
125	\r
126	STATIC\r
127	VOID\r
128	RemoveSpcrTable (\r
129	VOID\r
130	)\r
131	{\r
132	EFI_ACPI_SDT_PROTOCOL *Sdt;\r
133	EFI_ACPI_TABLE_PROTOCOL *AcpiTable;\r
134	EFI_STATUS Status;\r
135	UINTN TableIndex;\r
136	EFI_ACPI_SDT_HEADER *TableHeader;\r
137	EFI_ACPI_TABLE_VERSION TableVersion;\r
138	UINTN TableKey;\r
139	\r
140	Status = gBS->LocateProtocol (&gEfiAcpiTableProtocolGuid, NULL,\r
141	(VOID **)&AcpiTable);\r
142	if (EFI_ERROR (Status)) {\r
143	return;\r
144	}\r
145	\r
146	Status = gBS->LocateProtocol (&gEfiAcpiSdtProtocolGuid, NULL, (VOID **)&Sdt);\r
147	if (EFI_ERROR (Status)) {\r
148	return;\r
149	}\r
150	\r
151	TableIndex = 0;\r
152	TableKey = 0;\r
153	TableHeader = NULL;\r
154	\r
155	do {\r
156	Status = Sdt->GetAcpiTable (TableIndex++, &TableHeader, &TableVersion,\r
157	&TableKey);\r
158	if (EFI_ERROR (Status)) {\r
159	break;\r
160	}\r
161	\r
162	if (TableHeader->Signature != SPCR_SIG) {\r
163	continue;\r
164	}\r
165	\r
166	Status = AcpiTable->UninstallAcpiTable (AcpiTable, TableKey);\r
167	if (EFI_ERROR (Status)) {\r
168	DEBUG ((DEBUG_WARN, "%a: failed to uninstall SPCR table - %r\n",\r
169	__FUNCTION__, Status));\r
170	}\r
171	break;\r
172	} while (TRUE);\r
173	}\r
174	\r
175	STATIC\r
176	VOID\r
7609c047	177	EFIAPI\r
d8e36289 AB	178	OnReadyToBoot (\r
	179	IN EFI_EVENT Event,\r
	180	IN VOID *Context\r
	181	)\r
	182	{\r
	183	CONSOLE_PREF_VARSTORE_DATA ConsolePref;\r
	184	UINTN BufferSize;\r
	185	EFI_STATUS Status;\r
	186	VOID *Gop;\r
	187	\r
	188	BufferSize = sizeof (ConsolePref);\r
	189	Status = gRT->GetVariable (CONSOLE_PREF_VARIABLE_NAME,\r
	190	&gConsolePrefFormSetGuid, NULL, &BufferSize, &ConsolePref);\r
	191	if (EFI_ERROR (Status)) {\r
	192	DEBUG ((DEBUG_ERROR,\r
	193	"%a: variable '%s' could not be read - bailing!\n", __FUNCTION__,\r
	194	CONSOLE_PREF_VARIABLE_NAME));\r
	195	return;\r
	196	}\r
	197	\r
	198	if (ConsolePref.Console == CONSOLE_PREF_SERIAL) {\r
	199	DEBUG ((DEBUG_INFO,\r
	200	"%a: serial console preferred - doing nothing\n", __FUNCTION__));\r
	201	return;\r
	202	}\r
	203	\r
	204	//\r
	205	// Check if any GOP instances exist: if so, disable stdout-path and SPCR\r
	206	//\r
	207	Status = gBS->LocateProtocol (&gEfiGraphicsOutputProtocolGuid, NULL, &Gop);\r
	208	if (EFI_ERROR (Status)) {\r
	209	DEBUG ((DEBUG_INFO,\r
	210	"%a: no GOP instances found - doing nothing (%r)\n", __FUNCTION__,\r
	211	Status));\r
	212	return;\r
	213	}\r
	214	\r
	215	RemoveDtStdoutPath ();\r
	216	RemoveSpcrTable ();\r
	217	}\r
	218	\r
	219	/**\r
	220	The entry point for ConsolePrefDxe driver.\r
	221	\r
	222	@param[in] ImageHandle The image handle of the driver.\r
	223	@param[in] SystemTable The system table.\r
	224	\r
	225	@retval EFI_ALREADY_STARTED The driver already exists in system.\r
	226	@retval EFI_OUT_OF_RESOURCES Fail to execute entry point due to lack of\r
	227	resources.\r
c6a72cd7	228	@retval EFI_SUCCESS All the related protocols are installed on\r
d8e36289 AB	229	the driver.\r
	230	\r
	231	**/\r
	232	EFI_STATUS\r
	233	EFIAPI\r
	234	ConsolePrefDxeEntryPoint (\r
	235	IN EFI_HANDLE ImageHandle,\r
	236	IN EFI_SYSTEM_TABLE *SystemTable\r
	237	)\r
	238	{\r
	239	EFI_STATUS Status;\r
	240	CONSOLE_PREF_VARSTORE_DATA ConsolePref;\r
	241	UINTN BufferSize;\r
	242	\r
	243	//\r
	244	// Get the current console preference from the ConsolePref variable.\r
	245	//\r
	246	BufferSize = sizeof (ConsolePref);\r
	247	Status = gRT->GetVariable (CONSOLE_PREF_VARIABLE_NAME,\r
	248	&gConsolePrefFormSetGuid, NULL, &BufferSize, &ConsolePref);\r
	249	if (EFI_ERROR (Status)) {\r
	250	DEBUG ((DEBUG_INFO,\r
	251	"%a: no console preference found, defaulting to graphical\n",\r
	252	__FUNCTION__));\r
	253	ConsolePref.Console = CONSOLE_PREF_GRAPHICAL;\r
	254	}\r
	255	\r
	256	if (!EFI_ERROR (Status) &&\r
	257	ConsolePref.Console != CONSOLE_PREF_GRAPHICAL &&\r
	258	ConsolePref.Console != CONSOLE_PREF_SERIAL) {\r
	259	DEBUG ((DEBUG_WARN, "%a: invalid value for %s, defaulting to graphical\n",\r
	260	__FUNCTION__, CONSOLE_PREF_VARIABLE_NAME));\r
	261	ConsolePref.Console = CONSOLE_PREF_GRAPHICAL;\r
	262	Status = EFI_INVALID_PARAMETER; // trigger setvar below\r
	263	}\r
	264	\r
	265	//\r
	266	// Write the newly selected value back to the variable store.\r
	267	//\r
	268	if (EFI_ERROR (Status)) {\r
	269	ZeroMem (&ConsolePref.Reserved, sizeof (ConsolePref.Reserved));\r
	270	Status = gRT->SetVariable (CONSOLE_PREF_VARIABLE_NAME,\r
	271	&gConsolePrefFormSetGuid,\r
	272	EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
	273	sizeof (ConsolePref), &ConsolePref);\r
	274	\r
	275	if (EFI_ERROR (Status)) {\r
	276	DEBUG ((DEBUG_ERROR, "%a: gRT->SetVariable () failed - %r\n",\r
	277	__FUNCTION__, Status));\r
	278	return Status;\r
	279	}\r
	280	}\r
	281	\r
	282	Status = gBS->CreateEventEx (EVT_NOTIFY_SIGNAL, TPL_CALLBACK,\r
	283	OnReadyToBoot, NULL, &gEfiEventReadyToBootGuid,\r
	284	&mReadyToBootEvent);\r
	285	ASSERT_EFI_ERROR (Status);\r
	286	\r
	287	return InstallHiiPages ();\r
	288	}\r