1 /* linux/arch/arm/plat-s3c24xx/pm.c
3 * Copyright (c) 2004,2006 Simtec Electronics
4 * Ben Dooks <ben@simtec.co.uk>
6 * S3C24XX Power Manager (Suspend-To-RAM) support
8 * See Documentation/arm/Samsung-S3C24XX/Suspend.txt for more information
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * Parts based on arch/arm/mach-pxa/pm.c
26 * Thanks to Dimitry Andric for debugging
29 #include <linux/init.h>
30 #include <linux/suspend.h>
31 #include <linux/errno.h>
32 #include <linux/time.h>
33 #include <linux/interrupt.h>
34 #include <linux/crc32.h>
35 #include <linux/ioport.h>
36 #include <linux/delay.h>
37 #include <linux/serial_core.h>
40 #include <asm/cacheflush.h>
41 #include <mach/hardware.h>
43 #include <asm/plat-s3c/regs-serial.h>
44 #include <mach/regs-clock.h>
45 #include <mach/regs-gpio.h>
46 #include <mach/regs-mem.h>
47 #include <mach/regs-irq.h>
49 #include <asm/mach/time.h>
51 #include <asm/plat-s3c24xx/pm.h>
53 /* for external use */
55 unsigned long s3c_pm_flags;
57 #define PFX "s3c24xx-pm: "
59 static struct sleep_save core_save[] = {
60 SAVE_ITEM(S3C2410_LOCKTIME),
61 SAVE_ITEM(S3C2410_CLKCON),
63 /* we restore the timings here, with the proviso that the board
64 * brings the system up in an slower, or equal frequency setting
65 * to the original system.
67 * if we cannot guarantee this, then things are going to go very
68 * wrong here, as we modify the refresh and both pll settings.
71 SAVE_ITEM(S3C2410_BWSCON),
72 SAVE_ITEM(S3C2410_BANKCON0),
73 SAVE_ITEM(S3C2410_BANKCON1),
74 SAVE_ITEM(S3C2410_BANKCON2),
75 SAVE_ITEM(S3C2410_BANKCON3),
76 SAVE_ITEM(S3C2410_BANKCON4),
77 SAVE_ITEM(S3C2410_BANKCON5),
79 SAVE_ITEM(S3C2410_CLKDIVN),
80 SAVE_ITEM(S3C2410_MPLLCON),
81 SAVE_ITEM(S3C2410_UPLLCON),
82 SAVE_ITEM(S3C2410_CLKSLOW),
83 SAVE_ITEM(S3C2410_REFRESH),
86 static struct gpio_sleep {
93 .base = S3C2410_GPACON,
96 .base = S3C2410_GPBCON,
99 .base = S3C2410_GPCCON,
102 .base = S3C2410_GPDCON,
105 .base = S3C2410_GPECON,
108 .base = S3C2410_GPFCON,
111 .base = S3C2410_GPGCON,
114 .base = S3C2410_GPHCON,
118 static struct sleep_save misc_save[] = {
119 SAVE_ITEM(S3C2410_DCLKCON),
122 #ifdef CONFIG_S3C2410_PM_DEBUG
124 #define SAVE_UART(va) \
125 SAVE_ITEM((va) + S3C2410_ULCON), \
126 SAVE_ITEM((va) + S3C2410_UCON), \
127 SAVE_ITEM((va) + S3C2410_UFCON), \
128 SAVE_ITEM((va) + S3C2410_UMCON), \
129 SAVE_ITEM((va) + S3C2410_UBRDIV)
131 static struct sleep_save uart_save[] = {
132 SAVE_UART(S3C24XX_VA_UART0),
133 SAVE_UART(S3C24XX_VA_UART1),
134 #ifndef CONFIG_CPU_S3C2400
135 SAVE_UART(S3C24XX_VA_UART2),
141 * we send the debug to printascii() to allow it to be seen if the
142 * system never wakes up from the sleep
145 extern void printascii(const char *);
147 void pm_dbg(const char *fmt, ...)
153 vsprintf(buff, fmt, va);
159 static void s3c2410_pm_debug_init(void)
161 unsigned long tmp = __raw_readl(S3C2410_CLKCON);
163 /* re-start uart clocks */
164 tmp |= S3C2410_CLKCON_UART0;
165 tmp |= S3C2410_CLKCON_UART1;
166 tmp |= S3C2410_CLKCON_UART2;
168 __raw_writel(tmp, S3C2410_CLKCON);
172 #define DBG(fmt...) pm_dbg(fmt)
174 #define DBG(fmt...) printk(KERN_DEBUG fmt)
176 #define s3c2410_pm_debug_init() do { } while(0)
178 static struct sleep_save uart_save[] = {};
181 #if defined(CONFIG_S3C2410_PM_CHECK) && CONFIG_S3C2410_PM_CHECK_CHUNKSIZE != 0
183 /* suspend checking code...
185 * this next area does a set of crc checks over all the installed
186 * memory, so the system can verify if the resume was ok.
188 * CONFIG_S3C2410_PM_CHECK_CHUNKSIZE defines the block-size for the CRC,
189 * increasing it will mean that the area corrupted will be less easy to spot,
190 * and reducing the size will cause the CRC save area to grow
193 #define CHECK_CHUNKSIZE (CONFIG_S3C2410_PM_CHECK_CHUNKSIZE * 1024)
195 static u32 crc_size; /* size needed for the crc block */
196 static u32 *crcs; /* allocated over suspend/resume */
198 typedef u32 *(run_fn_t)(struct resource *ptr, u32 *arg);
200 /* s3c2410_pm_run_res
202 * go thorugh the given resource list, and look for system ram
205 static void s3c2410_pm_run_res(struct resource *ptr, run_fn_t fn, u32 *arg)
207 while (ptr != NULL) {
208 if (ptr->child != NULL)
209 s3c2410_pm_run_res(ptr->child, fn, arg);
211 if ((ptr->flags & IORESOURCE_MEM) &&
212 strcmp(ptr->name, "System RAM") == 0) {
213 DBG("Found system RAM at %08lx..%08lx\n",
214 ptr->start, ptr->end);
215 arg = (fn)(ptr, arg);
222 static void s3c2410_pm_run_sysram(run_fn_t fn, u32 *arg)
224 s3c2410_pm_run_res(&iomem_resource, fn, arg);
227 static u32 *s3c2410_pm_countram(struct resource *res, u32 *val)
229 u32 size = (u32)(res->end - res->start)+1;
231 size += CHECK_CHUNKSIZE-1;
232 size /= CHECK_CHUNKSIZE;
234 DBG("Area %08lx..%08lx, %d blocks\n", res->start, res->end, size);
236 *val += size * sizeof(u32);
240 /* s3c2410_pm_prepare_check
242 * prepare the necessary information for creating the CRCs. This
243 * must be done before the final save, as it will require memory
244 * allocating, and thus touching bits of the kernel we do not
248 static void s3c2410_pm_check_prepare(void)
252 s3c2410_pm_run_sysram(s3c2410_pm_countram, &crc_size);
254 DBG("s3c2410_pm_prepare_check: %u checks needed\n", crc_size);
256 crcs = kmalloc(crc_size+4, GFP_KERNEL);
258 printk(KERN_ERR "Cannot allocated CRC save area\n");
261 static u32 *s3c2410_pm_makecheck(struct resource *res, u32 *val)
263 unsigned long addr, left;
265 for (addr = res->start; addr < res->end;
266 addr += CHECK_CHUNKSIZE) {
267 left = res->end - addr;
269 if (left > CHECK_CHUNKSIZE)
270 left = CHECK_CHUNKSIZE;
272 *val = crc32_le(~0, phys_to_virt(addr), left);
279 /* s3c2410_pm_check_store
281 * compute the CRC values for the memory blocks before the final
285 static void s3c2410_pm_check_store(void)
288 s3c2410_pm_run_sysram(s3c2410_pm_makecheck, crcs);
293 * return TRUE if the area defined by ptr..ptr+size contatins the
297 static inline int in_region(void *ptr, int size, void *what, size_t whatsz)
299 if ((what+whatsz) < ptr)
302 if (what > (ptr+size))
308 static u32 *s3c2410_pm_runcheck(struct resource *res, u32 *val)
310 void *save_at = phys_to_virt(s3c2410_sleep_save_phys);
316 for (addr = res->start; addr < res->end;
317 addr += CHECK_CHUNKSIZE) {
318 left = res->end - addr;
320 if (left > CHECK_CHUNKSIZE)
321 left = CHECK_CHUNKSIZE;
323 ptr = phys_to_virt(addr);
325 if (in_region(ptr, left, crcs, crc_size)) {
326 DBG("skipping %08lx, has crc block in\n", addr);
330 if (in_region(ptr, left, save_at, 32*4 )) {
331 DBG("skipping %08lx, has save block in\n", addr);
335 /* calculate and check the checksum */
337 calc = crc32_le(~0, ptr, left);
339 printk(KERN_ERR PFX "Restore CRC error at "
340 "%08lx (%08x vs %08x)\n", addr, calc, *val);
342 DBG("Restore CRC error at %08lx (%08x vs %08x)\n",
353 /* s3c2410_pm_check_restore
355 * check the CRCs after the restore event and free the memory used
359 static void s3c2410_pm_check_restore(void)
362 s3c2410_pm_run_sysram(s3c2410_pm_runcheck, crcs);
370 #define s3c2410_pm_check_prepare() do { } while(0)
371 #define s3c2410_pm_check_restore() do { } while(0)
372 #define s3c2410_pm_check_store() do { } while(0)
375 /* helper functions to save and restore register state */
377 void s3c2410_pm_do_save(struct sleep_save *ptr, int count)
379 for (; count > 0; count--, ptr++) {
380 ptr->val = __raw_readl(ptr->reg);
381 DBG("saved %p value %08lx\n", ptr->reg, ptr->val);
385 /* s3c2410_pm_do_restore
387 * restore the system from the given list of saved registers
389 * Note, we do not use DBG() in here, as the system may not have
390 * restore the UARTs state yet
393 void s3c2410_pm_do_restore(struct sleep_save *ptr, int count)
395 for (; count > 0; count--, ptr++) {
396 printk(KERN_DEBUG "restore %p (restore %08lx, was %08x)\n",
397 ptr->reg, ptr->val, __raw_readl(ptr->reg));
399 __raw_writel(ptr->val, ptr->reg);
403 /* s3c2410_pm_do_restore_core
405 * similar to s3c2410_pm_do_restore_core
407 * WARNING: Do not put any debug in here that may effect memory or use
408 * peripherals, as things may be changing!
411 static void s3c2410_pm_do_restore_core(struct sleep_save *ptr, int count)
413 for (; count > 0; count--, ptr++) {
414 __raw_writel(ptr->val, ptr->reg);
418 /* s3c2410_pm_show_resume_irqs
420 * print any IRQs asserted at resume time (ie, we woke from)
423 static void s3c2410_pm_show_resume_irqs(int start, unsigned long which,
430 for (i = 0; i <= 31; i++) {
431 if ((which) & (1L<<i)) {
432 DBG("IRQ %d asserted at resume\n", start+i);
437 /* s3c2410_pm_check_resume_pin
439 * check to see if the pin is configured correctly for sleep mode, and
440 * make any necessary adjustments if it is not
443 static void s3c2410_pm_check_resume_pin(unsigned int pin, unsigned int irqoffs)
445 unsigned long irqstate;
446 unsigned long pinstate;
447 int irq = s3c2410_gpio_getirq(pin);
450 irqstate = s3c_irqwake_intmask & (1L<<irqoffs);
452 irqstate = s3c_irqwake_eintmask & (1L<<irqoffs);
454 pinstate = s3c2410_gpio_getcfg(pin);
457 if (pinstate == S3C2410_GPIO_IRQ)
458 DBG("Leaving IRQ %d (pin %d) enabled\n", irq, pin);
460 if (pinstate == S3C2410_GPIO_IRQ) {
461 DBG("Disabling IRQ %d (pin %d)\n", irq, pin);
462 s3c2410_gpio_cfgpin(pin, S3C2410_GPIO_INPUT);
467 /* s3c2410_pm_configure_extint
469 * configure all external interrupt pins
472 static void s3c2410_pm_configure_extint(void)
476 /* for each of the external interrupts (EINT0..EINT15) we
477 * need to check wether it is an external interrupt source,
478 * and then configure it as an input if it is not
481 for (pin = S3C2410_GPF0; pin <= S3C2410_GPF7; pin++) {
482 s3c2410_pm_check_resume_pin(pin, pin - S3C2410_GPF0);
485 for (pin = S3C2410_GPG0; pin <= S3C2410_GPG7; pin++) {
486 s3c2410_pm_check_resume_pin(pin, (pin - S3C2410_GPG0)+8);
490 /* offsets for CON/DAT/UP registers */
492 #define OFFS_CON (S3C2410_GPACON - S3C2410_GPACON)
493 #define OFFS_DAT (S3C2410_GPADAT - S3C2410_GPACON)
494 #define OFFS_UP (S3C2410_GPBUP - S3C2410_GPBCON)
496 /* s3c2410_pm_save_gpios()
498 * Save the state of the GPIOs
501 static void s3c2410_pm_save_gpios(void)
503 struct gpio_sleep *gps = gpio_save;
506 for (gpio = 0; gpio < ARRAY_SIZE(gpio_save); gpio++, gps++) {
507 void __iomem *base = gps->base;
509 gps->gpcon = __raw_readl(base + OFFS_CON);
510 gps->gpdat = __raw_readl(base + OFFS_DAT);
513 gps->gpup = __raw_readl(base + OFFS_UP);
518 /* Test whether the given masked+shifted bits of an GPIO configuration
519 * are one of the SFN (special function) modes. */
521 static inline int is_sfn(unsigned long con)
523 return (con == 2 || con == 3);
526 /* Test if the given masked+shifted GPIO configuration is an input */
528 static inline int is_in(unsigned long con)
533 /* Test if the given masked+shifted GPIO configuration is an output */
535 static inline int is_out(unsigned long con)
540 /* s3c2410_pm_restore_gpio()
542 * Restore one of the GPIO banks that was saved during suspend. This is
543 * not as simple as once thought, due to the possibility of glitches
544 * from the order that the CON and DAT registers are set in.
546 * The three states the pin can be are {IN,OUT,SFN} which gives us 9
547 * combinations of changes to check. Three of these, if the pin stays
548 * in the same configuration can be discounted. This leaves us with
551 * { IN => OUT } Change DAT first
552 * { IN => SFN } Change CON first
553 * { OUT => SFN } Change CON first, so new data will not glitch
554 * { OUT => IN } Change CON first, so new data will not glitch
555 * { SFN => IN } Change CON first
556 * { SFN => OUT } Change DAT first, so new data will not glitch [1]
558 * We do not currently deal with the UP registers as these control
559 * weak resistors, so a small delay in change should not need to bring
560 * these into the calculations.
562 * [1] this assumes that writing to a pin DAT whilst in SFN will set the
563 * state for when it is next output.
566 static void s3c2410_pm_restore_gpio(int index, struct gpio_sleep *gps)
568 void __iomem *base = gps->base;
569 unsigned long gps_gpcon = gps->gpcon;
570 unsigned long gps_gpdat = gps->gpdat;
571 unsigned long old_gpcon;
572 unsigned long old_gpdat;
573 unsigned long old_gpup = 0x0;
577 old_gpcon = __raw_readl(base + OFFS_CON);
578 old_gpdat = __raw_readl(base + OFFS_DAT);
580 if (base == S3C2410_GPACON) {
581 /* GPACON only has one bit per control / data and no PULLUPs.
582 * GPACON[x] = 0 => Output, 1 => SFN */
584 /* first set all SFN bits to SFN */
586 gpcon = old_gpcon | gps->gpcon;
587 __raw_writel(gpcon, base + OFFS_CON);
589 /* now set all the other bits */
591 __raw_writel(gps_gpdat, base + OFFS_DAT);
592 __raw_writel(gps_gpcon, base + OFFS_CON);
594 unsigned long old, new, mask;
595 unsigned long change_mask = 0x0;
597 old_gpup = __raw_readl(base + OFFS_UP);
599 /* Create a change_mask of all the items that need to have
600 * their CON value changed before their DAT value, so that
601 * we minimise the work between the two settings.
604 for (nr = 0, mask = 0x03; nr < 32; nr += 2, mask <<= 2) {
605 old = (old_gpcon & mask) >> nr;
606 new = (gps_gpcon & mask) >> nr;
608 /* If there is no change, then skip */
613 /* If both are special function, then skip */
615 if (is_sfn(old) && is_sfn(new))
618 /* Change is IN => OUT, do not change now */
620 if (is_in(old) && is_out(new))
623 /* Change is SFN => OUT, do not change now */
625 if (is_sfn(old) && is_out(new))
628 /* We should now be at the case of IN=>SFN,
629 * OUT=>SFN, OUT=>IN, SFN=>IN. */
634 /* Write the new CON settings */
636 gpcon = old_gpcon & ~change_mask;
637 gpcon |= gps_gpcon & change_mask;
639 __raw_writel(gpcon, base + OFFS_CON);
641 /* Now change any items that require DAT,CON */
643 __raw_writel(gps_gpdat, base + OFFS_DAT);
644 __raw_writel(gps_gpcon, base + OFFS_CON);
645 __raw_writel(gps->gpup, base + OFFS_UP);
648 DBG("GPIO[%d] CON %08lx => %08lx, DAT %08lx => %08lx\n",
649 index, old_gpcon, gps_gpcon, old_gpdat, gps_gpdat);
653 /** s3c2410_pm_restore_gpios()
655 * Restore the state of the GPIOs
658 static void s3c2410_pm_restore_gpios(void)
660 struct gpio_sleep *gps = gpio_save;
663 for (gpio = 0; gpio < ARRAY_SIZE(gpio_save); gpio++, gps++) {
664 s3c2410_pm_restore_gpio(gpio, gps);
668 void (*pm_cpu_prep)(void);
669 void (*pm_cpu_sleep)(void);
671 #define any_allowed(mask, allow) (((mask) & (allow)) != (allow))
675 * central control for sleep/resume process
678 static int s3c2410_pm_enter(suspend_state_t state)
680 unsigned long regs_save[16];
682 /* ensure the debug is initialised (if enabled) */
684 s3c2410_pm_debug_init();
686 DBG("s3c2410_pm_enter(%d)\n", state);
688 if (pm_cpu_prep == NULL || pm_cpu_sleep == NULL) {
689 printk(KERN_ERR PFX "error: no cpu sleep functions set\n");
693 /* check if we have anything to wake-up with... bad things seem
694 * to happen if you suspend with no wakeup (system will often
695 * require a full power-cycle)
698 if (!any_allowed(s3c_irqwake_intmask, s3c_irqwake_intallow) &&
699 !any_allowed(s3c_irqwake_eintmask, s3c_irqwake_eintallow)) {
700 printk(KERN_ERR PFX "No sources enabled for wake-up!\n");
701 printk(KERN_ERR PFX "Aborting sleep\n");
705 /* prepare check area if configured */
707 s3c2410_pm_check_prepare();
709 /* store the physical address of the register recovery block */
711 s3c2410_sleep_save_phys = virt_to_phys(regs_save);
713 DBG("s3c2410_sleep_save_phys=0x%08lx\n", s3c2410_sleep_save_phys);
715 /* save all necessary core registers not covered by the drivers */
717 s3c2410_pm_save_gpios();
718 s3c2410_pm_do_save(misc_save, ARRAY_SIZE(misc_save));
719 s3c2410_pm_do_save(core_save, ARRAY_SIZE(core_save));
720 s3c2410_pm_do_save(uart_save, ARRAY_SIZE(uart_save));
722 /* set the irq configuration for wake */
724 s3c2410_pm_configure_extint();
726 DBG("sleep: irq wakeup masks: %08lx,%08lx\n",
727 s3c_irqwake_intmask, s3c_irqwake_eintmask);
729 __raw_writel(s3c_irqwake_intmask, S3C2410_INTMSK);
730 __raw_writel(s3c_irqwake_eintmask, S3C2410_EINTMASK);
732 /* ack any outstanding external interrupts before we go to sleep */
734 __raw_writel(__raw_readl(S3C2410_EINTPEND), S3C2410_EINTPEND);
735 __raw_writel(__raw_readl(S3C2410_INTPND), S3C2410_INTPND);
736 __raw_writel(__raw_readl(S3C2410_SRCPND), S3C2410_SRCPND);
738 /* call cpu specific preparation */
742 /* flush cache back to ram */
746 s3c2410_pm_check_store();
748 /* send the cpu to sleep... */
750 __raw_writel(0x00, S3C2410_CLKCON); /* turn off clocks over sleep */
752 /* s3c2410_cpu_save will also act as our return point from when
753 * we resume as it saves its own register state, so use the return
754 * code to differentiate return from save and return from sleep */
756 if (s3c2410_cpu_save(regs_save) == 0) {
761 /* restore the cpu state */
765 /* restore the system state */
767 s3c2410_pm_do_restore_core(core_save, ARRAY_SIZE(core_save));
768 s3c2410_pm_do_restore(misc_save, ARRAY_SIZE(misc_save));
769 s3c2410_pm_do_restore(uart_save, ARRAY_SIZE(uart_save));
770 s3c2410_pm_restore_gpios();
772 s3c2410_pm_debug_init();
774 /* check what irq (if any) restored the system */
776 DBG("post sleep: IRQs 0x%08x, 0x%08x\n",
777 __raw_readl(S3C2410_SRCPND),
778 __raw_readl(S3C2410_EINTPEND));
780 s3c2410_pm_show_resume_irqs(IRQ_EINT0, __raw_readl(S3C2410_SRCPND),
781 s3c_irqwake_intmask);
783 s3c2410_pm_show_resume_irqs(IRQ_EINT4-4, __raw_readl(S3C2410_EINTPEND),
784 s3c_irqwake_eintmask);
786 DBG("post sleep, preparing to return\n");
788 s3c2410_pm_check_restore();
790 /* ok, let's return from sleep */
792 DBG("S3C2410 PM Resume (post-restore)\n");
796 static struct platform_suspend_ops s3c2410_pm_ops = {
797 .enter = s3c2410_pm_enter,
798 .valid = suspend_valid_only_mem,
803 * Attach the power management functions. This should be called
804 * from the board specific initialisation if the board supports
808 int __init s3c2410_pm_init(void)
810 printk("S3C2410 Power Management, (c) 2004 Simtec Electronics\n");
812 suspend_set_ops(&s3c2410_pm_ops);