1 '\" te
2 .\" Copyright (c) 1996, 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_PARSETUPLE 9F "Dec 20, 1996"
7 .SH NAME
8 csx_ParseTuple \- generic tuple parser
9 .SH SYNOPSIS
10 .LP
11 .nf
12 #include <sys/pccard.h>
13
14
15
16 \fBint32_t\fR \fBcsx_ParseTuple\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR, \fBcisparse_t *\fR\fIcp\fR,
17 \fBcisdata_t\fR \fIcd\fR);
18 .fi
19
20 .SH INTERFACE LEVEL
21 .sp
22 .LP
23 Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR)
24 .SH PARAMETERS
25 .sp
26 .ne 2
27 .na
28 \fB\fIch\fR \fR
29 .ad
30 .RS 7n
31 Client handle returned from \fBcsx_RegisterClient\fR(9F).
32 .RE
33
34 .sp
35 .ne 2
36 .na
37 \fB\fItu\fR \fR
38 .ad
39 .RS 7n
40 Pointer to a \fBtuple_t\fR structure (see \fBtuple\fR(9S)) returned by a call
41 to \fBcsx_GetFirstTuple\fR(9F) or \fBcsx_GetNextTuple\fR(9F).
42 .RE
43
44 .sp
45 .ne 2
46 .na
47 \fB\fIcp\fR \fR
48 .ad
49 .RS 7n
50 Pointer to a \fBcisparse_t\fR structure that unifies all tuple parsing
51 structures.
52 .RE
53
54 .sp
55 .ne 2
56 .na
57 \fB\fIcd\fR \fR
58 .ad
59 .RS 7n
60 Extended tuple data for some tuples.
61 .RE
62
63 .SH DESCRIPTION
64 .sp
65 .LP
66 This function is the generic tuple parser entry point.
67 .SH STRUCTURE MEMBERS
68 .sp
69 .LP
70 The structure members of \fBcisparse_t\fR are:
71 .sp
72 .in +2
73 .nf
74 typedef union cisparse_t {
75 cistpl_config_t cistpl_config;
76 cistpl_device_t cistpl_device;
77 cistpl_vers_1_t cistpl_vers_1;
78 cistpl_vers_2_t cistpl_vers_2;
79 cistpl_jedec_t cistpl_jedec;
80 cistpl_format_t cistpl_format;
81 cistpl_geometry_t cistpl_geometry;
82 cistpl_byteorder_t cistpl_byteorder;
83 cistpl_date_t cistpl_date;
84 cistpl_battery_t cistpl_battery;
85 cistpl_org_t cistpl_org;
86 cistpl_manfid_t cistpl_manfid;
87 cistpl_funcid_t cistpl_funcid;
88 cistpl_funce_t cistpl_funce;
89 cistpl_cftable_entry_t cistpl_cftable_entry;
90 cistpl_linktarget_t cistpl_linktarget;
91 cistpl_longlink_ac_t cistpl_longlink_ac;
92 cistpl_longlink_mfc_t cistpl_longlink_mfc;
93 cistpl_spcl_t cistpl_spcl;
94 cistpl_swil_t cistpl_swil;
95 cistpl_bar_t cistpl_bar;
96 cistpl_devicegeo_t cistpl_devicegeo;
97 cistpl_longlink_cb_t cistpl_longlink_cb;
98 cistpl_get_tuple_name_t cistpl_get_tuple_name;
99 } cisparse_t;
100 .fi
101 .in -2
102
103 .SH RETURN VALUES
104 .sp
105 .ne 2
106 .na
107 \fB\fBCS_SUCCESS\fR \fR
108 .ad
109 .RS 28n
110 Successful operation.
111 .RE
112
113 .sp
114 .ne 2
115 .na
116 \fB\fBCS_BAD_HANDLE\fR \fR
117 .ad
118 .RS 28n
119 Client handle is invalid.
120 .RE
121
122 .sp
123 .ne 2
124 .na
125 \fB\fBCS_UNKNOWN_TUPLE\fR \fR
126 .ad
127 .RS 28n
128 Parser does not know how to parse tuple.
129 .RE
130
131 .sp
132 .ne 2
133 .na
134 \fB\fBCS_NO_CARD\fR \fR
135 .ad
136 .RS 28n
137 No \fBPC\fR Card in socket.
138 .RE
139
140 .sp
141 .ne 2
142 .na
143 \fB\fBCS_BAD_CIS\fR \fR
144 .ad
145 .RS 28n
146 Generic parser error.
147 .RE
148
149 .sp
150 .ne 2
151 .na
152 \fB\fBCS_NO_CIS\fR \fR
153 .ad
154 .RS 28n
155 No Card Information Structure (\fBCIS\fR) on \fBPC\fR Card.
156 .RE
157
158 .sp
159 .ne 2
160 .na
161 \fB\fBCS_UNSUPPORTED_FUNCTION\fR \fR
162 .ad
163 .RS 28n
164 No \fBPCMCIA\fR hardware installed.
165 .RE
166
167 .SH CONTEXT
168 .sp
169 .LP
170 This function may be called from user or kernel context.
171 .SH SEE ALSO
172 .sp
173 .LP
174 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
175 \fBcsx_Parse_CISTPL_BATTERY\fR(9F), \fBcsx_Parse_CISTPL_BYTEORDER\fR(9F),
176 \fBcsx_Parse_CISTPL_CFTABLE_ENTRY\fR(9F), \fBcsx_Parse_CISTPL_CONFIG\fR(9F),
177 \fBcsx_Parse_CISTPL_DATE\fR(9F), \fBcsx_Parse_CISTPL_DEVICE\fR(9F),
178 \fBcsx_Parse_CISTPL_FUNCE\fR(9F), \fBcsx_Parse_CISTPL_FUNCID\fR(9F),
179 \fBcsx_Parse_CISTPL_JEDEC_C\fR(9F), \fBcsx_Parse_CISTPL_MANFID\fR(9F),
180 \fBcsx_Parse_CISTPL_SPCL\fR(9F), \fBcsx_Parse_CISTPL_VERS_1\fR(9F),
181 \fBcsx_Parse_CISTPL_VERS_2\fR(9F), \fBcsx_RegisterClient\fR(9F),
182 \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
183 .sp
184 .LP
185 \fIPC Card 95 Standard\fR, PCMCIA/JEIDA