Pace-V5471/Kernel
1
0
Fork 0
Code Releases 1 Activity
Files
pace_v5471
Kernel/include/bcm963xx/bcmxtmcfg.h

500 lines
18 KiB
C
Raw Permalink Blame History

/*
<:copyright-BRCM:2007:DUAL/GPL:standard
Copyright (c) 2007 Broadcom Corporation
All Rights Reserved
Unless you and Broadcom execute a separate written software license
agreement governing use of this software, this software is licensed
to you under the terms of the GNU General Public License version 2
(the "GPL"), available at http://www.broadcom.com/licenses/GPLv2.php,
with the following added to such license:
As a special exception, the copyright holders of this software give
you permission to link this software with independent modules, and
to copy and distribute the resulting executable under terms of your
choice, provided that you also meet, for each linked independent
module, the terms and conditions of the license of that module.
An independent module is a module which is not derived from this
software. The special exception does not apply to any modifications
of the software.
Not withstanding the above, under no circumstances may you combine
this software in any way with any other Broadcom software provided
under a license other than the GPL, without Broadcom's express prior
written consent.
:>
*/
/***************************************************************************
* File Name : bcmxtmcfg.h
*
* Description: This file contains the definitions, structures and function
* prototypes for the Broadcom Asynchronous/Packet Transfer Mode
* (XTM) Configuration driver.
***************************************************************************/
#if !defined(_BCMXTMCFG_H_)
#define _BCMXTMCFG_H_
#if defined(__cplusplus)
extern "C" {
#endif
/***************************************************************************
* Constant Definitions
***************************************************************************/
/* Miscellaneous */
#define MAX_PHY_PORTS 4
#define MAX_SUB_PRIORITIES 8
#define MAX_PTM_PRIORITIES 2
#define MAX_BOND_GROUPS 1
#define MAX_BOND_PORTS 2
#define MAX_RECEIVE_QUEUES 2
#define MAX_TRANSMIT_QUEUES 16
#define NETWORK_DEVICE_NAME_SIZE 16
#if defined(CHIP_6368) || defined(CHIP_63268) || defined(CHIP_6828)
#define MAX_ATM_TRANSMIT_QUEUES 16
#else
#define MAX_ATM_TRANSMIT_QUEUES 8
#endif
#define MAX_PTM_TRANSMIT_QUEUES 8
/* Values for ulPortId and ulPortMask fields. */
#define PORT_PHY0_FAST 0x01
#define PORT_PHY0_INTERLEAVED 0x02
#define PORT_PHY1_FAST 0x04
#define PORT_PHY1_INTERLEAVED 0x08
#define PORT_PHY_INVALID 0xFF
#define PORT_PHY0_PATH0 0x01
#define PORT_PHY0_PATH1 0x02
#define PORT_PHY1_PATH0 0x04
#define PORT_PHY1_PATH1 0x08
/* For bonding, we work on absolutte port id assignments. It goes as follows.
* PTM bonding, port ids 0 & 1 will be bonded. Single latency only. No dual
* latency support.
* ATM bonding, port ids 0 & 1 will be bonded for single latency.
* ATM bonding, port ids 0&2, 1&3 will be bonded in dual latency mode.
*/
#define PHY_PORTID_0 0x00
#define PHY_PORTID_1 0x01
#define PHY_PORTID_2 0x02
#define PHY_PORTID_3 0x03
/* Conversions between port and port id. */
#define PORT_TO_PORTID(PORT) (UINT32) (1 << (PORT))
#define PORTID_TO_PORT(PORTID) (UINT32) \
(((PORTID) == PORT_PHY0_FAST) ? PHY_PORTID_0 : \
((PORTID) == PORT_PHY0_INTERLEAVED) ? PHY_PORTID_1 : \
((PORTID) == PORT_PHY1_FAST) ? PHY_PORTID_2 : \
((PORTID) == PORT_PHY1_INTERLEAVED) ? PHY_PORTID_3 : MAX_PHY_PORTS)
/* Values for XTM_INITIALIZATION_PARMS ulPortConfig. */
#define PC_INTERNAL_EXTERNAL_MASK 0x03
#define PC_ALL_INTERNAL 0x00
#define PC_ALL_EXTERNAL 0x01
#define PC_INTERNAL_EXTERNAL 0x02
#define PC_NEG_EDGE 0x04
/* Values for XTM_INITIALIZATION_PARMS sBondConfig */
#define BC_PTM_BONDING_ENABLE 0x01
#define BC_PTM_BONDING_DISABLE 0x00
#define BC_ATM_BONDING_ENABLE 0x01
#define BC_ATM_BONDING_DISABLE 0x00
#define BC_DUAL_LATENCY_ENABLE 0x01
#define BC_DUAL_LATENCY_DISABLE 0x00
#define BC_ATM_AUTO_SENSE_ENABLE 0x01
#define BC_ATM_AUTO_SENSE_DISABLE 0x00
#define BC_BOND_PROTO_NONE 0x00
#define BC_BOND_PROTO_G994_AGGR 0x01
#define BC_BOND_PROTO_ASM 0x02
#define BC_BOND_PROTO_BACP 0x03
#define BONDING_INVALID_GROUP_ID 0xFFFFFFFF
#define DATA_STATUS_DISABLED 0x0
#define DATA_STATUS_ENABLED 0x1
#define DATA_STATUS_RESET 0x2
/* Values for XTM_TRAFFIC_DESCR_PARM_ENTRY ulTrafficDescrType. */
#define TDT_ATM_NO_TRAFFIC_DESCRIPTOR 1
#define TDT_ATM_NO_CLP_NO_SCR 2
#define TDT_ATM_NO_CLP_SCR 5
#define TDT_ATM_CLP_NO_TAGGING_MCR 8
#define TDT_ATM_CLP_TRANSPARENT_NO_SCR 9
#define TDT_ATM_CLP_TRANSPARENT_SCR 10
#define TDT_ATM_NO_CLP_TAGGING_NO_SCR 11
#define TDT_ATM_PTM_MAX_BIT_RATE_SCR 16
/* Values for XTM_TRAFFIC_DESCR_PARM_ENTRY ulServiceCategory. */
#define SC_OTHER 1
#define SC_CBR 2
#define SC_RT_VBR 3
#define SC_NRT_VBR 4
#define SC_UBR 6
#define SC_MBR 7
/*Values for XTM_INTERFACE_CFG ulIfAdminStatus and XTM_CONN_CFG ulAdminStatus */
#define ADMSTS_UP 1
#define ADMSTS_DOWN 2
/* Values for XTM_INTERFACE_CFG ulIfOperStatus and XTM_CONN_CFG ulOperStatus. */
#define OPRSTS_UP 1
#define OPRSTS_DOWN 2
/* Values for XTM_INTERFACE_LINK_INFO ulLinkState. */
#define LINK_UP 1
#define LINK_DOWN 2
#define LINK_START_TEQ_DATA 3
#define LINK_STOP_TEQ_DATA 4
#define LINK_DS_DOWN 5
/* Values for XTM_ADDR ulTrafficType, XTM_INTERFACE_CFG usIfTrafficType and
* XTM_INTERFACE_LINK_INFO ulLinkTrafficType.
*/
#define TRAFFIC_TYPE_NOT_CONNECTED 0
#define TRAFFIC_TYPE_ATM_MASK 0x1
#define TRAFFIC_TYPE_ATM 1 /* Odd types for ATM... */
#define TRAFFIC_TYPE_ATM_BONDED 3
#define TRAFFIC_TYPE_ATM_TEQ 5
#define TRAFFIC_TYPE_PTM 2 /* Even types for PTM... */
#define TRAFFIC_TYPE_PTM_RAW 4
#define TRAFFIC_TYPE_PTM_BONDED 6
#define TRAFFIC_TYPE_PTM_TEQ 8
#define TRAFFIC_TYPE_TEQ (TRAFFIC_TYPE_ATM_TEQ|TRAFFIC_TYPE_PTM_TEQ)
/* Values for XTM_INTERFACE_CFG usIfSupportedTrafficTypes. */
#define SUPPORT_TRAFFIC_TYPE_ATM (1 << TRAFFIC_TYPE_ATM)
#define SUPPORT_TRAFFIC_TYPE_PTM (1 << TRAFFIC_TYPE_PTM)
#define SUPPORT_TRAFFIC_TYPE_PTM_RAW (1 << TRAFFIC_TYPE_PTM_RAW)
#define SUPPORT_TRAFFIC_TYPE_PTM_BONDED (1 << TRAFFIC_TYPE_PTM_BONDED)
#define SUPPORT_TRAFFIC_TYPE_ATM_BONDED (1 << TRAFFIC_TYPE_ATM_BONDED)
#define SUPPORT_TRAFFIC_TYPE_TEQ (1 << TRAFFIC_TYPE_TEQ)
/* Values for PTM_ADDR ulPtmPriority. */
#define PTM_PRI_LOW 0x01
#define PTM_PRI_HIGH 0x02
/* Values for XTM_TRANSMIT_QUEUE_PARMS ulWeightAlg. */
#define WA_DISABLED 0 /* disabled */
#define WA_CWRR 1 /* cell weighted round robin */
#define WA_PWRR 2 /* packet weighted round robin */
#define WA_WFQ 3 /* weighted fair queuing */
/* Values for XTM_CONN_CFG ulAtmAalType. */
#define AAL_TRANSPARENT 1
#define AAL_0_PACKET 2
#define AAL_0_CELL 3
#define AAL_5 7
/* Values for XTM_CONN_CFG header types. */
#define HT_TYPE_LLC_SNAP_ETHERNET 0x01 /* AA AA 03 00 80 C2 00 07 00 00 */
#define HT_TYPE_LLC_SNAP_ROUTE_IP 0x02 /* AA AA 03 00 00 00 08 00 */
#define HT_TYPE_LLC_ENCAPS_PPP 0x03 /* FE FE 03 CF */
#define HT_TYPE_VC_MUX_ETHERNET 0x04 /* 00 00 */
#define HT_TYPE_VC_MUX_IPOA 0x05 /* */
#define HT_TYPE_VC_MUX_PPPOA 0x06 /* */
#define HT_TYPE_PTM 0x07 /* */
/* Values for XTM_CONN_CFG header lengths. */
#define HT_LEN_LLC_SNAP_ETHERNET 10
#define HT_LEN_LLC_SNAP_ROUTE_IP 8
#define HT_LEN_LLC_ENCAPS_PPP 4
#define HT_LEN_VC_MUX_ETHERNET 2
#define HT_LEN_VC_MUX_PPPOA 0
#define HT_LEN_VC_MUX_IPOA 0
#define HT_LEN_PTM 0
/* Values for XTM_CONN_CFG ulHeaderType. */
#define HT_LLC_SNAP_ETHERNET \
(((UINT32) HT_TYPE_LLC_SNAP_ETHERNET << 16) | HT_LEN_LLC_SNAP_ETHERNET)
#define HT_LLC_SNAP_ROUTE_IP \
(((UINT32) HT_TYPE_LLC_SNAP_ROUTE_IP << 16) | HT_LEN_LLC_SNAP_ROUTE_IP)
#define HT_LLC_ENCAPS_PPP \
(((UINT32) HT_TYPE_LLC_ENCAPS_PPP << 16) | HT_LEN_LLC_ENCAPS_PPP)
#define HT_VC_MUX_ETHERNET \
(((UINT32) HT_TYPE_VC_MUX_ETHERNET << 16) | HT_LEN_VC_MUX_ETHERNET)
#define HT_VC_MUX_IPOA \
(((UINT32) HT_TYPE_VC_MUX_IPOA << 16) | HT_LEN_VC_MUX_IPOA)
#define HT_VC_MUX_PPPOA \
(((UINT32) HT_TYPE_VC_MUX_PPPOA << 16) | HT_LEN_VC_MUX_PPPOA)
#define HT_PTM \
(((UINT32) HT_TYPE_PTM << 16) | HT_LEN_PTM)
#define HT_TYPE(H) ((H >> 16) & 0xffff)
#define HT_LEN(H) (H & 0xffff)
/* Values for BcmXtm_SendOamCell ucCircuitType. */
#define CTYPE_OAM_F5_SEGMENT 0x00
#define CTYPE_OAM_F5_END_TO_END 0x01
#define CTYPE_OAM_F4_SEGMENT 0x02
#define CTYPE_OAM_F4_END_TO_END 0x03
#define CTYPE_ASM_P0 0x04
#define CTYPE_ASM_P1 0x05
#define CTYPE_ASM_P2 0x06
#define CTYPE_ASM_P3 0x07
/* Deviation */
#define XTM_DS_MIN_DEVIATION 2
#define XTM_DS_MAX_DEVIATION 128
#define XTM_RX_TEQ_PHY_PORT PHY_PORTID_3
/***************************************************************************
* Type Definitions
***************************************************************************/
/* Return status values. */
typedef enum BcmXtmStatus
{
XTMSTS_SUCCESS = 0,
XTMSTS_ERROR,
XTMSTS_STATE_ERROR,
XTMSTS_PARAMETER_ERROR,
XTMSTS_ALLOC_ERROR,
XTMSTS_RESOURCE_ERROR,
XTMSTS_IN_USE,
XTMSTS_NOT_FOUND,
XTMSTS_NOT_SUPPORTED,
XTMSTS_TIMEOUT,
XTMSTS_PROTO_ERROR
} BCMXTM_STATUS;
typedef struct AtmAddr
{
UINT32 ulPortMask;
UINT16 usVpi;
UINT16 usVci;
} ATM_ADDR, *PATM_ADDR;
typedef struct PtmAddr
{
UINT32 ulPortMask;
UINT32 ulPtmPriority;
} PTM_ADDR, *PPTM_ADDR;
typedef struct GenAddr
{
UINT32 ulPortMask;
UINT32 ulPtmPriority;
} GEN_ADDR, *PGEN_ADDR;
typedef struct XtmAddr
{
UINT32 ulTrafficType;
union
{
ATM_ADDR Vcc;
PTM_ADDR Flow;
GEN_ADDR Conn;
} u;
} XTM_ADDR, *PXTM_ADDR;
typedef union _XtmBondConfig {
struct _sConfig {
UINT32 ptmBond : 1 ;
UINT32 atmBond : 1 ;
UINT32 bondProto : 1 ; /* For PTM, BACP (Bonding Aggr Cont Protocol)
For ATM, ASM based (as defined in G998.1) */
UINT32 dualLat : 1 ;
UINT32 autoSenseAtm : 1 ; /* Needed to auto sense between ATM bonded/Non-bonded types */
UINT32 resv : 27 ;
} sConfig ;
UINT32 uConfig ;
} XtmBondConfig ;
typedef struct XtmInitialization
{
UINT32 ulReceiveQueueSizes[MAX_RECEIVE_QUEUES];
UINT32 ulPortConfig;
XtmBondConfig bondConfig ;
} XTM_INITIALIZATION_PARMS, *PXTM_INITIALIZATION_PARMS;
typedef struct XtmInterfaceCfg
{
UINT32 ulIfAdminStatus; /* UTOPIA enable/disable */
UINT32 ulIfOperStatus; /* read only */
UINT32 ulIfLastChange; /* read only */
UINT16 usIfSupportedTrafficTypes; /* read only */
UINT16 usIfTrafficType; /* read only */
UINT32 ulAtmInterfaceConfVccs; /* read only */
} XTM_INTERFACE_CFG, *PXTM_INTERFACE_CFG;
/* XTM_TRAFFIC_DESCR_PARM_ENTRY contains the fields needed to create a Traffic
* Descriptor Table parameter entry.
*/
typedef struct XtmTrafficDescrParmEntry
{
UINT32 ulTrafficDescrIndex;
UINT32 ulTrafficDescrType;
UINT32 ulPcr;
UINT32 ulScr;
UINT32 ulMbs;
UINT32 ulMcr;
UINT32 ulServiceCategory;
} XTM_TRAFFIC_DESCR_PARM_ENTRY, *PXTM_TRAFFIC_DESCR_PARM_ENTRY;
typedef struct XtmTransmitQueueParms
{
UINT32 ulPortId;
UINT32 ulPtmPriority;
UINT32 ulWeightAlg; /* per packet arbitration for a PVC */
UINT32 ulWeightValue;
UINT32 ulSubPriority;
UINT32 ulSize;
UINT32 ulMinBitRate; /* 0 indicates no shaping */
UINT32 ulShapingRate; /* 0 indicates no shaping */
UINT16 usShapingBurstSize;
UINT16 usQosQId;
UINT32 ulBondingPortId; /* read-only. Necessary for PTM bonding and not for
ATM bonding, as for PTM bonding, Flow Buffer/port
intermediate between Tx DMA channels and the Utopia
ports when scheduling, each flow buffer needs to be
configured/port. */
} XTM_TRANSMIT_QUEUE_PARMS, *PXTM_TRANSMIT_QUEUE_PARMS;
typedef struct XtmConnArb
{
UINT32 ulWeightAlg; /* per cell arbitration among PVCs */
UINT32 ulWeightValue;
UINT32 ulSubPriority;
} XTM_CONN_ARB, *PXTM_CONN_ARB;
typedef struct XtmConnCfg
{
UINT32 ulAtmAalType;
UINT32 ulAdminStatus;
UINT32 ulOperStatus; /* read only */
UINT32 ulLastChange; /* read only */
UINT32 ulTransmitTrafficDescrIndex;
UINT32 ulHeaderType;
XTM_CONN_ARB ConnArbs[MAX_PHY_PORTS][MAX_PTM_PRIORITIES];
UINT32 ulTransmitQParmsSize;
XTM_TRANSMIT_QUEUE_PARMS TransmitQParms[MAX_TRANSMIT_QUEUES];
} XTM_CONN_CFG, *PXTM_CONN_CFG;
typedef struct XtmInterfaceStats
{
UINT32 ulIfInOctets;
UINT32 ulIfOutOctets;
UINT32 ulIfInPackets;
UINT32 ulIfOutPackets;
UINT32 ulIfInOamRmCells;
UINT32 ulIfOutOamRmCells;
UINT32 ulIfInAsmCells;
UINT32 ulIfOutAsmCells;
UINT32 ulIfInCellErrors;
UINT32 ulIfInPacketErrors;
} XTM_INTERFACE_STATS, *PXTM_INTERFACE_STATS;
typedef struct XtmInterfaceLinkInfo
{
UINT32 ulLinkState;
UINT32 ulLinkUsRate;
UINT32 ulLinkDsRate;
UINT32 ulLinkTrafficType;
} XTM_INTERFACE_LINK_INFO, *PXTM_INTERFACE_LINK_INFO;
typedef struct XtmOamCellInfo
{
UINT8 ucCircuitType;
UINT32 ulTimeout;
UINT32 ulRepetition;
UINT32 ulSent;
UINT32 ulReceived;
UINT32 ulMinRspTime;
UINT32 ulMaxRspTime;
UINT32 ulAvgRspTime;
} XTM_OAM_CELL_INFO, *PXTM_OAM_CELL_INFO;
typedef struct _XtmPortInfo {
UINT32 ulInterfaceId ;
UINT32 linkState ;
UINT32 usRate ; /* in bps */
UINT32 dsRate ; /* in bps */
UINT32 usDelay ; /* in milli sec */
UINT32 dsDelay ; /* in milli sec */
} XTM_PORT_INFO, *PXTM_PORT_INFO ;
typedef struct XtmBondGroupInfo {
UINT32 ulGroupId ;
XTM_PORT_INFO portInfo [MAX_BOND_PORTS] ;
UINT32 aggrUSRate ;
UINT32 aggrDSRate ;
UINT32 diffUSDelay ;
UINT32 diffDSDelay ;
UINT32 dataStatus ;
} XTM_BOND_GROUP_INFO, *PXTM_BOND_GROUP_INFO ;
typedef struct XtmBondInfo {
UINT8 u8MajorVersion ;
UINT8 u8MinorVersion ;
UINT16 u8BuildVersion ;
UINT32 ulTrafficType ;
UINT32 ulBondProto ;
UINT32 ulNumGroups ;
XTM_BOND_GROUP_INFO grpInfo [MAX_BOND_GROUPS] ;
} XTM_BOND_INFO, *PXTM_BOND_INFO ;
/***************************************************************************
* Function Prototypes
***************************************************************************/
#ifndef FAP_4KE
BCMXTM_STATUS BcmXtm_Initialize( PXTM_INITIALIZATION_PARMS pInitParms );
BCMXTM_STATUS BcmXtm_Uninitialize( void );
BCMXTM_STATUS BcmXtm_GetTrafficDescrTable( PXTM_TRAFFIC_DESCR_PARM_ENTRY
pTrafficDescTable, UINT32 *pulTrafficDescrTableSize );
BCMXTM_STATUS BcmXtm_SetTrafficDescrTable( PXTM_TRAFFIC_DESCR_PARM_ENTRY
pTrafficDescTable, UINT32 ulTrafficDescrTableSize );
BCMXTM_STATUS BcmXtm_GetInterfaceCfg( UINT32 ulPortId, PXTM_INTERFACE_CFG
pInterfaceCfg );
BCMXTM_STATUS BcmXtm_SetInterfaceCfg( UINT32 ulPortId, PXTM_INTERFACE_CFG
pInterfaceCfg );
BCMXTM_STATUS BcmXtm_GetConnCfg( PXTM_ADDR pConnAddr, PXTM_CONN_CFG pConnCfg );
BCMXTM_STATUS BcmXtm_SetConnCfg( PXTM_ADDR pConnAddr, PXTM_CONN_CFG pConnCfg );
BCMXTM_STATUS BcmXtm_GetConnAddrs( PXTM_ADDR pConnAddrs, UINT32 *pulNumConns );
BCMXTM_STATUS BcmXtm_GetInterfaceStatistics( UINT32 ulPortId,
PXTM_INTERFACE_STATS pStatistics, UINT32 ulReset );
BCMXTM_STATUS BcmXtm_SetInterfaceLinkInfo( UINT32 ulPortId,
PXTM_INTERFACE_LINK_INFO pLinkInfo );
BCMXTM_STATUS BcmXtm_SendOamCell( PXTM_ADDR pConnAddr,
PXTM_OAM_CELL_INFO pOamCellInfo);
BCMXTM_STATUS BcmXtm_CreateNetworkDevice( PXTM_ADDR pConnAddr,
char *pszNetworkDeviceName );
BCMXTM_STATUS BcmXtm_DeleteNetworkDevice( PXTM_ADDR pConnAddr );
BCMXTM_STATUS BcmXtm_GetBondingInfo ( PXTM_BOND_INFO pBondingInfo) ;
BCMXTM_STATUS BcmXtm_ReInitialize( void );
BCMXTM_STATUS BcmXtm_SetDsPtmBondingDeviation ( UINT32 ulDeviation ) ;
#define XTM_USE_DSL_MIB /* needed for dsl line monitoring */
#if defined(CONFIG_BCM963268)
#define XTM_USE_DSL_SYSCTL /* needed for XTM traffic/mode sensing functionality */
#endif
#endif /* FAP_4KE */
#if defined(__cplusplus)
}
#endif
#endif /* _BCMXTMCFG_H_ */
View Git Blame Copy Permalink