arch/arm/plat-samsung/include/plat/pm.h

   1 /* arch/arm/plat-samsung/include/plat/pm.h
   2  *
   3  * Copyright (c) 2004 Simtec Electronics
   4  *      http://armlinux.simtec.co.uk/
   5  *      Written by Ben Dooks, <ben@simtec.co.uk>
   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 version 2 as
   9  * published by the Free Software Foundation.
  10 */
  11
  12 /* s3c_pm_init
  13  *
  14  * called from board at initialisation time to setup the power
  15  * management
  16 */
  17
  18 #include <linux/irq.h>
  19
  20 struct device;
  21
  22 #ifdef CONFIG_SAMSUNG_PM
  23
  24 extern __init int s3c_pm_init(void);
  25 extern __init int s3c64xx_pm_init(void);
  26
  27 #else
  28
  29 static inline int s3c_pm_init(void)
  30 {
  31         return 0;
  32 }
  33
  34 static inline int s3c64xx_pm_init(void)
  35 {
  36         return 0;
  37 }
  38 #endif
  39
  40 /* configuration for the IRQ mask over sleep */
  41 extern unsigned long s3c_irqwake_intmask;
  42 extern unsigned long s3c_irqwake_eintmask;
  43
  44 /* IRQ masks for IRQs allowed to go to sleep (see irq.c) */
  45 extern unsigned long s3c_irqwake_intallow;
  46 extern unsigned long s3c_irqwake_eintallow;
  47
  48 /* per-cpu sleep functions */
  49
  50 extern void (*pm_cpu_prep)(void);
  51 extern int (*pm_cpu_sleep)(unsigned long);
  52
  53 /* Flags for PM Control */
  54
  55 extern unsigned long s3c_pm_flags;
  56
  57 extern unsigned char pm_uart_udivslot;  /* true to save UART UDIVSLOT */
  58
  59 /* from sleep.S */
  60
  61 extern int s3c2410_cpu_suspend(unsigned long);
  62
  63 /* sleep save info */
  64
  65 /**
  66  * struct sleep_save - save information for shared peripherals.
  67  * @reg: Pointer to the register to save.
  68  * @val: Holder for the value saved from reg.
  69  *
  70  * This describes a list of registers which is used by the pm core and
  71  * other subsystem to save and restore register values over suspend.
  72  */
  73 struct sleep_save {
  74         void __iomem    *reg;
  75         unsigned long   val;
  76 };
  77
  78 #define SAVE_ITEM(x) \
  79         { .reg = (x) }
  80
  81 /**
  82  * struct pm_uart_save - save block for core UART
  83  * @ulcon: Save value for S3C2410_ULCON
  84  * @ucon: Save value for S3C2410_UCON
  85  * @ufcon: Save value for S3C2410_UFCON
  86  * @umcon: Save value for S3C2410_UMCON
  87  * @ubrdiv: Save value for S3C2410_UBRDIV
  88  *
  89  * Save block for UART registers to be held over sleep and restored if they
  90  * are needed (say by debug).
  91 */
  92 struct pm_uart_save {
  93         u32     ulcon;
  94         u32     ucon;
  95         u32     ufcon;
  96         u32     umcon;
  97         u32     ubrdiv;
  98         u32     udivslot;
  99 };
 100
 101 /* helper functions to save/restore lists of registers. */
 102
 103 extern void s3c_pm_do_save(struct sleep_save *ptr, int count);
 104 extern void s3c_pm_do_restore(struct sleep_save *ptr, int count);
 105 extern void s3c_pm_do_restore_core(struct sleep_save *ptr, int count);
 106
 107 #ifdef CONFIG_SAMSUNG_PM
 108 extern int s3c_irq_wake(struct irq_data *data, unsigned int state);
 109 extern int s3c_irqext_wake(struct irq_data *data, unsigned int state);
 110 extern void s3c_cpu_resume(void);
 111 #else
 112 #define s3c_irq_wake NULL
 113 #define s3c_irqext_wake NULL
 114 #define s3c_cpu_resume NULL
 115 #endif
 116
 117 /* PM debug functions */
 118
 119 #ifdef CONFIG_SAMSUNG_PM_DEBUG
 120 /**
 121  * s3c_pm_dbg() - low level debug function for use in suspend/resume.
 122  * @msg: The message to print.
 123  *
 124  * This function is used mainly to debug the resume process before the system
 125  * can rely on printk/console output. It uses the low-level debugging output
 126  * routine printascii() to do its work.
 127  */
 128 extern void s3c_pm_dbg(const char *msg, ...);
 129
 130 #define S3C_PMDBG(fmt...) s3c_pm_dbg(fmt)
 131 #else
 132 #define S3C_PMDBG(fmt...) printk(KERN_DEBUG fmt)
 133 #endif
 134
 135 #ifdef CONFIG_S3C_PM_DEBUG_LED_SMDK
 136 /**
 137  * s3c_pm_debug_smdkled() - Debug PM suspend/resume via SMDK Board LEDs
 138  * @set: set bits for the state of the LEDs
 139  * @clear: clear bits for the state of the LEDs.
 140  */
 141 extern void s3c_pm_debug_smdkled(u32 set, u32 clear);
 142
 143 #else
 144 static inline void s3c_pm_debug_smdkled(u32 set, u32 clear) { }
 145 #endif /* CONFIG_S3C_PM_DEBUG_LED_SMDK */
 146
 147 /* suspend memory checking */
 148
 149 #ifdef CONFIG_SAMSUNG_PM_CHECK
 150 extern void s3c_pm_check_prepare(void);
 151 extern void s3c_pm_check_restore(void);
 152 extern void s3c_pm_check_cleanup(void);
 153 extern void s3c_pm_check_store(void);
 154 #else
 155 #define s3c_pm_check_prepare() do { } while(0)
 156 #define s3c_pm_check_restore() do { } while(0)
 157 #define s3c_pm_check_cleanup() do { } while(0)
 158 #define s3c_pm_check_store()   do { } while(0)
 159 #endif
 160
 161 /**
 162  * s3c_pm_configure_extint() - ensure pins are correctly set for IRQ
 163  *
 164  * Setup all the necessary GPIO pins for waking the system on external
 165  * interrupt.
 166  */
 167 extern void s3c_pm_configure_extint(void);
 168
 169 #ifdef CONFIG_GPIO_SAMSUNG
 170 /**
 171  * samsung_pm_restore_gpios() - restore the state of the gpios after sleep.
 172  *
 173  * Restore the state of the GPIO pins after sleep, which may involve ensuring
 174  * that we do not glitch the state of the pins from that the bootloader's
 175  * resume code has done.
 176 */
 177 extern void samsung_pm_restore_gpios(void);
 178
 179 /**
 180  * samsung_pm_save_gpios() - save the state of the GPIOs for restoring after sleep.
 181  *
 182  * Save the GPIO states for resotration on resume. See samsung_pm_restore_gpios().
 183  */
 184 extern void samsung_pm_save_gpios(void);
 185 #else
 186 static inline void samsung_pm_restore_gpios(void) {}
 187 static inline void samsung_pm_save_gpios(void) {}
 188 #endif
 189
 190 extern void s3c_pm_save_core(void);
 191 extern void s3c_pm_restore_core(void);