rstp_pim.h

Go to the documentation of this file.

/**
 * @file rstp_pim.h
 * @brief Port Information state machine (PIM)
 *
 * @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_PIM_H
#define _RSTP_PIM_H
 
//Dependencies
#include "rstp/rstp.h"
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
/**
 * @brief Port Information machine states
 **/
 
typedef enum
{
   RSTP_PIM_STATE_DISABLED            = 0,
   RSTP_PIM_STATE_AGED                = 1,
   RSTP_PIM_STATE_UPDATE              = 2,
   RSTP_PIM_STATE_SUPERIOR_DESIGNATED = 3,
   RSTP_PIM_STATE_REPEATED_DESIGNATED = 4,
   RSTP_PIM_STATE_INFERIOR_DESIGNATED = 5,
   RSTP_PIM_STATE_NOT_DESIGNATED      = 6,
   RSTP_PIM_STATE_OTHER               = 7,
   RSTP_PIM_STATE_CURRENT             = 8,
   RSTP_PIM_STATE_RECEIVE             = 9
} RstpPimState;
 
 
//RSTP related functions
void rstpPimInit(RstpBridgePort *port);
void rstpPimFsm(RstpBridgePort *port);
void rstpPimChangeState(RstpBridgePort *port, RstpPimState newState);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif