usr/src/man/man9f/csx_Parse_CISTPL_ORG.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_ORG 9F "Jan 24, 1997"
   7 .SH NAME
   8 csx_Parse_CISTPL_ORG \- parse the Data Organization tuple
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_Parse_CISTPL_ORG\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  17      \fBcistpl_org_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 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_org_t\fR structure which contains the parsed
  51 \fBCISTPL_ORG\fR tuple information upon return from this function.
  52 .RE
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 This function parses the Data Organization tuple, \fBCISTPL_ORG,\fR into a form
  58 usable by \fBPC \fRCard drivers.
  59 .sp
  60 .LP
  61 The \fBCISTPL_ORG\fR tuple provides a text description of the organization.
  62 .SH STRUCTURE MEMBERS
  63 .sp
  64 .LP
  65 The structure members of \fBcistpl_org_t\fR are:
  66 .sp
  67 .in +2
  68 .nf
  69 uint32_t   type;
  70 char       desc[CIS_MAX_TUPLE_DATA_LEN];
  71 .fi
  72 .in -2
  73
  74 .sp
  75 .LP
  76 The fields are defined as follows:
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBtype\fR\fR
  81 .ad
  82 .sp .6
  83 .RS 4n
  84 This field indicates type of data organization.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBdesc[CIS_MAX_TUPLE_DATA_LEN]\fR\fR
  91 .ad
  92 .sp .6
  93 .RS 4n
  94 This field provides the text description of this organization.
  95 .RE
  96
  97 .SH RETURN VALUES
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBCS_SUCCESS\fR\fR
 102 .ad
 103 .RS 27n
 104 Successful operation.
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fBCS_BAD_HANDLE\fR\fR
 111 .ad
 112 .RS 27n
 113 Client handle is invalid.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBCS_UNKNOWN_TUPLE\fR\fR
 120 .ad
 121 .RS 27n
 122 Parser does not know how to parse tuple.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBCS_NO_CARD\fR\fR
 129 .ad
 130 .RS 27n
 131 No \fBPC \fRCard in socket.
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBCS_NO_CIS\fR\fR
 138 .ad
 139 .RS 27n
 140 No Card Information Structure (CIS) on \fBPC \fRCard.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
 147 .ad
 148 .RS 27n
 149 No \fBPCMCIA \fRhardware installed.
 150 .RE
 151
 152 .SH CONTEXT
 153 .sp
 154 .LP
 155 This function may be called from user or kernel context.
 156 .SH SEE ALSO
 157 .sp
 158 .LP
 159 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
 160 \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
 161 .sp
 162 .LP
 163 \fIPC Card 95 Standard,\fR PCMCIA/JEIDA