1 /** @file 2 3 UEFI Component Name(2) protocol implementation header file for IDE Bus driver. 4 5 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR> 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 _IDE_BUS_COMPONENT_NAME_H_ 17 #define _IDE_BUS_COMPONENT_NAME_H_ 18 19 #define ADD_IDE_ATAPI_NAME(x) AddName ((x)); 20 21 extern EFI_COMPONENT_NAME_PROTOCOL gIDEBusComponentName; 22 extern EFI_COMPONENT_NAME2_PROTOCOL gIDEBusComponentName2; 23 24 25 // 26 // EFI Component Name Functions 27 // 28 /** 29 Retrieves a Unicode string that is the user readable name of the driver. 30 31 This function retrieves the user readable name of a driver in the form of a 32 Unicode string. If the driver specified by This has a user readable name in 33 the language specified by Language, then a pointer to the driver name is 34 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified 35 by This does not support the language specified by Language, 36 then EFI_UNSUPPORTED is returned. 37 38 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 39 EFI_COMPONENT_NAME_PROTOCOL instance. 40 41 @param Language[in] A pointer to a Null-terminated ASCII string 42 array indicating the language. This is the 43 language of the driver name that the caller is 44 requesting, and it must match one of the 45 languages specified in SupportedLanguages. The 46 number of languages supported by a driver is up 47 to the driver writer. Language is specified 48 in RFC 4646 or ISO 639-2 language code format. 49 50 @param DriverName[out] A pointer to the Unicode string to return. 51 This Unicode string is the name of the 52 driver specified by This in the language 53 specified by Language. 54 55 @retval EFI_SUCCESS The Unicode string for the Driver specified by 56 This and the language specified by Language was 57 returned in DriverName. 58 59 @retval EFI_INVALID_PARAMETER Language is NULL. 60 61 @retval EFI_INVALID_PARAMETER DriverName is NULL. 62 63 @retval EFI_UNSUPPORTED The driver specified by This does not support 64 the language specified by Language. 65 66 **/ 67 EFI_STATUS 68 EFIAPI 69 IDEBusComponentNameGetDriverName ( 70 IN EFI_COMPONENT_NAME_PROTOCOL *This, 71 IN CHAR8 *Language, 72 OUT CHAR16 **DriverName 73 ); 74 75 76 /** 77 Retrieves a Unicode string that is the user readable name of the controller 78 that is being managed by a driver. 79 80 This function retrieves the user readable name of the controller specified by 81 ControllerHandle and ChildHandle in the form of a Unicode string. If the 82 driver specified by This has a user readable name in the language specified by 83 Language, then a pointer to the controller name is returned in ControllerName, 84 and EFI_SUCCESS is returned. If the driver specified by This is not currently 85 managing the controller specified by ControllerHandle and ChildHandle, 86 then EFI_UNSUPPORTED is returned. If the driver specified by This does not 87 support the language specified by Language, then EFI_UNSUPPORTED is returned. 88 89 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 90 EFI_COMPONENT_NAME_PROTOCOL instance. 91 92 @param ControllerHandle[in] The handle of a controller that the driver 93 specified by This is managing. This handle 94 specifies the controller whose name is to be 95 returned. 96 97 @param ChildHandle[in] The handle of the child controller to retrieve 98 the name of. This is an optional parameter that 99 may be NULL. It will be NULL for device 100 drivers. It will also be NULL for a bus drivers 101 that wish to retrieve the name of the bus 102 controller. It will not be NULL for a bus 103 driver that wishes to retrieve the name of a 104 child controller. 105 106 @param Language[in] A pointer to a Null-terminated ASCII string 107 array indicating the language. This is the 108 language of the driver name that the caller is 109 requesting, and it must match one of the 110 languages specified in SupportedLanguages. The 111 number of languages supported by a driver is up 112 to the driver writer. Language is specified in 113 RFC 4646 or ISO 639-2 language code format. 114 115 @param ControllerName[out] A pointer to the Unicode string to return. 116 This Unicode string is the name of the 117 controller specified by ControllerHandle and 118 ChildHandle in the language specified by 119 Language from the point of view of the driver 120 specified by This. 121 122 @retval EFI_SUCCESS The Unicode string for the user readable name in 123 the language specified by Language for the 124 driver specified by This was returned in 125 DriverName. 126 127 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. 128 129 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid 130 EFI_HANDLE. 131 132 @retval EFI_INVALID_PARAMETER Language is NULL. 133 134 @retval EFI_INVALID_PARAMETER ControllerName is NULL. 135 136 @retval EFI_UNSUPPORTED The driver specified by This is not currently 137 managing the controller specified by 138 ControllerHandle and ChildHandle. 139 140 @retval EFI_UNSUPPORTED The driver specified by This does not support 141 the language specified by Language. 142 143 **/ 144 EFI_STATUS 145 EFIAPI 146 IDEBusComponentNameGetControllerName ( 147 IN EFI_COMPONENT_NAME_PROTOCOL *This, 148 IN EFI_HANDLE ControllerHandle, 149 IN EFI_HANDLE ChildHandle OPTIONAL, 150 IN CHAR8 *Language, 151 OUT CHAR16 **ControllerName 152 ); 153 154 155 /** 156 Add the component name for the IDE/ATAPI device 157 158 @param IdeBlkIoDevicePtr A pointer to the IDE_BLK_IO_DEV instance. 159 160 **/ 161 VOID 162 AddName ( 163 IN IDE_BLK_IO_DEV *IdeBlkIoDevicePtr 164 ); 165 166 #endif 167