[linux-block.git] / include / linux / platform_data / pm33xx.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * TI pm33xx platform data
 *
 * Copyright (C) 2016-2018 Texas Instruments, Inc.
 *	Dave Gerlach <d-gerlach@ti.com>
 */

#ifndef _LINUX_PLATFORM_DATA_PM33XX_H
#define _LINUX_PLATFORM_DATA_PM33XX_H

#include <linux/kbuild.h>
#include <linux/types.h>

/*
 * WFI Flags for sleep code control
 *
 * These flags allow PM code to exclude certain operations from happening
 * in the low level ASM code found in sleep33xx.S and sleep43xx.S
 *
 * WFI_FLAG_FLUSH_CACHE: Flush the ARM caches and disable caching. Only
 *			 needed when MPU will lose context.
 * WFI_FLAG_SELF_REFRESH: Let EMIF place DDR memory into self-refresh and
 *			  disable EMIF.
 * WFI_FLAG_SAVE_EMIF: Save context of all EMIF registers and restore in
 *		       resume path. Only needed if PER domain loses context
 *		       and must also have WFI_FLAG_SELF_REFRESH set.
 * WFI_FLAG_WAKE_M3: Disable MPU clock or clockdomain to cause wkup_m3 to
 *		     execute when WFI instruction executes.
 * WFI_FLAG_RTC_ONLY: Configure the RTC to enter RTC+DDR mode.
 */
#define WFI_FLAG_FLUSH_CACHE		BIT(0)
#define WFI_FLAG_SELF_REFRESH		BIT(1)
#define WFI_FLAG_SAVE_EMIF		BIT(2)
#define WFI_FLAG_WAKE_M3		BIT(3)
#define WFI_FLAG_RTC_ONLY		BIT(4)

#ifndef __ASSEMBLER__
struct am33xx_pm_sram_addr {
	void (*do_wfi)(void);
	unsigned long *do_wfi_sz;
	unsigned long *resume_offset;
	unsigned long *emif_sram_table;
	unsigned long *ro_sram_data;
	unsigned long resume_address;
};

struct am33xx_pm_platform_data {
	int     (*init)(int (*idle)(u32 wfi_flags));
	int     (*deinit)(void);
	int	(*soc_suspend)(unsigned int state, int (*fn)(unsigned long),
			       unsigned long args);
	int	(*cpu_suspend)(int (*fn)(unsigned long), unsigned long args);
	void    (*begin_suspend)(void);
	void    (*finish_suspend)(void);
	struct  am33xx_pm_sram_addr *(*get_sram_addrs)(void);
	void (*save_context)(void);
	void (*restore_context)(void);
	int (*check_off_mode_enable)(void);
};

struct am33xx_pm_sram_data {
	u32 wfi_flags;
	u32 l2_aux_ctrl_val;
	u32 l2_prefetch_ctrl_val;
} __packed __aligned(8);

struct am33xx_pm_ro_sram_data {
	u32 amx3_pm_sram_data_virt;
	u32 amx3_pm_sram_data_phys;
	void __iomem *rtc_base_virt;
} __packed __aligned(8);

#endif /* __ASSEMBLER__ */
#endif /* _LINUX_PLATFORM_DATA_PM33XX_H */
Commit	Line	Data
41d9d44d DG	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	/*
	3	* TI pm33xx platform data
	4	*
	5	* Copyright (C) 2016-2018 Texas Instruments, Inc.
	6	* Dave Gerlach <d-gerlach@ti.com>
	7	*/
	8
	9	#ifndef _LINUX_PLATFORM_DATA_PM33XX_H
	10	#define _LINUX_PLATFORM_DATA_PM33XX_H
	11
	12	#include <linux/kbuild.h>
	13	#include <linux/types.h>
	14
74655749 DG	15	/*
	16	* WFI Flags for sleep code control
	17	*
	18	* These flags allow PM code to exclude certain operations from happening
	19	* in the low level ASM code found in sleep33xx.S and sleep43xx.S
	20	*
	21	* WFI_FLAG_FLUSH_CACHE: Flush the ARM caches and disable caching. Only
	22	* needed when MPU will lose context.
	23	* WFI_FLAG_SELF_REFRESH: Let EMIF place DDR memory into self-refresh and
	24	* disable EMIF.
	25	* WFI_FLAG_SAVE_EMIF: Save context of all EMIF registers and restore in
	26	* resume path. Only needed if PER domain loses context
	27	* and must also have WFI_FLAG_SELF_REFRESH set.
	28	* WFI_FLAG_WAKE_M3: Disable MPU clock or clockdomain to cause wkup_m3 to
	29	* execute when WFI instruction executes.
	30	* WFI_FLAG_RTC_ONLY: Configure the RTC to enter RTC+DDR mode.
	31	*/
	32	#define WFI_FLAG_FLUSH_CACHE BIT(0)
	33	#define WFI_FLAG_SELF_REFRESH BIT(1)
	34	#define WFI_FLAG_SAVE_EMIF BIT(2)
	35	#define WFI_FLAG_WAKE_M3 BIT(3)
	36	#define WFI_FLAG_RTC_ONLY BIT(4)
	37
41d9d44d DG	38	#ifndef __ASSEMBLER__
	39	struct am33xx_pm_sram_addr {
	40	void (*do_wfi)(void);
	41	unsigned long *do_wfi_sz;
	42	unsigned long *resume_offset;
	43	unsigned long *emif_sram_table;
	44	unsigned long *ro_sram_data;
8c5a916f	45	unsigned long resume_address;
41d9d44d DG	46	};
	47
	48	struct am33xx_pm_platform_data {
65880ab1 DG	49	int (init)(int (idle)(u32 wfi_flags));
65880ab1 DG	50	int (*deinit)(void);
74655749 DG	51	int (soc_suspend)(unsigned int state, int (fn)(unsigned long),
74655749 DG	52	unsigned long args);
06ee7a95 DG	53	int (cpu_suspend)(int (fn)(unsigned long), unsigned long args);
	54	void (*begin_suspend)(void);
	55	void (*finish_suspend)(void);
41d9d44d	56	struct am33xx_pm_sram_addr (get_sram_addrs)(void);
44c22a2d K	57	void (*save_context)(void);
44c22a2d K	58	void (*restore_context)(void);
44c22a2d	59	int (*check_off_mode_enable)(void);
41d9d44d DG	60	};
	61
	62	struct am33xx_pm_sram_data {
	63	u32 wfi_flags;
	64	u32 l2_aux_ctrl_val;
	65	u32 l2_prefetch_ctrl_val;
	66	} __packed __aligned(8);
	67
	68	struct am33xx_pm_ro_sram_data {
	69	u32 amx3_pm_sram_data_virt;
	70	u32 amx3_pm_sram_data_phys;
8c5a916f	71	void __iomem *rtc_base_virt;
41d9d44d DG	72	} __packed __aligned(8);
	73
	74	#endif /* __ASSEMBLER__ */
	75	#endif /* _LINUX_PLATFORM_DATA_PM33XX_H */