rstp_pim.h
Go to the documentation of this file.
1 /**
2  * @file rstp_pim.h
3  * @brief Port Information state machine (PIM)
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_PIM_H
32 #define _RSTP_PIM_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 Port Information machine states
45  **/
46 
47 typedef enum
48 {
60 
61 
62 //RSTP related functions
66 
67 //C++ guard
68 #ifdef __cplusplus
69 }
70 #endif
71 
72 #endif
uint16_t port
Definition: dns_common.h:267
RSTP (Rapid Spanning Tree Protocol)
#define RstpBridgePort
Definition: rstp.h:40
RstpPimState
Port Information machine states.
Definition: rstp_pim.h:48
@ 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
void rstpPimFsm(RstpBridgePort *port)
PIM state machine implementation.
Definition: rstp_pim.c:78
void rstpPimChangeState(RstpBridgePort *port, RstpPimState newState)
Update PIM state machine state.
Definition: rstp_pim.c:213
void rstpPimInit(RstpBridgePort *port)
PIM state machine initialization.
Definition: rstp_pim.c:66