From: Alex Elder <elder@linaro.org>
To: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>,
mhi@lists.linux.dev
Cc: quic_hemantk@quicinc.com, quic_bbhatt@quicinc.com,
quic_jhugo@quicinc.com, vinod.koul@linaro.org,
bjorn.andersson@linaro.org, dmitry.baryshkov@linaro.org,
quic_vbadigan@quicinc.com, quic_cang@quicinc.com,
quic_skananth@quicinc.com, linux-arm-msm@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH v4 16/27] bus: mhi: ep: Add support for managing MHI state machine
Date: Mon, 28 Feb 2022 10:41:35 -0600 [thread overview]
Message-ID: <043bd7c6-97af-26ae-78fa-8b22b0e5606d@linaro.org> (raw)
In-Reply-To: <20220228124344.77359-17-manivannan.sadhasivam@linaro.org>
On 2/28/22 6:43 AM, Manivannan Sadhasivam wrote:
> Add support for managing the MHI state machine by controlling the state
> transitions. Only the following MHI state transitions are supported:
>
> 1. Ready state
> 2. M0 state
> 3. M3 state
> 4. SYS_ERR state
>
> Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
Some minor comments below, but otherwise:
Reviewed-by: Alex Elder <elder@linaro.org.
> ---
> drivers/bus/mhi/ep/Makefile | 2 +-
> drivers/bus/mhi/ep/internal.h | 11 +++
> drivers/bus/mhi/ep/main.c | 54 +++++++++++++-
> drivers/bus/mhi/ep/sm.c | 136 ++++++++++++++++++++++++++++++++++
> include/linux/mhi_ep.h | 12 +++
> 5 files changed, 213 insertions(+), 2 deletions(-)
> create mode 100644 drivers/bus/mhi/ep/sm.c
>
> diff --git a/drivers/bus/mhi/ep/Makefile b/drivers/bus/mhi/ep/Makefile
> index 7ba0e04801eb..aad85f180b70 100644
> --- a/drivers/bus/mhi/ep/Makefile
> +++ b/drivers/bus/mhi/ep/Makefile
> @@ -1,2 +1,2 @@
> obj-$(CONFIG_MHI_BUS_EP) += mhi_ep.o
> -mhi_ep-y := main.o mmio.o ring.o
> +mhi_ep-y := main.o mmio.o ring.o sm.o
> diff --git a/drivers/bus/mhi/ep/internal.h b/drivers/bus/mhi/ep/internal.h
> index 8753ae93eda3..536351218685 100644
> --- a/drivers/bus/mhi/ep/internal.h
> +++ b/drivers/bus/mhi/ep/internal.h
> @@ -144,6 +144,11 @@ struct mhi_ep_event {
> struct mhi_ep_ring ring;
> };
>
> +struct mhi_ep_state_transition {
> + struct list_head node;
> + enum mhi_state state;
> +};
> +
> struct mhi_ep_chan {
> char *name;
> struct mhi_ep_device *mhi_dev;
> @@ -198,5 +203,11 @@ void mhi_ep_mmio_update_ner(struct mhi_ep_cntrl *mhi_cntrl);
> /* MHI EP core functions */
> int mhi_ep_send_state_change_event(struct mhi_ep_cntrl *mhi_cntrl, enum mhi_state state);
> int mhi_ep_send_ee_event(struct mhi_ep_cntrl *mhi_cntrl, enum mhi_ee_type exec_env);
> +bool mhi_ep_check_mhi_state(struct mhi_ep_cntrl *mhi_cntrl, enum mhi_state cur_mhi_state,
> + enum mhi_state mhi_state);
> +int mhi_ep_set_mhi_state(struct mhi_ep_cntrl *mhi_cntrl, enum mhi_state mhi_state);
> +int mhi_ep_set_m0_state(struct mhi_ep_cntrl *mhi_cntrl);
> +int mhi_ep_set_m3_state(struct mhi_ep_cntrl *mhi_cntrl);
> +int mhi_ep_set_ready_state(struct mhi_ep_cntrl *mhi_cntrl);
>
> #endif
> diff --git a/drivers/bus/mhi/ep/main.c b/drivers/bus/mhi/ep/main.c
> index 903f9bd3e03d..7a29543586d0 100644
> --- a/drivers/bus/mhi/ep/main.c
> +++ b/drivers/bus/mhi/ep/main.c
> @@ -106,6 +106,43 @@ static int mhi_ep_send_cmd_comp_event(struct mhi_ep_cntrl *mhi_cntrl, enum mhi_e
> return mhi_ep_send_event(mhi_cntrl, 0, &event, 0);
> }
>
> +static void mhi_ep_state_worker(struct work_struct *work)
> +{
> + struct mhi_ep_cntrl *mhi_cntrl = container_of(work, struct mhi_ep_cntrl, state_work);
> + struct device *dev = &mhi_cntrl->mhi_dev->dev;
> + struct mhi_ep_state_transition *itr, *tmp;
> + unsigned long flags;
> + LIST_HEAD(head);
> + int ret;
> +
> + spin_lock_irqsave(&mhi_cntrl->list_lock, flags);
> + list_splice_tail_init(&mhi_cntrl->st_transition_list, &head);
> + spin_unlock_irqrestore(&mhi_cntrl->list_lock, flags);
> +
> + list_for_each_entry_safe(itr, tmp, &head, node) {
> + list_del(&itr->node);
> + dev_dbg(dev, "Handling MHI state transition to %s\n",
> + mhi_state_str(itr->state));
> +
> + switch (itr->state) {
> + case MHI_STATE_M0:
> + ret = mhi_ep_set_m0_state(mhi_cntrl);
> + if (ret)
> + dev_err(dev, "Failed to transition to M0 state\n");
> + break;
> + case MHI_STATE_M3:
> + ret = mhi_ep_set_m3_state(mhi_cntrl);
> + if (ret)
> + dev_err(dev, "Failed to transition to M3 state\n");
> + break;
> + default:
> + dev_err(dev, "Invalid MHI state transition: %d\n", itr->state);
> + break;
> + }
> + kfree(itr);
> + }
> +}
> +
> static void mhi_ep_release_device(struct device *dev)
> {
> struct mhi_ep_device *mhi_dev = to_mhi_ep_device(dev);
> @@ -315,6 +352,17 @@ int mhi_ep_register_controller(struct mhi_ep_cntrl *mhi_cntrl,
> goto err_free_ch;
> }
>
> + INIT_WORK(&mhi_cntrl->state_work, mhi_ep_state_worker);
> +
> + mhi_cntrl->wq = alloc_workqueue("mhi_ep_wq", 0, 0);
> + if (!mhi_cntrl->wq) {
> + ret = -ENOMEM;
> + goto err_free_cmd;
> + }
> +
> + INIT_LIST_HEAD(&mhi_cntrl->st_transition_list);
> + spin_lock_init(&mhi_cntrl->state_lock);
> + spin_lock_init(&mhi_cntrl->list_lock);
> mutex_init(&mhi_cntrl->event_lock);
>
> /* Set MHI version and AMSS EE before enumeration */
> @@ -325,7 +373,7 @@ int mhi_ep_register_controller(struct mhi_ep_cntrl *mhi_cntrl,
> mhi_cntrl->index = ida_alloc(&mhi_ep_cntrl_ida, GFP_KERNEL);
> if (mhi_cntrl->index < 0) {
> ret = mhi_cntrl->index;
> - goto err_free_cmd;
> + goto err_destroy_wq;
> }
>
> /* Allocate the controller device */
> @@ -352,6 +400,8 @@ int mhi_ep_register_controller(struct mhi_ep_cntrl *mhi_cntrl,
> put_device(&mhi_dev->dev);
> err_ida_free:
> ida_free(&mhi_ep_cntrl_ida, mhi_cntrl->index);
> +err_destroy_wq:
> + destroy_workqueue(mhi_cntrl->wq);
> err_free_cmd:
> kfree(mhi_cntrl->mhi_cmd);
> err_free_ch:
> @@ -365,6 +415,8 @@ void mhi_ep_unregister_controller(struct mhi_ep_cntrl *mhi_cntrl)
> {
> struct mhi_ep_device *mhi_dev = mhi_cntrl->mhi_dev;
>
> + destroy_workqueue(mhi_cntrl->wq);
> +
> kfree(mhi_cntrl->mhi_cmd);
> kfree(mhi_cntrl->mhi_chan);
>
> diff --git a/drivers/bus/mhi/ep/sm.c b/drivers/bus/mhi/ep/sm.c
> new file mode 100644
> index 000000000000..ad49276ec044
> --- /dev/null
> +++ b/drivers/bus/mhi/ep/sm.c
> @@ -0,0 +1,136 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * Copyright (C) 2022 Linaro Ltd.
> + * Author: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
> + */
> +
> +#include <linux/errno.h>
> +#include <linux/mhi_ep.h>
> +#include "internal.h"
> +
> +bool __must_check mhi_ep_check_mhi_state(struct mhi_ep_cntrl *mhi_cntrl,
> + enum mhi_state cur_mhi_state,
> + enum mhi_state mhi_state)
> +{
> + if (mhi_state == MHI_STATE_SYS_ERR)
> + return true; /* Allowed in any state */
> +
> + if (mhi_state == MHI_STATE_READY)
> + return cur_mhi_state == MHI_STATE_RESET;
> +
> + if (mhi_state == MHI_STATE_M0)
> + return (cur_mhi_state == MHI_STATE_M3 || cur_mhi_state == MHI_STATE_READY);
Parentheses not required here.
> +
> + if (mhi_state == MHI_STATE_M3)
> + return cur_mhi_state == MHI_STATE_M0;
> +
> + return false;
> +}
> +
> +int mhi_ep_set_mhi_state(struct mhi_ep_cntrl *mhi_cntrl, enum mhi_state mhi_state)
> +{
> + struct device *dev = &mhi_cntrl->mhi_dev->dev;
> +
> + if (!mhi_ep_check_mhi_state(mhi_cntrl, mhi_cntrl->mhi_state, mhi_state)) {
> + dev_err(dev, "MHI state change to %s from %s is not allowed!\n",
> + mhi_state_str(mhi_state),
> + mhi_state_str(mhi_cntrl->mhi_state));
> + return -EACCES;
> + }
> +
> + /* TODO */
What is TODO here? It probably doesn't belong, but if you're going
to keep it, at least say what's expected...
> + if (mhi_state == MHI_STATE_M1 || mhi_state == MHI_STATE_M2) {
> + dev_err(dev, "MHI state (%s) not supported\n", mhi_state_str(mhi_state));
> + return -EOPNOTSUPP;
> + }
> +
> + mhi_ep_mmio_masked_write(mhi_cntrl, EP_MHISTATUS, MHISTATUS_MHISTATE_MASK, mhi_state);
> + mhi_cntrl->mhi_state = mhi_state;
> +
> + if (mhi_state == MHI_STATE_READY)
> + mhi_ep_mmio_masked_write(mhi_cntrl, EP_MHISTATUS, MHISTATUS_READY_MASK, 1);
> +
> + if (mhi_state == MHI_STATE_SYS_ERR)
> + mhi_ep_mmio_masked_write(mhi_cntrl, EP_MHISTATUS, MHISTATUS_SYSERR_MASK, 1);
> +
> + return 0;
> +}
> +
> +int mhi_ep_set_m0_state(struct mhi_ep_cntrl *mhi_cntrl)
> +{
> + struct device *dev = &mhi_cntrl->mhi_dev->dev;
> + enum mhi_state old_state;
> + int ret;
> +
> + spin_lock_bh(&mhi_cntrl->state_lock);
> + old_state = mhi_cntrl->mhi_state;
> +
> + ret = mhi_ep_set_mhi_state(mhi_cntrl, MHI_STATE_M0);
> + spin_unlock_bh(&mhi_cntrl->state_lock);
> +
> + if (ret)
> + return ret;
> +
> + /* Signal host that the device moved to M0 */
> + ret = mhi_ep_send_state_change_event(mhi_cntrl, MHI_STATE_M0);
> + if (ret) {
> + dev_err(dev, "Failed sending M0 state change event\n");
> + return ret;
> + }
> +
> + if (old_state == MHI_STATE_READY) {
> + /* Send AMSS EE event to host */
> + ret = mhi_ep_send_ee_event(mhi_cntrl, MHI_EE_AMSS);
> + if (ret) {
> + dev_err(dev, "Failed sending AMSS EE event\n");
> + return ret;
> + }
> + }
> +
> + return 0;
> +}
> +
> +int mhi_ep_set_m3_state(struct mhi_ep_cntrl *mhi_cntrl)
> +{
> + struct device *dev = &mhi_cntrl->mhi_dev->dev;
> + int ret;
> +
> + spin_lock_bh(&mhi_cntrl->state_lock);
> + ret = mhi_ep_set_mhi_state(mhi_cntrl, MHI_STATE_M3);
> + spin_unlock_bh(&mhi_cntrl->state_lock);
> +
> + if (ret)
> + return ret;
> +
> + /* Signal host that the device moved to M3 */
> + ret = mhi_ep_send_state_change_event(mhi_cntrl, MHI_STATE_M3);
> + if (ret) {
> + dev_err(dev, "Failed sending M3 state change event\n");
> + return ret;
> + }
> +
> + return 0;
> +}
> +
> +int mhi_ep_set_ready_state(struct mhi_ep_cntrl *mhi_cntrl)
> +{
> + struct device *dev = &mhi_cntrl->mhi_dev->dev;
> + enum mhi_state mhi_state;
> + int ret, is_ready;
> +
> + spin_lock_bh(&mhi_cntrl->state_lock);
> + /* Ensure that the MHISTATUS is set to RESET by host */
> + mhi_state = mhi_ep_mmio_masked_read(mhi_cntrl, EP_MHISTATUS, MHISTATUS_MHISTATE_MASK);
> + is_ready = mhi_ep_mmio_masked_read(mhi_cntrl, EP_MHISTATUS, MHISTATUS_READY_MASK);
> +
> + if (mhi_state != MHI_STATE_RESET || is_ready) {
> + dev_err(dev, "READY state transition failed. MHI host not in RESET state\n");
> + spin_unlock_bh(&mhi_cntrl->state_lock);
> + return -EIO;
> + }
> +
> + ret = mhi_ep_set_mhi_state(mhi_cntrl, MHI_STATE_READY);
> + spin_unlock_bh(&mhi_cntrl->state_lock);
> +
> + return ret;
> +}
> diff --git a/include/linux/mhi_ep.h b/include/linux/mhi_ep.h
> index 44a4669382ad..dc27a5de7d3c 100644
> --- a/include/linux/mhi_ep.h
> +++ b/include/linux/mhi_ep.h
> @@ -67,6 +67,11 @@ struct mhi_ep_db_info {
> * @cmd_ctx_host_pa: Physical address of host command context data structure
> * @chdb: Array of channel doorbell interrupt info
> * @event_lock: Lock for protecting event rings
> + * @list_lock: Lock for protecting state transition and channel doorbell lists
> + * @state_lock: Lock for protecting state transitions
> + * @st_transition_list: List of state transitions
> + * @wq: Dedicated workqueue for handling rings and state changes
> + * @state_work: State transition worker
> * @raise_irq: CB function for raising IRQ to the host
> * @alloc_addr: CB function for allocating memory in endpoint for storing host context
> * @map_addr: CB function for mapping host context to endpoint
> @@ -102,6 +107,13 @@ struct mhi_ep_cntrl {
>
> struct mhi_ep_db_info chdb[4];
> struct mutex event_lock;
> + spinlock_t list_lock;
> + spinlock_t state_lock;
> +
> + struct list_head st_transition_list;
> +
> + struct workqueue_struct *wq;
> + struct work_struct state_work;
>
> void (*raise_irq)(struct mhi_ep_cntrl *mhi_cntrl, u32 vector);
> void __iomem *(*alloc_addr)(struct mhi_ep_cntrl *mhi_cntrl, phys_addr_t *phys_addr,
next prev parent reply other threads:[~2022-02-28 16:41 UTC|newest]
Thread overview: 52+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-02-28 12:43 [PATCH v4 00/27] Add initial support for MHI endpoint stack Manivannan Sadhasivam
2022-02-28 12:43 ` [PATCH v4 01/27] bus: mhi: Fix pm_state conversion to string Manivannan Sadhasivam
2022-02-28 15:30 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 02/27] bus: mhi: Fix MHI DMA structure endianness Manivannan Sadhasivam
2022-02-28 15:40 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 03/27] bus: mhi: Move host MHI code to "host" directory Manivannan Sadhasivam
2022-02-28 12:43 ` [PATCH v4 04/27] bus: mhi: Use bitfield operations for register read and write Manivannan Sadhasivam
2022-02-28 12:43 ` [PATCH v4 05/27] bus: mhi: Use bitfield operations for handling DWORDs of ring elements Manivannan Sadhasivam
2022-02-28 14:00 ` David Laight
2022-02-28 14:43 ` 'Manivannan Sadhasivam'
2022-02-28 15:11 ` Alex Elder
2022-02-28 15:40 ` David Laight
2022-02-28 15:51 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 06/27] bus: mhi: Cleanup the register definitions used in headers Manivannan Sadhasivam
2022-02-28 12:43 ` [PATCH v4 07/27] bus: mhi: host: Rename "struct mhi_tre" to "struct mhi_ring_element" Manivannan Sadhasivam
2022-02-28 15:52 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 08/27] bus: mhi: Move common MHI definitions out of host directory Manivannan Sadhasivam
2022-02-28 12:43 ` [PATCH v4 09/27] bus: mhi: Make mhi_state_str[] array static inline and move to common.h Manivannan Sadhasivam
2022-02-28 15:56 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 10/27] bus: mhi: ep: Add support for registering MHI endpoint controllers Manivannan Sadhasivam
2022-02-28 16:06 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 11/27] bus: mhi: ep: Add support for registering MHI endpoint client drivers Manivannan Sadhasivam
2022-02-28 16:09 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 12/27] bus: mhi: ep: Add support for creating and destroying MHI EP devices Manivannan Sadhasivam
2022-02-28 16:10 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 13/27] bus: mhi: ep: Add support for managing MMIO registers Manivannan Sadhasivam
2022-02-28 16:23 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 14/27] bus: mhi: ep: Add support for ring management Manivannan Sadhasivam
2022-02-28 16:27 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 15/27] bus: mhi: ep: Add support for sending events to the host Manivannan Sadhasivam
2022-02-28 16:37 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 16/27] bus: mhi: ep: Add support for managing MHI state machine Manivannan Sadhasivam
2022-02-28 16:41 ` Alex Elder [this message]
2022-02-28 12:43 ` [PATCH v4 17/27] bus: mhi: ep: Add support for processing MHI endpoint interrupts Manivannan Sadhasivam
2022-02-28 16:45 ` Alex Elder
2022-03-01 6:41 ` Manivannan Sadhasivam
2022-02-28 12:43 ` [PATCH v4 18/27] bus: mhi: ep: Add support for powering up the MHI endpoint stack Manivannan Sadhasivam
2022-02-28 16:47 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 19/27] bus: mhi: ep: Add support for powering down " Manivannan Sadhasivam
2022-02-28 16:49 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 20/27] bus: mhi: ep: Add support for handling MHI_RESET Manivannan Sadhasivam
2022-02-28 12:43 ` [PATCH v4 21/27] bus: mhi: ep: Add support for handling SYS_ERR condition Manivannan Sadhasivam
2022-02-28 12:43 ` [PATCH v4 22/27] bus: mhi: ep: Add support for processing command rings Manivannan Sadhasivam
2022-02-28 12:43 ` [PATCH v4 23/27] bus: mhi: ep: Add support for reading from the host Manivannan Sadhasivam
2022-02-28 12:43 ` [PATCH v4 24/27] bus: mhi: ep: Add support for processing channel rings Manivannan Sadhasivam
2022-02-28 12:43 ` [PATCH v4 25/27] bus: mhi: ep: Add support for queueing SKBs to the host Manivannan Sadhasivam
2022-02-28 16:51 ` Alex Elder
2022-02-28 12:43 ` [PATCH v4 26/27] bus: mhi: ep: Add support for suspending and resuming channels Manivannan Sadhasivam
2022-02-28 12:43 ` [PATCH v4 27/27] bus: mhi: ep: Add uevent support for module autoloading Manivannan Sadhasivam
2022-02-28 16:57 ` [PATCH v4 00/27] Add initial support for MHI endpoint stack Alex Elder
2022-03-01 6:15 ` Manivannan Sadhasivam
2022-03-01 8:50 ` Manivannan Sadhasivam
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=043bd7c6-97af-26ae-78fa-8b22b0e5606d@linaro.org \
--to=elder@linaro.org \
--cc=bjorn.andersson@linaro.org \
--cc=dmitry.baryshkov@linaro.org \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=manivannan.sadhasivam@linaro.org \
--cc=mhi@lists.linux.dev \
--cc=quic_bbhatt@quicinc.com \
--cc=quic_cang@quicinc.com \
--cc=quic_hemantk@quicinc.com \
--cc=quic_jhugo@quicinc.com \
--cc=quic_skananth@quicinc.com \
--cc=quic_vbadigan@quicinc.com \
--cc=vinod.koul@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®