1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
'\" te
.\" Copyright (c) 1997, Sun Microsystems, Inc. All Rights Reserved
.\" 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.
.\" 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.
.\" 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]
.TH CSX_PARSE_CISTPL_FORMAT 9F "Jan 24, 1997"
.SH NAME
csx_Parse_CISTPL_FORMAT \- parse the Data Recording Format tuple
.SH SYNOPSIS
.LP
.nf
#include <sys/pccard.h>
\fBint32_t\fR \fBcsx_Parse_CISTPL_FORMAT\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
\fBcistpl_format_t *\fR\fIpt\fR);
.fi
.SH INTERFACE LEVEL
.sp
.LP
Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR
.SH PARAMETERS
.sp
.ne 2
.na
\fB\fIch\fR\fR
.ad
.RS 6n
Client handle returned from \fBcsx_RegisterClient\fR(9F).
.RE
.sp
.ne 2
.na
\fB\fItu\fR\fR
.ad
.RS 6n
Pointer to a \fBtuple_t\fR structure (see \fBtuple\fR(9S)) returned by a call
to \fBcsx_GetFirstTuple\fR(9F) or \fBcsx_GetNextTuple\fR(9F).
.RE
.sp
.ne 2
.na
\fB\fIpt\fR\fR
.ad
.RS 6n
Pointer to a \fBcistpl_format_t\fR structure which contains the parsed
\fBCISTPL_FORMAT\fR tuple information upon return from this function.
.RE
.SH DESCRIPTION
.sp
.LP
This function parses the Data Recording Format tuple, \fBCISTPL_FORMAT,\fR into
a form usable by \fBPC \fRCard drivers.
.sp
.LP
The \fBCISTPL_FORMAT\fR tuple indicates the data recording format for a device
partition.
.SH STRUCTURE MEMBERS
.sp
.LP
The structure members of \fBcistpl_format_t\fR are:
.sp
.in +2
.nf
uint32_t type;
uint32_t edc_length;
uint32_t edc_type;
uint32_t offset;
uint32_t nbytes;
uint32_t dev.disk.bksize;
uint32_t dev.disk.nblocks;
uint32_t dev.disk.edcloc;
uint32_t dev.mem.flags;
uint32_t dev.mem.reserved;
caddr_t dev.mem.address;
uint32_t dev.mem.edcloc;
.fi
.in -2
.sp
.LP
The fields are defined as follows:
.sp
.ne 2
.na
\fB\fBtype\fR\fR
.ad
.RS 20n
This field indicates the type of device:
.sp
.ne 2
.na
\fBTPLFMTTYPE_DISK\fR
.ad
.RS 19n
disk-like device
.RE
.sp
.ne 2
.na
\fBTPLFMTTYPE_MEM\fR
.ad
.RS 19n
memory-like device
.RE
.sp
.ne 2
.na
\fBTPLFMTTYPE_VS\fR
.ad
.RS 19n
vendor-specific device
.RE
.RE
.sp
.ne 2
.na
\fB\fBedc_length\fR\fR
.ad
.RS 20n
This field indicates the error detection code length.
.RE
.sp
.ne 2
.na
\fB\fBedc_type\fR\fR
.ad
.RS 20n
This field indicates the error detection code type.
.RE
.sp
.ne 2
.na
\fB\fBoffset\fR\fR
.ad
.RS 20n
This field indicates the offset of the first byte of data in this partition.
.RE
.sp
.ne 2
.na
\fB\fBnbytes\fR\fR
.ad
.RS 20n
This field indicates the number of bytes of data in this partition
.RE
.sp
.ne 2
.na
\fB\fBdev.disk.bksize\fR\fR
.ad
.RS 20n
This field indicates the block size, for disk devices.
.RE
.sp
.ne 2
.na
\fB\fBdev.disk.nblocks\fR\fR
.ad
.RS 20n
This field indicates the number of blocks, for disk devices.
.RE
.sp
.ne 2
.na
\fB\fBdev.disk.edcloc\fR\fR
.ad
.RS 20n
This field indicates the location of the error detection code, for disk
devices.
.RE
.sp
.ne 2
.na
\fB\fBdev.mem.flags\fR\fR
.ad
.RS 20n
This field provides flags, for memory devices. Valid flags are:
.sp
.ne 2
.na
\fBTPLFMTFLAGS_ADDR\fR
.ad
.RS 20n
address is valid
.RE
.sp
.ne 2
.na
\fBTPLFMTFLAGS_AUTO\fR
.ad
.RS 20n
automatically map memory region
.RE
.RE
.sp
.ne 2
.na
\fB\fBdev.mem.reserved\fR\fR
.ad
.RS 20n
This field is reserved.
.RE
.sp
.ne 2
.na
\fB\fBdev.mem.address\fR\fR
.ad
.RS 20n
This field indicates the physical address, for memory devices.
.RE
.sp
.ne 2
.na
\fB\fBdev.mem.edcloc\fR\fR
.ad
.RS 20n
This field indicates the location of the error detection code, for memory
devices.
.RE
.SH RETURN VALUES
.sp
.ne 2
.na
\fB\fBCS_SUCCESS\fR\fR
.ad
.RS 27n
Successful operation.
.RE
.sp
.ne 2
.na
\fB\fBCS_BAD_HANDLE\fR\fR
.ad
.RS 27n
Client handle is invalid.
.RE
.sp
.ne 2
.na
\fB\fBCS_UNKNOWN_TUPLE\fR\fR
.ad
.RS 27n
Parser does not know how to parse tuple.
.RE
.sp
.ne 2
.na
\fB\fBCS_NO_CARD\fR\fR
.ad
.RS 27n
No \fBPC \fRCard in socket.
.RE
.sp
.ne 2
.na
\fB\fBCS_NO_CIS\fR\fR
.ad
.RS 27n
No Card Information Structure (CIS) on \fBPC \fRCard.
.RE
.sp
.ne 2
.na
\fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
.ad
.RS 27n
No \fBPCMCIA \fRhardware installed.
.RE
.SH CONTEXT
.sp
.LP
This function may be called from user or kernel context.
.SH SEE ALSO
.sp
.LP
\fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
\fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
.sp
.LP
\fIPC Card 95 Standard, PCMCIA/JEIDA\fR
|
