rstp_ppm.h File Reference

Port Protocol Migration state machine (PPM) More...

#include "rstp/rstp.h"

Go to the source code of this file.

Enumerations

enum  RstpPpmState { RSTP_PPM_STATE_CHECKING_RSTP = 0 , RSTP_PPM_STATE_SELECTING_STP = 1 , RSTP_PPM_STATE_SENSING = 2 }
 Port Protocol Migration states. More...
 

Functions

void rstpPpmInit (RstpBridgePort *port)
 PPM state machine initialization. More...
 
void rstpPpmFsm (RstpBridgePort *port)
 PPM state machine implementation. More...
 
void rstpPpmChangeState (RstpBridgePort *port, RstpPpmState newState)
 Update PPM state machine state. More...
 

Detailed Description

Port Protocol Migration state machine (PPM)

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

Enumeration Type Documentation

◆ RstpPpmState

Port Protocol Migration states.

Enumerator
RSTP_PPM_STATE_CHECKING_RSTP 
RSTP_PPM_STATE_SELECTING_STP 
RSTP_PPM_STATE_SENSING 

Definition at line 47 of file rstp_ppm.h.

Function Documentation

◆ rstpPpmChangeState()

void rstpPpmChangeState ( RstpBridgePort port,
RstpPpmState  newState 
)

Update PPM state machine state.

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

Definition at line 145 of file rstp_ppm.c.

◆ rstpPpmFsm()

void rstpPpmFsm ( RstpBridgePort port)

PPM state machine implementation.

Parameters
[in]portPointer to the bridge port context

Definition at line 71 of file rstp_ppm.c.

◆ rstpPpmInit()

void rstpPpmInit ( RstpBridgePort port)

PPM state machine initialization.

Parameters
[in]portPointer to the bridge port context

Definition at line 59 of file rstp_ppm.c.