xref: /freebsd/sys/compat/linuxkpi/common/include/linux/pm.h (revision 592ae60e2b2eff6c2ec467c34be9a457ce24b044)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2020-2024 The FreeBSD Foundation
5  *
6  * This software was developed by Björn Zeeb under sponsorship from
7  * the FreeBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #ifndef	_LINUXKPI_LINUX_PM_H
32 #define	_LINUXKPI_LINUX_PM_H
33 
34 #include <linux/kernel.h>	/* pr_debug */
35 #include <asm/atomic.h>
36 
37 /* Needed but breaks linux_usb.c */
38 /* #include <linux/completion.h> */
39 /* #include <linux/wait.h> */
40 
41 struct device;
42 
43 typedef struct pm_message {
44 	int event;
45 } pm_message_t;
46 
47 struct dev_pm_domain {
48 };
49 
50 struct dev_pm_info {
51 	atomic_t usage_count;
52 	bool can_wakeup;
53 };
54 
55 #define	PM_EVENT_FREEZE		0x0001
56 #define	PM_EVENT_SUSPEND	0x0002
57 
58 #define	pm_sleep_ptr(_p)					\
59     IS_ENABLED(CONFIG_PM_SLEEP) ? (_p) : NULL
60 
61 #ifdef CONFIG_PM_SLEEP
62 #define	__SET_PM_OPS(_suspendfunc, _resumefunc)			\
63 	.suspend	= _suspendfunc,				\
64 	.resume		= _resumefunc,				\
65 	.freeze		= _suspendfunc,				\
66 	.thaw		= _resumefunc,				\
67 	.poweroff	= _suspendfunc,				\
68 	.restore	= _resumefunc,				\
69 
70 #define	SIMPLE_DEV_PM_OPS(_name, _suspendfunc, _resumefunc)	\
71 const struct dev_pm_ops _name = {				\
72 	__SET_PM_OPS(_suspendfunc, _resumefunc)			\
73 }
74 
75 #define	DEFINE_SIMPLE_DEV_PM_OPS(_name, _suspendfunc, _resumefunc) \
76 const struct dev_pm_ops _name = {				\
77 	__SET_PM_OPS(_suspendfunc, _resumefunc)			\
78 }
79 
80 #define	SET_SYSTEM_SLEEP_PM_OPS(_suspendfunc, _resumefunc)	\
81 	__SET_PM_OPS(_suspendfunc, _resumefunc)
82 #else
83 #define	SIMPLE_DEV_PM_OPS(_name, _suspendfunc, _resumefunc)	\
84 const struct dev_pm_ops _name = {				\
85 }
86 #define	DEFINE_SIMPLE_DEV_PM_OPS(_name, _suspendfunc, _resumefunc) \
87 const struct dev_pm_ops _name = {				\
88 }
89 #endif
90 
91 bool linuxkpi_device_can_wakeup(struct device *);
92 #define	device_can_wakeup(_dev)		linuxkpi_device_can_wakeup(_dev)
93 
94 static inline void
95 pm_wakeup_event(struct device *dev __unused, unsigned int x __unused)
96 {
97 
98 	pr_debug("%s: TODO\n", __func__);
99 }
100 
101 /*
102  * We do not need to specify anything here as a VT switch always happens on
103  * suspend/resume.
104  */
105 static inline void
106 pm_vt_switch_required(struct device *dev __unused, bool required __unused)
107 {
108 }
109 
110 static inline void
111 pm_vt_switch_unregister(struct device *dev __unused)
112 {
113 }
114 
115 #ifdef CONFIG_PM_SLEEP
116 static inline void
117 device_set_wakeup_capable(struct device *dev __unused, bool capable __unused)
118 {
119 	pr_debug("%s: TODO\n", __func__);
120 }
121 #else
122 void linuxkpi_device_set_wakeup_capable(struct device *, bool);
123 
124 static inline void
125 device_set_wakeup_capable(struct device *dev, bool capable)
126 {
127 	linuxkpi_device_set_wakeup_capable(dev, capable);
128 }
129 #endif
130 
131 #endif	/* _LINUXKPI_LINUX_PM_H */
132