rstp_pim.c File Reference

Port Information state machine (PIM) More...

#include "rstp/rstp.h"
#include "rstp/rstp_fsm.h"
#include "rstp/rstp_pim.h"
#include "rstp/rstp_procedures.h"
#include "rstp/rstp_misc.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   RSTP_TRACE_LEVEL
 

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

Variables

const RstpParamName rstpPimStates []
 

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

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   RSTP_TRACE_LEVEL

Definition at line 32 of file rstp_pim.c.

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.

Variable Documentation

◆ rstpPimStates

const RstpParamName rstpPimStates[]
Initial value:
=
{
{RSTP_PIM_STATE_DISABLED, "DISABLED"},
{RSTP_PIM_STATE_UPDATE, "UPDATE"},
{RSTP_PIM_STATE_SUPERIOR_DESIGNATED, "SUPERIOR_DESIGNATED"},
{RSTP_PIM_STATE_REPEATED_DESIGNATED, "REPEATED_DESIGNATED"},
{RSTP_PIM_STATE_INFERIOR_DESIGNATED, "INFERIOR_DESIGNATED"},
{RSTP_PIM_STATE_NOT_DESIGNATED, "NOT_DESIGNATED"},
{RSTP_PIM_STATE_CURRENT, "CURRENT"},
}
@ RSTP_PIM_STATE_CURRENT
Definition: rstp_pim.h:57
@ RSTP_PIM_STATE_NOT_DESIGNATED
Definition: rstp_pim.h:55
@ RSTP_PIM_STATE_INFERIOR_DESIGNATED
Definition: rstp_pim.h:54
@ RSTP_PIM_STATE_UPDATE
Definition: rstp_pim.h:51
@ RSTP_PIM_STATE_SUPERIOR_DESIGNATED
Definition: rstp_pim.h:52
@ RSTP_PIM_STATE_RECEIVE
Definition: rstp_pim.h:58
@ RSTP_PIM_STATE_DISABLED
Definition: rstp_pim.h:49
@ RSTP_PIM_STATE_REPEATED_DESIGNATED
Definition: rstp_pim.h:53
@ RSTP_PIM_STATE_OTHER
Definition: rstp_pim.h:56
@ RSTP_PIM_STATE_AGED
Definition: rstp_pim.h:50

Definition at line 46 of file rstp_pim.c.