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

/** @file\r
  UfsHcDxe driver produces EFI_UFS_HOST_CONTROLLER_PROTOCOL. The upper layer module\r
  uses it to query the MMIO base address of the UFS host controller.\r
\r
  Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "UfsPciHcDxe.h"\r
\r
//\r
// EFI Component Name Protocol\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gUfsHcComponentName = {\r
  UfsHcComponentNameGetDriverName,\r
  UfsHcComponentNameGetControllerName,\r
  "eng"\r
};\r
\r
//\r
// EFI Component Name 2 Protocol\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL  gUfsHcComponentName2 = {\r
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)UfsHcComponentNameGetDriverName,\r
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)UfsHcComponentNameGetControllerName,\r
  "en"\r
};\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE  mUfsHcDriverNameTable[] = {\r
  {\r
    "eng;en",\r
    L"Universal Flash Storage (UFS) Pci Host Controller Driver"\r
  },\r
  {\r
    NULL,\r
    NULL\r
  }\r
};\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE  mUfsHcControllerNameTable[] = {\r
  {\r
    "eng;en",\r
    L"Universal Flash Storage (UFS) Pci Host Controller"\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
UfsHcComponentNameGetDriverName (\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
           mUfsHcDriverNameTable,\r
           DriverName,\r
           (BOOLEAN)(This == &gUfsHcComponentName)\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
UfsHcComponentNameGetControllerName (\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
\r
  if ((Language == NULL) || (ControllerName == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\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
  //\r
  // Make sure this driver is currently managing Controller Handle\r
  //\r
  Status = EfiTestManagedDevice (\r
             ControllerHandle,\r
             gUfsHcDriverBinding.DriverBindingHandle,\r
             &gEfiPciIoProtocolGuid\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  return LookupUnicodeString2 (\r
           Language,\r
           This->SupportedLanguages,\r
           mUfsHcControllerNameTable,\r
           ControllerName,\r
           (BOOLEAN)(This == &gUfsHcComponentName)\r
           );\r
}\r
Commit	Line	Data
0591696e FT	1	/** @file\r
	2	UfsHcDxe driver produces EFI_UFS_HOST_CONTROLLER_PROTOCOL. The upper layer module\r
	3	uses it to query the MMIO base address of the UFS host controller.\r
	4	\r
d1102dba	5	Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>\r
9d510e61	6	SPDX-License-Identifier: BSD-2-Clause-Patent\r
0591696e FT	7	\r
	8	**/\r
	9	\r
	10	#include "UfsPciHcDxe.h"\r
	11	\r
	12	//\r
	13	// EFI Component Name Protocol\r
	14	//\r
1436aea4	15	GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gUfsHcComponentName = {\r
0591696e FT	16	UfsHcComponentNameGetDriverName,\r
	17	UfsHcComponentNameGetControllerName,\r
	18	"eng"\r
	19	};\r
	20	\r
	21	//\r
	22	// EFI Component Name 2 Protocol\r
	23	//\r
1436aea4 MK	24	GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUfsHcComponentName2 = {\r
	25	(EFI_COMPONENT_NAME2_GET_DRIVER_NAME)UfsHcComponentNameGetDriverName,\r
	26	(EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)UfsHcComponentNameGetControllerName,\r
0591696e FT	27	"en"\r
	28	};\r
	29	\r
1436aea4	30	GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUfsHcDriverNameTable[] = {\r
0591696e FT	31	{\r
	32	"eng;en",\r
	33	L"Universal Flash Storage (UFS) Pci Host Controller Driver"\r
	34	},\r
d1102dba	35	{\r
0591696e FT	36	NULL,\r
	37	NULL\r
	38	}\r
	39	};\r
	40	\r
1436aea4	41	GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUfsHcControllerNameTable[] = {\r
0591696e FT	42	{\r
	43	"eng;en",\r
	44	L"Universal Flash Storage (UFS) Pci Host Controller"\r
	45	},\r
	46	{\r
	47	NULL,\r
	48	NULL\r
	49	}\r
	50	};\r
	51	\r
	52	/**\r
	53	Retrieves a Unicode string that is the user readable name of the driver.\r
	54	\r
	55	This function retrieves the user readable name of a driver in the form of a\r
	56	Unicode string. If the driver specified by This has a user readable name in\r
	57	the language specified by Language, then a pointer to the driver name is\r
	58	returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
	59	by This does not support the language specified by Language,\r
	60	then EFI_UNSUPPORTED is returned.\r
	61	\r
	62	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	63	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	64	\r
	65	@param Language[in] A pointer to a Null-terminated ASCII string\r
	66	array indicating the language. This is the\r
	67	language of the driver name that the caller is\r
	68	requesting, and it must match one of the\r
	69	languages specified in SupportedLanguages. The\r
	70	number of languages supported by a driver is up\r
	71	to the driver writer. Language is specified\r
	72	in RFC 4646 or ISO 639-2 language code format.\r
	73	\r
	74	@param DriverName[out] A pointer to the Unicode string to return.\r
	75	This Unicode string is the name of the\r
	76	driver specified by This in the language\r
	77	specified by Language.\r
	78	\r
	79	@retval EFI_SUCCESS The Unicode string for the Driver specified by\r
	80	This and the language specified by Language was\r
	81	returned in DriverName.\r
	82	\r
	83	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	84	\r
	85	@retval EFI_INVALID_PARAMETER DriverName is NULL.\r
	86	\r
	87	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	88	the language specified by Language.\r
	89	\r
	90	**/\r
	91	EFI_STATUS\r
	92	EFIAPI\r
	93	UfsHcComponentNameGetDriverName (\r
1436aea4 MK	94	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	95	IN CHAR8 *Language,\r
	96	OUT CHAR16 **DriverName\r
0591696e FT	97	)\r
	98	{\r
	99	return LookupUnicodeString2 (\r
	100	Language,\r
	101	This->SupportedLanguages,\r
	102	mUfsHcDriverNameTable,\r
	103	DriverName,\r
	104	(BOOLEAN)(This == &gUfsHcComponentName)\r
	105	);\r
	106	}\r
	107	\r
	108	/**\r
	109	Retrieves a Unicode string that is the user readable name of the controller\r
	110	that is being managed by a driver.\r
	111	\r
	112	This function retrieves the user readable name of the controller specified by\r
	113	ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
	114	driver specified by This has a user readable name in the language specified by\r
	115	Language, then a pointer to the controller name is returned in ControllerName,\r
	116	and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
	117	managing the controller specified by ControllerHandle and ChildHandle,\r
	118	then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
	119	support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
	120	\r
	121	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	122	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	123	\r
	124	@param ControllerHandle[in] The handle of a controller that the driver\r
	125	specified by This is managing. This handle\r
	126	specifies the controller whose name is to be\r
	127	returned.\r
	128	\r
	129	@param ChildHandle[in] The handle of the child controller to retrieve\r
	130	the name of. This is an optional parameter that\r
	131	may be NULL. It will be NULL for device\r
	132	drivers. It will also be NULL for a bus drivers\r
	133	that wish to retrieve the name of the bus\r
	134	controller. It will not be NULL for a bus\r
	135	driver that wishes to retrieve the name of a\r
	136	child controller.\r
	137	\r
	138	@param Language[in] A pointer to a Null-terminated ASCII string\r
	139	array indicating the language. This is the\r
	140	language of the driver name that the caller is\r
	141	requesting, and it must match one of the\r
	142	languages specified in SupportedLanguages. The\r
	143	number of languages supported by a driver is up\r
	144	to the driver writer. Language is specified in\r
	145	RFC 4646 or ISO 639-2 language code format.\r
	146	\r
	147	@param ControllerName[out] A pointer to the Unicode string to return.\r
	148	This Unicode string is the name of the\r
	149	controller specified by ControllerHandle and\r
	150	ChildHandle in the language specified by\r
	151	Language from the point of view of the driver\r
	152	specified by This.\r
	153	\r
	154	@retval EFI_SUCCESS The Unicode string for the user readable name in\r
	155	the language specified by Language for the\r
	156	driver specified by This was returned in\r
	157	DriverName.\r
	158	\r
	159	@retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
	160	\r
161	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
162	EFI_HANDLE.\r
163	\r
164	@retval EFI_INVALID_PARAMETER Language is NULL.\r
165	\r
166	@retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
167	\r
168	@retval EFI_UNSUPPORTED The driver specified by This is not currently\r
169	managing the controller specified by\r
170	ControllerHandle and ChildHandle.\r
171	\r
172	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
173	the language specified by Language.\r
174	\r
175	**/\r
176	EFI_STATUS\r
177	EFIAPI\r
178	UfsHcComponentNameGetControllerName (\r
1436aea4 MK	179	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	180	IN EFI_HANDLE ControllerHandle,\r
	181	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	182	IN CHAR8 *Language,\r
	183	OUT CHAR16 **ControllerName\r
0591696e FT	184	)\r
0591696e FT	185	{\r
1436aea4	186	EFI_STATUS Status;\r
0591696e	187	\r
1436aea4	188	if ((Language == NULL) \|\| (ControllerName == NULL)) {\r
0591696e FT	189	return EFI_INVALID_PARAMETER;\r
	190	}\r
	191	\r
	192	//\r
	193	// This is a device driver, so ChildHandle must be NULL.\r
	194	//\r
	195	if (ChildHandle != NULL) {\r
	196	return EFI_UNSUPPORTED;\r
	197	}\r
	198	\r
	199	//\r
	200	// Make sure this driver is currently managing Controller Handle\r
	201	//\r
	202	Status = EfiTestManagedDevice (\r
	203	ControllerHandle,\r
	204	gUfsHcDriverBinding.DriverBindingHandle,\r
	205	&gEfiPciIoProtocolGuid\r
	206	);\r
	207	if (EFI_ERROR (Status)) {\r
	208	return Status;\r
	209	}\r
	210	\r
	211	return LookupUnicodeString2 (\r
	212	Language,\r
	213	This->SupportedLanguages,\r
	214	mUfsHcControllerNameTable,\r
	215	ControllerName,\r
	216	(BOOLEAN)(This == &gUfsHcComponentName)\r
	217	);\r
0591696e	218	}\r