REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3737 Apply uncrustify changes to .c/.h files in the RedfishPkg package Cc: Andrew Fish <afish@apple.com> Cc: Leif Lindholm <leif@nuviainc.com> Cc: Michael D Kinney <michael.d.kinney@intel.com> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Reviewed-by: Abner Chang <abner.chang@hpe.com>
		
			
				
	
	
		
			224 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			224 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/** @file
 | 
						|
  Implementation of EFI_COMPONENT_NAME_PROTOCOL and EFI_COMPONENT_NAME2_PROTOCOL
 | 
						|
  protocol.
 | 
						|
 | 
						|
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
 | 
						|
  (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
 | 
						|
 | 
						|
  SPDX-License-Identifier: BSD-2-Clause-Patent
 | 
						|
 | 
						|
**/
 | 
						|
#include <Uefi.h>
 | 
						|
 | 
						|
#include <Library/UefiLib.h>
 | 
						|
 | 
						|
#include <Protocol/ComponentName.h>
 | 
						|
#include <Protocol/ComponentName2.h>
 | 
						|
 | 
						|
//
 | 
						|
// EFI Component Name Functions
 | 
						|
//
 | 
						|
 | 
						|
/**
 | 
						|
  Retrieves a Unicode string that is the user-readable name of the EFI Driver.
 | 
						|
 | 
						|
  @param[in]   This       A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
 | 
						|
  @param[in]   Language   A pointer to a three-character ISO 639-2 language identifier.
 | 
						|
                          This is the language of the driver name that that the caller
 | 
						|
                          is requesting, and it must match one of the languages specified
 | 
						|
                          in SupportedLanguages.  The number of languages supported by a
 | 
						|
                          driver is up to the driver writer.
 | 
						|
  @param[out]  DriverName A pointer to the Unicode string to return.  This Unicode string
 | 
						|
                          is the name of the driver specified by This in the language
 | 
						|
                          specified by Language.
 | 
						|
 | 
						|
  @retval EFI_SUCCESS      The Unicode string for the Driver specified by This
 | 
						|
                           and the language specified by Language was returned
 | 
						|
                           in DriverName.
 | 
						|
  @retval EFI_INVALID_PARAMETER Language is NULL.
 | 
						|
  @retval EFI_INVALID_PARAMETER DriverName is NULL.
 | 
						|
  @retval EFI_UNSUPPORTED       The driver specified by This does not support the
 | 
						|
                                language specified by Language.
 | 
						|
 | 
						|
**/
 | 
						|
EFI_STATUS
 | 
						|
EFIAPI
 | 
						|
RedfishRestExComponentNameGetDriverName (
 | 
						|
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 | 
						|
  IN  CHAR8                        *Language,
 | 
						|
  OUT CHAR16                       **DriverName
 | 
						|
  );
 | 
						|
 | 
						|
/**
 | 
						|
  Retrieves a Unicode string that is the user readable name of the controller
 | 
						|
  that is being managed by an EFI Driver.
 | 
						|
 | 
						|
  @param[in]   This             A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
 | 
						|
  @param[in]   ControllerHandle The handle of a controller that the driver specified by
 | 
						|
                                This is managing.  This handle specifies the controller
 | 
						|
                                whose name is to be returned.
 | 
						|
  @param[in]   ChildHandle      The handle of the child controller to retrieve the name
 | 
						|
                                of. This is an optional parameter that may be NULL.  It
 | 
						|
                                will be NULL for device drivers.  It will also be NULL
 | 
						|
                                for a bus drivers that wish to retrieve the name of the
 | 
						|
                                bus controller.  It will not be NULL for a bus driver
 | 
						|
                                that wishes to retrieve the name of a child controller.
 | 
						|
  @param[in]   Language         A pointer to a three character ISO 639-2 language
 | 
						|
                                identifier. This is the language of the controller name
 | 
						|
                                that the caller is requesting, and it must match one
 | 
						|
                                of the languages specified in SupportedLanguages.  The
 | 
						|
                                number of languages supported by a driver is up to the
 | 
						|
                                driver writer.
 | 
						|
  @param[out]  ControllerName   A pointer to the Unicode string to return.  This Unicode
 | 
						|
                                string is the name of the controller specified by
 | 
						|
                                ControllerHandle and ChildHandle in the language specified
 | 
						|
                                by Language, from the point of view of the driver specified
 | 
						|
                                by This.
 | 
						|
 | 
						|
  @retval EFI_SUCCESS           The Unicode string for the user-readable name in the
 | 
						|
                                language specified by Language for the driver
 | 
						|
                                specified by This was returned in DriverName.
 | 
						|
  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
 | 
						|
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
 | 
						|
  @retval EFI_INVALID_PARAMETER Language is NULL.
 | 
						|
  @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 | 
						|
  @retval EFI_UNSUPPORTED       The driver specified by This is not currently managing
 | 
						|
                                the controller specified by ControllerHandle and
 | 
						|
                                ChildHandle.
 | 
						|
  @retval EFI_UNSUPPORTED       The driver specified by This does not support the
 | 
						|
                                language specified by Language.
 | 
						|
 | 
						|
**/
 | 
						|
EFI_STATUS
 | 
						|
EFIAPI
 | 
						|
RedfishRestExComponentNameGetControllerName (
 | 
						|
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 | 
						|
  IN  EFI_HANDLE                   ControllerHandle,
 | 
						|
  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
 | 
						|
  IN  CHAR8                        *Language,
 | 
						|
  OUT CHAR16                       **ControllerName
 | 
						|
  );
 | 
						|
 | 
						|
///
 | 
						|
/// Component Name Protocol instance
 | 
						|
///
 | 
						|
GLOBAL_REMOVE_IF_UNREFERENCED
 | 
						|
EFI_COMPONENT_NAME_PROTOCOL  gRedfishRestExComponentName = {
 | 
						|
  RedfishRestExComponentNameGetDriverName,
 | 
						|
  RedfishRestExComponentNameGetControllerName,
 | 
						|
  "eng"
 | 
						|
};
 | 
						|
 | 
						|
///
 | 
						|
/// Component Name 2 Protocol instance
 | 
						|
///
 | 
						|
GLOBAL_REMOVE_IF_UNREFERENCED
 | 
						|
EFI_COMPONENT_NAME2_PROTOCOL  gRedfishRestExComponentName2 = {
 | 
						|
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)RedfishRestExComponentNameGetDriverName,
 | 
						|
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)RedfishRestExComponentNameGetControllerName,
 | 
						|
  "en"
 | 
						|
};
 | 
						|
 | 
						|
///
 | 
						|
/// Table of driver names
 | 
						|
///
 | 
						|
GLOBAL_REMOVE_IF_UNREFERENCED
 | 
						|
EFI_UNICODE_STRING_TABLE  mRedfishRestExDriverNameTable[] = {
 | 
						|
  { "eng;en", (CHAR16 *)L"Redfish RestEx Network Service Driver" },
 | 
						|
  { NULL,     NULL                                               }
 | 
						|
};
 | 
						|
 | 
						|
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE  *gRedfishRestExControllerNameTable = NULL;
 | 
						|
 | 
						|
/**
 | 
						|
  Retrieves a Unicode string that is the user-readable name of the EFI Driver.
 | 
						|
 | 
						|
  @param[in]   This      A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
 | 
						|
  @param[in]   Language  A pointer to a three-character ISO 639-2 language identifier.
 | 
						|
                         This is the language of the driver name that that the caller
 | 
						|
                         is requesting, and it must match one of the languages specified
 | 
						|
                         in SupportedLanguages.  The number of languages supported by a
 | 
						|
                         driver is up to the driver writer.
 | 
						|
  @param[out]  DriverName  A pointer to the Unicode string to return.  This Unicode string
 | 
						|
                           is the name of the driver specified by This in the language
 | 
						|
                           specified by Language.
 | 
						|
 | 
						|
  @retval EFI_SUCCESS           The Unicode string for the Driver specified by This
 | 
						|
                                and the language specified by Language was returned
 | 
						|
                                in DriverName.
 | 
						|
  @retval EFI_INVALID_PARAMETER Language is NULL.
 | 
						|
  @retval EFI_INVALID_PARAMETER DriverName is NULL.
 | 
						|
  @retval EFI_UNSUPPORTED       The driver specified by This does not support the
 | 
						|
                                language specified by Language.
 | 
						|
 | 
						|
**/
 | 
						|
EFI_STATUS
 | 
						|
EFIAPI
 | 
						|
RedfishRestExComponentNameGetDriverName (
 | 
						|
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 | 
						|
  IN  CHAR8                        *Language,
 | 
						|
  OUT CHAR16                       **DriverName
 | 
						|
  )
 | 
						|
{
 | 
						|
  return LookupUnicodeString2 (
 | 
						|
           Language,
 | 
						|
           This->SupportedLanguages,
 | 
						|
           mRedfishRestExDriverNameTable,
 | 
						|
           DriverName,
 | 
						|
           (BOOLEAN)(This == &gRedfishRestExComponentName)
 | 
						|
           );
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  Retrieves a Unicode string that is the user readable name of the controller
 | 
						|
  that is being managed by an EFI Driver.
 | 
						|
 | 
						|
  @param[in]   This              A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
 | 
						|
  @param[in]   ControllerHandle  The handle of a controller that the driver specified by
 | 
						|
                                 This is managing.  This handle specifies the controller
 | 
						|
                                 whose name is to be returned.
 | 
						|
  @param[in]   ChildHandle       The handle of the child controller to retrieve the name
 | 
						|
                                 of.  This is an optional parameter that may be NULL.  It
 | 
						|
                                 will be NULL for device drivers.  It will also be NULL
 | 
						|
                                 for a bus drivers that wish to retrieve the name of the
 | 
						|
                                 bus controller.  It will not be NULL for a bus driver
 | 
						|
                                 that wishes to retrieve the name of a child controller.
 | 
						|
  @param[in]   Language    A pointer to a three character ISO 639-2 language
 | 
						|
                           identifier.  This is the language of the controller name
 | 
						|
                           that the caller is requesting, and it must match one
 | 
						|
                           of the languages specified in SupportedLanguages.  The
 | 
						|
                           number of languages supported by a driver is up to the
 | 
						|
                           driver writer.
 | 
						|
  @param[out]   ControllerName   A pointer to the Unicode string to return.  This Unicode
 | 
						|
                                  string is the name of the controller specified by
 | 
						|
                                  ControllerHandle and ChildHandle in the language specified
 | 
						|
                                  by Language, from the point of view of the driver specified
 | 
						|
                                  by This.
 | 
						|
 | 
						|
  @retval EFI_SUCCESS           The Unicode string for the user-readable name in the
 | 
						|
                                language specified by Language for the driver
 | 
						|
                                specified by This was returned in DriverName.
 | 
						|
  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
 | 
						|
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
 | 
						|
  @retval EFI_INVALID_PARAMETER Language is NULL.
 | 
						|
  @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 | 
						|
  @retval EFI_UNSUPPORTED       The driver specified by This is not currently managing
 | 
						|
                                the controller specified by ControllerHandle and
 | 
						|
                                ChildHandle.
 | 
						|
  @retval EFI_UNSUPPORTED       The driver specified by This does not support the
 | 
						|
                                language specified by Language.
 | 
						|
 | 
						|
**/
 | 
						|
EFI_STATUS
 | 
						|
EFIAPI
 | 
						|
RedfishRestExComponentNameGetControllerName (
 | 
						|
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 | 
						|
  IN  EFI_HANDLE                   ControllerHandle,
 | 
						|
  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
 | 
						|
  IN  CHAR8                        *Language,
 | 
						|
  OUT CHAR16                       **ControllerName
 | 
						|
  )
 | 
						|
{
 | 
						|
  return EFI_UNSUPPORTED;
 | 
						|
}
 |