lldp_ext_dot1.h File Reference

IEEE 802.1 LLDP extension. More...

#include "core/net.h"
#include "lldp/lldp.h"

Go to the source code of this file.

Macros

#define LLDP_DOT1_MIN_VLAN_NAME_LEN   1
 
#define LLDP_DOT1_MAX_VLAN_NAME_LEN   31
 
#define LLDP_DOT1_MIN_PROTOCOL_ID_LEN   1
 
#define LLDP_DOT1_MAX_PROTOCOL_ID_LEN   255
 

Typedefs

struct {
   char_t   type
 
   uint32_t   dataStart
 
   uint32_t   dataLength
 
   uint8_t   nameLength
 
   char_t   name []
 
   uint8_t   tokenLen: 4
 
   uint8_t   type: 2
 
   uint8_t   version: 2
 
   uint8_t   code
 
   uint16_t   mid
 
   uint8_t   token []
 
   union {
      uint8_t   b [6]
 
      uint16_t   w [3]
 
   } 
 
   uint16_t   srcPort
 
   uint16_t   destPort
 
   uint32_t   seqNum
 
   uint32_t   ackNum
 
   uint8_t   reserved1: 4
 
   uint8_t   dataOffset: 4
 
   uint8_t   flags: 6
 
   uint8_t   reserved2: 2
 
   uint16_t   window
 
   uint16_t   checksum
 
   uint16_t   urgentPointer
 
   uint8_t   options []
 
   uint16_t   length
 
   uint8_t   data []
 
   uint8_t   op
 
   uint8_t   htype
 
   uint8_t   hlen
 
   uint8_t   hops
 
   uint32_t   xid
 
   uint16_t   secs
 
   uint16_t   flags
 
   Ipv4Addr   ciaddr
 
   Ipv4Addr   yiaddr
 
   Ipv4Addr   siaddr
 
   Ipv4Addr   giaddr
 
   MacAddr   chaddr
 
   uint8_t   unused [10]
 
   uint8_t   sname [64]
 
   uint8_t   file [128]
 
   uint32_t   magicCookie
 
   uint16_t   type
 
   uint16_t   hardwareType
 
   uint32_t   time
 
   MacAddr   linkLayerAddr
 
   uint16_t   id
 
   uint8_t   rd: 1
 
   uint8_t   tc: 1
 
   uint8_t   aa: 1
 
   uint8_t   opcode: 4
 
   uint8_t   qr: 1
 
   uint8_t   rcode: 4
 
   uint8_t   z: 3
 
   uint8_t   ra: 1
 
   uint16_t   qdcount
 
   uint16_t   ancount
 
   uint16_t   nscount
 
   uint16_t   arcount
 
   uint8_t   questions []
 
   uint16_t   controlWord
 
   uint16_t   byteCount
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   bcdUsb
 
   uint8_t   bDeviceClass
 
   uint8_t   bDeviceSubClass
 
   uint8_t   bDeviceProtocol
 
   uint8_t   bMaxPacketSize0
 
   uint16_t   idVendor
 
   uint16_t   idProduct
 
   uint16_t   bcdDevice
 
   uint8_t   iManufacturer
 
   uint8_t   iProduct
 
   uint8_t   iSerialNumber
 
   uint8_t   bNumConfigurations
 
   uint8_t   maxRespTime
 
   Ipv4Addr   groupAddr
 
   uint16_t   hrd
 
   uint16_t   pro
 
   uint8_t   hln
 
   uint8_t   pln
 
   uint16_t   op
 
   MacAddr   sha
 
   Ipv4Addr   spa
 
   MacAddr   tha
 
   Ipv4Addr   tpa
 
   uint8_t   length
 
   uint8_t   value []
 
   uint16_t   first
 
   uint16_t   last
 
   uint16_t   next
 
   union {
      uint8_t   b [16]
 
      uint16_t   w [8]
 
      uint32_t   dw [4]
 
   } 
 
   uint16_t   maxRespDelay
 
   uint16_t   reserved
 
   Ipv6Addr   multicastAddr
 
   uint32_t   reserved
 
   uint16_t   pvid
 
   uint8_t   autoNegSupportStatus
 
   uint16_t   pmdAutoNegAdvCap
 
   uint16_t   operationalMauType
 
   uint16_t   capabilities
 
   uint8_t   deviceType
 
   uint8_t   lengthH: 1
 
   uint8_t   lengthL
 
   uint8_t   t: 1
 
   uint8_t   c: 1
 
   union {
      int32_t   integer
 
      uint8_t   octetString [1]
 
      uint8_t   oid [1]
 
      uint8_t   ipAddr [4]
 
      uint32_t   counter32
 
      uint32_t   gauge32
 
      uint32_t   unsigned32
 
      uint32_t   timeTicks
 
      uint64_t   counter64
 
   } 
 
   uint16_t   transactionId
 
   uint16_t   protocolId
 
   uint8_t   unitId
 
   uint8_t   pdu []
 
   uint8_t   retain: 1
 
   uint8_t   qos: 2
 
   uint8_t   dup: 1
 
   union {
      uint8_t   all
 
      struct {
         uint8_t   topicIdType: 2
 
         uint8_t   cleanSession: 1
 
         uint8_t   will: 1
 
         uint8_t   retain: 1
 
         uint8_t   qos: 2
 
         uint8_t   dup: 1
 
      } 
 
   } 
 
   uint8_t   b: 1
 
   uint8_t   identifier
 
   uint8_t   valueSize
 
   Ipv4Addr   srcIpAddr
 
   Ipv4Addr   destIpAddr
 
   Eui64   interfaceId
 
   uint16_t   mru
 
   uint8_t   peerIdLength
 
   uint8_t   peerId []
 
   uint32_t   seconds
 
   uint32_t   fraction
 
   uint16_t   opcode
 
   char_t   filename []
 
   uint8_t   reserved: 3
 
   uint8_t   fin: 1
 
   uint8_t   payloadLen: 7
 
   uint8_t   mask: 1
 
   uint8_t   extPayloadLen []
 
   uint32_t   length
 
   uint8_t   payload []
 
   uint32_t   packetLen
 
   uint8_t   paddingLen
 
   uint8_t   protocolVersionId
 
   uint8_t   bpduType
 
   StpBridgeId   rootId
 
   uint32_t   rootPathCost
 
   StpBridgeId   bridgeId
 
   uint16_t   portId
 
   uint16_t   messageAge
 
   uint16_t   maxAge
 
   uint16_t   helloTime
 
   uint16_t   forwardDelay
 
   uint8_t   version1Length
 
   uint16_t   priority
 
   MacAddr   addr
 
LldpDot1PortVlanIdTlv
 Port VLAN ID TLV. More...
 
struct {
   char_t   type
 
   uint32_t   dataStart
 
   uint32_t   dataLength
 
   uint8_t   nameLength
 
   uint8_t   length: 4
 
   uint8_t   delta: 4
 
   union {
      uint8_t   b [8]
 
      uint16_t   w [4]
 
      uint32_t   dw [2]
 
   } 
 
   uint8_t   kind
 
   uint8_t   value []
 
   uint8_t   code
 
   uint16_t   type
 
   uint32_t   enterpriseNumber
 
   uint8_t   identifier []
 
   uint16_t   qtype
 
   uint16_t   qclass
 
   uint16_t   statusWord
 
   uint16_t   byteCount
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   wTotalLength
 
   uint8_t   bNumInterfaces
 
   uint8_t   bConfigurationValue
 
   uint8_t   iConfiguration
 
   uint8_t   bmAttributes
 
   uint8_t   bMaxPower
 
   uint8_t   type
 
   uint16_t   checksum
 
   uint8_t   parameter
 
   uint8_t   unused [3]
 
   uint8_t   data []
 
   uint32_t   parameter
 
   uint8_t   nextHeader
 
   uint8_t   hdrExtLen
 
   uint8_t   options []
 
   uint8_t   curHopLimit
 
   uint8_t   reserved: 2
 
   uint8_t   p: 1
 
   uint8_t   prf: 2
 
   uint8_t   h: 1
 
   uint8_t   o: 1
 
   uint8_t   m: 1
 
   uint16_t   routerLifetime
 
   uint32_t   reachableTime
 
   uint32_t   retransTimer
 
   uint8_t   flags
 
   uint16_t   ppvid
 
   uint8_t   mdiPowerSupport
 
   uint8_t   psePowerPair
 
   uint8_t   powerClass
 
   uint8_t   appType
 
   uint8_t   vlanIdH: 5
 
   uint8_t   x: 1
 
   uint8_t   t: 1
 
   uint8_t   u: 1
 
   uint8_t   l2PriorityH: 1
 
   uint8_t   vlanIdL: 7
 
   uint8_t   dscpValue: 6
 
   uint8_t   l2PriorityL: 2
 
   uint8_t   chassisIdSubtype
 
   uint8_t   chassisId []
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfCoils
 
   uint16_t   length
 
   uint8_t   msgType
 
   uint16_t   flags
 
   Ipv4Addr   addr
 
   uint8_t   valueSize
 
   uint16_t   protocol
 
   uint32_t   accm
 
   uint8_t   msgLength
 
   uint8_t   message []
 
   uint8_t   mode: 3
 
   uint8_t   vn: 3
 
   uint8_t   li: 2
 
   uint8_t   stratum
 
   uint8_t   poll
 
   int8_t   precision
 
   uint32_t   rootDelay
 
   uint32_t   rootDispersion
 
   uint32_t   referenceId
 
   NtpTimestamp   referenceTimestamp
 
   NtpTimestamp   originateTimestamp
 
   NtpTimestamp   receiveTimestamp
 
   NtpTimestamp   transmitTimestamp
 
   uint16_t   opcode
 
   char_t   filename []
 
   uint16_t   value []
 
   uint16_t   group
 
   uint8_t   keyExchange []
 
   uint32_t   id
 
   uint32_t   dataLen
 
LldpDot1PortProtoVlanIdTlv
 Port And Protocol VLAN ID TLV. More...
 
struct {
   uint32_t   totalSize
 
   ResRootEntry   rootEntry
 
   MacAddr   destAddr
 
   MacAddr   srcAddr
 
   uint16_t   type
 
   uint8_t   data []
 
   uint16_t   hardwareType
 
   MacAddr   linkLayerAddr
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint8_t   rdata []
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bInterfaceNumber
 
   uint8_t   bAlternateSetting
 
   uint8_t   bNumEndpoints
 
   uint8_t   bInterfaceClass
 
   uint8_t   bInterfaceSubClass
 
   uint8_t   bInterfaceProtocol
 
   uint8_t   iInterface
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint32_t   unused
 
   uint8_t   nextHeader
 
   uint8_t   hdrExtLen
 
   uint8_t   options []
 
   uint32_t   reserved
 
   Ipv6Addr   targetAddr
 
   uint16_t   vlanId
 
   uint8_t   vlanNameLen
 
   char_t   vlanName []
 
   uint8_t   aggregationStatus
 
   uint32_t   aggregatedPortId
 
   uint8_t   locationDataFormat
 
   uint8_t   locationId []
 
   uint8_t   portIdSubtype
 
   uint8_t   portId []
 
   uint8_t   functionCode
 
   uint8_t   byteCount
 
   uint8_t   coilStatus []
 
   uint8_t   prefix
 
   uint16_t   length
 
   uint8_t   msgType
 
   uint8_t   identifier
 
   uint8_t   message []
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
   uint16_t   protocol
 
   uint8_t   msgLength
 
   uint8_t   rejectedPacket []
 
   uint32_t   keyId
 
   uint8_t   messageDigest [16]
 
   uint16_t   opcode
 
   uint16_t   block
 
   uint16_t   value []
 
   uint8_t   value []
 
LldpDot1VlanNameTlv
 VLAN Name TLV. More...
 
struct {
   uint8_t   dsap
 
   uint8_t   ssap
 
   uint8_t   control
 
   uint8_t   msgType
 
   uint8_t   transactionId [3]
 
   uint8_t   options []
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint8_t   rdata [4]
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bEndpointAddress
 
   uint8_t   bmAttributes
 
   uint16_t   wMaxPacketSize
 
   uint8_t   bInterval
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint32_t   unused
 
   uint8_t   data []
 
   uint32_t   mtu
 
   uint8_t   nextHeader
 
   uint8_t   hdrExtLen
 
   uint8_t   routingType
 
   uint8_t   segmentsLeft
 
   uint32_t   reserved
 
   Ipv6Addr   address []
 
   uint8_t   reserved1: 5
 
   uint8_t   o: 1
 
   uint8_t   s: 1
 
   uint8_t   r: 1
 
   uint8_t   reserved2 [3]
 
   Ipv6Addr   targetAddr
 
   uint8_t   protocolIdLen
 
   uint8_t   protocolId []
 
   uint16_t   maxFrameSize
 
   uint8_t   powerPriority: 4
 
   uint8_t   powerSource: 2
 
   uint8_t   powerType: 2
 
   uint16_t   powerValue
 
   uint16_t   ttl
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfInputs
 
   uint8_t   gwId
 
   uint16_t   duration
 
   uint8_t   identifier
 
   uint16_t   length
 
   uint8_t   message []
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
   uint16_t   protocol
 
   uint16_t   rejectedProtocol
 
   uint8_t   rejectedInfo []
 
   uint16_t   opcode
 
   uint16_t   block
 
   uint16_t   version
 
   uint16_t   epoch
 
   DtlsSequenceNumber   seqNum
 
   uint8_t   hash
 
   uint8_t   signature
 
   uint8_t   value []
 
LldpDot1ProtocolIdTlv
 Protocol Identity TLV. More...
 

Enumerations

enum  LldpDot1Subtype {
  LLDP_DOT1_SUBTYPE_RESERVED = 0, LLDP_DOT1_SUBTYPE_PORT_VLAN_ID = 1, LLDP_DOT1_SUBTYPE_PORT_PROTO_VLAN_ID = 2, LLDP_DOT1_SUBTYPE_VLAN_NAME = 3,
  LLDP_DOT1_SUBTYPE_PROTOCOL_ID = 4
}
 IEEE 802.1 subtypes. More...
 
enum  LldpDot1PortProtoFlags { LLDP_DOT1_PORT_PROTO_FLAG_RESERVED = 0x01, LLDP_DOT1_PORT_PROTO_FLAG_SUPPORTED = 0x02, LLDP_DOT1_PORT_PROTO_FLAG_ENABLED = 0x04 }
 Port and protocol capability/status flags. More...
 

Functions

error_t lldpDot1SetLocalPortVlanId (LldpAgentContext *context, uint_t portIndex, uint16_t pvid)
 Set port VLAN ID. More...
 
error_t lldpDot1SetLocalPortProtoVlanId (LldpAgentContext *context, uint_t portIndex, uint8_t flags, uint16_t ppvid)
 Set port and protocol VLAN ID. More...
 
error_t lldpDot1SetLocalVlanName (LldpAgentContext *context, uint_t portIndex, uint16_t vlanId, const char_t *vlanName)
 Set VLAN name. More...
 
error_t lldpDot1SetLocalProtocolId (LldpAgentContext *context, uint_t portIndex, const uint8_t *protocolId, size_t protocolIdLen)
 Set protocol identity. More...
 
error_t lldpDot1DeleteLocalTlv (LldpAgentContext *context, LldpDot1Subtype subtype)
 Remove all IEEE 802.1 specific TLVs with specified subtype. More...
 

Detailed Description

IEEE 802.1 LLDP extension.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2022 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.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.1.6

Definition in file lldp_ext_dot1.h.

Macro Definition Documentation

◆ LLDP_DOT1_MAX_PROTOCOL_ID_LEN

#define LLDP_DOT1_MAX_PROTOCOL_ID_LEN   255

Definition at line 46 of file lldp_ext_dot1.h.

◆ LLDP_DOT1_MAX_VLAN_NAME_LEN

#define LLDP_DOT1_MAX_VLAN_NAME_LEN   31

Definition at line 41 of file lldp_ext_dot1.h.

◆ LLDP_DOT1_MIN_PROTOCOL_ID_LEN

#define LLDP_DOT1_MIN_PROTOCOL_ID_LEN   1

Definition at line 44 of file lldp_ext_dot1.h.

◆ LLDP_DOT1_MIN_VLAN_NAME_LEN

#define LLDP_DOT1_MIN_VLAN_NAME_LEN   1

Definition at line 39 of file lldp_ext_dot1.h.

Typedef Documentation

◆ LldpDot1PortProtoVlanIdTlv

typedef { ... } LldpDot1PortProtoVlanIdTlv

Port And Protocol VLAN ID TLV.

◆ LldpDot1PortVlanIdTlv

typedef { ... } LldpDot1PortVlanIdTlv

Port VLAN ID TLV.

◆ LldpDot1ProtocolIdTlv

typedef { ... } LldpDot1ProtocolIdTlv

Protocol Identity TLV.

◆ LldpDot1VlanNameTlv

typedef { ... } LldpDot1VlanNameTlv

VLAN Name TLV.

Enumeration Type Documentation

◆ LldpDot1PortProtoFlags

Port and protocol capability/status flags.

Enumerator
LLDP_DOT1_PORT_PROTO_FLAG_RESERVED 

Reserved.

LLDP_DOT1_PORT_PROTO_FLAG_SUPPORTED 

Port and protocol VLAN supported.

LLDP_DOT1_PORT_PROTO_FLAG_ENABLED 

Port and protocol VLAN enabled.

Definition at line 72 of file lldp_ext_dot1.h.

◆ LldpDot1Subtype

IEEE 802.1 subtypes.

Enumerator
LLDP_DOT1_SUBTYPE_RESERVED 

Reserved.

LLDP_DOT1_SUBTYPE_PORT_VLAN_ID 

Port VLAN ID.

LLDP_DOT1_SUBTYPE_PORT_PROTO_VLAN_ID 

Port And Protocol VLAN ID.

LLDP_DOT1_SUBTYPE_VLAN_NAME 

VLAN Name.

LLDP_DOT1_SUBTYPE_PROTOCOL_ID 

Protocol Identity.

Definition at line 58 of file lldp_ext_dot1.h.

Function Documentation

◆ lldpDot1DeleteLocalTlv()

error_t lldpDot1DeleteLocalTlv ( LldpAgentContext context,
LldpDot1Subtype  subtype 
)

Remove all IEEE 802.1 specific TLVs with specified subtype.

Parameters
[in]contextPointer to the LLDP agent context
[in]subtypeTLV subtype
Returns
Error code

Definition at line 465 of file lldp_ext_dot1.c.

◆ lldpDot1SetLocalPortProtoVlanId()

error_t lldpDot1SetLocalPortProtoVlanId ( LldpAgentContext context,
uint_t  portIndex,
uint8_t  flags,
uint16_t  ppvid 
)

Set port and protocol VLAN ID.

Parameters
[in]contextPointer to the LLDP agent context
[in]portIndexPort index
[in]flagsBit-map indicating the port and protocol VLAN capability and status
[in]ppvidPPVID number for this LAN station
Returns
Error code

Definition at line 120 of file lldp_ext_dot1.c.

◆ lldpDot1SetLocalPortVlanId()

error_t lldpDot1SetLocalPortVlanId ( LldpAgentContext context,
uint_t  portIndex,
uint16_t  pvid 
)

Set port VLAN ID.

Parameters
[in]contextPointer to the LLDP agent context
[in]portIndexPort index
[in]pvidPort VLAN identifier
Returns
Error code

Definition at line 54 of file lldp_ext_dot1.c.

◆ lldpDot1SetLocalProtocolId()

error_t lldpDot1SetLocalProtocolId ( LldpAgentContext context,
uint_t  portIndex,
const uint8_t *  protocolId,
size_t  protocolIdLen 
)

Set protocol identity.

Parameters
[in]contextPointer to the LLDP agent context
[in]portIndexPort index
[in]protocolIdFirst n octets of the protocol after the layer 2 addresses
[in]protocolIdLenLength of the protocol identity, in bytes
Returns
Error code

Definition at line 356 of file lldp_ext_dot1.c.

◆ lldpDot1SetLocalVlanName()

error_t lldpDot1SetLocalVlanName ( LldpAgentContext context,
uint_t  portIndex,
uint16_t  vlanId,
const char_t vlanName 
)

Set VLAN name.

Parameters
[in]contextPointer to the LLDP agent context
[in]portIndexPort index
[in]vlanIdVID number associated with the VLAN name
[in]vlanNameVLAN's name
Returns
Error code

Definition at line 231 of file lldp_ext_dot1.c.

Variable Documentation

◆ flags

uint8_t flags

Definition at line 102 of file lldp_ext_dot1.h.

◆ ppvid

uint16_t ppvid

Definition at line 103 of file lldp_ext_dot1.h.

◆ protocolId

uint8_t protocolId[]

Definition at line 126 of file lldp_ext_dot1.h.

◆ protocolIdLen

uint8_t protocolIdLen

Definition at line 125 of file lldp_ext_dot1.h.

◆ pvid

uint16_t pvid

Definition at line 92 of file lldp_ext_dot1.h.

◆ vlanId

uint16_t vlanId

Definition at line 113 of file lldp_ext_dot1.h.

◆ vlanName

char_t vlanName[]

Definition at line 115 of file lldp_ext_dot1.h.

◆ vlanNameLen

uint8_t vlanNameLen

Definition at line 114 of file lldp_ext_dot1.h.