xref: /illumos-gate/usr/src/man/man9f/csx_SetEventMask.9f (revision dd72704bd9e794056c558153663c739e2012d721)
te
Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
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.
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.
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]
CSX_SETEVENTMASK 9F "Jul 19, 1996"
NAME
csx_SetEventMask, csx_GetEventMask - set or return the client event mask for the client
SYNOPSIS
#include <sys/pccard.h>



int32_t csx_SetEventMask(client_handle_t ch, sockevent_t *se);

int32_t csx_GetEventMask(client_handle_t ch, sockevent_t *se);
INTERFACE LEVEL
illumos DDI Specific (illumos DDI)
PARAMETERS
ch

Client handle returned from csx_RegisterClient(9F).

se

Pointer to a sockevent_t structure

DESCRIPTION
The function csx_SetEventMask() sets the client or global event mask for the client.

The function csx_GetEventMask() returns the client or global event mask for the client.

csx_RequestSocketMask(9F) must be called before calling csx_SetEventMask() for the client event mask for this socket.

STRUCTURE MEMBERS
The structure members of sockevent_t are:
uint32_t uint32_t /* attribute flags for call */
uint32_t EventMask; /* event mask to set or return */
uint32_t Socket; /* socket number if necessary */

The fields are defined as follows: Attributes

This is a bit-mapped field that identifies the type of event mask to be returned. The field is defined as follows: CONF_EVENT_MASK_GLOBAL

Client's global event mask. If set, the client's global event mask is returned.

CONF_EVENT_MASK_CLIENT

Client's local event mask. If set, the client's local event mask is returned.

EventMask

This field is bit-mapped. Card Services performs event notification based on this field. See csx_event_handler(9E) for valid event definitions and for additional information about handling events.

Socket

Not used in illumos, but for portability with other Card Services implementations, it should be set to the logical socket number.

RETURN VALUES
CS_SUCCESS

Successful operation.

CS_BAD_HANDLE

Client handle is invalid.

CS_BAD_SOCKET

csx_RequestSocketMask(9F) not called for CONF_EVENT_MASK_CLIENT.

CS_UNSUPPORTED_FUNCTION

No PCMCIA hardware installed.

CONTEXT
These functions may be called from user or kernel context.
SEE ALSO
csx_event_handler (9E), csx_RegisterClient (9F), csx_ReleaseSocketMask (9F), csx_RequestSocketMask (9F)

PC Card 95 Standard, PCMCIA/JEIDA