csx_RequestSocketMask(9f)

1csx_RequestSocketMask(9F)Kernel Functions for Driverscsx_RequestSocketMask(9F)
2
3
4

NAME

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

SYNOPSIS

10       #include <sys/pccard.h>
11
12
13
14       int32_t csx_RequestSocketMask(client_handle_t ch,
15            request_socket_mask_t *sm);
16
17
18       int32_t csx_ReleaseSocketMask(client_handle_t ch,
19            release_socket_mask_t *rm);
20
21

INTERFACE LEVEL

23       Solaris DDI Specific (Solaris DDI)
24

PARAMETERS

26       ch    Client handle returned from csx_RegisterClient(9F).
27
28
29       sm    Pointer to a request_socket_mask_t structure.
30
31
32       rm    Pointer to a release_socket_mask_t structure.
33
34

DESCRIPTION

36       The function csx_RequestSocketMask() sets  the  client's  client  event
37       mask  and  enables  the  client  to start receiving events at its event
38       callback handler. Once this function returns successfully,  the  client
39       can  start  receiving events at its event callback handler. Any pending
40       events generated from the call to csx_RegisterClient(9F) will be deliv‐
41       ered  to  the client after this call as well. This allows the client to
42       set up the event handler mutexes before the event handler gets called.
43
44
45       csx_RequestSocketMask()  must  be  used  before  calling  csx_GetEvent‐
46       Mask(9F)  or  csx_SetEventMask(9F)  for  the client event mask for this
47       socket.
48
49
50       The function csx_ReleaseSocketMask() clears the client's  client  event
51       mask.
52

STRUCTURE MEMBERS

54       The structure members of request_socket_mask_t are:
55
56          uint32_t    Socket;       /* socket number */
57           uint32_t    EventMask;    /* event mask to set or return */
58
59
60
61       The structure members of release_socket_mask_t are:
62
63           uint32_t    Socket;       /* socket number */
64
65
66
67       The fields are defined as follows:
68
69       Socket       Not  used  in Solaris, but for portability with other Card
70                    Services implementations, it should be set to the  logical
71                    socket number.
72
73
74       EventMask    This  field  is  bit-mapped.  Card Services performs event
75                    notification  based  on  this  field.  See  csx_event_han‐
76                    dler(9E)  for  valid  event definitions and for additional
77                    information about handling events.
78
79

RETURN VALUES

81       CS_SUCCESS                 Successful operation.
82
83
84       CS_BAD_HANDLE              Client handle is invalid.
85
86
87       CS_IN_USE                  csx_ReleaseSocketMask() has not been done.
88
89
90       CS_BAD_SOCKET              csx_RequestSocketMask() has not been done.
91
92
93       CS_UNSUPPORTED_FUNCTION    No PCMCIA hardware installed.
94
95

CONTEXT

97       These functions may be called from user or kernel context.
98