csx_GetTupleData(9f)

1csx_GetTupleData(9F)     Kernel Functions for Drivers     csx_GetTupleData(9F)
2
3
4

NAME

6       csx_GetTupleData - return the data portion of a tuple
7

SYNOPSIS

9       #include <sys/pccard.h>
10
11
12
13       int32_t csx_GetTupleData(client_handle_t ch, tuple_t *tu);
14
15

INTERFACE LEVEL

17       Solaris DDI Specific (Solaris DDI)
18

PARAMETERS

20       ch    Client handle returned from csx_RegisterClient(9F).
21
22
23       tu    Pointer to a tuple_t structure.
24
25

DESCRIPTION

27       This  function  returns the data portion of a tuple, as returned by the
28       csx_GetFirstTuple(9F) and csx_GetNextTuple(9F) functions.
29

STRUCTURE MEMBERS

31       The structure members of tuple_t are:
32
33
34       The fields are defined as follows:
35
36         uint32_t  Socket;                           /* socket number */
37         uint32_t  Attributes;                       /* tuple attributes*/
38         cisdata_t DesiredTuple;                     /* tuple to search for*/
39         cisdata_t TupleOffset;                      /* tuple data offset*/
40         cisdata_t TupleDataMax;                     /* max tuple data size*/
41         cisdata_t TupleDataLen;                     /* actual tuple data length*/
42         cisdata_t TupleData[CIS_MAX_TUPLE_DATA_LEN];/* tuple body data buffer*/
43         cisdata_t TupleCode;                        /* tuple type code*/
44         cisdata_t TupleLink;                        /* tuple link */
45
46
47       Socket          Not used in Solaris, but  for  portability  with  other
48                       Card  Services implementations, it should be set to the
49                       logical socket number.
50
51
52       Attributes      Initialized by  csx_GetFirstTuple(9F)  or  csx_GetNext‐
53                       Tuple(9F); the client must not modify the value in this
54                       field.
55
56
57       DesiredTuple    Initialized by  csx_GetFirstTuple(9F)  or  csx_GetNext‐
58                       Tuple(9F); the client must not modify the value in this
59                       field.
60
61
62       TupleOffset     This field  allows  partial  tuple  information  to  be
63                       retrieved, starting anywhere within the tuple.
64
65
66       TupleDataMax    This  field  is  the size of the tuple data buffer that
67                       Card Services  uses  to  return  raw  tuple  data  from
68                       csx_GetTupleData.  It  can be larger than the number of
69                       bytes in the tuple data body. Card Services ignores any
70                       value placed here by the client.
71
72
73       TupleDataLen    This  field  is the actual size of the tuple data body.
74                       It represents the  number  of  tuple  data  body  bytes
75                       returned.
76
77
78       TupleData       This  field  is  an  array  of bytes containing the raw
79                       tuple data body contents.
80
81
82       TupleCode       Initialized by  csx_GetFirstTuple(9F)  or  csx_GetNext‐
83                       Tuple(9F); the client must not modify the value in this
84                       field.
85
86
87       TupleLink       Initialized by  csx_GetFirstTuple(9F)  or  csx_GetNext‐
88                       Tuple(9F); the client must not modify the value in this
89                       field.
90
91

RETURN VALUES

93       CS_SUCCESS                 Successful operation.
94
95
96       CS_BAD_HANDLE              Client handle is invalid.
97
98
99       CS_BAD_ARGS                Data  from  prior  csx_GetFirstTuple(9F)  or
100                                  csx_GetNextTuple(9F) is corrupt.
101
102
103       CS_NO_CARD                 No PC Card in socket.
104
105
106       CS_NO_CIS                  No  Card  Information  Structure (CIS) on PC
107                                  Card.
108
109
110       CS_NO_MORE_ITEMS           Card Services was not able to read the tuple
111                                  from the PC Card.
112
113
114       CS_UNSUPPORTED_FUNCTION    No PCMCIA hardware installed.
115
116

CONTEXT

118       This function may be called from user or kernel context.
119