rstp_tcm.h File Reference

Topology change state machine (TCM) More...

#include "rstp/rstp.h"

Go to the source code of this file.

Enumerations

enum  RstpTcmState {
  RSTP_TCM_STATE_INACTIVE = 0, RSTP_TCM_STATE_LEARNING = 1, RSTP_TCM_STATE_DETECTED = 2, RSTP_TCM_STATE_NOTIFIED_TCN = 3,
  RSTP_TCM_STATE_NOTIFIED_TC = 4, RSTP_TCM_STATE_PROPAGATING = 5, RSTP_TCM_STATE_ACKNOWLEDGED = 6, RSTP_TCM_STATE_ACTIVE = 7
}
 Topology Change machine states. More...
 

Functions

void rstpTcmInit (RstpBridgePort *port)
 TCM state machine initialization. More...
 
void rstpTcmFsm (RstpBridgePort *port)
 TCM state machine implementation. More...
 
void rstpTcmChangeState (RstpBridgePort *port, RstpTcmState newState)
 Update TCM state machine state. More...
 

Detailed Description

Topology change state machine (TCM)

License

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

Copyright (C) 2019-2024 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.4.4

Definition in file rstp_tcm.h.

Enumeration Type Documentation

◆ RstpTcmState

Topology Change machine states.

Enumerator
RSTP_TCM_STATE_INACTIVE 
RSTP_TCM_STATE_LEARNING 
RSTP_TCM_STATE_DETECTED 
RSTP_TCM_STATE_NOTIFIED_TCN 
RSTP_TCM_STATE_NOTIFIED_TC 
RSTP_TCM_STATE_PROPAGATING 
RSTP_TCM_STATE_ACKNOWLEDGED 
RSTP_TCM_STATE_ACTIVE 

Definition at line 47 of file rstp_tcm.h.

Function Documentation

◆ rstpTcmChangeState()

void rstpTcmChangeState ( RstpBridgePort port,
RstpTcmState  newState 
)

Update TCM state machine state.

Parameters
[in]portPointer to the bridge port context
[in]newStateNew state to switch to

Definition at line 189 of file rstp_tcm.c.

◆ rstpTcmFsm()

void rstpTcmFsm ( RstpBridgePort port)

TCM state machine implementation.

Parameters
[in]portPointer to the bridge port context

Definition at line 76 of file rstp_tcm.c.

◆ rstpTcmInit()

void rstpTcmInit ( RstpBridgePort port)

TCM state machine initialization.

Parameters
[in]portPointer to the bridge port context

Definition at line 64 of file rstp_tcm.c.