IEEE 802.3 LLDP extension. More...
Go to the source code of this file.
Functions | |
error_t | lldpDot3SetLocalMacPhyConfigStatus (LldpAgentContext *context, uint_t portIndex, uint8_t autoNegSupportStatus, uint16_t pmdAutoNegAdvCap, uint16_t operationalMauType) |
Set MAC/PHY configuration/status. More... | |
error_t | lldpDot3SetLocalPowerViaMdi (LldpAgentContext *context, uint_t portIndex, uint8_t mdiPowerSupport, LldpDot3PsePowerPair psePowerPair, LldpDot3PowerClass powerClass, const LldpDot3DllClassExt *dllClassExt, const LldpDot3Type34Ext *type34Ext) |
Set power-via-MDI. More... | |
error_t | lldpDot3SetLocalLinkAggregation (LldpAgentContext *context, uint_t portIndex, uint8_t aggregationStatus, uint32_t aggregatedPortId) |
Set Link aggregation. More... | |
error_t | lldpDot3SetLocalMaxFrameSize (LldpAgentContext *context, uint_t portIndex, uint16_t maxFrameSize) |
Set maximum frame size. More... | |
error_t | lldpDot3SetLocalPowerViaMdiMeas (LldpAgentContext *context, uint_t portIndex, uint8_t measurements[20], uint16_t psePowerPriceIndex) |
Set power-via-MDI measurements. More... | |
error_t | lldpDot3DeleteLocalTlv (LldpAgentContext *context, LldpDot3Subtype subtype) |
Remove all IEEE 802.3 specific TLVs with specified subtype. More... | |
Variables | |
typedef | __packed_struct |
MAC/PHY Configuration/Status TLV. More... | |
uint16_t | pmdAutoNegAdvCap |
uint16_t | operationalMauType |
LldpDot3MacPhyConfigStatusTlv | |
uint8_t | psePowerPair |
uint8_t | powerClass |
LldpDot3PowerViaMdiTlv | |
uint32_t | aggregatedPortId |
LldpDot3LinkAggregationTlv | |
LldpDot3MaxFrameSizeTlv | |
uint16_t | psePowerPriceIndex |
LldpDot3PowerViaMdiMeasTlv | |
uint8_t | pd4pid |
uint8_t | reserved |
uint8_t | powerSource |
uint8_t | powerType |
uint16_t | pdRequestedPower |
uint16_t | pseAllocatedPower |
LldpDot3DllClassExt | |
uint16_t | pdRequestedPowerB |
uint16_t | pseAllocatedPowerA |
uint16_t | pseAllocatedPowerB |
uint16_t | powerStatus |
uint8_t | systemSetup |
uint16_t | pseMaxAvailablePower |
uint8_t | autoclass |
uint8_t | powerDown [3] |
LldpDot3Type34Ext | |
Detailed Description
IEEE 802.3 LLDP extension.
License
SPDX-License-Identifier: GPL-2.0-or-later
Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
This file is part of CycloneTCP Open.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- Version
- 2.4.4
Definition in file lldp_ext_dot3.h.
Enumeration Type Documentation
◆ LldpDot3AnFlags
enum LldpDot3AnFlags |
Auto-negotiation support/status flags.
Enumerator | |
---|---|
LLDP_DOT3_AN_FLAG_SUPPORT | Auto-negotiation support. |
LLDP_DOT3_AN_FLAG_STATUS | Auto-negotiation status. |
Definition at line 63 of file lldp_ext_dot3.h.
◆ LldpDot3Autoclass
enum LldpDot3Autoclass |
Autoclass field.
Enumerator | |
---|---|
LLDP_DOT3_AUTOCLASS_REQUEST | |
LLDP_DOT3_AUTOCLASS_COMPLETED | |
LLDP_DOT3_AUTOCLASS_PSE_SUPPORT | |
LLDP_DOT3_AUTOCLASS_RESERVED |
Definition at line 272 of file lldp_ext_dot3.h.
◆ LldpDot3LinkAggregationFlag
Link aggregation capability/status flags.
Enumerator | |
---|---|
LLDP_DOT3_LINK_AGGREGATION_FLAG_CAP | Aggregation capability. |
LLDP_DOT3_LINK_AGGREGATION_FLAG_STATUS | Aggregation status. |
Definition at line 296 of file lldp_ext_dot3.h.
◆ LldpDot3MauType
enum LldpDot3MauType |
Operational MAU types.
Definition at line 99 of file lldp_ext_dot3.h.
◆ LldpDot3MdiPowerFlags
MDI power capability/status flags.
Definition at line 122 of file lldp_ext_dot3.h.
◆ LldpDot3PmdAnAdvCapability
PMD auto-negotiation advertised capability.
Definition at line 74 of file lldp_ext_dot3.h.
◆ LldpDot3PowerClass
enum LldpDot3PowerClass |
power class
Enumerator | |
---|---|
LLDP_DOT3_POWER_CLASS_0 | Class 0 PD. |
LLDP_DOT3_POWER_CLASS_1 | Class 1 PD. |
LLDP_DOT3_POWER_CLASS_2 | Class 2 PD. |
LLDP_DOT3_POWER_CLASS_3 | Class 3 PD. |
LLDP_DOT3_POWER_CLASS_4 | Class 4 and above PD. |
Definition at line 150 of file lldp_ext_dot3.h.
◆ LldpDot3PowerDown
enum LldpDot3PowerDown |
Power down field.
Enumerator | |
---|---|
LLDP_DOT3_POWER_DOWN_REQUEST | |
LLDP_DOT3_POWER_DOWN_TIME |
Definition at line 285 of file lldp_ext_dot3.h.
◆ LldpDot3PowerPriority
Power priority.
Enumerator | |
---|---|
LLDP_DOT3_POWER_PRIORITY_UNKNOWN | Unknown. |
LLDP_DOT3_POWER_PRIORITY_CRITICAL | Critical. |
LLDP_DOT3_POWER_PRIORITY_HIGH | High. |
LLDP_DOT3_POWER_PRIORITY_LOW | Low. |
Definition at line 194 of file lldp_ext_dot3.h.
◆ LldpDot3PowerSource
enum LldpDot3PowerSource |
power source
Definition at line 177 of file lldp_ext_dot3.h.
◆ LldpDot3PowerStatus
enum LldpDot3PowerStatus |
Power status.
Definition at line 207 of file lldp_ext_dot3.h.
◆ LldpDot3PowerType
enum LldpDot3PowerType |
power type
Enumerator | |
---|---|
LLDP_DOT3_POWER_TYPE_2_PSE | Type 2 PSE. |
LLDP_DOT3_POWER_TYPE_2_PD | Type 2 PD. |
LLDP_DOT3_POWER_TYPE_1_PSE | Type 1 PSE. |
LLDP_DOT3_POWER_TYPE_1_PD | Type 1 PD. |
Definition at line 164 of file lldp_ext_dot3.h.
◆ LldpDot3PsePowerPair
enum LldpDot3PsePowerPair |
PSE power pair.
Enumerator | |
---|---|
LLDP_DOT3_PSE_POWER_PAIR_SIGNAL | Signal. |
LLDP_DOT3_PSE_POWER_PAIR_SPARE | Spare. |
LLDP_DOT3_PSE_POWER_PAIR_ALT_A | Alternative A. |
LLDP_DOT3_PSE_POWER_PAIR_ALT_B | Alternative B. |
Definition at line 137 of file lldp_ext_dot3.h.
◆ LldpDot3Subtype
enum LldpDot3Subtype |
IEEE 802.3 subtypes.
Definition at line 48 of file lldp_ext_dot3.h.
◆ LldpDot3SystemSetup
enum LldpDot3SystemSetup |
System setup.
Definition at line 254 of file lldp_ext_dot3.h.
Function Documentation
◆ lldpDot3DeleteLocalTlv()
error_t lldpDot3DeleteLocalTlv | ( | LldpAgentContext * | context, |
LldpDot3Subtype | subtype | ||
) |
Remove all IEEE 802.3 specific TLVs with specified subtype.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] subtype TLV subtype
- Returns
- Error code
Definition at line 442 of file lldp_ext_dot3.c.
◆ lldpDot3SetLocalLinkAggregation()
error_t lldpDot3SetLocalLinkAggregation | ( | LldpAgentContext * | context, |
uint_t | portIndex, | ||
uint8_t | aggregationStatus, | ||
uint32_t | aggregatedPortId | ||
) |
Set Link aggregation.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] portIndex Port index [in] aggregationStatus Bit-map of the link aggregation capabilities and the current aggregation status of the link [in] aggregatedPortId IEEE 802.3 aggregated port identifier,
- Returns
- Error code
Definition at line 244 of file lldp_ext_dot3.c.
◆ lldpDot3SetLocalMacPhyConfigStatus()
error_t lldpDot3SetLocalMacPhyConfigStatus | ( | LldpAgentContext * | context, |
uint_t | portIndex, | ||
uint8_t | autoNegSupportStatus, | ||
uint16_t | pmdAutoNegAdvCap, | ||
uint16_t | operationalMauType | ||
) |
Set MAC/PHY configuration/status.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] portIndex Port index [in] autoNegSupportStatus Bit-map that identifies the auto-negotiation support and current status of the local 802.3 LAN station [in] pmdAutoNegAdvCap PMD auto-negotiation advertised capability [in] operationalMauType MAU type of the sending device
- Returns
- Error code
Definition at line 57 of file lldp_ext_dot3.c.
◆ lldpDot3SetLocalMaxFrameSize()
error_t lldpDot3SetLocalMaxFrameSize | ( | LldpAgentContext * | context, |
uint_t | portIndex, | ||
uint16_t | maxFrameSize | ||
) |
Set maximum frame size.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] portIndex Port index [in] maxFrameSize Maximum supported frame size, in octets
- Returns
- Error code
Definition at line 310 of file lldp_ext_dot3.c.
◆ lldpDot3SetLocalPowerViaMdi()
error_t lldpDot3SetLocalPowerViaMdi | ( | LldpAgentContext * | context, |
uint_t | portIndex, | ||
uint8_t | mdiPowerSupport, | ||
LldpDot3PsePowerPair | psePowerPair, | ||
LldpDot3PowerClass | powerClass, | ||
const LldpDot3DllClassExt * | dllClassExt, | ||
const LldpDot3Type34Ext * | type34Ext | ||
) |
Set power-via-MDI.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] portIndex Port index [in] mdiPowerSupport Bit-map of the MDI power capabilities and status [in] psePowerPair PSE power pair [in] powerClass PSE power classification [in] dllClassExt DLL classification extension (optional parameter) [in] type34Ext Type 3 and Type 4 extension (optional parameter)
- Returns
- Error code
Definition at line 130 of file lldp_ext_dot3.c.
◆ lldpDot3SetLocalPowerViaMdiMeas()
error_t lldpDot3SetLocalPowerViaMdiMeas | ( | LldpAgentContext * | context, |
uint_t | portIndex, | ||
uint8_t | measurements[20], | ||
uint16_t | psePowerPriceIndex | ||
) |
Set power-via-MDI measurements.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] portIndex Port index [in] measurements Measured values [in] psePowerPriceIndex Index of the current price of electricity compared to what the PSE considers the nominal electricity price
- Returns
- Error code
Definition at line 376 of file lldp_ext_dot3.c.
Variable Documentation
◆ __packed_struct
typedef __packed_struct |
MAC/PHY Configuration/Status TLV.
Type 3 and Type 4 extension.
DLL Classification extension.
Power Via MDI Measurements TLV.
Maximum Frame Size TLV.
Link Aggregation TLV.
Power Via MDI TLV.
Definition at line 315 of file lldp_ext_dot3.h.
◆ aggregatedPortId
uint32_t aggregatedPortId |
Definition at line 342 of file lldp_ext_dot3.h.
◆ autoclass
uint8_t autoclass |
Definition at line 404 of file lldp_ext_dot3.h.
◆ LldpDot3DllClassExt
LldpDot3DllClassExt |
Definition at line 388 of file lldp_ext_dot3.h.
◆ LldpDot3LinkAggregationTlv
LldpDot3LinkAggregationTlv |
Definition at line 343 of file lldp_ext_dot3.h.
◆ LldpDot3MacPhyConfigStatusTlv
LldpDot3MacPhyConfigStatusTlv |
Definition at line 320 of file lldp_ext_dot3.h.
◆ LldpDot3MaxFrameSizeTlv
LldpDot3MaxFrameSizeTlv |
Definition at line 353 of file lldp_ext_dot3.h.
◆ LldpDot3PowerViaMdiMeasTlv
LldpDot3PowerViaMdiMeasTlv |
Definition at line 364 of file lldp_ext_dot3.h.
◆ LldpDot3PowerViaMdiTlv
LldpDot3PowerViaMdiTlv |
Definition at line 332 of file lldp_ext_dot3.h.
◆ LldpDot3Type34Ext
LldpDot3Type34Ext |
Definition at line 406 of file lldp_ext_dot3.h.
◆ operationalMauType
uint16_t operationalMauType |
Definition at line 319 of file lldp_ext_dot3.h.
◆ pd4pid
uint8_t pd4pid |
Definition at line 381 of file lldp_ext_dot3.h.
◆ pdRequestedPower
uint16_t pdRequestedPower |
Definition at line 386 of file lldp_ext_dot3.h.
◆ pdRequestedPowerB
uint16_t pdRequestedPowerB |
Definition at line 398 of file lldp_ext_dot3.h.
◆ pmdAutoNegAdvCap
uint16_t pmdAutoNegAdvCap |
Definition at line 318 of file lldp_ext_dot3.h.
◆ powerClass
uint8_t powerClass |
Definition at line 331 of file lldp_ext_dot3.h.
◆ powerDown
uint8_t powerDown[3] |
Definition at line 405 of file lldp_ext_dot3.h.
◆ powerSource
uint8_t powerSource |
Definition at line 383 of file lldp_ext_dot3.h.
◆ powerStatus
uint16_t powerStatus |
Definition at line 401 of file lldp_ext_dot3.h.
◆ powerType
uint8_t powerType |
Definition at line 384 of file lldp_ext_dot3.h.
◆ pseAllocatedPower
uint16_t pseAllocatedPower |
Definition at line 387 of file lldp_ext_dot3.h.
◆ pseAllocatedPowerA
uint16_t pseAllocatedPowerA |
Definition at line 399 of file lldp_ext_dot3.h.
◆ pseAllocatedPowerB
uint16_t pseAllocatedPowerB |
Definition at line 400 of file lldp_ext_dot3.h.
◆ pseMaxAvailablePower
uint16_t pseMaxAvailablePower |
Definition at line 403 of file lldp_ext_dot3.h.
◆ psePowerPair
uint8_t psePowerPair |
Definition at line 330 of file lldp_ext_dot3.h.
◆ psePowerPriceIndex
uint16_t psePowerPriceIndex |
Definition at line 363 of file lldp_ext_dot3.h.
◆ reserved
uint8_t reserved |
Definition at line 382 of file lldp_ext_dot3.h.
◆ systemSetup
uint8_t systemSetup |
Definition at line 402 of file lldp_ext_dot3.h.