usr/src/man/man9f/csx_Parse_CISTPL_DEVICEGEO_A.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_DEVICEGEO_A 9F "May 16, 1997"
   7 .SH NAME
   8 csx_Parse_CISTPL_DEVICEGEO_A \- parse the Device Geo A tuple
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_Parse_CISTPL_DEVICEGEO_A\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItp\fR,
  17      \fBcistpl_devicegeo_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 7n
  31 Client handle returned from \fBcsx_RegisterClient\fR(9F).
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fItp\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\fIpt\fR \fR
  48 .ad
  49 .RS 7n
  50 Pointer to a \fBcistpl_devicegeo_t\fR structure which contains the parsed
  51 Device Geo A tuple information upon return from this function.
  52 .RE
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 This function parses the Device Geo A tuple, \fBCISTPL_DEVICEGEO_A,\fR into a
  58 form usable by \fBPC \fRCard drivers.
  59 .sp
  60 .LP
  61 The \fBCISTPL_DEVICEGEO_A\fR tuple describes the device geometry of attribute
  62 memory partitions.
  63 .SH STRUCTURE MEMBERS
  64 .sp
  65 .LP
  66 The structure members of \fBcistpl_devicegeo_t\fR are:
  67 .sp
  68 .in +2
  69 .nf
  70 uint32_t     info[CISTPL_DEVICEGEO_MAX_PARTITIONS].bus;
  71 uint32_t     info[CISTPL_DEVICEGEO_MAX_PARTITIONS].ebs;
  72 uint32_t     info[CISTPL_DEVICEGEO_MAX_PARTITIONS].rbs;
  73 uint32_t     info[CISTPL_DEVICEGEO_MAX_PARTITIONS].wbs;
  74 uint32_t     info[CISTPL_DEVICEGEO_MAX_PARTITIONS].part;
  75 uint32_t     info[CISTPL_DEVICEGEO_MAX_PARTITIONS].hwil;
  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\fBinfo[CISTPL_DEVICEGEO_MAX_PARTITIONS].bus\fR \fR
  86 .ad
  87 .sp .6
  88 .RS 4n
  89 This field indicates the card interface width in bytes for the given partition.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBinfo[CISTPL_DEVICEGEO_MAX_PARTITIONS].ebs\fR \fR
  96 .ad
  97 .sp .6
  98 .RS 4n
  99 This field indicates the minimum erase block size for the given partition.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBinfo[CISTPL_DEVICEGEO_MAX_PARTITIONS].rbs\fR \fR
 106 .ad
 107 .sp .6
 108 .RS 4n
 109 This field indicates the minimum read block size for the given partition.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBinfo[CISTPL_DEVICEGEO_MAX_PARTITIONS].wbs\fR \fR
 116 .ad
 117 .sp .6
 118 .RS 4n
 119 This field indicates the minimum write block size for the given partition.
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fBinfo[CISTPL_DEVICEGEO_MAX_PARTITIONS].part\fR \fR
 126 .ad
 127 .sp .6
 128 .RS 4n
 129 This field indicates the segment partition subdivisions for the given
 130 partition.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBinfo[CISTPL_DEVICEGEO_MAX_PARTITIONS].hwil\fR \fR
 137 .ad
 138 .sp .6
 139 .RS 4n
 140 This field indicates the hardware interleave for the given partition.
 141 .RE
 142
 143 .SH RETURN VALUES
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBCS_SUCCESS\fR \fR
 148 .ad
 149 .RS 28n
 150 Successful operation.
 151 .RE
 152
 153 .sp
 154 .ne 2
 155 .na
 156 \fB\fBCS_BAD_HANDLE\fR \fR
 157 .ad
 158 .RS 28n
 159 Client handle is invalid.
 160 .RE
 161
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fBCS_UNKNOWN_TUPLE\fR \fR
 166 .ad
 167 .RS 28n
 168 Parser does not know how to parse tuple.
 169 .RE
 170
 171 .sp
 172 .ne 2
 173 .na
 174 \fB\fBCS_NO_CARD\fR \fR
 175 .ad
 176 .RS 28n
 177 No \fBPC \fRCard in socket.
 178 .RE
 179
 180 .sp
 181 .ne 2
 182 .na
 183 \fB\fBCS_NO_CIS\fR \fR
 184 .ad
 185 .RS 28n
 186 No Card Information Structure (CIS) on \fBPC \fRCard.
 187 .RE
 188
 189 .sp
 190 .ne 2
 191 .na
 192 \fB\fBCS_UNSUPPORTED_FUNCTION\fR \fR
 193 .ad
 194 .RS 28n
 195 No \fBPCMCIA \fRhardware installed.
 196 .RE
 197
 198 .SH CONTEXT
 199 .sp
 200 .LP
 201 This function may be called from user or kernel context.
 202 .SH SEE ALSO
 203 .sp
 204 .LP
 205 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetNextTuple\fR(9F),
 206 \fBcsx_GetTupleData\fR(9F), \fBcsx_Parse_CISTPL_DEVICEGEO\fR(9F),
 207 \fBcsx_RegisterClient\fR(9F), \fBtuple\fR(9S)
 208 .sp
 209 .LP
 210 \fIPC Card 95 Standard, PCMCIA/JEIDA\fR