1 // SPDX-License-Identifier: GPL-2.0-only 1 // SPDX-License-Identifier: GPL-2.0-only
2 /* 2 /*
3 * Copyright (C) 2011 Google, Inc. 3 * Copyright (C) 2011 Google, Inc.
4 * 4 *
5 * Author: 5 * Author:
6 * Colin Cross <ccross@android.com> 6 * Colin Cross <ccross@android.com>
7 */ 7 */
8 8
9 #include <linux/kernel.h> 9 #include <linux/kernel.h>
10 #include <linux/cpu_pm.h> 10 #include <linux/cpu_pm.h>
11 #include <linux/module.h> 11 #include <linux/module.h>
12 #include <linux/notifier.h> 12 #include <linux/notifier.h>
13 #include <linux/spinlock.h> 13 #include <linux/spinlock.h>
14 #include <linux/syscore_ops.h> 14 #include <linux/syscore_ops.h>
15 15
16 /* 16 /*
17 * atomic_notifiers use a spinlock_t, which ca 17 * atomic_notifiers use a spinlock_t, which can block under PREEMPT_RT.
18 * Notifications for cpu_pm will be issued by 18 * Notifications for cpu_pm will be issued by the idle task itself, which can
19 * never block, IOW it requires using a raw_sp 19 * never block, IOW it requires using a raw_spinlock_t.
20 */ 20 */
21 static struct { 21 static struct {
22 struct raw_notifier_head chain; 22 struct raw_notifier_head chain;
23 raw_spinlock_t lock; 23 raw_spinlock_t lock;
24 } cpu_pm_notifier = { 24 } cpu_pm_notifier = {
25 .chain = RAW_NOTIFIER_INIT(cpu_pm_noti 25 .chain = RAW_NOTIFIER_INIT(cpu_pm_notifier.chain),
26 .lock = __RAW_SPIN_LOCK_UNLOCKED(cpu_ 26 .lock = __RAW_SPIN_LOCK_UNLOCKED(cpu_pm_notifier.lock),
27 }; 27 };
28 28
29 static int cpu_pm_notify(enum cpu_pm_event eve 29 static int cpu_pm_notify(enum cpu_pm_event event)
30 { 30 {
31 int ret; 31 int ret;
32 32
33 rcu_read_lock(); 33 rcu_read_lock();
34 ret = raw_notifier_call_chain(&cpu_pm_ 34 ret = raw_notifier_call_chain(&cpu_pm_notifier.chain, event, NULL);
35 rcu_read_unlock(); 35 rcu_read_unlock();
36 36
37 return notifier_to_errno(ret); 37 return notifier_to_errno(ret);
38 } 38 }
39 39
40 static int cpu_pm_notify_robust(enum cpu_pm_ev 40 static int cpu_pm_notify_robust(enum cpu_pm_event event_up, enum cpu_pm_event event_down)
41 { 41 {
42 unsigned long flags; 42 unsigned long flags;
43 int ret; 43 int ret;
44 44
45 raw_spin_lock_irqsave(&cpu_pm_notifier 45 raw_spin_lock_irqsave(&cpu_pm_notifier.lock, flags);
46 ret = raw_notifier_call_chain_robust(& 46 ret = raw_notifier_call_chain_robust(&cpu_pm_notifier.chain, event_up, event_down, NULL);
47 raw_spin_unlock_irqrestore(&cpu_pm_not 47 raw_spin_unlock_irqrestore(&cpu_pm_notifier.lock, flags);
48 48
49 return notifier_to_errno(ret); 49 return notifier_to_errno(ret);
50 } 50 }
51 51
52 /** 52 /**
53 * cpu_pm_register_notifier - register a drive 53 * cpu_pm_register_notifier - register a driver with cpu_pm
54 * @nb: notifier block to register 54 * @nb: notifier block to register
55 * 55 *
56 * Add a driver to a list of drivers that are 56 * Add a driver to a list of drivers that are notified about
57 * CPU and CPU cluster low power entry and exi 57 * CPU and CPU cluster low power entry and exit.
58 * 58 *
59 * This function has the same return condition 59 * This function has the same return conditions as raw_notifier_chain_register.
60 */ 60 */
61 int cpu_pm_register_notifier(struct notifier_b 61 int cpu_pm_register_notifier(struct notifier_block *nb)
62 { 62 {
63 unsigned long flags; 63 unsigned long flags;
64 int ret; 64 int ret;
65 65
66 raw_spin_lock_irqsave(&cpu_pm_notifier 66 raw_spin_lock_irqsave(&cpu_pm_notifier.lock, flags);
67 ret = raw_notifier_chain_register(&cpu 67 ret = raw_notifier_chain_register(&cpu_pm_notifier.chain, nb);
68 raw_spin_unlock_irqrestore(&cpu_pm_not 68 raw_spin_unlock_irqrestore(&cpu_pm_notifier.lock, flags);
69 return ret; 69 return ret;
70 } 70 }
71 EXPORT_SYMBOL_GPL(cpu_pm_register_notifier); 71 EXPORT_SYMBOL_GPL(cpu_pm_register_notifier);
72 72
73 /** 73 /**
74 * cpu_pm_unregister_notifier - unregister a d 74 * cpu_pm_unregister_notifier - unregister a driver with cpu_pm
75 * @nb: notifier block to be unregistered 75 * @nb: notifier block to be unregistered
76 * 76 *
77 * Remove a driver from the CPU PM notifier li 77 * Remove a driver from the CPU PM notifier list.
78 * 78 *
79 * This function has the same return condition 79 * This function has the same return conditions as raw_notifier_chain_unregister.
80 */ 80 */
81 int cpu_pm_unregister_notifier(struct notifier 81 int cpu_pm_unregister_notifier(struct notifier_block *nb)
82 { 82 {
83 unsigned long flags; 83 unsigned long flags;
84 int ret; 84 int ret;
85 85
86 raw_spin_lock_irqsave(&cpu_pm_notifier 86 raw_spin_lock_irqsave(&cpu_pm_notifier.lock, flags);
87 ret = raw_notifier_chain_unregister(&c 87 ret = raw_notifier_chain_unregister(&cpu_pm_notifier.chain, nb);
88 raw_spin_unlock_irqrestore(&cpu_pm_not 88 raw_spin_unlock_irqrestore(&cpu_pm_notifier.lock, flags);
89 return ret; 89 return ret;
90 } 90 }
91 EXPORT_SYMBOL_GPL(cpu_pm_unregister_notifier); 91 EXPORT_SYMBOL_GPL(cpu_pm_unregister_notifier);
92 92
93 /** 93 /**
94 * cpu_pm_enter - CPU low power entry notifier 94 * cpu_pm_enter - CPU low power entry notifier
95 * 95 *
96 * Notifies listeners that a single CPU is ent 96 * Notifies listeners that a single CPU is entering a low power state that may
97 * cause some blocks in the same power domain 97 * cause some blocks in the same power domain as the cpu to reset.
98 * 98 *
99 * Must be called on the affected CPU with int 99 * Must be called on the affected CPU with interrupts disabled. Platform is
100 * responsible for ensuring that cpu_pm_enter 100 * responsible for ensuring that cpu_pm_enter is not called twice on the same
101 * CPU before cpu_pm_exit is called. Notified 101 * CPU before cpu_pm_exit is called. Notified drivers can include VFP
102 * co-processor, interrupt controller and its 102 * co-processor, interrupt controller and its PM extensions, local CPU
103 * timers context save/restore which shouldn't 103 * timers context save/restore which shouldn't be interrupted. Hence it
104 * must be called with interrupts disabled. 104 * must be called with interrupts disabled.
105 * 105 *
106 * Return conditions are same as __raw_notifie 106 * Return conditions are same as __raw_notifier_call_chain.
107 */ 107 */
108 int cpu_pm_enter(void) 108 int cpu_pm_enter(void)
109 { 109 {
110 return cpu_pm_notify_robust(CPU_PM_ENT 110 return cpu_pm_notify_robust(CPU_PM_ENTER, CPU_PM_ENTER_FAILED);
111 } 111 }
112 EXPORT_SYMBOL_GPL(cpu_pm_enter); 112 EXPORT_SYMBOL_GPL(cpu_pm_enter);
113 113
114 /** 114 /**
115 * cpu_pm_exit - CPU low power exit notifier 115 * cpu_pm_exit - CPU low power exit notifier
116 * 116 *
117 * Notifies listeners that a single CPU is exi 117 * Notifies listeners that a single CPU is exiting a low power state that may
118 * have caused some blocks in the same power d 118 * have caused some blocks in the same power domain as the cpu to reset.
119 * 119 *
120 * Notified drivers can include VFP co-process 120 * Notified drivers can include VFP co-processor, interrupt controller
121 * and its PM extensions, local CPU timers con 121 * and its PM extensions, local CPU timers context save/restore which
122 * shouldn't be interrupted. Hence it must be 122 * shouldn't be interrupted. Hence it must be called with interrupts disabled.
123 * 123 *
124 * Return conditions are same as __raw_notifie 124 * Return conditions are same as __raw_notifier_call_chain.
125 */ 125 */
126 int cpu_pm_exit(void) 126 int cpu_pm_exit(void)
127 { 127 {
128 return cpu_pm_notify(CPU_PM_EXIT); 128 return cpu_pm_notify(CPU_PM_EXIT);
129 } 129 }
130 EXPORT_SYMBOL_GPL(cpu_pm_exit); 130 EXPORT_SYMBOL_GPL(cpu_pm_exit);
131 131
132 /** 132 /**
133 * cpu_cluster_pm_enter - CPU cluster low powe 133 * cpu_cluster_pm_enter - CPU cluster low power entry notifier
134 * 134 *
135 * Notifies listeners that all cpus in a power 135 * Notifies listeners that all cpus in a power domain are entering a low power
136 * state that may cause some blocks in the sam 136 * state that may cause some blocks in the same power domain to reset.
137 * 137 *
138 * Must be called after cpu_pm_enter has been 138 * Must be called after cpu_pm_enter has been called on all cpus in the power
139 * domain, and before cpu_pm_exit has been cal 139 * domain, and before cpu_pm_exit has been called on any cpu in the power
140 * domain. Notified drivers can include VFP co 140 * domain. Notified drivers can include VFP co-processor, interrupt controller
141 * and its PM extensions, local CPU timers con 141 * and its PM extensions, local CPU timers context save/restore which
142 * shouldn't be interrupted. Hence it must be 142 * shouldn't be interrupted. Hence it must be called with interrupts disabled.
143 * 143 *
144 * Must be called with interrupts disabled. 144 * Must be called with interrupts disabled.
145 * 145 *
146 * Return conditions are same as __raw_notifie 146 * Return conditions are same as __raw_notifier_call_chain.
147 */ 147 */
148 int cpu_cluster_pm_enter(void) 148 int cpu_cluster_pm_enter(void)
149 { 149 {
150 return cpu_pm_notify_robust(CPU_CLUSTE 150 return cpu_pm_notify_robust(CPU_CLUSTER_PM_ENTER, CPU_CLUSTER_PM_ENTER_FAILED);
151 } 151 }
152 EXPORT_SYMBOL_GPL(cpu_cluster_pm_enter); 152 EXPORT_SYMBOL_GPL(cpu_cluster_pm_enter);
153 153
154 /** 154 /**
155 * cpu_cluster_pm_exit - CPU cluster low power 155 * cpu_cluster_pm_exit - CPU cluster low power exit notifier
156 * 156 *
157 * Notifies listeners that all cpus in a power 157 * Notifies listeners that all cpus in a power domain are exiting form a
158 * low power state that may have caused some b 158 * low power state that may have caused some blocks in the same power domain
159 * to reset. 159 * to reset.
160 * 160 *
161 * Must be called after cpu_cluster_pm_enter h 161 * Must be called after cpu_cluster_pm_enter has been called for the power
162 * domain, and before cpu_pm_exit has been cal 162 * domain, and before cpu_pm_exit has been called on any cpu in the power
163 * domain. Notified drivers can include VFP co 163 * domain. Notified drivers can include VFP co-processor, interrupt controller
164 * and its PM extensions, local CPU timers con 164 * and its PM extensions, local CPU timers context save/restore which
165 * shouldn't be interrupted. Hence it must be 165 * shouldn't be interrupted. Hence it must be called with interrupts disabled.
166 * 166 *
167 * Return conditions are same as __raw_notifie 167 * Return conditions are same as __raw_notifier_call_chain.
168 */ 168 */
169 int cpu_cluster_pm_exit(void) 169 int cpu_cluster_pm_exit(void)
170 { 170 {
171 return cpu_pm_notify(CPU_CLUSTER_PM_EX 171 return cpu_pm_notify(CPU_CLUSTER_PM_EXIT);
172 } 172 }
173 EXPORT_SYMBOL_GPL(cpu_cluster_pm_exit); 173 EXPORT_SYMBOL_GPL(cpu_cluster_pm_exit);
174 174
175 #ifdef CONFIG_PM 175 #ifdef CONFIG_PM
176 static int cpu_pm_suspend(void) 176 static int cpu_pm_suspend(void)
177 { 177 {
178 int ret; 178 int ret;
179 179
180 ret = cpu_pm_enter(); 180 ret = cpu_pm_enter();
181 if (ret) 181 if (ret)
182 return ret; 182 return ret;
183 183
184 ret = cpu_cluster_pm_enter(); 184 ret = cpu_cluster_pm_enter();
185 return ret; 185 return ret;
186 } 186 }
187 187
188 static void cpu_pm_resume(void) 188 static void cpu_pm_resume(void)
189 { 189 {
190 cpu_cluster_pm_exit(); 190 cpu_cluster_pm_exit();
191 cpu_pm_exit(); 191 cpu_pm_exit();
192 } 192 }
193 193
194 static struct syscore_ops cpu_pm_syscore_ops = 194 static struct syscore_ops cpu_pm_syscore_ops = {
195 .suspend = cpu_pm_suspend, 195 .suspend = cpu_pm_suspend,
196 .resume = cpu_pm_resume, 196 .resume = cpu_pm_resume,
197 }; 197 };
198 198
199 static int cpu_pm_init(void) 199 static int cpu_pm_init(void)
200 { 200 {
201 register_syscore_ops(&cpu_pm_syscore_o 201 register_syscore_ops(&cpu_pm_syscore_ops);
202 return 0; 202 return 0;
203 } 203 }
204 core_initcall(cpu_pm_init); 204 core_initcall(cpu_pm_init);
205 #endif 205 #endif
206 206
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.