usr/src/man/man9f/csx_Parse_CISTPL_SPCL.9f

   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_PARSE_CISTPL_SPCL 9F "Dec 20, 1996"
   7 .SH NAME
   8 csx_Parse_CISTPL_SPCL \- parse the Special Purpose tuple
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_Parse_CISTPL_SPCL\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  17     \fBcistpl_spcl_t *\fR\fIcsp\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris \fBDDI \fRSpecific (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\fIcsp\fR\fR
  48 .ad
  49 .RS 7n
  50 Pointer to a \fBcistpl_spcl_t\fR structure which contains the parsed
  51 \fBCISTPL_SPCL\fR tuple information upon return from this function.
  52 .RE
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 This function parses the Special Purpose tuple, \fBCISTPL_SPCL,\fR into a form
  58 usable by \fBPC \fRCard drivers.
  59 .sp
  60 .LP
  61 The \fBCISTPL_SPCL\fR tuple is identified by an identification field that is
  62 assigned by \fBPCMCIA \fRor JEIDA. A sequence field allows a series of
  63 \fBCISTPL_SPCL\fR tuples to be used when the data exceeds the size that can be
  64 stored in a single tuple; the maximum data area of a series of
  65 \fBCISTPL_SPCL\fR tuples is unlimited. Another field gives the number of bytes
  66 in the data field in this tuple.
  67 .SH STRUCTURE MEMBERS
  68 .sp
  69 .LP
  70 The structure members of \fBcistpl_date_t\fR are:
  71 .sp
  72 .in +2
  73 .nf
  74 uint32_t    id;       /* tuple contents identification */
  75 uint32_t    seq;      /* data sequence number */
  76 uint32_t    bytes;    /* number of bytes following */
  77 uchar_t     data[CIS_MAX_TUPLE_DATA_LEN];
  78 .fi
  79 .in -2
  80
  81 .sp
  82 .LP
  83 The fields are defined as follows:
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBid\fR\fR
  88 .ad
  89 .RS 9n
  90 This field contains a \fBPCMCIA \fRor \fBJEIDA \fRassigned value that
  91 identifies this series of one or more \fBCISTPL_SPCL\fR tuples. These field
  92 values are assigned by contacting either \fBPCMCIA \fRor \fBJEIDA\fR.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBseq\fR\fR
  99 .ad
 100 .RS 9n
 101 This field contains a data sequence number. \fBCISTPL_SPCL_SEQ_END\fR is the
 102 last tuple in sequence.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBbytes\fR\fR
 109 .ad
 110 .RS 9n
 111 This field contains the number of data bytes in the
 112 \fBdata[CIS_MAX_TUPLE_DATA_LEN]\fR.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBdata\fR\fR
 119 .ad
 120 .RS 9n
 121 The data component of this tuple.
 122 .RE
 123
 124 .SH RETURN VALUES
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBCS_SUCCESS\fR\fR
 129 .ad
 130 .RS 27n
 131 Successful operation.
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBCS_BAD_HANDLE\fR\fR
 138 .ad
 139 .RS 27n
 140 Client handle is invalid.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBCS_UNKNOWN_TUPLE\fR\fR
 147 .ad
 148 .RS 27n
 149 Parser does not know how to parse tuple.
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBCS_NO_CARD\fR\fR
 156 .ad
 157 .RS 27n
 158 No \fBPC \fRCard in socket.
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fBCS_NO_CIS\fR\fR
 165 .ad
 166 .RS 27n
 167 No Card Information Structure (CIS) on \fBPC \fRCard.
 168 .RE
 169
 170 .sp
 171 .ne 2
 172 .na
 173 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
 174 .ad
 175 .RS 27n
 176 No \fBPCMCIA \fRhardware installed.
 177 .RE
 178
 179 .SH CONTEXT
 180 .sp
 181 .LP
 182 This function may be called from user or kernel context.
 183 .SH SEE ALSO
 184 .sp
 185 .LP
 186 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
 187 \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
 188 .sp
 189 .LP
 190 \fIPC Card 95 Standard,\fR PCMCIA/JEIDA