Merge tag 'v3.7-rc7' into next/cleanup
[linux-3.10.git] / arch / arm / mach-omap2 / omap_hwmod.h
1 /*
2  * omap_hwmod macros, structures
3  *
4  * Copyright (C) 2009-2011 Nokia Corporation
5  * Copyright (C) 2012 Texas Instruments, Inc.
6  * Paul Walmsley
7  *
8  * Created in collaboration with (alphabetical order): BenoĆ®t Cousson,
9  * Kevin Hilman, Tony Lindgren, Rajendra Nayak, Vikram Pandita, Sakari
10  * Poussa, Anand Sawant, Santosh Shilimkar, Richard Woodruff
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License version 2 as
14  * published by the Free Software Foundation.
15  *
16  * These headers and macros are used to define OMAP on-chip module
17  * data and their integration with other OMAP modules and Linux.
18  * Copious documentation and references can also be found in the
19  * omap_hwmod code, in arch/arm/mach-omap2/omap_hwmod.c (as of this
20  * writing).
21  *
22  * To do:
23  * - add interconnect error log structures
24  * - add pinmuxing
25  * - init_conn_id_bit (CONNID_BIT_VECTOR)
26  * - implement default hwmod SMS/SDRC flags?
27  * - move Linux-specific data ("non-ROM data") out
28  *
29  */
30 #ifndef __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_HWMOD_H
31 #define __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_HWMOD_H
32
33 #include <linux/kernel.h>
34 #include <linux/init.h>
35 #include <linux/list.h>
36 #include <linux/ioport.h>
37 #include <linux/spinlock.h>
38
39 struct omap_device;
40
41 extern struct omap_hwmod_sysc_fields omap_hwmod_sysc_type1;
42 extern struct omap_hwmod_sysc_fields omap_hwmod_sysc_type2;
43 extern struct omap_hwmod_sysc_fields omap_hwmod_sysc_type3;
44
45 /*
46  * OCP SYSCONFIG bit shifts/masks TYPE1. These are for IPs compliant
47  * with the original PRCM protocol defined for OMAP2420
48  */
49 #define SYSC_TYPE1_MIDLEMODE_SHIFT      12
50 #define SYSC_TYPE1_MIDLEMODE_MASK       (0x3 << SYSC_TYPE1_MIDLEMODE_SHIFT)
51 #define SYSC_TYPE1_CLOCKACTIVITY_SHIFT  8
52 #define SYSC_TYPE1_CLOCKACTIVITY_MASK   (0x3 << SYSC_TYPE1_CLOCKACTIVITY_SHIFT)
53 #define SYSC_TYPE1_SIDLEMODE_SHIFT      3
54 #define SYSC_TYPE1_SIDLEMODE_MASK       (0x3 << SYSC_TYPE1_SIDLEMODE_SHIFT)
55 #define SYSC_TYPE1_ENAWAKEUP_SHIFT      2
56 #define SYSC_TYPE1_ENAWAKEUP_MASK       (1 << SYSC_TYPE1_ENAWAKEUP_SHIFT)
57 #define SYSC_TYPE1_SOFTRESET_SHIFT      1
58 #define SYSC_TYPE1_SOFTRESET_MASK       (1 << SYSC_TYPE1_SOFTRESET_SHIFT)
59 #define SYSC_TYPE1_AUTOIDLE_SHIFT       0
60 #define SYSC_TYPE1_AUTOIDLE_MASK        (1 << SYSC_TYPE1_AUTOIDLE_SHIFT)
61
62 /*
63  * OCP SYSCONFIG bit shifts/masks TYPE2. These are for IPs compliant
64  * with the new PRCM protocol defined for new OMAP4 IPs.
65  */
66 #define SYSC_TYPE2_SOFTRESET_SHIFT      0
67 #define SYSC_TYPE2_SOFTRESET_MASK       (1 << SYSC_TYPE2_SOFTRESET_SHIFT)
68 #define SYSC_TYPE2_SIDLEMODE_SHIFT      2
69 #define SYSC_TYPE2_SIDLEMODE_MASK       (0x3 << SYSC_TYPE2_SIDLEMODE_SHIFT)
70 #define SYSC_TYPE2_MIDLEMODE_SHIFT      4
71 #define SYSC_TYPE2_MIDLEMODE_MASK       (0x3 << SYSC_TYPE2_MIDLEMODE_SHIFT)
72 #define SYSC_TYPE2_DMADISABLE_SHIFT     16
73 #define SYSC_TYPE2_DMADISABLE_MASK      (0x1 << SYSC_TYPE2_DMADISABLE_SHIFT)
74
75 /*
76  * OCP SYSCONFIG bit shifts/masks TYPE3.
77  * This is applicable for some IPs present in AM33XX
78  */
79 #define SYSC_TYPE3_SIDLEMODE_SHIFT      0
80 #define SYSC_TYPE3_SIDLEMODE_MASK       (0x3 << SYSC_TYPE3_SIDLEMODE_SHIFT)
81 #define SYSC_TYPE3_MIDLEMODE_SHIFT      2
82 #define SYSC_TYPE3_MIDLEMODE_MASK       (0x3 << SYSC_TYPE3_MIDLEMODE_SHIFT)
83
84 /* OCP SYSSTATUS bit shifts/masks */
85 #define SYSS_RESETDONE_SHIFT            0
86 #define SYSS_RESETDONE_MASK             (1 << SYSS_RESETDONE_SHIFT)
87
88 /* Master standby/slave idle mode flags */
89 #define HWMOD_IDLEMODE_FORCE            (1 << 0)
90 #define HWMOD_IDLEMODE_NO               (1 << 1)
91 #define HWMOD_IDLEMODE_SMART            (1 << 2)
92 #define HWMOD_IDLEMODE_SMART_WKUP       (1 << 3)
93
94 /* modulemode control type (SW or HW) */
95 #define MODULEMODE_HWCTRL               1
96 #define MODULEMODE_SWCTRL               2
97
98
99 /**
100  * struct omap_hwmod_mux_info - hwmod specific mux configuration
101  * @pads:              array of omap_device_pad entries
102  * @nr_pads:           number of omap_device_pad entries
103  *
104  * Note that this is currently built during init as needed.
105  */
106 struct omap_hwmod_mux_info {
107         int                             nr_pads;
108         struct omap_device_pad          *pads;
109         int                             nr_pads_dynamic;
110         struct omap_device_pad          **pads_dynamic;
111         int                             *irqs;
112         bool                            enabled;
113 };
114
115 /**
116  * struct omap_hwmod_irq_info - MPU IRQs used by the hwmod
117  * @name: name of the IRQ channel (module local name)
118  * @irq: IRQ channel ID (should be non-negative except -1 = terminator)
119  *
120  * @name should be something short, e.g., "tx" or "rx".  It is for use
121  * by platform_get_resource_byname().  It is defined locally to the
122  * hwmod.
123  */
124 struct omap_hwmod_irq_info {
125         const char      *name;
126         s16             irq;
127 };
128
129 /**
130  * struct omap_hwmod_dma_info - DMA channels used by the hwmod
131  * @name: name of the DMA channel (module local name)
132  * @dma_req: DMA request ID (should be non-negative except -1 = terminator)
133  *
134  * @name should be something short, e.g., "tx" or "rx".  It is for use
135  * by platform_get_resource_byname().  It is defined locally to the
136  * hwmod.
137  */
138 struct omap_hwmod_dma_info {
139         const char      *name;
140         s16             dma_req;
141 };
142
143 /**
144  * struct omap_hwmod_rst_info - IPs reset lines use by hwmod
145  * @name: name of the reset line (module local name)
146  * @rst_shift: Offset of the reset bit
147  * @st_shift: Offset of the reset status bit (OMAP2/3 only)
148  *
149  * @name should be something short, e.g., "cpu0" or "rst". It is defined
150  * locally to the hwmod.
151  */
152 struct omap_hwmod_rst_info {
153         const char      *name;
154         u8              rst_shift;
155         u8              st_shift;
156 };
157
158 /**
159  * struct omap_hwmod_opt_clk - optional clocks used by this hwmod
160  * @role: "sys", "32k", "tv", etc -- for use in clk_get()
161  * @clk: opt clock: OMAP clock name
162  * @_clk: pointer to the struct clk (filled in at runtime)
163  *
164  * The module's interface clock and main functional clock should not
165  * be added as optional clocks.
166  */
167 struct omap_hwmod_opt_clk {
168         const char      *role;
169         const char      *clk;
170         struct clk      *_clk;
171 };
172
173
174 /* omap_hwmod_omap2_firewall.flags bits */
175 #define OMAP_FIREWALL_L3                (1 << 0)
176 #define OMAP_FIREWALL_L4                (1 << 1)
177
178 /**
179  * struct omap_hwmod_omap2_firewall - OMAP2/3 device firewall data
180  * @l3_perm_bit: bit shift for L3_PM_*_PERMISSION_*
181  * @l4_fw_region: L4 firewall region ID
182  * @l4_prot_group: L4 protection group ID
183  * @flags: (see omap_hwmod_omap2_firewall.flags macros above)
184  */
185 struct omap_hwmod_omap2_firewall {
186         u8 l3_perm_bit;
187         u8 l4_fw_region;
188         u8 l4_prot_group;
189         u8 flags;
190 };
191
192
193 /*
194  * omap_hwmod_addr_space.flags bits
195  *
196  * ADDR_MAP_ON_INIT: Map this address space during omap_hwmod init.
197  * ADDR_TYPE_RT: Address space contains module register target data.
198  */
199 #define ADDR_MAP_ON_INIT        (1 << 0)        /* XXX does not belong */
200 #define ADDR_TYPE_RT            (1 << 1)
201
202 /**
203  * struct omap_hwmod_addr_space - address space handled by the hwmod
204  * @name: name of the address space
205  * @pa_start: starting physical address
206  * @pa_end: ending physical address
207  * @flags: (see omap_hwmod_addr_space.flags macros above)
208  *
209  * Address space doesn't necessarily follow physical interconnect
210  * structure.  GPMC is one example.
211  */
212 struct omap_hwmod_addr_space {
213         const char *name;
214         u32 pa_start;
215         u32 pa_end;
216         u8 flags;
217 };
218
219
220 /*
221  * omap_hwmod_ocp_if.user bits: these indicate the initiators that use this
222  * interface to interact with the hwmod.  Used to add sleep dependencies
223  * when the module is enabled or disabled.
224  */
225 #define OCP_USER_MPU                    (1 << 0)
226 #define OCP_USER_SDMA                   (1 << 1)
227 #define OCP_USER_DSP                    (1 << 2)
228 #define OCP_USER_IVA                    (1 << 3)
229
230 /* omap_hwmod_ocp_if.flags bits */
231 #define OCPIF_SWSUP_IDLE                (1 << 0)
232 #define OCPIF_CAN_BURST                 (1 << 1)
233
234 /* omap_hwmod_ocp_if._int_flags possibilities */
235 #define _OCPIF_INT_FLAGS_REGISTERED     (1 << 0)
236
237
238 /**
239  * struct omap_hwmod_ocp_if - OCP interface data
240  * @master: struct omap_hwmod that initiates OCP transactions on this link
241  * @slave: struct omap_hwmod that responds to OCP transactions on this link
242  * @addr: address space associated with this link
243  * @clk: interface clock: OMAP clock name
244  * @_clk: pointer to the interface struct clk (filled in at runtime)
245  * @fw: interface firewall data
246  * @width: OCP data width
247  * @user: initiators using this interface (see OCP_USER_* macros above)
248  * @flags: OCP interface flags (see OCPIF_* macros above)
249  * @_int_flags: internal flags (see _OCPIF_INT_FLAGS* macros above)
250  *
251  * It may also be useful to add a tag_cnt field for OCP2.x devices.
252  *
253  * Parameter names beginning with an underscore are managed internally by
254  * the omap_hwmod code and should not be set during initialization.
255  */
256 struct omap_hwmod_ocp_if {
257         struct omap_hwmod               *master;
258         struct omap_hwmod               *slave;
259         struct omap_hwmod_addr_space    *addr;
260         const char                      *clk;
261         struct clk                      *_clk;
262         union {
263                 struct omap_hwmod_omap2_firewall omap2;
264         }                               fw;
265         u8                              width;
266         u8                              user;
267         u8                              flags;
268         u8                              _int_flags;
269 };
270
271
272 /* Macros for use in struct omap_hwmod_sysconfig */
273
274 /* Flags for use in omap_hwmod_sysconfig.idlemodes */
275 #define MASTER_STANDBY_SHIFT    4
276 #define SLAVE_IDLE_SHIFT        0
277 #define SIDLE_FORCE             (HWMOD_IDLEMODE_FORCE << SLAVE_IDLE_SHIFT)
278 #define SIDLE_NO                (HWMOD_IDLEMODE_NO << SLAVE_IDLE_SHIFT)
279 #define SIDLE_SMART             (HWMOD_IDLEMODE_SMART << SLAVE_IDLE_SHIFT)
280 #define SIDLE_SMART_WKUP        (HWMOD_IDLEMODE_SMART_WKUP << SLAVE_IDLE_SHIFT)
281 #define MSTANDBY_FORCE          (HWMOD_IDLEMODE_FORCE << MASTER_STANDBY_SHIFT)
282 #define MSTANDBY_NO             (HWMOD_IDLEMODE_NO << MASTER_STANDBY_SHIFT)
283 #define MSTANDBY_SMART          (HWMOD_IDLEMODE_SMART << MASTER_STANDBY_SHIFT)
284 #define MSTANDBY_SMART_WKUP     (HWMOD_IDLEMODE_SMART_WKUP << MASTER_STANDBY_SHIFT)
285
286 /* omap_hwmod_sysconfig.sysc_flags capability flags */
287 #define SYSC_HAS_AUTOIDLE       (1 << 0)
288 #define SYSC_HAS_SOFTRESET      (1 << 1)
289 #define SYSC_HAS_ENAWAKEUP      (1 << 2)
290 #define SYSC_HAS_EMUFREE        (1 << 3)
291 #define SYSC_HAS_CLOCKACTIVITY  (1 << 4)
292 #define SYSC_HAS_SIDLEMODE      (1 << 5)
293 #define SYSC_HAS_MIDLEMODE      (1 << 6)
294 #define SYSS_HAS_RESET_STATUS   (1 << 7)
295 #define SYSC_NO_CACHE           (1 << 8)  /* XXX SW flag, belongs elsewhere */
296 #define SYSC_HAS_RESET_STATUS   (1 << 9)
297 #define SYSC_HAS_DMADISABLE     (1 << 10)
298
299 /* omap_hwmod_sysconfig.clockact flags */
300 #define CLOCKACT_TEST_BOTH      0x0
301 #define CLOCKACT_TEST_MAIN      0x1
302 #define CLOCKACT_TEST_ICLK      0x2
303 #define CLOCKACT_TEST_NONE      0x3
304
305 /**
306  * struct omap_hwmod_sysc_fields - hwmod OCP_SYSCONFIG register field offsets.
307  * @midle_shift: Offset of the midle bit
308  * @clkact_shift: Offset of the clockactivity bit
309  * @sidle_shift: Offset of the sidle bit
310  * @enwkup_shift: Offset of the enawakeup bit
311  * @srst_shift: Offset of the softreset bit
312  * @autoidle_shift: Offset of the autoidle bit
313  * @dmadisable_shift: Offset of the dmadisable bit
314  */
315 struct omap_hwmod_sysc_fields {
316         u8 midle_shift;
317         u8 clkact_shift;
318         u8 sidle_shift;
319         u8 enwkup_shift;
320         u8 srst_shift;
321         u8 autoidle_shift;
322         u8 dmadisable_shift;
323 };
324
325 /**
326  * struct omap_hwmod_class_sysconfig - hwmod class OCP_SYS* data
327  * @rev_offs: IP block revision register offset (from module base addr)
328  * @sysc_offs: OCP_SYSCONFIG register offset (from module base addr)
329  * @syss_offs: OCP_SYSSTATUS register offset (from module base addr)
330  * @srst_udelay: Delay needed after doing a softreset in usecs
331  * @idlemodes: One or more of {SIDLE,MSTANDBY}_{OFF,FORCE,SMART}
332  * @sysc_flags: SYS{C,S}_HAS* flags indicating SYSCONFIG bits supported
333  * @clockact: the default value of the module CLOCKACTIVITY bits
334  *
335  * @clockact describes to the module which clocks are likely to be
336  * disabled when the PRCM issues its idle request to the module.  Some
337  * modules have separate clockdomains for the interface clock and main
338  * functional clock, and can check whether they should acknowledge the
339  * idle request based on the internal module functionality that has
340  * been associated with the clocks marked in @clockact.  This field is
341  * only used if HWMOD_SET_DEFAULT_CLOCKACT is set (see below)
342  *
343  * @sysc_fields: structure containing the offset positions of various bits in
344  * SYSCONFIG register. This can be populated using omap_hwmod_sysc_type1 or
345  * omap_hwmod_sysc_type2 defined in omap_hwmod_common_data.c depending on
346  * whether the device ip is compliant with the original PRCM protocol
347  * defined for OMAP2420 or the new PRCM protocol for new OMAP4 IPs.
348  * If the device follows a different scheme for the sysconfig register ,
349  * then this field has to be populated with the correct offset structure.
350  */
351 struct omap_hwmod_class_sysconfig {
352         u32 rev_offs;
353         u32 sysc_offs;
354         u32 syss_offs;
355         u16 sysc_flags;
356         struct omap_hwmod_sysc_fields *sysc_fields;
357         u8 srst_udelay;
358         u8 idlemodes;
359         u8 clockact;
360 };
361
362 /**
363  * struct omap_hwmod_omap2_prcm - OMAP2/3-specific PRCM data
364  * @module_offs: PRCM submodule offset from the start of the PRM/CM
365  * @prcm_reg_id: PRCM register ID (e.g., 3 for CM_AUTOIDLE3)
366  * @module_bit: register bit shift for AUTOIDLE, WKST, WKEN, GRPSEL regs
367  * @idlest_reg_id: IDLEST register ID (e.g., 3 for CM_IDLEST3)
368  * @idlest_idle_bit: register bit shift for CM_IDLEST slave idle bit
369  * @idlest_stdby_bit: register bit shift for CM_IDLEST master standby bit
370  *
371  * @prcm_reg_id and @module_bit are specific to the AUTOIDLE, WKST,
372  * WKEN, GRPSEL registers.  In an ideal world, no extra information
373  * would be needed for IDLEST information, but alas, there are some
374  * exceptions, so @idlest_reg_id, @idlest_idle_bit, @idlest_stdby_bit
375  * are needed for the IDLEST registers (c.f. 2430 I2CHS, 3430 USBHOST)
376  */
377 struct omap_hwmod_omap2_prcm {
378         s16 module_offs;
379         u8 prcm_reg_id;
380         u8 module_bit;
381         u8 idlest_reg_id;
382         u8 idlest_idle_bit;
383         u8 idlest_stdby_bit;
384 };
385
386 /*
387  * Possible values for struct omap_hwmod_omap4_prcm.flags
388  *
389  * HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT: Some IP blocks don't have a PRCM
390  *     module-level context loss register associated with them; this
391  *     flag bit should be set in those cases
392  */
393 #define HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT         (1 << 0)
394
395 /**
396  * struct omap_hwmod_omap4_prcm - OMAP4-specific PRCM data
397  * @clkctrl_reg: PRCM address of the clock control register
398  * @rstctrl_reg: address of the XXX_RSTCTRL register located in the PRM
399  * @lostcontext_mask: bitmask for selecting bits from RM_*_CONTEXT register
400  * @rstst_reg: (AM33XX only) address of the XXX_RSTST register in the PRM
401  * @submodule_wkdep_bit: bit shift of the WKDEP range
402  * @flags: PRCM register capabilities for this IP block
403  *
404  * If @lostcontext_mask is not defined, context loss check code uses
405  * whole register without masking. @lostcontext_mask should only be
406  * defined in cases where @context_offs register is shared by two or
407  * more hwmods.
408  */
409 struct omap_hwmod_omap4_prcm {
410         u16             clkctrl_offs;
411         u16             rstctrl_offs;
412         u16             rstst_offs;
413         u16             context_offs;
414         u32             lostcontext_mask;
415         u8              submodule_wkdep_bit;
416         u8              modulemode;
417         u8              flags;
418 };
419
420
421 /*
422  * omap_hwmod.flags definitions
423  *
424  * HWMOD_SWSUP_SIDLE: omap_hwmod code should manually bring module in and out
425  *     of idle, rather than relying on module smart-idle
426  * HWMOD_SWSUP_MSTDBY: omap_hwmod code should manually bring module in and out
427  *     of standby, rather than relying on module smart-standby
428  * HWMOD_INIT_NO_RESET: don't reset this module at boot - important for
429  *     SDRAM controller, etc. XXX probably belongs outside the main hwmod file
430  *     XXX Should be HWMOD_SETUP_NO_RESET
431  * HWMOD_INIT_NO_IDLE: don't idle this module at boot - important for SDRAM
432  *     controller, etc. XXX probably belongs outside the main hwmod file
433  *     XXX Should be HWMOD_SETUP_NO_IDLE
434  * HWMOD_NO_OCP_AUTOIDLE: disable module autoidle (OCP_SYSCONFIG.AUTOIDLE)
435  *     when module is enabled, rather than the default, which is to
436  *     enable autoidle
437  * HWMOD_SET_DEFAULT_CLOCKACT: program CLOCKACTIVITY bits at startup
438  * HWMOD_NO_IDLEST: this module does not have idle status - this is the case
439  *     only for few initiator modules on OMAP2 & 3.
440  * HWMOD_CONTROL_OPT_CLKS_IN_RESET: Enable all optional clocks during reset.
441  *     This is needed for devices like DSS that require optional clocks enabled
442  *     in order to complete the reset. Optional clocks will be disabled
443  *     again after the reset.
444  * HWMOD_16BIT_REG: Module has 16bit registers
445  * HWMOD_EXT_OPT_MAIN_CLK: The only main functional clock source for
446  *     this IP block comes from an off-chip source and is not always
447  *     enabled.  This prevents the hwmod code from being able to
448  *     enable and reset the IP block early.  XXX Eventually it should
449  *     be possible to query the clock framework for this information.
450  */
451 #define HWMOD_SWSUP_SIDLE                       (1 << 0)
452 #define HWMOD_SWSUP_MSTANDBY                    (1 << 1)
453 #define HWMOD_INIT_NO_RESET                     (1 << 2)
454 #define HWMOD_INIT_NO_IDLE                      (1 << 3)
455 #define HWMOD_NO_OCP_AUTOIDLE                   (1 << 4)
456 #define HWMOD_SET_DEFAULT_CLOCKACT              (1 << 5)
457 #define HWMOD_NO_IDLEST                         (1 << 6)
458 #define HWMOD_CONTROL_OPT_CLKS_IN_RESET         (1 << 7)
459 #define HWMOD_16BIT_REG                         (1 << 8)
460 #define HWMOD_EXT_OPT_MAIN_CLK                  (1 << 9)
461
462 /*
463  * omap_hwmod._int_flags definitions
464  * These are for internal use only and are managed by the omap_hwmod code.
465  *
466  * _HWMOD_NO_MPU_PORT: no path exists for the MPU to write to this module
467  * _HWMOD_WAKEUP_ENABLED: set when the omap_hwmod code has enabled ENAWAKEUP
468  * _HWMOD_SYSCONFIG_LOADED: set when the OCP_SYSCONFIG value has been cached
469  * _HWMOD_SKIP_ENABLE: set if hwmod enabled during init (HWMOD_INIT_NO_IDLE) -
470  *     causes the first call to _enable() to only update the pinmux
471  */
472 #define _HWMOD_NO_MPU_PORT                      (1 << 0)
473 #define _HWMOD_WAKEUP_ENABLED                   (1 << 1)
474 #define _HWMOD_SYSCONFIG_LOADED                 (1 << 2)
475 #define _HWMOD_SKIP_ENABLE                      (1 << 3)
476
477 /*
478  * omap_hwmod._state definitions
479  *
480  * INITIALIZED: reset (optionally), initialized, enabled, disabled
481  *              (optionally)
482  *
483  *
484  */
485 #define _HWMOD_STATE_UNKNOWN                    0
486 #define _HWMOD_STATE_REGISTERED                 1
487 #define _HWMOD_STATE_CLKS_INITED                2
488 #define _HWMOD_STATE_INITIALIZED                3
489 #define _HWMOD_STATE_ENABLED                    4
490 #define _HWMOD_STATE_IDLE                       5
491 #define _HWMOD_STATE_DISABLED                   6
492
493 /**
494  * struct omap_hwmod_class - the type of an IP block
495  * @name: name of the hwmod_class
496  * @sysc: device SYSCONFIG/SYSSTATUS register data
497  * @rev: revision of the IP class
498  * @pre_shutdown: ptr to fn to be executed immediately prior to device shutdown
499  * @reset: ptr to fn to be executed in place of the standard hwmod reset fn
500  *
501  * Represent the class of a OMAP hardware "modules" (e.g. timer,
502  * smartreflex, gpio, uart...)
503  *
504  * @pre_shutdown is a function that will be run immediately before
505  * hwmod clocks are disabled, etc.  It is intended for use for hwmods
506  * like the MPU watchdog, which cannot be disabled with the standard
507  * omap_hwmod_shutdown().  The function should return 0 upon success,
508  * or some negative error upon failure.  Returning an error will cause
509  * omap_hwmod_shutdown() to abort the device shutdown and return an
510  * error.
511  *
512  * If @reset is defined, then the function it points to will be
513  * executed in place of the standard hwmod _reset() code in
514  * mach-omap2/omap_hwmod.c.  This is needed for IP blocks which have
515  * unusual reset sequences - usually processor IP blocks like the IVA.
516  */
517 struct omap_hwmod_class {
518         const char                              *name;
519         struct omap_hwmod_class_sysconfig       *sysc;
520         u32                                     rev;
521         int                                     (*pre_shutdown)(struct omap_hwmod *oh);
522         int                                     (*reset)(struct omap_hwmod *oh);
523 };
524
525 /**
526  * struct omap_hwmod_link - internal structure linking hwmods with ocp_ifs
527  * @ocp_if: OCP interface structure record pointer
528  * @node: list_head pointing to next struct omap_hwmod_link in a list
529  */
530 struct omap_hwmod_link {
531         struct omap_hwmod_ocp_if        *ocp_if;
532         struct list_head                node;
533 };
534
535 /**
536  * struct omap_hwmod - integration data for OMAP hardware "modules" (IP blocks)
537  * @name: name of the hwmod
538  * @class: struct omap_hwmod_class * to the class of this hwmod
539  * @od: struct omap_device currently associated with this hwmod (internal use)
540  * @mpu_irqs: ptr to an array of MPU IRQs
541  * @sdma_reqs: ptr to an array of System DMA request IDs
542  * @prcm: PRCM data pertaining to this hwmod
543  * @main_clk: main clock: OMAP clock name
544  * @_clk: pointer to the main struct clk (filled in at runtime)
545  * @opt_clks: other device clocks that drivers can request (0..*)
546  * @voltdm: pointer to voltage domain (filled in at runtime)
547  * @dev_attr: arbitrary device attributes that can be passed to the driver
548  * @_sysc_cache: internal-use hwmod flags
549  * @_mpu_rt_va: cached register target start address (internal use)
550  * @_mpu_port: cached MPU register target slave (internal use)
551  * @opt_clks_cnt: number of @opt_clks
552  * @master_cnt: number of @master entries
553  * @slaves_cnt: number of @slave entries
554  * @response_lat: device OCP response latency (in interface clock cycles)
555  * @_int_flags: internal-use hwmod flags
556  * @_state: internal-use hwmod state
557  * @_postsetup_state: internal-use state to leave the hwmod in after _setup()
558  * @flags: hwmod flags (documented below)
559  * @_lock: spinlock serializing operations on this hwmod
560  * @node: list node for hwmod list (internal use)
561  *
562  * @main_clk refers to this module's "main clock," which for our
563  * purposes is defined as "the functional clock needed for register
564  * accesses to complete."  Modules may not have a main clock if the
565  * interface clock also serves as a main clock.
566  *
567  * Parameter names beginning with an underscore are managed internally by
568  * the omap_hwmod code and should not be set during initialization.
569  *
570  * @masters and @slaves are now deprecated.
571  */
572 struct omap_hwmod {
573         const char                      *name;
574         struct omap_hwmod_class         *class;
575         struct omap_device              *od;
576         struct omap_hwmod_mux_info      *mux;
577         struct omap_hwmod_irq_info      *mpu_irqs;
578         struct omap_hwmod_dma_info      *sdma_reqs;
579         struct omap_hwmod_rst_info      *rst_lines;
580         union {
581                 struct omap_hwmod_omap2_prcm omap2;
582                 struct omap_hwmod_omap4_prcm omap4;
583         }                               prcm;
584         const char                      *main_clk;
585         struct clk                      *_clk;
586         struct omap_hwmod_opt_clk       *opt_clks;
587         char                            *clkdm_name;
588         struct clockdomain              *clkdm;
589         struct list_head                master_ports; /* connect to *_IA */
590         struct list_head                slave_ports; /* connect to *_TA */
591         void                            *dev_attr;
592         u32                             _sysc_cache;
593         void __iomem                    *_mpu_rt_va;
594         spinlock_t                      _lock;
595         struct list_head                node;
596         struct omap_hwmod_ocp_if        *_mpu_port;
597         u16                             flags;
598         u8                              response_lat;
599         u8                              rst_lines_cnt;
600         u8                              opt_clks_cnt;
601         u8                              masters_cnt;
602         u8                              slaves_cnt;
603         u8                              hwmods_cnt;
604         u8                              _int_flags;
605         u8                              _state;
606         u8                              _postsetup_state;
607 };
608
609 struct omap_hwmod *omap_hwmod_lookup(const char *name);
610 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
611                         void *data);
612
613 int __init omap_hwmod_setup_one(const char *name);
614
615 int omap_hwmod_enable(struct omap_hwmod *oh);
616 int omap_hwmod_idle(struct omap_hwmod *oh);
617 int omap_hwmod_shutdown(struct omap_hwmod *oh);
618
619 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name);
620 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name);
621 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name);
622
623 int omap_hwmod_enable_clocks(struct omap_hwmod *oh);
624 int omap_hwmod_disable_clocks(struct omap_hwmod *oh);
625
626 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode);
627 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle);
628
629 int omap_hwmod_reset(struct omap_hwmod *oh);
630 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh);
631
632 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs);
633 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs);
634 int omap_hwmod_softreset(struct omap_hwmod *oh);
635
636 int omap_hwmod_count_resources(struct omap_hwmod *oh);
637 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res);
638 int omap_hwmod_fill_dma_resources(struct omap_hwmod *oh, struct resource *res);
639 int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
640                                    const char *name, struct resource *res);
641
642 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh);
643 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh);
644
645 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
646                                  struct omap_hwmod *init_oh);
647 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
648                                  struct omap_hwmod *init_oh);
649
650 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh);
651 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh);
652
653 int omap_hwmod_for_each_by_class(const char *classname,
654                                  int (*fn)(struct omap_hwmod *oh,
655                                            void *user),
656                                  void *user);
657
658 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state);
659 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh);
660
661 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh);
662
663 int omap_hwmod_pad_route_irq(struct omap_hwmod *oh, int pad_idx, int irq_idx);
664
665 extern void __init omap_hwmod_init(void);
666
667 const char *omap_hwmod_get_main_clk(struct omap_hwmod *oh);
668
669 /*
670  * Chip variant-specific hwmod init routines - XXX should be converted
671  * to use initcalls once the initial boot ordering is straightened out
672  */
673 extern int omap2420_hwmod_init(void);
674 extern int omap2430_hwmod_init(void);
675 extern int omap3xxx_hwmod_init(void);
676 extern int omap44xx_hwmod_init(void);
677 extern int am33xx_hwmod_init(void);
678
679 extern int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois);
680
681 #endif