csx_Parse_CISTPL_FORMAT(9f)

1csx_Parse_CISTPL_FORMAT(9FK)ernel Functions for Drivercssx_Parse_CISTPL_FORMAT(9F)
2
3
4

NAME

6       csx_Parse_CISTPL_FORMAT - parse the Data Recording Format tuple
7

SYNOPSIS

9       #include <sys/pccard.h>
10
11
12
13       int32_t csx_Parse_CISTPL_FORMAT(client_handle_t ch, tuple_t *tu,
14            cistpl_format_t *pt);
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 call
25             to csx_GetFirstTuple(9F) or csx_GetNextTuple(9F).
26
27
28       pt    Pointer to a cistpl_format_t structure which contains the  parsed
29             CISTPL_FORMAT tuple information upon return from this function.
30
31

DESCRIPTION

33       This  function  parses  the Data Recording Format tuple, CISTPL_FORMAT,
34       into a form usable by PC Card drivers.
35
36
37       The CISTPL_FORMAT tuple indicates  the  data  recording  format  for  a
38       device partition.
39

STRUCTURE MEMBERS

41       The structure members of cistpl_format_t are:
42
43         uint32_t     type;
44         uint32_t     edc_length;
45         uint32_t     edc_type;
46         uint32_t     offset;
47         uint32_t     nbytes;
48         uint32_t     dev.disk.bksize;
49         uint32_t     dev.disk.nblocks;
50         uint32_t     dev.disk.edcloc;
51         uint32_t     dev.mem.flags;
52         uint32_t     dev.mem.reserved;
53         caddr_t      dev.mem.address;
54         uint32_t     dev.mem.edcloc;
55
56
57
58       The fields are defined as follows:
59
60       type                This field indicates the type of device:
61
62                           TPLFMTTYPE_DISK    disk-like device
63
64
65                           TPLFMTTYPE_MEM     memory-like device
66
67
68                           TPLFMTTYPE_VS      vendor-specific device
69
70
71
72       edc_length          This  field  indicates  the  error  detection  code
73                           length.
74
75
76       edc_type            This field indicates the error detection code type.
77
78
79       offset              This field indicates the offset of the  first  byte
80                           of data in this partition.
81
82
83       nbytes              This field indicates the number of bytes of data in
84                           this partition
85
86
87       dev.disk.bksize     This field  indicates  the  block  size,  for  disk
88                           devices.
89
90
91       dev.disk.nblocks    This field indicates the number of blocks, for disk
92                           devices.
93
94
95       dev.disk.edcloc     This field indicates  the  location  of  the  error
96                           detection code, for disk devices.
97
98
99       dev.mem.flags       This  field  provides  flags,  for  memory devices.
100                           Valid flags are:
101
102                           TPLFMTFLAGS_ADDR    address is valid
103
104
105                           TPLFMTFLAGS_AUTO    automatically map memory region
106
107
108
109       dev.mem.reserved    This field is reserved.
110
111
112       dev.mem.address     This field indicates the physical address, for mem‐
113                           ory devices.
114
115
116       dev.mem.edcloc      This  field  indicates  the  location  of the error
117                           detection code, for memory devices.
118
119

RETURN VALUES

121       CS_SUCCESS                 Successful operation.
122
123
124       CS_BAD_HANDLE              Client handle is invalid.
125
126
127       CS_UNKNOWN_TUPLE           Parser does not know how to parse tuple.
128
129
130       CS_NO_CARD                 No PC Card in socket.
131
132
133       CS_NO_CIS                  No Card Information Structure  (CIS)  on  PC
134                                  Card.
135
136
137       CS_UNSUPPORTED_FUNCTION    No PCMCIA hardware installed.
138
139

CONTEXT

141       This function may be called from user or kernel context.
142