rstp_bdm.h File Reference

Bridge Detection state machine (BDM) More...

#include "rstp/rstp.h"

Go to the source code of this file.

Enumerations

enum  RstpBdmState { RSTP_BDM_STATE_EDGE = 0 , RSTP_BDM_STATE_NOT_EDGE = 1 }
 Bridge Detection machine states. More...
 

Functions

void rstpBdmInit (RstpBridgePort *port)
 BDM state machine initialization. More...
 
void rstpBdmFsm (RstpBridgePort *port)
 BDM state machine implementation. More...
 
void rstpBdmChangeState (RstpBridgePort *port, RstpBdmState newState)
 Update BDM state machine state. More...
 

Detailed Description

Bridge Detection state machine (BDM)

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.0

Definition in file rstp_bdm.h.

Enumeration Type Documentation

◆ RstpBdmState

Bridge Detection machine states.

Enumerator
RSTP_BDM_STATE_EDGE 
RSTP_BDM_STATE_NOT_EDGE 

Definition at line 47 of file rstp_bdm.h.

Function Documentation

◆ rstpBdmChangeState()

void rstpBdmChangeState ( RstpBridgePort port,
RstpBdmState  newState 
)

Update BDM state machine state.

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

Definition at line 122 of file rstp_bdm.c.

◆ rstpBdmFsm()

void rstpBdmFsm ( RstpBridgePort port)

BDM state machine implementation.

Parameters
[in]portPointer to the bridge port context

Definition at line 77 of file rstp_bdm.c.

◆ rstpBdmInit()

void rstpBdmInit ( RstpBridgePort port)

BDM state machine initialization.

Parameters
[in]portPointer to the bridge port context

Definition at line 58 of file rstp_bdm.c.