ComponentName.c File Reference

#include <Library/UefiLib.h>
#include "VirtioNet.h"

Go to the source code of this file.

Functions
STATIC EFI_STATUS EFIAPI	VirtioNetGetDriverName (IN EFI_COMPONENT_NAME_PROTOCOL *This, IN CHAR8 *Language, OUT CHAR16 **DriverName)
STATIC EFI_STATUS EFIAPI	VirtioNetGetControllerName (IN EFI_COMPONENT_NAME_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle, IN CHAR8 *Language, OUT CHAR16 **ControllerName)

Variables
STATIC EFI_UNICODE_STRING_TABLE	mVirtioNetDriverNameTable []
STATIC EFI_UNICODE_STRING_TABLE	mVirtioNetControllerNameTable []
EFI_COMPONENT_NAME_PROTOCOL	gVirtioNetComponentName
EFI_COMPONENT_NAME2_PROTOCOL	gVirtioNetComponentName2

Detailed Description

Component Name code for the virtio-net driver.

Copyright (C) 2013, Red Hat, Inc. Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.

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

Definition in file ComponentName.c.

Function Documentation

VirtioNetGetControllerName()

STATIC EFI_STATUS EFIAPI VirtioNetGetControllerName	(	IN EFI_COMPONENT_NAME_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_HANDLE	ChildHandle,
		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 118 of file ComponentName.c.

VirtioNetGetDriverName()

STATIC EFI_STATUS EFIAPI VirtioNetGetDriverName	(	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 54 of file ComponentName.c.

Variable Documentation

gVirtioNetComponentName

EFI_COMPONENT_NAME_PROTOCOL gVirtioNetComponentName

Initial value:

= {
  &VirtioNetGetDriverName,
  &VirtioNetGetControllerName,
  "eng" 
}

Definition at line 165 of file ComponentName.c.

gVirtioNetComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gVirtioNetComponentName2

Initial value:

= {
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)&VirtioNetGetDriverName,
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)&VirtioNetGetControllerName,
  "en" 
}

Definition at line 171 of file ComponentName.c.

mVirtioNetControllerNameTable

STATIC EFI_UNICODE_STRING_TABLE mVirtioNetControllerNameTable[]

Initial value:

= {
  { "eng;en", L"Virtio Network Device" },
  { NULL,     NULL                     }
}

Definition at line 23 of file ComponentName.c.

mVirtioNetDriverNameTable

STATIC EFI_UNICODE_STRING_TABLE mVirtioNetDriverNameTable[]

Initial value:

= {
  { "eng;en", L"Virtio Network Driver" },
  { NULL,     NULL                     }
}

Definition at line 17 of file ComponentName.c.