rstp_tcm.h
Go to the documentation of this file.
1 /**
2  * @file rstp_tcm.h
3  * @brief Topology change state machine (TCM)
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2019-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneSTP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.0
29  **/
30 
31 #ifndef _RSTP_TCM_H
32 #define _RSTP_TCM_H
33 
34 //Dependencies
35 #include "rstp/rstp.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 
43 /**
44  * @brief Topology Change machine states
45  **/
46 
47 typedef enum
48 {
58 
59 
60 //RSTP related functions
64 
65 //C++ guard
66 #ifdef __cplusplus
67 }
68 #endif
69 
70 #endif
uint16_t port
Definition: dns_common.h:267
RSTP (Rapid Spanning Tree Protocol)
#define RstpBridgePort
Definition: rstp.h:40
void rstpTcmChangeState(RstpBridgePort *port, RstpTcmState newState)
Update TCM state machine state.
Definition: rstp_tcm.c:189
RstpTcmState
Topology Change machine states.
Definition: rstp_tcm.h:48
@ RSTP_TCM_STATE_INACTIVE
Definition: rstp_tcm.h:49
@ RSTP_TCM_STATE_ACKNOWLEDGED
Definition: rstp_tcm.h:55
@ RSTP_TCM_STATE_ACTIVE
Definition: rstp_tcm.h:56
@ RSTP_TCM_STATE_LEARNING
Definition: rstp_tcm.h:50
@ RSTP_TCM_STATE_DETECTED
Definition: rstp_tcm.h:51
@ RSTP_TCM_STATE_NOTIFIED_TCN
Definition: rstp_tcm.h:52
@ RSTP_TCM_STATE_PROPAGATING
Definition: rstp_tcm.h:54
@ RSTP_TCM_STATE_NOTIFIED_TC
Definition: rstp_tcm.h:53
void rstpTcmFsm(RstpBridgePort *port)
TCM state machine implementation.
Definition: rstp_tcm.c:76
void rstpTcmInit(RstpBridgePort *port)
TCM state machine initialization.
Definition: rstp_tcm.c:64