1 /* linux/arch/arm/mach-s3c2410/pm.c
3 * Copyright (c) 2004 Simtec Electronics
4 * Ben Dooks <ben@simtec.co.uk>
6 * S3C2410 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 * 10-Mar-2005 LCVR Changed S3C2410_VA_UART to S3C24XX_VA_UART
32 #include <linux/config.h>
33 #include <linux/init.h>
34 #include <linux/suspend.h>
35 #include <linux/errno.h>
36 #include <linux/time.h>
37 #include <linux/interrupt.h>
38 #include <linux/crc32.h>
39 #include <linux/ioport.h>
40 #include <linux/delay.h>
42 #include <asm/hardware.h>
45 #include <asm/arch/regs-serial.h>
46 #include <asm/arch/regs-clock.h>
47 #include <asm/arch/regs-gpio.h>
48 #include <asm/arch/regs-mem.h>
49 #include <asm/arch/regs-irq.h>
51 #include <asm/mach/time.h>
55 /* for external use */
57 unsigned long s3c_pm_flags
;
59 /* cache functions from arch/arm/mm/proc-arm920.S */
61 extern void arm920_flush_kern_cache_all(void);
63 #define PFX "s3c24xx-pm: "
65 static struct sleep_save core_save
[] = {
66 SAVE_ITEM(S3C2410_LOCKTIME
),
67 SAVE_ITEM(S3C2410_CLKCON
),
69 /* we restore the timings here, with the proviso that the board
70 * brings the system up in an slower, or equal frequency setting
71 * to the original system.
73 * if we cannot guarantee this, then things are going to go very
74 * wrong here, as we modify the refresh and both pll settings.
77 SAVE_ITEM(S3C2410_BWSCON
),
78 SAVE_ITEM(S3C2410_BANKCON0
),
79 SAVE_ITEM(S3C2410_BANKCON1
),
80 SAVE_ITEM(S3C2410_BANKCON2
),
81 SAVE_ITEM(S3C2410_BANKCON3
),
82 SAVE_ITEM(S3C2410_BANKCON4
),
83 SAVE_ITEM(S3C2410_BANKCON5
),
85 SAVE_ITEM(S3C2410_CLKDIVN
),
86 SAVE_ITEM(S3C2410_MPLLCON
),
87 SAVE_ITEM(S3C2410_UPLLCON
),
88 SAVE_ITEM(S3C2410_CLKSLOW
),
89 SAVE_ITEM(S3C2410_REFRESH
),
92 /* this lot should be really saved by the IRQ code */
93 static struct sleep_save irq_save
[] = {
94 SAVE_ITEM(S3C2410_EXTINT0
),
95 SAVE_ITEM(S3C2410_EXTINT1
),
96 SAVE_ITEM(S3C2410_EXTINT2
),
97 SAVE_ITEM(S3C2410_EINFLT0
),
98 SAVE_ITEM(S3C2410_EINFLT1
),
99 SAVE_ITEM(S3C2410_EINFLT2
),
100 SAVE_ITEM(S3C2410_EINFLT3
),
101 SAVE_ITEM(S3C2410_EINTMASK
),
102 SAVE_ITEM(S3C2410_INTMSK
)
105 static struct sleep_save gpio_save
[] = {
106 SAVE_ITEM(S3C2410_GPACON
),
107 SAVE_ITEM(S3C2410_GPADAT
),
109 SAVE_ITEM(S3C2410_GPBCON
),
110 SAVE_ITEM(S3C2410_GPBDAT
),
111 SAVE_ITEM(S3C2410_GPBUP
),
113 SAVE_ITEM(S3C2410_GPCCON
),
114 SAVE_ITEM(S3C2410_GPCDAT
),
115 SAVE_ITEM(S3C2410_GPCUP
),
117 SAVE_ITEM(S3C2410_GPDCON
),
118 SAVE_ITEM(S3C2410_GPDDAT
),
119 SAVE_ITEM(S3C2410_GPDUP
),
121 SAVE_ITEM(S3C2410_GPECON
),
122 SAVE_ITEM(S3C2410_GPEDAT
),
123 SAVE_ITEM(S3C2410_GPEUP
),
125 SAVE_ITEM(S3C2410_GPFCON
),
126 SAVE_ITEM(S3C2410_GPFDAT
),
127 SAVE_ITEM(S3C2410_GPFUP
),
129 SAVE_ITEM(S3C2410_GPGCON
),
130 SAVE_ITEM(S3C2410_GPGDAT
),
131 SAVE_ITEM(S3C2410_GPGUP
),
133 SAVE_ITEM(S3C2410_GPHCON
),
134 SAVE_ITEM(S3C2410_GPHDAT
),
135 SAVE_ITEM(S3C2410_GPHUP
),
137 SAVE_ITEM(S3C2410_DCLKCON
),
140 #ifdef CONFIG_S3C2410_PM_DEBUG
142 #define SAVE_UART(va) \
143 SAVE_ITEM((va) + S3C2410_ULCON), \
144 SAVE_ITEM((va) + S3C2410_UCON), \
145 SAVE_ITEM((va) + S3C2410_UFCON), \
146 SAVE_ITEM((va) + S3C2410_UMCON), \
147 SAVE_ITEM((va) + S3C2410_UBRDIV)
149 static struct sleep_save uart_save
[] = {
150 SAVE_UART(S3C24XX_VA_UART0
),
151 SAVE_UART(S3C24XX_VA_UART1
),
152 #ifndef CONFIG_CPU_S3C2400
153 SAVE_UART(S3C24XX_VA_UART2
),
159 * we send the debug to printascii() to allow it to be seen if the
160 * system never wakes up from the sleep
163 extern void printascii(const char *);
165 static void pm_dbg(const char *fmt
, ...)
171 vsprintf(buff
, fmt
, va
);
177 static void s3c2410_pm_debug_init(void)
179 unsigned long tmp
= __raw_readl(S3C2410_CLKCON
);
181 /* re-start uart clocks */
182 tmp
|= S3C2410_CLKCON_UART0
;
183 tmp
|= S3C2410_CLKCON_UART1
;
184 tmp
|= S3C2410_CLKCON_UART2
;
186 __raw_writel(tmp
, S3C2410_CLKCON
);
190 #define DBG(fmt...) pm_dbg(fmt)
192 #define DBG(fmt...) printk(KERN_DEBUG fmt)
194 #define s3c2410_pm_debug_init() do { } while(0)
196 static struct sleep_save uart_save
[] = {};
199 #if defined(CONFIG_S3C2410_PM_CHECK) && CONFIG_S3C2410_PM_CHECK_CHUNKSIZE != 0
201 /* suspend checking code...
203 * this next area does a set of crc checks over all the installed
204 * memory, so the system can verify if the resume was ok.
206 * CONFIG_S3C2410_PM_CHECK_CHUNKSIZE defines the block-size for the CRC,
207 * increasing it will mean that the area corrupted will be less easy to spot,
208 * and reducing the size will cause the CRC save area to grow
211 #define CHECK_CHUNKSIZE (CONFIG_S3C2410_PM_CHECK_CHUNKSIZE * 1024)
213 static u32 crc_size
; /* size needed for the crc block */
214 static u32
*crcs
; /* allocated over suspend/resume */
216 typedef u32
*(run_fn_t
)(struct resource
*ptr
, u32
*arg
);
218 /* s3c2410_pm_run_res
220 * go thorugh the given resource list, and look for system ram
223 static void s3c2410_pm_run_res(struct resource
*ptr
, run_fn_t fn
, u32
*arg
)
225 while (ptr
!= NULL
) {
226 if (ptr
->child
!= NULL
)
227 s3c2410_pm_run_res(ptr
->child
, fn
, arg
);
229 if ((ptr
->flags
& IORESOURCE_MEM
) &&
230 strcmp(ptr
->name
, "System RAM") == 0) {
231 DBG("Found system RAM at %08lx..%08lx\n",
232 ptr
->start
, ptr
->end
);
233 arg
= (fn
)(ptr
, arg
);
240 static void s3c2410_pm_run_sysram(run_fn_t fn
, u32
*arg
)
242 s3c2410_pm_run_res(&iomem_resource
, fn
, arg
);
245 static u32
*s3c2410_pm_countram(struct resource
*res
, u32
*val
)
247 u32 size
= (u32
)(res
->end
- res
->start
)+1;
249 size
+= CHECK_CHUNKSIZE
-1;
250 size
/= CHECK_CHUNKSIZE
;
252 DBG("Area %08lx..%08lx, %d blocks\n", res
->start
, res
->end
, size
);
254 *val
+= size
* sizeof(u32
);
258 /* s3c2410_pm_prepare_check
260 * prepare the necessary information for creating the CRCs. This
261 * must be done before the final save, as it will require memory
262 * allocating, and thus touching bits of the kernel we do not
266 static void s3c2410_pm_check_prepare(void)
270 s3c2410_pm_run_sysram(s3c2410_pm_countram
, &crc_size
);
272 DBG("s3c2410_pm_prepare_check: %u checks needed\n", crc_size
);
274 crcs
= kmalloc(crc_size
+4, GFP_KERNEL
);
276 printk(KERN_ERR
"Cannot allocated CRC save area\n");
279 static u32
*s3c2410_pm_makecheck(struct resource
*res
, u32
*val
)
281 unsigned long addr
, left
;
283 for (addr
= res
->start
; addr
< res
->end
;
284 addr
+= CHECK_CHUNKSIZE
) {
285 left
= res
->end
- addr
;
287 if (left
> CHECK_CHUNKSIZE
)
288 left
= CHECK_CHUNKSIZE
;
290 *val
= crc32_le(~0, phys_to_virt(addr
), left
);
297 /* s3c2410_pm_check_store
299 * compute the CRC values for the memory blocks before the final
303 static void s3c2410_pm_check_store(void)
306 s3c2410_pm_run_sysram(s3c2410_pm_makecheck
, crcs
);
311 * return TRUE if the area defined by ptr..ptr+size contatins the
315 static inline int in_region(void *ptr
, int size
, void *what
, size_t whatsz
)
317 if ((what
+whatsz
) < ptr
)
320 if (what
> (ptr
+size
))
326 static u32
*s3c2410_pm_runcheck(struct resource
*res
, u32
*val
)
328 void *save_at
= phys_to_virt(s3c2410_sleep_save_phys
);
334 for (addr
= res
->start
; addr
< res
->end
;
335 addr
+= CHECK_CHUNKSIZE
) {
336 left
= res
->end
- addr
;
338 if (left
> CHECK_CHUNKSIZE
)
339 left
= CHECK_CHUNKSIZE
;
341 ptr
= phys_to_virt(addr
);
343 if (in_region(ptr
, left
, crcs
, crc_size
)) {
344 DBG("skipping %08lx, has crc block in\n", addr
);
348 if (in_region(ptr
, left
, save_at
, 32*4 )) {
349 DBG("skipping %08lx, has save block in\n", addr
);
353 /* calculate and check the checksum */
355 calc
= crc32_le(~0, ptr
, left
);
357 printk(KERN_ERR PFX
"Restore CRC error at "
358 "%08lx (%08x vs %08x)\n", addr
, calc
, *val
);
360 DBG("Restore CRC error at %08lx (%08x vs %08x)\n",
371 /* s3c2410_pm_check_restore
373 * check the CRCs after the restore event and free the memory used
377 static void s3c2410_pm_check_restore(void)
380 s3c2410_pm_run_sysram(s3c2410_pm_runcheck
, crcs
);
388 #define s3c2410_pm_check_prepare() do { } while(0)
389 #define s3c2410_pm_check_restore() do { } while(0)
390 #define s3c2410_pm_check_store() do { } while(0)
393 /* helper functions to save and restore register state */
395 void s3c2410_pm_do_save(struct sleep_save
*ptr
, int count
)
397 for (; count
> 0; count
--, ptr
++) {
398 ptr
->val
= __raw_readl(ptr
->reg
);
399 DBG("saved %p value %08lx\n", ptr
->reg
, ptr
->val
);
403 /* s3c2410_pm_do_restore
405 * restore the system from the given list of saved registers
407 * Note, we do not use DBG() in here, as the system may not have
408 * restore the UARTs state yet
411 void s3c2410_pm_do_restore(struct sleep_save
*ptr
, int count
)
413 for (; count
> 0; count
--, ptr
++) {
414 printk(KERN_DEBUG
"restore %p (restore %08lx, was %08x)\n",
415 ptr
->reg
, ptr
->val
, __raw_readl(ptr
->reg
));
417 __raw_writel(ptr
->val
, ptr
->reg
);
421 /* s3c2410_pm_do_restore_core
423 * similar to s3c2410_pm_do_restore_core
425 * WARNING: Do not put any debug in here that may effect memory or use
426 * peripherals, as things may be changing!
429 static void s3c2410_pm_do_restore_core(struct sleep_save
*ptr
, int count
)
431 for (; count
> 0; count
--, ptr
++) {
432 __raw_writel(ptr
->val
, ptr
->reg
);
436 /* s3c2410_pm_show_resume_irqs
438 * print any IRQs asserted at resume time (ie, we woke from)
441 static void s3c2410_pm_show_resume_irqs(int start
, unsigned long which
,
448 for (i
= 0; i
<= 31; i
++) {
449 if ((which
) & (1L<<i
)) {
450 DBG("IRQ %d asserted at resume\n", start
+i
);
455 /* s3c2410_pm_check_resume_pin
457 * check to see if the pin is configured correctly for sleep mode, and
458 * make any necessary adjustments if it is not
461 static void s3c2410_pm_check_resume_pin(unsigned int pin
, unsigned int irqoffs
)
463 unsigned long irqstate
;
464 unsigned long pinstate
;
465 int irq
= s3c2410_gpio_getirq(pin
);
468 irqstate
= s3c_irqwake_intmask
& (1L<<irqoffs
);
470 irqstate
= s3c_irqwake_eintmask
& (1L<<irqoffs
);
472 pinstate
= s3c2410_gpio_getcfg(pin
);
473 pinstate
>>= S3C2410_GPIO_OFFSET(pin
)*2;
476 if (pinstate
== 0x02)
477 DBG("Leaving IRQ %d (pin %d) enabled\n", irq
, pin
);
479 if (pinstate
== 0x02) {
480 DBG("Disabling IRQ %d (pin %d)\n", irq
, pin
);
481 s3c2410_gpio_cfgpin(pin
, 0x00);
486 /* s3c2410_pm_configure_extint
488 * configure all external interrupt pins
491 static void s3c2410_pm_configure_extint(void)
495 /* for each of the external interrupts (EINT0..EINT15) we
496 * need to check wether it is an external interrupt source,
497 * and then configure it as an input if it is not
500 for (pin
= S3C2410_GPF0
; pin
<= S3C2410_GPF7
; pin
++) {
501 s3c2410_pm_check_resume_pin(pin
, pin
- S3C2410_GPF0
);
504 for (pin
= S3C2410_GPG0
; pin
<= S3C2410_GPG7
; pin
++) {
505 s3c2410_pm_check_resume_pin(pin
, (pin
- S3C2410_GPG0
)+8);
509 #define any_allowed(mask, allow) (((mask) & (allow)) != (allow))
513 * central control for sleep/resume process
516 static int s3c2410_pm_enter(suspend_state_t state
)
518 unsigned long regs_save
[16];
521 /* ensure the debug is initialised (if enabled) */
523 s3c2410_pm_debug_init();
525 DBG("s3c2410_pm_enter(%d)\n", state
);
527 if (state
!= PM_SUSPEND_MEM
) {
528 printk(KERN_ERR PFX
"error: only PM_SUSPEND_MEM supported\n");
532 /* check if we have anything to wake-up with... bad things seem
533 * to happen if you suspend with no wakeup (system will often
534 * require a full power-cycle)
537 if (!any_allowed(s3c_irqwake_intmask
, s3c_irqwake_intallow
) &&
538 !any_allowed(s3c_irqwake_eintmask
, s3c_irqwake_eintallow
)) {
539 printk(KERN_ERR PFX
"No sources enabled for wake-up!\n");
540 printk(KERN_ERR PFX
"Aborting sleep\n");
544 /* prepare check area if configured */
546 s3c2410_pm_check_prepare();
548 /* store the physical address of the register recovery block */
550 s3c2410_sleep_save_phys
= virt_to_phys(regs_save
);
552 DBG("s3c2410_sleep_save_phys=0x%08lx\n", s3c2410_sleep_save_phys
);
554 /* ensure at least GESTATUS3 has the resume address */
556 __raw_writel(virt_to_phys(s3c2410_cpu_resume
), S3C2410_GSTATUS3
);
558 DBG("GSTATUS3 0x%08x\n", __raw_readl(S3C2410_GSTATUS3
));
559 DBG("GSTATUS4 0x%08x\n", __raw_readl(S3C2410_GSTATUS4
));
561 /* save all necessary core registers not covered by the drivers */
563 s3c2410_pm_do_save(gpio_save
, ARRAY_SIZE(gpio_save
));
564 s3c2410_pm_do_save(irq_save
, ARRAY_SIZE(irq_save
));
565 s3c2410_pm_do_save(core_save
, ARRAY_SIZE(core_save
));
566 s3c2410_pm_do_save(uart_save
, ARRAY_SIZE(uart_save
));
568 /* set the irq configuration for wake */
570 s3c2410_pm_configure_extint();
572 DBG("sleep: irq wakeup masks: %08lx,%08lx\n",
573 s3c_irqwake_intmask
, s3c_irqwake_eintmask
);
575 __raw_writel(s3c_irqwake_intmask
, S3C2410_INTMSK
);
576 __raw_writel(s3c_irqwake_eintmask
, S3C2410_EINTMASK
);
578 /* ack any outstanding external interrupts before we go to sleep */
580 __raw_writel(__raw_readl(S3C2410_EINTPEND
), S3C2410_EINTPEND
);
582 /* flush cache back to ram */
584 arm920_flush_kern_cache_all();
586 s3c2410_pm_check_store();
588 // need to make some form of time-delta
590 /* send the cpu to sleep... */
592 __raw_writel(0x00, S3C2410_CLKCON
); /* turn off clocks over sleep */
594 s3c2410_cpu_suspend(regs_save
);
596 /* unset the return-from-sleep flag, to ensure reset */
598 tmp
= __raw_readl(S3C2410_GSTATUS2
);
599 tmp
&= S3C2410_GSTATUS2_OFFRESET
;
600 __raw_writel(tmp
, S3C2410_GSTATUS2
);
602 /* restore the system state */
604 s3c2410_pm_do_restore_core(core_save
, ARRAY_SIZE(core_save
));
605 s3c2410_pm_do_restore(gpio_save
, ARRAY_SIZE(gpio_save
));
606 s3c2410_pm_do_restore(irq_save
, ARRAY_SIZE(irq_save
));
607 s3c2410_pm_do_restore(uart_save
, ARRAY_SIZE(uart_save
));
609 s3c2410_pm_debug_init();
611 /* check what irq (if any) restored the system */
613 DBG("post sleep: IRQs 0x%08x, 0x%08x\n",
614 __raw_readl(S3C2410_SRCPND
),
615 __raw_readl(S3C2410_EINTPEND
));
617 s3c2410_pm_show_resume_irqs(IRQ_EINT0
, __raw_readl(S3C2410_SRCPND
),
618 s3c_irqwake_intmask
);
620 s3c2410_pm_show_resume_irqs(IRQ_EINT4
-4, __raw_readl(S3C2410_EINTPEND
),
621 s3c_irqwake_eintmask
);
623 DBG("post sleep, preparing to return\n");
625 s3c2410_pm_check_restore();
627 /* ok, let's return from sleep */
629 DBG("S3C2410 PM Resume (post-restore)\n");
634 * Called after processes are frozen, but before we shut down devices.
636 static int s3c2410_pm_prepare(suspend_state_t state
)
642 * Called after devices are re-setup, but before processes are thawed.
644 static int s3c2410_pm_finish(suspend_state_t state
)
650 * Set to PM_DISK_FIRMWARE so we can quickly veto suspend-to-disk.
652 static struct pm_ops s3c2410_pm_ops
= {
653 .pm_disk_mode
= PM_DISK_FIRMWARE
,
654 .prepare
= s3c2410_pm_prepare
,
655 .enter
= s3c2410_pm_enter
,
656 .finish
= s3c2410_pm_finish
,
661 * Attach the power management functions. This should be called
662 * from the board specific initialisation if the board supports
666 int __init
s3c2410_pm_init(void)
668 printk("S3C2410 Power Management, (c) 2004 Simtec Electronics\n");
670 pm_set_ops(&s3c2410_pm_ops
);