#include "TcpMain.h"

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

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

EFI_STATUS	UpdateTcp4Name (IN EFI_TCP4_PROTOCOL *Tcp4)

EFI_STATUS	UpdateTcp6Name (IN EFI_TCP6_PROTOCOL *Tcp6)

Variables
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL	gTcpComponentName

GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL	gTcpComponentName2

GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE	mTcpDriverNameTable []

GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *	gTcpControllerNameTable = NULL

Detailed Description

Implementation of protocols EFI_COMPONENT_NAME_PROTOCOL and EFI_COMPONENT_NAME2_PROTOCOL.

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

Definition in file ComponentName.c.

Function Documentation

◆ TcpComponentNameGetControllerName()

EFI_STATUS EFIAPI TcpComponentNameGetControllerName	(	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 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 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 or 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 432 of file ComponentName.c.

◆ TcpComponentNameGetDriverName()

EFI_STATUS EFIAPI TcpComponentNameGetDriverName	(	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 or DriverName is NULL.
EFI_UNSUPPORTED	The driver specified by This does not support the language specified by Language.

Definition at line 208 of file ComponentName.c.

◆ UpdateTcp4Name()

EFI_STATUS UpdateTcp4Name ( IN EFI_TCP4_PROTOCOL * Tcp4 )

Update the component name for the Tcp4 child handle.

Parameters

Tcp4[in] A pointer to the EFI_TCP4_PROTOCOL.

Return values

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

Definition at line 234 of file ComponentName.c.

◆ UpdateTcp6Name()

EFI_STATUS UpdateTcp6Name ( IN EFI_TCP6_PROTOCOL * Tcp6 )

Update the component name for the Tcp6 child handle.

Parameters

Tcp6[in] A pointer to the EFI_TCP6_PROTOCOL.

Return values

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

Definition at line 307 of file ComponentName.c.

Variable Documentation

◆ gTcpComponentName

GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gTcpComponentName

Initial value:

= {
  TcpComponentNameGetDriverName,
  TcpComponentNameGetControllerName,
  "eng"
}

EFI Component Name Protocol

Definition at line 141 of file ComponentName.c.

◆ gTcpComponentName2

GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gTcpComponentName2

Initial value:

= {
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)TcpComponentNameGetDriverName,
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)TcpComponentNameGetControllerName,
  "en"
}

EFI Component Name 2 Protocol

Definition at line 150 of file ComponentName.c.

◆ gTcpControllerNameTable

GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE* gTcpControllerNameTable = NULL

Definition at line 167 of file ComponentName.c.

◆ mTcpDriverNameTable

GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mTcpDriverNameTable[]

Initial value:

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

Definition at line 156 of file ComponentName.c.

Functions

Variables

Detailed Description

Function Documentation

◆ TcpComponentNameGetControllerName()

◆ TcpComponentNameGetDriverName()

◆ UpdateTcp4Name()

◆ UpdateTcp6Name()

Variable Documentation

◆ gTcpComponentName

◆ gTcpComponentName2

◆ gTcpControllerNameTable

◆ mTcpDriverNameTable