rstp_prs.h File Reference

Port Role Selection state machine (PRS) More...

#include "rstp/rstp.h"

Go to the source code of this file.

Enumerations

enum  RstpPrsState { RSTP_PRS_STATE_INIT_BRIDGE = 0, RSTP_PRS_STATE_ROLE_SELECTION = 1 }
 Port Role Selection machine states. More...
 

Functions

void rstpPrsInit (RstpBridgeContext *context)
 PRS state machine initialization. More...
 
void rstpPrsFsm (RstpBridgeContext *context)
 PRS state machine implementation. More...
 
void rstpPrsChangeState (RstpBridgeContext *context, RstpPrsState newState)
 Update PRS state machine state. More...
 

Detailed Description

Port Role Selection state machine (PRS)

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

Definition in file rstp_prs.h.

Enumeration Type Documentation

◆ RstpPrsState

Port Role Selection machine states.

Enumerator
RSTP_PRS_STATE_INIT_BRIDGE 
RSTP_PRS_STATE_ROLE_SELECTION 

Definition at line 47 of file rstp_prs.h.

Function Documentation

◆ rstpPrsChangeState()

void rstpPrsChangeState ( RstpBridgeContext context,
RstpPrsState  newState 
)

Update PRS state machine state.

Parameters
[in]contextPointer to the RSTP bridge context
[in]newStateNew state to switch to

Definition at line 117 of file rstp_prs.c.

◆ rstpPrsFsm()

void rstpPrsFsm ( RstpBridgeContext context)

PRS state machine implementation.

Parameters
[in]contextPointer to the RSTP bridge context

Definition at line 70 of file rstp_prs.c.

◆ rstpPrsInit()

void rstpPrsInit ( RstpBridgeContext context)

PRS state machine initialization.

Parameters
[in]contextPointer to the RSTP bridge context

Definition at line 58 of file rstp_prs.c.