1 /** @file 2 This file contains the delarations for componet name routines. 3 4 Copyright (c) 2013-2015 Intel Corporation. 5 6 This program and the accompanying materials 7 are licensed and made available under the terms and conditions of the BSD License 8 which accompanies this distribution. The full text of the license may be found at 9 http://opensource.org/licenses/bsd-license.php 10 11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 13 14 **/ 15 16 #ifndef _COMPONENT_NAME_H_ 17 #define _COMPONENT_NAME_H_ 18 19 20 /** 21 Retrieves a Unicode string that is the user readable name of the driver. 22 23 This function retrieves the user readable name of a driver in the form of a 24 Unicode string. If the driver specified by This has a user readable name in 25 the language specified by Language, then a pointer to the driver name is 26 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified 27 by This does not support the language specified by Language, 28 then EFI_UNSUPPORTED is returned. 29 30 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 31 EFI_COMPONENT_NAME_PROTOCOL instance. 32 33 @param Language[in] A pointer to a Null-terminated ASCII string 34 array indicating the language. This is the 35 language of the driver name that the caller is 36 requesting, and it must match one of the 37 languages specified in SupportedLanguages. The 38 number of languages supported by a driver is up 39 to the driver writer. Language is specified 40 in RFC 4646 or ISO 639-2 language code format. 41 42 @param DriverName[out] A pointer to the Unicode string to return. 43 This Unicode string is the name of the 44 driver specified by This in the language 45 specified by Language. 46 47 @retval EFI_SUCCESS The Unicode string for the Driver specified by 48 This and the language specified by Language was 49 returned in DriverName. 50 51 @retval EFI_INVALID_PARAMETER Language is NULL. 52 53 @retval EFI_INVALID_PARAMETER DriverName is NULL. 54 55 @retval EFI_UNSUPPORTED The driver specified by This does not support 56 the language specified by Language. 57 58 **/ 59 EFI_STATUS 60 EFIAPI 61 OhciComponentNameGetDriverName ( 62 IN EFI_COMPONENT_NAME_PROTOCOL *This, 63 IN CHAR8 *Language, 64 OUT CHAR16 **DriverName 65 ); 66 67 68 /** 69 Retrieves a Unicode string that is the user readable name of the controller 70 that is being managed by a driver. 71 72 This function retrieves the user readable name of the controller specified by 73 ControllerHandle and ChildHandle in the form of a Unicode string. If the 74 driver specified by This has a user readable name in the language specified by 75 Language, then a pointer to the controller name is returned in ControllerName, 76 and EFI_SUCCESS is returned. If the driver specified by This is not currently 77 managing the controller specified by ControllerHandle and ChildHandle, 78 then EFI_UNSUPPORTED is returned. If the driver specified by This does not 79 support the language specified by Language, then EFI_UNSUPPORTED is returned. 80 81 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 82 EFI_COMPONENT_NAME_PROTOCOL instance. 83 84 @param ControllerHandle[in] The handle of a controller that the driver 85 specified by This is managing. This handle 86 specifies the controller whose name is to be 87 returned. 88 89 @param ChildHandle[in] The handle of the child controller to retrieve 90 the name of. This is an optional parameter that 91 may be NULL. It will be NULL for device 92 drivers. It will also be NULL for a bus drivers 93 that wish to retrieve the name of the bus 94 controller. It will not be NULL for a bus 95 driver that wishes to retrieve the name of a 96 child controller. 97 98 @param Language[in] A pointer to a Null-terminated ASCII string 99 array indicating the language. This is the 100 language of the driver name that the caller is 101 requesting, and it must match one of the 102 languages specified in SupportedLanguages. The 103 number of languages supported by a driver is up 104 to the driver writer. Language is specified in 105 RFC 4646 or ISO 639-2 language code format. 106 107 @param ControllerName[out] A pointer to the Unicode string to return. 108 This Unicode string is the name of the 109 controller specified by ControllerHandle and 110 ChildHandle in the language specified by 111 Language from the point of view of the driver 112 specified by This. 113 114 @retval EFI_SUCCESS The Unicode string for the user readable name in 115 the language specified by Language for the 116 driver specified by This was returned in 117 DriverName. 118 119 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. 120 121 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid 122 EFI_HANDLE. 123 124 @retval EFI_INVALID_PARAMETER Language is NULL. 125 126 @retval EFI_INVALID_PARAMETER ControllerName is NULL. 127 128 @retval EFI_UNSUPPORTED The driver specified by This is not currently 129 managing the controller specified by 130 ControllerHandle and ChildHandle. 131 132 @retval EFI_UNSUPPORTED The driver specified by This does not support 133 the language specified by Language. 134 135 **/ 136 EFI_STATUS 137 EFIAPI 138 OhciComponentNameGetControllerName ( 139 IN EFI_COMPONENT_NAME_PROTOCOL *This, 140 IN EFI_HANDLE ControllerHandle, 141 IN EFI_HANDLE ChildHandle OPTIONAL, 142 IN CHAR8 *Language, 143 OUT CHAR16 **ControllerName 144 ); 145 146 #endif 147 148
