rstp_pti.h File Reference

Port Timers state machine (PTI) More...

#include "rstp/rstp.h"

Go to the source code of this file.

Enumerations

enum  RstpPtiState { RSTP_PTI_STATE_ONE_SECOND = 0, RSTP_PTI_STATE_TICK = 1 }
 Port Timers machine states. More...
 

Functions

void rstpPtiInit (RstpBridgePort *port)
 PTI state machine initialization. More...
 
void rstpPtiFsm (RstpBridgePort *port)
 PTI state machine implementation. More...
 
void rstpPtiChangeState (RstpBridgePort *port, RstpPtiState newState)
 Update PTI state machine state. More...
 

Detailed Description

Port Timers state machine (PTI)

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

Definition in file rstp_pti.h.

Enumeration Type Documentation

◆ RstpPtiState

Port Timers machine states.

Enumerator
RSTP_PTI_STATE_ONE_SECOND 
RSTP_PTI_STATE_TICK 

Definition at line 47 of file rstp_pti.h.

Function Documentation

◆ rstpPtiChangeState()

void rstpPtiChangeState ( RstpBridgePort port,
RstpPtiState  newState 
)

Update PTI state machine state.

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

Definition at line 108 of file rstp_pti.c.

◆ rstpPtiFsm()

void rstpPtiFsm ( RstpBridgePort port)

PTI state machine implementation.

Parameters
[in]portPointer to the bridge port context

Definition at line 70 of file rstp_pti.c.

◆ rstpPtiInit()

void rstpPtiInit ( RstpBridgePort port)

PTI state machine initialization.

Parameters
[in]portPointer to the bridge port context

Definition at line 57 of file rstp_pti.c.