csx_seteventmask(9f) [sunos man page]

csx_SetEventMask(9F)					   Kernel Functions for Drivers 				      csx_SetEventMask(9F)

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

       Solaris DDI Specific (Solaris 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 def-
	   initions and for additional information about handling events.

       Socket

	   Not used in Solaris, 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

SunOS 5.10							    19 Jul 1996 					      csx_SetEventMask(9F)

csx_RequestSocketMask(9F)				   Kernel Functions for Drivers 				 csx_RequestSocketMask(9F)

NAME

       csx_RequestSocketMask, csx_ReleaseSocketMask - set or clear the client's client event mask

SYNOPSIS

       #include <sys/pccard.h>

       int32_t csx_RequestSocketMask(client_handle_t ch, request_socket_mask_t *sm);

       int32_t csx_ReleaseSocketMask(client_handle_t ch, release_socket_mask_t *rm);

INTERFACE LEVEL

       Solaris DDI Specific (Solaris DDI)

PARAMETERS

       ch	Client handle returned from csx_RegisterClient(9F).

       sm	Pointer to a request_socket_mask_t structure.

       rm	Pointer to a release_socket_mask_t structure.

DESCRIPTION

       The  function  csx_RequestSocketMask()  sets  the  client's client event mask and enables the client to start receiving events at its event
       callback handler. Once this function returns successfully, the client can start receiving events at its event callback handler. Any pending
       events generated from the call to csx_RegisterClient(9F) will be delivered to the client after this call as well. This allows the client to
       set up the event handler mutexes before the event handler gets called.

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

       The function csx_ReleaseSocketMask() clears the client's client event mask.

STRUCTURE MEMBERS

       The structure members of request_socket_mask_t are:

	 uint32_t    Socket;	   /* socket number */
	 uint32_t    EventMask;    /* event mask to set or return */

       The structure members of release_socket_mask_t are:

	 uint32_t    Socket;	   /* socket number */

       The fields are defined as follows:

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

       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.

RETURN VALUES

       CS_SUCCESS		       Successful operation.

       CS_BAD_HANDLE		       Client handle is invalid.

       CS_IN_USE		       csx_ReleaseSocketMask() has not been done.

       CS_BAD_SOCKET		       csx_RequestSocketMask() has not been done.

       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_GetEventMask(9F), csx_RegisterClient(9F), csx_SetEventMask(9F)

       PC Card 95 Standard, PCMCIA/JEIDA

SunOS 5.10							    19 Jul 1996 					 csx_RequestSocketMask(9F)