stp_common.h File Reference

STP common definitions. More...

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

Go to the source code of this file.

Macros

#define CYCLONE_STP_VERSION_STRING   "2.0.2"
 
#define CYCLONE_STP_MAJOR_VERSION   2
 
#define CYCLONE_STP_MINOR_VERSION   0
 
#define CYCLONE_STP_REV_NUMBER   2
 
#define STP_PROTOCOL_ID   0
 
#define STP_LLC_DSAP   0x42
 
#define STP_LLC_SSAP   0x42
 
#define STP_LLC_CTRL   0x03
 
#define STP_MIN_BPDU_SIZE   4
 

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
 
   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   maxRespTime
 
   Ipv4Addr   groupAddr
 
   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
 
   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
 
StpBridgeId
 Bridge identifier. More...
 

Enumerations

enum  StpProtocolVersion { STP_PROTOCOL_VERSION = 0, RSTP_PROTOCOL_VERSION = 2, MSTP_PROTOCOL_VERSION = 3 }
 Protocol versions. More...
 
enum  StpPortState {
  STP_PORT_STATE_DISABLED = 0, STP_PORT_STATE_BROKEN = 1, STP_PORT_STATE_BLOCKING = 2, STP_PORT_STATE_LISTENING = 3,
  STP_PORT_STATE_LEARNING = 4, STP_PORT_STATE_FORWARDING = 5
}
 Port states. More...
 
enum  StpPortRole {
  STP_PORT_ROLE_DISABLED = 0, STP_PORT_ROLE_ROOT = 1, STP_PORT_ROLE_DESIGNATED = 2, STP_PORT_ROLE_ALTERNATE = 3,
  STP_PORT_ROLE_BACKUP = 4
}
 Port role values. More...
 

Detailed Description

STP common definitions.

License

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

Copyright (C) 2019-2021 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneSTP 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.0.2

Definition in file stp_common.h.

Macro Definition Documentation

◆ CYCLONE_STP_MAJOR_VERSION

#define CYCLONE_STP_MAJOR_VERSION   2

Definition at line 68 of file stp_common.h.

◆ CYCLONE_STP_MINOR_VERSION

#define CYCLONE_STP_MINOR_VERSION   0

Definition at line 70 of file stp_common.h.

◆ CYCLONE_STP_REV_NUMBER

#define CYCLONE_STP_REV_NUMBER   2

Definition at line 72 of file stp_common.h.

◆ CYCLONE_STP_VERSION_STRING

#define CYCLONE_STP_VERSION_STRING   "2.0.2"

Definition at line 66 of file stp_common.h.

◆ STP_LLC_CTRL

#define STP_LLC_CTRL   0x03

Definition at line 85 of file stp_common.h.

◆ STP_LLC_DSAP

#define STP_LLC_DSAP   0x42

Definition at line 83 of file stp_common.h.

◆ STP_LLC_SSAP

#define STP_LLC_SSAP   0x42

Definition at line 84 of file stp_common.h.

◆ STP_MIN_BPDU_SIZE

#define STP_MIN_BPDU_SIZE   4

Definition at line 88 of file stp_common.h.

◆ STP_PROTOCOL_ID

#define STP_PROTOCOL_ID   0

Definition at line 80 of file stp_common.h.

Typedef Documentation

◆ StpBridgeId

typedef { ... } StpBridgeId

Bridge identifier.

Enumeration Type Documentation

◆ StpPortRole

Port role values.

Enumerator
STP_PORT_ROLE_DISABLED 
STP_PORT_ROLE_ROOT 
STP_PORT_ROLE_DESIGNATED 
STP_PORT_ROLE_ALTERNATE 
STP_PORT_ROLE_BACKUP 

Definition at line 122 of file stp_common.h.

◆ StpPortState

Port states.

Enumerator
STP_PORT_STATE_DISABLED 
STP_PORT_STATE_BROKEN 
STP_PORT_STATE_BLOCKING 
STP_PORT_STATE_LISTENING 
STP_PORT_STATE_LEARNING 
STP_PORT_STATE_FORWARDING 

Definition at line 107 of file stp_common.h.

◆ StpProtocolVersion

Protocol versions.

Enumerator
STP_PROTOCOL_VERSION 

STP version.

RSTP_PROTOCOL_VERSION 

RSTP version.

MSTP_PROTOCOL_VERSION 

MSTP version.

Definition at line 95 of file stp_common.h.

Variable Documentation

◆ addr

MacAddr addr

Definition at line 145 of file stp_common.h.

◆ priority

uint16_t priority

Definition at line 144 of file stp_common.h.