rstp_tcm.h

Go to the documentation of this file.

/**
 * @file rstp_tcm.h
 * @brief Topology change state machine (TCM)
 *
 * @section 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
 **/
 
#ifndef _RSTP_TCM_H
#define _RSTP_TCM_H
 
//Dependencies
#include "rstp/rstp.h"
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
/**
 * @brief Topology Change machine states
 **/
 
typedef enum
{
   RSTP_TCM_STATE_INACTIVE     = 0,
   RSTP_TCM_STATE_LEARNING     = 1,
   RSTP_TCM_STATE_DETECTED     = 2,
   RSTP_TCM_STATE_NOTIFIED_TCN = 3,
   RSTP_TCM_STATE_NOTIFIED_TC  = 4,
   RSTP_TCM_STATE_PROPAGATING  = 5,
   RSTP_TCM_STATE_ACKNOWLEDGED = 6,
   RSTP_TCM_STATE_ACTIVE       = 7
} RstpTcmState;
 
 
//RSTP related functions
void rstpTcmInit(RstpBridgePort *port);
void rstpTcmFsm(RstpBridgePort *port);
void rstpTcmChangeState(RstpBridgePort *port, RstpTcmState newState);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif