USB Gadget: documentation update
[linux-2.6] / include / linux / pm_wakeup.h
1 /*
2  *  pm_wakeup.h - Power management wakeup interface
3  *
4  *  Copyright (C) 2008 Alan Stern
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #ifndef _LINUX_PM_WAKEUP_H
22 #define _LINUX_PM_WAKEUP_H
23
24 #ifndef _DEVICE_H_
25 # error "please don't include this file directly"
26 #endif
27
28 #ifdef CONFIG_PM
29
30 /* changes to device_may_wakeup take effect on the next pm state change.
31  * by default, devices should wakeup if they can.
32  */
33 static inline void device_init_wakeup(struct device *dev, int val)
34 {
35         dev->power.can_wakeup = dev->power.should_wakeup = !!val;
36 }
37
38 static inline void device_set_wakeup_capable(struct device *dev, int val)
39 {
40         dev->power.can_wakeup = !!val;
41 }
42
43 static inline int device_can_wakeup(struct device *dev)
44 {
45         return dev->power.can_wakeup;
46 }
47
48 static inline void device_set_wakeup_enable(struct device *dev, int val)
49 {
50         dev->power.should_wakeup = !!val;
51 }
52
53 static inline int device_may_wakeup(struct device *dev)
54 {
55         return dev->power.can_wakeup && dev->power.should_wakeup;
56 }
57
58 #else /* !CONFIG_PM */
59
60 /* For some reason the next two routines work even without CONFIG_PM */
61 static inline void device_init_wakeup(struct device *dev, int val)
62 {
63         dev->power.can_wakeup = !!val;
64 }
65
66 static inline void device_set_wakeup_capable(struct device *dev, int val) { }
67
68 static inline int device_can_wakeup(struct device *dev)
69 {
70         return dev->power.can_wakeup;
71 }
72
73 #define device_set_wakeup_enable(dev, val)      do {} while (0)
74 #define device_may_wakeup(dev)                  0
75
76 #endif /* !CONFIG_PM */
77
78 #endif /* _LINUX_PM_WAKEUP_H */