csx_Parse_CISTPL_SPCL(9f)

1csx_Parse_CISTPL_SPCL(9F)Kernel Functions for Driverscsx_Parse_CISTPL_SPCL(9F)
2
3
4

NAME

6       csx_Parse_CISTPL_SPCL - parse the Special Purpose tuple
7

SYNOPSIS

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

INTERFACE LEVEL

18       Solaris DDI Specific (Solaris DDI)
19

PARAMETERS

21       ch     Client handle returned from csx_RegisterClient(9F).
22
23
24       tu     Pointer  to  a  tuple_t  structure (see tuple(9S)) returned by a
25              call to csx_GetFirstTuple(9F) or csx_GetNextTuple(9F).
26
27
28       csp    Pointer to a cistpl_spcl_t structure which contains  the  parsed
29              CISTPL_SPCL tuple information upon return from this function.
30
31

DESCRIPTION

33       This  function  parses  the  Special Purpose tuple, CISTPL_SPCL, into a
34       form usable by PC Card drivers.
35
36
37       The CISTPL_SPCL tuple is identified by an identification field that  is
38       assigned  by  PCMCIA  or  JEIDA.  A  sequence  field allows a series of
39       CISTPL_SPCL tuples to be used when the data exceeds the size  that  can
40       be  stored  in  a  single  tuple;  the maximum data area of a series of
41       CISTPL_SPCL tuples is unlimited. Another  field  gives  the  number  of
42       bytes in the data field in this tuple.
43

STRUCTURE MEMBERS

45       The structure members of cistpl_date_t are:
46
47         uint32_t    id;       /* tuple contents identification */
48         uint32_t    seq;      /* data sequence number */
49         uint32_t    bytes;    /* number of bytes following */
50         uchar_t     data[CIS_MAX_TUPLE_DATA_LEN];
51
52
53
54       The fields are defined as follows:
55
56       id       This  field  contains  a  PCMCIA  or JEIDA assigned value that
57                identifies this series of  one  or  more  CISTPL_SPCL  tuples.
58                These field values are assigned by contacting either PCMCIA or
59                JEIDA.
60
61
62       seq      This    field    contains    a    data    sequence     number.
63                CISTPL_SPCL_SEQ_END is the last tuple in sequence.
64
65
66       bytes    This   field   contains  the  number  of  data  bytes  in  the
67                data[CIS_MAX_TUPLE_DATA_LEN].
68
69
70       data     The data component of this tuple.
71
72

RETURN VALUES

74       CS_SUCCESS                 Successful operation.
75
76
77       CS_BAD_HANDLE              Client handle is invalid.
78
79
80       CS_UNKNOWN_TUPLE           Parser does not know how to parse tuple.
81
82
83       CS_NO_CARD                 No PC Card in socket.
84
85
86       CS_NO_CIS                  No Card Information Structure  (CIS)  on  PC
87                                  Card.
88
89
90       CS_UNSUPPORTED_FUNCTION    No PCMCIA hardware installed.
91
92

CONTEXT

94       This function may be called from user or kernel context.
95