home *** CD-ROM | disk | FTP | other *** search
/ PC Plus SuperCD (UK) 2000 May / PCP163A.iso / Runimage / Cbuilder4 / Include / WS2ATM.H < prev    next >
Encoding:
C/C++ Source or Header  |  1999-01-26  |  16.6 KB  |  462 lines
  1. /*++
  2.  
  3. Copyright 1997 - 1998 Microsoft Corporation
  4.  
  5. Module Name:
  6.  
  7.     ws2atm.h
  8.  
  9. Abstract:
  10.  
  11.     Winsock 2 ATM Annex definitions.
  12.  
  13. Revision History:
  14.  
  15. Notes:
  16.  
  17. --*/
  18.  
  19. #ifndef _WS2ATM_H_
  20. #pragma option push -b -a8 -pc -A- /*P_O_Push_S*/
  21. #define _WS2ATM_H_
  22.  
  23. #include <pshpack4.h>
  24.  
  25. #define ATMPROTO_AALUSER           0x00   /* User-defined AAL */
  26. #define ATMPROTO_AAL1              0x01   /* AAL 1 */
  27. #define ATMPROTO_AAL2              0x02   /* AAL 2 */
  28. #define ATMPROTO_AAL34             0x03   /* AAL 3/4 */
  29. #define ATMPROTO_AAL5              0x05   /* AAL 5 */
  30.  
  31. #define SAP_FIELD_ABSENT           0xFFFFFFFE
  32. #define SAP_FIELD_ANY              0xFFFFFFFF
  33. #define SAP_FIELD_ANY_AESA_SEL     0xFFFFFFFA
  34. #define SAP_FIELD_ANY_AESA_REST    0xFFFFFFFB
  35.  
  36. /* 
  37.  *  values used for AddressType in struct ATM_ADDRESS
  38.  */
  39. #define ATM_E164               0x01   /* E.164 addressing scheme */
  40. #define ATM_NSAP               0x02   /* NSAP-style ATM Endsystem Address scheme */
  41. #define ATM_AESA               0x02   /* NSAP-style ATM Endsystem Address scheme */
  42.  
  43. #define ATM_ADDR_SIZE          20     
  44. typedef struct {
  45.     DWORD AddressType;                /* E.164 or NSAP-style ATM Endsystem Address */
  46.     DWORD NumofDigits;                /* number of digits; */
  47.     UCHAR Addr[ATM_ADDR_SIZE];        /* IA5 digits for E164, BCD encoding for NSAP */
  48.                                       /* format as defined in the ATM Forum UNI 3.1 */
  49. } ATM_ADDRESS;
  50.  
  51. /* 
  52.  *  values used for Layer2Protocol in B-LLI
  53.  */
  54. #define BLLI_L2_ISO_1745           0x01   /* Basic mode ISO 1745                      */
  55. #define BLLI_L2_Q921               0x02   /* CCITT Rec. Q.921                         */
  56. #define BLLI_L2_X25L               0x06   /* CCITT Rec. X.25, link layer              */
  57. #define BLLI_L2_X25M               0x07   /* CCITT Rec. X.25, multilink               */
  58. #define BLLI_L2_ELAPB              0x08   /* Extended LAPB; for half duplex operation */
  59. #define BLLI_L2_HDLC_NRM           0x09   /* HDLC NRM (ISO 4335)                      */
  60. #define BLLI_L2_HDLC_ABM           0x0A   /* HDLC ABM (ISO 4335)                      */
  61. #define BLLI_L2_HDLC_ARM           0x0B   /* HDLC ARM (ISO 4335)                      */
  62. #define BLLI_L2_LLC                0x0C   /* LAN logical link control (ISO 8802/2)    */
  63. #define BLLI_L2_X75                0x0D   /* CCITT Rec. X.75, single link procedure   */
  64. #define BLLI_L2_Q922               0x0E   /* CCITT Rec. Q.922                         */
  65. #define BLLI_L2_USER_SPECIFIED     0x10   /* User Specified                           */
  66. #define BLLI_L2_ISO_7776           0x11   /* ISO 7776 DTE-DTE operation               */
  67.  
  68. /* 
  69.  *  values used for Layer3Protocol in B-LLI
  70.  */
  71. #define BLLI_L3_X25                0x06   /* CCITT Rec. X.25, packet layer            */
  72. #define BLLI_L3_ISO_8208           0x07   /* ISO/IEC 8208 (X.25 packet layer for DTE  */
  73. #define BLLI_L3_X223               0x08   /* X.223/ISO 8878                           */
  74. #define BLLI_L3_SIO_8473           0x09   /* ISO/IEC 8473 (OSI connectionless)        */
  75. #define BLLI_L3_T70                0x0A   /* CCITT Rec. T.70 min. network layer       */
  76. #define BLLI_L3_ISO_TR9577         0x0B   /* ISO/IEC TR 9577 Network Layer Protocol ID*/
  77. #define BLLI_L3_USER_SPECIFIED     0x10   /* User Specified                           */
  78.  
  79. /* 
  80.  *  values used for Layer3IPI in B-LLI
  81.  */
  82. #define BLLI_L3_IPI_SNAP           0x80   /* IEEE 802.1 SNAP identifier               */
  83. #define BLLI_L3_IPI_IP             0xCC   /* Internet Protocol (IP) identifier        */
  84.  
  85. typedef struct {
  86.     DWORD Layer2Protocol;                 /* User information layer 2 protocol           */
  87.     DWORD Layer2UserSpecifiedProtocol;    /* User specified layer 2 protocol information */
  88.     DWORD Layer3Protocol;                 /* User information layer 3 protocol           */
  89.     DWORD Layer3UserSpecifiedProtocol;    /* User specified layer 3 protocol information */
  90.     DWORD Layer3IPI;                      /* ISO/IEC TR 9577 Initial Protocol Identifier */
  91.     UCHAR SnapID[5];                      /* SNAP ID consisting of OUI and PID           */
  92. } ATM_BLLI;
  93.  
  94. /* 
  95.  *  values used for the HighLayerInfoType field in ATM_BHLI
  96.  */
  97. #define BHLI_ISO                   0x00   /* ISO                                 */
  98. #define BHLI_UserSpecific          0x01   /* User Specific                       */
  99. #define BHLI_HighLayerProfile      0x02   /* High layer profile (only in UNI3.0) */
  100. #define BHLI_VendorSpecificAppId   0x03   /* Vendor-Specific Application ID      */
  101.  
  102. typedef struct {
  103.     DWORD HighLayerInfoType;          /* High Layer Information Type      */
  104.     DWORD HighLayerInfoLength;        /* number of bytes in HighLayerInfo */
  105.     UCHAR HighLayerInfo[8];           /* the value dependent on the       */
  106.                                       /*   HighLayerInfoType field        */
  107. } ATM_BHLI;
  108.  
  109. typedef struct sockaddr_atm {
  110.     u_short satm_family;              /* address family should be AF_ATM  */
  111.     ATM_ADDRESS satm_number;          /* ATM address                      */
  112.     ATM_BLLI satm_blli;               /* B-LLI                            */
  113.     ATM_BHLI satm_bhli;               /* B-HLI                            */
  114. } sockaddr_atm, SOCKADDR_ATM, *PSOCKADDR_ATM, *LPSOCKADDR_ATM;
  115.  
  116. typedef enum {
  117.     IE_AALParameters,
  118.     IE_TrafficDescriptor,
  119.     IE_BroadbandBearerCapability,
  120.     IE_BHLI,
  121.     IE_BLLI,
  122.     IE_CalledPartyNumber,
  123.     IE_CalledPartySubaddress,
  124.     IE_CallingPartyNumber,
  125.     IE_CallingPartySubaddress,
  126.     IE_Cause,
  127.     IE_QOSClass,
  128.     IE_TransitNetworkSelection,
  129. } Q2931_IE_TYPE;
  130.  
  131. typedef struct {
  132.     Q2931_IE_TYPE IEType;
  133.     ULONG         IELength;
  134.     UCHAR         IE[1];
  135. } Q2931_IE;
  136.  
  137. /* 
  138.  *  manifest constants for the AALType field in struct AAL_PARAMETERS_IE
  139.  */
  140. typedef enum {
  141.     AALTYPE_5     = 5,   /* AAL 5 */
  142.     AALTYPE_USER  = 16,  /* user-defined AAL */
  143. } AAL_TYPE;
  144.  
  145. /* 
  146.  *  values used for the Mode field in struct AAL5_PARAMETERS
  147.  */
  148. #define AAL5_MODE_MESSAGE           0x01
  149. #define AAL5_MODE_STREAMING         0x02
  150.  
  151. /* 
  152.  *  values used for the SSCSType field in struct AAL5_PARAMETERS
  153.  */
  154. #define AAL5_SSCS_NULL              0x00
  155. #define AAL5_SSCS_SSCOP_ASSURED     0x01
  156. #define AAL5_SSCS_SSCOP_NON_ASSURED 0x02
  157. #define AAL5_SSCS_FRAME_RELAY       0x04
  158.  
  159. typedef struct {
  160.     ULONG ForwardMaxCPCSSDUSize;
  161.     ULONG BackwardMaxCPCSSDUSize;
  162.     UCHAR Mode;                        /* only available in UNI 3.0 */
  163.     UCHAR SSCSType;
  164. } AAL5_PARAMETERS;
  165.  
  166. typedef struct {
  167.     ULONG UserDefined;
  168. } AALUSER_PARAMETERS; 
  169.     
  170. typedef struct {
  171.     AAL_TYPE AALType;
  172.     union {
  173.         AAL5_PARAMETERS     AAL5Parameters;
  174.         AALUSER_PARAMETERS  AALUserParameters;
  175.     } AALSpecificParameters;
  176. } AAL_PARAMETERS_IE;
  177.  
  178. typedef struct {
  179.     ULONG PeakCellRate_CLP0;
  180.     ULONG PeakCellRate_CLP01;
  181.     ULONG SustainableCellRate_CLP0;
  182.     ULONG SustainableCellRate_CLP01;
  183.     ULONG MaxBurstSize_CLP0;
  184.     ULONG MaxBurstSize_CLP01;
  185.     BOOL  Tagging;
  186. } ATM_TD;
  187.  
  188. typedef struct {
  189.     ATM_TD Forward;
  190.     ATM_TD Backward;
  191.     BOOL   BestEffort;
  192. } ATM_TRAFFIC_DESCRIPTOR_IE;
  193.  
  194. /* 
  195.  *  values used for the BearerClass field in struct ATM_BROADBAND_BEARER_CAPABILITY_IE
  196.  */
  197. #define BCOB_A                   0x01   /* Bearer class A                      */
  198. #define BCOB_C                   0x03   /* Bearer class C                      */
  199. #define BCOB_X                   0x10   /* Bearer class X                      */
  200.  
  201. /* 
  202.  *  values used for the TrafficType field in struct ATM_BROADBAND_BEARER_CAPABILITY_IE
  203.  */
  204. #define TT_NOIND                 0x00   /* No indication of traffic type       */
  205. #define TT_CBR                   0x04   /* Constant bit rate                   */
  206. #define TT_VBR                   0x06   /* Variable bit rate                   */
  207.  
  208. /* 
  209.  *  values used for the TimingRequirements field in struct ATM_BROADBAND_BEARER_CAPABILITY_IE
  210.  */
  211. #define TR_NOIND                 0x00   /* No timing requirement indication    */
  212. #define TR_END_TO_END            0x01   /* End-to-end timing required          */
  213. #define TR_NO_END_TO_END         0x02   /* End-to-end timing not required      */
  214.  
  215. /* 
  216.  *  values used for the ClippingSusceptability field in struct ATM_BROADBAND_BEARER_CAPABILITY_IE
  217.  */
  218. #define CLIP_NOT                 0x00   /* Not susceptible to clipping         */
  219. #define CLIP_SUS                 0x20   /* Susceptible to clipping             */
  220.  
  221. /* 
  222.  *  values used for the UserPlaneConnectionConfig field in 
  223.  *  struct ATM_BROADBAND_BEARER_CAPABILITY_IE
  224.  */
  225. #define UP_P2P                   0x00   /* Point-to-point connection           */
  226. #define UP_P2MP                  0x01   /* Point-to-multipoint connection      */
  227.  
  228. typedef struct {
  229.     UCHAR BearerClass;
  230.     UCHAR TrafficType;
  231.     UCHAR TimingRequirements;
  232.     UCHAR ClippingSusceptability;
  233.     UCHAR UserPlaneConnectionConfig;
  234. } ATM_BROADBAND_BEARER_CAPABILITY_IE;
  235.  
  236. typedef ATM_BHLI ATM_BHLI_IE;
  237.  
  238. /* 
  239.  *  values used for the Layer2Mode field in struct ATM_BLLI_IE
  240.  */
  241. #define BLLI_L2_MODE_NORMAL         0x40
  242. #define BLLI_L2_MODE_EXT            0x80
  243.  
  244. /* 
  245.  *  values used for the Layer3Mode field in struct ATM_BLLI_IE
  246.  */
  247. #define BLLI_L3_MODE_NORMAL         0x40
  248. #define BLLI_L3_MODE_EXT            0x80
  249.  
  250. /* 
  251.  *  values used for the Layer3DefaultPacketSize field in struct ATM_BLLI_IE
  252.  */
  253. #define BLLI_L3_PACKET_16           0x04
  254. #define BLLI_L3_PACKET_32           0x05
  255. #define BLLI_L3_PACKET_64           0x06
  256. #define BLLI_L3_PACKET_128          0x07
  257. #define BLLI_L3_PACKET_256          0x08
  258. #define BLLI_L3_PACKET_512          0x09
  259. #define BLLI_L3_PACKET_1024         0x0A
  260. #define BLLI_L3_PACKET_2048         0x0B
  261. #define BLLI_L3_PACKET_4096         0x0C
  262.  
  263. typedef struct {
  264.     DWORD Layer2Protocol;                 /* User information layer 2 protocol           */
  265.     UCHAR Layer2Mode;
  266.     UCHAR Layer2WindowSize;
  267.     DWORD Layer2UserSpecifiedProtocol;    /* User specified layer 2 protocol information */
  268.     DWORD Layer3Protocol;                 /* User information layer 3 protocol           */
  269.     UCHAR Layer3Mode;
  270.     UCHAR Layer3DefaultPacketSize;
  271.     UCHAR Layer3PacketWindowSize;
  272.     DWORD Layer3UserSpecifiedProtocol;    /* User specified layer 3 protocol information */
  273.     DWORD Layer3IPI;                      /* ISO/IEC TR 9577 Initial Protocol Identifier */
  274.     UCHAR SnapID[5];                      /* SNAP ID consisting of OUI and PID           */
  275. } ATM_BLLI_IE;
  276.  
  277. typedef ATM_ADDRESS ATM_CALLED_PARTY_NUMBER_IE;
  278.  
  279. typedef ATM_ADDRESS ATM_CALLED_PARTY_SUBADDRESS_IE;
  280.  
  281. /* 
  282.  *  values used for the Presentation_Indication field in 
  283.  *  struct ATM_CALLING_PARTY_NUMBER_IE
  284.  */
  285. #define PI_ALLOWED                  0x00
  286. #define PI_RESTRICTED               0x40
  287. #define PI_NUMBER_NOT_AVAILABLE     0x80
  288.  
  289. /* 
  290.  *  values used for the Screening_Indicator field in 
  291.  *  struct ATM_CALLING_PARTY_NUMBER_IE
  292.  */
  293. #define SI_USER_NOT_SCREENED        0x00
  294. #define SI_USER_PASSED              0x01
  295. #define SI_USER_FAILED              0x02
  296. #define SI_NETWORK                  0x03
  297.  
  298. typedef struct {
  299.     ATM_ADDRESS ATM_Number;
  300.     UCHAR       Presentation_Indication;
  301.     UCHAR       Screening_Indicator;
  302. } ATM_CALLING_PARTY_NUMBER_IE;
  303.  
  304. typedef ATM_ADDRESS ATM_CALLING_PARTY_SUBADDRESS_IE;
  305.  
  306. /* 
  307.  *  values used for the Location field in struct ATM_CAUSE_IE
  308.  */
  309. #define CAUSE_LOC_USER                      0x00
  310. #define CAUSE_LOC_PRIVATE_LOCAL             0x01
  311. #define CAUSE_LOC_PUBLIC_LOCAL              0x02
  312. #define CAUSE_LOC_TRANSIT_NETWORK           0x03
  313. #define CAUSE_LOC_PUBLIC_REMOTE             0x04
  314. #define CAUSE_LOC_PRIVATE_REMOTE            0x05
  315. #define CAUSE_LOC_INTERNATIONAL_NETWORK     0x06
  316. #define CAUSE_LOC_BEYOND_INTERWORKING       0x0A
  317.  
  318. /* 
  319.  *  values used for the Cause field in struct ATM_CAUSE_IE
  320.  */
  321. #define CAUSE_UNALLOCATED_NUMBER                0x01
  322. #define CAUSE_NO_ROUTE_TO_TRANSIT_NETWORK       0x02
  323. #define CAUSE_NO_ROUTE_TO_DESTINATION           0x03
  324. #define CAUSE_VPI_VCI_UNACCEPTABLE              0x0A
  325. #define CAUSE_NORMAL_CALL_CLEARING              0x10
  326. #define CAUSE_USER_BUSY                         0x11
  327. #define CAUSE_NO_USER_RESPONDING                0x12
  328. #define CAUSE_CALL_REJECTED                     0x15
  329. #define CAUSE_NUMBER_CHANGED                    0x16
  330. #define CAUSE_USER_REJECTS_CLIR                 0x17
  331. #define CAUSE_DESTINATION_OUT_OF_ORDER          0x1B
  332. #define CAUSE_INVALID_NUMBER_FORMAT             0x1C
  333. #define CAUSE_STATUS_ENQUIRY_RESPONSE           0x1E
  334. #define CAUSE_NORMAL_UNSPECIFIED                0x1F
  335. #define CAUSE_VPI_VCI_UNAVAILABLE               0x23
  336. #define CAUSE_NETWORK_OUT_OF_ORDER              0x26
  337. #define CAUSE_TEMPORARY_FAILURE                 0x29
  338. #define CAUSE_ACCESS_INFORMAION_DISCARDED       0x2B
  339. #define CAUSE_NO_VPI_VCI_AVAILABLE              0x2D
  340. #define CAUSE_RESOURCE_UNAVAILABLE              0x2F
  341. #define CAUSE_QOS_UNAVAILABLE                   0x31
  342. #define CAUSE_USER_CELL_RATE_UNAVAILABLE        0x33
  343. #define CAUSE_BEARER_CAPABILITY_UNAUTHORIZED    0x39
  344. #define CAUSE_BEARER_CAPABILITY_UNAVAILABLE     0x3A
  345. #define CAUSE_OPTION_UNAVAILABLE                0x3F
  346. #define CAUSE_BEARER_CAPABILITY_UNIMPLEMENTED   0x41
  347. #define CAUSE_UNSUPPORTED_TRAFFIC_PARAMETERS    0x49
  348. #define CAUSE_INVALID_CALL_REFERENCE            0x51
  349. #define CAUSE_CHANNEL_NONEXISTENT               0x52
  350. #define CAUSE_INCOMPATIBLE_DESTINATION          0x58
  351. #define CAUSE_INVALID_ENDPOINT_REFERENCE        0x59
  352. #define CAUSE_INVALID_TRANSIT_NETWORK_SELECTION 0x5B
  353. #define CAUSE_TOO_MANY_PENDING_ADD_PARTY        0x5C
  354. #define CAUSE_AAL_PARAMETERS_UNSUPPORTED        0x5D
  355. #define CAUSE_MANDATORY_IE_MISSING              0x60
  356. #define CAUSE_UNIMPLEMENTED_MESSAGE_TYPE        0x61
  357. #define CAUSE_UNIMPLEMENTED_IE                  0x63
  358. #define CAUSE_INVALID_IE_CONTENTS               0x64
  359. #define CAUSE_INVALID_STATE_FOR_MESSAGE         0x65
  360. #define CAUSE_RECOVERY_ON_TIMEOUT               0x66
  361. #define CAUSE_INCORRECT_MESSAGE_LENGTH          0x68
  362. #define CAUSE_PROTOCOL_ERROR                    0x6F
  363.  
  364. /* 
  365.  *  values used for the Condition portion of the Diagnostics field
  366.  *  in struct ATM_CAUSE_IE, for certain Cause values
  367.  */
  368. #define CAUSE_COND_UNKNOWN                  0x00
  369. #define CAUSE_COND_PERMANENT                0x01
  370. #define CAUSE_COND_TRANSIENT                0x02
  371.  
  372. /* 
  373.  *  values used for the Rejection Reason portion of the Diagnostics field
  374.  *  in struct ATM_CAUSE_IE, for certain Cause values
  375.  */
  376. #define CAUSE_REASON_USER                   0x00
  377. #define CAUSE_REASON_IE_MISSING             0x04
  378. #define CAUSE_REASON_IE_INSUFFICIENT        0x08
  379.  
  380. /* 
  381.  *  values used for the P-U flag of the Diagnostics field
  382.  *  in struct ATM_CAUSE_IE, for certain Cause values
  383.  */
  384. #define CAUSE_PU_PROVIDER                   0x00
  385. #define CAUSE_PU_USER                       0x08
  386.  
  387. /* 
  388.  *  values used for the N-A flag of the Diagnostics field
  389.  *  in struct ATM_CAUSE_IE, for certain Cause values
  390.  */
  391. #define CAUSE_NA_NORMAL                     0x00
  392. #define CAUSE_NA_ABNORMAL                   0x04
  393.  
  394. typedef struct {
  395.     UCHAR Location;
  396.     UCHAR Cause;
  397.     UCHAR DiagnosticsLength;
  398.     UCHAR Diagnostics[4];
  399. } ATM_CAUSE_IE;
  400.  
  401. /* 
  402.  *  values used for the QOSClassForward and QOSClassBackward
  403.  *  field in struct ATM_QOS_CLASS_IE
  404.  */
  405. #define QOS_CLASS0                  0x00
  406. #define QOS_CLASS1                  0x01
  407. #define QOS_CLASS2                  0x02
  408. #define QOS_CLASS3                  0x03
  409. #define QOS_CLASS4                  0x04
  410.  
  411. typedef struct {
  412.     UCHAR QOSClassForward;
  413.     UCHAR QOSClassBackward;
  414. } ATM_QOS_CLASS_IE;
  415.  
  416. /* 
  417.  *  values used for the TypeOfNetworkId field in struct ATM_TRANSIT_NETWORK_SELECTION_IE
  418.  */
  419. #define TNS_TYPE_NATIONAL           0x40
  420.  
  421. /* 
  422.  *  values used for the NetworkIdPlan field in struct ATM_TRANSIT_NETWORK_SELECTION_IE
  423.  */
  424. #define TNS_PLAN_CARRIER_ID_CODE    0x01
  425.  
  426. typedef struct {
  427.     UCHAR TypeOfNetworkId;
  428.     UCHAR NetworkIdPlan;
  429.     UCHAR NetworkIdLength;
  430.     UCHAR NetworkId[1];
  431. } ATM_TRANSIT_NETWORK_SELECTION_IE;
  432.  
  433. /*
  434.  *  ATM specific Ioctl codes
  435.  */
  436. #define SIO_GET_NUMBER_OF_ATM_DEVICES   0x50160001
  437. #define SIO_GET_ATM_ADDRESS             0xd0160002
  438. #define SIO_ASSOCIATE_PVC               0x90160003
  439. #define SIO_GET_ATM_CONNECTION_ID       0x50160004
  440.  
  441. /* ATM Connection Identifier */
  442.  
  443. typedef struct {
  444.     DWORD  DeviceNumber;
  445.     DWORD  VPI;
  446.     DWORD  VCI;
  447. } ATM_CONNECTION_ID;
  448.  
  449. /*
  450.  * Input buffer format for SIO_ASSOCIATE_PVC
  451.  */
  452.  
  453. typedef struct {
  454.    ATM_CONNECTION_ID   PvcConnectionId;
  455.    QOS                 PvcQos;
  456. } ATM_PVC_PARAMS;
  457.  
  458. #include <poppack.h>
  459.  
  460. #pragma option pop /*P_O_Pop*/
  461. #endif   /* _WS2ATM_H_ */
  462.