rstp_pim.h File Reference

Port Information state machine (PIM) More...

#include "rstp/rstp.h"

Go to the source code of this file.

Enumerations

enum  RstpPimState {
  RSTP_PIM_STATE_DISABLED = 0 , RSTP_PIM_STATE_AGED = 1 , RSTP_PIM_STATE_UPDATE = 2 , RSTP_PIM_STATE_SUPERIOR_DESIGNATED = 3 ,
  RSTP_PIM_STATE_REPEATED_DESIGNATED = 4 , RSTP_PIM_STATE_INFERIOR_DESIGNATED = 5 , RSTP_PIM_STATE_NOT_DESIGNATED = 6 , RSTP_PIM_STATE_OTHER = 7 ,
  RSTP_PIM_STATE_CURRENT = 8 , RSTP_PIM_STATE_RECEIVE = 9
}
 Port Information machine states. More...
 

Functions

void rstpPimInit (RstpBridgePort *port)
 PIM state machine initialization. More...
 
void rstpPimFsm (RstpBridgePort *port)
 PIM state machine implementation. More...
 
void rstpPimChangeState (RstpBridgePort *port, RstpPimState newState)
 Update PIM state machine state. More...
 

Detailed Description

Port Information state machine (PIM)

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

Enumeration Type Documentation

◆ RstpPimState

Port Information machine states.

Enumerator
RSTP_PIM_STATE_DISABLED 
RSTP_PIM_STATE_AGED 
RSTP_PIM_STATE_UPDATE 
RSTP_PIM_STATE_SUPERIOR_DESIGNATED 
RSTP_PIM_STATE_REPEATED_DESIGNATED 
RSTP_PIM_STATE_INFERIOR_DESIGNATED 
RSTP_PIM_STATE_NOT_DESIGNATED 
RSTP_PIM_STATE_OTHER 
RSTP_PIM_STATE_CURRENT 
RSTP_PIM_STATE_RECEIVE 

Definition at line 47 of file rstp_pim.h.

Function Documentation

◆ rstpPimChangeState()

void rstpPimChangeState ( RstpBridgePort port,
RstpPimState  newState 
)

Update PIM state machine state.

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

Definition at line 213 of file rstp_pim.c.

◆ rstpPimFsm()

void rstpPimFsm ( RstpBridgePort port)

PIM state machine implementation.

Parameters
[in]portPointer to the bridge port context

Definition at line 78 of file rstp_pim.c.

◆ rstpPimInit()

void rstpPimInit ( RstpBridgePort port)

PIM state machine initialization.

Parameters
[in]portPointer to the bridge port context

Definition at line 66 of file rstp_pim.c.