Staging: bcm: Remove typedef for _stServiceFlowParamSI and call directly.
[deliverable/linux.git] / drivers / staging / bcm / cntrl_SignalingInterface.h
CommitLineData
f8942e07
SH
1#ifndef CNTRL_SIGNALING_INTERFACE_
2#define CNTRL_SIGNALING_INTERFACE_
3
8f413fe6
KM
4#define DSA_REQ 11
5#define DSA_RSP 12
6#define DSA_ACK 13
7#define DSC_REQ 14
8#define DSC_RSP 15
9#define DSC_ACK 16
10#define DSD_REQ 17
11#define DSD_RSP 18
12#define DSD_ACK 19
13#define MAX_CLASSIFIERS_IN_SF 4
14
15#define MAX_STRING_LEN 20
16#define MAX_PHS_LENGTHS 255
17#define VENDOR_PHS_PARAM_LENGTH 10
18#define MAX_NUM_ACTIVE_BS 10
19#define AUTH_TOKEN_LENGTH 10
957d7cdc
KM
20#define NUM_HARQ_CHANNELS 16 /* Changed from 10 to 16 to accommodate all HARQ channels */
21#define VENDOR_CLASSIFIER_PARAM_LENGTH 1 /* Changed the size to 1 byte since we dnt use it */
8f413fe6
KM
22#define VENDOR_SPECIF_QOS_PARAM 1
23#define VENDOR_PHS_PARAM_LENGTH 10
24#define MBS_CONTENTS_ID_LENGTH 10
25#define GLOBAL_SF_CLASSNAME_LENGTH 6
26
27#define TYPE_OF_SERVICE_LENGTH 3
28#define IP_MASKED_SRC_ADDRESS_LENGTH 32
29#define IP_MASKED_DEST_ADDRESS_LENGTH 32
30#define PROTOCOL_SRC_PORT_RANGE_LENGTH 4
31#define PROTOCOL_DEST_PORT_RANGE_LENGTH 4
32#define ETHERNET_DEST_MAC_ADDR_LENGTH 12
33#define ETHERNET_SRC_MAC_ADDR_LENGTH 12
34#define NUM_ETHERTYPE_BYTES 3
35#define NUM_IPV6_FLOWLABLE_BYTES 3
f8942e07 36
957d7cdc
KM
37/*
38 * structure Definitions
39 *
40 * brief class cCPacketClassificationRule
41 */
8f413fe6 42struct _stCPacketClassificationRuleSI {
957d7cdc 43 /* 16bit UserPriority Of The Service Flow */
8f413fe6 44 B_UINT16 u16UserPriority;
957d7cdc 45 /* 16bit VLANID Of The Service Flow */
8f413fe6 46 B_UINT16 u16VLANID;
957d7cdc 47 /* 16bit Packet Classification RuleIndex Of The Service Flow */
8f413fe6 48 B_UINT16 u16PacketClassificationRuleIndex;
957d7cdc 49 /* 8bit Classifier Rule Priority Of The Service Flow */
8f413fe6 50 B_UINT8 u8ClassifierRulePriority;
957d7cdc 51 /* Length of IP TypeOfService field */
8f413fe6 52 B_UINT8 u8IPTypeOfServiceLength;
957d7cdc 53 /* 3bytes IP TypeOfService */
8f413fe6 54 B_UINT8 u8IPTypeOfService[TYPE_OF_SERVICE_LENGTH];
957d7cdc 55 /* Protocol used in classification of Service Flow */
8f413fe6 56 B_UINT8 u8Protocol;
957d7cdc 57 /* Length of IP Masked Source Address */
8f413fe6 58 B_UINT8 u8IPMaskedSourceAddressLength;
957d7cdc 59 /* IP Masked Source Address used in classification for the Service Flow */
8f413fe6 60 B_UINT8 u8IPMaskedSourceAddress[IP_MASKED_SRC_ADDRESS_LENGTH];
957d7cdc 61 /* Length of IP Destination Address */
8f413fe6 62 B_UINT8 u8IPDestinationAddressLength;
957d7cdc 63 /* IP Destination Address used in classification for the Service Flow */
8f413fe6 64 B_UINT8 u8IPDestinationAddress[IP_MASKED_DEST_ADDRESS_LENGTH];
957d7cdc 65 /* Length of Protocol Source Port Range */
8f413fe6 66 B_UINT8 u8ProtocolSourcePortRangeLength;
957d7cdc 67 /* Protocol Source Port Range used in the Service Flow */
8f413fe6 68 B_UINT8 u8ProtocolSourcePortRange[PROTOCOL_SRC_PORT_RANGE_LENGTH];
957d7cdc 69 /* Length of Protocol Dest Port Range */
8f413fe6 70 B_UINT8 u8ProtocolDestPortRangeLength;
957d7cdc 71 /* Protocol Dest Port Range used in the Service Flow */
8f413fe6 72 B_UINT8 u8ProtocolDestPortRange[PROTOCOL_DEST_PORT_RANGE_LENGTH];
957d7cdc 73 /* Length of Ethernet Destination MAC Address */
8f413fe6 74 B_UINT8 u8EthernetDestMacAddressLength;
957d7cdc 75 /* Ethernet Destination MAC Address used in classification of the Service Flow */
8f413fe6 76 B_UINT8 u8EthernetDestMacAddress[ETHERNET_DEST_MAC_ADDR_LENGTH];
957d7cdc 77 /* Length of Ethernet Source MAC Address */
8f413fe6 78 B_UINT8 u8EthernetSourceMACAddressLength;
957d7cdc 79 /* Ethernet Source MAC Address used in classification of the Service Flow */
8f413fe6 80 B_UINT8 u8EthernetSourceMACAddress[ETHERNET_SRC_MAC_ADDR_LENGTH];
957d7cdc 81 /* Length of Ethertype */
8f413fe6 82 B_UINT8 u8EthertypeLength;
957d7cdc 83 /* 3bytes Ethertype Of The Service Flow */
8f413fe6 84 B_UINT8 u8Ethertype[NUM_ETHERTYPE_BYTES];
957d7cdc 85 /* 8bit Associated PHSI Of The Service Flow */
8f413fe6 86 B_UINT8 u8AssociatedPHSI;
957d7cdc 87 /* Length of Vendor Specific Classifier Param length Of The Service Flow */
8f413fe6 88 B_UINT8 u8VendorSpecificClassifierParamLength;
957d7cdc 89 /* Vendor Specific Classifier Param Of The Service Flow */
8f413fe6 90 B_UINT8 u8VendorSpecificClassifierParam[VENDOR_CLASSIFIER_PARAM_LENGTH];
957d7cdc 91 /* Length Of IPv6 Flow Lable of the Service Flow */
8f413fe6 92 B_UINT8 u8IPv6FlowLableLength;
957d7cdc 93 /* IPv6 Flow Lable Of The Service Flow */
8f413fe6 94 B_UINT8 u8IPv6FlowLable[NUM_IPV6_FLOWLABLE_BYTES];
957d7cdc 95 /* Action associated with the classifier rule */
8f413fe6
KM
96 B_UINT8 u8ClassifierActionRule;
97 B_UINT16 u16ValidityBitMap;
f8942e07 98};
8f413fe6 99typedef struct _stCPacketClassificationRuleSI CCPacketClassificationRuleSI, stCPacketClassificationRuleSI, *pstCPacketClassificationRuleSI;
f8942e07 100
957d7cdc 101/* brief class CPhsRuleSI */
f8942e07 102typedef struct _stPhsRuleSI {
957d7cdc 103 /* 8bit PHS Index Of The Service Flow */
8f413fe6 104 B_UINT8 u8PHSI;
957d7cdc 105 /* PHSF Length Of The Service Flow */
8f413fe6 106 B_UINT8 u8PHSFLength;
957d7cdc 107 /* String of bytes containing header information to be suppressed by the sending CS and reconstructed by the receiving CS */
8f413fe6 108 B_UINT8 u8PHSF[MAX_PHS_LENGTHS];
957d7cdc 109 /* PHSM Length Of The Service Flow */
8f413fe6 110 B_UINT8 u8PHSMLength;
957d7cdc 111 /* PHS Mask for the SF */
8f413fe6 112 B_UINT8 u8PHSM[MAX_PHS_LENGTHS];
957d7cdc 113 /* 8bit Total number of bytes to be suppressed for the Service Flow */
8f413fe6 114 B_UINT8 u8PHSS;
957d7cdc 115 /* 8bit Indicates whether or not Packet Header contents need to be verified prior to suppression */
8f413fe6 116 B_UINT8 u8PHSV;
957d7cdc 117 /* Vendor Specific PHS param Length Of The Service Flow */
8f413fe6 118 B_UINT8 u8VendorSpecificPHSParamsLength;
957d7cdc 119 /* Vendor Specific PHS param Of The Service Flow */
8f413fe6
KM
120 B_UINT8 u8VendorSpecificPHSParams[VENDOR_PHS_PARAM_LENGTH];
121 B_UINT8 u8Padding[2];
122} stPhsRuleSI, *pstPhsRuleSI;
f8942e07 123typedef stPhsRuleSI CPhsRuleSI;
f8942e07 124
957d7cdc 125/* brief structure cConvergenceSLTypes */
8f413fe6 126struct _stConvergenceSLTypes {
957d7cdc 127 /* 8bit Phs Classfier Action Of The Service Flow */
8f413fe6 128 B_UINT8 u8ClassfierDSCAction;
957d7cdc 129 /* 8bit Phs DSC Action Of The Service Flow */
8f413fe6 130 B_UINT8 u8PhsDSCAction;
957d7cdc 131 /* 16bit Padding */
8f413fe6 132 B_UINT8 u8Padding[2];
957d7cdc 133 /* brief class cCPacketClassificationRule */
8f413fe6 134 stCPacketClassificationRuleSI cCPacketClassificationRule;
957d7cdc 135 /* brief class CPhsRuleSI */
8f413fe6 136 struct _stPhsRuleSI cPhsRule;
f8942e07 137};
8f413fe6 138typedef struct _stConvergenceSLTypes stConvergenceSLTypes, CConvergenceSLTypes, *pstConvergenceSLTypes;
f8942e07 139
b766fb15 140struct bcm_connect_mgr_params {
957d7cdc 141 /* 32bitSFID Of The Service Flow */
8f413fe6 142 B_UINT32 u32SFID;
957d7cdc 143 /* 32bit Maximum Sustained Traffic Rate of the Service Flow */
8f413fe6 144 B_UINT32 u32MaxSustainedTrafficRate;
957d7cdc 145 /* 32bit Maximum Traffic Burst allowed for the Service Flow */
8f413fe6 146 B_UINT32 u32MaxTrafficBurst;
957d7cdc 147 /* 32bit Minimum Reserved Traffic Rate of the Service Flow */
8f413fe6 148 B_UINT32 u32MinReservedTrafficRate;
957d7cdc 149 /* 32bit Tolerated Jitter of the Service Flow */
8f413fe6 150 B_UINT32 u32ToleratedJitter;
957d7cdc 151 /* 32bit Maximum Latency of the Service Flow */
8f413fe6 152 B_UINT32 u32MaximumLatency;
957d7cdc 153 /* 16bitCID Of The Service Flow */
8f413fe6 154 B_UINT16 u16CID;
957d7cdc 155 /* 16bit SAID on which the service flow being set up shall be mapped */
8f413fe6 156 B_UINT16 u16TargetSAID;
957d7cdc 157 /* 16bit ARQ window size negotiated */
8f413fe6 158 B_UINT16 u16ARQWindowSize;
957d7cdc 159 /* 16bit Total Tx delay incl sending, receiving & processing delays */
8f413fe6 160 B_UINT16 u16ARQRetryTxTimeOut;
957d7cdc 161 /* 16bit Total Rx delay incl sending, receiving & processing delays */
8f413fe6 162 B_UINT16 u16ARQRetryRxTimeOut;
957d7cdc 163 /* 16bit ARQ block lifetime */
8f413fe6 164 B_UINT16 u16ARQBlockLifeTime;
957d7cdc 165 /* 16bit ARQ Sync loss timeout */
8f413fe6 166 B_UINT16 u16ARQSyncLossTimeOut;
957d7cdc 167 /* 16bit ARQ Purge timeout */
8f413fe6 168 B_UINT16 u16ARQRxPurgeTimeOut;
957d7cdc
KM
169 /* TODO::Remove this once we move to a new CORR2 driver
170 * brief Size of an ARQ block
171 */
8f413fe6 172 B_UINT16 u16ARQBlockSize;
957d7cdc
KM
173 /* #endif */
174 /* 16bit Nominal interval b/w consecutive SDU arrivals at MAC SAP */
8f413fe6 175 B_UINT16 u16SDUInterArrivalTime;
957d7cdc 176 /* 16bit Specifies the time base for rate measurement */
8f413fe6 177 B_UINT16 u16TimeBase;
957d7cdc 178 /* 16bit Interval b/w Successive Grant oppurtunities */
8f413fe6 179 B_UINT16 u16UnsolicitedGrantInterval;
957d7cdc 180 /* 16bit Interval b/w Successive Polling grant oppurtunities */
8f413fe6 181 B_UINT16 u16UnsolicitedPollingInterval;
957d7cdc 182 /* internal var to get the overhead */
8f413fe6 183 B_UINT16 u16MacOverhead;
957d7cdc 184 /* MBS contents Identifier */
8f413fe6 185 B_UINT16 u16MBSContentsID[MBS_CONTENTS_ID_LENGTH];
957d7cdc 186 /* MBS contents Identifier length */
8f413fe6 187 B_UINT8 u8MBSContentsIDLength;
957d7cdc 188 /* ServiceClassName Length Of The Service Flow */
8f413fe6 189 B_UINT8 u8ServiceClassNameLength;
957d7cdc 190 /* 32bytes ServiceClassName Of The Service Flow */
8f413fe6 191 B_UINT8 u8ServiceClassName[32];
957d7cdc 192 /* 8bit Indicates whether or not MBS service is requested for this Serivce Flow */
8f413fe6 193 B_UINT8 u8MBSService;
957d7cdc 194 /* 8bit QOS Parameter Set specifies proper application of QoS parameters to Provisioned, Admitted and Active sets */
8f413fe6 195 B_UINT8 u8QosParamSet;
957d7cdc 196 /* 8bit Traffic Priority Of the Service Flow */
8f413fe6 197 B_UINT8 u8TrafficPriority;
957d7cdc 198 /* 8bit Uplink Grant Scheduling Type of The Service Flow */
8f413fe6 199 B_UINT8 u8ServiceFlowSchedulingType;
957d7cdc 200 /* 8bit Request transmission Policy of the Service Flow */
8f413fe6 201 B_UINT8 u8RequesttransmissionPolicy;
957d7cdc 202 /* 8bit Specifies whether SDUs for this Service flow are of FixedLength or Variable length */
8f413fe6 203 B_UINT8 u8FixedLengthVSVariableLengthSDUIndicator;
957d7cdc 204 /* 8bit Length of the SDU for a fixed length SDU service flow */
8f413fe6 205 B_UINT8 u8SDUSize;
957d7cdc 206 /* 8bit Indicates whether or not ARQ is requested for this connection */
8f413fe6 207 B_UINT8 u8ARQEnable;
957d7cdc 208 /* < 8bit Indicates whether or not data has tobe delivered in order to higher layer */
8f413fe6 209 B_UINT8 u8ARQDeliverInOrder;
957d7cdc 210 /* 8bit Receiver ARQ ACK processing time */
8f413fe6 211 B_UINT8 u8RxARQAckProcessingTime;
957d7cdc 212 /* 8bit Convergence Sublayer Specification Of The Service Flow */
8f413fe6 213 B_UINT8 u8CSSpecification;
957d7cdc 214 /* 8 bit Type of data delivery service */
8f413fe6 215 B_UINT8 u8TypeOfDataDeliveryService;
957d7cdc 216 /* 8bit Specifies whether a service flow may generate Paging */
8f413fe6 217 B_UINT8 u8PagingPreference;
957d7cdc 218 /* 8bit Indicates the MBS Zone through which the connection or virtual connection is valid */
8f413fe6 219 B_UINT8 u8MBSZoneIdentifierassignment;
957d7cdc 220 /* 8bit Specifies whether traffic on SF should generate MOB_TRF_IND to MS in sleep mode */
8f413fe6 221 B_UINT8 u8TrafficIndicationPreference;
957d7cdc 222 /* 8bit Speciifes the length of predefined Global QoS parameter set encoding for this SF */
8f413fe6 223 B_UINT8 u8GlobalServicesClassNameLength;
957d7cdc 224 /* 6 byte Speciifes the predefined Global QoS parameter set encoding for this SF */
8f413fe6 225 B_UINT8 u8GlobalServicesClassName[GLOBAL_SF_CLASSNAME_LENGTH];
957d7cdc 226 /* 8bit Indicates whether or not SN feedback is enabled for the conn */
8f413fe6 227 B_UINT8 u8SNFeedbackEnabled;
957d7cdc 228 /* Indicates the size of the Fragment Sequence Number for the connection */
8f413fe6 229 B_UINT8 u8FSNSize;
957d7cdc 230 /* 8bit Number of CIDs in active BS list */
8f413fe6 231 B_UINT8 u8CIDAllocation4activeBSsLength;
957d7cdc 232 /* CIDs of BS in the active list */
8f413fe6 233 B_UINT8 u8CIDAllocation4activeBSs[MAX_NUM_ACTIVE_BS];
957d7cdc 234 /* Specifies if PDU extended subheader should be applied on every PDU on this conn */
8f413fe6 235 B_UINT8 u8PDUSNExtendedSubheader4HarqReordering;
957d7cdc 236 /* 8bit Specifies whether the connection uses HARQ or not */
8f413fe6 237 B_UINT8 u8HARQServiceFlows;
957d7cdc 238 /* Specifies the length of Authorization token */
8f413fe6 239 B_UINT8 u8AuthTokenLength;
957d7cdc 240 /* Specifies the Authorization token */
8f413fe6 241 B_UINT8 u8AuthToken[AUTH_TOKEN_LENGTH];
957d7cdc 242 /* specifes Number of HARQ channels used to carry data length */
8f413fe6 243 B_UINT8 u8HarqChannelMappingLength;
957d7cdc 244 /* specifes HARQ channels used to carry data */
8f413fe6 245 B_UINT8 u8HARQChannelMapping[NUM_HARQ_CHANNELS];
957d7cdc 246 /* 8bit Length of Vendor Specific QoS Params */
8f413fe6 247 B_UINT8 u8VendorSpecificQoSParamLength;
957d7cdc 248 /* 1byte Vendor Specific QoS Param Of The Service Flow */
8f413fe6 249 B_UINT8 u8VendorSpecificQoSParam[VENDOR_SPECIF_QOS_PARAM];
957d7cdc
KM
250 /* indicates total classifiers in the SF */
251 B_UINT8 u8TotalClassifiers; /* < Total number of valid classifiers */
252 B_UINT8 bValid; /* < Validity flag */
253 B_UINT8 u8Padding; /* < Padding byte */
254/*
255 * Structure for Convergence SubLayer Types with a maximum of 4 classifiers
256 */
8f413fe6 257 stConvergenceSLTypes cConvergenceSLTypes[MAX_CLASSIFIERS_IN_SF];
b766fb15 258};
f8942e07 259
fc1ad162 260struct bcm_add_request {
957d7cdc
KM
261 B_UINT8 u8Type; /* < Type */
262 B_UINT8 eConnectionDir; /* < Connection direction */
263 /* brief 16 bit TID */
264 B_UINT16 u16TID; /* < 16bit TID */
265 /* brief 16bitCID */
266 B_UINT16 u16CID; /* < 16bit CID */
267 /* brief 16bitVCID */
268 B_UINT16 u16VCID; /* < 16bit VCID */
b766fb15 269 struct bcm_connect_mgr_params *psfParameterSet; /* < connection manager parameters */
fc1ad162 270};
f8942e07 271
da529f0f 272struct bcm_add_indication {
957d7cdc
KM
273 B_UINT8 u8Type; /* < Type */
274 B_UINT8 eConnectionDir; /* < Connection Direction */
275 /* brief 16 bit TID */
276 B_UINT16 u16TID; /* < TID */
277 /* brief 16bitCID */
278 B_UINT16 u16CID; /* < 16bitCID */
279 /* brief 16bitVCID */
280 B_UINT16 u16VCID; /* < 16bitVCID */
b766fb15
KM
281 struct bcm_connect_mgr_params *psfAuthorizedSet; /* Authorized set of connection manager parameters */
282 struct bcm_connect_mgr_params *psfAdmittedSet; /* Admitted set of connection manager parameters */
283 struct bcm_connect_mgr_params *psfActiveSet; /* Activeset of connection manager parameters */
957d7cdc
KM
284 B_UINT8 u8CC; /* <Confirmation Code */
285 B_UINT8 u8Padd; /* < 8-bit Padding */
286 B_UINT16 u16Padd; /* < 16 bit Padding */
da529f0f 287};
f8942e07 288
ec5bb992 289struct bcm_del_request {
957d7cdc
KM
290 B_UINT8 u8Type; /* < Type */
291 B_UINT8 u8Padding; /* < Padding byte */
292 B_UINT16 u16TID; /* < TID */
293 /* brief 32bitSFID */
294 B_UINT32 u32SFID; /* < SFID */
ec5bb992 295};
f8942e07 296
de473db1 297struct bcm_del_indication {
957d7cdc
KM
298 B_UINT8 u8Type; /* < Type */
299 B_UINT8 u8Padding; /* < Padding */
300 B_UINT16 u16TID; /* < TID */
301 /* brief 16bitCID */
302 B_UINT16 u16CID; /* < CID */
303 /* brief 16bitVCID */
304 B_UINT16 u16VCID; /* < VCID */
305 /* brief 32bitSFID */
306 B_UINT32 u32SFID; /* < SFID */
307 /* brief 8bit Confirmation code */
308 B_UINT8 u8ConfirmationCode; /* < Confirmation code */
309 B_UINT8 u8Padding1[3]; /* < 3 byte Padding */
de473db1 310};
f8942e07 311
f34170c7 312struct bcm_stim_sfhostnotify {
957d7cdc
KM
313 B_UINT32 SFID; /* SFID of the service flow */
314 B_UINT16 newCID; /* the new/changed CID */
315 B_UINT16 VCID; /* Get new Vcid if the flow has been made active in CID update TLV, but was inactive earlier or the orig vcid */
316 B_UINT8 RetainSF; /* Indication to Host if the SF is to be retained or deleted; if TRUE-retain else delete */
317 B_UINT8 QoSParamSet; /* QoS paramset of the retained SF */
318 B_UINT16 u16reserved; /* For byte alignment */
f34170c7 319};
f8942e07
SH
320
321#endif
This page took 0.19604 seconds and 5 git commands to generate.