]>
Commit | Line | Data |
---|---|---|
e65e8802 AP |
1 | /** @file\r |
2 | Component Name functions declaration for XenBus Bus driver.\r | |
3 | \r | |
4 | Copyright (C) 2014, Citrix Ltd.\r | |
5 | \r | |
6 | This program and the accompanying materials\r | |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | /**\r | |
17 | Retrieves a Unicode string that is the user-readable name of the EFI Driver.\r | |
18 | \r | |
19 | @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
20 | @param Language A pointer to a three-character ISO 639-2 language identifier.\r | |
21 | This is the language of the driver name that that the caller\r | |
22 | is requesting, and it must match one of the languages specified\r | |
23 | in SupportedLanguages. The number of languages supported by a\r | |
24 | driver is up to the driver writer.\r | |
25 | @param DriverName A pointer to the Unicode string to return. This Unicode string\r | |
26 | is the name of the driver specified by This in the language\r | |
27 | specified by Language.\r | |
28 | \r | |
29 | @retval EFI_SUCCESS The Unicode string for the Driver specified by This\r | |
30 | and the language specified by Language was returned\r | |
31 | in DriverName.\r | |
32 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
33 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
34 | @retval EFI_UNSUPPORTED The driver specified by This does not support the\r | |
35 | language specified by Language.\r | |
36 | \r | |
37 | **/\r | |
38 | EFI_STATUS\r | |
39 | EFIAPI\r | |
40 | XenBusDxeComponentNameGetDriverName (\r | |
41 | IN EFI_COMPONENT_NAME2_PROTOCOL *This,\r | |
42 | IN CHAR8 *Language,\r | |
43 | OUT CHAR16 **DriverName\r | |
44 | );\r | |
45 | \r | |
46 | /**\r | |
47 | Retrieves a Unicode string that is the user readable name of the controller\r | |
48 | that is being managed by an EFI Driver.\r | |
49 | \r | |
50 | @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
51 | @param ControllerHandle The handle of a controller that the driver specified by\r | |
52 | This is managing. This handle specifies the controller\r | |
53 | whose name is to be returned.\r | |
54 | @param ChildHandle The handle of the child controller to retrieve the name\r | |
55 | of. This is an optional parameter that may be NULL. It\r | |
56 | will be NULL for device drivers. It will also be NULL\r | |
57 | for a bus drivers that wish to retrieve the name of the\r | |
58 | bus controller. It will not be NULL for a bus driver\r | |
59 | that wishes to retrieve the name of a child controller.\r | |
60 | @param Language A pointer to a three character ISO 639-2 language\r | |
61 | identifier. This is the language of the controller name\r | |
62 | that the caller is requesting, and it must match one\r | |
63 | of the languages specified in SupportedLanguages. The\r | |
64 | number of languages supported by a driver is up to the\r | |
65 | driver writer.\r | |
66 | @param ControllerName A pointer to the Unicode string to return. This Unicode\r | |
67 | string is the name of the controller specified by\r | |
68 | ControllerHandle and ChildHandle in the language specified\r | |
69 | by Language, from the point of view of the driver specified\r | |
70 | by This.\r | |
71 | \r | |
72 | @retval EFI_SUCCESS The Unicode string for the user-readable name in the\r | |
73 | language specified by Language for the driver\r | |
74 | specified by This was returned in DriverName.\r | |
75 | @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r | |
76 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r | |
77 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
78 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
79 | @retval EFI_UNSUPPORTED The driver specified by This is not currently managing\r | |
80 | the controller specified by ControllerHandle and\r | |
81 | ChildHandle.\r | |
82 | @retval EFI_UNSUPPORTED The driver specified by This does not support the\r | |
83 | language specified by Language.\r | |
84 | \r | |
85 | **/\r | |
86 | EFI_STATUS\r | |
87 | EFIAPI\r | |
88 | XenBusDxeComponentNameGetControllerName (\r | |
89 | IN EFI_COMPONENT_NAME2_PROTOCOL *This,\r | |
90 | IN EFI_HANDLE ControllerHandle,\r | |
91 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
92 | IN CHAR8 *Language,\r | |
93 | OUT CHAR16 **ControllerName\r | |
94 | );\r |