usr/src/man/man9f/csx_Parse_CISTPL_GEOMETRY.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_GEOMETRY 9F "Jan 24, 1997"
   7 .SH NAME
   8 csx_Parse_CISTPL_GEOMETRY \- parse the Geometry tuple
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_Parse_CISTPL_GEOMETRY\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  17      \fBcistpl_geometry_t *\fR\fIpt\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris \fBDDI\fR Specific (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_geometry_t\fR structure which contains the parsed
  51 \fBCISTPL_GEOMETRY\fR tuple information upon return from this function.
  52 .RE
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 This function parses the Geometry tuple, \fBCISTPL_GEOMETRY\fR, into a form
  58 usable by \fBPC\fR Card drivers.
  59 .sp
  60 .LP
  61 The \fBCISTPL_GEOMETRY\fR tuple indicates the geometry of a disk-like device.
  62 .SH STRUCTURE MEMBERS
  63 .sp
  64 .LP
  65 The structure members of \fBcistpl_geometry_t\fR are:
  66 .sp
  67 .in +2
  68 .nf
  69   uint32_t     spt;
  70    uint32_t     tpc;
  71    uint32_t     ncyl;
  72 .fi
  73 .in -2
  74
  75 .sp
  76 .LP
  77 The fields are defined as follows:
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBspt\fR\fR
  82 .ad
  83 .RS 8n
  84 This field indicates the number of sectors per track.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBtpc\fR\fR
  91 .ad
  92 .RS 8n
  93 This field indicates the number of tracks per cylinder.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBncyl\fR\fR
 100 .ad
 101 .RS 8n
 102 This field indicates the number of cylinders.
 103 .RE
 104
 105 .SH RETURN VALUES
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBCS_SUCCESS\fR\fR
 110 .ad
 111 .RS 27n
 112 Successful operation.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBCS_BAD_HANDLE\fR\fR
 119 .ad
 120 .RS 27n
 121 Client handle is invalid.
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBCS_UNKNOWN_TUPLE\fR\fR
 128 .ad
 129 .RS 27n
 130 Parser does not know how to parse tuple.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBCS_NO_CARD\fR\fR
 137 .ad
 138 .RS 27n
 139 No \fBPC\fR Card in socket.
 140 .RE
 141
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fBCS_NO_CIS\fR\fR
 146 .ad
 147 .RS 27n
 148 No Card Information Structure (\fBCIS\fR) on \fBPC\fR Card.
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
 155 .ad
 156 .RS 27n
 157 No \fBPCMCIA\fR hardware installed.
 158 .RE
 159
 160 .SH CONTEXT
 161 .sp
 162 .LP
 163 This function may be called from user or kernel context.
 164 .SH SEE ALSO
 165 .sp
 166 .LP
 167 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
 168 \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
 169 .sp
 170 .LP
 171 \fIPC Card 95 Standard\fR, PCMCIA/JEIDA