usr/src/man/man9f/csx_Parse_CISTPL_LONGLINK_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_LONGLINK_A 9F "Jan 24, 1997"
   7 .SH NAME
   8 csx_Parse_CISTPL_LONGLINK_A, csx_Parse_CISTPL_LONGLINK_C \- parse the Long Link
   9 A and C tuples
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/pccard.h>
  14
  15
  16
  17 \fBint32_t\fR \fBcsx_Parse_CISTPL_LONGLINK_A\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  18      \fBcistpl_longlink_ac_t *\fR\fIpt\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint32_t\fR \fBcsx_Parse_CISTPL_LONGLINK_C\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  24      \fBcistpl_longlink_ac_t *\fR\fIpt\fR);
  25 .fi
  26
  27 .SH INTERFACE LEVEL
  28 .sp
  29 .LP
  30 Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR
  31 .SH PARAMETERS
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIch\fR \fR
  36 .ad
  37 .RS 7n
  38 Client handle returned from \fBcsx_RegisterClient\fR(9F).
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fItu\fR \fR
  45 .ad
  46 .RS 7n
  47 Pointer to a \fBtuple_t\fR structure (see \fBtuple\fR(9S)) returned by a call
  48 to \fBcsx_GetFirstTuple\fR(9F) or \fBcsx_GetNextTuple\fR(9F).
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fIpt\fR \fR
  55 .ad
  56 .RS 7n
  57 Pointer to a \fBcistpl_longlink_ac_t\fR structure which contains the parsed
  58 \fBCISTPL_LONGLINK_A\fR or \fBCISTPL_LONGLINK_C\fR tuple information upon
  59 return from this function.
  60 .RE
  61
  62 .SH DESCRIPTION
  63 .sp
  64 .LP
  65 This function parses the Long Link A and C tuples, \fBCISTPL_LONGLINK_A\fR and
  66 \fBCISTPL_LONGLINK_A,\fR into a form usable by \fBPC \fRCard drivers.
  67 .sp
  68 .LP
  69 The \fBCISTPL_LONGLINK_A\fR and \fBCISTPL_LONGLINK_C\fR tuples provide links to
  70 Attribute and Common Memory.
  71 .SH STRUCTURE MEMBERS
  72 .sp
  73 .LP
  74 The structure members of \fBcistpl_longlink_ac_t\fR are:
  75 .sp
  76 .in +2
  77 .nf
  78 uint32_t   flags;
  79 uint32_t   tpll_addr;
  80 .fi
  81 .in -2
  82
  83 .sp
  84 .LP
  85 The fields are defined as follows:
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBflags\fR \fR
  90 .ad
  91 .RS 14n
  92 This field indicates the type of memory:
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBCISTPL_LONGLINK_AC_AM\fR\fR
  97 .ad
  98 .RS 25n
  99 long link to Attribute Memory
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBCISTPL_LONGLINK_AC_CM\fR\fR
 106 .ad
 107 .RS 25n
 108 long link to Common Memory
 109 .RE
 110
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fBtpll_addr\fR \fR
 117 .ad
 118 .RS 14n
 119 This field provides the offset from the beginning of the specified address
 120 space.
 121 .RE
 122
 123 .SH RETURN VALUES
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBCS_SUCCESS\fR \fR
 128 .ad
 129 .RS 28n
 130 Successful operation.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBCS_BAD_HANDLE\fR \fR
 137 .ad
 138 .RS 28n
 139 Client handle is invalid.
 140 .RE
 141
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fBCS_UNKNOWN_TUPLE\fR \fR
 146 .ad
 147 .RS 28n
 148 Parser does not know how to parse tuple.
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fBCS_NO_CARD\fR \fR
 155 .ad
 156 .RS 28n
 157 No \fBPC \fRCard in socket.
 158 .RE
 159
 160 .sp
 161 .ne 2
 162 .na
 163 \fB\fBCS_NO_CIS\fR \fR
 164 .ad
 165 .RS 28n
 166 No Card Information Structure (CIS) on \fBPC \fRCard.
 167 .RE
 168
 169 .sp
 170 .ne 2
 171 .na
 172 \fB\fBCS_UNSUPPORTED_FUNCTION\fR \fR
 173 .ad
 174 .RS 28n
 175 No \fBPCMCIA \fRhardware installed.
 176 .RE
 177
 178 .SH CONTEXT
 179 .sp
 180 .LP
 181 This function may be called from user or kernel context.
 182 .SH SEE ALSO
 183 .sp
 184 .LP
 185 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
 186 \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
 187 .sp
 188 .LP
 189 \fIPC Card 95 Standard,\fR PCMCIA/JEIDA