[mirror_edk2.git] / MdeModulePkg / Bus / Pci / PciSioSerialDxe / ComponentName.c

/** @file\r
  UEFI Component Name and Name2 protocol for Isa serial driver.\r
\r
Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "Serial.h"\r
\r
//\r
// EFI Component Name Protocol\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gPciSioSerialComponentName = {\r
  SerialComponentNameGetDriverName,\r
  SerialComponentNameGetControllerName,\r
  "eng"\r
};\r
\r
//\r
// EFI Component Name 2 Protocol\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL  gPciSioSerialComponentName2 = {\r
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)SerialComponentNameGetDriverName,\r
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)SerialComponentNameGetControllerName,\r
  "en"\r
};\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE  mSerialDriverNameTable[] = {\r
  {\r
    "eng;en",\r
    L"PCI SIO Serial Driver"\r
  },\r
  {\r
    NULL,\r
    NULL\r
  }\r
};\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the driver.\r
\r
  This function retrieves the user readable name of a driver in the form of a\r
  Unicode string. If the driver specified by This has a user readable name in\r
  the language specified by Language, then a pointer to the driver name is\r
  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
  by This does not support the language specified by Language,\r
  then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language. This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified\r
                                in RFC 4646 or ISO 639-2 language code format.\r
\r
  @param  DriverName[out]       A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                driver specified by This in the language\r
                                specified by Language.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
                                This and the language specified by Language was\r
                                returned in DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SerialComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  )\r
{\r
  return LookupUnicodeString2 (\r
           Language,\r
           This->SupportedLanguages,\r
           mSerialDriverNameTable,\r
           DriverName,\r
           (BOOLEAN)(This == &gPciSioSerialComponentName)\r
           );\r
}\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the controller\r
  that is being managed by a driver.\r
\r
  This function retrieves the user readable name of the controller specified by\r
  ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
  driver specified by This has a user readable name in the language specified by\r
  Language, then a pointer to the controller name is returned in ControllerName,\r
  and EFI_SUCCESS is returned.  If the driver specified by This is not currently\r
  managing the controller specified by ControllerHandle and ChildHandle,\r
  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
  support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param  ControllerHandle[in]  The handle of a controller that the driver\r
                                specified by This is managing.  This handle\r
                                specifies the controller whose name is to be\r
                                returned.\r
\r
  @param  ChildHandle[in]       The handle of the child controller to retrieve\r
                                the name of.  This is an optional parameter that\r
                                may be NULL.  It will be NULL for device\r
                                drivers.  It will also be NULL for a bus drivers\r
                                that wish to retrieve the name of the bus\r
                                controller.  It will not be NULL for a bus\r
                                driver that wishes to retrieve the name of a\r
                                child controller.\r
\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language.  This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified in\r
                                RFC 4646 or ISO 639-2 language code format.\r
\r
  @param  ControllerName[out]   A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                controller specified by ControllerHandle and\r
                                ChildHandle in the language specified by\r
                                Language from the point of view of the driver\r
                                specified by This.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the user readable name in\r
                                the language specified by Language for the\r
                                driver specified by This was returned in\r
                                DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                EFI_HANDLE.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
                                managing the controller specified by\r
                                ControllerHandle and ChildHandle.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SerialComponentNameGetControllerName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   ControllerHandle,\r
  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **ControllerName\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_SERIAL_IO_PROTOCOL    *SerialIo;\r
  SERIAL_DEV                *SerialDevice;\r
  EFI_UNICODE_STRING_TABLE  *ControllerNameTable;\r
  EFI_GUID                  *IoProtocolGuid;\r
\r
  //\r
  // Make sure this driver is currently managing ControllerHandle\r
  //\r
  IoProtocolGuid = &gEfiSioProtocolGuid;\r
  Status         = EfiTestManagedDevice (\r
                     ControllerHandle,\r
                     gSerialControllerDriver.DriverBindingHandle,\r
                     IoProtocolGuid\r
                     );\r
  if (EFI_ERROR (Status)) {\r
    IoProtocolGuid = &gEfiPciIoProtocolGuid;\r
    Status         = EfiTestManagedDevice (\r
                       ControllerHandle,\r
                       gSerialControllerDriver.DriverBindingHandle,\r
                       IoProtocolGuid\r
                       );\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  ControllerNameTable = NULL;\r
  if (ChildHandle != NULL) {\r
    Status = EfiTestChildHandle (\r
               ControllerHandle,\r
               ChildHandle,\r
               IoProtocolGuid\r
               );\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    //\r
    // Get the Serial I/O Protocol from the child handle\r
    //\r
    Status = gBS->OpenProtocol (\r
                    ChildHandle,\r
                    &gEfiSerialIoProtocolGuid,\r
                    (VOID **)&SerialIo,\r
                    gSerialControllerDriver.DriverBindingHandle,\r
                    ChildHandle,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    //\r
    // Get the Serial Controller's Device structure\r
    //\r
    SerialDevice        = SERIAL_DEV_FROM_THIS (SerialIo);\r
    ControllerNameTable = SerialDevice->ControllerNameTable;\r
  }\r
\r
  return LookupUnicodeString2 (\r
           Language,\r
           This->SupportedLanguages,\r
           ControllerNameTable,\r
           ControllerName,\r
           (BOOLEAN)(This == &gPciSioSerialComponentName)\r
           );\r
}\r
\r
/**\r
  Add the ISO639-2 and RFC4646 component name both for the Serial IO device\r
\r
  @param SerialDevice     A pointer to the SERIAL_DEV instance.\r
  @param Instance         Instance ID for the serial device.\r
**/\r
VOID\r
AddName (\r
  IN  SERIAL_DEV  *SerialDevice,\r
  IN  UINT32      Instance\r
  )\r
{\r
  CHAR16  SerialPortName[SERIAL_PORT_NAME_LEN];\r
\r
  UnicodeSPrint (\r
    SerialPortName,\r
    sizeof (SerialPortName),\r
    (SerialDevice->PciDeviceInfo != NULL) ? PCI_SERIAL_PORT_NAME : SIO_SERIAL_PORT_NAME,\r
    Instance\r
    );\r
  AddUnicodeString2 (\r
    "eng",\r
    gPciSioSerialComponentName.SupportedLanguages,\r
    &SerialDevice->ControllerNameTable,\r
    SerialPortName,\r
    TRUE\r
    );\r
  AddUnicodeString2 (\r
    "en",\r
    gPciSioSerialComponentName2.SupportedLanguages,\r
    &SerialDevice->ControllerNameTable,\r
    SerialPortName,\r
    FALSE\r
    );\r
}\r
Commit	Line	Data
a59e2ede RN	1	/** @file\r
	2	UEFI Component Name and Name2 protocol for Isa serial driver.\r
	3	\r
1a3d12b1	4	Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
9d510e61	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
a59e2ede RN	6	\r
	7	**/\r
	8	\r
	9	#include "Serial.h"\r
	10	\r
	11	//\r
	12	// EFI Component Name Protocol\r
	13	//\r
	14	GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gPciSioSerialComponentName = {\r
	15	SerialComponentNameGetDriverName,\r
	16	SerialComponentNameGetControllerName,\r
	17	"eng"\r
	18	};\r
	19	\r
	20	//\r
	21	// EFI Component Name 2 Protocol\r
	22	//\r
1436aea4 MK	23	GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gPciSioSerialComponentName2 = {\r
	24	(EFI_COMPONENT_NAME2_GET_DRIVER_NAME)SerialComponentNameGetDriverName,\r
	25	(EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)SerialComponentNameGetControllerName,\r
a59e2ede RN	26	"en"\r
	27	};\r
	28	\r
1436aea4	29	GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mSerialDriverNameTable[] = {\r
a59e2ede RN	30	{\r
	31	"eng;en",\r
	32	L"PCI SIO Serial Driver"\r
	33	},\r
	34	{\r
	35	NULL,\r
	36	NULL\r
	37	}\r
	38	};\r
	39	\r
a59e2ede RN	40	/**\r
	41	Retrieves a Unicode string that is the user readable name of the driver.\r
	42	\r
	43	This function retrieves the user readable name of a driver in the form of a\r
	44	Unicode string. If the driver specified by This has a user readable name in\r
	45	the language specified by Language, then a pointer to the driver name is\r
	46	returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
	47	by This does not support the language specified by Language,\r
	48	then EFI_UNSUPPORTED is returned.\r
	49	\r
	50	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	51	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	52	\r
	53	@param Language[in] A pointer to a Null-terminated ASCII string\r
	54	array indicating the language. This is the\r
	55	language of the driver name that the caller is\r
	56	requesting, and it must match one of the\r
	57	languages specified in SupportedLanguages. The\r
	58	number of languages supported by a driver is up\r
	59	to the driver writer. Language is specified\r
	60	in RFC 4646 or ISO 639-2 language code format.\r
	61	\r
	62	@param DriverName[out] A pointer to the Unicode string to return.\r
	63	This Unicode string is the name of the\r
	64	driver specified by This in the language\r
	65	specified by Language.\r
	66	\r
	67	@retval EFI_SUCCESS The Unicode string for the Driver specified by\r
	68	This and the language specified by Language was\r
	69	returned in DriverName.\r
	70	\r
	71	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	72	\r
	73	@retval EFI_INVALID_PARAMETER DriverName is NULL.\r
	74	\r
	75	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	76	the language specified by Language.\r
	77	\r
	78	**/\r
	79	EFI_STATUS\r
	80	EFIAPI\r
	81	SerialComponentNameGetDriverName (\r
	82	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	83	IN CHAR8 *Language,\r
	84	OUT CHAR16 **DriverName\r
	85	)\r
	86	{\r
	87	return LookupUnicodeString2 (\r
	88	Language,\r
	89	This->SupportedLanguages,\r
	90	mSerialDriverNameTable,\r
	91	DriverName,\r
	92	(BOOLEAN)(This == &gPciSioSerialComponentName)\r
	93	);\r
	94	}\r
	95	\r
	96	/**\r
	97	Retrieves a Unicode string that is the user readable name of the controller\r
	98	that is being managed by a driver.\r
	99	\r
	100	This function retrieves the user readable name of the controller specified by\r
	101	ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
	102	driver specified by This has a user readable name in the language specified by\r
	103	Language, then a pointer to the controller name is returned in ControllerName,\r
104	and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
105	managing the controller specified by ControllerHandle and ChildHandle,\r
106	then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
107	support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
108	\r
109	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
110	EFI_COMPONENT_NAME_PROTOCOL instance.\r
111	\r
112	@param ControllerHandle[in] The handle of a controller that the driver\r
113	specified by This is managing. This handle\r
114	specifies the controller whose name is to be\r
115	returned.\r
116	\r
117	@param ChildHandle[in] The handle of the child controller to retrieve\r
118	the name of. This is an optional parameter that\r
119	may be NULL. It will be NULL for device\r
120	drivers. It will also be NULL for a bus drivers\r
121	that wish to retrieve the name of the bus\r
122	controller. It will not be NULL for a bus\r
123	driver that wishes to retrieve the name of a\r
124	child controller.\r
125	\r
126	@param Language[in] A pointer to a Null-terminated ASCII string\r
127	array indicating the language. This is the\r
128	language of the driver name that the caller is\r
129	requesting, and it must match one of the\r
130	languages specified in SupportedLanguages. The\r
131	number of languages supported by a driver is up\r
132	to the driver writer. Language is specified in\r
133	RFC 4646 or ISO 639-2 language code format.\r
134	\r
135	@param ControllerName[out] A pointer to the Unicode string to return.\r
136	This Unicode string is the name of the\r
137	controller specified by ControllerHandle and\r
138	ChildHandle in the language specified by\r
139	Language from the point of view of the driver\r
140	specified by This.\r
141	\r
142	@retval EFI_SUCCESS The Unicode string for the user readable name in\r
143	the language specified by Language for the\r
144	driver specified by This was returned in\r
145	DriverName.\r
146	\r
147	@retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
148	\r
149	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
150	EFI_HANDLE.\r
151	\r
152	@retval EFI_INVALID_PARAMETER Language is NULL.\r
153	\r
154	@retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
155	\r
156	@retval EFI_UNSUPPORTED The driver specified by This is not currently\r
157	managing the controller specified by\r
158	ControllerHandle and ChildHandle.\r
159	\r
160	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
161	the language specified by Language.\r
162	\r
163	**/\r
164	EFI_STATUS\r
165	EFIAPI\r
166	SerialComponentNameGetControllerName (\r
1436aea4 MK	167	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	168	IN EFI_HANDLE ControllerHandle,\r
	169	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	170	IN CHAR8 *Language,\r
	171	OUT CHAR16 **ControllerName\r
a59e2ede RN	172	)\r
	173	{\r
	174	EFI_STATUS Status;\r
	175	EFI_SERIAL_IO_PROTOCOL *SerialIo;\r
	176	SERIAL_DEV *SerialDevice;\r
	177	EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
	178	EFI_GUID *IoProtocolGuid;\r
	179	\r
	180	//\r
	181	// Make sure this driver is currently managing ControllerHandle\r
	182	//\r
	183	IoProtocolGuid = &gEfiSioProtocolGuid;\r
1436aea4 MK	184	Status = EfiTestManagedDevice (\r
	185	ControllerHandle,\r
	186	gSerialControllerDriver.DriverBindingHandle,\r
	187	IoProtocolGuid\r
	188	);\r
a59e2ede RN	189	if (EFI_ERROR (Status)) {\r
a59e2ede RN	190	IoProtocolGuid = &gEfiPciIoProtocolGuid;\r
1436aea4 MK	191	Status = EfiTestManagedDevice (\r
	192	ControllerHandle,\r
	193	gSerialControllerDriver.DriverBindingHandle,\r
	194	IoProtocolGuid\r
	195	);\r
a59e2ede RN	196	}\r
	197	\r
	198	if (EFI_ERROR (Status)) {\r
	199	return Status;\r
	200	}\r
	201	\r
	202	ControllerNameTable = NULL;\r
	203	if (ChildHandle != NULL) {\r
	204	Status = EfiTestChildHandle (\r
	205	ControllerHandle,\r
	206	ChildHandle,\r
	207	IoProtocolGuid\r
	208	);\r
	209	if (EFI_ERROR (Status)) {\r
	210	return Status;\r
	211	}\r
	212	\r
	213	//\r
	214	// Get the Serial I/O Protocol from the child handle\r
	215	//\r
	216	Status = gBS->OpenProtocol (\r
	217	ChildHandle,\r
	218	&gEfiSerialIoProtocolGuid,\r
1436aea4	219	(VOID **)&SerialIo,\r
a59e2ede RN	220	gSerialControllerDriver.DriverBindingHandle,\r
	221	ChildHandle,\r
	222	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
	223	);\r
	224	if (EFI_ERROR (Status)) {\r
	225	return Status;\r
	226	}\r
	227	\r
	228	//\r
	229	// Get the Serial Controller's Device structure\r
	230	//\r
1436aea4	231	SerialDevice = SERIAL_DEV_FROM_THIS (SerialIo);\r
a59e2ede RN	232	ControllerNameTable = SerialDevice->ControllerNameTable;\r
	233	}\r
	234	\r
	235	return LookupUnicodeString2 (\r
	236	Language,\r
	237	This->SupportedLanguages,\r
	238	ControllerNameTable,\r
	239	ControllerName,\r
	240	(BOOLEAN)(This == &gPciSioSerialComponentName)\r
	241	);\r
	242	}\r
	243	\r
	244	/**\r
	245	Add the ISO639-2 and RFC4646 component name both for the Serial IO device\r
	246	\r
	247	@param SerialDevice A pointer to the SERIAL_DEV instance.\r
	248	@param Instance Instance ID for the serial device.\r
	249	**/\r
	250	VOID\r
	251	AddName (\r
1436aea4 MK	252	IN SERIAL_DEV *SerialDevice,\r
1436aea4 MK	253	IN UINT32 Instance\r
a59e2ede RN	254	)\r
a59e2ede RN	255	{\r
1436aea4 MK	256	CHAR16 SerialPortName[SERIAL_PORT_NAME_LEN];\r
1436aea4 MK	257	\r
a59e2ede RN	258	UnicodeSPrint (\r
	259	SerialPortName,\r
	260	sizeof (SerialPortName),\r
	261	(SerialDevice->PciDeviceInfo != NULL) ? PCI_SERIAL_PORT_NAME : SIO_SERIAL_PORT_NAME,\r
	262	Instance\r
	263	);\r
	264	AddUnicodeString2 (\r
	265	"eng",\r
	266	gPciSioSerialComponentName.SupportedLanguages,\r
	267	&SerialDevice->ControllerNameTable,\r
	268	SerialPortName,\r
	269	TRUE\r
	270	);\r
	271	AddUnicodeString2 (\r
	272	"en",\r
	273	gPciSioSerialComponentName2.SupportedLanguages,\r
	274	&SerialDevice->ControllerNameTable,\r
	275	SerialPortName,\r
	276	FALSE\r
	277	);\r
a59e2ede	278	}\r