projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 9b6bbcdb MK |
1 | /** @file\r |
| 2 | \r | |
| 3 | This file contains the delarations for componet name routines.\r | |
| 4 | \r | |
| 5 | Copyright (c) 2013-2015 Intel Corporation.\r | |
| 6 | \r | |
| c9f231d0 | 7 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| 9b6bbcdb MK |
8 | \r |
| 9 | **/\r | |
| 10 | \r | |
| 11 | \r | |
| 12 | #ifndef _COMPONENT_NAME_H_\r | |
| 13 | #define _COMPONENT_NAME_H_\r | |
| 14 | \r | |
| 15 | /**\r | |
| 16 | Retrieves a Unicode string that is the user readable name of the driver.\r | |
| 17 | \r | |
| 18 | This function retrieves the user readable name of a driver in the form of a\r | |
| 19 | Unicode string. If the driver specified by This has a user readable name in\r | |
| 20 | the language specified by Language, then a pointer to the driver name is\r | |
| 21 | returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r | |
| 22 | by This does not support the language specified by Language,\r | |
| 23 | then EFI_UNSUPPORTED is returned.\r | |
| 24 | \r | |
| 25 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
| 26 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
| 27 | \r | |
| 28 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
| 29 | array indicating the language. This is the\r | |
| 30 | language of the driver name that the caller is\r | |
| 31 | requesting, and it must match one of the\r | |
| 32 | languages specified in SupportedLanguages. The\r | |
| 33 | number of languages supported by a driver is up\r | |
| 34 | to the driver writer. Language is specified\r | |
| 35 | in RFC 3066 or ISO 639-2 language code format.\r | |
| 36 | \r | |
| 37 | @param DriverName[out] A pointer to the Unicode string to return.\r | |
| 38 | This Unicode string is the name of the\r | |
| 39 | driver specified by This in the language\r | |
| 40 | specified by Language.\r | |
| 41 | \r | |
| 42 | @retval EFI_SUCCESS The Unicode string for the Driver specified by\r | |
| 43 | This and the language specified by Language was\r | |
| 44 | returned in DriverName.\r | |
| 45 | \r | |
| 46 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
| 47 | \r | |
| 48 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
| 49 | \r | |
| 50 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
| 51 | the language specified by Language.\r | |
| 52 | \r | |
| 53 | **/\r | |
| 54 | EFI_STATUS\r | |
| 55 | EFIAPI\r | |
| 56 | SDControllerGetDriverName (\r | |
| 57 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
| 58 | IN CHAR8 *Language,\r | |
| 59 | OUT CHAR16 **DriverName\r | |
| 60 | );\r | |
| 61 | \r | |
| 62 | \r | |
| 63 | /**\r | |
| 64 | Retrieves a Unicode string that is the user readable name of the controller\r | |
| 65 | that is being managed by a driver.\r | |
| 66 | \r | |
| 67 | This function retrieves the user readable name of the controller specified by\r | |
| 68 | ControllerHandle and ChildHandle in the form of a Unicode string. If the\r | |
| 69 | driver specified by This has a user readable name in the language specified by\r | |
| 70 | Language, then a pointer to the controller name is returned in ControllerName,\r | |
| 71 | and EFI_SUCCESS is returned. If the driver specified by This is not currently\r | |
| 72 | managing the controller specified by ControllerHandle and ChildHandle,\r | |
| 73 | then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r | |
| 74 | support the language specified by Language, then EFI_UNSUPPORTED is returned.\r | |
| 75 | \r | |
| 76 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
| 77 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
| 78 | \r | |
| 79 | @param ControllerHandle[in] The handle of a controller that the driver\r | |
| 80 | specified by This is managing. This handle\r | |
| 81 | specifies the controller whose name is to be\r | |
| 82 | returned.\r | |
| 83 | \r | |
| 84 | @param ChildHandle[in] The handle of the child controller to retrieve\r | |
| 85 | the name of. This is an optional parameter that\r | |
| 86 | may be NULL. It will be NULL for device\r | |
| 87 | drivers. It will also be NULL for a bus drivers\r | |
| 88 | that wish to retrieve the name of the bus\r | |
| 89 | controller. It will not be NULL for a bus\r | |
| 90 | driver that wishes to retrieve the name of a\r | |
| 91 | child controller.\r | |
| 92 | \r | |
| 93 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
| 94 | array indicating the language. This is the\r | |
| 95 | language of the driver name that the caller is\r | |
| 96 | requesting, and it must match one of the\r | |
| 97 | languages specified in SupportedLanguages. The\r | |
| 98 | number of languages supported by a driver is up\r | |
| 99 | to the driver writer. Language is specified in\r | |
| 100 | RFC 3066 or ISO 639-2 language code format.\r | |
| 101 | \r | |
| 102 | @param ControllerName[out] A pointer to the Unicode string to return.\r | |
| 103 | This Unicode string is the name of the\r | |
| 104 | controller specified by ControllerHandle and\r | |
| 105 | ChildHandle in the language specified by\r | |
| 106 | Language from the point of view of the driver\r | |
| 107 | specified by This.\r | |
| 108 | \r | |
| 109 | @retval EFI_SUCCESS The Unicode string for the user readable name in\r | |
| 110 | the language specified by Language for the\r | |
| 111 | driver specified by This was returned in\r | |
| 112 | DriverName.\r | |
| 113 | \r | |
| 114 | @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r | |
| 115 | \r | |
| 116 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r | |
| 117 | EFI_HANDLE.\r | |
| 118 | \r | |
| 119 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
| 120 | \r | |
| 121 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
| 122 | \r | |
| 123 | @retval EFI_UNSUPPORTED The driver specified by This is not currently\r | |
| 124 | managing the controller specified by\r | |
| 125 | ControllerHandle and ChildHandle.\r | |
| 126 | \r | |
| 127 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
| 128 | the language specified by Language.\r | |
| 129 | \r | |
| 130 | **/\r | |
| 131 | EFI_STATUS\r | |
| 132 | EFIAPI\r | |
| 133 | SDControllerGetControllerName (\r | |
| 134 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
| 135 | IN EFI_HANDLE ControllerHandle,\r | |
| 136 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
| 137 | IN CHAR8 *Language,\r | |
| 138 | OUT CHAR16 **ControllerName\r | |
| 139 | );\r | |
| 140 | \r | |
| 141 | #endif\r |