Macros | Typedefs | Enumerations | Functions | Variables
rstp_bpdu.h File Reference

BPDU processing. More...

#include "rstp/rstp.h"

Go to the source code of this file.

Macros

#define RSTP_TCN_BPDU_SIZE   4
 
#define RSTP_CONFIG_BPDU_SIZE   35
 
#define RSTP_RST_BPDU_SIZE   36
 
#define RSTP_PORT_PRIORITY_MASK   0xF000
 
#define RSTP_PORT_NUM_MASK   0x0FFF
 

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 []
 
   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
 
} RstpBpdu
 Rapid Spanning Tree BPDU. More...
 

Enumerations

enum  RstpBpduTypes { RSTP_BPDU_TYPE_CONFIG = 0x00, RSTP_BPDU_TYPE_TCN = 0x80, RSTP_BPDU_TYPE_RST = 0x02 }
 BPDU types. More...
 
enum  RstpBpduFlags {
  RSTP_BPDU_FLAG_TC = 0x01, RSTP_BPDU_FLAG_PROPOSAL = 0x02, RSTP_BPDU_FLAG_PORT_ROLE = 0x0C, RSTP_BPDU_FLAG_PORT_ROLE_UNKNOWN = 0x00,
  RSTP_BPDU_FLAG_PORT_ROLE_ALT_BACKUP = 0x04, RSTP_BPDU_FLAG_PORT_ROLE_ROOT = 0x08, RSTP_BPDU_FLAG_PORT_ROLE_DESIGNATED = 0x0C, RSTP_BPDU_FLAG_LEARNING = 0x10,
  RSTP_BPDU_FLAG_FORWARDING = 0x20, RSTP_BPDU_FLAG_AGREEMENT = 0x40, RSTP_BPDU_FLAG_TC_ACK = 0x80
}
 BPDU flags. More...
 

Functions

void rstpProcessLlcFrame (NetInterface *interface, EthHeader *ethHeader, const uint8_t *data, size_t length, NetRxAncillary *ancillary, void *param)
 Process incoming LLC frame. More...
 
error_t rstpProcessBpdu (RstpBridgePort *port, const RstpBpdu *bpdu, size_t length)
 Process incoming bridge protocol data unit. More...
 
error_t rstpValidateConfigBpdu (RstpBridgePort *port, const RstpBpdu *bpdu, size_t length)
 Validate Configuration BPDU. More...
 
error_t rstpSendBpdu (RstpBridgePort *port, const RstpBpdu *bpdu, size_t length)
 Send bridge protocol data unit. More...
 
error_t rstpDumpBpdu (const RstpBpdu *bpdu, size_t length)
 Dump BPDU for debugging purpose. More...
 
void rstpDumpFlags (uint8_t flags)
 Dump Flags field for debugging purpose. More...
 

Variables

const MacAddr RSTP_BRIDGE_GROUP_ADDR
 

Detailed Description

BPDU processing.

License

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

Copyright (C) 2019-2023 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.2.4

Definition in file rstp_bpdu.h.

Macro Definition Documentation

◆ RSTP_CONFIG_BPDU_SIZE

#define RSTP_CONFIG_BPDU_SIZE   35

Definition at line 39 of file rstp_bpdu.h.

◆ RSTP_PORT_NUM_MASK

#define RSTP_PORT_NUM_MASK   0x0FFF

Definition at line 44 of file rstp_bpdu.h.

◆ RSTP_PORT_PRIORITY_MASK

#define RSTP_PORT_PRIORITY_MASK   0xF000

Definition at line 43 of file rstp_bpdu.h.

◆ RSTP_RST_BPDU_SIZE

#define RSTP_RST_BPDU_SIZE   36

Definition at line 40 of file rstp_bpdu.h.

◆ RSTP_TCN_BPDU_SIZE

#define RSTP_TCN_BPDU_SIZE   4

Definition at line 38 of file rstp_bpdu.h.

Typedef Documentation

◆ RstpBpdu

typedef { ... } RstpBpdu

Rapid Spanning Tree BPDU.

Enumeration Type Documentation

◆ RstpBpduFlags

enum RstpBpduFlags

BPDU flags.

Enumerator
RSTP_BPDU_FLAG_TC 
RSTP_BPDU_FLAG_PROPOSAL 
RSTP_BPDU_FLAG_PORT_ROLE 
RSTP_BPDU_FLAG_PORT_ROLE_UNKNOWN 
RSTP_BPDU_FLAG_PORT_ROLE_ALT_BACKUP 
RSTP_BPDU_FLAG_PORT_ROLE_ROOT 
RSTP_BPDU_FLAG_PORT_ROLE_DESIGNATED 
RSTP_BPDU_FLAG_LEARNING 
RSTP_BPDU_FLAG_FORWARDING 
RSTP_BPDU_FLAG_AGREEMENT 
RSTP_BPDU_FLAG_TC_ACK 

Definition at line 68 of file rstp_bpdu.h.

◆ RstpBpduTypes

enum RstpBpduTypes

BPDU types.

Enumerator
RSTP_BPDU_TYPE_CONFIG 
RSTP_BPDU_TYPE_TCN 
RSTP_BPDU_TYPE_RST 

Definition at line 56 of file rstp_bpdu.h.

Function Documentation

◆ rstpDumpBpdu()

error_t rstpDumpBpdu ( const RstpBpdu *  bpdu,
size_t  length 
)

Dump BPDU for debugging purpose.

Parameters
[in]bpduPointer to the BPDU to dump
[in]lengthLength of the BPDU, in bytes
Returns
Error code

Definition at line 389 of file rstp_bpdu.c.

◆ rstpDumpFlags()

void rstpDumpFlags ( uint8_t  flags)

Dump Flags field for debugging purpose.

Parameters
[in]flagsValue of the Flags field

Definition at line 466 of file rstp_bpdu.c.

◆ rstpProcessBpdu()

error_t rstpProcessBpdu ( RstpBridgePort *  port,
const RstpBpdu *  bpdu,
size_t  length 
)

Process incoming bridge protocol data unit.

Parameters
[in]portPointer to the bridge port context
[in]bpduPointer to the received BPDU
[in]lengthLength of the BPDU, in bytes
Returns
Error code

Definition at line 134 of file rstp_bpdu.c.

◆ rstpProcessLlcFrame()

void rstpProcessLlcFrame ( NetInterface *  interface,
EthHeader *  ethHeader,
const uint8_t *  data,
size_t  length,
NetRxAncillary *  ancillary,
void *  param 
)

Process incoming LLC frame.

Parameters
[in]interfaceUnderlying network interface
[in]ethHeaderPointer to the Ethernet header
[in]dataPointer to the LLC frame
[in]lengthLength of the LLC frame, in bytes
[in]ancillaryAdditional options passed to the stack along with the packet
[in]paramPointer to the RSTP bridge context

Definition at line 75 of file rstp_bpdu.c.

◆ rstpSendBpdu()

error_t rstpSendBpdu ( RstpBridgePort *  port,
const RstpBpdu *  bpdu,
size_t  length 
)

Send bridge protocol data unit.

Parameters
[in]portPointer to the bridge port context
[in]bpduPointer to the BPDU to be transmitted
[in]lengthLength of the BPDU, in bytes
Returns
Error code

Definition at line 308 of file rstp_bpdu.c.

◆ rstpValidateConfigBpdu()

error_t rstpValidateConfigBpdu ( RstpBridgePort *  port,
const RstpBpdu *  bpdu,
size_t  length 
)

Validate Configuration BPDU.

Parameters
[in]portPointer to the bridge port context
[in]bpduPointer to the received Configuration BPDU
[in]lengthLength of the Configuration BPDU, in bytes
Returns
Error code

Definition at line 271 of file rstp_bpdu.c.

Variable Documentation

◆ bpduType

uint8_t bpduType

Definition at line 98 of file rstp_bpdu.h.

◆ bridgeId

StpBridgeId bridgeId

Definition at line 102 of file rstp_bpdu.h.

◆ flags

uint8_t flags

Definition at line 99 of file rstp_bpdu.h.

◆ forwardDelay

uint16_t forwardDelay

Definition at line 107 of file rstp_bpdu.h.

◆ helloTime

uint16_t helloTime

Definition at line 106 of file rstp_bpdu.h.

◆ maxAge

uint16_t maxAge

Definition at line 105 of file rstp_bpdu.h.

◆ messageAge

uint16_t messageAge

Definition at line 104 of file rstp_bpdu.h.

◆ portId

uint16_t portId

Definition at line 103 of file rstp_bpdu.h.

◆ protocolId

uint16_t protocolId

Definition at line 96 of file rstp_bpdu.h.

◆ protocolVersionId

uint8_t protocolVersionId

Definition at line 97 of file rstp_bpdu.h.

◆ rootId

StpBridgeId rootId

Definition at line 100 of file rstp_bpdu.h.

◆ rootPathCost

uint32_t rootPathCost

Definition at line 101 of file rstp_bpdu.h.

◆ RSTP_BRIDGE_GROUP_ADDR

const MacAddr RSTP_BRIDGE_GROUP_ADDR
extern

Definition at line 46 of file rstp_bpdu.c.

◆ version1Length

uint8_t version1Length

Definition at line 108 of file rstp_bpdu.h.