d09448e8创建于 2022年10月17日历史提交
/* SPDX-License-Identifier: GPL-2.0 */

/*

 *  Copyright (c) 2010-2011 Jeremy Kerr <jeremy.kerr@canonical.com>

 *  Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>

 */

#ifndef __LINUX_CLK_PROVIDER_H

#define __LINUX_CLK_PROVIDER_H



#include <linux/of.h>

#include <linux/of_clk.h>



/*

 * flags used across common struct clk.  these flags should only affect the

 * top-level framework.  custom flags for dealing with hardware specifics

 * belong in struct clk_foo

 *

 * Please update clk_flags[] in drivers/clk/clk.c when making changes here!

 */

#define CLK_SET_RATE_GATE BIT(0)        /* must be gated across rate change */

#define CLK_SET_PARENT_GATE BIT(1)      /* must be gated across re-parent */

#define CLK_SET_RATE_PARENT BIT(2)      /* propagate rate change up one level */

#define CLK_IGNORE_UNUSED BIT(3)        /* do not gate even if unused */

                                        /* unused */

                                        /* unused */

#define CLK_GET_RATE_NOCACHE BIT(6)     /* do not use the cached clk rate */

#define CLK_SET_RATE_NO_REPARENT BIT(7) /* don't re-parent on rate change */

#define CLK_GET_ACCURACY_NOCACHE BIT(8) /* do not use the cached clk accuracy */

#define CLK_RECALC_NEW_RATES BIT(9)     /* recalc rates after notifications */

#define CLK_SET_RATE_UNGATE BIT(10)     /* clock needs to run to set rate */

#define CLK_IS_CRITICAL BIT(11)         /* do not gate, ever */

/* parents need enable during gate/ungate, set rate and re-parent */

#define CLK_OPS_PARENT_ENABLE BIT(12)

/* duty cycle call may be forwarded to the parent clock */

#define CLK_DUTY_CYCLE_PARENT BIT(13)



struct clk;

struct clk_hw;

struct clk_core;

struct dentry;



/**

 * struct clk_rate_request - Structure encoding the clk constraints that

 * a clock user might require.

 *

 * @rate:        Requested clock rate. This field will be adjusted by

 *            clock drivers according to hardware capabilities.

 * @min_rate:        Minimum rate imposed by clk users.

 * @max_rate:        Maximum rate imposed by clk users.

 * @best_parent_rate:    The best parent rate a parent can provide to fulfill the

 *            requested constraints.

 * @best_parent_hw:    The most appropriate parent clock that fulfills the

 *            requested constraints.

 *

 */

struct clk_rate_request {

    unsigned long rate;

    unsigned long min_rate;

    unsigned long max_rate;

    unsigned long best_parent_rate;

    struct clk_hw *best_parent_hw;

};



/**

 * struct clk_duty - Struture encoding the duty cycle ratio of a clock

 *

 * @num:    Numerator of the duty cycle ratio

 * @den:    Denominator of the duty cycle ratio

 */

struct clk_duty {

    unsigned int num;

    unsigned int den;

};



/**

 * struct clk_ops -  Callback operations for hardware clocks; these are to

 * be provided by the clock implementation, and will be called by drivers

 * through the clk_* api.

 *

 * @prepare:    Prepare the clock for enabling. This must not return until

 *        the clock is fully prepared, and it's safe to call clk_enable.

 *        This callback is intended to allow clock implementations to

 *        do any initialisation that may sleep. Called with

 *        prepare_lock held.

 *

 * @unprepare:    Release the clock from its prepared state. This will typically

 *        undo any work done in the @prepare callback. Called with

 *        prepare_lock held.

 *

 * @is_prepared: Queries the hardware to determine if the clock is prepared.

 *        This function is allowed to sleep. Optional, if this op is not

 *        set then the prepare count will be used.

 *

 * @unprepare_unused: Unprepare the clock atomically.  Only called from

 *        clk_disable_unused for prepare clocks with special needs.

 *        Called with prepare mutex held. This function may sleep.

 *

 * @enable:    Enable the clock atomically. This must not return until the

 *        clock is generating a valid clock signal, usable by consumer

 *        devices. Called with enable_lock held. This function must not

 *        sleep.

 *

 * @disable:    Disable the clock atomically. Called with enable_lock held.

 *        This function must not sleep.

 *

 * @is_enabled:    Queries the hardware to determine if the clock is enabled.

 *        This function must not sleep. Optional, if this op is not

 *        set then the enable count will be used.

 *

 * @disable_unused: Disable the clock atomically.  Only called from

 *        clk_disable_unused for gate clocks with special needs.

 *        Called with enable_lock held.  This function must not

 *        sleep.

 *

 * @save_context: Save the context of the clock in prepration for poweroff.

 *

 * @restore_context: Restore the context of the clock after a restoration

 *        of power.

 *

 * @recalc_rate    Recalculate the rate of this clock, by querying hardware. The

 *        parent rate is an input parameter.  It is up to the caller to

 *        ensure that the prepare_mutex is held across this call.

 *        Returns the calculated rate.  Optional, but recommended - if

 *        this op is not set then clock rate will be initialized to 0.

 *

 * @round_rate:    Given a target rate as input, returns the closest rate actually

 *        supported by the clock. The parent rate is an input/output

 *        parameter.

 *

 * @determine_rate: Given a target rate as input, returns the closest rate

 *        actually supported by the clock, and optionally the parent clock

 *        that should be used to provide the clock rate.

 *

 * @set_parent:    Change the input source of this clock; for clocks with multiple

 *        possible parents specify a new parent by passing in the index

 *        as a u8 corresponding to the parent in either the .parent_names

 *        or .parents arrays.  This function in affect translates an

 *        array index into the value programmed into the hardware.

 *        Returns 0 on success, -EERROR otherwise.

 *

 * @get_parent:    Queries the hardware to determine the parent of a clock.  The

 *        return value is a u8 which specifies the index corresponding to

 *        the parent clock.  This index can be applied to either the

 *        .parent_names or .parents arrays.  In short, this function

 *        translates the parent value read from hardware into an array

 *        index.  Currently only called when the clock is initialized by

 *        __clk_init.  This callback is mandatory for clocks with

 *        multiple parents.  It is optional (and unnecessary) for clocks

 *        with 0 or 1 parents.

 *

 * @set_rate:    Change the rate of this clock. The requested rate is specified

 *        by the second argument, which should typically be the return

 *        of .round_rate call.  The third argument gives the parent rate

 *        which is likely helpful for most .set_rate implementation.

 *        Returns 0 on success, -EERROR otherwise.

 *

 * @set_rate_and_parent: Change the rate and the parent of this clock. The

 *        requested rate is specified by the second argument, which

 *        should typically be the return of .round_rate call.  The

 *        third argument gives the parent rate which is likely helpful

 *        for most .set_rate_and_parent implementation. The fourth

 *        argument gives the parent index. This callback is optional (and

 *        unnecessary) for clocks with 0 or 1 parents as well as

 *        for clocks that can tolerate switching the rate and the parent

 *        separately via calls to .set_parent and .set_rate.

 *        Returns 0 on success, -EERROR otherwise.

 *

 * @recalc_accuracy: Recalculate the accuracy of this clock. The clock accuracy

 *        is expressed in ppb (parts per billion). The parent accuracy is

 *        an input parameter.

 *        Returns the calculated accuracy.  Optional - if    this op is not

 *        set then clock accuracy will be initialized to parent accuracy

 *        or 0 (perfect clock) if clock has no parent.

 *

 * @get_phase:    Queries the hardware to get the current phase of a clock.

 *        Returned values are 0-359 degrees on success, negative

 *        error codes on failure.

 *

 * @set_phase:    Shift the phase this clock signal in degrees specified

 *        by the second argument. Valid values for degrees are

 *        0-359. Return 0 on success, otherwise -EERROR.

 *

 * @get_duty_cycle: Queries the hardware to get the current duty cycle ratio

 *              of a clock. Returned values denominator cannot be 0 and must be

 *              superior or equal to the numerator.

 *

 * @set_duty_cycle: Apply the duty cycle ratio to this clock signal specified by

 *              the numerator (2nd argurment) and denominator (3rd  argument).

 *              Argument must be a valid ratio (denominator > 0

 *              and >= numerator) Return 0 on success, otherwise -EERROR.

 *

 * @init:    Perform platform-specific initialization magic.

 *        This is not used by any of the basic clock types.

 *        This callback exist for HW which needs to perform some

 *        initialisation magic for CCF to get an accurate view of the

 *        clock. It may also be used dynamic resource allocation is

 *        required. It shall not used to deal with clock parameters,

 *        such as rate or parents.

 *        Returns 0 on success, -EERROR otherwise.

 *

 * @terminate:  Free any resource allocated by init.

 *

 * @debug_init:    Set up type-specific debugfs entries for this clock.  This

 *        is called once, after the debugfs directory entry for this

 *        clock has been created.  The dentry pointer representing that

 *        directory is provided as an argument.  Called with

 *        prepare_lock held.  Returns 0 on success, -EERROR otherwise.

 *

 *

 * The clk_enable/clk_disable and clk_prepare/clk_unprepare pairs allow

 * implementations to split any work between atomic (enable) and sleepable

 * (prepare) contexts.  If enabling a clock requires code that might sleep,

 * this must be done in clk_prepare.  Clock enable code that will never be

 * called in a sleepable context may be implemented in clk_enable.

 *

 * Typically, drivers will call clk_prepare when a clock may be needed later

 * (eg. when a device is opened), and clk_enable when the clock is actually

 * required (eg. from an interrupt). Note that clk_prepare MUST have been

 * called before clk_enable.

 */

struct clk_ops {

    int (*prepare)(struct clk_hw *hw);

    void (*unprepare)(struct clk_hw *hw);

    int (*is_prepared)(struct clk_hw *hw);

    void (*unprepare_unused)(struct clk_hw *hw);

    int (*enable)(struct clk_hw *hw);

    void (*disable)(struct clk_hw *hw);

    int (*is_enabled)(struct clk_hw *hw);

    void (*disable_unused)(struct clk_hw *hw);

    int (*save_context)(struct clk_hw *hw);

    void (*restore_context)(struct clk_hw *hw);

    unsigned long (*recalc_rate)(struct clk_hw *hw, unsigned long parent_rate);

    long (*round_rate)(struct clk_hw *hw, unsigned long rate, unsigned long *parent_rate);

    int (*determine_rate)(struct clk_hw *hw, struct clk_rate_request *req);

    int (*set_parent)(struct clk_hw *hw, u8 index);

    u8 (*get_parent)(struct clk_hw *hw);

    int (*set_rate)(struct clk_hw *hw, unsigned long rate, unsigned long parent_rate);

    int (*set_rate_and_parent)(struct clk_hw *hw, unsigned long rate, unsigned long parent_rate, u8 index);

    unsigned long (*recalc_accuracy)(struct clk_hw *hw, unsigned long parent_accuracy);

    int (*get_phase)(struct clk_hw *hw);

    int (*set_phase)(struct clk_hw *hw, int degrees);

    int (*get_duty_cycle)(struct clk_hw *hw, struct clk_duty *duty);

    int (*set_duty_cycle)(struct clk_hw *hw, struct clk_duty *duty);

    int (*init)(struct clk_hw *hw);

    void (*terminate)(struct clk_hw *hw);

    void (*debug_init)(struct clk_hw *hw, struct dentry *dentry);

};



/**

 * struct clk_parent_data - clk parent information

 * @hw: parent clk_hw pointer (used for clk providers with internal clks)

 * @fw_name: parent name local to provider registering clk

 * @name: globally unique parent name (used as a fallback)

 * @index: parent index local to provider registering clk (if @fw_name absent)

 */

struct clk_parent_data {

    const struct clk_hw *hw;

    const char *fw_name;

    const char *name;

    int index;

};



/**

 * struct clk_init_data - holds init data that's common to all clocks and is

 * shared between the clock provider and the common clock framework.

 *

 * @name: clock name

 * @ops: operations this clock supports

 * @parent_names: array of string names for all possible parents

 * @parent_data: array of parent data for all possible parents (when some

 *               parents are external to the clk controller)

 * @parent_hws: array of pointers to all possible parents (when all parents

 *              are internal to the clk controller)

 * @num_parents: number of possible parents

 * @flags: framework-level hints and quirks

 */

struct clk_init_data {

    const char *name;

    const struct clk_ops *ops;

    /* Only one of the following three should be assigned */

    const char *const *parent_names;

    const struct clk_parent_data *parent_data;

    const struct clk_hw **parent_hws;

    u8 num_parents;

    unsigned long flags;

};



/**

 * struct clk_hw - handle for traversing from a struct clk to its corresponding

 * hardware-specific structure.  struct clk_hw should be declared within struct

 * clk_foo and then referenced by the struct clk instance that uses struct

 * clk_foo's clk_ops

 *

 * @core: pointer to the struct clk_core instance that points back to this

 * struct clk_hw instance

 *

 * @clk: pointer to the per-user struct clk instance that can be used to call

 * into the clk API

 *

 * @init: pointer to struct clk_init_data that contains the init data shared

 * with the common clock framework. This pointer will be set to NULL once

 * a clk_register() variant is called on this clk_hw pointer.

 */

struct clk_hw {

    struct clk_core *core;

    struct clk *clk;

    const struct clk_init_data *init;

};



/*

 * DOC: Basic clock implementations common to many platforms

 *

 * Each basic clock hardware type is comprised of a structure describing the

 * clock hardware, implementations of the relevant callbacks in struct clk_ops,

 * unique flags for that hardware type, a registration function and an

 * alternative macro for static initialization

 */



/**

 * struct clk_fixed_rate - fixed-rate clock

 * @hw:        handle between common and hardware-specific interfaces

 * @fixed_rate:    constant frequency of clock

 * @fixed_accuracy: constant accuracy of clock in ppb (parts per billion)

 * @flags:    hardware specific flags

 *

 * Flags:

 * * CLK_FIXED_RATE_PARENT_ACCURACY - Use the accuracy of the parent clk

 *                                    instead of what's set in @fixed_accuracy.

 */

struct clk_fixed_rate {

    struct clk_hw hw;

    unsigned long fixed_rate;

    unsigned long fixed_accuracy;

    unsigned long flags;

};



#define CLK_FIXED_RATE_PARENT_ACCURACY BIT(0)



extern const struct clk_ops clk_fixed_rate_ops;

struct clk_hw *__clk_hw_register_fixed_rate(struct device *dev, struct device_node *np, const char *name,

                                            const char *parent_name, const struct clk_hw *parent_hw,

                                            const struct clk_parent_data *parent_data, unsigned long flags,

                                            unsigned long fixed_rate, unsigned long fixed_accuracy,

                                            unsigned long clk_fixed_flags);

struct clk *clk_register_fixed_rate(struct device *dev, const char *name, const char *parent_name, unsigned long flags,

                                    unsigned long fixed_rate);

/**

 * clk_hw_register_fixed_rate - register fixed-rate clock with the clock

 * framework

 * @dev: device that is registering this clock

 * @name: name of this clock

 * @parent_name: name of clock's parent

 * @flags: framework-specific flags

 * @fixed_rate: non-adjustable clock rate

 */

#define clk_hw_register_fixed_rate(dev, name, parent_name, flags, fixed_rate)                                          \

    __clk_hw_register_fixed_rate((dev), NULL, (name), (parent_name), NULL, NULL, (flags), (fixed_rate), 0, 0)

/**

 * clk_hw_register_fixed_rate_parent_hw - register fixed-rate clock with

 * the clock framework

 * @dev: device that is registering this clock

 * @name: name of this clock

 * @parent_hw: pointer to parent clk

 * @flags: framework-specific flags

 * @fixed_rate: non-adjustable clock rate

 */

#define clk_hw_register_fixed_rate_parent_hw(dev, name, parent_hw, flags, fixed_rate)                                  \

    __clk_hw_register_fixed_rate((dev), NULL, (name), NULL, (parent_hw), NULL, (flags), (fixed_rate), 0, 0)

/**

 * clk_hw_register_fixed_rate_parent_data - register fixed-rate clock with

 * the clock framework

 * @dev: device that is registering this clock

 * @name: name of this clock

 * @parent_data: parent clk data

 * @flags: framework-specific flags

 * @fixed_rate: non-adjustable clock rate

 */

#define clk_hw_register_fixed_rate_parent_data(dev, name, parent_hw, flags, fixed_rate)                                \

    __clk_hw_register_fixed_rate((dev), NULL, (name), NULL, NULL, (parent_data), (flags), (fixed_rate), 0, 0)

/**

 * clk_hw_register_fixed_rate_with_accuracy - register fixed-rate clock with

 * the clock framework

 * @dev: device that is registering this clock

 * @name: name of this clock

 * @parent_name: name of clock's parent

 * @flags: framework-specific flags

 * @fixed_rate: non-adjustable clock rate

 * @fixed_accuracy: non-adjustable clock accuracy

 */

#define clk_hw_register_fixed_rate_with_accuracy(dev, name, parent_name, flags, fixed_rate, fixed_accuracy)            \

    __clk_hw_register_fixed_rate((dev), NULL, (name), (parent_name), NULL, NULL, (flags), (fixed_rate),                \

                                 (fixed_accuracy), 0)

/**

 * clk_hw_register_fixed_rate_with_accuracy_parent_hw - register fixed-rate

 * clock with the clock framework

 * @dev: device that is registering this clock

 * @name: name of this clock

 * @parent_hw: pointer to parent clk

 * @flags: framework-specific flags

 * @fixed_rate: non-adjustable clock rate

 * @fixed_accuracy: non-adjustable clock accuracy

 */

#define clk_hw_register_fixed_rate_with_accuracy_parent_hw(dev, name, parent_hw, flags, fixed_rate, fixed_accuracy)    \

    __clk_hw_register_fixed_rate((dev), NULL, (name), NULL, (parent_hw)NULL, NULL, (flags), (fixed_rate),              \

                                 (fixed_accuracy), 0)

/**

 * clk_hw_register_fixed_rate_with_accuracy_parent_data - register fixed-rate

 * clock with the clock framework

 * @dev: device that is registering this clock

 * @name: name of this clock

 * @parent_name: name of clock's parent

 * @flags: framework-specific flags

 * @fixed_rate: non-adjustable clock rate

 * @fixed_accuracy: non-adjustable clock accuracy

 */

#define clk_hw_register_fixed_rate_with_accuracy_parent_data(dev, name, parent_data, flags, fixed_rate,                \

                                                             fixed_accuracy)                                           \

    __clk_hw_register_fixed_rate((dev), NULL, (name), NULL, NULL, (parent_data), NULL, (flags), (fixed_rate),          \

                                 (fixed_accuracy), 0)



void clk_unregister_fixed_rate(struct clk *clk);

void clk_hw_unregister_fixed_rate(struct clk_hw *hw);



void of_fixed_clk_setup(struct device_node *np);



/**

 * struct clk_gate - gating clock

 *

 * @hw:        handle between common and hardware-specific interfaces

 * @reg:    register controlling gate

 * @bit_idx:    single bit controlling gate

 * @flags:    hardware-specific flags

 * @lock:    register lock

 *

 * Clock which can gate its output.  Implements .enable & .disable

 *

 * Flags:

 * CLK_GATE_SET_TO_DISABLE - by default this clock sets the bit at bit_idx to

 *    enable the clock.  Setting this flag does the opposite: setting the bit

 *    disable the clock and clearing it enables the clock

 * CLK_GATE_HIWORD_MASK - The gate settings are only in lower 16-bit

 *    of this register, and mask of gate bits are in higher 16-bit of this

 *    register.  While setting the gate bits, higher 16-bit should also be

 *    updated to indicate changing gate bits.

 * CLK_GATE_BIG_ENDIAN - by default little endian register accesses are used for

 *    the gate register.  Setting this flag makes the register accesses big

 *    endian.

 */

struct clk_gate {

    struct clk_hw hw;

    void __iomem *reg;

    u8 bit_idx;

    u8 flags;

    spinlock_t *lock;

};



#define to_clk_gate(_hw) container_of(_hw, struct clk_gate, hw)



#define CLK_GATE_SET_TO_DISABLE BIT(0)

#define CLK_GATE_HIWORD_MASK BIT(1)

#define CLK_GATE_BIG_ENDIAN BIT(2)



extern const struct clk_ops clk_gate_ops;

struct clk_hw *__clk_hw_register_gate(struct device *dev, struct device_node *np, const char *name,

                                      const char *parent_name, const struct clk_hw *parent_hw,

                                      const struct clk_parent_data *parent_data, unsigned long flags, void __iomem *reg,

                                      u8 bit_idx, u8 clk_gate_flags, spinlock_t *lock);

struct clk *clk_register_gate(struct device *dev, const char *name, const char *parent_name, unsigned long flags,

                              void __iomem *reg, u8 bit_idx, u8 clk_gate_flags, spinlock_t *lock);

/**

 * clk_hw_register_gate - register a gate clock with the clock framework

 * @dev: device that is registering this clock

 * @name: name of this clock

 * @parent_name: name of this clock's parent

 * @flags: framework-specific flags for this clock

 * @reg: register address to control gating of this clock

 * @bit_idx: which bit in the register controls gating of this clock

 * @clk_gate_flags: gate-specific flags for this clock

 * @lock: shared register lock for this clock

 */

#define clk_hw_register_gate(dev, name, parent_name, flags, reg, bit_idx, clk_gate_flags, lock)                        \

    __clk_hw_register_gate((dev), NULL, (name), (parent_name), NULL, NULL, (flags), (reg), (bit_idx),                  \

                           (clk_gate_flags), (lock))

/**

 * clk_hw_register_gate_parent_hw - register a gate clock with the clock

 * framework

 * @dev: device that is registering this clock

 * @name: name of this clock

 * @parent_hw: pointer to parent clk

 * @flags: framework-specific flags for this clock

 * @reg: register address to control gating of this clock

 * @bit_idx: which bit in the register controls gating of this clock

 * @clk_gate_flags: gate-specific flags for this clock

 * @lock: shared register lock for this clock

 */

#define clk_hw_register_gate_parent_hw(dev, name, parent_hw, flags, reg, bit_idx, clk_gate_flags, lock)                \

    __clk_hw_register_gate((dev), NULL, (name), NULL, (parent_hw), NULL, (flags), (reg), (bit_idx), (clk_gate_flags),  \

                           (lock))

/**

 * clk_hw_register_gate_parent_data - register a gate clock with the clock

 * framework

 * @dev: device that is registering this clock

 * @name: name of this clock

 * @parent_data: parent clk data

 * @flags: framework-specific flags for this clock

 * @reg: register address to control gating of this clock

 * @bit_idx: which bit in the register controls gating of this clock

 * @clk_gate_flags: gate-specific flags for this clock

 * @lock: shared register lock for this clock

 */

#define clk_hw_register_gate_parent_data(dev, name, parent_data, flags, reg, bit_idx, clk_gate_flags, lock)            \

    __clk_hw_register_gate((dev), NULL, (name), NULL, NULL, (parent_data), (flags), (reg), (bit_idx),                  \

                           (clk_gate_flags), (lock))

void clk_unregister_gate(struct clk *clk);

void clk_hw_unregister_gate(struct clk_hw *hw);

int clk_gate_is_enabled(struct clk_hw *hw);



struct clk_div_table {

    unsigned int val;

    unsigned int div;

};



/**

 * struct clk_divider - adjustable divider clock

 *

 * @hw:        handle between common and hardware-specific interfaces

 * @reg:    register containing the divider

 * @shift:    shift to the divider bit field

 * @width:    width of the divider bit field

 * @table:    array of value/divider pairs, last entry should have div = 0

 * @lock:    register lock

 *

 * Clock with an adjustable divider affecting its output frequency.  Implements

 * .recalc_rate, .set_rate and .round_rate

 *

 * Flags:

 * CLK_DIVIDER_ONE_BASED - by default the divisor is the value read from the

 *    register plus one.  If CLK_DIVIDER_ONE_BASED is set then the divider is

 *    the raw value read from the register, with the value of zero considered

 *    invalid, unless CLK_DIVIDER_ALLOW_ZERO is set.

 * CLK_DIVIDER_POWER_OF_TWO - clock divisor is 2 raised to the value read from

 *    the hardware register

 * CLK_DIVIDER_ALLOW_ZERO - Allow zero divisors.  For dividers which have

 *    CLK_DIVIDER_ONE_BASED set, it is possible to end up with a zero divisor.

 *    Some hardware implementations gracefully handle this case and allow a

 *    zero divisor by not modifying their input clock

 *    (divide by one / bypass).

 * CLK_DIVIDER_HIWORD_MASK - The divider settings are only in lower 16-bit

 *    of this register, and mask of divider bits are in higher 16-bit of this

 *    register.  While setting the divider bits, higher 16-bit should also be

 *    updated to indicate changing divider bits.

 * CLK_DIVIDER_ROUND_CLOSEST - Makes the best calculated divider to be rounded

 *    to the closest integer instead of the up one.

 * CLK_DIVIDER_READ_ONLY - The divider settings are preconfigured and should

 *    not be changed by the clock framework.

 * CLK_DIVIDER_MAX_AT_ZERO - For dividers which are like CLK_DIVIDER_ONE_BASED

 *    except when the value read from the register is zero, the divisor is

 *    2^width of the field.

 * CLK_DIVIDER_BIG_ENDIAN - By default little endian register accesses are used

 *    for the divider register.  Setting this flag makes the register accesses

 *    big endian.

 */

struct clk_divider {

    struct clk_hw hw;

    void __iomem *reg;

    u8 shift;

    u8 width;

    u8 flags;

    unsigned long max_prate;

    const struct clk_div_table *table;

    spinlock_t *lock;

};



#define clk_div_mask(width) ((1 << (width)) - 1)

#define to_clk_divider(_hw) container_of(_hw, struct clk_divider, hw)



#define CLK_DIVIDER_ONE_BASED BIT(0)

#define CLK_DIVIDER_POWER_OF_TWO BIT(1)

#define CLK_DIVIDER_ALLOW_ZERO BIT(2)

#define CLK_DIVIDER_HIWORD_MASK BIT(3)

#define CLK_DIVIDER_ROUND_CLOSEST BIT(4)

#define CLK_DIVIDER_READ_ONLY BIT(5)

#define CLK_DIVIDER_MAX_AT_ZERO BIT(6)

#define CLK_DIVIDER_BIG_ENDIAN BIT(7)



extern const struct clk_ops clk_divider_ops;

extern const struct clk_ops clk_divider_ro_ops;



unsigned long divider_recalc_rate(struct clk_hw *hw, unsigned long parent_rate, unsigned int val,

                                  const struct clk_div_table *table, unsigned long flags, unsigned long width);

long divider_round_rate_parent(struct clk_hw *hw, struct clk_hw *parent, unsigned long rate, unsigned long *prate,

                               const struct clk_div_table *table, u8 width, unsigned long flags);

long divider_ro_round_rate_parent(struct clk_hw *hw, struct clk_hw *parent, unsigned long rate, unsigned long *prate,

                                  const struct clk_div_table *table, u8 width, unsigned long flags, unsigned int val);

int divider_get_val(unsigned long rate, unsigned long parent_rate, const struct clk_div_table *table, u8 width,

                    unsigned long flags);



struct clk_hw *__clk_hw_register_divider(struct device *dev, struct device_node *np, const char *name,

                                         const char *parent_name, const struct clk_hw *parent_hw,

                                         const struct clk_parent_data *parent_data, unsigned long flags,

                                         void __iomem *reg, u8 shift, u8 width, u8 clk_divider_flags,

                                         const struct clk_div_table *table, spinlock_t *lock);

struct clk *clk_register_divider_table(struct device *dev, const char *name, const char *parent_name,

                                       unsigned long flags, void __iomem *reg, u8 shift, u8 width, u8 clk_divider_flags,

                                       const struct clk_div_table *table, spinlock_t *lock);

/**

 * clk_register_divider - register a divider clock with the clock framework

 * @dev: device registering this clock

 * @name: name of this clock

 * @parent_name: name of clock's parent

 * @flags: framework-specific flags

 * @reg: register address to adjust divider

 * @shift: number of bits to shift the bitfield

 * @width: width of the bitfield

 * @clk_divider_flags: divider-specific flags for this clock

 * @lock: shared register lock for this clock

 */

#define clk_register_divider(dev, name, parent_name, flags, reg, shift, width, clk_divider_flags, lock)                \

    clk_register_divider_table((dev), (name), (parent_name), (flags), (reg), (shift), (width), (clk_divider_flags),    \

                               NULL, (lock))

/**

 * clk_hw_register_divider - register a divider clock with the clock framework

 * @dev: device registering this clock

 * @name: name of this clock

 * @parent_name: name of clock's parent

 * @flags: framework-specific flags

 * @reg: register address to adjust divider

 * @shift: number of bits to shift the bitfield

 * @width: width of the bitfield

 * @clk_divider_flags: divider-specific flags for this clock

 * @lock: shared register lock for this clock

 */

#define clk_hw_register_divider(dev, name, parent_name, flags, reg, shift, width, clk_divider_flags, lock)             \

    __clk_hw_register_divider((dev), NULL, (name), (parent_name), NULL, NULL, (flags), (reg), (shift), (width),        \

                              (clk_divider_flags), NULL, (lock))

/**

 * clk_hw_register_divider_parent_hw - register a divider clock with the clock

 * framework

 * @dev: device registering this clock

 * @name: name of this clock

 * @parent_hw: pointer to parent clk

 * @flags: framework-specific flags

 * @reg: register address to adjust divider

 * @shift: number of bits to shift the bitfield

 * @width: width of the bitfield

 * @clk_divider_flags: divider-specific flags for this clock

 * @lock: shared register lock for this clock

 */

#define clk_hw_register_divider_parent_hw(dev, name, parent_hw, flags, reg, shift, width, clk_divider_flags, lock)     \

    __clk_hw_register_divider((dev), NULL, (name), NULL, (parent_hw), NULL, (flags), (reg), (shift), (width),          \

                              (clk_divider_flags), NULL, (lock))

/**

 * clk_hw_register_divider_parent_data - register a divider clock with the clock

 * framework

 * @dev: device registering this clock

 * @name: name of this clock

 * @parent_data: parent clk data

 * @flags: framework-specific flags

 * @reg: register address to adjust divider

 * @shift: number of bits to shift the bitfield

 * @width: width of the bitfield

 * @clk_divider_flags: divider-specific flags for this clock

 * @lock: shared register lock for this clock

 */

#define clk_hw_register_divider_parent_data(dev, name, parent_data, flags, reg, shift, width, clk_divider_flags, lock) \

    __clk_hw_register_divider((dev), NULL, (name), NULL, NULL, (parent_data), (flags), (reg), (shift), (width),        \

                              (clk_divider_flags), NULL, (lock))

/**

 * clk_hw_register_divider_table - register a table based divider clock with

 * the clock framework

 * @dev: device registering this clock

 * @name: name of this clock

 * @parent_name: name of clock's parent

 * @flags: framework-specific flags

 * @reg: register address to adjust divider

 * @shift: number of bits to shift the bitfield

 * @width: width of the bitfield

 * @clk_divider_flags: divider-specific flags for this clock

 * @table: array of divider/value pairs ending with a div set to 0

 * @lock: shared register lock for this clock

 */

#define clk_hw_register_divider_table(dev, name, parent_name, flags, reg, shift, width, clk_divider_flags, table,      \

                                      lock)                                                                            \

    __clk_hw_register_divider((dev), NULL, (name), (parent_name), NULL, NULL, (flags), (reg), (shift), (width),        \

                              (clk_divider_flags), (table), (lock))

/**

 * clk_hw_register_divider_table_parent_hw - register a table based divider

 * clock with the clock framework

 * @dev: device registering this clock

 * @name: name of this clock

 * @parent_hw: pointer to parent clk

 * @flags: framework-specific flags

 * @reg: register address to adjust divider

 * @shift: number of bits to shift the bitfield

 * @width: width of the bitfield

 * @clk_divider_flags: divider-specific flags for this clock

 * @table: array of divider/value pairs ending with a div set to 0

 * @lock: shared register lock for this clock

 */

#define clk_hw_register_divider_table_parent_hw(dev, name, parent_hw, flags, reg, shift, width, clk_divider_flags,     \

                                                table, lock)                                                           \

    __clk_hw_register_divider((dev), NULL, (name), NULL, (parent_hw), NULL, (flags), (reg), (shift), (width),          \

                              (clk_divider_flags), (table), (lock))

/**

 * clk_hw_register_divider_table_parent_data - register a table based divider

 * clock with the clock framework

 * @dev: device registering this clock

 * @name: name of this clock

 * @parent_data: parent clk data

 * @flags: framework-specific flags

 * @reg: register address to adjust divider

 * @shift: number of bits to shift the bitfield

 * @width: width of the bitfield

 * @clk_divider_flags: divider-specific flags for this clock

 * @table: array of divider/value pairs ending with a div set to 0

 * @lock: shared register lock for this clock

 */

#define clk_hw_register_divider_table_parent_data(dev, name, parent_data, flags, reg, shift, width, clk_divider_flags, \

                                                  table, lock)                                                         \

    __clk_hw_register_divider((dev), NULL, (name), NULL, NULL, (parent_data), (flags), (reg), (shift), (width),        \

                              (clk_divider_flags), (table), (lock))



void clk_unregister_divider(struct clk *clk);

void clk_hw_unregister_divider(struct clk_hw *hw);



/**

 * struct clk_mux - multiplexer clock

 *

 * @hw:        handle between common and hardware-specific interfaces

 * @reg:    register controlling multiplexer

 * @table:    array of register values corresponding to the parent index

 * @shift:    shift to multiplexer bit field

 * @mask:    mask of mutliplexer bit field

 * @flags:    hardware-specific flags

 * @lock:    register lock

 *

 * Clock with multiple selectable parents.  Implements .get_parent, .set_parent

 * and .recalc_rate

 *

 * Flags:

 * CLK_MUX_INDEX_ONE - register index starts at 1, not 0

 * CLK_MUX_INDEX_BIT - register index is a single bit (power of two)

 * CLK_MUX_HIWORD_MASK - The mux settings are only in lower 16-bit of this

 *    register, and mask of mux bits are in higher 16-bit of this register.

 *    While setting the mux bits, higher 16-bit should also be updated to

 *    indicate changing mux bits.

 * CLK_MUX_READ_ONLY - The mux registers can't be written, only read in the

 *     .get_parent clk_op.

 * CLK_MUX_ROUND_CLOSEST - Use the parent rate that is closest to the desired

 *    frequency.

 * CLK_MUX_BIG_ENDIAN - By default little endian register accesses are used for

 *    the mux register.  Setting this flag makes the register accesses big

 *    endian.

 */

struct clk_mux {

    struct clk_hw hw;

    void __iomem *reg;

    u32 *table;

    u32 mask;

    u8 shift;

    u8 flags;

    spinlock_t *lock;

};



#define to_clk_mux(_hw) container_of(_hw, struct clk_mux, hw)



#define CLK_MUX_INDEX_ONE BIT(0)

#define CLK_MUX_INDEX_BIT BIT(1)

#define CLK_MUX_HIWORD_MASK BIT(2)

#define CLK_MUX_READ_ONLY BIT(3) /* mux can't be changed */

#define CLK_MUX_ROUND_CLOSEST BIT(4)

#define CLK_MUX_BIG_ENDIAN BIT(5)



extern const struct clk_ops clk_mux_ops;

extern const struct clk_ops clk_mux_ro_ops;



struct clk_hw *__clk_hw_register_mux(struct device *dev, struct device_node *np, const char *name, u8 num_parents,

                                     const char *const *parent_names, const struct clk_hw **parent_hws,

                                     const struct clk_parent_data *parent_data, unsigned long flags, void __iomem *reg,

                                     u8 shift, u32 mask, u8 clk_mux_flags, u32 *table, spinlock_t *lock);

struct clk *clk_register_mux_table(struct device *dev, const char *name, const char *const *parent_names,

                                   u8 num_parents, unsigned long flags, void __iomem *reg, u8 shift, u32 mask,

                                   u8 clk_mux_flags, u32 *table, spinlock_t *lock);



#define clk_register_mux(dev, name, parent_names, num_parents, flags, reg, shift, width, clk_mux_flags, lock)          \

    clk_register_mux_table((dev), (name), (parent_names), (num_parents), (flags), (reg), (shift), BIT((width)) - 1,    \

                           (clk_mux_flags), NULL, (lock))

#define clk_hw_register_mux_table(dev, name, parent_names, num_parents, flags, reg, shift, mask, clk_mux_flags, table, \

                                  lock)                                                                                \

    __clk_hw_register_mux((dev), NULL, (name), (num_parents), (parent_names), NULL, NULL, (flags), (reg), (shift),     \

                          (mask), (clk_mux_flags), (table), (lock))

#define clk_hw_register_mux(dev, name, parent_names, num_parents, flags, reg, shift, width, clk_mux_flags, lock)       \

    __clk_hw_register_mux((dev), NULL, (name), (num_parents), (parent_names), NULL, NULL, (flags), (reg), (shift),     \

                          BIT((width)) - 1, (clk_mux_flags), NULL, (lock))

#define clk_hw_register_mux_hws(dev, name, parent_hws, num_parents, flags, reg, shift, width, clk_mux_flags, lock)     \

    __clk_hw_register_mux((dev), NULL, (name), (num_parents), NULL, (parent_hws), NULL, (flags), (reg), (shift),       \

                          BIT((width)) - 1, (clk_mux_flags), NULL, (lock))

#define clk_hw_register_mux_parent_data(dev, name, parent_data, num_parents, flags, reg, shift, width, clk_mux_flags,  \

                                        lock)                                                                          \

    __clk_hw_register_mux((dev), NULL, (name), (num_parents), NULL, NULL, (parent_data), (flags), (reg), (shift),      \

                          BIT((width)) - 1, (clk_mux_flags), NULL, (lock))



int clk_mux_val_to_index(struct clk_hw *hw, u32 *table, unsigned int flags, unsigned int val);

unsigned int clk_mux_index_to_val(u32 *table, unsigned int flags, u8 index);



void clk_unregister_mux(struct clk *clk);

void clk_hw_unregister_mux(struct clk_hw *hw);



void of_fixed_factor_clk_setup(struct device_node *node);



/**

 * struct clk_fixed_factor - fixed multiplier and divider clock

 *

 * @hw:        handle between common and hardware-specific interfaces

 * @mult:    multiplier

 * @div:    divider

 *

 * Clock with a fixed multiplier and divider. The output frequency is the

 * parent clock rate divided by div and multiplied by mult.

 * Implements .recalc_rate, .set_rate and .round_rate

 */



struct clk_fixed_factor {

    struct clk_hw hw;

    unsigned int mult;

    unsigned int div;

};



#define to_clk_fixed_factor(_hw) container_of(_hw, struct clk_fixed_factor, hw)



extern const struct clk_ops clk_fixed_factor_ops;

struct clk *clk_register_fixed_factor(struct device *dev, const char *name, const char *parent_name,

                                      unsigned long flags, unsigned int mult, unsigned int div);

void clk_unregister_fixed_factor(struct clk *clk);

struct clk_hw *clk_hw_register_fixed_factor(struct device *dev, const char *name, const char *parent_name,

                                            unsigned long flags, unsigned int mult, unsigned int div);

void clk_hw_unregister_fixed_factor(struct clk_hw *hw);



/**

 * struct clk_fractional_divider - adjustable fractional divider clock

 *

 * @hw:        handle between common and hardware-specific interfaces

 * @reg:    register containing the divider

 * @mshift:    shift to the numerator bit field

 * @mwidth:    width of the numerator bit field

 * @nshift:    shift to the denominator bit field

 * @nwidth:    width of the denominator bit field

 * @lock:    register lock

 *

 * Clock with adjustable fractional divider affecting its output frequency.

 *

 * Flags:

 * CLK_FRAC_DIVIDER_ZERO_BASED - by default the numerator and denominator

 *    is the value read from the register. If CLK_FRAC_DIVIDER_ZERO_BASED

 *    is set then the numerator and denominator are both the value read

 *    plus one.

 * CLK_FRAC_DIVIDER_BIG_ENDIAN - By default little endian register accesses are

 *    used for the divider register.  Setting this flag makes the register

 *    accesses big endian.

 * CLK_FRAC_DIVIDER_NO_LIMIT - not need to follow the 20 times limit on

 *    fractional divider

 */

struct clk_fractional_divider {

    struct clk_hw hw;

    void __iomem *reg;

    u8 mshift;

    u8 mwidth;

    u32 mmask;

    u8 nshift;

    u8 nwidth;

    u32 nmask;

    u8 flags;

    unsigned long max_prate;

    void (*approximation)(struct clk_hw *hw, unsigned long rate, unsigned long *parent_rate, unsigned long *m,

                          unsigned long *n);

    spinlock_t *lock;

};



#define to_clk_fd(_hw) container_of(_hw, struct clk_fractional_divider, hw)



#define CLK_FRAC_DIVIDER_ZERO_BASED BIT(0)

#define CLK_FRAC_DIVIDER_BIG_ENDIAN BIT(1)

#define CLK_FRAC_DIVIDER_NO_LIMIT BIT(2)



extern const struct clk_ops clk_fractional_divider_ops;

struct clk *clk_register_fractional_divider(struct device *dev, const char *name, const char *parent_name,

                                            unsigned long flags, void __iomem *reg, u8 mshift, u8 mwidth, u8 nshift,

                                            u8 nwidth, u8 clk_divider_flags, spinlock_t *lock);

struct clk_hw *clk_hw_register_fractional_divider(struct device *dev, const char *name, const char *parent_name,

                                                  unsigned long flags, void __iomem *reg, u8 mshift, u8 mwidth,

                                                  u8 nshift, u8 nwidth, u8 clk_divider_flags, spinlock_t *lock);

void clk_hw_unregister_fractional_divider(struct clk_hw *hw);



/**

 * struct clk_multiplier - adjustable multiplier clock

 *

 * @hw:        handle between common and hardware-specific interfaces

 * @reg:    register containing the multiplier

 * @shift:    shift to the multiplier bit field

 * @width:    width of the multiplier bit field

 * @lock:    register lock

 *

 * Clock with an adjustable multiplier affecting its output frequency.

 * Implements .recalc_rate, .set_rate and .round_rate

 *

 * Flags:

 * CLK_MULTIPLIER_ZERO_BYPASS - By default, the multiplier is the value read

 *    from the register, with 0 being a valid value effectively

 *    zeroing the output clock rate. If CLK_MULTIPLIER_ZERO_BYPASS is

 *    set, then a null multiplier will be considered as a bypass,

 *    leaving the parent rate unmodified.

 * CLK_MULTIPLIER_ROUND_CLOSEST - Makes the best calculated divider to be

 *    rounded to the closest integer instead of the down one.

 * CLK_MULTIPLIER_BIG_ENDIAN - By default little endian register accesses are

 *    used for the multiplier register.  Setting this flag makes the register

 *    accesses big endian.

 */

struct clk_multiplier {

    struct clk_hw hw;

    void __iomem *reg;

    u8 shift;

    u8 width;

    u8 flags;

    spinlock_t *lock;

};



#define to_clk_multiplier(_hw) container_of(_hw, struct clk_multiplier, hw)



#define CLK_MULTIPLIER_ZERO_BYPASS BIT(0)

#define CLK_MULTIPLIER_ROUND_CLOSEST BIT(1)

#define CLK_MULTIPLIER_BIG_ENDIAN BIT(2)



extern const struct clk_ops clk_multiplier_ops;



/***

 * struct clk_composite - aggregate clock of mux, divider and gate clocks

 *

 * @hw:        handle between common and hardware-specific interfaces

 * @mux_hw:    handle between composite and hardware-specific mux clock

 * @rate_hw:    handle between composite and hardware-specific rate clock

 * @gate_hw:    handle between composite and hardware-specific gate clock

 * @brother_hw: a member of clk_composite who has the common parent clocks

 *              with another clk_composite, and it's also a handle between

 *              common and hardware-specific interfaces

 * @mux_ops:    clock ops for mux

 * @rate_ops:    clock ops for rate

 * @gate_ops:    clock ops for gate

 */

struct clk_composite {

    struct clk_hw hw;

    struct clk_ops ops;



    struct clk_hw *mux_hw;

    struct clk_hw *rate_hw;

    struct clk_hw *gate_hw;

    struct clk_hw *brother_hw;



    const struct clk_ops *mux_ops;

    const struct clk_ops *rate_ops;

    const struct clk_ops *gate_ops;

};



#define to_clk_composite(_hw) container_of(_hw, struct clk_composite, hw)



struct clk *clk_register_composite(struct device *dev, const char *name, const char *const *parent_names,

                                   int num_parents, struct clk_hw *mux_hw, const struct clk_ops *mux_ops,

                                   struct clk_hw *rate_hw, const struct clk_ops *rate_ops, struct clk_hw *gate_hw,

                                   const struct clk_ops *gate_ops, unsigned long flags);

struct clk *clk_register_composite_pdata(struct device *dev, const char *name,

                                         const struct clk_parent_data *parent_data, int num_parents,

                                         struct clk_hw *mux_hw, const struct clk_ops *mux_ops, struct clk_hw *rate_hw,

                                         const struct clk_ops *rate_ops, struct clk_hw *gate_hw,

                                         const struct clk_ops *gate_ops, unsigned long flags);

void clk_unregister_composite(struct clk *clk);

struct clk_hw *clk_hw_register_composite(struct device *dev, const char *name, const char *const *parent_names,

                                         int num_parents, struct clk_hw *mux_hw, const struct clk_ops *mux_ops,

                                         struct clk_hw *rate_hw, const struct clk_ops *rate_ops, struct clk_hw *gate_hw,

                                         const struct clk_ops *gate_ops, unsigned long flags);

struct clk_hw *clk_hw_register_composite_pdata(struct device *dev, const char *name,

                                               const struct clk_parent_data *parent_data, int num_parents,

                                               struct clk_hw *mux_hw, const struct clk_ops *mux_ops,

                                               struct clk_hw *rate_hw, const struct clk_ops *rate_ops,

                                               struct clk_hw *gate_hw, const struct clk_ops *gate_ops,

                                               unsigned long flags);

void clk_hw_unregister_composite(struct clk_hw *hw);



struct clk *clk_register(struct device *dev, struct clk_hw *hw);

struct clk *devm_clk_register(struct device *dev, struct clk_hw *hw);



int __must_check clk_hw_register(struct device *dev, struct clk_hw *hw);

int __must_check devm_clk_hw_register(struct device *dev, struct clk_hw *hw);

int __must_check of_clk_hw_register(struct device_node *node, struct clk_hw *hw);



void clk_unregister(struct clk *clk);

void devm_clk_unregister(struct device *dev, struct clk *clk);



void clk_hw_unregister(struct clk_hw *hw);

void devm_clk_hw_unregister(struct device *dev, struct clk_hw *hw);



/* helper functions */

const char *__clk_get_name(const struct clk *clk);

const char *clk_hw_get_name(const struct clk_hw *hw);

#ifdef CONFIG_COMMON_CLK

struct clk_hw *__clk_get_hw(struct clk *clk);

#else

static inline struct clk_hw *__clk_get_hw(struct clk *clk)

{

    return (struct clk_hw *)clk;

}

#endif

unsigned int clk_hw_get_num_parents(const struct clk_hw *hw);

struct clk_hw *clk_hw_get_parent(const struct clk_hw *hw);

struct clk_hw *clk_hw_get_parent_by_index(const struct clk_hw *hw, unsigned int index);

int clk_hw_get_parent_index(struct clk_hw *hw);

int clk_hw_set_parent(struct clk_hw *hw, struct clk_hw *new_parent);

unsigned int __clk_get_enable_count(struct clk *clk);

unsigned long clk_hw_get_rate(const struct clk_hw *hw);

unsigned long clk_hw_get_flags(const struct clk_hw *hw);

#define clk_hw_can_set_rate_parent(hw) (clk_hw_get_flags((hw)) & CLK_SET_RATE_PARENT)



bool clk_hw_is_prepared(const struct clk_hw *hw);

bool clk_hw_rate_is_protected(const struct clk_hw *hw);

bool clk_hw_is_enabled(const struct clk_hw *hw);

bool __clk_is_enabled(struct clk *clk);

struct clk *__clk_lookup(const char *name);

int __clk_mux_determine_rate(struct clk_hw *hw, struct clk_rate_request *req);

int __clk_determine_rate(struct clk_hw *core, struct clk_rate_request *req);

int __clk_mux_determine_rate_closest(struct clk_hw *hw, struct clk_rate_request *req);

int clk_mux_determine_rate_flags(struct clk_hw *hw, struct clk_rate_request *req, unsigned long flags);

void clk_hw_reparent(struct clk_hw *hw, struct clk_hw *new_parent);

void clk_hw_set_rate_range(struct clk_hw *hw, unsigned long min_rate, unsigned long max_rate);



static inline void __clk_hw_set_clk(struct clk_hw *dst, struct clk_hw *src)

{

    dst->clk = src->clk;

    dst->core = src->core;

}



static inline long divider_round_rate(struct clk_hw *hw, unsigned long rate, unsigned long *prate,

                                      const struct clk_div_table *table, u8 width, unsigned long flags)

{

    return divider_round_rate_parent(hw, clk_hw_get_parent(hw), rate, prate, table, width, flags);

}



static inline long divider_ro_round_rate(struct clk_hw *hw, unsigned long rate, unsigned long *prate,

                                         const struct clk_div_table *table, u8 width, unsigned long flags,

                                         unsigned int val)

{

    return divider_ro_round_rate_parent(hw, clk_hw_get_parent(hw), rate, prate, table, width, flags, val);

}



/*

 * clock api without lock protection

 */

unsigned long clk_hw_round_rate(struct clk_hw *hw, unsigned long rate);



struct clk_onecell_data {

    struct clk **clks;

    unsigned int clk_num;

};



struct clk_hw_onecell_data {

    unsigned int num;

    struct clk_hw *hws[];

};



#define CLK_OF_DECLARE(name, compat, fn) OF_DECLARE_1(clk, name, compat, fn)



/*

 * Use this macro when you have a driver that requires two initialization

 * routines, one at of_clk_init(), and one at platform device probe

 */

#define CLK_OF_DECLARE_DRIVER(name, compat, fn)                                                                        \

    static void __init name##_of_clk_init_driver(struct device_node *np)                                               \

    {                                                                                                                  \

        of_node_clear_flag(np, OF_POPULATED);                                                                          \

        fn(np);                                                                                                        \

    }                                                                                                                  \

    OF_DECLARE_1(clk, name, compat, name##_of_clk_init_driver)



#define CLK_HW_INIT(_name, _parent, _ops, _flags)                                                                      \

    (&(struct clk_init_data) {                                                                                         \

        .flags = (_flags),                                                                                             \

        .name = (_name),                                                                                               \

        .parent_names = (const char *[]) {_parent},                                                                    \

        .num_parents = 1,                                                                                              \

        .ops = (_ops),                                                                                                 \

    })



#define CLK_HW_INIT_HW(_name, _parent, _ops, _flags)                                                                   \

    (&(struct clk_init_data) {                                                                                         \

        .flags = (_flags),                                                                                             \

        .name = (_name),                                                                                               \

        .parent_hws = (const struct clk_hw *[]) {_parent},                                                             \

        .num_parents = 1,                                                                                              \

        .ops = (_ops),                                                                                                 \

    })



/*

 * This macro is intended for drivers to be able to share the otherwise

 * individual struct clk_hw[] compound literals created by the compiler

 * when using CLK_HW_INIT_HW. It does NOT support multiple parents.

 */

#define CLK_HW_INIT_HWS(_name, _parent, _ops, _flags)                                                                  \

    (&(struct clk_init_data) {                                                                                         \

        .flags = (_flags),                                                                                             \

        .name = (_name),                                                                                               \

        .parent_hws = (_parent),                                                                                       \

        .num_parents = 1,                                                                                              \

        .ops = (_ops),                                                                                                 \

    })



#define CLK_HW_INIT_FW_NAME(_name, _parent, _ops, _flags)                                                              \

    (&(struct clk_init_data) {                                                                                         \

        .flags = (_flags),                                                                                             \

        .name = (_name),                                                                                               \

        .parent_data =                                                                                                 \

            (const struct clk_parent_data[]) {                                                                         \

                {.fw_name = _parent},                                                                                  \

            },                                                                                                         \

        .num_parents = 1,                                                                                              \

        .ops = (_ops),                                                                                                 \

    })



#define CLK_HW_INIT_PARENTS(_name, _parents, _ops, _flags)                                                             \

    (&(struct clk_init_data) {                                                                                         \

        .flags = (_flags),                                                                                             \

        .name = (_name),                                                                                               \

        .parent_names = (_parents),                                                                                    \

        .num_parents = ARRAY_SIZE(_parents),                                                                           \

        .ops = (_ops),                                                                                                 \

    })



#define CLK_HW_INIT_PARENTS_HW(_name, _parents, _ops, _flags)                                                          \

    (&(struct clk_init_data) {                                                                                         \

        .flags = (_flags),                                                                                             \

        .name = (_name),                                                                                               \

        .parent_hws = (_parents),                                                                                      \

        .num_parents = ARRAY_SIZE(_parents),                                                                           \

        .ops = (_ops),                                                                                                 \

    })



#define CLK_HW_INIT_PARENTS_DATA(_name, _parents, _ops, _flags)                                                        \

    (&(struct clk_init_data) {                                                                                         \

        .flags = (_flags),                                                                                             \

        .name = (_name),                                                                                               \

        .parent_data = (_parents),                                                                                     \

        .num_parents = ARRAY_SIZE(_parents),                                                                           \

        .ops = (_ops),                                                                                                 \

    })



#define CLK_HW_INIT_NO_PARENT(_name, _ops, _flags)                                                                     \

    (&(struct clk_init_data) {                                                                                         \

        .flags = (_flags),                                                                                             \

        .name = (_name),                                                                                               \

        .parent_names = NULL,                                                                                          \

        .num_parents = 0,                                                                                              \

        .ops = (_ops),                                                                                                 \

    })



#define CLK_FIXED_FACTOR(_struct, _name, _parent, _div, _mult, _flags)                                                 \

    struct clk_fixed_factor _struct = {                                                                                \

        .div = (_div),                                                                                                 \

        .mult = (_mult),                                                                                               \

        .hw.init = CLK_HW_INIT(_name, _parent, &clk_fixed_factor_ops, _flags),                                         \

    }



#define CLK_FIXED_FACTOR_HW(_struct, _name, _parent, _div, _mult, _flags)                                              \

    struct clk_fixed_factor _struct = {                                                                                \

        .div = (_div),                                                                                                 \

        .mult = _mult,                                                                                                 \

        .hw.init = CLK_HW_INIT_HW(_name, _parent, &clk_fixed_factor_ops, _flags),                                      \

    }



/*

 * This macro allows the driver to reuse the _parent array for multiple

 * fixed factor clk declarations.

 */

#define CLK_FIXED_FACTOR_HWS(_struct, _name, _parent, _div, _mult, _flags)                                             \

    struct clk_fixed_factor _struct = {                                                                                \

        .div = (_div),                                                                                                 \

        .mult = (_mult),                                                                                               \

        .hw.init = CLK_HW_INIT_HWS(_name, _parent, &clk_fixed_factor_ops, _flags),                                     \

    }



#define CLK_FIXED_FACTOR_FW_NAME(_struct, _name, _parent, _div, _mult, _flags)                                         \

    struct clk_fixed_factor _struct = {                                                                                \

        .div = (_div),                                                                                                 \

        .mult = (_mult),                                                                                               \

        .hw.init = CLK_HW_INIT_FW_NAME(_name, _parent, &clk_fixed_factor_ops, _flags),                                 \

    }



#ifdef CONFIG_OF

int of_clk_add_provider(struct device_node *np, struct clk *(*clk_src_get)(struct of_phandle_args *args, void *data),

                        void *data);

int of_clk_add_hw_provider(struct device_node *np, struct clk_hw *(*get)(struct of_phandle_args *clkspec, void *data),

                           void *data);

int devm_of_clk_add_hw_provider(struct device *dev, struct clk_hw *(*get)(struct of_phandle_args *clkspec, void *data),

                                void *data);

void of_clk_del_provider(struct device_node *np);

void devm_of_clk_del_provider(struct device *dev);

struct clk *of_clk_src_simple_get(struct of_phandle_args *clkspec, void *data);

struct clk_hw *of_clk_hw_simple_get(struct of_phandle_args *clkspec, void *data);

struct clk *of_clk_src_onecell_get(struct of_phandle_args *clkspec, void *data);

struct clk_hw *of_clk_hw_onecell_get(struct of_phandle_args *clkspec, void *data);

int of_clk_parent_fill(struct device_node *np, const char **parents, unsigned int size);

int of_clk_detect_critical(struct device_node *np, int index, unsigned long *flags);



#else  /* !CONFIG_OF */



static inline int of_clk_add_provider(struct device_node *np,

                                      struct clk *(*clk_src_get)(struct of_phandle_args *args, void *data), void *data)

{

    return 0;

}

static inline int of_clk_add_hw_provider(struct device_node *np,

                                         struct clk_hw *(*get)(struct of_phandle_args *clkspec, void *data), void *data)

{

    return 0;

}

static inline int devm_of_clk_add_hw_provider(struct device *dev,

                                              struct clk_hw *(*get)(struct of_phandle_args *clkspec, void *data),

                                              void *data)

{

    return 0;

}

static inline void of_clk_del_provider(struct device_node *np)

{

}

static inline void devm_of_clk_del_provider(struct device *dev)

{

}

static inline struct clk *of_clk_src_simple_get(struct of_phandle_args *clkspec, void *data)

{

    return ERR_PTR(-ENOENT);

}

static inline struct clk_hw *of_clk_hw_simple_get(struct of_phandle_args *clkspec, void *data)

{

    return ERR_PTR(-ENOENT);

}

static inline struct clk *of_clk_src_onecell_get(struct of_phandle_args *clkspec, void *data)

{

    return ERR_PTR(-ENOENT);

}

static inline struct clk_hw *of_clk_hw_onecell_get(struct of_phandle_args *clkspec, void *data)

{

    return ERR_PTR(-ENOENT);

}

static inline int of_clk_parent_fill(struct device_node *np, const char **parents, unsigned int size)

{

    return 0;

}

static inline int of_clk_detect_critical(struct device_node *np, int index, unsigned long *flags)

{

    return 0;

}

#endif /* CONFIG_OF */



void clk_gate_restore_context(struct clk_hw *hw);



#endif /* CLK_PROVIDER_H */