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