usr/src/man/man9f/csx_Parse_CISTPL_JEDEC_C.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_JEDEC_C 9F "Dec 20, 1996"
   7 .SH NAME
   8 csx_Parse_CISTPL_JEDEC_C, csx_Parse_CISTPL_JEDEC_A \- parse JEDEC Identifier
   9 tuples
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/pccard.h>
  14
  15
  16
  17 \fBint32_t\fR \fBcsx_Parse_CISTPL_JEDEC_C\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  18      \fBcistpl_jedec_t *\fR\fIcj\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint32_t\fR \fBcsx_Parse_CISTPL_JEDEC_A\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  24      \fBcistpl_jedec_t *\fR\fIcj\fR);
  25 .fi
  26
  27 .SH INTERFACE LEVEL
  28 .sp
  29 .LP
  30 Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR)
  31 .SH PARAMETERS
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIch\fR\fR
  36 .ad
  37 .RS 6n
  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 6n
  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\fIcj\fR\fR
  55 .ad
  56 .RS 6n
  57 Pointer to a \fBcistpl_jedec_t\fR structure which contains the parsed
  58 \fBCISTPL_JEDEC_C\fR or \fBCISTPL_JEDEC_A\fR tuple information upon return from
  59 these functions, respectively.
  60 .RE
  61
  62 .SH DESCRIPTION
  63 .sp
  64 .LP
  65 \fBcsx_Parse_CISTPL_JEDEC_C()\fR and \fBcsx_Parse_CISTPL_JEDEC_A()\fR parse the
  66 \fBJEDEC\fR Identifier tuples, \fBCISTPL_JEDEC_C\fR and \fBCISTPL_JEDEC_A,\fR
  67 respectively, into a form usable by \fBPC\fR Card drivers.
  68 .sp
  69 .LP
  70 The \fBCISTPL_JEDEC_C\fR and \fBCISTPL_JEDEC_A\fR tuples are optional tuples
  71 provided for cards containing programmable devices. They describe information
  72 for Common Memory or Attribute Memory space, respectively.
  73 .SH STRUCTURE MEMBERS
  74 .sp
  75 .LP
  76 The structure members of \fBcistpl_jedec_t\fR are:
  77 .sp
  78 .in +2
  79 .nf
  80  uint32_t        nid;   /* # of JEDEC identifiers present */
  81   jedec_ident_t   jid[CISTPL_JEDEC_MAX_IDENTIFIERS];
  82 .fi
  83 .in -2
  84
  85 .sp
  86 .LP
  87 The structure members of \fBjedec_ident_t\fR are:
  88 .sp
  89 .in +2
  90 .nf
  91  uint32_t        id;    /* manufacturer id */
  92   uint32_t        info;  /* manufacturer specific info */
  93 .fi
  94 .in -2
  95
  96 .SH RETURN VALUES
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBCS_SUCCESS\fR\fR
 101 .ad
 102 .RS 27n
 103 Successful operation.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBCS_BAD_HANDLE\fR\fR
 110 .ad
 111 .RS 27n
 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 27n
 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 27n
 130 No \fBPC\fR Card in socket.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBCS_NO_CIS\fR\fR
 137 .ad
 138 .RS 27n
 139 No Card Information Structure (\fBCIS\fR) on \fBPC\fR Card.
 140 .RE
 141
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
 146 .ad
 147 .RS 27n
 148 No \fBPCMCIA\fR hardware installed.
 149 .RE
 150
 151 .SH CONTEXT
 152 .sp
 153 .LP
 154 These functions 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_Parse_CISTPL_DEVICE\fR(9F), \fBcsx_RegisterClient\fR(9F),
 160 \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
 161 .sp
 162 .LP
 163 \fIPC Card 95 Standard\fR, PCMCIA/JEIDA