NetworkPkg/Dhcp6Dxe/ComponentName.c File Reference


Functions

EFI_STATUS EFIAPI Dhcp6ComponentNameGetDriverName (IN EFI_COMPONENT_NAME_PROTOCOL *This, IN CHAR8 *Language, OUT CHAR16 **DriverName)
EFI_STATUS EFIAPI Dhcp6ComponentNameGetControllerName (IN EFI_COMPONENT_NAME_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle, IN CHAR8 *Language, OUT CHAR16 **ControllerName)
EFI_STATUS UpdateName (IN EFI_DHCP6_PROTOCOL *Dhcp6)

Variables

GLOBAL_REMOVE_IF_UNREFERENCED
EFI_COMPONENT_NAME_PROTOCOL 
gDhcp6ComponentName
GLOBAL_REMOVE_IF_UNREFERENCED
EFI_COMPONENT_NAME2_PROTOCOL 
gDhcp6ComponentName2
GLOBAL_REMOVE_IF_UNREFERENCED
EFI_UNICODE_STRING_TABLE 
mDhcp6DriverNameTable []
GLOBAL_REMOVE_IF_UNREFERENCED
EFI_UNICODE_STRING_TABLE * 
gDhcp6ControllerNameTable = NULL
CHAR16 * mDhcp6ControllerName []

Detailed Description

UEFI Component Name(2) protocol implementation for Dhcp6 driver.

Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.

This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Function Documentation

EFI_STATUS EFIAPI Dhcp6ComponentNameGetControllerName ( 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 a driver.

This function retrieves the user-readable name of the controller specified by ControllerHandle and ChildHandle in the form of a Unicode string. If the driver specified by This has a user-readable name in the language specified by Language, then a pointer to the controller name is returned in ControllerName, and EFI_SUCCESS is returned. If the driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle, then EFI_UNSUPPORTED is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.

Parameters:
[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 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 attempt to retrieve the name of the bus controller. It will not be NULL for a bus driver that attempts to retrieve the name of a child controller.
[in] Language A pointer to a Null-terminated ASCII string array indicating the language. 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. Language is specified in RFC 4646 or ISO 639-2 language code format.
[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.
Retrieves a Unicode string that is the user-readable name of the controller that is being managed by a driver.

This function retrieves the user-readable name of the controller specified by ControllerHandle and ChildHandle in the form of a Unicode string. If the driver specified by This has a user-readable name in the language specified by Language, then a pointer to the controller name is returned in ControllerName, and EFI_SUCCESS is returned. If the driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle, then EFI_UNSUPPORTED is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.

Parameters:
[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or 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 Null-terminated ASCII string array indicating the language. 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. Language is specified in the RFC 4646 or ISO 639-2 language code format.
[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.

References gDhcp6ComponentName, gDhcp6ControllerNameTable, and UpdateName().

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

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

This function retrieves the user-readable name of a driver in the form of a Unicode string. If the driver specified by This has a user-readable name in the language specified by Language, then a pointer to the driver name is returned in DriverName, and EFI_SUCCESS is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.

Parameters:
[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance.
[in] Language A pointer to a Null-terminated ASCII string array indicating the language. 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. Language is specified in RFC 4646 or ISO 639-2 language code format.
[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.

References gDhcp6ComponentName, and mDhcp6DriverNameTable.

EFI_STATUS UpdateName ( IN EFI_DHCP6_PROTOCOL *  Dhcp6  ) 

Update the component name for the Dhcp6 child handle.

Parameters:
Dhcp6[in] A pointer to the EFI_DHCP6_PROTOCOL.
Return values:
EFI_SUCCESS Update the ControllerNameTable of this instance successfully.
EFI_INVALID_PARAMETER The input parameter is invalid.

References gDhcp6ComponentName, gDhcp6ComponentName2, gDhcp6ControllerNameTable, and mDhcp6ControllerName.

Referenced by Dhcp6ComponentNameGetControllerName(), Ip6ComponentNameGetControllerName(), IScsiComponentNameGetControllerName(), Mtftp6ComponentNameGetControllerName(), and Udp6ComponentNameGetControllerName().


Variable Documentation

GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gDhcp6ComponentName

GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gDhcp6ComponentName2

Initial value:

 {
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) Dhcp6ComponentNameGetDriverName,
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) Dhcp6ComponentNameGetControllerName,
  "en"
}

Referenced by Dhcp6DriverEntryPoint(), and UpdateName().

GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE* gDhcp6ControllerNameTable = NULL

Initial value:

 {
  L"DHCPv6 (State=0, Init)",
  L"DHCPv6 (State=1, Selecting)",
  L"DHCPv6 (State=2, Requesting)",
  L"DHCPv6 (State=3, Declining)",
  L"DHCPv6 (State=4, Confirming)",
  L"DHCPv6 (State=5, Releasing)",
  L"DHCPv6 (State=6, Bound)",
  L"DHCPv6 (State=7, Renewing)",
  L"DHCPv6 (State=8, Rebinding)"
}

Referenced by UpdateName().

GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mDhcp6DriverNameTable[]

Initial value:

 {
  {
    "eng;en",
    L"DHCP6 Protocol Driver"
  },
  {
    NULL,
    NULL
  }
}

Referenced by Dhcp6ComponentNameGetDriverName().


Generated on Mon Sep 28 08:49:05 2015 for NetworkPkg[ALL] by  doxygen 1.5.7.1