usr/src/man/man9f/csx_ResetFunction.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_RESETFUNCTION 9F "Jul 19, 1996"
   7 .SH NAME
   8 csx_ResetFunction \- reset a function on a PC card
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_ResetFunction\fR(\fBclient_handle_t\fR \fIch\fR, \fBreset_function_t *\fR\fIrf\fR);
  17 .fi
  18
  19 .SH INTERFACE LEVEL
  20 .sp
  21 .LP
  22 Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR)
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIch\fR\fR
  28 .ad
  29 .RS 6n
  30 Client handle returned from \fBcsx_RegisterClient\fR(9F).
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIrf\fR\fR
  37 .ad
  38 .RS 6n
  39 Pointer to a \fBreset_function_t\fR structure.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 \fBcsx_ResetFunction()\fR requests that the specified function on the \fBPC\fR
  46 card initiate a reset operation.
  47 .SH STRUCTURE MEMBERS
  48 .sp
  49 .LP
  50 The structure members of \fBreset_function_t\fR are:
  51 .sp
  52 .in +2
  53 .nf
  54  uint32_t     Socket;        /* socket number */
  55   uint32_t     Attributes;    /* reset attributes  */
  56 .fi
  57 .in -2
  58
  59 .sp
  60 .LP
  61 The fields are defined as follows:
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBSocket\fR\fR
  66 .ad
  67 .RS 14n
  68 Not used in Solaris, but for portability with other Card Services
  69 implementations, it should be set to the logical socket number.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBAttributes\fR\fR
  76 .ad
  77 .RS 14n
  78 Must be \fB0\fR.
  79 .RE
  80
  81 .SH RETURN VALUES
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBCS_SUCCESS\fR\fR
  86 .ad
  87 .RS 27n
  88 Card Services has noted the reset request.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBCS_IN_USE\fR\fR
  95 .ad
  96 .RS 27n
  97 This Card Services implementation does not permit configured cards to be reset.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBCS_BAD_HANDLE\fR\fR
 104 .ad
 105 .RS 27n
 106 Client handle is invalid.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBCS_NO_CARD\fR\fR
 113 .ad
 114 .RS 27n
 115 No \fBPC\fR card in socket.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBCS_BAD_SOCKET\fR\fR
 122 .ad
 123 .RS 27n
 124 Specified socket or function number is invalid.
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
 131 .ad
 132 .RS 27n
 133 No \fBPCMCIA\fR hardware installed.
 134 .RE
 135
 136 .SH CONTEXT
 137 .sp
 138 .LP
 139 This function may be called from user or kernel context.
 140 .SH SEE ALSO
 141 .sp
 142 .LP
 143 \fBcsx_event_handler\fR(9E), \fBcsx_RegisterClient\fR(9F)
 144 .sp
 145 .LP
 146 \fIPC Card 95 Standard\fR, PCMCIA/JEIDA
 147 .SH NOTES
 148 .sp
 149 .LP
 150 \fBcsx_ResetFunction()\fR has not been implemented in this release and always
 151 returns \fBCS_IN_USE\fR.