csx_Parse_CISTPL_BATTERY(9f)

1csx_Parse_CISTPL_BATTERY(9KFe)rnel Functions for Drivecrssx_Parse_CISTPL_BATTERY(9F)
2
3
4

NAME

6       csx_Parse_CISTPL_BATTERY - parse the Battery Replacement Date tuple
7

SYNOPSIS

9       #include <sys/pccard.h>
10
11
12
13       int32_t csx_Parse_CISTPL_BATTERY(client_handle_t ch, tuple_t *tu,
14            cistpl_battery_t *cb);
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       cb    Pointer to a cistpl_battery_t structure which contains the parsed
29             CISTPL_BATTERY tuple information upon return from this function.
30
31

DESCRIPTION

33       This  function  parses  the Battery Replacement Date tuple, CISTPL_BAT‐
34       TERY, into a form usable by PC Card drivers.
35
36
37       The CISTPL_BATTERY tuple is an optional tuple which  shall  be  present
38       only  in PC Cards with battery-backed storage. It indicates the date on
39       which the battery was replaced, and the date on which  the  battery  is
40       expected  to need replacement. Only one CISTPL_BATTERY tuple is allowed
41       per PC Card.
42

STRUCTURE MEMBERS

44       The structure members of cistpl_battery_t are:
45
46         uint32_t     rday;     /* date battery last replaced */
47         uint32_t     xday;     /* date battery due for replacement */
48
49
50
51       The fields are defined as follows:
52
53       rday    This field indicates the date on which  the  battery  was  last
54               replaced.
55
56
57       xday    This  field  indicates  the date on which the battery should be
58               replaced.
59
60

RETURN VALUES

62       CS_SUCCESS                 Successful operation.
63
64
65       CS_BAD_HANDLE              Client handle is invalid.
66
67
68       CS_UNKNOWN_TUPLE           Parser does not know how to parse tuple.
69
70
71       CS_NO_CARD                 No PC Card in socket.
72
73
74       CS_NO_CIS                  No Card Information Structure  (CIS)  on  PC
75                                  Card.
76
77
78       CS_UNSUPPORTED_FUNCTION    No PCMCIA hardware installed.
79
80

CONTEXT

82       This function may be called from user or kernel context.
83