/** @file\r
EFI VLAN Config protocol is to provide manageability interface for VLAN configuration.\r
\r
- Copyright (c) 2009, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
+ Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+ @par Revision Reference:\r
+ This Protocol is introduced in UEFI Specification 2.2\r
\r
**/\r
\r
#ifndef __EFI_VLANCONFIG_PROTOCOL_H__\r
#define __EFI_VLANCONFIG_PROTOCOL_H__\r
\r
-\r
#define EFI_VLAN_CONFIG_PROTOCOL_GUID \\r
{ \\r
0x9e23d768, 0xd2f3, 0x4366, {0x9f, 0xc3, 0x3a, 0x7a, 0xba, 0x86, 0x43, 0x74 } \\r
\r
typedef struct _EFI_VLAN_CONFIG_PROTOCOL EFI_VLAN_CONFIG_PROTOCOL;\r
\r
-\r
///\r
/// EFI_VLAN_FIND_DATA\r
///\r
typedef struct {\r
- UINT16 VlanId; ///< Vlan Identifier.\r
- UINT8 Priority; ///< Priority of this VLAN.\r
+ UINT16 VlanId; ///< Vlan Identifier.\r
+ UINT8 Priority; ///< Priority of this VLAN.\r
} EFI_VLAN_FIND_DATA;\r
\r
-\r
/**\r
- Create a VLAN device or modify the configuration parameter of an \r
+ Create a VLAN device or modify the configuration parameter of an\r
already-configured VLAN.\r
\r
The Set() function is used to create a new VLAN device or change the VLAN\r
- configuration parameters. If the VlanId hasn't been configured in the \r
+ configuration parameters. If the VlanId hasn't been configured in the\r
physical Ethernet device, a new VLAN device will be created. If a VLAN with\r
this VlanId is already configured, then related configuration will be updated\r
- as the input parameters. \r
- \r
+ as the input parameters.\r
+\r
If VlanId is zero, the VLAN device will send and receive untagged frames.\r
Otherwise, the VLAN device will send and receive VLAN-tagged frames containing the VlanId.\r
If VlanId is out of scope of (0-4094), EFI_INVALID_PARAMETER is returned.\r
- If Priority is out of the scope of (0-7), then EFI_INVALID_PARAMETER is returned. \r
- If there is not enough system memory to perform the registration, then \r
+ If Priority is out of the scope of (0-7), then EFI_INVALID_PARAMETER is returned.\r
+ If there is not enough system memory to perform the registration, then\r
EFI_OUT_OF_RESOURCES is returned.\r
\r
@param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL.\r
- @param[in] VlanId A unique identifier (1-4094) of the VLAN which is being created \r
+ @param[in] VlanId A unique identifier (1-4094) of the VLAN which is being created\r
or modified, or zero (0).\r
- @param[in] Priority 3 bit priority in VLAN header. Priority 0 is default value. If \r
+ @param[in] Priority 3 bit priority in VLAN header. Priority 0 is default value. If\r
VlanId is zero (0), Priority is ignored.\r
- \r
+\r
@retval EFI_SUCCESS The VLAN is successfully configured.\r
@retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE:\r
- This is NULL.\r
Find configuration information for specified VLAN or all configured VLANs.\r
\r
The Find() function is used to find the configuration information for matching\r
- VLAN and allocate a buffer into which those entries are copied. \r
+ VLAN and allocate a buffer into which those entries are copied.\r
\r
@param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL.\r
@param[in] VlanId Pointer to VLAN identifier. Set to NULL to find all\r
configured VLANs.\r
@param[out] NumberOfVlan The number of VLANs which is found by the specified criteria.\r
@param[out] Entries The buffer which receive the VLAN configuration.\r
- \r
+\r
@retval EFI_SUCCESS The VLAN is successfully found.\r
@retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE:\r
- This is NULL.\r
/**\r
Remove the configured VLAN device.\r
\r
- The Remove() function is used to remove the specified VLAN device. \r
+ The Remove() function is used to remove the specified VLAN device.\r
If the VlanId is out of the scope of (0-4094), EFI_INVALID_PARAMETER is returned.\r
- If specified VLAN hasn't been previously configured, EFI_NOT_FOUND is returned. \r
+ If specified VLAN hasn't been previously configured, EFI_NOT_FOUND is returned.\r
\r
@param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL.\r
@param[in] VlanId Identifier (0-4094) of the VLAN to be removed.\r
- \r
+\r
@retval EFI_SUCCESS The VLAN is successfully removed.\r
@retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE:\r
- This is NULL.\r
\r
///\r
/// EFI_VLAN_CONFIG_PROTOCOL\r
-/// provide manageability interface for VLAN setting. The intended \r
+/// provide manageability interface for VLAN setting. The intended\r
/// VLAN tagging implementation is IEEE802.1Q.\r
///\r
struct _EFI_VLAN_CONFIG_PROTOCOL {\r
- EFI_VLAN_CONFIG_SET Set;\r
- EFI_VLAN_CONFIG_FIND Find;\r
- EFI_VLAN_CONFIG_REMOVE Remove;\r
+ EFI_VLAN_CONFIG_SET Set;\r
+ EFI_VLAN_CONFIG_FIND Find;\r
+ EFI_VLAN_CONFIG_REMOVE Remove;\r
};\r
\r
-extern EFI_GUID gEfiVlanConfigProtocolGuid;\r
+extern EFI_GUID gEfiVlanConfigProtocolGuid;\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff