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