usr/src/man/man9f/csx_RequestSocketMask.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_REQUESTSOCKETMASK 9F "Jul 19, 1996"
   7 .SH NAME
   8 csx_RequestSocketMask, csx_ReleaseSocketMask \- set or clear the client's
   9 client event mask
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/pccard.h>
  14
  15
  16
  17 \fBint32_t\fR \fBcsx_RequestSocketMask\fR(\fBclient_handle_t\fR \fIch\fR,
  18      \fBrequest_socket_mask_t *\fR\fIsm\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint32_t\fR \fBcsx_ReleaseSocketMask\fR(\fBclient_handle_t\fR \fIch\fR,
  24      \fBrelease_socket_mask_t *\fR\fIrm\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\fIsm\fR\fR
  45 .ad
  46 .RS 6n
  47 Pointer to a \fBrequest_socket_mask_t\fR structure.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fIrm\fR\fR
  54 .ad
  55 .RS 6n
  56 Pointer to a \fBrelease_socket_mask_t\fR structure.
  57 .RE
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  62 The function \fBcsx_RequestSocketMask()\fR sets the client's client event mask
  63 and enables the client to start receiving events at its event callback handler.
  64 Once this function returns successfully, the client can start receiving events
  65 at its event callback handler. Any pending events generated from the call to
  66 \fBcsx_RegisterClient\fR(9F) will be delivered to the client after this call as
  67 well. This allows the client to set up the event handler mutexes before the
  68 event handler gets called.
  69 .sp
  70 .LP
  71 \fBcsx_RequestSocketMask()\fR must be used before calling
  72 \fBcsx_GetEventMask\fR(9F) or \fBcsx_SetEventMask\fR(9F) for the client event
  73 mask for this socket.
  74 .sp
  75 .LP
  76 The function \fBcsx_ReleaseSocketMask()\fR clears the client's client event
  77 mask.
  78 .SH STRUCTURE MEMBERS
  79 .sp
  80 .LP
  81 The structure members of \fBrequest_socket_mask_t\fR are:
  82 .sp
  83 .in +2
  84 .nf
  85  uint32_t    Socket;       /* socket number */
  86   uint32_t    EventMask;    /* event mask to set or return */
  87 .fi
  88 .in -2
  89
  90 .sp
  91 .LP
  92 The structure members of \fBrelease_socket_mask_t\fR are:
  93 .sp
  94 .in +2
  95 .nf
  96   uint32_t    Socket;       /* socket number */
  97 .fi
  98 .in -2
  99
 100 .sp
 101 .LP
 102 The fields are defined as follows:
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBSocket\fR\fR
 107 .ad
 108 .RS 13n
 109 Not used in Solaris, but for portability with other Card Services
 110 implementations, it should be set to the logical socket number.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fBEventMask\fR\fR
 117 .ad
 118 .RS 13n
 119 This field is bit-mapped. Card Services performs event notification based on
 120 this field. See \fBcsx_event_handler\fR(9E) for valid event definitions and for
 121 additional information about handling events.
 122 .RE
 123
 124 .SH RETURN VALUES
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBCS_SUCCESS\fR\fR
 129 .ad
 130 .RS 27n
 131 Successful operation.
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBCS_BAD_HANDLE\fR\fR
 138 .ad
 139 .RS 27n
 140 Client handle is invalid.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBCS_IN_USE\fR\fR
 147 .ad
 148 .RS 27n
 149 \fBcsx_ReleaseSocketMask()\fR has not been done.
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBCS_BAD_SOCKET\fR\fR
 156 .ad
 157 .RS 27n
 158 \fBcsx_RequestSocketMask()\fR has not been done.
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
 165 .ad
 166 .RS 27n
 167 No \fBPCMCIA\fR hardware installed.
 168 .RE
 169
 170 .SH CONTEXT
 171 .sp
 172 .LP
 173 These functions may be called from user or kernel context.
 174 .SH SEE ALSO
 175 .sp
 176 .LP
 177 \fBcsx_event_handler\fR(9E), \fBcsx_GetEventMask\fR(9F),
 178 \fBcsx_RegisterClient\fR(9F), \fBcsx_SetEventMask\fR(9F)
 179 .sp
 180 .LP
 181 \fIPC Card 95 Standard\fR, PCMCIA/JEIDA