xref: /freebsd/sys/compat/linuxkpi/common/include/linux/pm.h (revision 7ef62cebc2f965b0f640263e179276928885e33d)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2020 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  * $FreeBSD$
31  */
32 
33 #ifndef	_LINUXKPI_LINUX_PM_H
34 #define	_LINUXKPI_LINUX_PM_H
35 
36 #include <linux/kernel.h>	/* pr_debug */
37 #include <asm/atomic.h>
38 
39 /* Needed but breaks linux_usb.c */
40 /* #include <linux/completion.h> */
41 /* #include <linux/wait.h> */
42 
43 struct device;
44 
45 typedef struct pm_message {
46 	int event;
47 } pm_message_t;
48 
49 struct dev_pm_domain {
50 };
51 
52 struct dev_pm_info {
53 	atomic_t usage_count;
54 };
55 
56 #define	PM_EVENT_FREEZE		0x0001
57 #define	PM_EVENT_SUSPEND	0x0002
58 
59 #define	pm_sleep_ptr(_p)					\
60     IS_ENABLED(CONFIG_PM_SLEEP) ? (_p) : NULL
61 
62 #ifdef CONFIG_PM_SLEEP
63 #define	SIMPLE_DEV_PM_OPS(_name, _suspendfunc, _resumefunc)	\
64 const struct dev_pm_ops _name = {				\
65 	.suspend	= _suspendfunc,		\
66 	.resume		= _resumefunc,		\
67 	.freeze		= _suspendfunc,		\
68 	.thaw		= _resumefunc,		\
69 	.poweroff	= _suspendfunc,		\
70 	.restore	= _resumefunc,		\
71 }
72 
73 #define	DEFINE_SIMPLE_DEV_PM_OPS(_name, _suspendfunc, _resumefunc) \
74 const struct dev_pm_ops _name = {				\
75 	.suspend	= _suspendfunc,		\
76 	.resume		= _resumefunc,		\
77 	.freeze		= _suspendfunc,		\
78 	.thaw		= _resumefunc,		\
79 	.poweroff	= _suspendfunc,		\
80 	.restore	= _resumefunc,		\
81 }
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 static inline void
92 pm_wakeup_event(struct device *dev __unused, unsigned int x __unused)
93 {
94 
95 	pr_debug("%s: TODO\n", __func__);
96 }
97 
98 #endif	/* _LINUXKPI_LINUX_PM_H */
99