lldp_tlv.h File Reference

TLV parsing and formatting. More...

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

Go to the source code of this file.

Data Structures

struct  LldpTlv
 TLV structure. More...
 

Macros

#define LLDP_OUI_SIZE   3
 
#define LLDP_MAX_TLV_INFO_LEN   511
 
#define LLDP_MAX_ORG_SPECIFIC_INFO_LEN   507
 
#define LLDP_MIN_CHASSIS_ID_LEN   1
 
#define LLDP_MAX_CHASSIS_ID_LEN   255
 
#define LLDP_MIN_PORT_ID_LEN   1
 
#define LLDP_MAX_PORT_ID_LEN   255
 
#define LLDP_MIN_PORT_DESC_LEN   1
 
#define LLDP_MAX_PORT_DESC_LEN   255
 
#define LLDP_MIN_SYS_NAME_LEN   1
 
#define LLDP_MAX_SYS_NAME_LEN   255
 
#define LLDP_MIN_SYS_DESC_LEN   1
 
#define LLDP_MAX_SYS_DESC_LEN   255
 
#define LLDP_MIN_MGMT_ADDR_LEN   1
 
#define LLDP_MAX_MGMT_ADDR_LEN   31
 
#define LLDP_MIN_OID_LEN   0
 
#define LLDP_MAX_OID_LEN   128
 

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
 
LldpTlvHeader
 TLV header. 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
 
LldpChassisIdTlv
 Chassis 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 []
 
LldpPortIdTlv
 Port ID 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 []
 
LldpTimeToLiveTlv
 Time To Live TLV. More...
 
struct {
   uint16_t   tci
 
   uint16_t   type
 
   uint8_t   msgType
 
   uint8_t   hopCount
 
   Ipv6Addr   linkAddress
 
   Ipv6Addr   peerAddress
 
   uint8_t   options []
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint8_t   rdata [16]
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   bString []
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint8_t   pointer
 
   uint8_t   unused [3]
 
   uint8_t   data []
 
   uint32_t   unused
 
   uint8_t   nextHeader
 
   uint8_t   payloadLen
 
   uint16_t   reserved
 
   uint32_t   securityParamIndex
 
   uint32_t   sequenceNumber
 
   uint8_t   authData []
 
   uint32_t   reserved
 
   Ipv6Addr   targetAddr
 
   Ipv6Addr   destAddr
 
   uint8_t   measurements [20]
 
   uint16_t   psePowerPriceIndex
 
   uint16_t   supportedCap
 
   uint16_t   enabledCap
 
   uint8_t   functionCode
 
   uint8_t   byteCount
 
   uint8_t   inputStatus []
 
   uint8_t   radius
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
   uint32_t   magicNumber
 
   uint8_t   identifier
 
   uint16_t   length
 
   uint16_t   opcode
 
   uint16_t   errorCode
 
   char_t   errorMsg []
 
   uint16_t   msgSeq
 
   uint8_t   fragOffset [3]
 
   uint8_t   fragLength [3]
 
   TlsSignHashAlgo   value []
 
   uint8_t   value []
 
LldpSysCapTlv
 System Capabilities TLV. More...
 
struct {
   uint16_t   code
 
   uint16_t   length
 
   uint8_t   value []
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint16_t   priority
 
   uint16_t   weight
 
   uint16_t   port
 
   uint8_t   target []
 
   uint8_t   bFunctionLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bDescriptorSubtype
 
   uint16_t   bcdCdc
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint16_t   identifier
 
   uint16_t   sequenceNumber
 
   uint8_t   data []
 
   uint32_t   pointer
 
   uint32_t   securityParamIndex
 
   uint32_t   sequenceNumber
 
   uint8_t   payloadData []
 
   uint8_t   length
 
   uint8_t   powerPriority: 2
 
   uint8_t   pd4pid: 1
 
   uint8_t   reserved: 1
 
   uint8_t   powerSource: 2
 
   uint8_t   powerType: 2
 
   uint16_t   pdRequestedPower
 
   uint16_t   pseAllocatedPower
 
   uint8_t   mgmtAddrLen
 
   uint8_t   mgmtAddrSubtype
 
   uint8_t   mgmtAddr []
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfRegs
 
   uint8_t   gwId
 
   uint8_t   gwAdd []
 
   Ipv4Addr   ipAddr
 
   uint8_t   identifier
 
   uint32_t   magicNumber
 
   uint16_t   serverVersion
 
   uint8_t   cookieLength
 
   uint8_t   cookie []
 
LldpMgmtAddrTlv1
 Management Address TLV (part 1) More...
 
struct {
   uint32_t   iaId
 
   uint32_t   t1
 
   uint32_t   t2
 
   uint8_t   options []
 
   uint8_t   bFunctionLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bDescriptorSubtype
 
   uint8_t   bmCapabilities
 
   uint8_t   bDataInterface
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint16_t   identifier
 
   uint16_t   sequenceNumber
 
   uint8_t   data []
 
   uint8_t   length
 
   MacAddr   linkLayerAddr
 
   uint16_t   pdRequestedPowerA
 
   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]
 
   uint8_t   ifNumSubtype
 
   uint32_t   ifNum
 
   uint8_t   oidLen
 
   uint8_t   oid []
 
   uint8_t   functionCode
 
   uint8_t   byteCount
 
   uint16_t   regValue []
 
   MqttSnFlags   flags
 
   uint8_t   protocolId
 
   uint16_t   duration
 
   char_t   clientId []
 
   Ipv4Addr   ipAddr
 
   uint16_t   length
 
   uint8_t   value []
 
LldpMgmtAddrTlv2
 Management Address TLV (part 2) More...
 
struct {
   uint32_t   iaId
 
   uint8_t   options []
 
   uint8_t   bFunctionLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bDescriptorSubtype
 
   uint8_t   bmCapabilities
 
   uint8_t   type
 
   uint8_t   length
 
   uint8_t   prefixLength
 
   uint8_t   reserved1: 5
 
   uint8_t   r: 1
 
   uint8_t   a: 1
 
   uint8_t   l: 1
 
   uint32_t   validLifetime
 
   uint32_t   preferredLifetime
 
   uint32_t   reserved2
 
   Ipv6Addr   prefix
 
   uint8_t   oui [LLDP_OUI_SIZE]
 
   uint8_t   subtype
 
   uint8_t   value []
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfRegs
 
   uint8_t   returnCode
 
   uint16_t   type
 
   uint16_t   length
 
LldpOrgDefTlv
 Organizationally Specific TLV. More...
 

Enumerations

enum  LldpTlvType {
  LLDP_TLV_TYPE_END_OF_LLDPDU = 0, LLDP_TLV_TYPE_CHASSIS_ID = 1, LLDP_TLV_TYPE_PORT_ID = 2, LLDP_TLV_TYPE_TIME_TO_LIVE = 3,
  LLDP_TLV_TYPE_PORT_DESC = 4, LLDP_TLV_TYPE_SYS_NAME = 5, LLDP_TLV_TYPE_SYS_DESC = 6, LLDP_TLV_TYPE_SYS_CAP = 7,
  LLDP_TLV_TYPE_MGMT_ADDR = 8, LLDP_TLV_TYPE_ORG_DEFINED = 127
}
 TLV type values. More...
 
enum  LldpChassisIdSubtype {
  LLDP_CHASSIS_ID_SUBTYPE_RESERVED = 0, LLDP_CHASSIS_ID_SUBTYPE_CHASSIS_COMPONENT = 1, LLDP_CHASSIS_ID_SUBTYPE_INTERFACE_ALIAS = 2, LLDP_CHASSIS_ID_SUBTYPE_PORT_COMPONENT = 3,
  LLDP_CHASSIS_ID_SUBTYPE_MAC_ADDR = 4, LLDP_CHASSIS_ID_SUBTYPE_NETWORK_ADDR = 5, LLDP_CHASSIS_ID_SUBTYPE_INTERFACE_NAME = 6, LLDP_CHASSIS_ID_SUBTYPE_LOCALLY_ASSIGNED = 7
}
 Chassis ID subtypes. More...
 
enum  LldpPortIdSubtype {
  LLDP_PORT_ID_SUBTYPE_RESERVED = 0, LLDP_PORT_ID_SUBTYPE_INTERFACE_ALIAS = 1, LLDP_PORT_ID_SUBTYPE_PORT_COMPONENT = 2, LLDP_PORT_ID_SUBTYPE_MAC_ADDR = 3,
  LLDP_PORT_ID_SUBTYPE_NETWORK_ADDR = 4, LLDP_PORT_ID_SUBTYPE_INTERFACE_NAME = 5, LLDP_PORT_ID_SUBTYPE_AGENT_CIRCUIT_ID = 6, LLDP_PORT_ID_SUBTYPE_LOCALLY_ASSIGNED = 7
}
 Port ID subtypes. More...
 
enum  LldpSysCap {
  LLDP_SYS_CAP_OTHER = 0x0001, LLDP_SYS_CAP_REPEATER = 0x0002, LLDP_SYS_CAP_BRIDGE = 0x0004, LLDP_SYS_CAP_WLAN_ACCESS_POINT = 0x0008,
  LLDP_SYS_CAP_ROUTER = 0x0010, LLDP_SYS_CAP_TELEPHONE = 0x0020, LLDP_SYS_CAP_DOCSIS_CABLE_DEVICE = 0x0040, LLDP_SYS_CAP_STATION_ONLY = 0x0080
}
 System capabilities. More...
 
enum  LldpMgmtAddrSubtype { LLDP_MGMT_ADDR_SUBTYPE_OTHER = 0, LLDP_MGMT_ADDR_SUBTYPE_IPV4 = 1, LLDP_MGMT_ADDR_SUBTYPE_IPV6 = 2, LLDP_MGMT_ADDR_SUBTYPE_ALL_802 = 6 }
 Management address subtypes. More...
 
enum  LldpIfNumSubtype { LLDP_IF_NUM_SUBTYPE_UNKNOWN = 1, LLDP_IF_NUM_SUBTYPE_IF_INDEX = 2, LLDP_IF_NUM_SUBTYPE_SYS_PORT_NUM = 3 }
 Interface numbering subtypes. More...
 
enum  LldpOui { LLDP_DOT1_OUI = 0x0080C2, LLDP_DOT3_OUI = 0x00120F, LLDP_MED_OUI = 0x0012BB }
 Organizationally unique identifiers. More...
 

Functions

error_t lldpSetTlv (LldpDataUnit *lldpdu, uint8_t type, uint_t index, const uint8_t *value, size_t length, bool_t replace)
 Add or replace a TLV. More...
 
error_t lldpGetTlv (LldpDataUnit *lldpdu, uint8_t type, uint_t index, const uint8_t **value, size_t *length)
 Search a LLDPDU for a given TLV. More...
 
error_t lldpGetFirstTlv (LldpDataUnit *lldpdu, LldpTlv *tlv)
 Extract the first TLV from an LLDPDU. More...
 
error_t lldpGetNextTlv (LldpDataUnit *lldpdu, LldpTlv *tlv)
 Extract the next TLV from an LLDPDU. More...
 
error_t lldpDeleteTlv (LldpDataUnit *lldpdu, uint8_t type, uint_t index)
 Remove a TLV from a LLDPDU. More...
 
error_t lldpDecodeMgmtAddrTlv (const uint8_t *value, size_t length, const LldpMgmtAddrTlv1 **mgmtAddr1, const LldpMgmtAddrTlv2 **mgmtAddr2)
 Decode the contents of a Management Address TLV. More...
 
error_t lldpSetOrgDefTlv (LldpDataUnit *lldpdu, uint32_t oui, uint8_t subtype, uint_t index, const uint8_t *value, size_t length, bool_t replace)
 Add or replace an organizationally specific TLV. More...
 
error_t lldpGetOrgDefTlv (LldpDataUnit *lldpdu, uint32_t oui, uint8_t subtype, uint_t index, const uint8_t **value, size_t *length)
 Search an LLDPDU for an organizationally specific TLV. More...
 
error_t lldpDeleteOrgDefTlv (LldpDataUnit *lldpdu, uint32_t oui, uint8_t subtype, uint_t index)
 Remove an organizationally specific TLV from a LLDPDU. More...
 

Detailed Description

TLV parsing and formatting.

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_tlv.h.

Macro Definition Documentation

◆ LLDP_MAX_CHASSIS_ID_LEN

#define LLDP_MAX_CHASSIS_ID_LEN   255

Definition at line 49 of file lldp_tlv.h.

◆ LLDP_MAX_MGMT_ADDR_LEN

#define LLDP_MAX_MGMT_ADDR_LEN   31

Definition at line 74 of file lldp_tlv.h.

◆ LLDP_MAX_OID_LEN

#define LLDP_MAX_OID_LEN   128

Definition at line 79 of file lldp_tlv.h.

◆ LLDP_MAX_ORG_SPECIFIC_INFO_LEN

#define LLDP_MAX_ORG_SPECIFIC_INFO_LEN   507

Definition at line 44 of file lldp_tlv.h.

◆ LLDP_MAX_PORT_DESC_LEN

#define LLDP_MAX_PORT_DESC_LEN   255

Definition at line 59 of file lldp_tlv.h.

◆ LLDP_MAX_PORT_ID_LEN

#define LLDP_MAX_PORT_ID_LEN   255

Definition at line 54 of file lldp_tlv.h.

◆ LLDP_MAX_SYS_DESC_LEN

#define LLDP_MAX_SYS_DESC_LEN   255

Definition at line 69 of file lldp_tlv.h.

◆ LLDP_MAX_SYS_NAME_LEN

#define LLDP_MAX_SYS_NAME_LEN   255

Definition at line 64 of file lldp_tlv.h.

◆ LLDP_MAX_TLV_INFO_LEN

#define LLDP_MAX_TLV_INFO_LEN   511

Definition at line 42 of file lldp_tlv.h.

◆ LLDP_MIN_CHASSIS_ID_LEN

#define LLDP_MIN_CHASSIS_ID_LEN   1

Definition at line 47 of file lldp_tlv.h.

◆ LLDP_MIN_MGMT_ADDR_LEN

#define LLDP_MIN_MGMT_ADDR_LEN   1

Definition at line 72 of file lldp_tlv.h.

◆ LLDP_MIN_OID_LEN

#define LLDP_MIN_OID_LEN   0

Definition at line 77 of file lldp_tlv.h.

◆ LLDP_MIN_PORT_DESC_LEN

#define LLDP_MIN_PORT_DESC_LEN   1

Definition at line 57 of file lldp_tlv.h.

◆ LLDP_MIN_PORT_ID_LEN

#define LLDP_MIN_PORT_ID_LEN   1

Definition at line 52 of file lldp_tlv.h.

◆ LLDP_MIN_SYS_DESC_LEN

#define LLDP_MIN_SYS_DESC_LEN   1

Definition at line 67 of file lldp_tlv.h.

◆ LLDP_MIN_SYS_NAME_LEN

#define LLDP_MIN_SYS_NAME_LEN   1

Definition at line 62 of file lldp_tlv.h.

◆ LLDP_OUI_SIZE

#define LLDP_OUI_SIZE   3

Definition at line 39 of file lldp_tlv.h.

Typedef Documentation

◆ LldpChassisIdTlv

typedef { ... } LldpChassisIdTlv

Chassis ID TLV.

◆ LldpMgmtAddrTlv1

typedef { ... } LldpMgmtAddrTlv1

Management Address TLV (part 1)

◆ LldpMgmtAddrTlv2

typedef { ... } LldpMgmtAddrTlv2

Management Address TLV (part 2)

◆ LldpOrgDefTlv

typedef { ... } LldpOrgDefTlv

Organizationally Specific TLV.

◆ LldpPortIdTlv

typedef { ... } LldpPortIdTlv

Port ID TLV.

◆ LldpSysCapTlv

typedef { ... } LldpSysCapTlv

System Capabilities TLV.

◆ LldpTimeToLiveTlv

typedef { ... } LldpTimeToLiveTlv

Time To Live TLV.

◆ LldpTlvHeader

typedef { ... } LldpTlvHeader

TLV header.

Enumeration Type Documentation

◆ LldpChassisIdSubtype

Chassis ID subtypes.

Enumerator
LLDP_CHASSIS_ID_SUBTYPE_RESERVED 

Reserved.

LLDP_CHASSIS_ID_SUBTYPE_CHASSIS_COMPONENT 

Chassis component.

LLDP_CHASSIS_ID_SUBTYPE_INTERFACE_ALIAS 

Interface alias.

LLDP_CHASSIS_ID_SUBTYPE_PORT_COMPONENT 

Port component.

LLDP_CHASSIS_ID_SUBTYPE_MAC_ADDR 

MAC address.

LLDP_CHASSIS_ID_SUBTYPE_NETWORK_ADDR 

Network address.

LLDP_CHASSIS_ID_SUBTYPE_INTERFACE_NAME 

Interface name.

LLDP_CHASSIS_ID_SUBTYPE_LOCALLY_ASSIGNED 

Locally assigned.

Definition at line 110 of file lldp_tlv.h.

◆ LldpIfNumSubtype

Interface numbering subtypes.

Enumerator
LLDP_IF_NUM_SUBTYPE_UNKNOWN 

Unknown.

LLDP_IF_NUM_SUBTYPE_IF_INDEX 

Interface index.

LLDP_IF_NUM_SUBTYPE_SYS_PORT_NUM 

System port number.

Definition at line 174 of file lldp_tlv.h.

◆ LldpMgmtAddrSubtype

Management address subtypes.

Enumerator
LLDP_MGMT_ADDR_SUBTYPE_OTHER 

Other.

LLDP_MGMT_ADDR_SUBTYPE_IPV4 

IPv4 address.

LLDP_MGMT_ADDR_SUBTYPE_IPV6 

IPv6 address.

LLDP_MGMT_ADDR_SUBTYPE_ALL_802 

MAC address.

Definition at line 161 of file lldp_tlv.h.

◆ LldpOui

enum LldpOui

Organizationally unique identifiers.

Enumerator
LLDP_DOT1_OUI 

IEEE 802.1.

LLDP_DOT3_OUI 

IEEE 802.3.

LLDP_MED_OUI 

LLDP-MED.

Definition at line 186 of file lldp_tlv.h.

◆ LldpPortIdSubtype

Port ID subtypes.

Enumerator
LLDP_PORT_ID_SUBTYPE_RESERVED 

Reserved.

LLDP_PORT_ID_SUBTYPE_INTERFACE_ALIAS 

Interface alias.

LLDP_PORT_ID_SUBTYPE_PORT_COMPONENT 

Port component.

LLDP_PORT_ID_SUBTYPE_MAC_ADDR 

MAC address.

LLDP_PORT_ID_SUBTYPE_NETWORK_ADDR 

Network address.

LLDP_PORT_ID_SUBTYPE_INTERFACE_NAME 

Interface name.

LLDP_PORT_ID_SUBTYPE_AGENT_CIRCUIT_ID 

Agent circuit ID.

LLDP_PORT_ID_SUBTYPE_LOCALLY_ASSIGNED 

Locally assigned.

Definition at line 127 of file lldp_tlv.h.

◆ LldpSysCap

enum LldpSysCap

System capabilities.

Enumerator
LLDP_SYS_CAP_OTHER 

Other.

LLDP_SYS_CAP_REPEATER 

Repeater.

LLDP_SYS_CAP_BRIDGE 

Bridge.

LLDP_SYS_CAP_WLAN_ACCESS_POINT 

WLAN Access Point.

LLDP_SYS_CAP_ROUTER 

Router.

LLDP_SYS_CAP_TELEPHONE 

Telephone.

LLDP_SYS_CAP_DOCSIS_CABLE_DEVICE 

DOCSIS cable device.

LLDP_SYS_CAP_STATION_ONLY 

Station Only.

Definition at line 144 of file lldp_tlv.h.

◆ LldpTlvType

TLV type values.

Enumerator
LLDP_TLV_TYPE_END_OF_LLDPDU 

End Of LLDPDU.

LLDP_TLV_TYPE_CHASSIS_ID 

Chassis ID.

LLDP_TLV_TYPE_PORT_ID 

Port ID.

LLDP_TLV_TYPE_TIME_TO_LIVE 

Time To Live.

LLDP_TLV_TYPE_PORT_DESC 

Port Description.

LLDP_TLV_TYPE_SYS_NAME 

System Name.

LLDP_TLV_TYPE_SYS_DESC 

System Description.

LLDP_TLV_TYPE_SYS_CAP 

System Capabilities.

LLDP_TLV_TYPE_MGMT_ADDR 

Management Address.

LLDP_TLV_TYPE_ORG_DEFINED 

Organizationally Specific TLVs.

Definition at line 91 of file lldp_tlv.h.

Function Documentation

◆ lldpDecodeMgmtAddrTlv()

error_t lldpDecodeMgmtAddrTlv ( const uint8_t *  value,
size_t  length,
const LldpMgmtAddrTlv1 **  mgmtAddr1,
const LldpMgmtAddrTlv2 **  mgmtAddr2 
)

Decode the contents of a Management Address TLV.

Parameters
[in]valuePointer to the TLV value to decode
[in]lengthLength of the TLV value, in bytes
[out]mgmtAddr1First part of the Management Address TLV
[out]mgmtAddr2Second part of the Management Address TLV
Returns
Error code

Definition at line 380 of file lldp_tlv.c.

◆ lldpDeleteOrgDefTlv()

error_t lldpDeleteOrgDefTlv ( LldpDataUnit lldpdu,
uint32_t  oui,
uint8_t  subtype,
uint_t  index 
)

Remove an organizationally specific TLV from a LLDPDU.

Parameters
[in]lldpduPointer to the LLDP data unit
[in]ouiOrganizationally unique identifier
[in]subtypeOrganizationally defined subtype
[in]indexTLV occurrence index
Returns
Error code

Definition at line 719 of file lldp_tlv.c.

◆ lldpDeleteTlv()

error_t lldpDeleteTlv ( LldpDataUnit lldpdu,
uint8_t  type,
uint_t  index 
)

Remove a TLV from a LLDPDU.

Parameters
[in]lldpduPointer to the LLDP data unit
[in]typeTLV type
[in]indexTLV occurrence index
Returns
Error code

Definition at line 320 of file lldp_tlv.c.

◆ lldpGetFirstTlv()

error_t lldpGetFirstTlv ( LldpDataUnit lldpdu,
LldpTlv tlv 
)

Extract the first TLV from an LLDPDU.

Parameters
[in]lldpduPointer to the LLDP data unit
[out]tlvNext TLV
Returns
Error code

Definition at line 247 of file lldp_tlv.c.

◆ lldpGetNextTlv()

error_t lldpGetNextTlv ( LldpDataUnit lldpdu,
LldpTlv tlv 
)

Extract the next TLV from an LLDPDU.

Parameters
[in]lldpduPointer to the LLDP data unit
[out]tlvNext TLV
Returns
Error code

Definition at line 264 of file lldp_tlv.c.

◆ lldpGetOrgDefTlv()

error_t lldpGetOrgDefTlv ( LldpDataUnit lldpdu,
uint32_t  oui,
uint8_t  subtype,
uint_t  index,
const uint8_t **  value,
size_t *  length 
)

Search an LLDPDU for an organizationally specific TLV.

Parameters
[in]lldpduPointer to the LLDP data unit
[in]ouiOrganizationally unique identifier
[in]subtypeOrganizationally defined subtype
[in]indexTLV occurrence index
[out]valueOrganizationally defined information string
[out]lengthLength of the information string, in bytes
Returns
Error code

Definition at line 651 of file lldp_tlv.c.

◆ lldpGetTlv()

error_t lldpGetTlv ( LldpDataUnit lldpdu,
uint8_t  type,
uint_t  index,
const uint8_t **  value,
size_t *  length 
)

Search a LLDPDU for a given TLV.

Parameters
[in]lldpduPointer to the LLDP data unit
[in]typeTLV type
[in]indexTLV occurrence index
[out]valueTLV information string
[out]lengthLength of the information string, in bytes
Returns
Error code

Definition at line 200 of file lldp_tlv.c.

◆ lldpSetOrgDefTlv()

error_t lldpSetOrgDefTlv ( LldpDataUnit lldpdu,
uint32_t  oui,
uint8_t  subtype,
uint_t  index,
const uint8_t *  value,
size_t  length,
bool_t  replace 
)

Add or replace an organizationally specific TLV.

Parameters
[in]lldpduPointer to the LLDP data unit
[in]ouiOrganizationally unique identifier
[in]subtypeOrganizationally defined subtype
[in]indexTLV occurrence index
[in]valueOrganizationally defined information string
[in]lengthLength of the information string, in bytes
[in]replaceReplace the existing TLV if a match is found
Returns
Error code

Definition at line 452 of file lldp_tlv.c.

◆ lldpSetTlv()

error_t lldpSetTlv ( LldpDataUnit lldpdu,
uint8_t  type,
uint_t  index,
const uint8_t *  value,
size_t  length,
bool_t  replace 
)

Add or replace a TLV.

Parameters
[in]lldpduPointer to the LLDP data unit
[in]typeTLV type
[in]indexTLV occurrence index
[in]valueTLV information string
[in]lengthLength of the information string, in bytes
[in]replaceReplace the existing TLV if a match is found
Returns
Error code

Definition at line 56 of file lldp_tlv.c.

Variable Documentation

◆ chassisId

uint8_t chassisId[]

Definition at line 240 of file lldp_tlv.h.

◆ chassisIdSubtype

uint8_t chassisIdSubtype

Definition at line 239 of file lldp_tlv.h.

◆ enabledCap

uint16_t enabledCap

Definition at line 272 of file lldp_tlv.h.

◆ ifNum

uint32_t ifNum

Definition at line 295 of file lldp_tlv.h.

◆ ifNumSubtype

uint8_t ifNumSubtype

Definition at line 294 of file lldp_tlv.h.

◆ lengthH

uint8_t lengthH

Definition at line 225 of file lldp_tlv.h.

◆ lengthL

uint8_t lengthL

Definition at line 227 of file lldp_tlv.h.

◆ mgmtAddr

uint8_t mgmtAddr[]

Definition at line 284 of file lldp_tlv.h.

◆ mgmtAddrLen

uint8_t mgmtAddrLen

Definition at line 282 of file lldp_tlv.h.

◆ mgmtAddrSubtype

uint8_t mgmtAddrSubtype

Definition at line 283 of file lldp_tlv.h.

◆ oid

uint8_t oid[]

Definition at line 297 of file lldp_tlv.h.

◆ oidLen

uint8_t oidLen

Definition at line 296 of file lldp_tlv.h.

◆ oui

uint8_t oui[LLDP_OUI_SIZE]

Definition at line 307 of file lldp_tlv.h.

◆ portId

uint8_t portId[]

Definition at line 251 of file lldp_tlv.h.

◆ portIdSubtype

uint8_t portIdSubtype

Definition at line 250 of file lldp_tlv.h.

◆ subtype

uint8_t subtype

Definition at line 308 of file lldp_tlv.h.

◆ supportedCap

uint16_t supportedCap

Definition at line 271 of file lldp_tlv.h.

◆ ttl

uint16_t ttl

Definition at line 261 of file lldp_tlv.h.

◆ type

uint8_t type

Definition at line 226 of file lldp_tlv.h.

◆ value

uint8_t value[]

Definition at line 228 of file lldp_tlv.h.