xref: /OK3568_Linux_fs/kernel/include/linux/wkup_m3_ipc.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * TI Wakeup M3 for AMx3 SoCs Power Management Routines
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright (C) 2015 Texas Instruments Incorporated - https://www.ti.com/
5*4882a593Smuzhiyun  * Dave Gerlach <d-gerlach@ti.com>
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * This program is free software; you can redistribute it and/or
8*4882a593Smuzhiyun  * modify it under the terms of the GNU General Public License as
9*4882a593Smuzhiyun  * published by the Free Software Foundation version 2.
10*4882a593Smuzhiyun  *
11*4882a593Smuzhiyun  * This program is distributed "as is" WITHOUT ANY WARRANTY of any
12*4882a593Smuzhiyun  * kind, whether express or implied; without even the implied warranty
13*4882a593Smuzhiyun  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14*4882a593Smuzhiyun  * GNU General Public License for more details.
15*4882a593Smuzhiyun  */
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun #ifndef _LINUX_WKUP_M3_IPC_H
18*4882a593Smuzhiyun #define _LINUX_WKUP_M3_IPC_H
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #define WKUP_M3_DEEPSLEEP	1
21*4882a593Smuzhiyun #define WKUP_M3_STANDBY		2
22*4882a593Smuzhiyun #define WKUP_M3_IDLE		3
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun #include <linux/mailbox_client.h>
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun struct wkup_m3_ipc_ops;
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun struct wkup_m3_ipc {
29*4882a593Smuzhiyun 	struct rproc *rproc;
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun 	void __iomem *ipc_mem_base;
32*4882a593Smuzhiyun 	struct device *dev;
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun 	int mem_type;
35*4882a593Smuzhiyun 	unsigned long resume_addr;
36*4882a593Smuzhiyun 	int state;
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun 	struct completion sync_complete;
39*4882a593Smuzhiyun 	struct mbox_client mbox_client;
40*4882a593Smuzhiyun 	struct mbox_chan *mbox;
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun 	struct wkup_m3_ipc_ops *ops;
43*4882a593Smuzhiyun 	int is_rtc_only;
44*4882a593Smuzhiyun };
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun struct wkup_m3_wakeup_src {
47*4882a593Smuzhiyun 	int irq_nr;
48*4882a593Smuzhiyun 	char src[10];
49*4882a593Smuzhiyun };
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun struct wkup_m3_ipc_ops {
52*4882a593Smuzhiyun 	void (*set_mem_type)(struct wkup_m3_ipc *m3_ipc, int mem_type);
53*4882a593Smuzhiyun 	void (*set_resume_address)(struct wkup_m3_ipc *m3_ipc, void *addr);
54*4882a593Smuzhiyun 	int (*prepare_low_power)(struct wkup_m3_ipc *m3_ipc, int state);
55*4882a593Smuzhiyun 	int (*finish_low_power)(struct wkup_m3_ipc *m3_ipc);
56*4882a593Smuzhiyun 	int (*request_pm_status)(struct wkup_m3_ipc *m3_ipc);
57*4882a593Smuzhiyun 	const char *(*request_wake_src)(struct wkup_m3_ipc *m3_ipc);
58*4882a593Smuzhiyun 	void (*set_rtc_only)(struct wkup_m3_ipc *m3_ipc);
59*4882a593Smuzhiyun };
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun struct wkup_m3_ipc *wkup_m3_ipc_get(void);
62*4882a593Smuzhiyun void wkup_m3_ipc_put(struct wkup_m3_ipc *m3_ipc);
63*4882a593Smuzhiyun void wkup_m3_set_rtc_only_mode(void);
64*4882a593Smuzhiyun #endif /* _LINUX_WKUP_M3_IPC_H */
65