usr/src/man/man9f/csx_Parse_CISTPL_MANFID.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_MANFID 9F "Dec 20, 1996"
   7 .SH NAME
   8 csx_Parse_CISTPL_MANFID \- parse Manufacturer Identification tuple
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_Parse_CISTPL_MANFID\fR(\fBclient_handle_t\fR \fIch\fR, \fBtuple_t *\fR\fItu\fR,
  17      \fBcistpl_manfid_t *\fR\fIcm\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\fIcm\fR\fR
  48 .ad
  49 .RS 6n
  50 Pointer to a \fBcistpl_manfid_t\fR structure which contains the parsed
  51 \fBCISTPL_MANFID\fR tuple information upon return from this function.
  52 .RE
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 This function parses the Manufacturer Identification tuple,
  58 \fBCISTPL_MANFID,\fR into a form usable by \fBPC \fRCard drivers.
  59 .sp
  60 .LP
  61 The \fBCISTPL_MANFID\fR tuple is used to describe the information about the
  62 manufacturer of a \fBPC \fRCard. There are two types of information, the \fBPC
  63 \fRCard's manufacturer and a manufacturer card number.
  64 .SH STRUCTURE MEMBERS
  65 .sp
  66 .LP
  67 The structure members of \fBcistpl_manfid_t\fR are:
  68 .sp
  69 .in +2
  70 .nf
  71 uint32_t   manf;   /* PCMCIA assigned manufacturer code */
  72 uint32_t   card;   /* manufacturer information
  73                     (part number and/or revision) */
  74 .fi
  75 .in -2
  76
  77 .SH RETURN VALUES
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBCS_SUCCESS\fR\fR
  82 .ad
  83 .RS 27n
  84 Successful operation.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBCS_BAD_HANDLE\fR\fR
  91 .ad
  92 .RS 27n
  93 Client handle is invalid.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBCS_UNKNOWN_TUPLE\fR\fR
 100 .ad
 101 .RS 27n
 102 Parser does not know how to parse tuple.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBCS_NO_CARD\fR\fR
 109 .ad
 110 .RS 27n
 111 No \fBPC \fRCard in socket.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBCS_NO_CIS\fR\fR
 118 .ad
 119 .RS 27n
 120 No Card Information Structure (CIS) on \fBPC \fRcard.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
 127 .ad
 128 .RS 27n
 129 No \fBPCMCIA \fRhardware installed.
 130 .RE
 131
 132 .SH CONTEXT
 133 .sp
 134 .LP
 135 This function may be called from user or kernel context.
 136 .SH SEE ALSO
 137 .sp
 138 .LP
 139 \fBcsx_GetFirstTuple\fR(9F), \fBcsx_GetTupleData\fR(9F),
 140 \fBcsx_RegisterClient\fR(9F), \fBcsx_ValidateCIS\fR(9F), \fBtuple\fR(9S)
 141 .sp
 142 .LP
 143 \fIPC Card 95 Standard,\fR PCMCIA/JEIDA