openSUSE Build Service

Overview Repositories Revisions Requests Users Attributes Meta

File dcb_types.h of Package open-fcoe

/*******************************************************************************

Intel Data Center Bridging (DCB) Software
  Copyright(c) 2007-2008 Intel Corporation.

This program is free software; you can redistribute it and/or modify it
  under the terms and conditions of the GNU General Public License,
  version 2, as published by the Free Software Foundation.

This program is distributed in the hope 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 St - Fifth Floor, Boston, MA 02110-1301 USA.

The full GNU General Public License is included in this distribution in
  the file called "COPYING".

Contact Information:
  e1000-eedc Mailing List <e1000-eedc@lists.sourceforge.net>
  Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497

*******************************************************************************/

#ifndef _DCB_CLIENT_IF_TYPES_H_
#define _DCB_CLIENT_IF_TYPES_H_

#include "dcb_osdep.h"

#define MAX_USER_PRIORITIES       8
#define MAX_BANDWIDTH_GROUPS      8
#define MAX_TRAFFIC_CLASSES       8
#define SHORT_STRING              20
#define MAX_DESCRIPTION_LEN       100

#define LINK_STRICT_PGID          15

#define DEF_BCN_DERVD_WEIGHT      16        /* 1 = 0.125 unitless */
#define MIN_BCN_DERVD_WEIGHT      1
#define MAX_BCN_DERVD_WEIGHT      64

#define DEF_BCN_INC_GAIN          0.53      /* unitless gain */
#define DEF_BCN_DEC_GAIN          0.00026   /* unitless gain */
#define DEF_BCN_MAX_DEC           0.5       /* unitless gain */
#define DEF_BCN_MAX_INC           0.1       /* unitless gain */
#define MIN_BCN_DELTA             0.0       /* unitless gain */
#define MAX_BCN_DELTA             1.0

#define DEF_BCN_RATE_UNIT         1         /* 1 = 1 Mbps */
#define MIN_BCN_RATE_UNIT         1
#define MAX_BCN_RATE_UNIT         100

#define DEF_BCN_INITIAL_RATE      5000      /* 1 = 1 Mbps */
#define MIN_BCN_INITIAL_RATE      0
#define MAX_BCN_INITIAL_RATE      10000

#define DEF_BCN_DRIFT_TIMER       100       /* 1 = 1 usec */
#define MIN_BCN_DRIFT_TIMER       1
#define MAX_BCN_DRIFT_TIMER       10000

#define DEF_BCN_DRIFT_INC         1         /* 1 = 1 Mbps */
#define MIN_BCN_DRIFT_INC         1
#define MAX_BCN_DRIFT_INC         100

#define DEF_BCN_BKOFF_TMR_RNG     100       /* 1 = 1 usec */
#define MIN_BCN_BKOFF_TMR_RNG     1
#define MAX_BCN_BKOFF_TMR_RNG     1000000

#define DEF_BCN_RESTRT_RATE       100       /* 1 = 1 Mbps */
#define MIN_BCN_RESTRT_RATE       1
#define MAX_BCN_RESTRT_RATE       1000

#define DEF_BCN_RTT_AVG_WEIGHT    9         /* unitless weighting */
#define MIN_BCN_RTT_AVG_WEIGHT    0
#define MAX_BCN_RTT_AVG_WEIGHT    10

#define BCN_ADDR_OPTION_LEN       8         /* 8 hex digits */
#define BCN_ADDR_OPTION_BYTES     34        /* bytes for 8 hex digits plus NULL */
#define BCN_CP_SAMP_INTERVAL      140000

/* DCBX subtypes */
typedef enum {
	dcbx_subtype1 = 1,
	dcbx_subtype2,
} dcbx_subtype;

/* PFC configuration */
typedef enum {
	pfc_disabled   = 0x000,
	pfc_enabled,
	pfc_invalid,
} pfc_type;

/* Peer DCB TLV States */
typedef enum {
	DCB_PEER_NONE  = 0x000,
	DCB_PEER_PRESENT,
	DCB_PEER_EXPIRED,
	DCB_PEER_RESET,
} peer_dcb_tlv_state;

typedef pfc_type dcb_pfc_type;\

typedef enum {
	dcb_none       = 0x0000,
	dcb_group,
	dcb_link,
	dcb_invalid,
} dcb_strict_priority_type;

typedef u64 dcb_stat_count;

typedef pfc_type dcb_pfc_list_type[MAX_USER_PRIORITIES];

typedef struct dcb_user_priority_attribs {
	u8 tcmap;
	u8 pgid;
	u8 percent_of_pg_cap;
	dcb_strict_priority_type   strict_priority;
} dcb_user_priority_attribs_type;

typedef struct dcb_traffic_attribs {
	u8 pg_percent[MAX_BANDWIDTH_GROUPS]; /* percent of link */
	dcb_user_priority_attribs_type up[MAX_USER_PRIORITIES];
} dcb_traffic_attribs_type;

typedef struct dcb_stats{
	u64 in_frames;
	u64 out_frames;
	u64 in_octets;
	u64 out_octets;
	u64 in_overflow_discards;
	u64 out_overflow_discards;
} dcb_stats_type;

typedef struct dcb_pfc_stats_type{
	u64 in_pauses;
	u64 out_pauses;
	u64 transitions;
} dcb_pfc_stats_type;

/* Define protocol and feature version that we support */
#define DCB_MAX_VERSION         0
#define DCB_PG_MAX_VERSION      0
#define DCB_PFC_MAX_VERSION     0
#define DCB_APPTLV_MAX_VERSION  0
#define DCB_BCN_MAX_VERSION     0
#define DCB_LLINK_MAX_VERSION   0

#define DCB_START_SEQ_NUMBER    0

/*  Definitions for dcb protocol event Flags. */
#define DCB_LOCAL_CHANGE_PG      0x00000001
#define DCB_LOCAL_CHANGE_PFC     0x00000002
#define DCB_LOCAL_CHANGE_APPTLV  0x00000004
#define DCB_REMOTE_CHANGE_PG     0x00000008
#define DCB_REMOTE_CHANGE_PFC    0x00000010
#define DCB_REMOTE_CHANGE_APPTLV 0x00000020
#define DCB_LOCAL_CHANGE_BCN     0x00000040
#define DCB_REMOTE_CHANGE_BCN    0x00000080
#define DCB_LOCAL_CHANGE_LLINK   0x00000100
#define DCB_REMOTE_CHANGE_LLINK  0x00000200
#define DCB_EVENT_FLAGS          0x00000FFF

/* Maximum APP TLVs supported */
#define DCB_MAX_APPTLV           1
#define DCB_MAX_LLKTLV           1

/* DCB SubTypes */
#define DEFAULT_SUBTYPE               0
#define APP_FCOE_STYPE                0
#define APP_FCOE_STYPE_LEN            1
#define LLINK_FCOE_STYPE              0

/* Max TLV length */
#define DCB_MAX_TLV_LENGTH          507

/* Definitions for different data store. */
#define LOCAL_STORE                 0x00000001
#define PEER_STORE                  0x00000002
#define OPER_STORE                  0x00000004
#define DATA_STORE_FLAGS            0x0000000F

#define MAX_DEVICE_NAME_LEN         256 /* NDIS supports 256 */
#define MAC_ADDR_LEN                6
#define LLDP_RXPKT_LEN              2300

/* DCB Feature and control states */
#define DCB_NSTATES                 3

#define DCB_CLOSED                  0    /* closed */
#define DCB_INIT                    1    /* Initialization */
#define DCB_LISTEN                  2    /* listening for peer */

/* Flags */
#define DCB_SET_FLAGS(_FlagsVar, _BitsToSet)    \
		(_FlagsVar) = (_FlagsVar) | (_BitsToSet)

#define DCB_TEST_FLAGS(_FlagsVar, _Mask, _BitsToCheck)    \
		(((_FlagsVar) & (_Mask)) == (_BitsToCheck))

/* Field Error_Flag for feature Oper_state_config */
typedef struct feature_protocol_attribs {
	boolean_t Enable;
	boolean_t Willing;
	boolean_t Advertise;
	boolean_t Advertise_prev;
	boolean_t OperMode;
	/* PeerWilling: Only used for Local data. */
	boolean_t PeerWilling;
	boolean_t Error;
	boolean_t Syncd;
	u32 Oper_version;
	u32 Max_version;
	u32 FeatureSeqNo;
	boolean_t TLVPresent; /* for Peer data */
	boolean_t tlv_sent;  /* for local config */
	u8 dcbx_st;
	u16 State;
	u8 Error_Flag; /* bitmap for returned oper_state errors */
} feature_protocol_attribs;

typedef struct control_protocol_attribs {
	u32 Oper_version;
	u32 Max_version;
	u32 SeqNo;
	u32 AckNo;
	u32 MyAckNo;
	peer_dcb_tlv_state RxDCBTLVState; /* for Peer data */
	u16 State;
} control_protocol_attribs;

typedef struct pg_attribs {
	feature_protocol_attribs protocol;
	dcb_traffic_attribs_type tx;
	dcb_traffic_attribs_type rx;
	u8 num_tcs;
} pg_attribs;

typedef struct pfc_attribs {
	feature_protocol_attribs    protocol;
	dcb_pfc_list_type      admin;
	u8 num_tcs;
} pfc_attribs;

typedef char dcb_descript[MAX_DESCRIPTION_LEN];

typedef struct pg_info {
	u8 max_pgid_desc;
	dcb_descript pgid_desc[MAX_BANDWIDTH_GROUPS];
} pg_info;

typedef struct bcn_cfg {
	u8 bcna[BCN_ADDR_OPTION_LEN];/* CM-Tag BCNA field */
	struct {
		boolean_t cp_admin;     /* CP admin mode */
		boolean_t rp_admin;     /* RP admin mode */
		boolean_t rp_oper;      /* RP Operational mode */
		boolean_t rem_tag_oper; /* Remove CM tag Operational mode */
	}bcn_up_settings[MAX_USER_PRIORITIES]; /* Index is user priority */
	double rp_alpha; /* RP max decrease factor */
	double rp_beta;  /* RP max increase factor */
	double rp_gd;    /* RP decrement coefficient */
	double rp_gi;    /* RP increment coefficient */
	u32 rp_tmax;     /* RP max time to backoff after BCN0 */
	u32 cp_sf;       /* CP sampling interval fixed - Not used by driver */
	u32 rp_c;        /* RP link capacity */
	u32 rp_ri;       /* RP initial rate */
	u16 rp_td;       /* RP drift interval */
	u16 rp_rmin;     /* RP default rate after 1st BCN0 */
	u8 rp_w;         /* RP derivate rate */
	u8 rp_rd;        /* RP drift factor */
	u8 rp_ru;        /* RP rate unit */
	u8 rp_wrtt;      /* RP RTT moving average weight */ 
} bcn_cfg;

typedef struct bcn_attribs {
	feature_protocol_attribs protocol;
	bcn_cfg bcn;
} bcn_attribs;

typedef struct app_attribs {
	feature_protocol_attribs protocol;
	u32 Length;
	u8  AppData[DCB_MAX_TLV_LENGTH];
} app_attribs;

typedef struct llink_cfg {
	u8 llink_status; 
} llink_cfg;

typedef struct llink_attribs {
	feature_protocol_attribs protocol;
	llink_cfg llink;
} llink_attribs;

typedef struct full_dcb_attribs {
	pg_attribs pg;
	pfc_attribs pfc;
	pg_info descript;
	app_attribs app[DCB_MAX_APPTLV];
	bcn_attribs bcn;
	llink_attribs llink[DCB_MAX_LLKTLV];
} full_dcb_attribs;

typedef struct full_dcb_attrib_ptrs {
	pg_attribs *pg;
	pfc_attribs *pfc;
	pg_info *pgid;
	app_attribs *app;
	u8 app_subtype;
	bcn_attribs *bcn;
	llink_attribs *llink;
	u8 llink_subtype;
} full_dcb_attrib_ptrs;

typedef struct feature_support {
	/* non-zero indicates support */
	u8  pg;         /* priority groups */
	u8  pfc;        /* priority flow control */
	u8  bcn;        /* backward congestion notification */

/* non-zero indicates support */
	u8  up2tc_mappable; /* abilty to map priorities to traffic classes */
	u8  gsp;        /* group strict priority */

/* Each bit represents a number of traffic classes supported by the hw.
	 * If 4 or 8 traffic classes can be configured, then the value is 0x88.
	 */
	u8  traffic_classes;
	u8  pfc_traffic_classes;
} feature_support;

#endif /* DCB_CLIENT_IF_TYPES_H_ */

Places

File dcb_types.h of Package open-fcoe

Places