omap_hwmod.h 22 KB

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