arch/arm/mach-omap2/omap_hwmod.h

   1 /*
   2  * omap_hwmod macros, structures
   3  *
   4  * Copyright (C) 2009-2011 Nokia Corporation
   5  * Copyright (C) 2011-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 #define DEBUG_OMAP2UART1_FLAGS  0
  99 #define DEBUG_OMAP2UART2_FLAGS  0
 100 #define DEBUG_OMAP2UART3_FLAGS  0
 101 #define DEBUG_OMAP3UART3_FLAGS  0
 102 #define DEBUG_OMAP3UART4_FLAGS  0
 103 #define DEBUG_OMAP4UART3_FLAGS  0
 104 #define DEBUG_OMAP4UART4_FLAGS  0
 105 #define DEBUG_TI81XXUART1_FLAGS 0
 106 #define DEBUG_TI81XXUART2_FLAGS 0
 107 #define DEBUG_TI81XXUART3_FLAGS 0
 108 #define DEBUG_AM33XXUART1_FLAGS 0
 109
 110 #define DEBUG_OMAPUART_FLAGS    (HWMOD_INIT_NO_IDLE | HWMOD_INIT_NO_RESET)
 111
 112 #ifdef CONFIG_OMAP_GPMC_DEBUG
 113 #define DEBUG_OMAP_GPMC_HWMOD_FLAGS     HWMOD_INIT_NO_RESET
 114 #else
 115 #define DEBUG_OMAP_GPMC_HWMOD_FLAGS     0
 116 #endif
 117
 118 #if defined(CONFIG_DEBUG_OMAP2UART1)
 119 #undef DEBUG_OMAP2UART1_FLAGS
 120 #define DEBUG_OMAP2UART1_FLAGS DEBUG_OMAPUART_FLAGS
 121 #elif defined(CONFIG_DEBUG_OMAP2UART2)
 122 #undef DEBUG_OMAP2UART2_FLAGS
 123 #define DEBUG_OMAP2UART2_FLAGS DEBUG_OMAPUART_FLAGS
 124 #elif defined(CONFIG_DEBUG_OMAP2UART3)
 125 #undef DEBUG_OMAP2UART3_FLAGS
 126 #define DEBUG_OMAP2UART3_FLAGS DEBUG_OMAPUART_FLAGS
 127 #elif defined(CONFIG_DEBUG_OMAP3UART3)
 128 #undef DEBUG_OMAP3UART3_FLAGS
 129 #define DEBUG_OMAP3UART3_FLAGS DEBUG_OMAPUART_FLAGS
 130 #elif defined(CONFIG_DEBUG_OMAP3UART4)
 131 #undef DEBUG_OMAP3UART4_FLAGS
 132 #define DEBUG_OMAP3UART4_FLAGS DEBUG_OMAPUART_FLAGS
 133 #elif defined(CONFIG_DEBUG_OMAP4UART3)
 134 #undef DEBUG_OMAP4UART3_FLAGS
 135 #define DEBUG_OMAP4UART3_FLAGS DEBUG_OMAPUART_FLAGS
 136 #elif defined(CONFIG_DEBUG_OMAP4UART4)
 137 #undef DEBUG_OMAP4UART4_FLAGS
 138 #define DEBUG_OMAP4UART4_FLAGS DEBUG_OMAPUART_FLAGS
 139 #elif defined(CONFIG_DEBUG_TI81XXUART1)
 140 #undef DEBUG_TI81XXUART1_FLAGS
 141 #define DEBUG_TI81XXUART1_FLAGS DEBUG_OMAPUART_FLAGS
 142 #elif defined(CONFIG_DEBUG_TI81XXUART2)
 143 #undef DEBUG_TI81XXUART2_FLAGS
 144 #define DEBUG_TI81XXUART2_FLAGS DEBUG_OMAPUART_FLAGS
 145 #elif defined(CONFIG_DEBUG_TI81XXUART3)
 146 #undef DEBUG_TI81XXUART3_FLAGS
 147 #define DEBUG_TI81XXUART3_FLAGS DEBUG_OMAPUART_FLAGS
 148 #elif defined(CONFIG_DEBUG_AM33XXUART1)
 149 #undef DEBUG_AM33XXUART1_FLAGS
 150 #define DEBUG_AM33XXUART1_FLAGS DEBUG_OMAPUART_FLAGS
 151 #endif
 152
 153 /**
 154  * struct omap_hwmod_mux_info - hwmod specific mux configuration
 155  * @pads:              array of omap_device_pad entries
 156  * @nr_pads:           number of omap_device_pad entries
 157  *
 158  * Note that this is currently built during init as needed.
 159  */
 160 struct omap_hwmod_mux_info {
 161         int                             nr_pads;
 162         struct omap_device_pad          *pads;
 163         int                             nr_pads_dynamic;
 164         struct omap_device_pad          **pads_dynamic;
 165         int                             *irqs;
 166         bool                            enabled;
 167 };
 168
 169 /**
 170  * struct omap_hwmod_irq_info - MPU IRQs used by the hwmod
 171  * @name: name of the IRQ channel (module local name)
 172  * @irq: IRQ channel ID (should be non-negative except -1 = terminator)
 173  *
 174  * @name should be something short, e.g., "tx" or "rx".  It is for use
 175  * by platform_get_resource_byname().  It is defined locally to the
 176  * hwmod.
 177  */
 178 struct omap_hwmod_irq_info {
 179         const char      *name;
 180         s16             irq;
 181 };
 182
 183 /**
 184  * struct omap_hwmod_dma_info - DMA channels used by the hwmod
 185  * @name: name of the DMA channel (module local name)
 186  * @dma_req: DMA request ID (should be non-negative except -1 = terminator)
 187  *
 188  * @name should be something short, e.g., "tx" or "rx".  It is for use
 189  * by platform_get_resource_byname().  It is defined locally to the
 190  * hwmod.
 191  */
 192 struct omap_hwmod_dma_info {
 193         const char      *name;
 194         s16             dma_req;
 195 };
 196
 197 /**
 198  * struct omap_hwmod_rst_info - IPs reset lines use by hwmod
 199  * @name: name of the reset line (module local name)
 200  * @rst_shift: Offset of the reset bit
 201  * @st_shift: Offset of the reset status bit (OMAP2/3 only)
 202  *
 203  * @name should be something short, e.g., "cpu0" or "rst". It is defined
 204  * locally to the hwmod.
 205  */
 206 struct omap_hwmod_rst_info {
 207         const char      *name;
 208         u8              rst_shift;
 209         u8              st_shift;
 210 };
 211
 212 /**
 213  * struct omap_hwmod_opt_clk - optional clocks used by this hwmod
 214  * @role: "sys", "32k", "tv", etc -- for use in clk_get()
 215  * @clk: opt clock: OMAP clock name
 216  * @_clk: pointer to the struct clk (filled in at runtime)
 217  *
 218  * The module's interface clock and main functional clock should not
 219  * be added as optional clocks.
 220  */
 221 struct omap_hwmod_opt_clk {
 222         const char      *role;
 223         const char      *clk;
 224         struct clk      *_clk;
 225 };
 226
 227
 228 /* omap_hwmod_omap2_firewall.flags bits */
 229 #define OMAP_FIREWALL_L3                (1 << 0)
 230 #define OMAP_FIREWALL_L4                (1 << 1)
 231
 232 /**
 233  * struct omap_hwmod_omap2_firewall - OMAP2/3 device firewall data
 234  * @l3_perm_bit: bit shift for L3_PM_*_PERMISSION_*
 235  * @l4_fw_region: L4 firewall region ID
 236  * @l4_prot_group: L4 protection group ID
 237  * @flags: (see omap_hwmod_omap2_firewall.flags macros above)
 238  */
 239 struct omap_hwmod_omap2_firewall {
 240         u8 l3_perm_bit;
 241         u8 l4_fw_region;
 242         u8 l4_prot_group;
 243         u8 flags;
 244 };
 245
 246
 247 /*
 248  * omap_hwmod_addr_space.flags bits
 249  *
 250  * ADDR_MAP_ON_INIT: Map this address space during omap_hwmod init.
 251  * ADDR_TYPE_RT: Address space contains module register target data.
 252  */
 253 #define ADDR_MAP_ON_INIT        (1 << 0)        /* XXX does not belong */
 254 #define ADDR_TYPE_RT            (1 << 1)
 255
 256 /**
 257  * struct omap_hwmod_addr_space - address space handled by the hwmod
 258  * @name: name of the address space
 259  * @pa_start: starting physical address
 260  * @pa_end: ending physical address
 261  * @flags: (see omap_hwmod_addr_space.flags macros above)
 262  *
 263  * Address space doesn't necessarily follow physical interconnect
 264  * structure.  GPMC is one example.
 265  */
 266 struct omap_hwmod_addr_space {
 267         const char *name;
 268         u32 pa_start;
 269         u32 pa_end;
 270         u8 flags;
 271 };
 272
 273
 274 /*
 275  * omap_hwmod_ocp_if.user bits: these indicate the initiators that use this
 276  * interface to interact with the hwmod.  Used to add sleep dependencies
 277  * when the module is enabled or disabled.
 278  */
 279 #define OCP_USER_MPU                    (1 << 0)
 280 #define OCP_USER_SDMA                   (1 << 1)
 281 #define OCP_USER_DSP                    (1 << 2)
 282 #define OCP_USER_IVA                    (1 << 3)
 283
 284 /* omap_hwmod_ocp_if.flags bits */
 285 #define OCPIF_SWSUP_IDLE                (1 << 0)
 286 #define OCPIF_CAN_BURST                 (1 << 1)
 287
 288 /* omap_hwmod_ocp_if._int_flags possibilities */
 289 #define _OCPIF_INT_FLAGS_REGISTERED     (1 << 0)
 290
 291
 292 /**
 293  * struct omap_hwmod_ocp_if - OCP interface data
 294  * @master: struct omap_hwmod that initiates OCP transactions on this link
 295  * @slave: struct omap_hwmod that responds to OCP transactions on this link
 296  * @addr: address space associated with this link
 297  * @clk: interface clock: OMAP clock name
 298  * @_clk: pointer to the interface struct clk (filled in at runtime)
 299  * @fw: interface firewall data
 300  * @width: OCP data width
 301  * @user: initiators using this interface (see OCP_USER_* macros above)
 302  * @flags: OCP interface flags (see OCPIF_* macros above)
 303  * @_int_flags: internal flags (see _OCPIF_INT_FLAGS* macros above)
 304  *
 305  * It may also be useful to add a tag_cnt field for OCP2.x devices.
 306  *
 307  * Parameter names beginning with an underscore are managed internally by
 308  * the omap_hwmod code and should not be set during initialization.
 309  */
 310 struct omap_hwmod_ocp_if {
 311         struct omap_hwmod               *master;
 312         struct omap_hwmod               *slave;
 313         struct omap_hwmod_addr_space    *addr;
 314         const char                      *clk;
 315         struct clk                      *_clk;
 316         struct list_head                node;
 317         union {
 318                 struct omap_hwmod_omap2_firewall omap2;
 319         }                               fw;
 320         u8                              width;
 321         u8                              user;
 322         u8                              flags;
 323         u8                              _int_flags;
 324 };
 325
 326
 327 /* Macros for use in struct omap_hwmod_sysconfig */
 328
 329 /* Flags for use in omap_hwmod_sysconfig.idlemodes */
 330 #define MASTER_STANDBY_SHIFT    4
 331 #define SLAVE_IDLE_SHIFT        0
 332 #define SIDLE_FORCE             (HWMOD_IDLEMODE_FORCE << SLAVE_IDLE_SHIFT)
 333 #define SIDLE_NO                (HWMOD_IDLEMODE_NO << SLAVE_IDLE_SHIFT)
 334 #define SIDLE_SMART             (HWMOD_IDLEMODE_SMART << SLAVE_IDLE_SHIFT)
 335 #define SIDLE_SMART_WKUP        (HWMOD_IDLEMODE_SMART_WKUP << SLAVE_IDLE_SHIFT)
 336 #define MSTANDBY_FORCE          (HWMOD_IDLEMODE_FORCE << MASTER_STANDBY_SHIFT)
 337 #define MSTANDBY_NO             (HWMOD_IDLEMODE_NO << MASTER_STANDBY_SHIFT)
 338 #define MSTANDBY_SMART          (HWMOD_IDLEMODE_SMART << MASTER_STANDBY_SHIFT)
 339 #define MSTANDBY_SMART_WKUP     (HWMOD_IDLEMODE_SMART_WKUP << MASTER_STANDBY_SHIFT)
 340
 341 /* omap_hwmod_sysconfig.sysc_flags capability flags */
 342 #define SYSC_HAS_AUTOIDLE       (1 << 0)
 343 #define SYSC_HAS_SOFTRESET      (1 << 1)
 344 #define SYSC_HAS_ENAWAKEUP      (1 << 2)
 345 #define SYSC_HAS_EMUFREE        (1 << 3)
 346 #define SYSC_HAS_CLOCKACTIVITY  (1 << 4)
 347 #define SYSC_HAS_SIDLEMODE      (1 << 5)
 348 #define SYSC_HAS_MIDLEMODE      (1 << 6)
 349 #define SYSS_HAS_RESET_STATUS   (1 << 7)
 350 #define SYSC_NO_CACHE           (1 << 8)  /* XXX SW flag, belongs elsewhere */
 351 #define SYSC_HAS_RESET_STATUS   (1 << 9)
 352 #define SYSC_HAS_DMADISABLE     (1 << 10)
 353
 354 /* omap_hwmod_sysconfig.clockact flags */
 355 #define CLOCKACT_TEST_BOTH      0x0
 356 #define CLOCKACT_TEST_MAIN      0x1
 357 #define CLOCKACT_TEST_ICLK      0x2
 358 #define CLOCKACT_TEST_NONE      0x3
 359
 360 /**
 361  * struct omap_hwmod_sysc_fields - hwmod OCP_SYSCONFIG register field offsets.
 362  * @midle_shift: Offset of the midle bit
 363  * @clkact_shift: Offset of the clockactivity bit
 364  * @sidle_shift: Offset of the sidle bit
 365  * @enwkup_shift: Offset of the enawakeup bit
 366  * @srst_shift: Offset of the softreset bit
 367  * @autoidle_shift: Offset of the autoidle bit
 368  * @dmadisable_shift: Offset of the dmadisable bit
 369  */
 370 struct omap_hwmod_sysc_fields {
 371         u8 midle_shift;
 372         u8 clkact_shift;
 373         u8 sidle_shift;
 374         u8 enwkup_shift;
 375         u8 srst_shift;
 376         u8 autoidle_shift;
 377         u8 dmadisable_shift;
 378 };
 379
 380 /**
 381  * struct omap_hwmod_class_sysconfig - hwmod class OCP_SYS* data
 382  * @rev_offs: IP block revision register offset (from module base addr)
 383  * @sysc_offs: OCP_SYSCONFIG register offset (from module base addr)
 384  * @syss_offs: OCP_SYSSTATUS register offset (from module base addr)
 385  * @srst_udelay: Delay needed after doing a softreset in usecs
 386  * @idlemodes: One or more of {SIDLE,MSTANDBY}_{OFF,FORCE,SMART}
 387  * @sysc_flags: SYS{C,S}_HAS* flags indicating SYSCONFIG bits supported
 388  * @clockact: the default value of the module CLOCKACTIVITY bits
 389  *
 390  * @clockact describes to the module which clocks are likely to be
 391  * disabled when the PRCM issues its idle request to the module.  Some
 392  * modules have separate clockdomains for the interface clock and main
 393  * functional clock, and can check whether they should acknowledge the
 394  * idle request based on the internal module functionality that has
 395  * been associated with the clocks marked in @clockact.  This field is
 396  * only used if HWMOD_SET_DEFAULT_CLOCKACT is set (see below)
 397  *
 398  * @sysc_fields: structure containing the offset positions of various bits in
 399  * SYSCONFIG register. This can be populated using omap_hwmod_sysc_type1 or
 400  * omap_hwmod_sysc_type2 defined in omap_hwmod_common_data.c depending on
 401  * whether the device ip is compliant with the original PRCM protocol
 402  * defined for OMAP2420 or the new PRCM protocol for new OMAP4 IPs.
 403  * If the device follows a different scheme for the sysconfig register ,
 404  * then this field has to be populated with the correct offset structure.
 405  */
 406 struct omap_hwmod_class_sysconfig {
 407         u32 rev_offs;
 408         u32 sysc_offs;
 409         u32 syss_offs;
 410         u16 sysc_flags;
 411         struct omap_hwmod_sysc_fields *sysc_fields;
 412         u8 srst_udelay;
 413         u8 idlemodes;
 414 };
 415
 416 /**
 417  * struct omap_hwmod_omap2_prcm - OMAP2/3-specific PRCM data
 418  * @module_offs: PRCM submodule offset from the start of the PRM/CM
 419  * @prcm_reg_id: PRCM register ID (e.g., 3 for CM_AUTOIDLE3)
 420  * @module_bit: register bit shift for AUTOIDLE, WKST, WKEN, GRPSEL regs
 421  * @idlest_reg_id: IDLEST register ID (e.g., 3 for CM_IDLEST3)
 422  * @idlest_idle_bit: register bit shift for CM_IDLEST slave idle bit
 423  * @idlest_stdby_bit: register bit shift for CM_IDLEST master standby bit
 424  *
 425  * @prcm_reg_id and @module_bit are specific to the AUTOIDLE, WKST,
 426  * WKEN, GRPSEL registers.  In an ideal world, no extra information
 427  * would be needed for IDLEST information, but alas, there are some
 428  * exceptions, so @idlest_reg_id, @idlest_idle_bit, @idlest_stdby_bit
 429  * are needed for the IDLEST registers (c.f. 2430 I2CHS, 3430 USBHOST)
 430  */
 431 struct omap_hwmod_omap2_prcm {
 432         s16 module_offs;
 433         u8 prcm_reg_id;
 434         u8 module_bit;
 435         u8 idlest_reg_id;
 436         u8 idlest_idle_bit;
 437         u8 idlest_stdby_bit;
 438 };
 439
 440 /*
 441  * Possible values for struct omap_hwmod_omap4_prcm.flags
 442  *
 443  * HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT: Some IP blocks don't have a PRCM
 444  *     module-level context loss register associated with them; this
 445  *     flag bit should be set in those cases
 446  * HWMOD_OMAP4_ZERO_CLKCTRL_OFFSET: Some IP blocks have a valid CLKCTRL
 447  *      offset of zero; this flag bit should be set in those cases to
 448  *      distinguish from hwmods that have no clkctrl offset.
 449  */
 450 #define HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT         (1 << 0)
 451 #define HWMOD_OMAP4_ZERO_CLKCTRL_OFFSET         (1 << 1)
 452
 453 /**
 454  * struct omap_hwmod_omap4_prcm - OMAP4-specific PRCM data
 455  * @clkctrl_offs: offset of the PRCM clock control register
 456  * @rstctrl_offs: offset of the XXX_RSTCTRL register located in the PRM
 457  * @context_offs: offset of the RM_*_CONTEXT register
 458  * @lostcontext_mask: bitmask for selecting bits from RM_*_CONTEXT register
 459  * @rstst_reg: (AM33XX only) address of the XXX_RSTST register in the PRM
 460  * @submodule_wkdep_bit: bit shift of the WKDEP range
 461  * @flags: PRCM register capabilities for this IP block
 462  * @modulemode: allowable modulemodes
 463  * @context_lost_counter: Count of module level context lost
 464  *
 465  * If @lostcontext_mask is not defined, context loss check code uses
 466  * whole register without masking. @lostcontext_mask should only be
 467  * defined in cases where @context_offs register is shared by two or
 468  * more hwmods.
 469  */
 470 struct omap_hwmod_omap4_prcm {
 471         u16             clkctrl_offs;
 472         u16             rstctrl_offs;
 473         u16             rstst_offs;
 474         u16             context_offs;
 475         u32             lostcontext_mask;
 476         u8              submodule_wkdep_bit;
 477         u8              modulemode;
 478         u8              flags;
 479         int             context_lost_counter;
 480 };
 481
 482
 483 /*
 484  * omap_hwmod.flags definitions
 485  *
 486  * HWMOD_SWSUP_SIDLE: omap_hwmod code should manually bring module in and out
 487  *     of idle, rather than relying on module smart-idle
 488  * HWMOD_SWSUP_MSTANDBY: omap_hwmod code should manually bring module in and
 489  *     out of standby, rather than relying on module smart-standby
 490  * HWMOD_INIT_NO_RESET: don't reset this module at boot - important for
 491  *     SDRAM controller, etc. XXX probably belongs outside the main hwmod file
 492  *     XXX Should be HWMOD_SETUP_NO_RESET
 493  * HWMOD_INIT_NO_IDLE: don't idle this module at boot - important for SDRAM
 494  *     controller, etc. XXX probably belongs outside the main hwmod file
 495  *     XXX Should be HWMOD_SETUP_NO_IDLE
 496  * HWMOD_NO_OCP_AUTOIDLE: disable module autoidle (OCP_SYSCONFIG.AUTOIDLE)
 497  *     when module is enabled, rather than the default, which is to
 498  *     enable autoidle
 499  * HWMOD_SET_DEFAULT_CLOCKACT: program CLOCKACTIVITY bits at startup
 500  * HWMOD_NO_IDLEST: this module does not have idle status - this is the case
 501  *     only for few initiator modules on OMAP2 & 3.
 502  * HWMOD_CONTROL_OPT_CLKS_IN_RESET: Enable all optional clocks during reset.
 503  *     This is needed for devices like DSS that require optional clocks enabled
 504  *     in order to complete the reset. Optional clocks will be disabled
 505  *     again after the reset.
 506  * HWMOD_16BIT_REG: Module has 16bit registers
 507  * HWMOD_EXT_OPT_MAIN_CLK: The only main functional clock source for
 508  *     this IP block comes from an off-chip source and is not always
 509  *     enabled.  This prevents the hwmod code from being able to
 510  *     enable and reset the IP block early.  XXX Eventually it should
 511  *     be possible to query the clock framework for this information.
 512  * HWMOD_BLOCK_WFI: Some OMAP peripherals apparently don't work
 513  *     correctly if the MPU is allowed to go idle while the
 514  *     peripherals are active.  This is apparently true for the I2C on
 515  *     OMAP2420, and also the EMAC on AM3517/3505.  It's unlikely that
 516  *     this is really true -- we're probably not configuring something
 517  *     correctly, or this is being abused to deal with some PM latency
 518  *     issues -- but we're currently suffering from a shortage of
 519  *     folks who are able to track these issues down properly.
 520  * HWMOD_FORCE_MSTANDBY: Always keep MIDLEMODE bits cleared so that device
 521  *     is kept in force-standby mode. Failing to do so causes PM problems
 522  *     with musb on OMAP3630 at least. Note that musb has a dedicated register
 523  *     to control MSTANDBY signal when MIDLEMODE is set to force-standby.
 524  * HWMOD_SWSUP_SIDLE_ACT: omap_hwmod code should manually bring the module
 525  *     out of idle, but rely on smart-idle to the put it back in idle,
 526  *     so the wakeups are still functional (Only known case for now is UART)
 527  * HWMOD_RECONFIG_IO_CHAIN: omap_hwmod code needs to reconfigure wake-up
 528  *     events by calling _reconfigure_io_chain() when a device is enabled
 529  *     or idled.
 530  * HWMOD_OPT_CLKS_NEEDED: The optional clocks are needed for the module to
 531  *     operate and they need to be handled at the same time as the main_clk.
 532  * HWMOD_NO_IDLE: Do not idle the hwmod at all. Useful to handle certain
 533  *     IPs like CPSW on DRA7, where clocks to this module cannot be disabled.
 534  * HWMOD_CLKDM_NOAUTO: Allows the hwmod's clockdomain to be prevented from
 535  *     entering HW_AUTO while hwmod is active. This is needed to workaround
 536  *     some modules which don't function correctly with HW_AUTO. For example,
 537  *     DCAN on DRA7x SoC needs this to workaround errata i893.
 538  */
 539 #define HWMOD_SWSUP_SIDLE                       (1 << 0)
 540 #define HWMOD_SWSUP_MSTANDBY                    (1 << 1)
 541 #define HWMOD_INIT_NO_RESET                     (1 << 2)
 542 #define HWMOD_INIT_NO_IDLE                      (1 << 3)
 543 #define HWMOD_NO_OCP_AUTOIDLE                   (1 << 4)
 544 #define HWMOD_SET_DEFAULT_CLOCKACT              (1 << 5)
 545 #define HWMOD_NO_IDLEST                         (1 << 6)
 546 #define HWMOD_CONTROL_OPT_CLKS_IN_RESET         (1 << 7)
 547 #define HWMOD_16BIT_REG                         (1 << 8)
 548 #define HWMOD_EXT_OPT_MAIN_CLK                  (1 << 9)
 549 #define HWMOD_BLOCK_WFI                         (1 << 10)
 550 #define HWMOD_FORCE_MSTANDBY                    (1 << 11)
 551 #define HWMOD_SWSUP_SIDLE_ACT                   (1 << 12)
 552 #define HWMOD_RECONFIG_IO_CHAIN                 (1 << 13)
 553 #define HWMOD_OPT_CLKS_NEEDED                   (1 << 14)
 554 #define HWMOD_NO_IDLE                           (1 << 15)
 555 #define HWMOD_CLKDM_NOAUTO                      (1 << 16)
 556
 557 /*
 558  * omap_hwmod._int_flags definitions
 559  * These are for internal use only and are managed by the omap_hwmod code.
 560  *
 561  * _HWMOD_NO_MPU_PORT: no path exists for the MPU to write to this module
 562  * _HWMOD_SYSCONFIG_LOADED: set when the OCP_SYSCONFIG value has been cached
 563  * _HWMOD_SKIP_ENABLE: set if hwmod enabled during init (HWMOD_INIT_NO_IDLE) -
 564  *     causes the first call to _enable() to only update the pinmux
 565  */
 566 #define _HWMOD_NO_MPU_PORT                      (1 << 0)
 567 #define _HWMOD_SYSCONFIG_LOADED                 (1 << 1)
 568 #define _HWMOD_SKIP_ENABLE                      (1 << 2)
 569
 570 /*
 571  * omap_hwmod._state definitions
 572  *
 573  * INITIALIZED: reset (optionally), initialized, enabled, disabled
 574  *              (optionally)
 575  *
 576  *
 577  */
 578 #define _HWMOD_STATE_UNKNOWN                    0
 579 #define _HWMOD_STATE_REGISTERED                 1
 580 #define _HWMOD_STATE_CLKS_INITED                2
 581 #define _HWMOD_STATE_INITIALIZED                3
 582 #define _HWMOD_STATE_ENABLED                    4
 583 #define _HWMOD_STATE_IDLE                       5
 584 #define _HWMOD_STATE_DISABLED                   6
 585
 586 /**
 587  * struct omap_hwmod_class - the type of an IP block
 588  * @name: name of the hwmod_class
 589  * @sysc: device SYSCONFIG/SYSSTATUS register data
 590  * @rev: revision of the IP class
 591  * @pre_shutdown: ptr to fn to be executed immediately prior to device shutdown
 592  * @reset: ptr to fn to be executed in place of the standard hwmod reset fn
 593  * @enable_preprogram:  ptr to fn to be executed during device enable
 594  * @lock: ptr to fn to be executed to lock IP registers
 595  * @unlock: ptr to fn to be executed to unlock IP registers
 596  *
 597  * Represent the class of a OMAP hardware "modules" (e.g. timer,
 598  * smartreflex, gpio, uart...)
 599  *
 600  * @pre_shutdown is a function that will be run immediately before
 601  * hwmod clocks are disabled, etc.  It is intended for use for hwmods
 602  * like the MPU watchdog, which cannot be disabled with the standard
 603  * omap_hwmod_shutdown().  The function should return 0 upon success,
 604  * or some negative error upon failure.  Returning an error will cause
 605  * omap_hwmod_shutdown() to abort the device shutdown and return an
 606  * error.
 607  *
 608  * If @reset is defined, then the function it points to will be
 609  * executed in place of the standard hwmod _reset() code in
 610  * mach-omap2/omap_hwmod.c.  This is needed for IP blocks which have
 611  * unusual reset sequences - usually processor IP blocks like the IVA.
 612  */
 613 struct omap_hwmod_class {
 614         const char                              *name;
 615         struct omap_hwmod_class_sysconfig       *sysc;
 616         u32                                     rev;
 617         int                                     (*pre_shutdown)(struct omap_hwmod *oh);
 618         int                                     (*reset)(struct omap_hwmod *oh);
 619         int                                     (*enable_preprogram)(struct omap_hwmod *oh);
 620         void                                    (*lock)(struct omap_hwmod *oh);
 621         void                                    (*unlock)(struct omap_hwmod *oh);
 622 };
 623
 624 /**
 625  * struct omap_hwmod - integration data for OMAP hardware "modules" (IP blocks)
 626  * @name: name of the hwmod
 627  * @class: struct omap_hwmod_class * to the class of this hwmod
 628  * @od: struct omap_device currently associated with this hwmod (internal use)
 629  * @mpu_irqs: ptr to an array of MPU IRQs
 630  * @sdma_reqs: ptr to an array of System DMA request IDs
 631  * @prcm: PRCM data pertaining to this hwmod
 632  * @main_clk: main clock: OMAP clock name
 633  * @_clk: pointer to the main struct clk (filled in at runtime)
 634  * @opt_clks: other device clocks that drivers can request (0..*)
 635  * @voltdm: pointer to voltage domain (filled in at runtime)
 636  * @dev_attr: arbitrary device attributes that can be passed to the driver
 637  * @_sysc_cache: internal-use hwmod flags
 638  * @mpu_rt_idx: index of device address space for register target (for DT boot)
 639  * @_mpu_rt_va: cached register target start address (internal use)
 640  * @_mpu_port: cached MPU register target slave (internal use)
 641  * @opt_clks_cnt: number of @opt_clks
 642  * @master_cnt: number of @master entries
 643  * @slaves_cnt: number of @slave entries
 644  * @response_lat: device OCP response latency (in interface clock cycles)
 645  * @_int_flags: internal-use hwmod flags
 646  * @_state: internal-use hwmod state
 647  * @_postsetup_state: internal-use state to leave the hwmod in after _setup()
 648  * @flags: hwmod flags (documented below)
 649  * @_lock: spinlock serializing operations on this hwmod
 650  * @node: list node for hwmod list (internal use)
 651  * @parent_hwmod: (temporary) a pointer to the hierarchical parent of this hwmod
 652  *
 653  * @main_clk refers to this module's "main clock," which for our
 654  * purposes is defined as "the functional clock needed for register
 655  * accesses to complete."  Modules may not have a main clock if the
 656  * interface clock also serves as a main clock.
 657  *
 658  * Parameter names beginning with an underscore are managed internally by
 659  * the omap_hwmod code and should not be set during initialization.
 660  *
 661  * @masters and @slaves are now deprecated.
 662  *
 663  * @parent_hwmod is temporary; there should be no need for it, as this
 664  * information should already be expressed in the OCP interface
 665  * structures.  @parent_hwmod is present as a workaround until we improve
 666  * handling for hwmods with multiple parents (e.g., OMAP4+ DSS with
 667  * multiple register targets across different interconnects).
 668  */
 669 struct omap_hwmod {
 670         const char                      *name;
 671         struct omap_hwmod_class         *class;
 672         struct omap_device              *od;
 673         struct omap_hwmod_mux_info      *mux;
 674         struct omap_hwmod_irq_info      *mpu_irqs;
 675         struct omap_hwmod_dma_info      *sdma_reqs;
 676         struct omap_hwmod_rst_info      *rst_lines;
 677         union {
 678                 struct omap_hwmod_omap2_prcm omap2;
 679                 struct omap_hwmod_omap4_prcm omap4;
 680         }                               prcm;
 681         const char                      *main_clk;
 682         struct clk                      *_clk;
 683         struct omap_hwmod_opt_clk       *opt_clks;
 684         const char                      *clkdm_name;
 685         struct clockdomain              *clkdm;
 686         struct list_head                slave_ports; /* connect to *_TA */
 687         void                            *dev_attr;
 688         u32                             _sysc_cache;
 689         void __iomem                    *_mpu_rt_va;
 690         spinlock_t                      _lock;
 691         struct lock_class_key           hwmod_key; /* unique lock class */
 692         struct list_head                node;
 693         struct omap_hwmod_ocp_if        *_mpu_port;
 694         unsigned int                    (*xlate_irq)(unsigned int);
 695         u32                             flags;
 696         u8                              mpu_rt_idx;
 697         u8                              response_lat;
 698         u8                              rst_lines_cnt;
 699         u8                              opt_clks_cnt;
 700         u8                              slaves_cnt;
 701         u8                              hwmods_cnt;
 702         u8                              _int_flags;
 703         u8                              _state;
 704         u8                              _postsetup_state;
 705         struct omap_hwmod               *parent_hwmod;
 706 };
 707
 708 struct omap_hwmod *omap_hwmod_lookup(const char *name);
 709 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
 710                         void *data);
 711
 712 int __init omap_hwmod_setup_one(const char *name);
 713
 714 int omap_hwmod_enable(struct omap_hwmod *oh);
 715 int omap_hwmod_idle(struct omap_hwmod *oh);
 716 int omap_hwmod_shutdown(struct omap_hwmod *oh);
 717
 718 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name);
 719 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name);
 720
 721 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs);
 722 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs);
 723 int omap_hwmod_softreset(struct omap_hwmod *oh);
 724
 725 int omap_hwmod_count_resources(struct omap_hwmod *oh, unsigned long flags);
 726 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res);
 727 int omap_hwmod_fill_dma_resources(struct omap_hwmod *oh, struct resource *res);
 728 int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
 729                                    const char *name, struct resource *res);
 730
 731 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh);
 732 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh);
 733
 734 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh);
 735 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh);
 736
 737 int omap_hwmod_for_each_by_class(const char *classname,
 738                                  int (*fn)(struct omap_hwmod *oh,
 739                                            void *user),
 740                                  void *user);
 741
 742 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state);
 743 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh);
 744
 745 extern void __init omap_hwmod_init(void);
 746
 747 const char *omap_hwmod_get_main_clk(struct omap_hwmod *oh);
 748
 749 /*
 750  *
 751  */
 752
 753 extern int omap_hwmod_aess_preprogram(struct omap_hwmod *oh);
 754 void omap_hwmod_rtc_unlock(struct omap_hwmod *oh);
 755 void omap_hwmod_rtc_lock(struct omap_hwmod *oh);
 756
 757 /*
 758  * Chip variant-specific hwmod init routines - XXX should be converted
 759  * to use initcalls once the initial boot ordering is straightened out
 760  */
 761 extern int omap2420_hwmod_init(void);
 762 extern int omap2430_hwmod_init(void);
 763 extern int omap3xxx_hwmod_init(void);
 764 extern int omap44xx_hwmod_init(void);
 765 extern int omap54xx_hwmod_init(void);
 766 extern int am33xx_hwmod_init(void);
 767 extern int dm814x_hwmod_init(void);
 768 extern int dm816x_hwmod_init(void);
 769 extern int dra7xx_hwmod_init(void);
 770 int am43xx_hwmod_init(void);
 771
 772 extern int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois);
 773
 774 #endif