xref: /linux/include/linux/platform_data/ti-sysc.h (revision e7420c2d4495cbb9c14dd8bf8b3b4e5bdded6e20)
1 #ifndef __TI_SYSC_DATA_H__
2 #define __TI_SYSC_DATA_H__
3 
4 enum ti_sysc_module_type {
5 	TI_SYSC_OMAP2,
6 	TI_SYSC_OMAP2_TIMER,
7 	TI_SYSC_OMAP3_SHAM,
8 	TI_SYSC_OMAP3_AES,
9 	TI_SYSC_OMAP4,
10 	TI_SYSC_OMAP4_TIMER,
11 	TI_SYSC_OMAP4_SIMPLE,
12 	TI_SYSC_OMAP34XX_SR,
13 	TI_SYSC_OMAP36XX_SR,
14 	TI_SYSC_OMAP4_SR,
15 	TI_SYSC_OMAP4_MCASP,
16 	TI_SYSC_OMAP4_USB_HOST_FS,
17 };
18 
19 struct ti_sysc_cookie {
20 	void *data;
21 };
22 
23 /**
24  * struct sysc_regbits - TI OCP_SYSCONFIG register field offsets
25  * @midle_shift: Offset of the midle bit
26  * @clkact_shift: Offset of the clockactivity bit
27  * @sidle_shift: Offset of the sidle bit
28  * @enwkup_shift: Offset of the enawakeup bit
29  * @srst_shift: Offset of the softreset bit
30  * @autoidle_shift: Offset of the autoidle bit
31  * @dmadisable_shift: Offset of the dmadisable bit
32  * @emufree_shift; Offset of the emufree bit
33  *
34  * Note that 0 is a valid shift, and for ti-sysc.c -ENODEV can be used if a
35  * feature is not available.
36  */
37 struct sysc_regbits {
38 	s8 midle_shift;
39 	s8 clkact_shift;
40 	s8 sidle_shift;
41 	s8 enwkup_shift;
42 	s8 srst_shift;
43 	s8 autoidle_shift;
44 	s8 dmadisable_shift;
45 	s8 emufree_shift;
46 };
47 
48 #define SYSC_QUIRK_RESOURCE_PROVIDER	BIT(9)
49 #define SYSC_QUIRK_LEGACY_IDLE		BIT(8)
50 #define SYSC_QUIRK_RESET_STATUS		BIT(7)
51 #define SYSC_QUIRK_NO_IDLE_ON_INIT	BIT(6)
52 #define SYSC_QUIRK_NO_RESET_ON_INIT	BIT(5)
53 #define SYSC_QUIRK_OPT_CLKS_NEEDED	BIT(4)
54 #define SYSC_QUIRK_OPT_CLKS_IN_RESET	BIT(3)
55 #define SYSC_QUIRK_16BIT		BIT(2)
56 #define SYSC_QUIRK_UNCACHED		BIT(1)
57 #define SYSC_QUIRK_USE_CLOCKACT		BIT(0)
58 
59 #define SYSC_NR_IDLEMODES		4
60 
61 /**
62  * struct sysc_capabilities - capabilities for an interconnect target module
63  *
64  * @sysc_mask: bitmask of supported SYSCONFIG register bits
65  * @regbits: bitmask of SYSCONFIG register bits
66  * @mod_quirks: bitmask of module specific quirks
67  */
68 struct sysc_capabilities {
69 	const enum ti_sysc_module_type type;
70 	const u32 sysc_mask;
71 	const struct sysc_regbits *regbits;
72 	const u32 mod_quirks;
73 };
74 
75 /**
76  * struct sysc_config - configuration for an interconnect target module
77  * @sysc_val: configured value for sysc register
78  * @midlemodes: bitmask of supported master idle modes
79  * @sidlemodes: bitmask of supported master idle modes
80  * @srst_udelay: optional delay needed after OCP soft reset
81  * @quirks: bitmask of enabled quirks
82  */
83 struct sysc_config {
84 	u32 sysc_val;
85 	u32 syss_mask;
86 	u8 midlemodes;
87 	u8 sidlemodes;
88 	u8 srst_udelay;
89 	u32 quirks;
90 };
91 
92 enum sysc_registers {
93 	SYSC_REVISION,
94 	SYSC_SYSCONFIG,
95 	SYSC_SYSSTATUS,
96 	SYSC_MAX_REGS,
97 };
98 
99 /**
100  * struct ti_sysc_module_data - ti-sysc to hwmod translation data for a module
101  * @name: legacy "ti,hwmods" module name
102  * @module_pa: physical address of the interconnect target module
103  * @module_size: size of the interconnect target module
104  * @offsets: array of register offsets as listed in enum sysc_registers
105  * @nr_offsets: number of registers
106  * @cap: interconnect target module capabilities
107  * @cfg: interconnect target module configuration
108  *
109  * This data is enough to allocate a new struct omap_hwmod_class_sysconfig
110  * based on device tree data parsed by ti-sysc driver.
111  */
112 struct ti_sysc_module_data {
113 	const char *name;
114 	u64 module_pa;
115 	u32 module_size;
116 	int *offsets;
117 	int nr_offsets;
118 	const struct sysc_capabilities *cap;
119 	struct sysc_config *cfg;
120 };
121 
122 struct device;
123 
124 struct ti_sysc_platform_data {
125 	struct of_dev_auxdata *auxdata;
126 	int (*init_module)(struct device *dev,
127 			   const struct ti_sysc_module_data *data,
128 			   struct ti_sysc_cookie *cookie);
129 	int (*enable_module)(struct device *dev,
130 			     const struct ti_sysc_cookie *cookie);
131 	int (*idle_module)(struct device *dev,
132 			   const struct ti_sysc_cookie *cookie);
133 	int (*shutdown_module)(struct device *dev,
134 			       const struct ti_sysc_cookie *cookie);
135 };
136 
137 #endif	/* __TI_SYSC_DATA_H__ */
138