LXR linux/include/linux/pm

   1/*
   2 *  pm_wakeup.h - Power management wakeup interface
   3 *
   4 *  Copyright (C) 2008 Alan Stern
   5 *  Copyright (C) 2010 Rafael J. Wysocki, Novell Inc.
   6 *
   7 *  This program is free software; you can redistribute it and/or modify
   8 *  it under the terms of the GNU General Public License as published by
   9 *  the Free Software Foundation; either version 2 of the License, or
  10 *  (at your option) any later version.
  11 *
  12 *  This program is distributed in the hope that it will be useful,
  13 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 *  GNU General Public License for more details.
  16 *
  17 *  You should have received a copy of the GNU General Public License
  18 *  along with this program; if not, write to the Free Software
  19 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20 */
  21
  22#ifndef _LINUX_PM_WAKEUP_H
  23#define _LINUX_PM_WAKEUP_H
  24
  25#ifndef _DEVICE_H_
  26# error "please don't include this file directly"
  27#endif
  28
  29#include <linux/types.h>
  30
  31struct wake_irq;
  32
  33/**
  34 * struct wakeup_source - Representation of wakeup sources
  35 *
  36 * @name: Name of the wakeup source
  37 * @entry: Wakeup source list entry
  38 * @lock: Wakeup source lock
  39 * @wakeirq: Optional device specific wakeirq
  40 * @timer: Wakeup timer list
  41 * @timer_expires: Wakeup timer expiration
  42 * @total_time: Total time this wakeup source has been active.
  43 * @max_time: Maximum time this wakeup source has been continuously active.
  44 * @last_time: Monotonic clock when the wakeup source's was touched last time.
  45 * @prevent_sleep_time: Total time this source has been preventing autosleep.
  46 * @event_count: Number of signaled wakeup events.
  47 * @active_count: Number of times the wakeup source was activated.
  48 * @relax_count: Number of times the wakeup source was deactivated.
  49 * @expire_count: Number of times the wakeup source's timeout has expired.
  50 * @wakeup_count: Number of times the wakeup source might abort suspend.
  51 * @active: Status of the wakeup source.
  52 * @has_timeout: The wakeup source has been activated with a timeout.
  53 */
  54struct wakeup_source {
  55        const char              *name;
  56        struct list_head        entry;
  57        spinlock_t              lock;
  58        struct wake_irq         *wakeirq;
  59        struct timer_list       timer;
  60        unsigned long           timer_expires;
  61        ktime_t total_time;
  62        ktime_t max_time;
  63        ktime_t last_time;
  64        ktime_t start_prevent_time;
  65        ktime_t prevent_sleep_time;
  66        unsigned long           event_count;
  67        unsigned long           active_count;
  68        unsigned long           relax_count;
  69        unsigned long           expire_count;
  70        unsigned long           wakeup_count;
  71        bool                    active:1;
  72        bool                    autosleep_enabled:1;
  73};
  74
  75#ifdef CONFIG_PM_SLEEP
  76
  77/*
  78 * Changes to device_may_wakeup take effect on the next pm state change.
  79 */
  80
  81static inline bool device_can_wakeup(struct device *dev)
  82{
  83        return dev->power.can_wakeup;
  84}
  85
  86static inline bool device_may_wakeup(struct device *dev)
  87{
  88        return dev->power.can_wakeup && !!dev->power.wakeup;
  89}
  90
  91/* drivers/base/power/wakeup.c */
  92extern void wakeup_source_prepare(struct wakeup_source *ws, const char *name);
  93extern struct wakeup_source *wakeup_source_create(const char *name);
  94extern void wakeup_source_drop(struct wakeup_source *ws);
  95extern void wakeup_source_destroy(struct wakeup_source *ws);
  96extern void wakeup_source_add(struct wakeup_source *ws);
  97extern void wakeup_source_remove(struct wakeup_source *ws);
  98extern struct wakeup_source *wakeup_source_register(const char *name);
  99extern void wakeup_source_unregister(struct wakeup_source *ws);
 100extern int device_wakeup_enable(struct device *dev);
 101extern int device_wakeup_disable(struct device *dev);
 102extern void device_set_wakeup_capable(struct device *dev, bool capable);
 103extern int device_init_wakeup(struct device *dev, bool val);
 104extern int device_set_wakeup_enable(struct device *dev, bool enable);
 105extern void __pm_stay_awake(struct wakeup_source *ws);
 106extern void pm_stay_awake(struct device *dev);
 107extern void __pm_relax(struct wakeup_source *ws);
 108extern void pm_relax(struct device *dev);
 109extern void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec);
 110extern void pm_wakeup_event(struct device *dev, unsigned int msec);
 111
 112#else /* !CONFIG_PM_SLEEP */
 113
 114static inline void device_set_wakeup_capable(struct device *dev, bool capable)
 115{
 116        dev->power.can_wakeup = capable;
 117}
 118
 119static inline bool device_can_wakeup(struct device *dev)
 120{
 121        return dev->power.can_wakeup;
 122}
 123
 124static inline void wakeup_source_prepare(struct wakeup_source *ws,
 125                                         const char *name) {}
 126
 127static inline struct wakeup_source *wakeup_source_create(const char *name)
 128{
 129        return NULL;
 130}
 131
 132static inline void wakeup_source_drop(struct wakeup_source *ws) {}
 133
 134static inline void wakeup_source_destroy(struct wakeup_source *ws) {}
 135
 136static inline void wakeup_source_add(struct wakeup_source *ws) {}
 137
 138static inline void wakeup_source_remove(struct wakeup_source *ws) {}
 139
 140static inline struct wakeup_source *wakeup_source_register(const char *name)
 141{
 142        return NULL;
 143}
 144
 145static inline void wakeup_source_unregister(struct wakeup_source *ws) {}
 146
 147static inline int device_wakeup_enable(struct device *dev)
 148{
 149        dev->power.should_wakeup = true;
 150        return 0;
 151}
 152
 153static inline int device_wakeup_disable(struct device *dev)
 154{
 155        dev->power.should_wakeup = false;
 156        return 0;
 157}
 158
 159static inline int device_set_wakeup_enable(struct device *dev, bool enable)
 160{
 161        dev->power.should_wakeup = enable;
 162        return 0;
 163}
 164
 165static inline int device_init_wakeup(struct device *dev, bool val)
 166{
 167        device_set_wakeup_capable(dev, val);
 168        device_set_wakeup_enable(dev, val);
 169        return 0;
 170}
 171
 172static inline bool device_may_wakeup(struct device *dev)
 173{
 174        return dev->power.can_wakeup && dev->power.should_wakeup;
 175}
 176
 177static inline void __pm_stay_awake(struct wakeup_source *ws) {}
 178
 179static inline void pm_stay_awake(struct device *dev) {}
 180
 181static inline void __pm_relax(struct wakeup_source *ws) {}
 182
 183static inline void pm_relax(struct device *dev) {}
 184
 185static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) {}
 186
 187static inline void pm_wakeup_event(struct device *dev, unsigned int msec) {}
 188
 189#endif /* !CONFIG_PM_SLEEP */
 190
 191static inline void wakeup_source_init(struct wakeup_source *ws,
 192                                      const char *name)
 193{
 194        wakeup_source_prepare(ws, name);
 195        wakeup_source_add(ws);
 196}
 197
 198static inline void wakeup_source_trash(struct wakeup_source *ws)
 199{
 200        wakeup_source_remove(ws);
 201        wakeup_source_drop(ws);
 202}
 203
 204#endif /* _LINUX_PM_WAKEUP_H */
 205