xref: /titanic_52/usr/src/lib/librstp/common/stp_vectors.h (revision 4eaa471005973e11a6110b69fe990530b3b95a38)
1*4eaa4710SRishi Srivatsavai /************************************************************************
2*4eaa4710SRishi Srivatsavai  * RSTP library - Rapid Spanning Tree (802.1t, 802.1w)
3*4eaa4710SRishi Srivatsavai  * Copyright (C) 2001-2003 Optical Access
4*4eaa4710SRishi Srivatsavai  * Author: Alex Rozin
5*4eaa4710SRishi Srivatsavai  *
6*4eaa4710SRishi Srivatsavai  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
7*4eaa4710SRishi Srivatsavai  * Use is subject to license terms.
8*4eaa4710SRishi Srivatsavai  *
9*4eaa4710SRishi Srivatsavai  * This file is part of RSTP library.
10*4eaa4710SRishi Srivatsavai  *
11*4eaa4710SRishi Srivatsavai  * RSTP library is free software; you can redistribute it and/or modify it
12*4eaa4710SRishi Srivatsavai  * under the terms of the GNU Lesser General Public License as published by the
13*4eaa4710SRishi Srivatsavai  * Free Software Foundation; version 2.1
14*4eaa4710SRishi Srivatsavai  *
15*4eaa4710SRishi Srivatsavai  * RSTP library is distributed in the hope that it will be useful, but
16*4eaa4710SRishi Srivatsavai  * WITHOUT ANY WARRANTY; without even the implied warranty of
17*4eaa4710SRishi Srivatsavai  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser
18*4eaa4710SRishi Srivatsavai  * General Public License for more details.
19*4eaa4710SRishi Srivatsavai  *
20*4eaa4710SRishi Srivatsavai  * You should have received a copy of the GNU Lesser General Public License
21*4eaa4710SRishi Srivatsavai  * along with RSTP library; see the file COPYING.  If not, write to the Free
22*4eaa4710SRishi Srivatsavai  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
23*4eaa4710SRishi Srivatsavai  * 02111-1307, USA.
24*4eaa4710SRishi Srivatsavai  **********************************************************************/
25*4eaa4710SRishi Srivatsavai 
26*4eaa4710SRishi Srivatsavai #ifndef __STP_VECTORS_H__
27*4eaa4710SRishi Srivatsavai #define	__STP_VECTORS_H__
28*4eaa4710SRishi Srivatsavai 
29*4eaa4710SRishi Srivatsavai /* This file defines callback vectors to be supplied by library user */
30*4eaa4710SRishi Srivatsavai 
31*4eaa4710SRishi Srivatsavai /* In the best case: clean all Learning entries with
32*4eaa4710SRishi Srivatsavai  the vlan_id and the port (if 'exclude'=0) or for all ports,
33*4eaa4710SRishi Srivatsavai  exclude the port (if ''exclude'=1). If 'port'=0, delete all
34*4eaa4710SRishi Srivatsavai  entries with the vlan_id, don't care to 'exclude'  */
35*4eaa4710SRishi Srivatsavai typedef enum {
36*4eaa4710SRishi Srivatsavai   LT_FLASH_ALL_PORTS_EXCLUDE_THIS,
37*4eaa4710SRishi Srivatsavai   LT_FLASH_ONLY_THE_PORT
38*4eaa4710SRishi Srivatsavai } LT_FLASH_TYPE_T;
39*4eaa4710SRishi Srivatsavai 
40*4eaa4710SRishi Srivatsavai struct stp_vectors {
41*4eaa4710SRishi Srivatsavai 	int (*flush_lt)(IN int port_index, IN int vlan_id,
42*4eaa4710SRishi Srivatsavai 	    IN LT_FLASH_TYPE_T type, IN char* reason);
43*4eaa4710SRishi Srivatsavai 
44*4eaa4710SRishi Srivatsavai 	/* for bridge id calculation */
45*4eaa4710SRishi Srivatsavai 	void (*get_port_mac) (IN int port_index, OUT unsigned char* mac);
46*4eaa4710SRishi Srivatsavai 
47*4eaa4710SRishi Srivatsavai 	unsigned long (*get_port_oper_speed) (IN unsigned int portNo);
48*4eaa4710SRishi Srivatsavai 
49*4eaa4710SRishi Srivatsavai 	/* 1- Up, 0- Down */
50*4eaa4710SRishi Srivatsavai 	int (*get_port_link_status) (IN int port_index);
51*4eaa4710SRishi Srivatsavai 
52*4eaa4710SRishi Srivatsavai 	/* 1- Full, 0- Half */
53*4eaa4710SRishi Srivatsavai 	int (*get_duplex) (IN int port_index);
54*4eaa4710SRishi Srivatsavai 
55*4eaa4710SRishi Srivatsavai #ifdef STRONGLY_SPEC_802_1W
56*4eaa4710SRishi Srivatsavai 	int (*set_learning) (IN int port_index, IN int vlan_id, IN int enable);
57*4eaa4710SRishi Srivatsavai 	int (*set_forwarding) (IN int port_index, IN int vlan_id,
58*4eaa4710SRishi Srivatsavai 	    IN int enable);
59*4eaa4710SRishi Srivatsavai #else
60*4eaa4710SRishi Srivatsavai /*
61*4eaa4710SRishi Srivatsavai  * In many kinds of hardware the state of ports may
62*4eaa4710SRishi Srivatsavai  * be changed with another method
63*4eaa4710SRishi Srivatsavai  */
64*4eaa4710SRishi Srivatsavai 	int (*set_port_state) (IN int port_index, IN int vlan_id,
65*4eaa4710SRishi Srivatsavai 	    IN RSTP_PORT_STATE state);
66*4eaa4710SRishi Srivatsavai #endif
67*4eaa4710SRishi Srivatsavai 
68*4eaa4710SRishi Srivatsavai 	int (*set_hardware_mode) (int vlan_id, UID_STP_MODE_T mode);
69*4eaa4710SRishi Srivatsavai 	int (*tx_bpdu) (IN int port_index, IN int vlan_id,
70*4eaa4710SRishi Srivatsavai                  IN unsigned char* bpdu,
71*4eaa4710SRishi Srivatsavai                  IN size_t bpdu_len);
72*4eaa4710SRishi Srivatsavai 	const char *(*get_port_name) (IN int port_index);
73*4eaa4710SRishi Srivatsavai 	int (*get_init_stpm_cfg) (IN int vlan_id,
74*4eaa4710SRishi Srivatsavai 	    INOUT UID_STP_CFG_T* cfg);
75*4eaa4710SRishi Srivatsavai 	int (*get_init_port_cfg) (IN int vlan_id,
76*4eaa4710SRishi Srivatsavai 		IN int port_index,
77*4eaa4710SRishi Srivatsavai 		INOUT UID_STP_PORT_CFG_T* cfg);
78*4eaa4710SRishi Srivatsavai 	void (*trace)(const char *fmt, ...);
79*4eaa4710SRishi Srivatsavai };
80*4eaa4710SRishi Srivatsavai 
81*4eaa4710SRishi Srivatsavai #ifndef __STP_VECTORS_T__
82*4eaa4710SRishi Srivatsavai #define __STP_VECTORS_T__
83*4eaa4710SRishi Srivatsavai typedef struct stp_vectors STP_VECTORS_T;
84*4eaa4710SRishi Srivatsavai #endif
85*4eaa4710SRishi Srivatsavai 
86*4eaa4710SRishi Srivatsavai #ifdef __STP_INTERNAL__
87*4eaa4710SRishi Srivatsavai extern STP_VECTORS_T *stp_vectors;
88*4eaa4710SRishi Srivatsavai #endif
89*4eaa4710SRishi Srivatsavai 
90*4eaa4710SRishi Srivatsavai #endif /* __STP_VECTORS_H__ */
91