ComponentName.c revision 5bca971e545e01271c6ae5b1b66ee9f281123bf2
195276127e373f2e2fb2a208ff77267422a197d9fxgu/*++ 295276127e373f2e2fb2a208ff77267422a197d9fxgu 395276127e373f2e2fb2a208ff77267422a197d9fxguCopyright (c) 2006, Intel Corporation 495276127e373f2e2fb2a208ff77267422a197d9fxguAll rights reserved. This program and the accompanying materials 595276127e373f2e2fb2a208ff77267422a197d9fxguare licensed and made available under the terms and conditions of the BSD License 695276127e373f2e2fb2a208ff77267422a197d9fxguwhich accompanies this distribution. The full text of the license may be found at 795276127e373f2e2fb2a208ff77267422a197d9fxguhttp://opensource.org/licenses/bsd-license.php 895276127e373f2e2fb2a208ff77267422a197d9fxgu 995276127e373f2e2fb2a208ff77267422a197d9fxguTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 1095276127e373f2e2fb2a208ff77267422a197d9fxguWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 1195276127e373f2e2fb2a208ff77267422a197d9fxgu 1295276127e373f2e2fb2a208ff77267422a197d9fxguModule Name: 1395276127e373f2e2fb2a208ff77267422a197d9fxgu 1495276127e373f2e2fb2a208ff77267422a197d9fxgu ComponentName.c 1595276127e373f2e2fb2a208ff77267422a197d9fxgu 1695276127e373f2e2fb2a208ff77267422a197d9fxguAbstract: 1795276127e373f2e2fb2a208ff77267422a197d9fxgu 1895276127e373f2e2fb2a208ff77267422a197d9fxgu--*/ 1995276127e373f2e2fb2a208ff77267422a197d9fxgu 2095276127e373f2e2fb2a208ff77267422a197d9fxgu#include "GraphicsConsole.h" 2195276127e373f2e2fb2a208ff77267422a197d9fxgu 2295276127e373f2e2fb2a208ff77267422a197d9fxgu// 2395276127e373f2e2fb2a208ff77267422a197d9fxgu// EFI Component Name Protocol 2495276127e373f2e2fb2a208ff77267422a197d9fxgu// 255bca971e545e01271c6ae5b1b66ee9f281123bf2qhuangEFI_COMPONENT_NAME_PROTOCOL gGraphicsConsoleComponentName = { 2695276127e373f2e2fb2a208ff77267422a197d9fxgu GraphicsConsoleComponentNameGetDriverName, 2795276127e373f2e2fb2a208ff77267422a197d9fxgu GraphicsConsoleComponentNameGetControllerName, 2895276127e373f2e2fb2a208ff77267422a197d9fxgu "eng" 295bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang }; 305bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 315bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang// 325bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang// EFI Component Name 2 Protocol 335bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang// 345bca971e545e01271c6ae5b1b66ee9f281123bf2qhuangEFI_COMPONENT_NAME2_PROTOCOL gGraphicsConsoleComponentName2 = { 355bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) GraphicsConsoleComponentNameGetDriverName, 365bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) GraphicsConsoleComponentNameGetControllerName, 375bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang "en" 385bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang }; 395bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 4095276127e373f2e2fb2a208ff77267422a197d9fxgu 4195276127e373f2e2fb2a208ff77267422a197d9fxguSTATIC EFI_UNICODE_STRING_TABLE mGraphicsConsoleDriverNameTable[] = { 4295276127e373f2e2fb2a208ff77267422a197d9fxgu { 435bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang "eng;en", 4495276127e373f2e2fb2a208ff77267422a197d9fxgu (CHAR16 *)L"UGA Console Driver" 4595276127e373f2e2fb2a208ff77267422a197d9fxgu }, 4695276127e373f2e2fb2a208ff77267422a197d9fxgu { 4795276127e373f2e2fb2a208ff77267422a197d9fxgu NULL, 4895276127e373f2e2fb2a208ff77267422a197d9fxgu NULL 4995276127e373f2e2fb2a208ff77267422a197d9fxgu } 5095276127e373f2e2fb2a208ff77267422a197d9fxgu}; 5195276127e373f2e2fb2a208ff77267422a197d9fxgu 525bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang/** 535bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang Retrieves a Unicode string that is the user readable name of the driver. 545bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 555bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang This function retrieves the user readable name of a driver in the form of a 565bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang Unicode string. If the driver specified by This has a user readable name in 575bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang the language specified by Language, then a pointer to the driver name is 585bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang returned in DriverName, and EFI_SUCCESS is returned. If the driver specified 595bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang by This does not support the language specified by Language, 605bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang then EFI_UNSUPPORTED is returned. 615bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 625bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 635bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang EFI_COMPONENT_NAME_PROTOCOL instance. 645bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 655bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @param Language[in] A pointer to a Null-terminated ASCII string 665bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang array indicating the language. This is the 675bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang language of the driver name that the caller is 685bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang requesting, and it must match one of the 695bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang languages specified in SupportedLanguages. The 705bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang number of languages supported by a driver is up 715bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang to the driver writer. Language is specified 725bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang in RFC 3066 or ISO 639-2 language code format. 735bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 745bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @param DriverName[out] A pointer to the Unicode string to return. 755bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang This Unicode string is the name of the 765bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang driver specified by This in the language 775bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang specified by Language. 785bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 795bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @retval EFI_SUCCESS The Unicode string for the Driver specified by 805bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang This and the language specified by Language was 815bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang returned in DriverName. 825bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 835bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @retval EFI_INVALID_PARAMETER Language is NULL. 845bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 855bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @retval EFI_INVALID_PARAMETER DriverName is NULL. 865bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 875bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @retval EFI_UNSUPPORTED The driver specified by This does not support 885bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang the language specified by Language. 895bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 905bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang**/ 9195276127e373f2e2fb2a208ff77267422a197d9fxguEFI_STATUS 9295276127e373f2e2fb2a208ff77267422a197d9fxguEFIAPI 9395276127e373f2e2fb2a208ff77267422a197d9fxguGraphicsConsoleComponentNameGetDriverName ( 9495276127e373f2e2fb2a208ff77267422a197d9fxgu IN EFI_COMPONENT_NAME_PROTOCOL *This, 9595276127e373f2e2fb2a208ff77267422a197d9fxgu IN CHAR8 *Language, 9695276127e373f2e2fb2a208ff77267422a197d9fxgu OUT CHAR16 **DriverName 9795276127e373f2e2fb2a208ff77267422a197d9fxgu ) 9895276127e373f2e2fb2a208ff77267422a197d9fxgu{ 995bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang return LookupUnicodeString2 ( 1005bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang Language, 1015bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang This->SupportedLanguages, 1025bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang mGraphicsConsoleDriverNameTable, 1035bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang DriverName, 1045bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang (BOOLEAN)(This == &gGraphicsConsoleComponentName) 1055bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang ); 10695276127e373f2e2fb2a208ff77267422a197d9fxgu} 10795276127e373f2e2fb2a208ff77267422a197d9fxgu 1085bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang/** 1095bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang Retrieves a Unicode string that is the user readable name of the controller 1105bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang that is being managed by a driver. 1115bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1125bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang This function retrieves the user readable name of the controller specified by 1135bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang ControllerHandle and ChildHandle in the form of a Unicode string. If the 1145bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang driver specified by This has a user readable name in the language specified by 1155bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang Language, then a pointer to the controller name is returned in ControllerName, 1165bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang and EFI_SUCCESS is returned. If the driver specified by This is not currently 1175bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang managing the controller specified by ControllerHandle and ChildHandle, 1185bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang then EFI_UNSUPPORTED is returned. If the driver specified by This does not 1195bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang support the language specified by Language, then EFI_UNSUPPORTED is returned. 1205bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1215bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 1225bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang EFI_COMPONENT_NAME_PROTOCOL instance. 1235bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1245bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @param ControllerHandle[in] The handle of a controller that the driver 1255bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang specified by This is managing. This handle 1265bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang specifies the controller whose name is to be 1275bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang returned. 1285bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1295bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @param ChildHandle[in] The handle of the child controller to retrieve 1305bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang the name of. This is an optional parameter that 1315bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang may be NULL. It will be NULL for device 1325bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang drivers. It will also be NULL for a bus drivers 1335bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang that wish to retrieve the name of the bus 1345bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang controller. It will not be NULL for a bus 1355bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang driver that wishes to retrieve the name of a 1365bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang child controller. 1375bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1385bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @param Language[in] A pointer to a Null-terminated ASCII string 1395bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang array indicating the language. This is the 1405bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang language of the driver name that the caller is 1415bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang requesting, and it must match one of the 1425bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang languages specified in SupportedLanguages. The 1435bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang number of languages supported by a driver is up 1445bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang to the driver writer. Language is specified in 1455bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang RFC 3066 or ISO 639-2 language code format. 1465bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1475bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @param ControllerName[out] A pointer to the Unicode string to return. 1485bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang This Unicode string is the name of the 1495bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang controller specified by ControllerHandle and 1505bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang ChildHandle in the language specified by 1515bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang Language from the point of view of the driver 1525bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang specified by This. 1535bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1545bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @retval EFI_SUCCESS The Unicode string for the user readable name in 1555bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang the language specified by Language for the 1565bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang driver specified by This was returned in 1575bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang DriverName. 1585bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1595bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. 1605bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1615bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid 1625bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang EFI_HANDLE. 1635bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1645bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @retval EFI_INVALID_PARAMETER Language is NULL. 1655bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1665bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @retval EFI_INVALID_PARAMETER ControllerName is NULL. 1675bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1685bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @retval EFI_UNSUPPORTED The driver specified by This is not currently 1695bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang managing the controller specified by 1705bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang ControllerHandle and ChildHandle. 1715bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1725bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang @retval EFI_UNSUPPORTED The driver specified by This does not support 1735bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang the language specified by Language. 1745bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang 1755bca971e545e01271c6ae5b1b66ee9f281123bf2qhuang**/ 17695276127e373f2e2fb2a208ff77267422a197d9fxguEFI_STATUS 17795276127e373f2e2fb2a208ff77267422a197d9fxguEFIAPI 17895276127e373f2e2fb2a208ff77267422a197d9fxguGraphicsConsoleComponentNameGetControllerName ( 17995276127e373f2e2fb2a208ff77267422a197d9fxgu IN EFI_COMPONENT_NAME_PROTOCOL *This, 18095276127e373f2e2fb2a208ff77267422a197d9fxgu IN EFI_HANDLE ControllerHandle, 18195276127e373f2e2fb2a208ff77267422a197d9fxgu IN EFI_HANDLE ChildHandle OPTIONAL, 18295276127e373f2e2fb2a208ff77267422a197d9fxgu IN CHAR8 *Language, 18395276127e373f2e2fb2a208ff77267422a197d9fxgu OUT CHAR16 **ControllerName 18495276127e373f2e2fb2a208ff77267422a197d9fxgu ) 18595276127e373f2e2fb2a208ff77267422a197d9fxgu{ 18695276127e373f2e2fb2a208ff77267422a197d9fxgu return EFI_UNSUPPORTED; 18795276127e373f2e2fb2a208ff77267422a197d9fxgu} 188