[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / IsaSerialDxe / ComponentName.c

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