From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.6 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8A6ECC606D5 for ; Tue, 9 Jul 2019 05:48:38 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 4EFFF216C4 for ; Tue, 9 Jul 2019 05:48:38 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="lqjpDQkA" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1725905AbfGIFsg (ORCPT ); Tue, 9 Jul 2019 01:48:36 -0400 Received: from mail-wr1-f65.google.com ([209.85.221.65]:37580 "EHLO mail-wr1-f65.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725832AbfGIFsg (ORCPT ); Tue, 9 Jul 2019 01:48:36 -0400 Received: by mail-wr1-f65.google.com with SMTP id n9so10371971wrr.4; Mon, 08 Jul 2019 22:48:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=CNN2kJc+nWrTuiXZEL6GkuVZVuX+Nw04FbBGD7IU+LE=; b=lqjpDQkAZeYNEQ+sEWPveNoi5a1wx01TcknFbfj1ITpgr/Qhpf3ZfyGbfGH1gkNePK VJ4jOwsvWQ0hE/cR8t12CYteK9N4tX+ipFo87rmV2VUnjsp8x876k3/fyKnbfarOV+vo 5QEXYY+wwxVCSL89ABGSSQAIhVQVST0D9apQgwOgsao7m6+yxrl3nW/xUWUJoM6EvBba 6TxDA7bjQeWBJFJPKZcGChL8mvm37bpuctuZxZ3mDv8uRDhhmPv28DQ7qn0eJn+VuCSc F/1ruD0LMLgkjvZEGywE3qPPoJW7Q0Dp23Ss9e+0s6EDDStEgCWqyXLpOfMGpeWyOFMJ CbDg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=CNN2kJc+nWrTuiXZEL6GkuVZVuX+Nw04FbBGD7IU+LE=; b=CSRba5LQ82B7i8G78Ok7RUI6WZFhL6BPAbOuu2ykSI8KJArOn42VO4AH0SmqNqXCEl AQvTo3rkIJr6YCo4ah2exhZ6EEs/MnpzA1Q+fvWlywtlojpouBxixxTCIc000Ioh2RRW bjcI+iYJ8A8dpEdEFjHN2tobuUeaeu0A6l95g0Qtiusv+TMYgQYlL/2EX6X1EW3M9Kw6 q6GXKBpzfhvxYkeAV6Tar7dCrLeCagOcIq9uWENUsoXBILr8Bwyu4cEpYb3Lbb0l9vGY 1WpawxeiXMleYZE/8RHQKEKFzhK7bPNUvGMH5vrmsQ1/JczVebstFZQBYpN2YmZvMcqN cFvw== X-Gm-Message-State: APjAAAXsO1KjBwADMuZ05NDtNWc40uoFurh6dHy2DS5KVO1WHaO8OsRY 5q3uFKjyMZjHj/6cZuoWDUDd6R9MOstkA3xtP1k= X-Google-Smtp-Source: APXvYqx0FZcur7ze+PmaoG3LMB6+HzCJzBe4KY7ZuSc+kzByCrpvYHptgS/2GwByhfvQ4sAjm2o2mRlZvIClkYTo3RM= X-Received: by 2002:a5d:46cf:: with SMTP id g15mr3688002wrs.93.1562651312263; Mon, 08 Jul 2019 22:48:32 -0700 (PDT) MIME-Version: 1.0 References: <20190627081205.22065-1-daniel.baluta@nxp.com> <20190627081205.22065-2-daniel.baluta@nxp.com> In-Reply-To: <20190627081205.22065-2-daniel.baluta@nxp.com> From: Daniel Baluta Date: Tue, 9 Jul 2019 08:48:20 +0300 Message-ID: Subject: Re: [PATCH v2 1/2] firmware: imx: Add DSP IPC protocol interface To: Daniel Baluta Cc: "shawnguo@kernel.org" , "robh+dt@kernel.org" , "o.rempel@pengutronix.de" , "s.hauer@pengutronix.de" , "S.j. Wang" , "festevam@gmail.com" , dl-linux-imx , Aisheng Dong , Anson Huang , "linux-kernel@vger.kernel.org" , "linux-arm-kernel@lists.infradead.org" , "mark.rutland@arm.com" , "devicetree@vger.kernel.org" Content-Type: text/plain; charset="UTF-8" Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi Oleksij, Any comments on this? On Thu, Jun 27, 2019 at 11:14 AM Daniel Baluta wrote: > > Some of i.MX8 processors (e.g i.MX8QM, i.MX8QXP) contain > the Tensilica HiFi4 DSP for advanced pre- and post-audio > processing. > > The communication between Host CPU and DSP firmware is > taking place using a shared memory area for message passing > and a dedicated Messaging Unit for notifications. > > DSP IPC protocol driver offers a doorbell interface using > imx-mailbox API. > > We use 4 MU channels (2 x TXDB, 2 x RXDB) to implement a > request-reply protocol. > > Connection 0 (txdb0, rxdb0): > - Host writes messasge to shared memory [SHMEM] > - Host sends a request [MU] > - DSP handles request [SHMEM] > - DSP sends reply [MU] > > Connection 1 (txdb1, rxdb1): > - DSP writes a message to shared memory [SHMEM] > - DSP sends a request [MU] > - Host handles request [SHMEM] > - Host sends reply [MU] > > The protocol driver will be used by a Host client to > communicate with the DSP. First client will be the i.MX8 > part from Sound Open Firmware infrastructure. > > The protocol drivers offers the following interface: > > On Tx: > - imx_dsp_ring_doorbell, will be called to notify the DSP > that it needs to handle a request. > > On Rx: > - clients need to provide two callbacks: > .handle_reply > .handle_request > - the callbacks will be used by the protocol driver on > notification arrival from DSP. > > Signed-off-by: Daniel Baluta > --- > drivers/firmware/imx/Kconfig | 11 +++ > drivers/firmware/imx/Makefile | 1 + > drivers/firmware/imx/imx-dsp.c | 142 +++++++++++++++++++++++++++++++ > include/linux/firmware/imx/dsp.h | 67 +++++++++++++++ > 4 files changed, 221 insertions(+) > create mode 100644 drivers/firmware/imx/imx-dsp.c > create mode 100644 include/linux/firmware/imx/dsp.h > > diff --git a/drivers/firmware/imx/Kconfig b/drivers/firmware/imx/Kconfig > index 42b566f8903f..ddb241708c31 100644 > --- a/drivers/firmware/imx/Kconfig > +++ b/drivers/firmware/imx/Kconfig > @@ -1,4 +1,15 @@ > # SPDX-License-Identifier: GPL-2.0-only > +config IMX_DSP > + bool "IMX DSP Protocol driver" > + depends on IMX_MBOX > + help > + This enables DSP IPC protocol between host CPU (Linux) > + and the firmware running on DSP. > + DSP exists on some i.MX8 processors (e.g i.MX8QM, i.MX8QXP). > + > + It acts like a doorbell. Client might use shared memory to > + exchange information with DSP side. > + > config IMX_SCU > bool "IMX SCU Protocol driver" > depends on IMX_MBOX > diff --git a/drivers/firmware/imx/Makefile b/drivers/firmware/imx/Makefile > index 802c4ad8e8f9..08bc9ddfbdfb 100644 > --- a/drivers/firmware/imx/Makefile > +++ b/drivers/firmware/imx/Makefile > @@ -1,3 +1,4 @@ > # SPDX-License-Identifier: GPL-2.0 > +obj-$(CONFIG_IMX_DSP) += imx-dsp.o > obj-$(CONFIG_IMX_SCU) += imx-scu.o misc.o imx-scu-irq.o > obj-$(CONFIG_IMX_SCU_PD) += scu-pd.o > diff --git a/drivers/firmware/imx/imx-dsp.c b/drivers/firmware/imx/imx-dsp.c > new file mode 100644 > index 000000000000..c4d34a2fbff3 > --- /dev/null > +++ b/drivers/firmware/imx/imx-dsp.c > @@ -0,0 +1,142 @@ > +// SPDX-License-Identifier: GPL-2.0+ > +/* > + * Copyright 2019 NXP > + * Author: Daniel Baluta > + * > + * Implementation of the DSP IPC interface (host side) > + */ > + > +#include > +#include > +#include > +#include > +#include > +#include > +#include > + > +/* > + * imx_dsp_ring_doorbell - triggers an interrupt on the other side (DSP) > + * > + * @dsp: DSP IPC handle > + * @chan_idx: index of the channel where to trigger the interrupt > + * > + * Returns non-negative value for success, negative value for error > + */ > +int imx_dsp_ring_doorbell(struct imx_dsp_ipc *ipc, unsigned int idx) > +{ > + int ret; > + struct imx_dsp_chan *dsp_chan; > + > + if (idx >= DSP_MU_CHAN_NUM) > + return -EINVAL; > + > + dsp_chan = &ipc->chans[idx]; > + ret = mbox_send_message(dsp_chan->ch, NULL); > + if (ret < 0) > + return ret; > + > + return 0; > +} > +EXPORT_SYMBOL(imx_dsp_ring_doorbell); > + > +/* > + * imx_dsp_handle_rx - rx callback used by imx mailbox > + * > + * @c: mbox client > + * @msg: message received > + * > + * Users of DSP IPC will need to privde handle_reply and handle_request > + * callbacks. > + */ > +static void imx_dsp_handle_rx(struct mbox_client *c, void *msg) > +{ > + struct imx_dsp_chan *chan = container_of(c, struct imx_dsp_chan, cl); > + > + if (chan->idx == 0) { > + chan->ipc->ops->handle_reply(chan->ipc); > + } else { > + chan->ipc->ops->handle_request(chan->ipc); > + imx_dsp_ring_doorbell(chan->ipc, 1); > + } > +} > + > +static int imx_dsp_probe(struct platform_device *pdev) > +{ > + struct device *dev = &pdev->dev; > + struct imx_dsp_ipc *dsp_ipc; > + struct imx_dsp_chan *dsp_chan; > + struct mbox_client *cl; > + char *chan_name; > + int ret; > + int i, j; > + > + dsp_ipc = devm_kzalloc(dev, sizeof(*dsp_ipc), GFP_KERNEL); > + if (!dsp_ipc) > + return -ENOMEM; > + > + for (i = 0; i < DSP_MU_CHAN_NUM; i++) { > + if (i < 2) > + chan_name = kasprintf(GFP_KERNEL, "txdb%d", i); > + else > + chan_name = kasprintf(GFP_KERNEL, "rxdb%d", i - 2); > + > + if (!chan_name) > + return -ENOMEM; > + > + dsp_chan = &dsp_ipc->chans[i]; > + cl = &dsp_chan->cl; > + cl->dev = dev; > + cl->tx_block = false; > + cl->knows_txdone = true; > + cl->rx_callback = imx_dsp_handle_rx; > + > + dsp_chan->ipc = dsp_ipc; > + dsp_chan->idx = i % 2; > + dsp_chan->ch = mbox_request_channel_byname(cl, chan_name); > + if (IS_ERR(dsp_chan->ch)) { > + ret = PTR_ERR(dsp_chan->ch); > + if (ret != -EPROBE_DEFER) > + dev_err(dev, "Failed to request mbox chan %s ret %d\n", > + chan_name, ret); > + goto out; > + } > + > + dev_dbg(dev, "request mbox chan %s\n", chan_name); > + /* chan_name is not used anymore by framework */ > + kfree(chan_name); > + } > + > + dsp_ipc->dev = dev; > + > + dev_set_drvdata(dev, dsp_ipc); > + > + dev_info(dev, "NXP i.MX DSP IPC initialized\n"); > + > + return devm_of_platform_populate(dev); > +out: > + kfree(chan_name); > + for (j = 0; j < i; j++) { > + dsp_chan = &dsp_ipc->chans[j]; > + mbox_free_channel(dsp_chan->ch); > + } > + > + return ret; > +} > + > +static const struct of_device_id imx_dsp_match[] = { > + { .compatible = "fsl,imx8qxp-dsp", }, > + { /* Sentinel */ } > +}; > + > +static struct platform_driver imx_dsp_driver = { > + .driver = { > + .name = "imx-dsp", > + .of_match_table = imx_dsp_match, > + }, > + .probe = imx_dsp_probe, > +}; > +builtin_platform_driver(imx_dsp_driver); > + > +MODULE_AUTHOR("Daniel Baluta "); > +MODULE_DESCRIPTION("IMX DSP IPC protocol driver"); > +MODULE_LICENSE("GPL v2"); > diff --git a/include/linux/firmware/imx/dsp.h b/include/linux/firmware/imx/dsp.h > new file mode 100644 > index 000000000000..7562099c9e46 > --- /dev/null > +++ b/include/linux/firmware/imx/dsp.h > @@ -0,0 +1,67 @@ > +/* SPDX-License-Identifier: GPL-2.0+ */ > +/* > + * Copyright 2019 NXP > + * > + * Header file for the DSP IPC implementation > + */ > + > +#ifndef _IMX_DSP_IPC_H > +#define _IMX_DSP_IPC_H > + > +#include > +#include > +#include > + > +#define DSP_MU_CHAN_NUM 4 > + > +struct imx_dsp_chan { > + struct imx_dsp_ipc *ipc; > + struct mbox_client cl; > + struct mbox_chan *ch; > + char *name; > + int idx; > +}; > + > +struct imx_dsp_ops { > + void (*handle_reply)(struct imx_dsp_ipc *ipc); > + void (*handle_request)(struct imx_dsp_ipc *ipc); > +}; > + > +struct imx_dsp_ipc { > + /* Host <-> DSP communication uses 2 txdb and 2 rxdb channels */ > + struct imx_dsp_chan chans[DSP_MU_CHAN_NUM]; > + struct device *dev; > + struct imx_dsp_ops *ops; > + void *private_data; > +}; > + > +static inline void imx_dsp_set_data(struct imx_dsp_ipc *ipc, void *data) > +{ > + if (!ipc) > + return; > + > + ipc->private_data = data; > +} > + > +static inline void *imx_dsp_get_data(struct imx_dsp_ipc *ipc) > +{ > + if (!ipc) > + return NULL; > + > + return ipc->private_data; > +} > + > +#if IS_ENABLED(CONFIG_IMX_DSP) > + > +int imx_dsp_ring_doorbell(struct imx_dsp_ipc *dsp, unsigned int chan_idx); > + > +#else > + > +static inline int imx_dsp_ring_doorbell(struct imx_dsp_ipc *ipc, > + unsigned int chan_idx) > +{ > + return -ENOTSUPP; > +} > + > +#endif > +#endif /* _IMX_DSP_IPC_H */ > -- > 2.17.1 >