usr/src/man/man9f/csx_Parse_CISTPL_VERS_2.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_VERS_2 9F "Dec 20, 1996"
   7 .SH NAME
   8 csx_Parse_CISTPL_VERS_2 \- parse Level-2 Version and Information tuple
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_Parse_CISTPL_VERS_2\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  17      \fBcistpl_vers_2_t *\fR\fIcv2\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\fIcv2\fR\fR
  48 .ad
  49 .RS 7n
  50 Pointer to a \fBcistpl_vers_2_t\fR structure which contains the parsed
  51 \fBCISTPL_VERS_2\fR tuple information upon return from this function.
  52 .RE
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 This function parses the Level-2 Version and Information tuple,
  58 \fBCISTPL_VERS_2,\fR into a form usable by \fBPC \fRCard drivers.
  59 .sp
  60 .LP
  61 The \fBCISTPL_VERS_2\fR tuple is used to describe the card Level-2 information
  62 which has the logical organization of the card's data.
  63 .SH STRUCTURE MEMBERS
  64 .sp
  65 .LP
  66 The structure members of \fBcistpl_vers_2_t\fR are:
  67 .sp
  68 .in +2
  69 .nf
  70 uint32_t   vers;     /* version number */
  71 uint32_t   comply;   /* level of compliance */
  72 uint32_t   dindex;   /* byte address of first data byte in card */
  73 uint32_t   vspec8;   /* vendor specific (byte 8) */
  74 uint32_t   vspec9;   /* vendor specific (byte 9) */
  75 uint32_t   nhdr;     /* number of copies of CIS present on device */
  76 char       oem[CIS_MAX_TUPLE_DATA_LEN];
  77                      /* Vendor of software that formatted card */
  78 char       info[CIS_MAX_TUPLE_DATA_LEN];
  79                      /* Informational message about card */
  80 .fi
  81 .in -2
  82
  83 .SH RETURN VALUES
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBCS_SUCCESS\fR\fR
  88 .ad
  89 .RS 27n
  90 Successful operation.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBCS_BAD_HANDLE\fR\fR
  97 .ad
  98 .RS 27n
  99 Client handle is invalid.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBCS_UNKNOWN_TUPLE\fR\fR
 106 .ad
 107 .RS 27n
 108 Parser does not know how to parse tuple.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBCS_NO_CARD\fR\fR
 115 .ad
 116 .RS 27n
 117 No \fBPC \fRCard in socket.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fBCS_NO_CIS\fR\fR
 124 .ad
 125 .RS 27n
 126 No Card Information Structure (CIS) on \fBPC \fRCard.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
 133 .ad
 134 .RS 27n
 135 No \fBPCMCIA \fRhardware installed.
 136 .RE
 137
 138 .SH CONTEXT
 139 .sp
 140 .LP
 141 This function may be called from user or kernel context.
 142 .SH SEE ALSO
 143 .sp
 144 .LP
 145 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
 146 \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
 147 .sp
 148 .LP
 149 \fIPC Card 95 Standard,\fR PCMCIA/JEIDA