From patchwork Thu Apr 16 21:54:42 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ben Levinsky X-Patchwork-Id: 11493845 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id D576514DD for ; Thu, 16 Apr 2020 21:56:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id AAD19218AC for ; Thu, 16 Apr 2020 21:56:31 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=xilinx.onmicrosoft.com header.i=@xilinx.onmicrosoft.com header.b="KlZ8NfOE" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727835AbgDPV4b (ORCPT ); Thu, 16 Apr 2020 17:56:31 -0400 Received: from mail-mw2nam12on2049.outbound.protection.outlook.com ([40.107.244.49]:24685 "EHLO NAM12-MW2-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1728295AbgDPV43 (ORCPT ); Thu, 16 Apr 2020 17:56:29 -0400 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=XgQOlE0VAjXowmDYuA3XXPQXxOfcEH0YcOA1Bz0DCGIBqppUJ2w4sw9bC+sNjKlFMDoVkmz03nqbZFglVL82vnkjVLZOaBFyDPci1XzBMWTOjgOIR2b+Q355XjZeIf+mPCr0XWdssYnBmOk2L0zUnfjYQRqXM8+bT4yuk5LX1LwuYM+sYNUI9mMXK79qZdg0uzAuKLqZvKPi2f1Hu4HmtRLsGkHc6tl23GVoUa8lVHU7a26d27M2FKLXtWN+CTqbE8WG47weq1twSCPkIOMCRqHt1l17Y6nBHMxczUmmm0CO8FxWE12s/tFvJzlXQ2R4VE899YqqVg24/oE5WAJnvQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=nFuFckJuJkm9e3M3r/fgzfGoOqGQyjxITHOleu08un8=; b=JWhbhreQJiXk8we12KFv4CapoyNoElVubOKjonJnMxI9PZv2AFq7fBOeos4cBzT6M6TTSzFamir63AbyiBwgrSuN0bfZ2K3gcCOnv9bBatOwra6YwDky36KFADIZhXF8qXsjzRpkn/YBPJzCdhEU3co8P5oRSpAwbErQwBJHVqfOyqKZ6uBkm5e6Su2/wDOUgHRnxCRTFw1yC0wBw4uZyOx3jTSZp1dUbSzYlF01nQIdmpka1JOj0fSwnHPWYjVRoqDxC0uef00x7PeATz3KPN/ojnXA19KK3opwrpOFMW+x5DycqZJWf+/HJxdztijUmZqKdLxuntgDor015JY4CQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 149.199.60.83) smtp.rcpttodomain=wizery.com smtp.mailfrom=xilinx.com; dmarc=bestguesspass action=none header.from=xilinx.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=xilinx.onmicrosoft.com; s=selector2-xilinx-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=nFuFckJuJkm9e3M3r/fgzfGoOqGQyjxITHOleu08un8=; b=KlZ8NfOERhFtz5z6i6BXtIXBFP4f92Vg7wSzyMXooCr08HV2M8GUk3ClKotrl78bruoEjA91FWNq+6iD1DXwS9v97ohsBEjLWPYkROZ6UsOsGt3un3rDYJtct3TN6qewEmcxn0Q/dJ5HQm0xfRDlwnd7+pD855JoVlfvFdf4rUA= Received: from SN6PR16CA0049.namprd16.prod.outlook.com (2603:10b6:805:ca::26) by DM5PR02MB2587.namprd02.prod.outlook.com (2603:10b6:3:3f::10) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2921.25; Thu, 16 Apr 2020 21:54:47 +0000 Received: from SN1NAM02FT059.eop-nam02.prod.protection.outlook.com (2603:10b6:805:ca:cafe::7a) by SN6PR16CA0049.outlook.office365.com (2603:10b6:805:ca::26) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2921.26 via Frontend Transport; Thu, 16 Apr 2020 21:54:47 +0000 Authentication-Results: spf=pass (sender IP is 149.199.60.83) smtp.mailfrom=xilinx.com; wizery.com; dkim=none (message not signed) header.d=none;wizery.com; dmarc=bestguesspass action=none header.from=xilinx.com; Received-SPF: Pass (protection.outlook.com: domain of xilinx.com designates 149.199.60.83 as permitted sender) receiver=protection.outlook.com; client-ip=149.199.60.83; helo=xsj-pvapsmtpgw01; Received: from xsj-pvapsmtpgw01 (149.199.60.83) by SN1NAM02FT059.mail.protection.outlook.com (10.152.72.177) with Microsoft SMTP Server id 15.20.2921.25 via Frontend Transport; Thu, 16 Apr 2020 21:54:46 +0000 Received: from [149.199.38.66] (port=38377 helo=xsj-pvapsmtp01) by xsj-pvapsmtpgw01 with esmtp (Exim 4.90) (envelope-from ) id 1jPCSN-0004cV-A8; Thu, 16 Apr 2020 14:53:59 -0700 Received: from [127.0.0.1] (helo=localhost) by xsj-pvapsmtp01 with smtp (Exim 4.63) (envelope-from ) id 1jPCT8-0003e3-Gm; Thu, 16 Apr 2020 14:54:46 -0700 Received: from [172.19.2.206] (helo=xsjblevinsk50.xilinx.com) by xsj-pvapsmtp01 with esmtp (Exim 4.63) (envelope-from ) id 1jPCT4-0003cm-9t; Thu, 16 Apr 2020 14:54:42 -0700 From: Ben Levinsky To: ohad@wizery.com, bjorn.andersson@linaro.org, michal.simek@xilinx.com, jollys@xilinx.com, rajan.vaja@xilinx.com, robh+dt@kernel.org, mark.rutland@arm.com Cc: linux-remoteproc@vger.kernel.org, linux-arm-kernel@lists.infradead.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, Wendy Liang , Ed Mooring , Jason Wu Subject: [PATCH v2 5/5] remoteproc: Add initial zynqmp R5 remoteproc driver Date: Thu, 16 Apr 2020 14:54:42 -0700 Message-Id: <1587074082-14836-6-git-send-email-ben.levinsky@xilinx.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1587074082-14836-1-git-send-email-ben.levinsky@xilinx.com> References: <1587074082-14836-1-git-send-email-ben.levinsky@xilinx.com> X-TM-AS-Product-Ver: IMSS-7.1.0.1224-8.2.0.1013-23620.005 X-TM-AS-User-Approved-Sender: Yes;Yes X-EOPAttributedMessage: 0 X-MS-Office365-Filtering-HT: Tenant X-Forefront-Antispam-Report: CIP:149.199.60.83;CTRY:US;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:xsj-pvapsmtpgw01;PTR:unknown-60-83.xilinx.com;CAT:NONE;SFTY:;SFS:(10009020)(4636009)(396003)(346002)(376002)(136003)(39860400002)(46966005)(478600001)(4326008)(70586007)(186003)(36756003)(316002)(70206006)(81156014)(8676002)(426003)(7696005)(54906003)(82740400003)(9786002)(356005)(81166007)(47076004)(8936002)(2616005)(44832011)(26005)(30864003)(336012)(2906002)(107886003)(5660300002);DIR:OUT;SFP:1101; MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 70a6752a-7c4c-430b-5aa3-08d7e250c77f X-MS-TrafficTypeDiagnostic: DM5PR02MB2587: X-Microsoft-Antispam-PRVS: X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-MS-Oob-TLC-OOBClassifiers: OLM:530; X-Forefront-PRVS: 0375972289 X-MS-Exchange-SenderADCheck: 1 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: uprHuKy05ooygUpBQ7JIdwin4u5gwpZU/wCj2chuoEfQRY4OVr/FjEcaLmIJu+2lacXsVEqlU42+PVhXgk2lSgcJquRs/4NAl1RCf/n0VEl+AtofO1dsMM+DTNiz+KE2GezYdOiU4h/ECYg8xkxcnF6bhrDFPQOnR2juXv9vC7YlGBKJXK6cW4rz+KP9VcUOvMPYFVxmYdrPtf9K5mjBcCfJiGahSdsIAwe5Jm7toQhq/TNlcIsLEqTwSXRDIQBqwy7s8Ro0ByOSslF3nrq5I4SnQDZJHiLL8bBfSg3G8LNVTUI/I68sqnn1K/AdY7f6x2KFlF91mJQl+sFEoDOY0sfRbfwT1XpaxKQtW+vhkFRu7tuszUZk8+qPJboSZlLNzXX8TkRUGEGEZrfsaQPc2pRbiFsf9fgaILqQdyCw8h0WYS0ZWAb6FEpDLChPM4FNO5xhYbFprjyXYDEwZRdvqplZXv33u/k8qUR7Z0e+uzRa7bdem60sN4kU3B7mCPaMpnjIcLL/pKIUwc812Q3e/g== X-OriginatorOrg: xilinx.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 16 Apr 2020 21:54:46.8358 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 70a6752a-7c4c-430b-5aa3-08d7e250c77f X-MS-Exchange-CrossTenant-Id: 657af505-d5df-48d0-8300-c31994686c5c X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=657af505-d5df-48d0-8300-c31994686c5c;Ip=[149.199.60.83];Helo=[xsj-pvapsmtpgw01] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR02MB2587 Sender: linux-remoteproc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-remoteproc@vger.kernel.org R5 is included in Xilinx Zynq UltraScale MPSoC so by adding this remotproc driver, we can boot the R5 sub-system in different configurations. Acked-by: Stefano Stabellini Acked-by: Ben Levinsky Reviewed-by: Radhey Shyam Pandey Signed-off-by: Ben Levinsky Signed-off-by: Wendy Liang Signed-off-by: Michal Simek Signed-off-by: Ed Mooring Signed-off-by: Jason Wu Tested-by: Ben Levinsky --- Changes since v1: - remove domain struct as per review from Mathieu --- drivers/remoteproc/Kconfig | 10 + drivers/remoteproc/Makefile | 1 + drivers/remoteproc/zynqmp_r5_remoteproc.c | 911 ++++++++++++++++++++++++++++++ 3 files changed, 922 insertions(+) create mode 100644 drivers/remoteproc/zynqmp_r5_remoteproc.c diff --git a/drivers/remoteproc/Kconfig b/drivers/remoteproc/Kconfig index fbaed07..f094c84 100644 --- a/drivers/remoteproc/Kconfig +++ b/drivers/remoteproc/Kconfig @@ -222,6 +222,16 @@ config ST_REMOTEPROC processor framework. This can be either built-in or a loadable module. +config ZYNQMP_R5_REMOTEPROC + tristate "ZynqMP_r5 remoteproc support" + depends on ARM64 && PM && ARCH_ZYNQMP + select RPMSG_VIRTIO + select MAILBOX + select ZYNQMP_IPI_MBOX + help + Say y here to support ZynqMP R5 remote processors via the remote + processor framework. + config ST_SLIM_REMOTEPROC tristate diff --git a/drivers/remoteproc/Makefile b/drivers/remoteproc/Makefile index 0effd38..806ac3f 100644 --- a/drivers/remoteproc/Makefile +++ b/drivers/remoteproc/Makefile @@ -27,5 +27,6 @@ obj-$(CONFIG_QCOM_WCNSS_PIL) += qcom_wcnss_pil.o qcom_wcnss_pil-y += qcom_wcnss.o qcom_wcnss_pil-y += qcom_wcnss_iris.o obj-$(CONFIG_ST_REMOTEPROC) += st_remoteproc.o +obj-$(CONFIG_ZYNQMP_R5_REMOTEPROC) += zynqmp_r5_remoteproc.o obj-$(CONFIG_ST_SLIM_REMOTEPROC) += st_slim_rproc.o obj-$(CONFIG_STM32_RPROC) += stm32_rproc.o diff --git a/drivers/remoteproc/zynqmp_r5_remoteproc.c b/drivers/remoteproc/zynqmp_r5_remoteproc.c new file mode 100644 index 0000000..2cfc6b6 --- /dev/null +++ b/drivers/remoteproc/zynqmp_r5_remoteproc.c @@ -0,0 +1,911 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Zynq R5 Remote Processor driver + * + * Copyright (C) 2015 - 2018 Xilinx Inc. + * Copyright (C) 2015 Jason Wu + * + * Based on origin OMAP and Zynq Remote Processor driver + * + * Copyright (C) 2012 Michal Simek + * Copyright (C) 2012 PetaLogix + * Copyright (C) 2011 Texas Instruments, Inc. + * Copyright (C) 2011 Google, Inc. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "remoteproc_internal.h" + +#define MAX_RPROCS 2 /* Support up to 2 RPU */ +#define MAX_MEM_PNODES 4 /* Max power nodes for one RPU memory instance */ + +#define DEFAULT_FIRMWARE_NAME "rproc-rpu-fw" + +/* PM proc states */ +#define PM_PROC_STATE_ACTIVE 1U + +/* IPI buffer MAX length */ +#define IPI_BUF_LEN_MAX 32U +/* RX mailbox client buffer max length */ +#define RX_MBOX_CLIENT_BUF_MAX (IPI_BUF_LEN_MAX + \ + sizeof(struct zynqmp_ipi_message)) + +static bool autoboot __read_mostly; + +static const struct zynqmp_eemi_ops *eemi_ops; + +/** + * struct zynqmp_r5_mem - zynqmp rpu memory data + * @pnode_id: TCM power domain ids + * @res: memory resource + * @node: list node + */ +struct zynqmp_r5_mem { + u32 pnode_id[MAX_MEM_PNODES]; + struct resource res; + struct list_head node; +}; + +/** + * struct zynqmp_r5_pdata - zynqmp rpu remote processor private data + * @dev: device of RPU instance + * @rproc: rproc handle + * @pnode_id: RPU CPU power domain id + * @mems: memory resources + * @is_r5_mode_set: indicate if r5 operation mode is set + * @tx_mc: tx mailbox client + * @rx_mc: rx mailbox client + * @tx_chan: tx mailbox channel + * @rx_chan: rx mailbox channel + * @workqueue: workqueue for the RPU remoteproc + * @tx_mc_skbs: socket buffers for tx mailbox client + * @rx_mc_buf: rx mailbox client buffer to save the rx message + */ +struct zynqmp_r5_pdata { + struct device dev; + struct rproc *rproc; + u32 pnode_id; + struct list_head mems; + bool is_r5_mode_set; + struct mbox_client tx_mc; + struct mbox_client rx_mc; + struct mbox_chan *tx_chan; + struct mbox_chan *rx_chan; + struct work_struct workqueue; + struct sk_buff_head tx_mc_skbs; + unsigned char rx_mc_buf[RX_MBOX_CLIENT_BUF_MAX]; +}; + +/** + * table of RPUs + */ +struct zynqmp_r5_pdata rpus[MAX_RPROCS]; +/** + * RPU core configuration + */ +enum rpu_oper_mode rpu_mode; + +/* + * r5_set_mode - set RPU operation mode + * @pdata: Remote processor private data + * + * set RPU oepration mode + * + * Return: 0 for success, negative value for failure + */ +static int r5_set_mode(struct zynqmp_r5_pdata *pdata) +{ + u32 val[PAYLOAD_ARG_CNT] = {0}, expect; + struct device *dev = &pdata->dev; + int ret; + + if (pdata->is_r5_mode_set) + return 0; + expect = (u32)rpu_mode; + ret = eemi_ops->ioctl(pdata->pnode_id, IOCTL_GET_RPU_OPER_MODE, + 0, 0, val); + if (ret < 0) { + dev_err(dev, "failed to get RPU oper mode.\n"); + return ret; + } + if (val[0] == expect) { + dev_dbg(dev, "RPU mode matches: %x\n", val[0]); + } else { + ret = eemi_ops->ioctl(pdata->pnode_id, + IOCTL_SET_RPU_OPER_MODE, + expect, 0, val); + if (ret < 0) { + dev_err(dev, + "failed to set RPU oper mode.\n"); + return ret; + } + } + if (expect == (u32)PM_RPU_MODE_LOCKSTEP) + expect = (u32)PM_RPU_TCM_COMB; + else + expect = (u32)PM_RPU_TCM_SPLIT; + ret = eemi_ops->ioctl(pdata->pnode_id, IOCTL_TCM_COMB_CONFIG, + expect, 0, val); + if (ret < 0) { + dev_err(dev, "failed to config TCM to %x.\n", + expect); + return ret; + } + pdata->is_r5_mode_set = true; + return 0; +} + +/** + * r5_is_running - check if r5 is running + * @pdata: Remote processor private data + * + * check if R5 is running + * + * Return: true if r5 is running, false otherwise + */ +static bool r5_is_running(struct zynqmp_r5_pdata *pdata) +{ + u32 status, requirements, usage; + struct device *dev = &pdata->dev; + + if (eemi_ops->get_node_status(pdata->pnode_id, + &status, &requirements, &usage)) { + dev_err(dev, "Failed to get RPU node %d status.\n", + pdata->pnode_id); + return false; + } else if (status != PM_PROC_STATE_ACTIVE) { + dev_dbg(dev, "RPU is not running.\n"); + return false; + } + + dev_dbg(dev, "RPU is running.\n"); + return true; +} + +/* + * ZynqMP R5 remoteproc memory release function + */ +static int zynqmp_r5_mem_release(struct rproc *rproc, + struct rproc_mem_entry *mem) +{ + struct zynqmp_r5_mem *priv; + int i, ret; + struct device *dev = &rproc->dev; + + priv = mem->priv; + if (!priv) + return 0; + for (i = 0; i < MAX_MEM_PNODES; i++) { + if (priv->pnode_id[i]) { + dev_dbg(dev, "%s, pnode %d\n", + __func__, priv->pnode_id[i]); + ret = eemi_ops->release_node(priv->pnode_id[i]); + if (ret < 0) { + dev_err(dev, + "failed to release power node: %u\n", + priv->pnode_id[i]); + return ret; + } + } else { + break; + } + } + return 0; +} + +/* + * ZynqMP R5 remoteproc operations + */ +static int zynqmp_r5_rproc_start(struct rproc *rproc) +{ + struct device *dev = rproc->dev.parent; + struct zynqmp_r5_pdata *local = rproc->priv; + enum rpu_boot_mem bootmem; + int ret; + /* Set up R5 */ + ret = r5_set_mode(local); + if (ret) { + dev_err(dev, "failed to set R5 operation mode.\n"); + return ret; + } + if ((rproc->bootaddr & 0xF0000000) == 0xF0000000) + bootmem = PM_RPU_BOOTMEM_HIVEC; + else + bootmem = PM_RPU_BOOTMEM_LOVEC; + dev_info(dev, "RPU boot from %s.", + bootmem == PM_RPU_BOOTMEM_HIVEC ? "OCM" : "TCM"); + + ret = eemi_ops->request_wakeup(local->pnode_id, 1, bootmem, + ZYNQMP_PM_REQUEST_ACK_NO); + if (ret < 0) { + dev_err(dev, "failed to boot R5.\n"); + return ret; + } + return 0; +} + +static int zynqmp_r5_rproc_stop(struct rproc *rproc) +{ + struct zynqmp_r5_pdata *local = rproc->priv; + int ret; + + ret = eemi_ops->force_powerdown(local->pnode_id, + ZYNQMP_PM_REQUEST_ACK_BLOCKING); + if (ret < 0) { + dev_err(&local->dev, "failed to shutdown R5.\n"); + return ret; + } + local->is_r5_mode_set = false; + return 0; +} + + +static int zynqmp_r5_parse_fw(struct rproc *rproc, const struct firmware *fw) +{ + int num_mems, i, ret; + struct zynqmp_r5_pdata *pdata = rproc->priv; + struct device *dev = &pdata->dev; + struct device_node *np = dev->of_node; + struct rproc_mem_entry *mem; + struct device_node *child; + struct resource rsc; + + num_mems = of_count_phandle_with_args(np, "memory-region", NULL); + if (num_mems <= 0) + return 0; + + for (i = 0; i < num_mems; i++) { + struct device_node *node; + struct zynqmp_r5_mem *zynqmp_mem; + struct reserved_mem *rmem; + + node = of_parse_phandle(np, "memory-region", i); + rmem = of_reserved_mem_lookup(node); + if (!rmem) { + dev_err(dev, "unable to acquire memory-region\n"); + return -EINVAL; + } + if (strstr(node->name, "vdev") && + strstr(node->name, "buffer")) { + int id; + char name[16]; + + id = node->name[8] - '0'; + snprintf(name, sizeof(name), "vdev%dbuffer", id); + /* Register DMA region */ + mem = rproc_mem_entry_init(dev, NULL, + (dma_addr_t)rmem->base, + rmem->size, rmem->base, + NULL, NULL, + name); + if (!mem) { + dev_err(dev, "unable to initialize memory-region %s\n", + node->name); + return -ENOMEM; + } + dev_dbg(dev, "parsed %s at %llx\r\n", mem->name, + mem->dma); + rproc_add_carveout(rproc, mem); + continue; + } else if (strstr(node->name, "vdev") && + strstr(node->name, "vring")) { + int id, vring_id; + char name[16]; + + id = node->name[8] - '0'; + vring_id = node->name[14] - '0'; + snprintf(name, sizeof(name), "vdev%dvring%d", id, + vring_id); + /* Register vring */ + mem = rproc_mem_entry_init(dev, NULL, + (dma_addr_t)rmem->base, + rmem->size, rmem->base, + NULL, NULL, + name); + mem->va = devm_ioremap_wc(dev, rmem->base, rmem->size); + if (!mem->va) + return -ENOMEM; + if (!mem) { + dev_err(dev, "unable to initialize memory-region %s\n", + node->name); + return -ENOMEM; + } + dev_dbg(dev, "parsed %s at %llx\r\n", mem->name, + mem->dma); + rproc_add_carveout(rproc, mem); + continue; + } else { + mem = rproc_of_resm_mem_entry_init(dev, i, + rmem->size, + rmem->base, + node->name); + if (!mem) { + dev_err(dev, "unable to initialize memory-region %s \n", + node->name); + return -ENOMEM; + } + mem->va = devm_ioremap_wc(dev, rmem->base, rmem->size); + if (!mem->va) + return -ENOMEM; + + rproc_add_carveout(rproc, mem); + } + if (!mem) + return -ENOMEM; + + + /* + * It is non-DMA memory, used for firmware loading. + * It will be added to the R5 remoteproc mappings later. + */ + zynqmp_mem = devm_kzalloc(dev, sizeof(*zynqmp_mem), GFP_KERNEL); + if (!zynqmp_mem) + return -ENOMEM; + ret = of_address_to_resource(node, 0, &zynqmp_mem->res); + if (ret) { + dev_err(dev, "unable to resolve memory region.\n"); + return ret; + } + list_add_tail(&zynqmp_mem->node, &pdata->mems); + dev_dbg(dev, "%s, non-dma mem %s\n", + __func__, of_node_full_name(node)); + } + + /* map TCM memories */ + for_each_available_child_of_node(np, child) { + struct property *prop; + const __be32 *cur; + u32 pnode_id; + void *va; + dma_addr_t dma; + resource_size_t size; + + ret = of_address_to_resource(child, 0, &rsc); + + i = 0; + of_property_for_each_u32(child, "pnode-id", prop, cur, + pnode_id) { + ret = eemi_ops->request_node(pnode_id, + ZYNQMP_PM_CAPABILITY_ACCESS, 0, + ZYNQMP_PM_REQUEST_ACK_BLOCKING); + if (ret < 0) { + dev_err(dev, "failed to request power node: %u\n", + pnode_id); + return ret; + } + ret = r5_set_mode(pdata); + if (ret < 0) { + dev_err(dev, "failed to set R5 operation mode.\n"); + return ret; + } + } + size = resource_size(&rsc); + + va = devm_ioremap_wc(dev, rsc.start, size); + if (!va) + return -ENOMEM; + + /* zero out tcm base address */ + if (rsc.start & 0xffe00000) { + rsc.start &= 0x000fffff; + /* handle tcm banks 1 a and b (0xffe9000 and oxffeb0000) */ + if (rsc.start & 0x80000) + rsc.start -= 0x90000; + } + + dma = (dma_addr_t)rsc.start; + mem = rproc_mem_entry_init(dev, va, dma, (int)size, rsc.start, + NULL, zynqmp_r5_mem_release, + rsc.name); + if (!mem) + return -ENOMEM; + + rproc_add_carveout(rproc, mem); + } + + ret = rproc_elf_load_rsc_table(rproc, fw); + if (ret == -EINVAL) + ret = 0; + return ret; +} + +/* kick a firmware */ +static void zynqmp_r5_rproc_kick(struct rproc *rproc, int vqid) +{ + struct device *dev = rproc->dev.parent; + struct zynqmp_r5_pdata *local = rproc->priv; + + dev_dbg(dev, "KICK Firmware to start send messages vqid %d\n", vqid); + + if (vqid < 0) { + /* If vqid is negative, does not pass the vqid to + * mailbox. As vqid is supposed to be 0 or possive. + * It also gives a way to just kick instead but + * not use the IPI buffer. It is better to provide + * a proper way to pass the short message, which will + * need to sync to upstream first, for now, + * use negative vqid to assume no message will be + * passed with IPI buffer, but just raise interrupt. + * This will be faster as it doesn't need to copy the + * message to the IPI buffer. + * + * It will ignore the return, as failure is due to + * there already kicks in the mailbox queue. + */ + (void)mbox_send_message(local->tx_chan, NULL); + } else { + struct sk_buff *skb; + unsigned int skb_len; + struct zynqmp_ipi_message *mb_msg; + int ret; + + skb_len = (unsigned int)(sizeof(vqid) + sizeof(mb_msg)); + skb = alloc_skb(skb_len, GFP_ATOMIC); + if (!skb) { + dev_err(dev, + "Failed to allocate skb to kick remote.\n"); + return; + } + mb_msg = (struct zynqmp_ipi_message *)skb_put(skb, skb_len); + mb_msg->len = sizeof(vqid); + memcpy(mb_msg->data, &vqid, sizeof(vqid)); + skb_queue_tail(&local->tx_mc_skbs, skb); + ret = mbox_send_message(local->tx_chan, mb_msg); + if (ret < 0) { + dev_warn(dev, "Failed to kick remote.\n"); + skb_dequeue_tail(&local->tx_mc_skbs); + kfree_skb(skb); + } + } +} + +static struct rproc_ops zynqmp_r5_rproc_ops = { + .start = zynqmp_r5_rproc_start, + .stop = zynqmp_r5_rproc_stop, + .load = rproc_elf_load_segments, + .parse_fw = zynqmp_r5_parse_fw, + .find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table, + .sanity_check = rproc_elf_sanity_check, + .get_boot_addr = rproc_elf_get_boot_addr, + .kick = zynqmp_r5_rproc_kick, +}; + +/* zynqmp_r5_mem_probe() - probes RPU TCM memory device + * @pdata: pointer to the RPU remoteproc private data + * @node: pointer to the memory node + * + * Function to retrieve memories resources for RPU TCM memory device. + */ +static int zynqmp_r5_mem_probe(struct zynqmp_r5_pdata *pdata, + struct device_node *node) +{ + struct device *dev; + struct zynqmp_r5_mem *mem; + int ret; + + dev = &pdata->dev; + mem = devm_kzalloc(dev, sizeof(*mem), GFP_KERNEL); + if (!mem) + return -ENOMEM; + ret = of_address_to_resource(node, 0, &mem->res); + if (ret < 0) { + dev_err(dev, "failed to get resource of memory %s", + of_node_full_name(node)); + return -EINVAL; + } + + /* Get the power domain id */ + if (of_find_property(node, "pnode-id", NULL)) { + struct property *prop; + const __be32 *cur; + u32 val; + int i = 0; + + of_property_for_each_u32(node, "pnode-id", prop, cur, val) + mem->pnode_id[i++] = val; + } + list_add_tail(&mem->node, &pdata->mems); + return 0; +} + +/** + * zynqmp_r5_release() - ZynqMP R5 device release function + * @dev: pointer to the device struct of ZynqMP R5 + * + * Function to release ZynqMP R5 device. + */ +static void zynqmp_r5_release(struct device *dev) +{ + struct zynqmp_r5_pdata *pdata; + struct rproc *rproc; + struct sk_buff *skb; + + pdata = dev_get_drvdata(dev); + rproc = pdata->rproc; + if (rproc) { + rproc_del(rproc); + rproc_free(rproc); + } + if (pdata->tx_chan) + mbox_free_channel(pdata->tx_chan); + if (pdata->rx_chan) + mbox_free_channel(pdata->rx_chan); + /* Discard all SKBs */ + while (!skb_queue_empty(&pdata->tx_mc_skbs)) { + skb = skb_dequeue(&pdata->tx_mc_skbs); + kfree_skb(skb); + } + + put_device(dev->parent); +} + +/** + * event_notified_idr_cb() - event notified idr callback + * @id: idr id + * @ptr: pointer to idr private data + * @data: data passed to idr_for_each callback + * + * Pass notification to remtoeproc virtio + * + * Return: 0. having return is to satisfy the idr_for_each() function + * pointer input argument requirement. + **/ +static int event_notified_idr_cb(int id, void *ptr, void *data) +{ + struct rproc *rproc = data; + + (void)rproc_vq_interrupt(rproc, id); + return 0; +} + +/** + * handle_event_notified() - remoteproc notification work funciton + * @work: pointer to the work structure + * + * It checks each registered remoteproc notify IDs. + */ +static void handle_event_notified(struct work_struct *work) +{ + struct rproc *rproc; + struct zynqmp_r5_pdata *local; + + local = container_of(work, struct zynqmp_r5_pdata, workqueue); + + (void)mbox_send_message(local->rx_chan, NULL); + rproc = local->rproc; + /* + * We only use IPI for interrupt. The firmware side may or may + * not write the notifyid when it trigger IPI. + * And thus, we scan through all the registered notifyids. + */ + idr_for_each(&rproc->notifyids, event_notified_idr_cb, rproc); +} + +/** + * zynqmp_r5_mb_rx_cb() - Receive channel mailbox callback + * @cl: mailbox client + * @mssg: message pointer + * + * It will schedule the R5 notification work. + */ +static void zynqmp_r5_mb_rx_cb(struct mbox_client *cl, void *mssg) +{ + struct zynqmp_r5_pdata *local; + + local = container_of(cl, struct zynqmp_r5_pdata, rx_mc); + if (mssg) { + struct zynqmp_ipi_message *ipi_msg, *buf_msg; + size_t len; + + ipi_msg = (struct zynqmp_ipi_message *)mssg; + buf_msg = (struct zynqmp_ipi_message *)local->rx_mc_buf; + len = (ipi_msg->len >= IPI_BUF_LEN_MAX) ? + IPI_BUF_LEN_MAX : ipi_msg->len; + buf_msg->len = len; + memcpy(buf_msg->data, ipi_msg->data, len); + } + schedule_work(&local->workqueue); +} + +/** + * zynqmp_r5_mb_tx_done() - Request has been sent to the remote + * @cl: mailbox client + * @mssg: pointer to the message which has been sent + * @r: status of last TX - OK or error + * + * It will be called by the mailbox framework when the last TX has done. + */ +static void zynqmp_r5_mb_tx_done(struct mbox_client *cl, void *mssg, int r) +{ + struct zynqmp_r5_pdata *local; + struct sk_buff *skb; + + if (!mssg) + return; + local = container_of(cl, struct zynqmp_r5_pdata, tx_mc); + skb = skb_dequeue(&local->tx_mc_skbs); + kfree_skb(skb); +} + +/** + * zynqmp_r5_setup_mbox() - Setup mailboxes + * + * @pdata: pointer to the ZynqMP R5 processor platform data + * @node: pointer of the device node + * + * Function to setup mailboxes to talk to RPU. + * + * Return: 0 for success, negative value for failure. + */ +static int zynqmp_r5_setup_mbox(struct zynqmp_r5_pdata *pdata, + struct device_node *node) +{ + struct device *dev = &pdata->dev; + struct mbox_client *mclient; + + /* Setup TX mailbox channel client */ + mclient = &pdata->tx_mc; + mclient->dev = dev; + mclient->rx_callback = NULL; + mclient->tx_block = false; + mclient->knows_txdone = false; + mclient->tx_done = zynqmp_r5_mb_tx_done; + + /* Setup TX mailbox channel client */ + mclient = &pdata->rx_mc; + mclient->dev = dev; + mclient->rx_callback = zynqmp_r5_mb_rx_cb; + mclient->tx_block = false; + mclient->knows_txdone = false; + + INIT_WORK(&pdata->workqueue, handle_event_notified); + + /* Request TX and RX channels */ + pdata->tx_chan = mbox_request_channel_byname(&pdata->tx_mc, "tx"); + if (IS_ERR(pdata->tx_chan)) { + dev_err(dev, "failed to request mbox tx channel.\n"); + pdata->tx_chan = NULL; + return -EINVAL; + } + pdata->rx_chan = mbox_request_channel_byname(&pdata->rx_mc, "rx"); + if (IS_ERR(pdata->rx_chan)) { + dev_err(dev, "failed to request mbox rx channel.\n"); + pdata->rx_chan = NULL; + return -EINVAL; + } + skb_queue_head_init(&pdata->tx_mc_skbs); + return 0; +} + +/** + * zynqmp_r5_probe() - Probes ZynqMP R5 processor device node + * @pdata: pointer to the ZynqMP R5 processor platform data + * @pdev: parent RPU domain platform device + * @node: pointer of the device node + * + * Function to retrieve the information of the ZynqMP R5 device node. + * + * Return: 0 for success, negative value for failure. + */ +static int zynqmp_r5_probe(struct zynqmp_r5_pdata *pdata, + struct platform_device *pdev, + struct device_node *node) +{ + struct device *dev = &pdata->dev; + struct rproc *rproc; + struct device_node *nc; + int ret; + + /* Create device for ZynqMP R5 device */ + dev->parent = &pdev->dev; + dev->release = zynqmp_r5_release; + dev->of_node = node; + dev_set_name(dev, "%s", of_node_full_name(node)); + dev_set_drvdata(dev, pdata); + ret = device_register(dev); + if (ret) { + dev_err(dev, "failed to register device.\n"); + return ret; + } + get_device(&pdev->dev); + + /* Allocate remoteproc instance */ + rproc = rproc_alloc(dev, dev_name(dev), &zynqmp_r5_rproc_ops, NULL, 0); + if (!rproc) { + dev_err(dev, "rproc allocation failed.\n"); + ret = -ENOMEM; + goto error; + } + rproc->auto_boot = autoboot; + pdata->rproc = rproc; + rproc->priv = pdata; + + /* + * The device has not been spawned from a device tree, so + * arch_setup_dma_ops has not been not called, thus leaving + * the device with dummy DMA ops. + * Fix this by inheriting the parent's DMA ops and mask. + */ + rproc->dev.dma_mask = pdev->dev.dma_mask; + set_dma_ops(&rproc->dev, get_dma_ops(&pdev->dev)); + + /* Probe R5 memory devices */ + INIT_LIST_HEAD(&pdata->mems); + for_each_available_child_of_node(node, nc) { + ret = zynqmp_r5_mem_probe(pdata, nc); + if (ret) { + dev_err(dev, "failed to probe memory %s.\n", + of_node_full_name(nc)); + goto error; + } + } + + /* Set up DMA mask */ + ret = dma_set_coherent_mask(dev, DMA_BIT_MASK(32)); + if (ret) { + dev_warn(dev, "dma_set_coherent_mask failed: %d\n", ret); + /* If DMA is not configured yet, try to configure it. */ + ret = of_dma_configure(dev, node, true); + if (ret) { + dev_err(dev, "failed to configure DMA.\n"); + goto error; + } + } + + /* Get R5 power domain node */ + ret = of_property_read_u32(node, "pnode-id", &pdata->pnode_id); + if (ret) { + dev_err(dev, "failed to get power node id.\n"); + goto error; + } + + /* Check if R5 is running */ + if (r5_is_running(pdata)) { + atomic_inc(&rproc->power); + rproc->state = RPROC_RUNNING; + } + + if (!of_get_property(dev->of_node, "mboxes", NULL)) { + dev_info(dev, "no mailboxes.\n"); + } else { + ret = zynqmp_r5_setup_mbox(pdata, node); + if (ret < 0) + goto error; + } + + /* Add R5 remoteproc */ + ret = rproc_add(rproc); + if (ret) { + dev_err(dev, "rproc registration failed\n"); + goto error; + } + return 0; +error: + if (pdata->rproc) + rproc_free(pdata->rproc); + pdata->rproc = NULL; + device_unregister(dev); + put_device(&pdev->dev); + return ret; +} + +static int zynqmp_r5_remoteproc_probe(struct platform_device *pdev) +{ + const unsigned char *prop; + int ret = 0, i; + struct device *dev = &pdev->dev; + struct device_node *nc; + + eemi_ops = zynqmp_pm_get_eemi_ops(); + if (IS_ERR(eemi_ops)) + return PTR_ERR(eemi_ops); + + prop = of_get_property(dev->of_node, "core_conf", NULL); + if (!prop) { + dev_err(&pdev->dev, "core_conf is not used.\n"); + return -EINVAL; + } + + dev_info(dev, "RPU core_conf: %s\n", prop); + if (!strcmp(prop, "split")) { + rpu_mode = PM_RPU_MODE_SPLIT; + } else if (!strcmp(prop, "lockstep")) { + rpu_mode = PM_RPU_MODE_LOCKSTEP; + } else { + dev_err(dev, + "Invalid core_conf mode provided - %s , %d\n", + prop, (int)rpu_mode); + return -EINVAL; + } + + i = 0; + for_each_available_child_of_node(dev->of_node, nc) { + ret = zynqmp_r5_probe(&(rpus[i]), pdev, nc); + if (ret) { + dev_err(dev, "failed to probe rpu %s.\n", + of_node_full_name(nc)); + return ret; + } + i++; + } + + return 0; +} + +static int zynqmp_r5_remoteproc_remove(struct platform_device *pdev) +{ + int i; + + for (i = 0; i < MAX_RPROCS; i++) { + struct zynqmp_r5_pdata *rpu = &rpus[i]; + struct rproc *rproc; + + rproc = rpu->rproc; + if (rproc) { + rproc_del(rproc); + rproc_free(rproc); + rpu->rproc = NULL; + } + if (rpu->tx_chan) { + mbox_free_channel(rpu->tx_chan); + rpu->tx_chan = NULL; + } + if (rpu->rx_chan) { + mbox_free_channel(rpu->rx_chan); + rpu->rx_chan = NULL; + } + + device_unregister(&rpu->dev); + } + + return 0; +} + +/* Match table for OF platform binding */ +static const struct of_device_id zynqmp_r5_remoteproc_match[] = { + { .compatible = "xlnx,zynqmp-r5-remoteproc-1.0", }, + { /* end of list */ }, +}; +MODULE_DEVICE_TABLE(of, zynqmp_r5_remoteproc_match); + +static struct platform_driver zynqmp_r5_remoteproc_driver = { + .probe = zynqmp_r5_remoteproc_probe, + .remove = zynqmp_r5_remoteproc_remove, + .driver = { + .name = "zynqmp_r5_remoteproc", + .of_match_table = zynqmp_r5_remoteproc_match, + }, +}; +module_platform_driver(zynqmp_r5_remoteproc_driver); + +module_param_named(autoboot, autoboot, bool, 0444); +MODULE_PARM_DESC(autoboot, + "enable | disable autoboot. (default: true)"); + +MODULE_AUTHOR("Ben Levinsky "); +MODULE_LICENSE("GPL v2"); +MODULE_DESCRIPTION("ZynqMP R5 remote processor control driver");