usr/src/man/man9f/csx_Parse_CISTPL_FUNCID.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_FUNCID 9F "Dec 20, 1996"
   7 .SH NAME
   8 csx_Parse_CISTPL_FUNCID \- parse Function Identification tuple
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_Parse_CISTPL_FUNCID\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  17      \fBcistpl_funcid_t *\fR\fIcf\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 6n
  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 6n
  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\fIcf\fR\fR
  48 .ad
  49 .RS 6n
  50 Pointer to a \fBcistpl_funcid_t\fR structure which contains the parsed
  51 \fBCISTPL_FUNCID\fR tuple information upon return from this function.
  52 .RE
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 This function parses the Function Identification tuple, \fBCISTPL_FUNCID,\fR
  58 into a form usable by \fBPC \fRCard drivers.
  59 .sp
  60 .LP
  61 The \fBCISTPL_FUNCID\fR tuple is used to describe information about the
  62 functionality provided by a \fBPC \fRCard. Information is also provided to
  63 enable system utilities to decide if the \fBPC \fRCard should be configured
  64 during system initialization. If additional function specific information is
  65 available, one or more function extension tuples of type \fBCISTPL_FUNCE\fR
  66 follow this tuple (see \fBcsx_Parse_CISTPL_FUNCE\fR(9F)).
  67 .SH STRUCTURE MEMBERS
  68 .sp
  69 .LP
  70 The structure members of \fBcistpl_funcid_t\fR are:
  71 .sp
  72 .in +2
  73 .nf
  74 uint32_t     function;     /* PC Card function code */
  75 uint32_t     sysinit;      /* system initialization mask */
  76 .fi
  77 .in -2
  78
  79 .sp
  80 .LP
  81 The fields are defined as follows:
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBfunction\fR\fR
  86 .ad
  87 .RS 12n
  88 This is the function type for \fBCISTPL_FUNCID:\fR
  89 .sp
  90 .ne 2
  91 .na
  92 \fBTPLFUNC_MULTI\fR
  93 .ad
  94 .RS 27n
  95 Vendor-specific multifunction card
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fBTPLFUNC_MEMORY\fR
 102 .ad
 103 .RS 27n
 104 Memory card
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fBTPLFUNC_SERIAL\fR
 111 .ad
 112 .RS 27n
 113 Serial I/O port
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fBTPLFUNC_PARALLEL\fR
 120 .ad
 121 .RS 27n
 122 Parallel printer port
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fBTPLFUNC_FIXED\fR
 129 .ad
 130 .RS 27n
 131 Fixed disk, silicon or removable
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fBTPLFUNC_VIDEO\fR
 138 .ad
 139 .RS 27n
 140 Video interface
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fBTPLFUNC_LAN\fR
 147 .ad
 148 .RS 27n
 149 Local Area Network adapter
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fBTPLFUNC_AIMS\fR
 156 .ad
 157 .RS 27n
 158 Auto Incrementing Mass Storage
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fBTPLFUNC_SCSI\fR
 165 .ad
 166 .RS 27n
 167 SCSI bridge
 168 .RE
 169
 170 .sp
 171 .ne 2
 172 .na
 173 \fBTPLFUNC_SECURITY\fR
 174 .ad
 175 .RS 27n
 176 Security cards
 177 .RE
 178
 179 .sp
 180 .ne 2
 181 .na
 182 \fBTPLFUNC_VENDOR_SPECIFIC\fR
 183 .ad
 184 .RS 27n
 185 Vendor specific
 186 .RE
 187
 188 .sp
 189 .ne 2
 190 .na
 191 \fBTPLFUNC_UNKNOWN\fR
 192 .ad
 193 .RS 27n
 194 Unknown function(s)
 195 .RE
 196
 197 .RE
 198
 199 .sp
 200 .ne 2
 201 .na
 202 \fB\fBsysinit\fR\fR
 203 .ad
 204 .RS 11n
 205 This field is bit-mapped and defined as follows:
 206 .sp
 207 .ne 2
 208 .na
 209 \fBTPLINIT_POST\fR
 210 .ad
 211 .RS 16n
 212 POST should attempt configure
 213 .RE
 214
 215 .sp
 216 .ne 2
 217 .na
 218 \fBTPLINIT_ROM\fR
 219 .ad
 220 .RS 16n
 221 Map ROM during sys init
 222 .RE
 223
 224 .RE
 225
 226 .SH RETURN VALUES
 227 .sp
 228 .ne 2
 229 .na
 230 \fB\fBCS_SUCCESS\fR\fR
 231 .ad
 232 .RS 27n
 233 Successful operation.
 234 .RE
 235
 236 .sp
 237 .ne 2
 238 .na
 239 \fB\fBCS_BAD_HANDLE\fR\fR
 240 .ad
 241 .RS 27n
 242 Client handle is invalid.
 243 .RE
 244
 245 .sp
 246 .ne 2
 247 .na
 248 \fB\fBCS_UNKNOWN_TUPLE\fR\fR
 249 .ad
 250 .RS 27n
 251 Parser does not know how to parse tuple.
 252 .RE
 253
 254 .sp
 255 .ne 2
 256 .na
 257 \fB\fBCS_NO_CARD\fR\fR
 258 .ad
 259 .RS 27n
 260 No \fBPC \fRCard in socket.
 261 .RE
 262
 263 .sp
 264 .ne 2
 265 .na
 266 \fB\fBCS_NO_CIS\fR\fR
 267 .ad
 268 .RS 27n
 269 No Card Information Structure (CIS) on \fBPC \fRCard.
 270 .RE
 271
 272 .sp
 273 .ne 2
 274 .na
 275 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
 276 .ad
 277 .RS 27n
 278 No \fBPCMCIA \fRhardware installed.
 279 .RE
 280
 281 .SH CONTEXT
 282 .sp
 283 .LP
 284 This function may be called from user or kernel context.
 285 .SH SEE ALSO
 286 .sp
 287 .LP
 288 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
 289 \fBcsx_Parse_CISTPL_FUNCE\fR(9F), \fBcsx_RegisterClient\fR(9F),
 290 \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
 291 .sp
 292 .LP
 293 \fIPC Card 95 Standard, PCMCIA/JEIDA\fR