usr/src/man/man9f/csx_ValidateCIS.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_VALIDATECIS 9F "Jul 19, 1996"
   7 .SH NAME
   8 csx_ValidateCIS \- validate the Card Information Structure (CIS)
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_ValidateCIS\fR(\fBclient_handle_t\fR \fIch\fR, \fBcisinfo_t *\fR\fIci\fR);
  17 .fi
  18
  19 .SH INTERFACE LEVEL
  20 .sp
  21 .LP
  22 Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR)
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIch\fR\fR
  28 .ad
  29 .RS 6n
  30 Client handle returned from \fBcsx_RegisterClient\fR(9F).
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIci\fR\fR
  37 .ad
  38 .RS 6n
  39 Pointer to a \fBcisinfo_t\fR structure.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 This function validates the Card Information Structure (CIS) on the \fBPC\fR
  46 Card in the specified socket.
  47 .SH STRUCTURE MEMBERS
  48 .sp
  49 .LP
  50 The structure members of \fBcisinfo_t\fR are:
  51 .sp
  52 .in +2
  53 .nf
  54  uint32_t     Socket;    /* socket number to validate CIS on */
  55   uint32_t     Chains;    /* number of tuple chains in CIS */
  56   uint32_t     Tuples;    /* total number of tuples in CIS */
  57 .fi
  58 .in -2
  59
  60 .sp
  61 .LP
  62 The fields are defined as follows:
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBSocket\fR\fR
  67 .ad
  68 .RS 10n
  69 Not used in Solaris, but for portability with other Card Services
  70 implementations, it should be set to the logical socket number.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBChains\fR\fR
  77 .ad
  78 .RS 10n
  79 This field returns the number of valid tuple chains located in the \fBCIS\fR.
  80 If \fB0\fR is returned, the \fBCIS\fR is not valid.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBTuples\fR\fR
  87 .ad
  88 .RS 10n
  89 This field is a Solaris-specific extension and it returns the total number of
  90 tuples on all the chains in the \fBPC\fR Card's \fBCIS\fR.
  91 .RE
  92
  93 .SH RETURN VALUES
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBCS_SUCCESS\fR\fR
  98 .ad
  99 .RS 27n
 100 Successful operation.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBCS_NO_CIS\fR\fR
 107 .ad
 108 .RS 27n
 109 No \fBCIS\fR on \fBPC\fR Card or \fBCIS\fR is invalid.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBCS_NO_CARD\fR\fR
 116 .ad
 117 .RS 27n
 118 No \fBPC\fR Card in socket.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
 125 .ad
 126 .RS 27n
 127 No \fBPCMCIA\fR hardware installed.
 128 .RE
 129
 130 .SH CONTEXT
 131 .sp
 132 .LP
 133 This function may be called from user or kernel context.
 134 .SH SEE ALSO
 135 .sp
 136 .LP
 137 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
 138 \fBcsx_ParseTuple\fR(9F), \fBcsx_RegisterClient\fR(9F)
 139 .sp
 140 .LP
 141 \fIPC Card 95 Standard\fR, PCMCIA/JEIDA