2 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH CSX_PARSE_CISTPL_FUNCE 9F "Dec 20, 1996"
8 csx_Parse_CISTPL_FUNCE \- parse Function Extension tuple
12 #include <sys/pccard.h>
16 \fBint32_t\fR \fBcsx_Parse_CISTPL_FUNCE\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
17 \fBcistpl_funce_t *\fR\fIcf\fR,
18 \fBuint32_t\fR \fIfid\fR);
24 Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR
32 Client handle returned from \fBcsx_RegisterClient\fR(9F).
41 Pointer to a \fBtuple_t\fR structure (see \fBtuple\fR(9S)) returned by a call
42 to \fBcsx_GetFirstTuple\fR(9F) or \fBcsx_GetNextTuple\fR(9F).
51 Pointer to a \fBcistpl_funce_t\fR structure which contains the parsed
52 \fBCISTPL_FUNCE\fR tuple information upon return from this function.
61 The function \fBID \fRcode to which this \fBCISTPL_FUNCE\fR tuple refers. See
62 \fBcsx_Parse_CISTPL_FUNCID\fR(9F).
68 This function parses the Function Extension tuple, \fBCISTPL_FUNCE,\fR into a
69 form usable by \fBPC \fRCard drivers.
72 The \fBCISTPL_FUNCE\fR tuple is used to describe information about a specific
73 \fBPC\fRCard function. The information provided is determined by the Function
74 Identification tuple, \fBCISTPL_FUNCID,\fR that is being extended. Each
75 function has a defined set of extension tuples.
79 The structure members of \fBcistpl_funce_t\fR are:
83 uint32_t function; /* type of extended data */
87 uint32_t ua; /* UART in use */
88 uint32_t uc; /* UART capabilities */
91 uint32_t fc; /* supported flow control methods */
92 uint32_t cb; /* size of DCE command buffer */
93 uint32_t eb; /* size of DCE to DCE buffer */
94 uint32_t tb; /* size of DTE to DCE buffer */
97 uint32_t ud; /* highest data rate */
98 uint32_t ms; /* modulation standards */
99 uint32_t em; /* err correct proto and
100 /* non-CCITT modulation */
101 uint32_t dc; /* data compression protocols */
102 uint32_t cm; /* command protocols */
103 uint32_t ex; /* escape mechanisms */
104 uint32_t dy; /* standardized data encryption */
105 uint32_t ef; /* miscellaneous end user features */
106 uint32_t ncd; /* number of country codes */
107 uchar_t cd[16]; /* CCITT country code */
110 uint32_t uf; /* highest data rate in DTE/UART */
111 uint32_t fm; /* CCITT modulation standards */
112 uint32_t fy; /* standardized data encryption */
113 uint32_t fs; /* feature selection */
114 uint32_t ncf; /* number of country codes */
115 uchar_t cf[16]; /* CCITT country codes */
118 uint32_t uv; /* highest data rate */
120 uint32_t sr[16]; /* voice sampling rates (*100) */
122 uint32_t ss[16]; /* voice sample sizes (*10) */
124 uint32_t sc[16]; /* voice compression methods */
127 uint32_t tech; /* network technology */
128 uint32_t speed; /* media bit or baud rate */
129 uint32_t media; /* network media supported */
130 uint32_t con; /* open/closed connector standard */
131 uint32_t id_sz; /* length of lan station id */
132 uchar_t id[16]; /* station ID */
140 The fields are defined as follows:
147 This field identifies the type of extended information provided about a
148 function by the \fBCISTPL_FUNCE\fR tuple. This field is defined as follows:
152 \fBTPLFE_SUB_SERIAL\fR
155 Serial port interface
161 \fBTPLFE_SUB_MODEM_COMMON\fR
164 Common modem interface
170 \fBTPLFE_SUB_MODEM_DATA\fR
179 \fBTPLFE_SUB_MODEM_FAX\fR
188 \fBTPLFE_SUB_VOICE\fR
197 \fBTPLFE_CAP_MODEM_DATA\fR
200 Capabilities of the data modem interface
206 \fBTPLFE_CAP_MODEM_FAX\fR
209 Capabilities of the fax modem interface
215 \fBTPLFE_CAP_MODEM_VOICE\fR
218 Capabilities of the voice modem interface
224 \fBTPLFE_CAP_SERIAL_DATA\fR
227 Serial port interface for data modem services
233 \fBTPLFE_CAP_SERIAL_FAX\fR
236 Serial port interface for fax modem services
242 \fBTPLFE_CAP_SERIAL_VOICE\fR
245 Serial port interface for voice modem services
253 \fB\fBsubfunction\fR\fR
256 This is for identifying a sub-category of services provided by a function in
257 the \fBCISTPL_FUNCE\fR tuple. The numeric value of the code is in the range of
267 This is the serial port \fBUART \fRidentification and is defined as follows:
303 This identifies the serial port \fBUART \fRcapabilities and is defined as
308 \fBTPLFE_UC_PARITY_SPACE\fR
311 Space parity supported
317 \fBTPLFE_UC_PARITY_MARK\fR
320 Mark parity supported
326 \fBTPLFE_UC_PARITY_ODD\fR
335 \fBTPLFE_UC_PARITY_EVEN\fR
338 Even parity supported
347 5 bit characters supported
356 6 bit characters supported
365 7 bit characters supported
374 8 bit characters supported
380 \fBTPLFE_UC_STOP_1\fR
389 \fBTPLFE_UC_STOP_15\fR
392 1.5 stop bits supported
398 \fBTPLFE_UC_STOP_2\fR
401 2 stop bits supported
412 This identifies the modem flow control methods and is defined as follows:
416 \fBTPLFE_FC_TX_XONOFF\fR
425 \fBTPLFE_FC_RX_XONOFF\fR
437 Transmit hardware flow control (CTS)
446 Receiver hardware flow control (RTS)
455 Transparent flow control
464 This identifies the modem modulation standards and is defined as follows:
470 \fBTPLFE_MS_BELL103\fR
500 1200bps (V.22A V.22B)
506 \fBTPLFE_MS_BELL212\fR
515 \fBTPLFE_MS_V22BIS\fR
527 2400bps leased line (V.26)
533 \fBTPLFE_MS_V26BIS\fR
542 \fBTPLFE_MS_V27BIS\fR
545 4800/2400bps leased line (V.27bis)
554 9600/7200/4800 leased line (V.29)
569 \fBTPLFE_MS_V32BIS\fR
572 Up to 14400bps (V.32bis)
592 This identifies modem error correction/detection protocols and is defined as
620 This identifies modem data compression protocols and is defined as follows:
627 CCITT compression V.42
636 MNP compression (uses MNP 2, 3 or 4)
647 This identifies modem command protocols and is defined as follows:
654 ANSI/EIA/TIA 602 "Action" commands
663 ANSI/EIA/TIA 602 "ACE/DCE IF Params"
672 ANSI/EIA/TIA 602 "Ace Parameters"
678 \fBTPLFE_CM_MNP_AT\fR
681 MNP specification AT commands
687 \fBTPLFE_CM_V25BIS\fR
690 V.25bis calling commands
699 V.25bis test procedures
719 This identifies the modem escape mechanism and is defined as follows:
726 BREAK support standardized
735 +++ returns to command mode
744 User defined escape character
755 This identifies modem standardized data encryption and is a reserved field for
756 future use and must be set to \fB0\fR.
765 This identifies modem miscellaneous features and is defined as follows:
769 \fBTPLFE_EF_CALLERID\fR
772 Caller ID is supported
783 This identifies fax modulation standards and is defined as follows:
796 \fBTPLFE_FM_V27TER\fR
799 4800/2400bps (V.27ter)
808 9600/7200/4800 leased line (V.29)
817 14.4K/12K/9600/7200bps (V.17)
826 4.4K/12K/9600/7200 leased line (V.33)
837 This identifies the fax feature selection and is defined as follows:
844 Group 2 (T.3) service class
853 Group 3 (T.4) service class
862 Group 4 (T.6) service class
871 Error Correction Mode
877 \fBTPLFE_FS_VOICEREQ\fR
880 Voice requests allowed
886 \fBTPLFE_FS_POLLING\fR
898 File transfer support
904 \fBTPLFE_FS_PASSWORD\fR
918 This identifies the \fBLAN \fRtechnology type and is defined as follows:
922 \fBTPLFE_LAN_TECH_ARCNET\fR
931 \fBTPLFE_LAN_TECH_ETHERNET\fR
940 \fBTPLFE_LAN_TECH_TOKENRING\fR
949 \fBTPLFE_LAN_TECH_LOCALTALK\fR
958 \fBTPLFE_LAN_TECH_FDDI\fR
967 \fBTPLFE_LAN_TECH_ATM\fR
976 \fBTPLFE_LAN_TECH_WIRELESS\fR
990 This identifies the \fBLAN \fRmedia type and is defined as follows:
994 \fBTPLFE_LAN_MEDIA_INHERENT\fR
1003 \fBTPLFE_LAN_MEDIA_UTP\fR
1006 Unshielded twisted pair
1012 \fBTPLFE_LAN_MEDIA_STP\fR
1015 Shielded twisted pair
1021 \fBTPLFE_LAN_MEDIA_THIN_COAX\fR
1030 \fBTPLFE_LAN_MEDIA_THICK_COAX\fR
1039 \fBTPLFE_LAN_MEDIA_FIBER\fR
1048 \fBTPLFE_LAN_MEDIA_SSR_902\fR
1051 Spread spectrum radio 902-928 MHz
1057 \fBTPLFE_LAN_MEDIA_SSR_2_4\fR
1060 Spread spectrum radio 2.4 GHz
1066 \fBTPLFE_LAN_MEDIA_SSR_5_4\fR
1069 Spread spectrum radio 5.4 GHz
1075 \fBTPLFE_LAN_MEDIA_DIFFUSE_IR\fR
1084 \fBTPLFE_LAN_MEDIA_PTP_IR\fR
1087 Point to point infra red
1096 \fB\fBCS_SUCCESS\fR\fR
1099 Successful operation.
1105 \fB\fBCS_BAD_HANDLE\fR\fR
1108 Client handle is invalid.
1114 \fB\fBCS_UNKNOWN_TUPLE\fR\fR
1117 Parser does not know how to parse tuple.
1123 \fB\fBCS_NO_CARD\fR\fR
1126 No \fBPC \fRCard in socket.
1132 \fB\fBCS_NO_CIS\fR\fR
1135 No Card Information Structure (CIS) on \fBPC \fRCard.
1141 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
1144 No \fBPCMCIA \fRhardware installed.
1150 This function may be called from user or kernel context.
1154 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
1155 \fBcsx_Parse_CISTPL_FUNCID\fR(9F), \fBcsx_RegisterClient\fR(9F),
1156 \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
1159 \fIPC Card 95 Standard, PCMCIA/JEIDA\fR