]>
Commit | Line | Data |
---|---|---|
fb0b259e | 1 | /** @file\r |
2 | UEFI Component Name(2) protocol implementation for DebugPort driver.\r | |
c1f23d63 | 3 | \r |
284ee2e8 | 4 | Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r |
9d510e61 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
c1f23d63 | 6 | \r |
fb0b259e | 7 | **/\r |
c1f23d63 | 8 | \r |
9 | #include "DebugPort.h"\r | |
10 | \r | |
11 | //\r | |
12 | // EFI Component Name Protocol\r | |
13 | //\r | |
1307dcd7 | 14 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gDebugPortComponentName = {\r |
c1f23d63 | 15 | DebugPortComponentNameGetDriverName,\r |
16 | DebugPortComponentNameGetControllerName,\r | |
17 | "eng"\r | |
18 | };\r | |
19 | \r | |
19f97f7e | 20 | //\r |
21 | // EFI Component Name 2 Protocol\r | |
22 | //\r | |
1436aea4 MK |
23 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gDebugPortComponentName2 = {\r |
24 | (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)DebugPortComponentNameGetDriverName,\r | |
25 | (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)DebugPortComponentNameGetControllerName,\r | |
19f97f7e | 26 | "en"\r |
27 | };\r | |
28 | \r | |
1436aea4 | 29 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mDebugPortDriverNameTable[] = {\r |
c1f23d63 | 30 | {\r |
19f97f7e | 31 | "eng;en",\r |
1436aea4 | 32 | (CHAR16 *)L"DebugPort Driver"\r |
c1f23d63 | 33 | },\r |
34 | {\r | |
35 | NULL,\r | |
36 | NULL\r | |
37 | }\r | |
38 | };\r | |
39 | \r | |
19f97f7e | 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 | |
0254efc0 | 60 | in RFC 4646 or ISO 639-2 language code format.\r |
19f97f7e | 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 | |
c1f23d63 | 79 | EFI_STATUS\r |
80 | EFIAPI\r | |
81 | DebugPortComponentNameGetDriverName (\r | |
82 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
83 | IN CHAR8 *Language,\r | |
84 | OUT CHAR16 **DriverName\r | |
85 | )\r | |
c1f23d63 | 86 | {\r |
19f97f7e | 87 | return LookupUnicodeString2 (\r |
c1f23d63 | 88 | Language,\r |
19f97f7e | 89 | This->SupportedLanguages,\r |
c1f23d63 | 90 | mDebugPortDriverNameTable,\r |
19f97f7e | 91 | DriverName,\r |
92 | (BOOLEAN)(This == &gDebugPortComponentName)\r | |
c1f23d63 | 93 | );\r |
94 | }\r | |
95 | \r | |
19f97f7e | 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 | |
0254efc0 | 133 | RFC 4646 or ISO 639-2 language code format.\r |
19f97f7e | 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 | |
284ee2e8 | 147 | @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r |
19f97f7e | 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 | |
c1f23d63 | 164 | EFI_STATUS\r |
165 | EFIAPI\r | |
166 | DebugPortComponentNameGetControllerName (\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 | |
c1f23d63 | 172 | )\r |
c1f23d63 | 173 | {\r |
174 | return EFI_UNSUPPORTED;\r | |
175 | }\r |