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

   1 '\" te
   2 .\"  Copyright (c) 1997, 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_SWIL 9F "Jan 24, 1997"
   7 .SH NAME
   8 csx_Parse_CISTPL_SWIL \- parse the Software Interleaving tuple
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_Parse_CISTPL_SWIL\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  17      \fBcistpl_swil_t *\fR\fIpt\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\fIpt\fR\fR
  48 .ad
  49 .RS 6n
  50 Pointer to a \fBcistpl_swil_t\fR structure which contains the parsed
  51 \fBCISTPL_SWIL\fR tuple information upon return from this function.
  52 .RE
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 This function parses the Software Interleaving tuple, \fBCISTPL_SWIL,\fR into a
  58 form usable by \fBPC \fRCard drivers.
  59 .sp
  60 .LP
  61 The \fBCISTPL_SWIL\fR tuple provides the software interleaving of data within a
  62 partition on the card.
  63 .SH STRUCTURE MEMBERS
  64 .sp
  65 .LP
  66 The structure members of \fBcistpl_swil_t\fR are:
  67 .sp
  68 .in +2
  69 .nf
  70 uint32_t     intrlv;
  71 .fi
  72 .in -2
  73
  74 .sp
  75 .LP
  76 The fields are defined as follows:
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBintrlv\fR\fR
  81 .ad
  82 .RS 10n
  83 This field provides the software interleaving for a partition.
  84 .RE
  85
  86 .SH RETURN VALUES
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBCS_SUCCESS\fR\fR
  91 .ad
  92 .RS 27n
  93 Successful operation.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBCS_BAD_HANDLE\fR\fR
 100 .ad
 101 .RS 27n
 102 Client handle is invalid.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBCS_UNKNOWN_TUPLE\fR\fR
 109 .ad
 110 .RS 27n
 111 Parser does not know how to parse tuple.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBCS_NO_CARD\fR\fR
 118 .ad
 119 .RS 27n
 120 No \fBPC \fRCard in socket.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBCS_NO_CIS\fR\fR
 127 .ad
 128 .RS 27n
 129 No Card Information Structure (CIS) on \fBPC \fRCard.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
 136 .ad
 137 .RS 27n
 138 No \fBPCMCIA \fRhardware installed.
 139 .RE
 140
 141 .SH CONTEXT
 142 .sp
 143 .LP
 144 This function may be called from user or kernel context.
 145 .SH SEE ALSO
 146 .sp
 147 .LP
 148 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
 149 \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
 150 .sp
 151 .LP
 152 \fIPC Card 95 Standard,\fR PCMCIA/JEIDA