8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man9f / csx_Parse_CISTPL_FUNCE.9f
blobccb6f1b7edaa18cc5d9cf99e66e97ae184368d3f
1 '\" te
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"
7 .SH NAME
8 csx_Parse_CISTPL_FUNCE \- parse Function Extension tuple
9 .SH SYNOPSIS
10 .LP
11 .nf
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);
19 .fi
21 .SH INTERFACE LEVEL
22 .sp
23 .LP
24 Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR
25 .SH PARAMETERS
26 .sp
27 .ne 2
28 .na
29 \fB\fIch\fR\fR
30 .ad
31 .RS 7n
32 Client handle returned from \fBcsx_RegisterClient\fR(9F).
33 .RE
35 .sp
36 .ne 2
37 .na
38 \fB\fItu\fR\fR
39 .ad
40 .RS 7n
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).
43 .RE
45 .sp
46 .ne 2
47 .na
48 \fB\fIcf\fR\fR
49 .ad
50 .RS 7n
51 Pointer to a \fBcistpl_funce_t\fR structure which contains the parsed
52 \fBCISTPL_FUNCE\fR tuple information upon return from this function.
53 .RE
55 .sp
56 .ne 2
57 .na
58 \fB\fIfid\fR\fR
59 .ad
60 .RS 7n
61 The function \fBID \fRcode to which this \fBCISTPL_FUNCE\fR tuple refers. See
62 \fBcsx_Parse_CISTPL_FUNCID\fR(9F).
63 .RE
65 .SH DESCRIPTION
66 .sp
67 .LP
68 This function parses the Function Extension tuple, \fBCISTPL_FUNCE,\fR into a
69 form usable by \fBPC \fRCard drivers.
70 .sp
71 .LP
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.
76 .SH STRUCTURE MEMBERS
77 .sp
78 .LP
79 The structure members of \fBcistpl_funce_t\fR are:
80 .sp
81 .in +2
82 .nf
83 uint32_t     function;           /* type of extended data */
84 uint32_t     subfunction;
85 union {
86        struct serial {
87               uint32_t  ua;      /* UART in use */
88               uint32_t  uc;      /* UART capabilities */
89        } serial;
90        struct modem {
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 */
95        } modem;
96        struct data_modem {
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 */
108        } data_modem;
109        struct fax {
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 */
116        } fax;
117        struct voice {
118               uint32_t  uv;      /* highest data rate */
119               uint32_t  nsr;
120               uint32_t  sr[16];  /* voice sampling rates (*100) */
121               uint32_t  nss;
122               uint32_t  ss[16];  /* voice sample sizes (*10) */
123               uint32_t  nsc;
124               uint32_t  sc[16];  /* voice compression methods */
125        } voice;
126        struct lan {
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 */
133         } lan;
134 } data;
136 .in -2
140 The fields are defined as follows:
142 .ne 2
144 \fBfunction\fR
146 .RS 15n
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:
150 .ne 2
152 \fBTPLFE_SUB_SERIAL\fR
154 .RS 26n
155 Serial port interface
159 .ne 2
161 \fBTPLFE_SUB_MODEM_COMMON\fR
163 .RS 26n
164 Common modem interface
168 .ne 2
170 \fBTPLFE_SUB_MODEM_DATA\fR
172 .RS 26n
173 Data modem services
177 .ne 2
179 \fBTPLFE_SUB_MODEM_FAX\fR
181 .RS 26n
182 Fax modem services
186 .ne 2
188 \fBTPLFE_SUB_VOICE\fR
190 .RS 26n
191 Voice services
195 .ne 2
197 \fBTPLFE_CAP_MODEM_DATA\fR
199 .RS 26n
200 Capabilities of the data modem interface
204 .ne 2
206 \fBTPLFE_CAP_MODEM_FAX\fR
208 .RS 26n
209 Capabilities of the fax modem interface
213 .ne 2
215 \fBTPLFE_CAP_MODEM_VOICE\fR
217 .RS 26n
218 Capabilities of the voice modem interface
222 .ne 2
224 \fBTPLFE_CAP_SERIAL_DATA\fR
226 .RS 26n
227 Serial port interface for data modem services
231 .ne 2
233 \fBTPLFE_CAP_SERIAL_FAX\fR
235 .RS 26n
236 Serial port interface for fax modem services
240 .ne 2
242 \fBTPLFE_CAP_SERIAL_VOICE\fR
244 .RS 26n
245 Serial port interface for voice modem services
251 .ne 2
253 \fB\fBsubfunction\fR\fR
255 .RS 15n
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
258 \fB1\fR to \fB15\fR.
262 .ne 2
264 \fB\fBua\fR\fR
266 .RS 15n
267 This is the serial port \fBUART \fRidentification and is defined as follows:
269 .ne 2
271 \fBTPLFE_UA_8250\fR
273 .RS 18n
274 Intel 8250
278 .ne 2
280 \fBTPLFE_UA_16450\fR
282 .RS 18n
283 NS 16450
287 .ne 2
289 \fBTPLFE_UA_16550\fR
291 .RS 18n
292 NS 16550
298 .ne 2
300 \fB\fBuc\fR\fR
302 .RS 15n
303 This identifies the serial port \fBUART \fRcapabilities and is defined as
304 follows:
306 .ne 2
308 \fBTPLFE_UC_PARITY_SPACE\fR
310 .RS 25n
311 Space parity supported
315 .ne 2
317 \fBTPLFE_UC_PARITY_MARK\fR
319 .RS 25n
320 Mark parity supported
324 .ne 2
326 \fBTPLFE_UC_PARITY_ODD\fR
328 .RS 25n
329 Odd parity supported
333 .ne 2
335 \fBTPLFE_UC_PARITY_EVEN\fR
337 .RS 25n
338 Even parity supported
342 .ne 2
344 \fBTPLFE_UC_CS5\fR
346 .RS 25n
347 5 bit characters supported
351 .ne 2
353 \fBTPLFE_UC_CS6\fR
355 .RS 25n
356 6 bit characters supported
360 .ne 2
362 \fBTPLFE_UC_CS7\fR
364 .RS 25n
365 7 bit characters supported
369 .ne 2
371 \fBTPLFE_UC_CS8\fR
373 .RS 25n
374 8 bit characters supported
378 .ne 2
380 \fBTPLFE_UC_STOP_1\fR
382 .RS 25n
383 1 stop bit supported
387 .ne 2
389 \fBTPLFE_UC_STOP_15\fR
391 .RS 25n
392 1.5 stop bits supported
396 .ne 2
398 \fBTPLFE_UC_STOP_2\fR
400 .RS 25n
401 2 stop bits supported
407 .ne 2
409 \fB\fBfc\fR\fR
411 .RS 15n
412 This identifies the modem flow control methods and is defined as follows:
414 .ne 2
416 \fBTPLFE_FC_TX_XONOFF\fR
418 .RS 22n
419 Transmit XON/XOFF
423 .ne 2
425 \fBTPLFE_FC_RX_XONOFF\fR
427 .RS 22n
428 Receiver XON/XOFF
432 .ne 2
434 \fBTPLFE_FC_TX_HW\fR
436 .RS 22n
437 Transmit hardware flow control (CTS)
441 .ne 2
443 \fBTPLFE_FC_RX_HW\fR
445 .RS 22n
446 Receiver hardware flow control (RTS)
450 .ne 2
452 \fBTPLFE_FC_TRANS\fR
454 .RS 22n
455 Transparent flow control
459 .ne 2
461 \fBms\fR
463 .RS 6n
464 This identifies the modem modulation standards and is defined as follows:
468 .ne 2
470 \fBTPLFE_MS_BELL103\fR
472 .RS 20n
473 300bps
477 .ne 2
479 \fBTPLFE_MS_V21\fR
481 .RS 20n
482 300bps (V.21)
486 .ne 2
488 \fBTPLFE_MS_V23\fR
490 .RS 20n
491 600/1200bps (V.23)
495 .ne 2
497 \fBTPLFE_MS_V22AB\fR
499 .RS 20n
500 1200bps (V.22A V.22B)
504 .ne 2
506 \fBTPLFE_MS_BELL212\fR
508 .RS 20n
509 2400bps (US Bell 212
513 .ne 2
515 \fBTPLFE_MS_V22BIS\fR
517 .RS 20n
518 2400bps (V.22bis)
522 .ne 2
524 \fBTPLFE_MS_V26\fR
526 .RS 20n
527 2400bps leased line (V.26)
531 .ne 2
533 \fBTPLFE_MS_V26BIS\fR
535 .RS 20n
536 2400bps (V.26bis)
540 .ne 2
542 \fBTPLFE_MS_V27BIS\fR
544 .RS 20n
545 4800/2400bps leased line (V.27bis)
549 .ne 2
551 \fBTPLFE_MS_V29\fR
553 .RS 20n
554 9600/7200/4800 leased line (V.29)
558 .ne 2
560 \fBTPLFE_MS_V32\fR
562 .RS 20n
563 Up to 9600bps (V.32)
567 .ne 2
569 \fBTPLFE_MS_V32BIS\fR
571 .RS 20n
572 Up to 14400bps (V.32bis)
576 .ne 2
578 \fBTPLFE_MS_VFAST\fR
580 .RS 20n
581 Up to 28800 V.FAST
587 .ne 2
589 \fB\fBem\fR\fR
591 .RS 15n
592 This identifies modem error correction/detection protocols and is defined as
593 follows:
595 .ne 2
597 \fBTPLFE_EM_MNP\fR
599 .RS 16n
600 MNP levels 2-4
604 .ne 2
606 \fBTPLFE_EM_V42\fR
608 .RS 16n
609 CCITT LAPM (V.42)
615 .ne 2
617 \fB\fBdc\fR\fR
619 .RS 15n
620 This identifies modem data compression protocols and is defined as follows:
622 .ne 2
624 \fBTPLFE_DC_V42BI\fR
626 .RS 18n
627 CCITT compression V.42
631 .ne 2
633 \fBTPLFE_DC_MNP5\fR
635 .RS 18n
636 MNP compression (uses MNP 2, 3 or 4)
642 .ne 2
644 \fB\fBcm\fR\fR
646 .RS 15n
647 This identifies modem command protocols and is defined as follows:
649 .ne 2
651 \fBTPLFE_CM_AT1\fR
653 .RS 19n
654 ANSI/EIA/TIA 602 "Action" commands
658 .ne 2
660 \fBTPLFE_CM_AT2\fR
662 .RS 19n
663 ANSI/EIA/TIA 602 "ACE/DCE IF Params"
667 .ne 2
669 \fBTPLFE_CM_AT3\fR
671 .RS 19n
672 ANSI/EIA/TIA 602 "Ace Parameters"
676 .ne 2
678 \fBTPLFE_CM_MNP_AT\fR
680 .RS 19n
681 MNP specification AT commands
685 .ne 2
687 \fBTPLFE_CM_V25BIS\fR
689 .RS 19n
690 V.25bis calling commands
694 .ne 2
696 \fBTPLFE_CM_V25A\fR
698 .RS 19n
699 V.25bis test procedures
703 .ne 2
705 \fBTPLFE_CM_DMCL\fR
707 .RS 19n
708 DMCL command mode
714 .ne 2
716 \fB\fBex\fR\fR
718 .RS 15n
719 This identifies the modem escape mechanism and is defined as follows:
721 .ne 2
723 \fBTPLFE_EX_BREAK\fR
725 .RS 18n
726 BREAK support standardized
730 .ne 2
732 \fBTPLFE_EX_PLUS\fR
734 .RS 18n
735 +++ returns to command mode
739 .ne 2
741 \fBTPLFE_EX_UD\fR
743 .RS 18n
744 User defined escape character
750 .ne 2
752 \fB\fBdy\fR\fR
754 .RS 15n
755 This identifies modem standardized data encryption and is a reserved field for
756 future use and must be set to \fB0\fR.
760 .ne 2
762 \fB\fBef\fR\fR
764 .RS 15n
765 This identifies modem miscellaneous features and is defined as follows:
767 .ne 2
769 \fBTPLFE_EF_CALLERID\fR
771 .RS 21n
772 Caller ID is supported
778 .ne 2
780 \fB\fBfm\fR\fR
782 .RS 15n
783 This identifies fax modulation standards and is defined as follows:
785 .ne 2
787 \fBTPLFE_FM_V21C2\fR
789 .RS 19n
790 300bps (V.21-C2)
794 .ne 2
796 \fBTPLFE_FM_V27TER\fR
798 .RS 19n
799 4800/2400bps (V.27ter)
803 .ne 2
805 \fBTPLFE_FM_V29\fR
807 .RS 19n
808 9600/7200/4800 leased line (V.29)
812 .ne 2
814 \fBTPLFE_FM_V17\fR
816 .RS 19n
817 14.4K/12K/9600/7200bps (V.17)
821 .ne 2
823 \fBTPLFE_FM_V33\fR
825 .RS 19n
826 4.4K/12K/9600/7200 leased line (V.33)
832 .ne 2
834 \fB\fBfs\fR\fR
836 .RS 15n
837 This identifies the fax feature selection and is defined as follows:
839 .ne 2
841 \fBTPLFE_FS_T3\fR
843 .RS 21n
844 Group 2 (T.3) service class
848 .ne 2
850 \fBTPLFE_FS_T4\fR
852 .RS 21n
853 Group 3 (T.4) service class
857 .ne 2
859 \fBTPLFE_FS_T6\fR
861 .RS 21n
862 Group 4 (T.6) service class
866 .ne 2
868 \fBTPLFE_FS_ECM\fR
870 .RS 21n
871 Error Correction Mode
875 .ne 2
877 \fBTPLFE_FS_VOICEREQ\fR
879 .RS 21n
880 Voice requests allowed
884 .ne 2
886 \fBTPLFE_FS_POLLING\fR
888 .RS 21n
889 Polling support
893 .ne 2
895 \fBTPLFE_FS_FTP\fR
897 .RS 21n
898 File transfer support
902 .ne 2
904 \fBTPLFE_FS_PASSWORD\fR
906 .RS 21n
907 Password support
913 .ne 2
915 \fB\fBtech\fR\fR
917 .RS 15n
918 This identifies the \fBLAN \fRtechnology type and is defined as follows:
920 .ne 2
922 \fBTPLFE_LAN_TECH_ARCNET\fR
924 .RS 28n
925 Arcnet
929 .ne 2
931 \fBTPLFE_LAN_TECH_ETHERNET\fR
933 .RS 28n
934 Ethernet
938 .ne 2
940 \fBTPLFE_LAN_TECH_TOKENRING\fR
942 .RS 28n
943 Token Ring
947 .ne 2
949 \fBTPLFE_LAN_TECH_LOCALTALK\fR
951 .RS 28n
952 Local Talk
956 .ne 2
958 \fBTPLFE_LAN_TECH_FDDI\fR
960 .RS 28n
961 FDDI/CDDI
965 .ne 2
967 \fBTPLFE_LAN_TECH_ATM\fR
969 .RS 28n
974 .ne 2
976 \fBTPLFE_LAN_TECH_WIRELESS\fR
978 .RS 28n
979 Wireless
985 .ne 2
987 \fB\fBmedia\fR\fR
989 .RS 15n
990 This identifies the \fBLAN \fRmedia type and is defined as follows:
992 .ne 2
994 \fBTPLFE_LAN_MEDIA_INHERENT\fR
996 .RS 30n
997 Generic interface
1001 .ne 2
1003 \fBTPLFE_LAN_MEDIA_UTP\fR
1005 .RS 30n
1006 Unshielded twisted pair
1010 .ne 2
1012 \fBTPLFE_LAN_MEDIA_STP\fR
1014 .RS 30n
1015 Shielded twisted pair
1019 .ne 2
1021 \fBTPLFE_LAN_MEDIA_THIN_COAX\fR
1023 .RS 30n
1024 Thin coax
1028 .ne 2
1030 \fBTPLFE_LAN_MEDIA_THICK_COAX\fR
1032 .RS 30n
1033 Thick coax
1037 .ne 2
1039 \fBTPLFE_LAN_MEDIA_FIBER\fR
1041 .RS 30n
1042 Fiber
1046 .ne 2
1048 \fBTPLFE_LAN_MEDIA_SSR_902\fR
1050 .RS 30n
1051 Spread spectrum radio 902-928 MHz
1055 .ne 2
1057 \fBTPLFE_LAN_MEDIA_SSR_2_4\fR
1059 .RS 30n
1060 Spread spectrum radio 2.4 GHz
1064 .ne 2
1066 \fBTPLFE_LAN_MEDIA_SSR_5_4\fR
1068 .RS 30n
1069 Spread spectrum radio 5.4 GHz
1073 .ne 2
1075 \fBTPLFE_LAN_MEDIA_DIFFUSE_IR\fR
1077 .RS 30n
1078 Diffuse infra red
1082 .ne 2
1084 \fBTPLFE_LAN_MEDIA_PTP_IR\fR
1086 .RS 30n
1087 Point to point infra red
1092 .SH RETURN VALUES
1094 .ne 2
1096 \fB\fBCS_SUCCESS\fR\fR
1098 .RS 27n
1099 Successful operation.
1103 .ne 2
1105 \fB\fBCS_BAD_HANDLE\fR\fR
1107 .RS 27n
1108 Client handle is invalid.
1112 .ne 2
1114 \fB\fBCS_UNKNOWN_TUPLE\fR\fR
1116 .RS 27n
1117 Parser does not know how to parse tuple.
1121 .ne 2
1123 \fB\fBCS_NO_CARD\fR\fR
1125 .RS 27n
1126 No \fBPC \fRCard in socket.
1130 .ne 2
1132 \fB\fBCS_NO_CIS\fR\fR
1134 .RS 27n
1135 No Card Information Structure (CIS) on \fBPC \fRCard.
1139 .ne 2
1141 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
1143 .RS 27n
1144 No \fBPCMCIA \fRhardware installed.
1147 .SH CONTEXT
1150 This function may be called from user or kernel context.
1151 .SH SEE ALSO
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