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_LINKTARGET 9F "Jan 24, 1997"
   7 .SH NAME
   8 csx_Parse_CISTPL_LINKTARGET \- parse the Link Target tuple
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13 
  14 
  15 \fBint32_t\fR \fBcsx_Parse_CISTPL_LINKTARGET\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  16      \fBcistpl_linktarget_t *\fR\fIpt\fR);
  17 .fi
  18 
  19 .SH INTERFACE LEVEL
  20 .sp
  21 .LP
  22 Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIch\fR \fR
  28 .ad
  29 .RS 7n
  30 Client handle returned from \fBcsx_RegisterClient\fR(9F).
  31 .RE
  32 
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fItu\fR \fR
  37 .ad
  38 .RS 7n
  39 Pointer to a \fBtuple_t\fR structure (see \fBtuple\fR(9S)) returned by a call
  40 to \fBcsx_GetFirstTuple\fR(9F) or \fBcsx_GetNextTuple\fR(9F).
  41 .RE
  42 
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIpt\fR \fR
  47 .ad
  48 .RS 7n
  49 Pointer to a \fBcistpl_linktarget_t\fR structure which contains the parsed
  50 \fBCISTPL_LINKTARGET\fR tuple information upon return from this function.
  51 .RE
  52 
  53 .SH DESCRIPTION
  54 .sp
  55 .LP
  56 This function parses the Link Target tuple, \fBCISTPL_LINKTARGET,\fR into a
  57 form usable by \fBPC\fRCard drivers.
  58 .sp
  59 .LP
  60 The \fBCISTPL_LINKTARGET\fR tuple is used to verify that tuple chains other
  61 than the primary chain are valid. All secondary tuple chains are required to
  62 contain this tuple as the first tuple of the chain.
  63 .SH STRUCTURE MEMBERS
  64 .sp
  65 .LP
  66 The structure members of \fBcistpl_linktarget_t\fR are:
  67 .sp
  68 .in +2
  69 .nf
  70 uint32_t   length;
  71 char       tpltg_tag[CIS_MAX_TUPLE_DATA_LEN];
  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\fBlength\fR \fR
  82 .ad
  83 .RS 14n
  84 This field indicates the number of bytes in \fBtpltg_tag\fR.
  85 .RE
  86 
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBtpltg_tag\fR \fR
  91 .ad
  92 .RS 14n
  93 This field provides the Link Target tuple information.
  94 .RE
  95 
  96 .SH RETURN VALUES
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBCS_SUCCESS\fR \fR
 101 .ad
 102 .RS 28n
 103 Successful operation.
 104 .RE
 105 
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBCS_BAD_HANDLE\fR \fR
 110 .ad
 111 .RS 28n
 112 Client handle is invalid.
 113 .RE
 114 
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBCS_UNKNOWN_TUPLE\fR \fR
 119 .ad
 120 .RS 28n
 121 Parser does not know how to parse tuple.
 122 .RE
 123 
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBCS_NO_CARD\fR \fR
 128 .ad
 129 .RS 28n
 130 No \fBPC \fRCard in socket.
 131 .RE
 132 
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBCS_NO_CIS\fR \fR
 137 .ad
 138 .RS 28n
 139 No Card Information Structure (CIS) on \fBPC \fRCard.
 140 .RE
 141 
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fBCS_UNSUPPORTED_FUNCTION\fR \fR
 146 .ad
 147 .RS 28n
 148 No \fBPCMCIA \fRhardware installed.
 149 .RE
 150 
 151 .SH CONTEXT
 152 .sp
 153 .LP
 154 This function may be called from user or kernel context.
 155 .SH SEE ALSO
 156 .sp
 157 .LP
 158 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
 159 \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
 160 .sp
 161 .LP
 162 \fIPC Card 95 Standard,\fR PCMCIA/JEIDA