2 * OMAP2+ common Clock Management (CM) IP block functions
4 * Copyright (C) 2012 Texas Instruments, Inc.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 * XXX This code should eventually be moved to a CM driver.
14 #include <linux/kernel.h>
15 #include <linux/init.h>
16 #include <linux/errno.h>
17 #include <linux/bug.h>
24 * cm_ll_data: function pointers to SoC-specific implementations of
27 static struct cm_ll_data null_cm_ll_data;
28 static struct cm_ll_data *cm_ll_data = &null_cm_ll_data;
30 /* cm_base: base virtual address of the CM IP block */
31 void __iomem *cm_base;
33 /* cm2_base: base virtual address of the CM2 IP block (OMAP44xx only) */
34 void __iomem *cm2_base;
37 * omap2_set_globals_cm - set the CM/CM2 base addresses (for early use)
38 * @cm: CM base virtual address
39 * @cm2: CM2 base virtual address (if present on the booted SoC)
41 * XXX Will be replaced when the PRM/CM drivers are completed.
43 void __init omap2_set_globals_cm(void __iomem *cm, void __iomem *cm2)
50 * cm_split_idlest_reg - split CM_IDLEST reg addr into its components
51 * @idlest_reg: CM_IDLEST* virtual address
52 * @prcm_inst: pointer to an s16 to return the PRCM instance offset
53 * @idlest_reg_id: pointer to a u8 to return the CM_IDLESTx register ID
55 * Given an absolute CM_IDLEST register address @idlest_reg, passes
56 * the PRCM instance offset and IDLEST register ID back to the caller
57 * via the @prcm_inst and @idlest_reg_id. Returns -EINVAL upon error,
58 * or 0 upon success. XXX This function is only needed until absolute
59 * register addresses are removed from the OMAP struct clk records.
61 int cm_split_idlest_reg(void __iomem *idlest_reg, s16 *prcm_inst,
64 if (!cm_ll_data->split_idlest_reg) {
65 WARN_ONCE(1, "cm: %s: no low-level function defined\n",
70 return cm_ll_data->split_idlest_reg(idlest_reg, prcm_inst,
75 * omap_cm_wait_module_ready - wait for a module to leave idle or standby
76 * @part: PRCM partition
77 * @prcm_mod: PRCM module offset
78 * @idlest_reg: CM_IDLESTx register
79 * @idlest_shift: shift of the bit in the CM_IDLEST* register to check
81 * Wait for the PRCM to indicate that the module identified by
82 * (@prcm_mod, @idlest_id, @idlest_shift) is clocked. Return 0 upon
83 * success, -EBUSY if the module doesn't enable in time, or -EINVAL if
84 * no per-SoC wait_module_ready() function pointer has been registered
85 * or if the idlest register is unknown on the SoC.
87 int omap_cm_wait_module_ready(u8 part, s16 prcm_mod, u16 idlest_reg,
90 if (!cm_ll_data->wait_module_ready) {
91 WARN_ONCE(1, "cm: %s: no low-level function defined\n",
96 return cm_ll_data->wait_module_ready(part, prcm_mod, idlest_reg,
101 * cm_register - register per-SoC low-level data with the CM
102 * @cld: low-level per-SoC OMAP CM data & function pointers to register
104 * Register per-SoC low-level OMAP CM data and function pointers with
105 * the OMAP CM common interface. The caller must keep the data
106 * pointed to by @cld valid until it calls cm_unregister() and
107 * it returns successfully. Returns 0 upon success, -EINVAL if @cld
108 * is NULL, or -EEXIST if cm_register() has already been called
109 * without an intervening cm_unregister().
111 int cm_register(struct cm_ll_data *cld)
116 if (cm_ll_data != &null_cm_ll_data)
125 * cm_unregister - unregister per-SoC low-level data & function pointers
126 * @cld: low-level per-SoC OMAP CM data & function pointers to unregister
128 * Unregister per-SoC low-level OMAP CM data and function pointers
129 * that were previously registered with cm_register(). The
130 * caller may not destroy any of the data pointed to by @cld until
131 * this function returns successfully. Returns 0 upon success, or
132 * -EINVAL if @cld is NULL or if @cld does not match the struct
133 * cm_ll_data * previously registered by cm_register().
135 int cm_unregister(struct cm_ll_data *cld)
137 if (!cld || cm_ll_data != cld)
140 cm_ll_data = &null_cm_ll_data;