From nobody Wed Dec 17 08:52:59 2025 Received: from mail-oi1-f171.google.com (mail-oi1-f171.google.com [209.85.167.171]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id EFD8F15442A for ; Thu, 27 Mar 2025 22:16:34 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.167.171 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1743113798; cv=none; b=rS0elShpOY25XA8Dsr1IosK31pb2xB2aQTCQ6SmxbHZYYtktnD06yfJ96BLG46v+w3m4alZVoE54pDkyrYe5+5V8Rk0we4E/9RC1tKyOqtvuREPKri7GokEMqwk31CyFS/Rg4RI3Goa3QxSqiau/KcwVH1BsNBlZyCkrl4kefM4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1743113798; c=relaxed/simple; bh=ZUWTAg5bm0DPfXu0tABm6vxRiz0LhapIPPThKe8x+0M=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=e73dHFYTfv6KwBRFjmt/6wSGEe2jPLeXIrXvHLmY8DgbJSbg3MxWhn289jdtwt74Ss1KsF56eVTLgC0lkheegXdAvVzzCzSS1wGa4NLwHhu61qD9tCzA+Luzuu52eXfQmjiH01gX8lzMielI7YjrwOzOSP1akJSkKWY1RfPWksM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=broadcom.com; spf=fail smtp.mailfrom=broadcom.com; dkim=pass (1024-bit key) header.d=broadcom.com header.i=@broadcom.com header.b=PohKB2uc; arc=none smtp.client-ip=209.85.167.171 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=broadcom.com Authentication-Results: smtp.subspace.kernel.org; spf=fail smtp.mailfrom=broadcom.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=broadcom.com header.i=@broadcom.com header.b="PohKB2uc" Received: by mail-oi1-f171.google.com with SMTP id 5614622812f47-3fe83c8cbdbso413758b6e.3 for ; Thu, 27 Mar 2025 15:16:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=broadcom.com; s=google; t=1743113794; x=1743718594; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=DsXm9DigU+g+r4oqoboNOcoDNqsj6iJcfB9oGhR8tck=; b=PohKB2ucTZ3AaVFO5my8qhZG4QJyVbQY4yESUBfNiIyMpS1y76dCT3mW0GSi8ncefW Y75Dr+oeQGAhrm40B+YdsiMjRHOnAsQaCBmQYd4d8rEJVrwL9zhRCGC1hjwuz8fHbPMh AsCOzVUd/yKxvmGv54uovdL39maA54Nnun6dA= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1743113794; x=1743718594; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=DsXm9DigU+g+r4oqoboNOcoDNqsj6iJcfB9oGhR8tck=; b=sY8Lih+GixCRaqAD8eIZMd+XQoIGJy+3rPvOUWv6KG2ZkDTqrwZxevodydJ1I56ETg AFvbsVceefJEl7M/lxfYVU0m5YP4F2k2YVcJMiwYlNfSfgiUQkw3Rl3ITJZccqcZjn9l vJCgwT2prqQGZyIyVGe80shnsk7+0xfdwrdHFK4Tzl6v7QH3xDNFjgjkCkERFPMvn2WD 6BU6dGvSBMhH9CWl2wjwtx9blhNa4lASjp5kaToG9RUbH7d+Y5hRl4Vi0LphCVXkzrEu mc5/EwYVZpAusvl5Uh3QE+FGAJKnzzzNDE4E9jarykQNdF/G/xiFaFyKeXo7vz1UfeeI rgVw== X-Forwarded-Encrypted: i=1; AJvYcCUe+iBXpJs3E0Xhxns4fT1g5m2dyIrhFUzkv1pUchsV0Q3/QvMTLCldSZ3NnFlgi0cdlxF2MEpUspes3wg=@vger.kernel.org X-Gm-Message-State: AOJu0Yx9CQHoBbRgVQJGUpt0ZmPUtGhujcQlkJ5BZaJJKS+yIOWeZXHp kiN3uYXCKw94rWqNebwXTv+ealktXom+X85A7duKn+XRkpFHuiDNoz9axnynuQ== X-Gm-Gg: ASbGncuYelhTGIo9uz8lxWsDVBy+la2SUDcUnLmDDAncIGZf61t2+mf3mCI+xbkl/WO JBkq2hflrhXWxG4hqES7DnSoPmX+zlWEyXl5C9pihHoha/6wByrolOpbB7q5havLrfhEQCw3m4X bMQ018KeUi8XSyy661hlzTPt1ZjjWwvfqnKen5nzhUt23eEhqNYCNZpoZoVcucYeErj3ItHo29i gNeCoHHQjKq5W8byCXhfcQN81osLmuufKBxoM/pVOV5HKa/hxbh+CmxExM6S/ie9y4/ODzmlZrZ OWDcwox2S02PMJqxCSfIPvaiNif+WL7GKkbqHSp4t3fGfDaXPAkx7Us2fFYxnrSVQ2GX3ghNmgA IRbyGQK3uJidw1/+sbRISefFRK6dSZP6M X-Google-Smtp-Source: AGHT+IFLtCIY5c1uPVgqPOtxo1Z0R7fHrfXIew+goBDofLT5NQD6vYfjC99hGxsoiv96YMecZbZQaQ== X-Received: by 2002:a05:6808:1811:b0:3fc:11a6:7433 with SMTP id 5614622812f47-3fefa63099bmr2994093b6e.36.1743113793640; Thu, 27 Mar 2025 15:16:33 -0700 (PDT) Received: from stbirv-lnx-1.igp.broadcom.net ([192.19.223.252]) by smtp.gmail.com with ESMTPSA id 5614622812f47-3ff051680a8sm105031b6e.1.2025.03.27.15.16.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 27 Mar 2025 15:16:33 -0700 (PDT) From: justin.chen@broadcom.com To: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Cc: florian.fainelli@broadcom.com, conor+dt@kernel.org, krzk+dt@kernel.org, robh@kernel.org, jassisinghbrar@gmail.com, bcm-kernel-feedback-list@broadcom.com, Justin Chen Subject: [PATCH 1/2] mailbox: Add support for bcm74110 mailbox Date: Thu, 27 Mar 2025 15:16:27 -0700 Message-Id: <20250327221628.651042-2-justin.chen@broadcom.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250327221628.651042-1-justin.chen@broadcom.com> References: <20250327221628.651042-1-justin.chen@broadcom.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Justin Chen The bcm74110 mailbox driver is used to communicate with a co-processor for various power management and firmware related tasks. Signed-off-by: Justin Chen --- drivers/mailbox/Kconfig | 10 + drivers/mailbox/Makefile | 2 + drivers/mailbox/bcm74110-mailbox.c | 661 +++++++++++++++++++++++++++++ 3 files changed, 673 insertions(+) create mode 100644 drivers/mailbox/bcm74110-mailbox.c diff --git a/drivers/mailbox/Kconfig b/drivers/mailbox/Kconfig index ed52db272f4d..6fe3356ddde5 100644 --- a/drivers/mailbox/Kconfig +++ b/drivers/mailbox/Kconfig @@ -330,4 +330,14 @@ config THEAD_TH1520_MBOX kernel is running, and E902 core used for power management among other things. =20 +config BCM74110_MAILBOX + tristate "Brcmstb BCM74110 Mailbox" + depends on ARCH_BRCMSTB || COMPILE_TEST + default ARCH_BRCMSTB + help + Broadcom STB mailbox driver present starting with brcmstb bcm74110 + SoCs. The mailbox is a communication channel between the host + processor and coprocessor that handles various power management task + and more. + endif diff --git a/drivers/mailbox/Makefile b/drivers/mailbox/Makefile index 9a1542b55539..eb2e8f55bd15 100644 --- a/drivers/mailbox/Makefile +++ b/drivers/mailbox/Makefile @@ -70,3 +70,5 @@ obj-$(CONFIG_QCOM_CPUCP_MBOX) +=3D qcom-cpucp-mbox.o obj-$(CONFIG_QCOM_IPCC) +=3D qcom-ipcc.o =20 obj-$(CONFIG_THEAD_TH1520_MBOX) +=3D mailbox-th1520.o + +obj-$(CONFIG_BCM74110_MAILBOX) +=3D bcm74110-mailbox.o diff --git a/drivers/mailbox/bcm74110-mailbox.c b/drivers/mailbox/bcm74110-= mailbox.c new file mode 100644 index 000000000000..9d5896725704 --- /dev/null +++ b/drivers/mailbox/bcm74110-mailbox.c @@ -0,0 +1,661 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Broadcom BCM74110 Mailbox Driver + * + * Copyright (c) 2025 Broadcom + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define BCM_MBOX_BASE(sel) ((sel) * 0x40) +#define BCM_MBOX_IRQ_BASE(sel) (((sel) * 0x20) + 0x800) + +#define BCM_MBOX_CFGA 0x0 +#define BCM_MBOX_CFGB 0x4 +#define BCM_MBOX_CFGC 0x8 +#define BCM_MBOX_CFGD 0xc +#define BCM_MBOX_CTRL 0x10 +#define BCM_MBOX_CTRL_EN BIT(0) +#define BCM_MBOX_CTRL_CLR BIT(1) +#define BCM_MBOX_STATUS0 0x14 +#define BCM_MBOX_STATUS0_NOT_EMPTY BIT(28) +#define BCM_MBOX_STATUS0_FULL BIT(29) +#define BCM_MBOX_STATUS1 0x18 +#define BCM_MBOX_STATUS2 0x1c +#define BCM_MBOX_WDATA 0x20 +#define BCM_MBOX_RDATA 0x28 + +#define BCM_MBOX_IRQ_STATUS 0x0 +#define BCM_MBOX_IRQ_SET 0x4 +#define BCM_MBOX_IRQ_CLEAR 0x8 +#define BCM_MBOX_IRQ_MASK_STATUS 0xc +#define BCM_MBOX_IRQ_MASK_SET 0x10 +#define BCM_MBOX_IRQ_MASK_CLEAR 0x14 +#define BCM_MBOX_IRQ_TIMEOUT BIT(0) +#define BCM_MBOX_IRQ_NOT_EMPTY BIT(1) +#define BCM_MBOX_IRQ_FULL BIT(2) +#define BCM_MBOX_IRQ_LOW_WM BIT(3) +#define BCM_MBOX_IRQ_HIGH_WM BIT(4) + +#define BCM_LINK_CODE0 0xbe0 +#define BCM_LINK_CODE1 0xbe1 +#define BCM_LINK_CODE2 0xbe2 + +enum { + BCM_MSG_FUNC_LINK_START =3D 0, + BCM_MSG_FUNC_LINK_STOP, + BCM_MSG_FUNC_SHMEM_TX, + BCM_MSG_FUNC_SHMEM_RX, + BCM_MSG_FUNC_SHMEM_STOP, + BCM_MSG_FUNC_MAX, +}; + +enum { + BCM_MSG_SVC_INIT =3D 0, + BCM_MSG_SVC_PMC, + BCM_MSG_SVC_SCMI, + BCM_MSG_SVC_DPFE, + BCM_MSG_SVC_MAX, +}; + +struct bcm74110_mbox_msg { + struct list_head list_entry; +#define BCM_MSG_VERSION_MASK GENMASK(31, 29) +#define BCM_MSG_VERSION 0x1 +#define BCM_MSG_REQ_MASK BIT(28) +#define BCM_MSG_RPLY_MASK BIT(27) +#define BCM_MSG_SVC_MASK GENMASK(26, 24) +#define BCM_MSG_FUNC_MASK GENMASK(23, 16) +#define BCM_MSG_LENGTH_MASK GENMASK(15, 4) +#define BCM_MSG_SLOT_MASK GENMASK(3, 0) + +#define BCM_MSG_SET_FIELD(hdr, field, val) \ + do { \ + hdr &=3D ~BCM_MSG_##field##_MASK; \ + hdr |=3D FIELD_PREP(BCM_MSG_##field##_MASK, val); \ + } while (0) + +#define BCM_MSG_GET_FIELD(hdr, field) \ + FIELD_GET(BCM_MSG_##field##_MASK, hdr) + u32 msg; +}; + +struct bcm74110_mbox_chan { + struct bcm74110_mbox *mbox; + bool en; + int slot; + int type; +}; + +#define BCM_MBOX_SLOT_SIZE 0x100 +struct bcm74110_mbox { + struct platform_device *pdev; + void __iomem *base; + + /* TX */ + int tx_chan; + void __iomem *base_tx; + + /* RX */ + int rx_chan; + int rx_irq; + void __iomem *base_rx; + void __iomem *base_rx_irq; + struct list_head rx_svc_init_list; + spinlock_t rx_svc_list_lock; + + struct mbox_controller controller; + struct bcm74110_mbox_chan *mbox_chan; + int shmem_offset; + int shmem_size; +}; + +static inline struct bcm74110_mbox *bcm74110_mbox_from_cntrl( + struct mbox_controller *cntrl) +{ + return container_of(cntrl, struct bcm74110_mbox, controller); +} + +static void bcm74110_rx_push_init_msg(struct bcm74110_mbox *mbox, u32 val) +{ + struct bcm74110_mbox_msg *msg; + + msg =3D kzalloc(sizeof(*msg), GFP_ATOMIC); + if (!msg) + return; + + INIT_LIST_HEAD(&msg->list_entry); + msg->msg =3D val; + + spin_lock(&mbox->rx_svc_list_lock); + list_add_tail(&msg->list_entry, &mbox->rx_svc_init_list); + spin_unlock(&mbox->rx_svc_list_lock); +} + +static void bcm74110_rx_process_msg(struct bcm74110_mbox *mbox) +{ + struct device *dev =3D &mbox->pdev->dev; + struct bcm74110_mbox_chan *chan_priv; + struct mbox_chan *chan; + u32 msg, status; + int type; + + do { + msg =3D readl_relaxed(mbox->base_rx + BCM_MBOX_RDATA); + status =3D readl_relaxed(mbox->base_rx + BCM_MBOX_STATUS0); + + dev_dbg(dev, "rx: [{req=3D%lu|rply=3D%lu|srv=3D%lu|fn=3D%lu|length=3D%lu= |slot=3D%lu]\n", + BCM_MSG_GET_FIELD(msg, REQ), BCM_MSG_GET_FIELD(msg, RPLY), + BCM_MSG_GET_FIELD(msg, SVC), BCM_MSG_GET_FIELD(msg, FUNC), + BCM_MSG_GET_FIELD(msg, LENGTH), BCM_MSG_GET_FIELD(msg, SLOT)); + + type =3D BCM_MSG_GET_FIELD(msg, SVC); + switch (type) { + case BCM_MSG_SVC_INIT: + bcm74110_rx_push_init_msg(mbox, msg); + break; + case BCM_MSG_SVC_PMC: + case BCM_MSG_SVC_SCMI: + case BCM_MSG_SVC_DPFE: + chan =3D &mbox->controller.chans[type]; + chan_priv =3D chan->con_priv; + if (chan_priv->en) + mbox_chan_received_data(chan, NULL); + else + dev_warn(dev, "Channel not enabled\n"); + break; + default: + dev_warn(dev, "Unsupported msg received\n"); + } + } while (status & BCM_MBOX_STATUS0_NOT_EMPTY); +} + +static irqreturn_t bcm74110_mbox_isr(int irq, void *data) +{ + struct bcm74110_mbox *mbox =3D data; + u32 status; + + status =3D readl_relaxed(mbox->base_rx_irq + BCM_MBOX_IRQ_STATUS); + + writel_relaxed(0xffffffff, mbox->base_rx_irq + BCM_MBOX_IRQ_CLEAR); + + if (status & BCM_MBOX_IRQ_NOT_EMPTY) + bcm74110_rx_process_msg(mbox); + else + dev_warn(&mbox->pdev->dev, "Spurious interrupt\n"); + + return IRQ_HANDLED; +} + +static void bcm74110_mbox_mask_and_clear(struct bcm74110_mbox *mbox) +{ + writel_relaxed(0xffffffff, mbox->base_rx_irq + BCM_MBOX_IRQ_MASK_SET); + writel_relaxed(0xffffffff, mbox->base_rx_irq + BCM_MBOX_IRQ_CLEAR); +} + +static int bcm74110_rx_pop_init_msg(struct bcm74110_mbox *mbox, u32 func_t= ype, + u32 *val) +{ + struct bcm74110_mbox_msg *msg, *msg_tmp; + unsigned long flags; + bool found =3D false; + + spin_lock_irqsave(&mbox->rx_svc_list_lock, flags); + list_for_each_entry_safe(msg, msg_tmp, &mbox->rx_svc_init_list, + list_entry) { + if (BCM_MSG_GET_FIELD(msg->msg, FUNC) =3D=3D func_type) { + list_del(&msg->list_entry); + found =3D true; + break; + } + } + spin_unlock_irqrestore(&mbox->rx_svc_list_lock, flags); + + if (!found) + return -EINVAL; + + *val =3D msg->msg; + kfree(msg); + + return 0; +} + +static void bcm74110_rx_flush_msg(struct bcm74110_mbox *mbox) +{ + struct bcm74110_mbox_msg *msg, *msg_tmp; + LIST_HEAD(list_temp); + unsigned long flags; + + spin_lock_irqsave(&mbox->rx_svc_list_lock, flags); + list_splice_init(&mbox->rx_svc_init_list, &list_temp); + spin_unlock_irqrestore(&mbox->rx_svc_list_lock, flags); + + list_for_each_entry_safe(msg, msg_tmp, &list_temp, list_entry) { + list_del(&msg->list_entry); + kfree(msg); + } +} + +#define BCM_DEQUEUE_TIMEOUT_MS 30 +static int bcm74110_rx_pop_init_msg_block(struct bcm74110_mbox *mbox, u32 = func_type, + u32 *val) +{ + int ret, timeout =3D 0; + + do { + ret =3D bcm74110_rx_pop_init_msg(mbox, func_type, val); + + if (!ret) + return 0; + + /* TODO: Figure out what is a good sleep here. */ + usleep_range(1000, 2000); + timeout++; + } while (timeout < BCM_DEQUEUE_TIMEOUT_MS); + + dev_warn(&mbox->pdev->dev, "Timeout waiting for service init response\n"); + return -ETIMEDOUT; +} + +static int bcm74110_mbox_create_msg(int req, int rply, int svc, int func, + int length, int slot) +{ + u32 msg =3D 0; + + BCM_MSG_SET_FIELD(msg, REQ, req); + BCM_MSG_SET_FIELD(msg, RPLY, rply); + BCM_MSG_SET_FIELD(msg, SVC, svc); + BCM_MSG_SET_FIELD(msg, FUNC, func); + BCM_MSG_SET_FIELD(msg, LENGTH, length); + BCM_MSG_SET_FIELD(msg, SLOT, slot); + + return msg; +} + +static int bcm74110_mbox_tx_msg(struct bcm74110_mbox *mbox, u32 msg) +{ + int val; + + /* We can potentially poll with timeout here instead */ + val =3D readl_relaxed(mbox->base_tx + BCM_MBOX_STATUS0); + if (val & BCM_MBOX_STATUS0_FULL) { + dev_err(&mbox->pdev->dev, "Mailbox full\n"); + return -EINVAL; + } + + dev_dbg(&mbox->pdev->dev, "tx: [{req=3D%lu|rply=3D%lu|srv=3D%lu|fn=3D%lu|= length=3D%lu|slot=3D%lu]\n", + BCM_MSG_GET_FIELD(msg, REQ), BCM_MSG_GET_FIELD(msg, RPLY), + BCM_MSG_GET_FIELD(msg, SVC), BCM_MSG_GET_FIELD(msg, FUNC), + BCM_MSG_GET_FIELD(msg, LENGTH), BCM_MSG_GET_FIELD(msg, SLOT)); + + writel_relaxed(msg, mbox->base_tx + BCM_MBOX_WDATA); + + return 0; +} + +#define BCM_MBOX_LINK_TRAINING_RETRIES 5 +static int bcm74110_mbox_link_training(struct bcm74110_mbox *mbox) +{ + int ret, retries =3D 0; + u32 msg =3D 0, orig_len =3D 0, len =3D BCM_LINK_CODE0; + + do { + switch (len) { + case 0: + retries++; + dev_warn(&mbox->pdev->dev, + "Link train failed, trying again... %d\n", + retries); + if (retries > BCM_MBOX_LINK_TRAINING_RETRIES) + return -EINVAL; + len =3D BCM_LINK_CODE0; + fallthrough; + case BCM_LINK_CODE0: + case BCM_LINK_CODE1: + case BCM_LINK_CODE2: + msg =3D bcm74110_mbox_create_msg(1, 0, BCM_MSG_SVC_INIT, + BCM_MSG_FUNC_LINK_START, + len, BCM_MSG_SVC_INIT); + break; + default: + break; + } + + bcm74110_mbox_tx_msg(mbox, msg); + + /* No response expected for LINK_CODE2 */ + if (len =3D=3D BCM_LINK_CODE2) + return 0; + + orig_len =3D len; + + ret =3D bcm74110_rx_pop_init_msg_block(mbox, + BCM_MSG_GET_FIELD(msg, FUNC), + &msg); + if (ret) { + len =3D 0; + continue; + } + + if ((BCM_MSG_GET_FIELD(msg, SVC) !=3D BCM_MSG_SVC_INIT) || + (BCM_MSG_GET_FIELD(msg, FUNC) !=3D BCM_MSG_FUNC_LINK_START) || + (BCM_MSG_GET_FIELD(msg, SLOT) !=3D 0) || + (BCM_MSG_GET_FIELD(msg, RPLY) !=3D 1) || + (BCM_MSG_GET_FIELD(msg, REQ) !=3D 0)) { + len =3D 0; + continue; + } + + len =3D BCM_MSG_GET_FIELD(msg, LENGTH); + + /* Make sure sequence is good */ + if (len !=3D (orig_len + 1)) { + len =3D 0; + continue; + } + } while (1); + + return -EINVAL; +} + +static int bcm74110_mbox_tx_msg_and_wait_ack(struct bcm74110_mbox *mbox, u= 32 msg) +{ + int ret; + u32 recv_msg; + + ret =3D bcm74110_mbox_tx_msg(mbox, msg); + if (ret) + return ret; + + ret =3D bcm74110_rx_pop_init_msg_block(mbox, BCM_MSG_GET_FIELD(msg, FUNC), + &recv_msg); + if (ret) + return ret; + + /* + * Modify tx message to verify rx ack. + * Flip RPLY/REQ for synchronous messages + */ + if (BCM_MSG_GET_FIELD(msg, REQ) =3D=3D 1) { + BCM_MSG_SET_FIELD(msg, RPLY, 1); + BCM_MSG_SET_FIELD(msg, REQ, 0); + } + + if (msg !=3D recv_msg) { + dev_err(&mbox->pdev->dev, "Found ack, but ack is invalid\n"); + return -EINVAL; + } + + return 0; +} + +static int bcm74110_mbox_shmem_init(struct bcm74110_mbox *mbox) +{ + u32 msg =3D 0; + int ret; + + msg =3D bcm74110_mbox_create_msg(1, 0, BCM_MSG_SVC_INIT, + BCM_MSG_FUNC_SHMEM_STOP, + 0, BCM_MSG_SVC_INIT); + ret =3D bcm74110_mbox_tx_msg_and_wait_ack(mbox, msg); + if (ret) + return -EINVAL; + + msg =3D bcm74110_mbox_create_msg(1, 0, BCM_MSG_SVC_INIT, + BCM_MSG_FUNC_SHMEM_TX, + mbox->shmem_offset / BCM_MBOX_SLOT_SIZE, + (mbox->shmem_size / BCM_MBOX_SLOT_SIZE) - 1); + ret =3D bcm74110_mbox_tx_msg_and_wait_ack(mbox, msg); + if (ret) + return -EINVAL; + + msg =3D bcm74110_mbox_create_msg(1, 0, BCM_MSG_SVC_INIT, + BCM_MSG_FUNC_SHMEM_RX, + mbox->shmem_offset / BCM_MBOX_SLOT_SIZE, + (mbox->shmem_size / BCM_MBOX_SLOT_SIZE) - 1); + ret =3D bcm74110_mbox_tx_msg_and_wait_ack(mbox, msg); + if (ret) + return -EINVAL; + + return 0; +} + +static int bcm74110_mbox_init(struct bcm74110_mbox *mbox) +{ + int ret =3D 0; + + /* Disable queues tx/rx */ + writel_relaxed(0x0, mbox->base_tx + BCM_MBOX_CTRL); + + /* Clear status & restart tx/rx*/ + writel_relaxed(BCM_MBOX_CTRL_EN | BCM_MBOX_CTRL_CLR, + mbox->base_tx + BCM_MBOX_CTRL); + + /* Unmask irq */ + writel_relaxed(BCM_MBOX_IRQ_NOT_EMPTY, mbox->base_rx_irq + + BCM_MBOX_IRQ_MASK_CLEAR); + + ret =3D bcm74110_mbox_link_training(mbox); + if (ret) { + dev_err(&mbox->pdev->dev, "Training failed\n"); + return ret; + } + + return bcm74110_mbox_shmem_init(mbox); +} + + + +static int bcm74110_mbox_send_data(struct mbox_chan *chan, void *data) +{ + struct bcm74110_mbox_chan *chan_priv =3D chan->con_priv; + u32 msg; + + switch (chan_priv->type) { + case BCM_MSG_SVC_PMC: + case BCM_MSG_SVC_SCMI: + case BCM_MSG_SVC_DPFE: + msg =3D bcm74110_mbox_create_msg(1, 0, chan_priv->type, 0, + 128 + 28, chan_priv->slot); + break; + default: + return -EINVAL; + }; + + return bcm74110_mbox_tx_msg(chan_priv->mbox, msg); +} + +static int bcm74110_mbox_chan_startup(struct mbox_chan *chan) +{ + struct bcm74110_mbox_chan *chan_priv =3D chan->con_priv; + + chan_priv->en =3D true; + + return 0; +} + +static void bcm74110_mbox_chan_shutdown(struct mbox_chan *chan) +{ + struct bcm74110_mbox_chan *chan_priv =3D chan->con_priv; + + chan_priv->en =3D false; +} + +static const struct mbox_chan_ops bcm74110_mbox_chan_ops =3D { + .send_data =3D bcm74110_mbox_send_data, + .startup =3D bcm74110_mbox_chan_startup, + .shutdown =3D bcm74110_mbox_chan_shutdown, +}; + +static void bcm74110_mbox_shutdown(struct platform_device *pdev) +{ + struct bcm74110_mbox *mbox =3D dev_get_drvdata(&pdev->dev); + u32 msg; + + msg =3D bcm74110_mbox_create_msg(1, 0, BCM_MSG_SVC_INIT, + BCM_MSG_FUNC_LINK_STOP, + 0, 0); + + bcm74110_mbox_tx_msg_and_wait_ack(mbox, msg); + + /* Even if we don't receive ACK, lets shut it down */ + + bcm74110_mbox_mask_and_clear(mbox); + + /* Disable queues tx/rx */ + writel_relaxed(0x0, mbox->base_tx + BCM_MBOX_CTRL); + + /* Flush queues */ + bcm74110_rx_flush_msg(mbox); +} + +static struct mbox_chan *bcm74110_mbox_of_xlate(struct mbox_controller *cn= trl, + const struct of_phandle_args *p) +{ + struct bcm74110_mbox *mbox =3D bcm74110_mbox_from_cntrl(cntrl); + struct device *dev =3D &mbox->pdev->dev; + struct bcm74110_mbox_chan *chan_priv; + int slot, type; + + if (p->args_count !=3D 2) { + dev_err(dev, "Invalid arguments\n"); + return ERR_PTR(-EINVAL); + } + + type =3D p->args[0]; + slot =3D p->args[1]; + + switch (type) { + case BCM_MSG_SVC_PMC: + case BCM_MSG_SVC_SCMI: + case BCM_MSG_SVC_DPFE: + if ((slot * BCM_MBOX_SLOT_SIZE) - 1 > mbox->shmem_size) { + dev_err(dev, "Not enough shared memory\n"); + return ERR_PTR(-EINVAL); + } + chan_priv =3D cntrl->chans[type].con_priv; + chan_priv->slot =3D slot; + chan_priv->type =3D type; + break; + default: + dev_err(dev, "Invalid channel type: %d\n", type); + return ERR_PTR(-EINVAL); + }; + + return &cntrl->chans[type]; +} + +static int bcm74110_mbox_probe(struct platform_device *pdev) +{ + struct device *dev =3D &pdev->dev; + struct bcm74110_mbox *mbox; + int i, ret; + + mbox =3D devm_kzalloc(dev, sizeof(*mbox), GFP_KERNEL); + if (!mbox) + return -ENOMEM; + + mbox->pdev =3D pdev; + platform_set_drvdata(pdev, mbox); + + mbox->base =3D devm_platform_ioremap_resource(pdev, 0); + if (IS_ERR(mbox->base)) + return dev_err_probe(dev, PTR_ERR(mbox->base), "Failed to iomap\n"); + + ret =3D of_property_read_u32(dev->of_node, "brcm,tx", &mbox->tx_chan); + if (ret) + return dev_err_probe(dev, ret, "Failed to find tx channel\n"); + + ret =3D of_property_read_u32(dev->of_node, "brcm,rx", &mbox->rx_chan); + if (ret) + return dev_err_probe(dev, ret, "Failed to find rx channel\n"); + + ret =3D of_property_read_u32_index(dev->of_node, "brcm,shmem", 0, + &mbox->shmem_offset); + if (ret) + return dev_err_probe(dev, ret, "Failed to get shmem offset\n"); + + ret =3D of_property_read_u32_index(dev->of_node, "brcm,shmem", 1, + &mbox->shmem_size); + if (ret) + return dev_err_probe(dev, ret, "Failed to get shmem size\n"); + + mbox->rx_irq =3D platform_get_irq(pdev, 0); + if (mbox->rx_irq <=3D 0) + return dev_err_probe(dev, -EINVAL, "Failed to get irq\n"); + + mbox->base_tx =3D mbox->base + BCM_MBOX_BASE(mbox->tx_chan); + mbox->base_rx =3D mbox->base + BCM_MBOX_BASE(mbox->rx_chan); + mbox->base_rx_irq =3D mbox->base + BCM_MBOX_IRQ_BASE(mbox->rx_chan); + + INIT_LIST_HEAD(&mbox->rx_svc_init_list); + spin_lock_init(&mbox->rx_svc_list_lock); + bcm74110_mbox_mask_and_clear(mbox); + + ret =3D devm_request_irq(dev, mbox->rx_irq, bcm74110_mbox_isr, + IRQF_NO_SUSPEND, pdev->name, mbox); + if (ret) + return dev_err_probe(dev, ret, "Failed to request irq\n"); + + mbox->controller.ops =3D &bcm74110_mbox_chan_ops; + mbox->controller.dev =3D dev; + mbox->controller.num_chans =3D BCM_MSG_SVC_MAX; + mbox->controller.of_xlate =3D &bcm74110_mbox_of_xlate; + mbox->controller.chans =3D devm_kcalloc(dev, BCM_MSG_SVC_MAX, + sizeof(*mbox->controller.chans), + GFP_KERNEL); + if (!mbox->controller.chans) + return -ENOMEM; + + mbox->mbox_chan =3D devm_kcalloc(dev, BCM_MSG_SVC_MAX, + sizeof(*mbox->mbox_chan), + GFP_KERNEL); + if (!mbox->mbox_chan) + return -ENOMEM; + + for (i =3D 0; i < BCM_MSG_SVC_MAX; i++) { + mbox->mbox_chan[i].mbox =3D mbox; + mbox->controller.chans[i].con_priv =3D &mbox->mbox_chan[i]; + } + + ret =3D devm_mbox_controller_register(dev, &mbox->controller); + if (ret) + return ret; + + ret =3D bcm74110_mbox_init(mbox); + if (ret) + return ret; + + dev_info(dev, "Mailbox inited with %d channels\n", BCM_MSG_SVC_MAX); + + return 0; +} + +static const struct of_device_id bcm74110_mbox_of_match[] =3D { + { .compatible =3D "brcm,bcm74110-mbox", }, + { /* sentinel */ }, +}; +MODULE_DEVICE_TABLE(of, bcm74110_mbox_of_match); + +static struct platform_driver bcm74110_mbox_driver =3D { + .driver =3D { + .name =3D "bcm74110-mbox", + .of_match_table =3D bcm74110_mbox_of_match, + }, + .probe =3D bcm74110_mbox_probe, + .shutdown =3D bcm74110_mbox_shutdown, +}; +module_platform_driver(bcm74110_mbox_driver); + +MODULE_AUTHOR("Justin Chen "); +MODULE_DESCRIPTION("BCM74110 mailbox driver"); +MODULE_LICENSE("GPL"); --=20 2.34.1 From nobody Wed Dec 17 08:52:59 2025 Received: from mail-oi1-f170.google.com (mail-oi1-f170.google.com [209.85.167.170]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 263741DE3C2 for ; Thu, 27 Mar 2025 22:16:35 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.167.170 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1743113797; cv=none; b=vA7gD/oAIgybytS2Bn5eSZ4N2hADUtqnuTgeEJigd0ZkKor43j0UJFmO8/hKGQyy6bvORrziSbyfZ/fccgQKl2aiQObKylPB3/3QunOmB4vEEYHWBeZXGOt7fhO6Ry0Fswvj/Rg6j8IiNLMv09Y8+rzFFsvhYgEok1vjWMQ7n+k= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1743113797; c=relaxed/simple; bh=c3pZ7RooU49GV/zbRYr6GKjwFAEK7W9UC8fTibTT5V8=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=AmLLRC1DhJReGrm1NemuFQtKWJnsoAwXcs2MoFx2CQAKRo6T0GDZk9uDqIvy2E+IcH/xGkk3lOo5lyjH3Dk7c5LKsA4fzXkmhKruzK0+5D+yDkbEhG1CZbHHBrojp4gEldv6r1W1Uwuv5LMAQ/x8Lw+6KW8UA/3fpjrRiwxnBgA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=broadcom.com; spf=fail smtp.mailfrom=broadcom.com; dkim=pass (1024-bit key) header.d=broadcom.com header.i=@broadcom.com header.b=ElRHVLsS; arc=none smtp.client-ip=209.85.167.170 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=broadcom.com Authentication-Results: smtp.subspace.kernel.org; spf=fail smtp.mailfrom=broadcom.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=broadcom.com header.i=@broadcom.com header.b="ElRHVLsS" Received: by mail-oi1-f170.google.com with SMTP id 5614622812f47-3feaedb39e9so407324b6e.1 for ; Thu, 27 Mar 2025 15:16:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=broadcom.com; s=google; t=1743113795; x=1743718595; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=pWnjsfzqeuRQjE5CuEy27r/cM16vobPuEqBqdK86nRY=; b=ElRHVLsSiITSonlYxI8xsck5Gn304Ps/jkNHY8LpW5QkbXMYqCqo/+wO1sOJw5IE/7 wUOOKaxmZ6ELpXBK5jVg3nRHifPIOvIX5aRwtWp2vz22OysRwV1eIkSP41D3Q6ujl1xc tBY8HO9xHZ88EAITcrE02suapZmCy3SWhK3ww= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1743113795; x=1743718595; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=pWnjsfzqeuRQjE5CuEy27r/cM16vobPuEqBqdK86nRY=; b=Mr4Ob5LhBCRZKMAP4cMg48IhC1LMVKOtoFBB60FgyUNRlHVjdWL9aV5zfNWG0n5DzY rN7Rhz8eFNdWHWR6DPEoH7NDzGJxs4JF4l9cLY3tkJM1ngQ9QqOa3AbND2QxwaK2njBN jLoAiP37/gsV0SF+syCOVMbAhiRsg+/rukSnBJgEsjQhVf6qx11wFzBZfgTTyapt5E+H 4iqoN3gc/Li6gksM87Z3qmGPFern0F5oMYxclby78be9/+Re3/04YT7HAQdxfckYHBID djun33fRU1FlV5hjVKu6dzkkGTxKUGSvrW92ZD4XZUVJkXq0pFeyc3vjDXZLKJmApGaF psCw== X-Forwarded-Encrypted: i=1; AJvYcCWXQqOv2RSG/Ty5+VIPv41hRSQU740+ezgafoFvzn+SpDK4XwOvjShHNbXWztzESFtocw+m4nMvfCVMwOI=@vger.kernel.org X-Gm-Message-State: AOJu0Yybz6yy446Zwj00W6+tKyftIrcHGKb183KY1LoPflP4URz7ZxLM CXjye6s9EVqLXNqL+OohDHXZl+ltFqQKLGbR68/qe98bjJR9gsaNd3gerV8bbl8fu4CCdJf1e+Q = X-Gm-Gg: ASbGncv6qEqsx/EwCApfif8l9i6230D6d9cWHt2U54lDog3oRl/JeXtXzljqbZ0kYMD wGGGkY3HzfHvgQeXcM9bBQwPkI7m+tUAyGCcyknlwc3ElBlE31a+OBlhkH3oHkrXk0g/RfbSWqQ lIP/FGU7H7P1JBr21fNs8cBw2ExALnEWudQnQTG3rGGrMy+oQvKNU+gqFtn8lRZWtHZX1KeGOap wOOaVlFLZAVqynDgPjTt6Fxwu6z1eSE6vE4+KF75aYaXGIkTm/i61kyiC4sx2AZqiVZ+citCcO7 bS3Hfk3sy6scAJJXt+0xmyHS1gHg1sP05Z7GT1W0l8pQp7NuOV8IBLt/jDMrsdCZX4hfZTOyE7e eIKDeJvFSAGMSOmBt1xVBFA== X-Google-Smtp-Source: AGHT+IHJe1kJJUaMvRyIpRfNMnixffqNiUdPbooQgfaLtzes3Umk6/URZ+Q1RCthW4bU3XakDncbfA== X-Received: by 2002:a05:6808:201d:b0:3f9:d5a2:89a6 with SMTP id 5614622812f47-3fefa62d72cmr2809117b6e.35.1743113795004; Thu, 27 Mar 2025 15:16:35 -0700 (PDT) Received: from stbirv-lnx-1.igp.broadcom.net ([192.19.223.252]) by smtp.gmail.com with ESMTPSA id 5614622812f47-3ff051680a8sm105031b6e.1.2025.03.27.15.16.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 27 Mar 2025 15:16:34 -0700 (PDT) From: justin.chen@broadcom.com To: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Cc: florian.fainelli@broadcom.com, conor+dt@kernel.org, krzk+dt@kernel.org, robh@kernel.org, jassisinghbrar@gmail.com, bcm-kernel-feedback-list@broadcom.com, Justin Chen Subject: [PATCH 2/2] dt-bindings: mailbox: Add devicetree binding for bcm74110 mbox Date: Thu, 27 Mar 2025 15:16:28 -0700 Message-Id: <20250327221628.651042-3-justin.chen@broadcom.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250327221628.651042-1-justin.chen@broadcom.com> References: <20250327221628.651042-1-justin.chen@broadcom.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Justin Chen Add devicetree YAML binding for brcmstb bcm74110 mailbox used for communicating with a co-processor. Signed-off-by: Justin Chen --- .../bindings/mailbox/brcm,bcm74110-mbox.yaml | 68 +++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 Documentation/devicetree/bindings/mailbox/brcm,bcm74110= -mbox.yaml diff --git a/Documentation/devicetree/bindings/mailbox/brcm,bcm74110-mbox.y= aml b/Documentation/devicetree/bindings/mailbox/brcm,bcm74110-mbox.yaml new file mode 100644 index 000000000000..139728a35303 --- /dev/null +++ b/Documentation/devicetree/bindings/mailbox/brcm,bcm74110-mbox.yaml @@ -0,0 +1,68 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mailbox/brcm,bcm74110-mbox.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Broadcom BCM74110 Mailbox Driver + +maintainers: + - Justin Chen + - Florian Fainelli + +description: Broadcom mailbox driver first introduced with 74110 + +properties: + compatible: + enum: + - brcm,bcm74110-mbox + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + "#mbox-cells": + const: 2 + description: + The first cell is channel type and second cell is shared memory slot + + brcm,mbox_tx: + $ref: /schemas/types.yaml#/definitions/uint32 + description: Mailbox transmit doorbell + + brcm,mbox_rx: + $ref: /schemas/types.yaml#/definitions/uint32 + description: Mailbox receive doorbell + + brcm,mbox_shmem: + $ref: /schemas/types.yaml#/definitions/uint32-array + maxItems: 2 + description: Mailbox shared memory region and size + +required: + - compatible + - reg + - interrupts + - "#mbox-cells" + - brcm,mbox_tx + - brcm,mbox_rx + - brcm,mbox_shmem + +additionalProperties: false + +examples: + - | + #include + + brcm_pmc_mailbox: brcm_pmc_mailbox@a552000 { + #mbox-cells =3D <2>; + compatible =3D "brcm,bcm74110-mbox"; + reg =3D <0xa552000 0x1100>; + brcm,mbox_tx =3D <0x6>; + brcm,mbox_rx =3D <0x7>; + brcm,mbox_shmem =3D <0x3000 0x400>; + interrupts =3D <0x0 0x67 0x4>; + interrupt-parent =3D <&intc>; + }; --=20 2.34.1