1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
/*
* drivers.h
*
* Header file for exporting UPS drivers.
*/
/*
* Copyright (C) 1999-2001 Riccardo Facchetti <riccardo@master.oasi.gpa.it>
* Copyright (C) 1996-1999 Andre M. Hedrick <andre@suse.com>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 2 of the GNU General
* Public License as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
* MA 02111-1307, USA.
*/
#ifndef _DRIVERS_H
#define _DRIVERS_H
/*
* This is the generic drivers structure. It contain any routine needed for
* managing a device (or family of devices, like Smart UPSes).
*
* Routines defined:
*
* open()
* Opens the device and setup the file descriptor. Returns a working file
* descriptor. This function does not interact with hardware functionality.
* In case of error, this function does not return. It simply exit.
*
* setup()
* Setup the device for operations. This function interacts with hardware to
* make sure on the other end there is an UPS and that the link is working.
* In case of error, this function does not return. It simply exit.
*
* close()
* Closes the device returning it to the original status.
* This function always returns.
*
* kill_power()
* Put the UPS into hibernation mode, killing output power.
* This function always returns.
*
* shutdown()
* Turn off the UPS completely.
* This function always returns.
*
* read_ups_static_data()
* Gets the static data from UPS like the UPS name.
* This function always returns.
*
* read_ups_volatile_data()
* Fills UPSINFO with dynamic UPS data.
* This function always returns.
* This function must lock the UPSINFO structure.
*
* get_ups_capabilities()
* Try to understand what capabilities the UPS is able to perform.
* This function always returns.
*
* check_ups_state()
* Check if the UPS changed state.
* This function always returns.
* This function must lock the UPSINFO structure.
*
* ups_program_eeprom(ups, command, data)
* Commit changes to the internal UPS eeprom.
* This function performs the eeprom change command (using data),
* then returns.
*
* ups_generic_entry_point()
* This is a generic entry point into the drivers for specific driver
* functions called from inside the apcupsd core.
* This function always return.
* This function must lock the UPSINFO structure.
* This function gets a void * that contain data. This pointer can be used
* to pass data to the function or to get return values from the function,
* depending on the value of "command" and the general design of the specific
* command to be executed.
* Each driver will have its specific functions and will ignore any
* function that does not understand.
*/
typedef struct upsdriver {
/* Data side of the driver structure. */
const char *driver_name;
/* Functions side of the driver structure. */
int (*open) (UPSINFO *ups);
int (*setup) (UPSINFO *ups);
int (*close) (UPSINFO *ups);
int (*kill_power) (UPSINFO *ups);
int (*shutdown) (UPSINFO *ups);
int (*read_ups_static_data) (UPSINFO *ups);
int (*read_ups_volatile_data) (UPSINFO *ups);
int (*get_ups_capabilities) (UPSINFO *ups);
int (*check_ups_state) (UPSINFO *ups);
int (*ups_program_eeprom) (UPSINFO *ups, int command, const char *data);
int (*ups_entry_point) (UPSINFO *ups, int command, void *data);
} UPSDRIVER;
/* Some defines that helps code readability. */
#define device_open(ups) \
do { \
if (ups->driver) ups->driver->open(ups); \
} while(0)
#define device_setup(ups) \
do { \
if (ups->driver) ups->driver->setup(ups); \
} while(0)
#define device_close(ups) \
do { \
if (ups->driver) ups->driver->close(ups); \
} while(0)
#define device_kill_power(ups) \
do { \
if (ups->driver) ups->driver->kill_power(ups); \
} while(0)
#define device_shutdown(ups) \
do { \
if (ups->driver) { \
if (ups->driver->shutdown) { \
ups->driver->shutdown(ups); \
} else { \
Dmsg1(000, "Power off not supported for %s driver\n", \
ups->driver->driver_name); \
} \
} \
} while(0)
#define device_read_static_data(ups) \
do { \
if (ups->driver) ups->driver->read_ups_static_data(ups); \
} while(0)
#define device_read_volatile_data(ups) \
do { \
if (ups->driver) ups->driver->read_ups_volatile_data(ups); \
} while(0)
#define device_get_capabilities(ups) \
do { \
if (ups->driver) ups->driver->get_ups_capabilities(ups); \
} while(0)
#define device_check_state(ups) \
do { \
if (ups->driver) ups->driver->check_ups_state(ups); \
} while(0)
#define device_program_eeprom(ups, command, data) \
do { \
if (ups->driver) ups->driver->ups_program_eeprom(ups, command, data); \
} while(0)
#define device_entry_point(ups, command, data) \
do { \
if (ups->driver) ups->driver->ups_entry_point(ups, command, data); \
} while(0)
/* Now some defines for device_entry_point commands. */
/* Dumb entry points. */
#define DEVICE_CMD_DTR_ENABLE 0x00
#define DEVICE_CMD_DTR_ST_DISABLE 0x01
/* Smart entry points. */
#define DEVICE_CMD_GET_SELFTEST_MSG 0x02
#define DEVICE_CMD_CHECK_SELFTEST 0x03
#define DEVICE_CMD_SET_DUMB_MODE 0x04
/* Support routines. */
const UPSDRIVER *attach_driver(UPSINFO *ups);
#endif /*_DRIVERS_H */
|
