[mirror_edk2.git] / EdkModulePkg / Bus / Usb / UsbKb / Dxe / ComponentName.c

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \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
Module Name:\r
\r
  ComponentName.c\r
\r
Abstract:\r
\r
--*/\r
\r
#include "keyboard.h"\r
\r
//\r
// EFI Component Name Functions\r
//\r
EFI_STATUS\r
EFIAPI\r
UsbKeyboardComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbKeyboardComponentNameGetControllerName (\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
//\r
// EFI Component Name Protocol\r
//\r
EFI_COMPONENT_NAME_PROTOCOL     gUsbKeyboardComponentName = {\r
  UsbKeyboardComponentNameGetDriverName,\r
  UsbKeyboardComponentNameGetControllerName,\r
  "eng"\r
};\r
\r
STATIC EFI_UNICODE_STRING_TABLE mUsbKeyboardDriverNameTable[] = {\r
  { "eng", (CHAR16 *) L"Usb Keyboard Driver" },\r
  { NULL , NULL }\r
};\r
\r
\r
EFI_STATUS\r
EFIAPI\r
UsbKeyboardComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  )\r
/*++\r
\r
  Routine Description:\r
    Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
\r
  Arguments:\r
    This       - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
    Language   - A pointer to a three character ISO 639-2 language identifier.\r
                 This is the language of the driver name that that the caller \r
                 is requesting, and it must match one of the languages specified\r
                 in SupportedLanguages.  The number of languages supported by a \r
                 driver is up to the driver writer.\r
    DriverName - A pointer to the Unicode string to return.  This Unicode string\r
                 is the name of the driver specified by This in the language \r
                 specified by Language.\r
\r
  Returns:\r
    EFI_SUCCESS           - The Unicode string for the Driver specified by This\r
                            and the language specified by Language was returned \r
                            in DriverName.\r
    EFI_INVALID_PARAMETER - Language is NULL.\r
    EFI_INVALID_PARAMETER - DriverName is NULL.\r
    EFI_UNSUPPORTED       - The driver specified by This does not support the \r
                            language specified by Language.\r
\r
--*/\r
{\r
  return LookupUnicodeString (\r
          Language,\r
          gUsbKeyboardComponentName.SupportedLanguages,\r
          mUsbKeyboardDriverNameTable,\r
          DriverName\r
          );\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
UsbKeyboardComponentNameGetControllerName (\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
\r
  Routine Description:\r
    Retrieves a Unicode string that is the user readable name of the controller\r
    that is being managed by an EFI Driver.\r
\r
  Arguments:\r
    This             - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
    ControllerHandle - The handle of a controller that the driver specified by \r
                       This is managing.  This handle specifies the controller \r
                       whose name is to be returned.\r
    ChildHandle      - The handle of the child controller to retrieve the name \r
                       of.  This is an optional parameter that may be NULL.  It \r
                       will be NULL for device drivers.  It will also be NULL \r
                       for a bus drivers that wish to retrieve the name of the \r
                       bus controller.  It will not be NULL for a bus driver \r
                       that wishes to retrieve the name of a child controller.\r
    Language         - A pointer to a three character ISO 639-2 language \r
                       identifier.  This is the language of the controller name \r
                       that that the caller is requesting, and it must match one\r
                       of the languages specified in SupportedLanguages.  The \r
                       number of languages supported by a driver is up to the \r
                       driver writer.\r
    ControllerName   - A pointer to the Unicode string to return.  This Unicode\r
                       string is the name of the controller specified by \r
                       ControllerHandle and ChildHandle in the language specified\r
                       by Language from the point of view of the driver specified\r
                       by This. \r
\r
  Returns:\r
    EFI_SUCCESS           - The Unicode string for the user readable name in the \r
                            language specified by Language for the driver \r
                            specified by This was returned in DriverName.\r
    EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
    EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
    EFI_INVALID_PARAMETER - Language is NULL.\r
    EFI_INVALID_PARAMETER - ControllerName is NULL.\r
    EFI_UNSUPPORTED       - The driver specified by This is not currently managing \r
                            the controller specified by ControllerHandle and \r
                            ChildHandle.\r
    EFI_UNSUPPORTED       - The driver specified by This does not support the \r
                            language specified by Language.\r
\r
--*/\r
{\r
  EFI_STATUS                  Status;\r
  USB_KB_DEV                  *UsbKbDev;\r
  EFI_SIMPLE_TEXT_IN_PROTOCOL *SimpleTxtIn;\r
  EFI_USB_IO_PROTOCOL         *UsbIoProtocol;\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
  // Check Controller's handle\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiUsbIoProtocolGuid,\r
                  (VOID **) &UsbIoProtocol,\r
                  gUsbKeyboardDriverBinding.DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    gBS->CloseProtocol (\r
          ControllerHandle,\r
          &gEfiUsbIoProtocolGuid,\r
          gUsbKeyboardDriverBinding.DriverBindingHandle,\r
          ControllerHandle\r
          );\r
\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  if (Status != EFI_ALREADY_STARTED) {\r
    return EFI_UNSUPPORTED;\r
  }\r
  //\r
  // Get the device context\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiSimpleTextInProtocolGuid,\r
                  (VOID **) &SimpleTxtIn,\r
                  gUsbKeyboardDriverBinding.DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  UsbKbDev = USB_KB_DEV_FROM_THIS (SimpleTxtIn);\r
\r
  return LookupUnicodeString (\r
          Language,\r
          gUsbKeyboardComponentName.SupportedLanguages,\r
          UsbKbDev->ControllerNameTable,\r
          ControllerName\r
          );\r
\r
}\r
Commit	Line	Data
878ddf1f	1	/*++\r
	2	\r
	3	Copyright (c) 2006, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
	12	Module Name:\r
	13	\r
	14	ComponentName.c\r
	15	\r
	16	Abstract:\r
	17	\r
	18	--*/\r
	19	\r
	20	#include "keyboard.h"\r
	21	\r
	22	//\r
	23	// EFI Component Name Functions\r
	24	//\r
	25	EFI_STATUS\r
	26	EFIAPI\r
	27	UsbKeyboardComponentNameGetDriverName (\r
	28	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	29	IN CHAR8 *Language,\r
	30	OUT CHAR16 **DriverName\r
	31	);\r
	32	\r
	33	EFI_STATUS\r
	34	EFIAPI\r
	35	UsbKeyboardComponentNameGetControllerName (\r
	36	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	37	IN EFI_HANDLE ControllerHandle,\r
	38	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	39	IN CHAR8 *Language,\r
	40	OUT CHAR16 **ControllerName\r
	41	);\r
	42	\r
	43	//\r
	44	// EFI Component Name Protocol\r
	45	//\r
	46	EFI_COMPONENT_NAME_PROTOCOL gUsbKeyboardComponentName = {\r
	47	UsbKeyboardComponentNameGetDriverName,\r
	48	UsbKeyboardComponentNameGetControllerName,\r
	49	"eng"\r
	50	};\r
	51	\r
	52	STATIC EFI_UNICODE_STRING_TABLE mUsbKeyboardDriverNameTable[] = {\r
	53	{ "eng", (CHAR16 *) L"Usb Keyboard Driver" },\r
	54	{ NULL , NULL }\r
	55	};\r
	56	\r
	57	\r
	58	EFI_STATUS\r
	59	EFIAPI\r
	60	UsbKeyboardComponentNameGetDriverName (\r
	61	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	62	IN CHAR8 *Language,\r
	63	OUT CHAR16 **DriverName\r
	64	)\r
65	/*++\r
66	\r
67	Routine Description:\r
68	Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
69	\r
70	Arguments:\r
71	This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
72	Language - A pointer to a three character ISO 639-2 language identifier.\r
73	This is the language of the driver name that that the caller \r
74	is requesting, and it must match one of the languages specified\r
75	in SupportedLanguages. The number of languages supported by a \r
76	driver is up to the driver writer.\r
77	DriverName - A pointer to the Unicode string to return. This Unicode string\r
78	is the name of the driver specified by This in the language \r
79	specified by Language.\r
80	\r
81	Returns:\r
82	EFI_SUCCESS - The Unicode string for the Driver specified by This\r
83	and the language specified by Language was returned \r
84	in DriverName.\r
85	EFI_INVALID_PARAMETER - Language is NULL.\r
86	EFI_INVALID_PARAMETER - DriverName is NULL.\r
87	EFI_UNSUPPORTED - The driver specified by This does not support the \r
88	language specified by Language.\r
89	\r
90	--*/\r
91	{\r
92	return LookupUnicodeString (\r
93	Language,\r
94	gUsbKeyboardComponentName.SupportedLanguages,\r
95	mUsbKeyboardDriverNameTable,\r
96	DriverName\r
97	);\r
98	}\r
99	\r
100	EFI_STATUS\r
101	EFIAPI\r
102	UsbKeyboardComponentNameGetControllerName (\r
103	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
104	IN EFI_HANDLE ControllerHandle,\r
105	IN EFI_HANDLE ChildHandle OPTIONAL,\r
106	IN CHAR8 *Language,\r
107	OUT CHAR16 **ControllerName\r
108	)\r
109	/*++\r
110	\r
111	Routine Description:\r
112	Retrieves a Unicode string that is the user readable name of the controller\r
113	that is being managed by an EFI Driver.\r
114	\r
115	Arguments:\r
116	This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
117	ControllerHandle - The handle of a controller that the driver specified by \r
118	This is managing. This handle specifies the controller \r
119	whose name is to be returned.\r
120	ChildHandle - The handle of the child controller to retrieve the name \r
121	of. This is an optional parameter that may be NULL. It \r
122	will be NULL for device drivers. It will also be NULL \r
123	for a bus drivers that wish to retrieve the name of the \r
124	bus controller. It will not be NULL for a bus driver \r
125	that wishes to retrieve the name of a child controller.\r
126	Language - A pointer to a three character ISO 639-2 language \r
127	identifier. This is the language of the controller name \r
128	that that the caller is requesting, and it must match one\r
129	of the languages specified in SupportedLanguages. The \r
130	number of languages supported by a driver is up to the \r
131	driver writer.\r
132	ControllerName - A pointer to the Unicode string to return. This Unicode\r
133	string is the name of the controller specified by \r
134	ControllerHandle and ChildHandle in the language specified\r
135	by Language from the point of view of the driver specified\r
136	by This. \r
137	\r
138	Returns:\r
139	EFI_SUCCESS - The Unicode string for the user readable name in the \r
140	language specified by Language for the driver \r
141	specified by This was returned in DriverName.\r
142	EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
143	EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
144	EFI_INVALID_PARAMETER - Language is NULL.\r
145	EFI_INVALID_PARAMETER - ControllerName is NULL.\r
146	EFI_UNSUPPORTED - The driver specified by This is not currently managing \r
147	the controller specified by ControllerHandle and \r
148	ChildHandle.\r
149	EFI_UNSUPPORTED - The driver specified by This does not support the \r
150	language specified by Language.\r
151	\r
152	--*/\r
153	{\r
154	EFI_STATUS Status;\r
155	USB_KB_DEV *UsbKbDev;\r
156	EFI_SIMPLE_TEXT_IN_PROTOCOL *SimpleTxtIn;\r
157	EFI_USB_IO_PROTOCOL *UsbIoProtocol;\r
158	//\r
159	// This is a device driver, so ChildHandle must be NULL.\r
160	//\r
161	if (ChildHandle != NULL) {\r
162	return EFI_UNSUPPORTED;\r
163	}\r
164	\r
165	//\r
166	// Check Controller's handle\r
167	//\r
168	Status = gBS->OpenProtocol (\r
169	ControllerHandle,\r
170	&gEfiUsbIoProtocolGuid,\r
171	(VOID **) &UsbIoProtocol,\r
172	gUsbKeyboardDriverBinding.DriverBindingHandle,\r
173	ControllerHandle,\r
174	EFI_OPEN_PROTOCOL_BY_DRIVER\r
175	);\r
176	if (!EFI_ERROR (Status)) {\r
177	gBS->CloseProtocol (\r
178	ControllerHandle,\r
179	&gEfiUsbIoProtocolGuid,\r
180	gUsbKeyboardDriverBinding.DriverBindingHandle,\r
181	ControllerHandle\r
182	);\r
183	\r
184	return EFI_UNSUPPORTED;\r
185	}\r
186	\r
187	if (Status != EFI_ALREADY_STARTED) {\r
188	return EFI_UNSUPPORTED;\r
189	}\r
190	//\r
191	// Get the device context\r
192	//\r
193	Status = gBS->OpenProtocol (\r
194	ControllerHandle,\r
195	&gEfiSimpleTextInProtocolGuid,\r
196	(VOID **) &SimpleTxtIn,\r
197	gUsbKeyboardDriverBinding.DriverBindingHandle,\r
198	ControllerHandle,\r
199	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
200	);\r
201	\r
202	if (EFI_ERROR (Status)) {\r
203	return Status;\r
204	}\r
205	\r
206	UsbKbDev = USB_KB_DEV_FROM_THIS (SimpleTxtIn);\r
207	\r
208	return LookupUnicodeString (\r
209	Language,\r
210	gUsbKeyboardComponentName.SupportedLanguages,\r
211	UsbKbDev->ControllerNameTable,\r
212	ControllerName\r
213	);\r
214	\r
215	}\r