LLDP-MED extension (LLDP for Media Endpoint Devices) More...
#include "core/net.h"#include "lldp/lldp.h"#include "lldp/lldp_ext_med.h"#include "lldp/lldp_misc.h"#include "lldp/lldp_debug.h"#include "debug.h"Go to the source code of this file.
Macros | |
| #define | TRACE_LEVEL LLDP_TRACE_LEVEL |
Detailed Description
LLDP-MED extension (LLDP for Media Endpoint Devices)
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.0
Definition in file lldp_ext_med.c.
Macro Definition Documentation
◆ TRACE_LEVEL
| #define TRACE_LEVEL LLDP_TRACE_LEVEL |
Definition at line 32 of file lldp_ext_med.c.
Function Documentation
◆ lldpMedDeleteLocalTlv()
| error_t lldpMedDeleteLocalTlv | ( | LldpAgentContext * | context, |
| LldpMedSubtype | subtype | ||
| ) |
Remove all LLDP-MED specific TLVs with specified subtype.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] subtype TLV subtype
- Returns
- Error code
Definition at line 838 of file lldp_ext_med.c.
◆ lldpMedSetLocalAssetId()
| error_t lldpMedSetLocalAssetId | ( | LldpAgentContext * | context, |
| const char_t * | assetId | ||
| ) |
Set asset identifier.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] assetId Alphanumerical string that contains the asset identifier of the endpoint
- Returns
- Error code
Definition at line 786 of file lldp_ext_med.c.
◆ lldpMedSetLocalCap()
| error_t lldpMedSetLocalCap | ( | LldpAgentContext * | context, |
| uint16_t | capabilities, | ||
| LldpMedDeviceType | deviceType | ||
| ) |
Set LLDP-MED capabilities.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] capabilities Bit-map of the supported set of capabilities [in] deviceType LLDP-MED device type
- Returns
- Error code
Definition at line 54 of file lldp_ext_med.c.
◆ lldpMedSetLocalExtPowerViaMdi()
| error_t lldpMedSetLocalExtPowerViaMdi | ( | LldpAgentContext * | context, |
| uint_t | portIndex, | ||
| LldpMedPowerType | powerType, | ||
| LldpMedPowerSource | powerSource, | ||
| LldpMedPowerPriority | powerPriority, | ||
| uint16_t | powerValue | ||
| ) |
Set extended power-via-MDI.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] portIndex Port index [in] powerType Binary value that represents whether LLDP-MED device is a Power Sourcing Entity (PSE) or Power Device (PD) [in] powerSource Binary value that represents the power source being utilized by a PSE or PD device [in] powerPriority Binary value that represents the priority of the PD type device to the power being supplied by the PSE type device, or the power priority associated with the PSE type device's port that is sourcing the power via MDI [in] powerValue Numerical value that indicates the total power in watts required by a PD device from a PSE device, or the total power a PSE device is capable of sourcing over a maximum length cable based on its current configuration
- Returns
- Error code
Definition at line 393 of file lldp_ext_med.c.
◆ lldpMedSetLocalFirmwareRevision()
| error_t lldpMedSetLocalFirmwareRevision | ( | LldpAgentContext * | context, |
| const char_t * | firmwareRevision | ||
| ) |
Set firmware revision.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] firmwareRevision Alphanumerical string that contains the firmware revision of the endpoint
- Returns
- Error code
Definition at line 518 of file lldp_ext_med.c.
◆ lldpMedSetLocalHardwareRevision()
| error_t lldpMedSetLocalHardwareRevision | ( | LldpAgentContext * | context, |
| const char_t * | hardwareRevision | ||
| ) |
Set hardware revision.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] hardwareRevision Alphanumerical string that contains the hardware revision of the endpoint
- Returns
- Error code
Definition at line 464 of file lldp_ext_med.c.
◆ lldpMedSetLocalLocationId()
| error_t lldpMedSetLocalLocationId | ( | LldpAgentContext * | context, |
| uint_t | portIndex, | ||
| LldpMedLocationDataFormat | locationDataFormat, | ||
| const void * | locationId, | ||
| size_t | locationIdLen | ||
| ) |
Set location identification.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] portIndex Port index [in] locationDataFormat Location ID data format [in] locationId Location ID [in] locationIdLen Length of the location ID, in bytes
- Returns
- Error code
Definition at line 243 of file lldp_ext_med.c.
◆ lldpMedSetLocalManufacturerName()
| error_t lldpMedSetLocalManufacturerName | ( | LldpAgentContext * | context, |
| const char_t * | manufacturerName | ||
| ) |
Set manufacturer name.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] manufacturerName Alphanumerical string that contains the manufacturer name of the endpoint
- Returns
- Error code
Definition at line 679 of file lldp_ext_med.c.
◆ lldpMedSetLocalModelName()
| error_t lldpMedSetLocalModelName | ( | LldpAgentContext * | context, |
| const char_t * | modelName | ||
| ) |
Set model name.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] modelName Alphanumerical string that contains the model name of the endpoint
- Returns
- Error code
Definition at line 733 of file lldp_ext_med.c.
◆ lldpMedSetLocalNetworkPolicy()
| error_t lldpMedSetLocalNetworkPolicy | ( | LldpAgentContext * | context, |
| uint_t | portIndex, | ||
| LldpMedAppType | appType, | ||
| bool_t | u, | ||
| bool_t | t, | ||
| uint16_t | vlanId, | ||
| uint8_t | l2Priority, | ||
| uint8_t | dscpValue | ||
| ) |
Set network policy.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] portIndex Port index [in] appType Primary function of the application [in] u Unknown policy flag (U) [in] t Tagged flag (T) [in] vlanId VLAN identifier for the port [in] l2Priority Layer 2 priority to be used [in] dscpValue DSCP value to be used
- Returns
- Error code
Definition at line 116 of file lldp_ext_med.c.
◆ lldpMedSetLocalSerialNumber()
| error_t lldpMedSetLocalSerialNumber | ( | LldpAgentContext * | context, |
| const char_t * | serialNumber | ||
| ) |
Set serial number.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] serialNumber Alphanumerical string that contains the serial number of the endpoint
- Returns
- Error code
Definition at line 626 of file lldp_ext_med.c.
◆ lldpMedSetLocalSoftwareRevision()
| error_t lldpMedSetLocalSoftwareRevision | ( | LldpAgentContext * | context, |
| const char_t * | softwareRevision | ||
| ) |
Set software revision.
- Parameters
-
[in] context Pointer to the LLDP agent context [in] softwareRevision Alphanumerical string that contains the software revision of the endpoint
- Returns
- Error code
Definition at line 572 of file lldp_ext_med.c.