ComponentName.c File Reference

#include "XenBusDxe.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	XenBusDxeComponentNameGetDriverName (IN EFI_COMPONENT_NAME2_PROTOCOL *This, IN CHAR8 *Language, OUT CHAR16 **DriverName)
EFI_STATUS EFIAPI	XenBusDxeComponentNameGetControllerName (IN EFI_COMPONENT_NAME2_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	gXenBusDxeComponentName
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL	gXenBusDxeComponentName2
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE	mXenBusDxeDriverNameTable []
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE	mXenBusDxeControllerNameTable []

Detailed Description

Component Name functions implementation for XenBus Bus driver.

Copyright (C) 2014, Citrix Ltd.

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

Definition in file ComponentName.c.

Function Documentation

XenBusDxeComponentNameGetControllerName()

EFI_STATUS EFIAPI XenBusDxeComponentNameGetControllerName	(	IN EFI_COMPONENT_NAME2_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

This	A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
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.
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.
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.
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 131 of file ComponentName.c.

XenBusDxeComponentNameGetDriverName()

EFI_STATUS EFIAPI XenBusDxeComponentNameGetDriverName	(	IN EFI_COMPONENT_NAME2_PROTOCOL *	This,
		IN CHAR8 *	Language,
		OUT CHAR16 **	DriverName
	)

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

Parameters

This	A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
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.
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 74 of file ComponentName.c.

Variable Documentation

gXenBusDxeComponentName

GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gXenBusDxeComponentName

Initial value:

= {
  (EFI_COMPONENT_NAME_GET_DRIVER_NAME)XenBusDxeComponentNameGetDriverName,
  (EFI_COMPONENT_NAME_GET_CONTROLLER_NAME)XenBusDxeComponentNameGetControllerName,
  "eng"
}

Component Name Protocol instance

Definition at line 16 of file ComponentName.c.

gXenBusDxeComponentName2

GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gXenBusDxeComponentName2

Initial value:

= {
  XenBusDxeComponentNameGetDriverName,
  XenBusDxeComponentNameGetControllerName,
  "en"
}

Component Name 2 Protocol instance

Definition at line 26 of file ComponentName.c.

mXenBusDxeControllerNameTable

GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mXenBusDxeControllerNameTable[]

Initial value:

= {
  { "eng;en", (CHAR16 *)L"XenBus Controller" },
  { NULL,     NULL                           }
}

Table of controller names

Definition at line 45 of file ComponentName.c.

mXenBusDxeDriverNameTable

GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mXenBusDxeDriverNameTable[]

Initial value:

= {
  { "eng;en", (CHAR16 *)L"XenBus Bus Driver" },
  { NULL,     NULL                           }
}

Table of driver names

Definition at line 36 of file ComponentName.c.