usr/src/man/man9f/csx_SetEventMask.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_SETEVENTMASK 9F "Jul 19, 1996"
   7 .SH NAME
   8 csx_SetEventMask, csx_GetEventMask \- set or return the client event mask for
   9 the client
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/pccard.h>
  14
  15
  16
  17 \fBint32_t\fR \fBcsx_SetEventMask\fR(\fBclient_handle_t\fR \fIch\fR, \fBsockevent_t *\fR\fIse\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint32_t\fR \fBcsx_GetEventMask\fR(\fBclient_handle_t\fR \fIch\fR, \fBsockevent_t *\fR\fIse\fR);
  23 .fi
  24
  25 .SH INTERFACE LEVEL
  26 .sp
  27 .LP
  28 Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR
  29 .SH PARAMETERS
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIch\fR \fR
  34 .ad
  35 .RS 7n
  36 Client handle returned from \fBcsx_RegisterClient\fR(9F).
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIse\fR \fR
  43 .ad
  44 .RS 7n
  45 Pointer to a \fBsockevent_t\fR structure
  46 .RE
  47
  48 .SH DESCRIPTION
  49 .sp
  50 .LP
  51 The function \fBcsx_SetEventMask()\fR sets the client or global event mask for
  52 the client.
  53 .sp
  54 .LP
  55 The function \fBcsx_GetEventMask()\fR returns the client or global event mask
  56 for the client.
  57 .sp
  58 .LP
  59 \fBcsx_RequestSocketMask\fR(9F) must be called before calling
  60 \fBcsx_SetEventMask()\fR for the client event mask for this socket.
  61 .SH STRUCTURE MEMBERS
  62 .sp
  63 .LP
  64 The structure members of \fBsockevent_t\fR are:
  65 .sp
  66 .in +2
  67 .nf
  68 uint32_t   uint32_t     /* attribute flags for call */
  69 uint32_t   EventMask;   /* event mask to set or return */
  70 uint32_t   Socket;      /* socket number if necessary */
  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\fBAttributes\fR\fR
  81 .ad
  82 .RS 14n
  83 This is a bit-mapped field that identifies the type of event mask to be
  84 returned. The field is defined as follows:
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBCONF_EVENT_MASK_GLOBAL\fR \fR
  89 .ad
  90 .RS 27n
  91 Client's global event mask. If set, the client's global event mask is returned.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBCONF_EVENT_MASK_CLIENT\fR \fR
  98 .ad
  99 .RS 27n
 100 Client's local event mask. If set, the client's local event mask is returned.
 101 .RE
 102
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBEventMask\fR \fR
 109 .ad
 110 .RS 14n
 111 This field is bit-mapped. Card Services performs event notification based on
 112 this field. See \fBcsx_event_handler\fR(9E) for valid event definitions and for
 113 additional information about handling events.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBSocket\fR \fR
 120 .ad
 121 .RS 14n
 122 Not used in Solaris, but for portability with other Card Services
 123 implementations, it should be set to the logical socket number.
 124 .RE
 125
 126 .SH RETURN VALUES
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fBCS_SUCCESS\fR \fR
 131 .ad
 132 .RS 28n
 133 Successful operation.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fBCS_BAD_HANDLE\fR \fR
 140 .ad
 141 .RS 28n
 142 Client handle is invalid.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fBCS_BAD_SOCKET\fR \fR
 149 .ad
 150 .RS 28n
 151 \fBcsx_RequestSocketMask\fR(9F) not called for \fBCONF_EVENT_MASK_CLIENT.\fR
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fBCS_UNSUPPORTED_FUNCTION\fR \fR
 158 .ad
 159 .RS 28n
 160 No \fBPCMCIA \fRhardware installed.
 161 .RE
 162
 163 .SH CONTEXT
 164 .sp
 165 .LP
 166 These functions may be called from user or kernel context.
 167 .SH SEE ALSO
 168 .sp
 169 .LP
 170 \fBcsx_event_handler\fR(9E), \fBcsx_RegisterClient\fR(9F),
 171 \fBcsx_ReleaseSocketMask\fR(9F), \fBcsx_RequestSocketMask\fR(9F)
 172 .sp
 173 .LP
 174 \fIPC Card 95 Standard,\fR  PCMCIA/JEIDA