ComponentName.c File Reference

#include "DnsImpl.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	DnsComponentNameGetDriverName (IN EFI_COMPONENT_NAME_PROTOCOL *This, IN CHAR8 *Language, OUT CHAR16 **DriverName)
EFI_STATUS EFIAPI	DnsComponentNameGetControllerName (IN EFI_COMPONENT_NAME_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN CHAR8 *Language, OUT CHAR16 **ControllerName)
EFI_STATUS	UpdateDns4Name (EFI_DNS4_PROTOCOL *Dns4)
EFI_STATUS	UpdateDns6Name (EFI_DNS6_PROTOCOL *Dns6)

Variables
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL	gDnsComponentName
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL	gDnsComponentName2
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE	mDnsDriverNameTable []
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *	gDnsControllerNameTable = NULL

Detailed Description

Implementation of EFI_COMPONENT_NAME_PROTOCOL and EFI_COMPONENT_NAME2_PROTOCOL protocol.

Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file ComponentName.c.

Function Documentation

DnsComponentNameGetControllerName()

EFI_STATUS EFIAPI DnsComponentNameGetControllerName	(	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

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 362 of file ComponentName.c.

DnsComponentNameGetDriverName()

EFI_STATUS EFIAPI DnsComponentNameGetDriverName	(	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

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 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 150 of file ComponentName.c.

UpdateDns4Name()

EFI_STATUS UpdateDns4Name

(

EFI_DNS4_PROTOCOL *

Dns4

)

Update the component name for the Dns4 child handle.

Parameters

Dns4	A pointer to the EFI_DNS4_PROTOCOL.

Return values

EFI_SUCCESS	Update the ControllerNameTable of this instance successfully.
EFI_INVALID_PARAMETER	The input parameter is invalid.

Definition at line 176 of file ComponentName.c.

UpdateDns6Name()

EFI_STATUS UpdateDns6Name

(

EFI_DNS6_PROTOCOL *

Dns6

)

Update the component name for the Dns6 child handle.

Parameters

Dns6	A pointer to the EFI_DNS6_PROTOCOL.

Return values

EFI_SUCCESS	Update the ControllerNameTable of this instance successfully.
EFI_INVALID_PARAMETER	The input parameter is invalid.

Definition at line 252 of file ComponentName.c.

Variable Documentation

gDnsComponentName

GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gDnsComponentName

Initial value:

= {
  DnsComponentNameGetDriverName,
  DnsComponentNameGetControllerName,
  "eng"
}

Component Name Protocol instance

Definition at line 99 of file ComponentName.c.

gDnsComponentName2

GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gDnsComponentName2

Initial value:

= {
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)DnsComponentNameGetDriverName,
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)DnsComponentNameGetControllerName,
  "en"
}

Component Name 2 Protocol instance

Definition at line 109 of file ComponentName.c.

gDnsControllerNameTable

GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE* gDnsControllerNameTable = NULL

Definition at line 124 of file ComponentName.c.

mDnsDriverNameTable

GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mDnsDriverNameTable[]

Initial value:

= {
  { "eng;en", (CHAR16 *)L"DNS Network Service Driver" },
  { NULL,     NULL                                    }
}

Table of driver names

Definition at line 119 of file ComponentName.c.