Hi!
Looks good, I think. I have some nits, but nothing major...
On 2021-11-30 13:18, Aswath Govindraju wrote:
> In some cases, we might need to provide the state of the mux to be set for
> the operation of a given peripheral. Therefore, pass this information using
> mux-states property.
>
> Signed-off-by: Aswath Govindraju <a-govindraju@xxxxxx>
> ---
> drivers/mux/core.c | 213 +++++++++++++++++++++++++++++++----
> include/linux/mux/consumer.h | 19 +++-
> 2 files changed, 212 insertions(+), 20 deletions(-)
>
> diff --git a/drivers/mux/core.c b/drivers/mux/core.c
> index 22f4709768d1..38869c3680a8 100644
> --- a/drivers/mux/core.c
> +++ b/drivers/mux/core.c
> @@ -29,6 +29,19 @@
> */
> #define MUX_CACHE_UNKNOWN MUX_IDLE_AS_IS
>
> +/**
> + * struct mux_state - Represents a mux controller specific to a given device
> + * @mux: Pointer to a mux controller
> + * @state State of the mux to be set
> + *
> + * This structure is specific to a device that acquires it and has information
> + * specific to the device.
> + */
> +struct mux_state {
> + struct mux_control *mux;
> + unsigned int state;
> +};
> +
> static struct class mux_class = {
> .name = "mux",
> .owner = THIS_MODULE,
> @@ -370,6 +383,30 @@ int mux_control_select_delay(struct mux_control *mux, unsigned int state,
> }
> EXPORT_SYMBOL_GPL(mux_control_select_delay);
>
> +/**
> + * mux_state_select_delay() - Select mux-state
> + * @mux: The mux-state to select
@mstate
> + * @delay_us: The time to delay (in microseconds) if the mux control
> + * changes state on select
> + *
> + * On successfully selecting the mux-state, it will be locked until
> + * there is a call to mux_state_deselect(). If the mux-control is already
> + * selected when mux_state_select() is called, the caller will be blocked
> + * until mux_state_deselect() is called (by someone else).
If the other consumer has the whole mux control, that consumer will
deselect with mux_control_deselect() (i.e. not mux_state_deselect()).
> + *
> + * Therefore, make sure to call mux_state_deselect() when the operation is
> + * complete and the mux-control is free for others to use, but do not call
> + * mux_state_deselect() if mux_state_select() fails.
> + *
> + * Return: 0 when the mux-state has been selected or a negative
> + * errno on error.
> + */
> +int mux_state_select_delay(struct mux_state *mstate, unsigned int delay_us)
> +{
> + return mux_control_select_delay(mstate->mux, mstate->state, delay_us);
> +}
> +EXPORT_SYMBOL_GPL(mux_state_select_delay);
> +
> /**
> * mux_control_try_select_delay() - Try to select the given multiplexer state.
> * @mux: The mux-control to request a change of state from.
> @@ -405,6 +442,27 @@ int mux_control_try_select_delay(struct mux_control *mux, unsigned int state,
> }
> EXPORT_SYMBOL_GPL(mux_control_try_select_delay);
>
> +/**
> + * mux_state_try_select_delay() - Try to select the mux-state.
> + * @mux: The mux-state to select
@mstate
> + * @delay_us: The time to delay (in microseconds) if the mux state is changed.
> + *
> + * On successfully selecting the mux-state, it will be locked until
> + * mux_state_deselect() called.
> + *
> + * Therefore, make sure to call mux_state_deselect() when the operation is
> + * complete and the mux-control is free for others to use, but do not call
> + * mux_state_deselect() if mux_state_try_select() fails.
> + *
> + * Return: 0 when the mux-control state has the requested state or a negative
* Return: 0 when the mux-state has been selected or a negative
> + * errno on error. Specifically -EBUSY if the mux-control is contended.
> + */
> +int mux_state_try_select_delay(struct mux_state *mstate, unsigned int delay_us)
> +{
> + return mux_control_try_select_delay(mstate->mux, mstate->state, delay_us);
> +}
> +EXPORT_SYMBOL_GPL(mux_state_try_select_delay);
> +
> /**
> * mux_control_deselect() - Deselect the previously selected multiplexer state.
> * @mux: The mux-control to deselect.
> @@ -431,6 +489,24 @@ int mux_control_deselect(struct mux_control *mux)
> }
> EXPORT_SYMBOL_GPL(mux_control_deselect);
>
> +/**
> + * mux_state_deselect() - Deselect the previously selected multiplexer state.
> + * @mux: The mux-state to deselect.
@mstate
> + *
> + * It is required that a single call is made to mux_state_deselect() for
> + * each and every successful call made to either of mux_state_select() or
> + * mux_state_try_select().
> + *
> + * Return: 0 on success and a negative errno on error. An error can only
> + * occur if the mux has an idle state. Note that even if an error occurs, the
> + * mux-control is unlocked and is thus free for the next access.
> + */
> +int mux_state_deselect(struct mux_state *mstate)
> +{
> + return mux_control_deselect(mstate->mux);
> +}
> +EXPORT_SYMBOL_GPL(mux_state_deselect);
> +
> /* Note this function returns a reference to the mux_chip dev. */
> static struct mux_chip *of_find_mux_chip_by_node(struct device_node *np)
> {
> @@ -442,13 +518,15 @@ static struct mux_chip *of_find_mux_chip_by_node(struct device_node *np)
> }
>
> /**
I think this should be an ordinary comment now that this function is refactored
into a static helper, so just go with a plain old /* instead of /**
> - * mux_control_get() - Get the mux-control for a device.
> + * mux_get() - Get the mux-control for a device.
> * @dev: The device that needs a mux-control.
> * @mux_name: The name identifying the mux-control.
> + * @state: The variable to store the enable state for the requested device
* @state: Pointer to where the requested state is returned, or NULL when the
required multiplexer states are handled by other means.
> *
> * Return: A pointer to the mux-control, or an ERR_PTR with a negative errno.
> */
> -struct mux_control *mux_control_get(struct device *dev, const char *mux_name)
> +static struct mux_control *mux_get(struct device *dev, const char *mux_name,
> + unsigned int *state)
> {
> struct device_node *np = dev->of_node;
> struct of_phandle_args args;
> @@ -458,8 +536,12 @@ struct mux_control *mux_control_get(struct device *dev, const char *mux_name)
> int ret;
>
> if (mux_name) {
> - index = of_property_match_string(np, "mux-control-names",
> - mux_name);
> + if (state)
> + index = of_property_match_string(np, "mux-state-names",
> + mux_name);
> + else
> + index = of_property_match_string(np, "mux-control-names",
> + mux_name);
> if (index < 0) {
> dev_err(dev, "mux controller '%s' not found\n",
> mux_name);
> @@ -467,12 +549,17 @@ struct mux_control *mux_control_get(struct device *dev, const char *mux_name)
> }
> }
>
> - ret = of_parse_phandle_with_args(np,
> - "mux-controls", "#mux-control-cells",
> - index, &args);
> + if (state)
> + ret = of_parse_phandle_with_args(np,
> + "mux-states", "#mux-state-cells",
> + index, &args);
> + else
> + ret = of_parse_phandle_with_args(np,
> + "mux-controls", "#mux-control-cells",
> + index, &args);
> if (ret) {
> - dev_err(dev, "%pOF: failed to get mux-control %s(%i)\n",
> - np, mux_name ?: "", index);
> + dev_err(dev, "%pOF: failed to get mux-%s %s(%i)\n",
> + np, state ? "state" : "control", mux_name ?: "", index);
> return ERR_PTR(ret);
> }
>
> @@ -481,17 +568,35 @@ struct mux_control *mux_control_get(struct device *dev, const char *mux_name)
> if (!mux_chip)
> return ERR_PTR(-EPROBE_DEFER);
>
> - if (args.args_count > 1 ||
> - (!args.args_count && (mux_chip->controllers > 1))) {
> - dev_err(dev, "%pOF: wrong #mux-control-cells for %pOF\n",
> - np, args.np);
> - put_device(&mux_chip->dev);
> - return ERR_PTR(-EINVAL);
> - }
> -
> controller = 0;
> - if (args.args_count)
> - controller = args.args[0];
> + if (state) {
> + if (args.args_count > 2 || args.args_count == 0 ||
> + (args.args_count < 2 && mux_chip->controllers > 1)) {
> + dev_err(dev, "%pOF: wrong #mux-state-cells for %pOF\n",
> + np, args.np);
> + put_device(&mux_chip->dev);
> + return ERR_PTR(-EINVAL);
> + }
> +
> + if (args.args_count == 2) {
> + controller = args.args[0];
> + *state = args.args[1];
> + } else {
> + *state = args.args[0];
> + }
> +
> + } else {
> + if (args.args_count > 1 ||
> + (!args.args_count && mux_chip->controllers > 1)) {
> + dev_err(dev, "%pOF: wrong #mux-control-cells for %pOF\n",
> + np, args.np);
> + put_device(&mux_chip->dev);
> + return ERR_PTR(-EINVAL);
> + }
> +
> + if (args.args_count)
> + controller = args.args[0];
> + }
>
> if (controller >= mux_chip->controllers) {
> dev_err(dev, "%pOF: bad mux controller %u specified in %pOF\n",
> @@ -502,6 +607,18 @@ struct mux_control *mux_control_get(struct device *dev, const char *mux_name)
>
> return &mux_chip->mux[controller];
> }
> +
> +/**
> + * mux_control_get() - Get the mux-control for a device.
> + * @dev: The device that needs a mux-control.
> + * @mux_name: The name identifying the mux-control.
> + *
> + * Return: A pointer to the mux-control, or an ERR_PTR with a negative errno.
> + */
> +struct mux_control *mux_control_get(struct device *dev, const char *mux_name)
> +{
> + return mux_get(dev, mux_name, NULL);
> +}
> EXPORT_SYMBOL_GPL(mux_control_get);
>
> /**
> @@ -523,6 +640,26 @@ static void devm_mux_control_release(struct device *dev, void *res)
> mux_control_put(mux);
> }
>
> +/**
> + * mux_state_put() - Put away the mux-state for good.
> + * @mux: The mux-state to put away.
@mstate
Cheers,
Peter
> + *
> + * mux_control_put() reverses the effects of mux_control_get().
> + */
> +void mux_state_put(struct mux_state *mstate)
> +{
> + mux_control_put(mstate->mux);
> + kfree(mstate);
> +}
> +EXPORT_SYMBOL_GPL(mux_state_put);
> +
> +static void devm_mux_state_release(struct device *dev, void *res)
> +{
> + struct mux_state *mstate = *(struct mux_state **)res;
> +
> + mux_state_put(mstate);
> +}
> +
> /**
> * devm_mux_control_get() - Get the mux-control for a device, with resource
> * management.
> @@ -553,6 +690,44 @@ struct mux_control *devm_mux_control_get(struct device *dev,
> }
> EXPORT_SYMBOL_GPL(devm_mux_control_get);
>
> +/**
> + * devm_mux_state_get() - Get the mux-state for a device, with resource
> + * management.
> + * @dev: The device that needs a mux-control.
> + * @mux_name: The name identifying the mux-control.
> + *
> + * Return: Pointer to the mux-state, or an ERR_PTR with a negative errno.
> + */
> +struct mux_state *devm_mux_state_get(struct device *dev,
> + const char *mux_name)
> +{
> + struct mux_state **ptr, *mstate;
> + struct mux_control *mux_ctrl;
> + int state;
> +
> + mstate = devm_kzalloc(dev, sizeof(struct mux_state), GFP_KERNEL);
> + if (!mstate)
> + return ERR_PTR(-ENOMEM);
> +
> + ptr = devres_alloc(devm_mux_state_release, sizeof(*ptr), GFP_KERNEL);
> + if (!ptr)
> + return ERR_PTR(-ENOMEM);
> +
> + mux_ctrl = mux_get(dev, mux_name, &state);
> + if (IS_ERR(mux_ctrl)) {
> + devres_free(ptr);
> + return (struct mux_state *)mux_ctrl;
> + }
> +
> + mstate->mux = mux_ctrl;
> + mstate->state = state;
> + *ptr = mstate;
> + devres_add(dev, ptr);
> +
> + return mstate;
> +}
> +EXPORT_SYMBOL_GPL(devm_mux_state_get);
> +
> /*
> * Using subsys_initcall instead of module_init here to try to ensure - for
> * the non-modular case - that the subsystem is initialized when mux consumers
> diff --git a/include/linux/mux/consumer.h b/include/linux/mux/consumer.h
> index 7a09b040ac39..bf5abf062c21 100644
> --- a/include/linux/mux/consumer.h
> +++ b/include/linux/mux/consumer.h
> @@ -14,33 +14,50 @@
>
> struct device;
> struct mux_control;
> +struct mux_state;
>
> unsigned int mux_control_states(struct mux_control *mux);
> int __must_check mux_control_select_delay(struct mux_control *mux,
> unsigned int state,
> unsigned int delay_us);
> +int __must_check mux_state_select_delay(struct mux_state *mstate,
> + unsigned int delay_us);
> int __must_check mux_control_try_select_delay(struct mux_control *mux,
> unsigned int state,
> unsigned int delay_us);
> -
> +int __must_check mux_state_try_select_delay(struct mux_state *mstate,
> + unsigned int delay_us);
> static inline int __must_check mux_control_select(struct mux_control *mux,
> unsigned int state)
> {
> return mux_control_select_delay(mux, state, 0);
> }
>
> +static inline int __must_check mux_state_select(struct mux_state *mstate)
> +{
> + return mux_state_select_delay(mstate, 0);
> +}
> static inline int __must_check mux_control_try_select(struct mux_control *mux,
> unsigned int state)
> {
> return mux_control_try_select_delay(mux, state, 0);
> }
>
> +static inline int __must_check mux_state_try_select(struct mux_state *mstate)
> +{
> + return mux_state_try_select_delay(mstate, 0);
> +}
> +
> int mux_control_deselect(struct mux_control *mux);
> +int mux_state_deselect(struct mux_state *mstate);
>
> struct mux_control *mux_control_get(struct device *dev, const char *mux_name);
> void mux_control_put(struct mux_control *mux);
> +void mux_state_put(struct mux_state *mstate);
>
> struct mux_control *devm_mux_control_get(struct device *dev,
> const char *mux_name);
> +struct mux_state *devm_mux_state_get(struct device *dev,
> + const char *mux_name);
>
> #endif /* _LINUX_MUX_CONSUMER_H */
>
