/************************************************************************
 * RSTP library - Rapid Spanning Tree (802.1t, 802.1w)
 * Copyright (C) 2001-2003 Optical Access
 * Author: Alex Rozin
 *
 * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 *
 * This file is part of RSTP library.
 *
 * RSTP library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; version 2.1
 *
 * RSTP library 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 Lesser
 * General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with RSTP library; see the file COPYING.  If not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 **********************************************************************/

#ifndef __STP_VECTORS_H__
#define __STP_VECTORS_H__

/* This file defines callback vectors to be supplied by library user */

/* In the best case: clean all Learning entries with
 the vlan_id and the port (if 'exclude'=0) or for all ports,
 exclude the port (if ''exclude'=1). If 'port'=0, delete all
 entries with the vlan_id, don't care to 'exclude'  */
typedef enum {
  LT_FLASH_ALL_PORTS_EXCLUDE_THIS,
  LT_FLASH_ONLY_THE_PORT
} LT_FLASH_TYPE_T;

struct stp_vectors {
        int (*flush_lt)(IN int port_index, IN int vlan_id,
            IN LT_FLASH_TYPE_T type, IN char* reason);

        /* for bridge id calculation */
        void (*get_port_mac) (IN int port_index, OUT unsigned char* mac);

        unsigned long (*get_port_oper_speed) (IN unsigned int portNo);

        /* 1- Up, 0- Down */
        int (*get_port_link_status) (IN int port_index);

        /* 1- Full, 0- Half */
        int (*get_duplex) (IN int port_index);

#ifdef STRONGLY_SPEC_802_1W
        int (*set_learning) (IN int port_index, IN int vlan_id, IN int enable);
        int (*set_forwarding) (IN int port_index, IN int vlan_id,
            IN int enable);
#else
/*
 * In many kinds of hardware the state of ports may
 * be changed with another method
 */
        int (*set_port_state) (IN int port_index, IN int vlan_id,
            IN RSTP_PORT_STATE state);
#endif

        int (*set_hardware_mode) (int vlan_id, UID_STP_MODE_T mode);
        int (*tx_bpdu) (IN int port_index, IN int vlan_id,
                 IN unsigned char* bpdu,
                 IN size_t bpdu_len);
        const char *(*get_port_name) (IN int port_index);
        int (*get_init_stpm_cfg) (IN int vlan_id,
            INOUT UID_STP_CFG_T* cfg);
        int (*get_init_port_cfg) (IN int vlan_id,
                IN int port_index,
                INOUT UID_STP_PORT_CFG_T* cfg);
        void (*trace)(const char *fmt, ...);
};

#ifndef __STP_VECTORS_T__
#define __STP_VECTORS_T__
typedef struct stp_vectors STP_VECTORS_T;
#endif

#ifdef __STP_INTERNAL__
extern STP_VECTORS_T *stp_vectors;
#endif

#endif /* __STP_VECTORS_H__ */