regulator: Remove extraneous kerneldoc annotations
[linux-2.6] / drivers / acpi / ac.c
1 /*
2  *  acpi_ac.c - ACPI AC Adapter Driver ($Revision: 27 $)
3  *
4  *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6  *
7  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8  *
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License as published by
11  *  the Free Software Foundation; either version 2 of the License, or (at
12  *  your option) any later version.
13  *
14  *  This program is distributed in the hope that it will be useful, but
15  *  WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  *  General Public License for more details.
18  *
19  *  You should have received a copy of the GNU General Public License along
20  *  with this program; if not, write to the Free Software Foundation, Inc.,
21  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
22  *
23  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24  */
25
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/init.h>
29 #include <linux/types.h>
30 #ifdef CONFIG_ACPI_PROCFS_POWER
31 #include <linux/proc_fs.h>
32 #include <linux/seq_file.h>
33 #endif
34 #ifdef CONFIG_ACPI_SYSFS_POWER
35 #include <linux/power_supply.h>
36 #endif
37 #include <acpi/acpi_bus.h>
38 #include <acpi/acpi_drivers.h>
39
40 #define ACPI_AC_CLASS                   "ac_adapter"
41 #define ACPI_AC_DEVICE_NAME             "AC Adapter"
42 #define ACPI_AC_FILE_STATE              "state"
43 #define ACPI_AC_NOTIFY_STATUS           0x80
44 #define ACPI_AC_STATUS_OFFLINE          0x00
45 #define ACPI_AC_STATUS_ONLINE           0x01
46 #define ACPI_AC_STATUS_UNKNOWN          0xFF
47
48 #define _COMPONENT              ACPI_AC_COMPONENT
49 ACPI_MODULE_NAME("ac");
50
51 MODULE_AUTHOR("Paul Diefenbaugh");
52 MODULE_DESCRIPTION("ACPI AC Adapter Driver");
53 MODULE_LICENSE("GPL");
54
55 #ifdef CONFIG_ACPI_PROCFS_POWER
56 extern struct proc_dir_entry *acpi_lock_ac_dir(void);
57 extern void *acpi_unlock_ac_dir(struct proc_dir_entry *acpi_ac_dir);
58 static int acpi_ac_open_fs(struct inode *inode, struct file *file);
59 #endif
60
61 static int acpi_ac_add(struct acpi_device *device);
62 static int acpi_ac_remove(struct acpi_device *device, int type);
63 static int acpi_ac_resume(struct acpi_device *device);
64
65 static const struct acpi_device_id ac_device_ids[] = {
66         {"ACPI0003", 0},
67         {"", 0},
68 };
69 MODULE_DEVICE_TABLE(acpi, ac_device_ids);
70
71 static struct acpi_driver acpi_ac_driver = {
72         .name = "ac",
73         .class = ACPI_AC_CLASS,
74         .ids = ac_device_ids,
75         .ops = {
76                 .add = acpi_ac_add,
77                 .remove = acpi_ac_remove,
78                 .resume = acpi_ac_resume,
79                 },
80 };
81
82 struct acpi_ac {
83 #ifdef CONFIG_ACPI_SYSFS_POWER
84         struct power_supply charger;
85 #endif
86         struct acpi_device * device;
87         unsigned long long state;
88 };
89
90 #define to_acpi_ac(x) container_of(x, struct acpi_ac, charger);
91
92 #ifdef CONFIG_ACPI_PROCFS_POWER
93 static const struct file_operations acpi_ac_fops = {
94         .owner = THIS_MODULE,
95         .open = acpi_ac_open_fs,
96         .read = seq_read,
97         .llseek = seq_lseek,
98         .release = single_release,
99 };
100 #endif
101 #ifdef CONFIG_ACPI_SYSFS_POWER
102 static int get_ac_property(struct power_supply *psy,
103                            enum power_supply_property psp,
104                            union power_supply_propval *val)
105 {
106         struct acpi_ac *ac = to_acpi_ac(psy);
107         switch (psp) {
108         case POWER_SUPPLY_PROP_ONLINE:
109                 val->intval = ac->state;
110                 break;
111         default:
112                 return -EINVAL;
113         }
114         return 0;
115 }
116
117 static enum power_supply_property ac_props[] = {
118         POWER_SUPPLY_PROP_ONLINE,
119 };
120 #endif
121 /* --------------------------------------------------------------------------
122                                AC Adapter Management
123    -------------------------------------------------------------------------- */
124
125 static int acpi_ac_get_state(struct acpi_ac *ac)
126 {
127         acpi_status status = AE_OK;
128
129
130         if (!ac)
131                 return -EINVAL;
132
133         status = acpi_evaluate_integer(ac->device->handle, "_PSR", NULL, &ac->state);
134         if (ACPI_FAILURE(status)) {
135                 ACPI_EXCEPTION((AE_INFO, status, "Error reading AC Adapter state"));
136                 ac->state = ACPI_AC_STATUS_UNKNOWN;
137                 return -ENODEV;
138         }
139
140         return 0;
141 }
142
143 #ifdef CONFIG_ACPI_PROCFS_POWER
144 /* --------------------------------------------------------------------------
145                               FS Interface (/proc)
146    -------------------------------------------------------------------------- */
147
148 static struct proc_dir_entry *acpi_ac_dir;
149
150 static int acpi_ac_seq_show(struct seq_file *seq, void *offset)
151 {
152         struct acpi_ac *ac = seq->private;
153
154
155         if (!ac)
156                 return 0;
157
158         if (acpi_ac_get_state(ac)) {
159                 seq_puts(seq, "ERROR: Unable to read AC Adapter state\n");
160                 return 0;
161         }
162
163         seq_puts(seq, "state:                   ");
164         switch (ac->state) {
165         case ACPI_AC_STATUS_OFFLINE:
166                 seq_puts(seq, "off-line\n");
167                 break;
168         case ACPI_AC_STATUS_ONLINE:
169                 seq_puts(seq, "on-line\n");
170                 break;
171         default:
172                 seq_puts(seq, "unknown\n");
173                 break;
174         }
175
176         return 0;
177 }
178
179 static int acpi_ac_open_fs(struct inode *inode, struct file *file)
180 {
181         return single_open(file, acpi_ac_seq_show, PDE(inode)->data);
182 }
183
184 static int acpi_ac_add_fs(struct acpi_device *device)
185 {
186         struct proc_dir_entry *entry = NULL;
187
188
189         if (!acpi_device_dir(device)) {
190                 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
191                                                      acpi_ac_dir);
192                 if (!acpi_device_dir(device))
193                         return -ENODEV;
194                 acpi_device_dir(device)->owner = THIS_MODULE;
195         }
196
197         /* 'state' [R] */
198         entry = proc_create_data(ACPI_AC_FILE_STATE,
199                                  S_IRUGO, acpi_device_dir(device),
200                                  &acpi_ac_fops, acpi_driver_data(device));
201         if (!entry)
202                 return -ENODEV;
203         return 0;
204 }
205
206 static int acpi_ac_remove_fs(struct acpi_device *device)
207 {
208
209         if (acpi_device_dir(device)) {
210                 remove_proc_entry(ACPI_AC_FILE_STATE, acpi_device_dir(device));
211
212                 remove_proc_entry(acpi_device_bid(device), acpi_ac_dir);
213                 acpi_device_dir(device) = NULL;
214         }
215
216         return 0;
217 }
218 #endif
219
220 /* --------------------------------------------------------------------------
221                                    Driver Model
222    -------------------------------------------------------------------------- */
223
224 static void acpi_ac_notify(acpi_handle handle, u32 event, void *data)
225 {
226         struct acpi_ac *ac = data;
227         struct acpi_device *device = NULL;
228
229
230         if (!ac)
231                 return;
232
233         device = ac->device;
234         switch (event) {
235         default:
236                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
237                                   "Unsupported event [0x%x]\n", event));
238         case ACPI_AC_NOTIFY_STATUS:
239         case ACPI_NOTIFY_BUS_CHECK:
240         case ACPI_NOTIFY_DEVICE_CHECK:
241                 acpi_ac_get_state(ac);
242                 acpi_bus_generate_proc_event(device, event, (u32) ac->state);
243                 acpi_bus_generate_netlink_event(device->pnp.device_class,
244                                                   dev_name(&device->dev), event,
245                                                   (u32) ac->state);
246 #ifdef CONFIG_ACPI_SYSFS_POWER
247                 kobject_uevent(&ac->charger.dev->kobj, KOBJ_CHANGE);
248 #endif
249         }
250
251         return;
252 }
253
254 static int acpi_ac_add(struct acpi_device *device)
255 {
256         int result = 0;
257         acpi_status status = AE_OK;
258         struct acpi_ac *ac = NULL;
259
260
261         if (!device)
262                 return -EINVAL;
263
264         ac = kzalloc(sizeof(struct acpi_ac), GFP_KERNEL);
265         if (!ac)
266                 return -ENOMEM;
267
268         ac->device = device;
269         strcpy(acpi_device_name(device), ACPI_AC_DEVICE_NAME);
270         strcpy(acpi_device_class(device), ACPI_AC_CLASS);
271         device->driver_data = ac;
272
273         result = acpi_ac_get_state(ac);
274         if (result)
275                 goto end;
276
277 #ifdef CONFIG_ACPI_PROCFS_POWER
278         result = acpi_ac_add_fs(device);
279 #endif
280         if (result)
281                 goto end;
282 #ifdef CONFIG_ACPI_SYSFS_POWER
283         ac->charger.name = acpi_device_bid(device);
284         ac->charger.type = POWER_SUPPLY_TYPE_MAINS;
285         ac->charger.properties = ac_props;
286         ac->charger.num_properties = ARRAY_SIZE(ac_props);
287         ac->charger.get_property = get_ac_property;
288         power_supply_register(&ac->device->dev, &ac->charger);
289 #endif
290         status = acpi_install_notify_handler(device->handle,
291                                              ACPI_ALL_NOTIFY, acpi_ac_notify,
292                                              ac);
293         if (ACPI_FAILURE(status)) {
294                 result = -ENODEV;
295                 goto end;
296         }
297
298         printk(KERN_INFO PREFIX "%s [%s] (%s)\n",
299                acpi_device_name(device), acpi_device_bid(device),
300                ac->state ? "on-line" : "off-line");
301
302       end:
303         if (result) {
304 #ifdef CONFIG_ACPI_PROCFS_POWER
305                 acpi_ac_remove_fs(device);
306 #endif
307                 kfree(ac);
308         }
309
310         return result;
311 }
312
313 static int acpi_ac_resume(struct acpi_device *device)
314 {
315         struct acpi_ac *ac;
316         unsigned old_state;
317         if (!device || !acpi_driver_data(device))
318                 return -EINVAL;
319         ac = acpi_driver_data(device);
320         old_state = ac->state;
321         if (acpi_ac_get_state(ac))
322                 return 0;
323 #ifdef CONFIG_ACPI_SYSFS_POWER
324         if (old_state != ac->state)
325                 kobject_uevent(&ac->charger.dev->kobj, KOBJ_CHANGE);
326 #endif
327         return 0;
328 }
329
330 static int acpi_ac_remove(struct acpi_device *device, int type)
331 {
332         acpi_status status = AE_OK;
333         struct acpi_ac *ac = NULL;
334
335
336         if (!device || !acpi_driver_data(device))
337                 return -EINVAL;
338
339         ac = acpi_driver_data(device);
340
341         status = acpi_remove_notify_handler(device->handle,
342                                             ACPI_ALL_NOTIFY, acpi_ac_notify);
343 #ifdef CONFIG_ACPI_SYSFS_POWER
344         if (ac->charger.dev)
345                 power_supply_unregister(&ac->charger);
346 #endif
347 #ifdef CONFIG_ACPI_PROCFS_POWER
348         acpi_ac_remove_fs(device);
349 #endif
350
351         kfree(ac);
352
353         return 0;
354 }
355
356 static int __init acpi_ac_init(void)
357 {
358         int result;
359
360         if (acpi_disabled)
361                 return -ENODEV;
362
363 #ifdef CONFIG_ACPI_PROCFS_POWER
364         acpi_ac_dir = acpi_lock_ac_dir();
365         if (!acpi_ac_dir)
366                 return -ENODEV;
367 #endif
368
369         result = acpi_bus_register_driver(&acpi_ac_driver);
370         if (result < 0) {
371 #ifdef CONFIG_ACPI_PROCFS_POWER
372                 acpi_unlock_ac_dir(acpi_ac_dir);
373 #endif
374                 return -ENODEV;
375         }
376
377         return 0;
378 }
379
380 static void __exit acpi_ac_exit(void)
381 {
382
383         acpi_bus_unregister_driver(&acpi_ac_driver);
384
385 #ifdef CONFIG_ACPI_PROCFS_POWER
386         acpi_unlock_ac_dir(acpi_ac_dir);
387 #endif
388
389         return;
390 }
391
392 module_init(acpi_ac_init);
393 module_exit(acpi_ac_exit);