usr/src/man/man9f/csx_Parse_CISTPL_LONGLINK_MFC.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_MFC 9F "Jan 24, 1997"
   7 .SH NAME
   8 csx_Parse_CISTPL_LONGLINK_MFC \- parse the Multi-Function tuple
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_Parse_CISTPL_LONGLINK_MFC\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  17      \fBcistpl_longlink_mfc_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\fItu\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_longlink_mfc_t\fR structure which contains the parsed
  51 \fBCISTPL_LONGLINK_MFC\fR tuple information upon return from this function.
  52 .RE
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 This function parses the Multi-Function tuple, \fBCISTPL_LONGLINK_MFC,\fR into
  58 a form usable by \fBPC \fRCard drivers.
  59 .sp
  60 .LP
  61 The \fBCISTPL_LONGLINK_MFC\fR tuple describes the start of the
  62 function-specific \fBCIS \fRfor each function on a multi-function card.
  63 .SH STRUCTURE MEMBERS
  64 .sp
  65 .LP
  66 The structure members of \fBcistpl_longlink_mfc_t\fR are:
  67 .sp
  68 .in +2
  69 .nf
  70 uint32_t    nfuncs;
  71 uint32_t    nregs;
  72 uint32_t    function[CIS_MAX_FUNCTIONS].tas
  73 uint32_t    function[CIS_MAX_FUNCTIONS].addr
  74 .fi
  75 .in -2
  76
  77 .sp
  78 .LP
  79 The fields are defined as follows:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBnfuncs\fR \fR
  84 .ad
  85 .sp .6
  86 .RS 4n
  87 This field indicates the number of functions on the \fBPC \fRcard.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBnregs\fR \fR
  94 .ad
  95 .sp .6
  96 .RS 4n
  97 This field indicates the number of configuration register sets.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBfunction[CIS_MAX_FUNCTIONS].tas\fR \fR
 104 .ad
 105 .sp .6
 106 .RS 4n
 107 This field provides the target address space for each function on the \fBPC
 108 \fRcard. This field can be one of:
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBCISTPL_LONGLINK_MFC_TAS_AM\fR\fR
 113 .ad
 114 .sp .6
 115 .RS 4n
 116 CIS in attribute memory
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBCISTPL_LONGLINK_MFC_TAS_CM\fR\fR
 123 .ad
 124 .sp .6
 125 .RS 4n
 126 CIS in common memory
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBfunction[CIS_MAX_FUNCTIONS].addr\fR \fR
 133 .ad
 134 .sp .6
 135 .RS 4n
 136 This field provides the target address offset for each function on the \fBPC
 137 \fRcard.
 138 .RE
 139
 140 .RE
 141
 142 .SH RETURN VALUES
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBCS_SUCCESS\fR \fR
 147 .ad
 148 .RS 28n
 149 Successful operation.
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBCS_BAD_HANDLE\fR \fR
 156 .ad
 157 .RS 28n
 158 Client handle is invalid.
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fBCS_UNKNOWN_TUPLE\fR \fR
 165 .ad
 166 .RS 28n
 167 Parser does not know how to parse tuple.
 168 .RE
 169
 170 .sp
 171 .ne 2
 172 .na
 173 \fB\fBCS_NO_CARD\fR \fR
 174 .ad
 175 .RS 28n
 176 No \fBPC \fRCard in socket.
 177 .RE
 178
 179 .sp
 180 .ne 2
 181 .na
 182 \fB\fBCS_NO_CIS\fR \fR
 183 .ad
 184 .RS 28n
 185 No Card Information Structure (CIS) on \fBPC \fRCard.
 186 .RE
 187
 188 .sp
 189 .ne 2
 190 .na
 191 \fB\fBCS_UNSUPPORTED_FUNCTION\fR \fR
 192 .ad
 193 .RS 28n
 194 No \fBPCMCIA \fRhardware installed.
 195 .RE
 196
 197 .SH CONTEXT
 198 .sp
 199 .LP
 200 This function may be called from user or kernel context.
 201 .SH SEE ALSO
 202 .sp
 203 .LP
 204 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
 205 \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
 206 .sp
 207 .LP
 208 \fIPC Card 95 Standard,\fR PCMCIA/JEIDA