ComponentName.c File Reference

#include "RedfishConfigHandlerCommon.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	RedfishConfigHandlerComponentNameGetDriverName (IN EFI_COMPONENT_NAME_PROTOCOL *This, IN CHAR8 *Language, OUT CHAR16 **DriverName)
EFI_STATUS EFIAPI	RedfishConfigHandlerComponentNameGetControllerName (IN EFI_COMPONENT_NAME_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN CHAR8 *Language, OUT CHAR16 **ControllerName)

Variables
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL	gRedfishConfigHandlerComponentName
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL	gRedfishConfigHandlerComponentName2
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE	mRedfishConfigHandlerDriverNameTable []
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *	gRedfishConfigHandlerControllerNameTable = NULL

Detailed Description

Implementation of EFI_COMPONENT_NAME_PROTOCOL and EFI_COMPONENT_NAME2_PROTOCOL protocol for EFI Refish Config Handler Protocol

Copyright (c) 2023, Mike Maslenkin mike..nosp@m.masl.nosp@m.enkin.nosp@m.@gma.nosp@m.il.co.nosp@m.m

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file ComponentName.c.

Function Documentation

RedfishConfigHandlerComponentNameGetControllerName()

EFI_STATUS EFIAPI RedfishConfigHandlerComponentNameGetControllerName	(	IN EFI_COMPONENT_NAME_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_HANDLE ChildHandle	OPTIONAL,
		IN CHAR8 *	Language,
		OUT CHAR16 **	ControllerName
	)

Retrieves a Unicode string that is the user readable name of the controller that is being managed by an EFI Driver.

Parameters

[in]	This	A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
[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.
[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.
[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.
[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.

Return values

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.
EFI_INVALID_PARAMETER	ControllerHandle is NULL.
EFI_INVALID_PARAMETER	ChildHandle is not NULL and it is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETER	Language is NULL.
EFI_INVALID_PARAMETER	ControllerName is NULL.
EFI_UNSUPPORTED	The driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle.
EFI_UNSUPPORTED	The driver specified by This does not support the language specified by Language.

Definition at line 209 of file ComponentName.c.

RedfishConfigHandlerComponentNameGetDriverName()

EFI_STATUS EFIAPI RedfishConfigHandlerComponentNameGetDriverName	(	IN EFI_COMPONENT_NAME_PROTOCOL *	This,
		IN CHAR8 *	Language,
		OUT CHAR16 **	DriverName
	)

Retrieves a Unicode string that is the user-readable name of the EFI Driver.

Parameters

[in]	This	A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
[in]	Language	A pointer to a three-character ISO 639-2 language identifier. This is the language of the driver 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.
[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.

Return values

EFI_SUCCESS	The Unicode string for the Driver specified by This and the language specified by Language was returned in DriverName.
EFI_INVALID_PARAMETER	Language is NULL.
EFI_INVALID_PARAMETER	DriverName is NULL.
EFI_UNSUPPORTED	The driver specified by This does not support the language specified by Language.

Definition at line 152 of file ComponentName.c.

Variable Documentation

gRedfishConfigHandlerComponentName

GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gRedfishConfigHandlerComponentName

Initial value:

= {
  RedfishConfigHandlerComponentNameGetDriverName,
  RedfishConfigHandlerComponentNameGetControllerName,
  "eng"
}

Component Name Protocol instance

Definition at line 101 of file ComponentName.c.

gRedfishConfigHandlerComponentName2

GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gRedfishConfigHandlerComponentName2

Initial value:

= {
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)RedfishConfigHandlerComponentNameGetDriverName,
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)RedfishConfigHandlerComponentNameGetControllerName,
  "en"
}

Component Name 2 Protocol instance

Definition at line 111 of file ComponentName.c.

gRedfishConfigHandlerControllerNameTable

GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE* gRedfishConfigHandlerControllerNameTable = NULL

Definition at line 126 of file ComponentName.c.

mRedfishConfigHandlerDriverNameTable

GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mRedfishConfigHandlerDriverNameTable[]

Initial value:

= {
  { "eng;en", (CHAR16 *)L"Redfish Configuration UEFI Driver" },
  { NULL,     NULL                                           }
}

Table of driver names

Definition at line 121 of file ComponentName.c.