From nobody Fri Dec 19 22:02:09 2025 Received: from mail-oi1-f169.google.com (mail-oi1-f169.google.com [209.85.167.169]) (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 B88A42222AC for ; Tue, 15 Apr 2025 18:28:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.167.169 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1744741713; cv=none; b=i/AzrYk7FMYk1I2sMND0v0Kbns/kXY+Dn0FcddfssJIu5CfqvlRZiZOWc9gkz7PP+bdFLOnWroR5g7hrk6b46IRRlE9nWQc2yRGBMe4IQDmtZg0xpOtHrFS4mTsPc1vlRk/AcD9eUX4G8coc9lF0P2Unbtv40nu9TY2cizciMk0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1744741713; c=relaxed/simple; bh=NS7NUQTWMnCY0Kq8/cM3cF2ihs/926O0LO7HDLvkUUQ=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=jdCxZ9Jls4BdVeQN28GspLl9LIWCJhhckI8plvcsW0BQ/go6pVntmb5MqHFHVVpZ08ztCKqenu4jh0QZTofC+WfVBdo4kU/J4zHkEUuf41h3Le0np36jsabwHWbWmp+GoLY+uV14T2GOjfSTZgd/D9RlbGezMTZHNXK31a0hvg0= 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=aY/H7+so; arc=none smtp.client-ip=209.85.167.169 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="aY/H7+so" Received: by mail-oi1-f169.google.com with SMTP id 5614622812f47-3feb0db95e6so3762947b6e.1 for ; Tue, 15 Apr 2025 11:28:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=broadcom.com; s=google; t=1744741711; x=1745346511; 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=TaFRLdnz7zCuUma9VAVck8Ma/53jvqZlJvs+qHg/LNU=; b=aY/H7+so2b0HWYpCAe5IcupsuOddXubLWAGvnz0MRVznAKC7ffaO0/Yhgjq5nCfAqH ZklLX9ofWckOCyiaUi4ccFWrfLCxSOpv6e3ClKYcdFKnOJg7ohIVU8pPtqwZy9tbLA7i xEWb6t7ZTcQsgfVwvc3dpIlk4FJy5eEwE0+s0= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1744741711; x=1745346511; 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=TaFRLdnz7zCuUma9VAVck8Ma/53jvqZlJvs+qHg/LNU=; b=dWZdQDWeDKNhwToRhLo6gCux++wJd/yYRPOR5qEv5EQKy0vfhYEJa4sALJb944Kn7X S6Qqd63uhBq4MUXV1TmYuPyRbS8ljkwBu351eNDar/kqb40giEtciwMrIkOwllRcdLZH cKrplq23pPp5OYgSaL/nTjlMEOz+etDMb16HE74BY2iF67RASsysWIoq1T1lW4ulL0S5 5ySa7s3CtjrmuWWYNzdA/c+ZHFktWweR7cXOzJkx12aEj4ULWFYQXYwZzWtFoOWdlKSY cVX3fUUtE0TBHAS34EHyWhcvWuPmUf1W8LMo5W12EtCVPZe7urY/FlBDPXtdwTTmV+MB ++5A== X-Forwarded-Encrypted: i=1; AJvYcCUYzipY53P8QFgHcRblkWToLnqohVf2nm0c73HH0cmQBfOq22GGNnAl4O88IlR9fT8zAjIWoR+EIaRZ1aA=@vger.kernel.org X-Gm-Message-State: AOJu0Yy7LHMIB/cThkePaWVh510ifF/m3H+CvwWimbSyvmeCdckrx17T wB6W5yfPkKHa8aituuw2z3rxnPEVHL5cSJfoXBUt1YC8/4IcYsxuyFoPxq+VIZiZdhpXTvc+Jnc = X-Gm-Gg: ASbGncvhyldJXUKvcFZJhbLfQdpoHvhbd8xngPFiyPev07yi0CH81LuUrqyS76/3kn5 5361Vje/A+RL+Y2nDgEjQRqpei5l/1yHFDLkpJyvSGHWlInkQoxeha7K8PjVY/vw6vXcAUy7tdz 7AtI9AEcwQ23sDvre8wWZGSc5OTCV79e13NPkzbrW4mKlJ4ngPGh9/i1un4RvfNbf1K26cvRBnP 2JjGVq9mITnpRiOLcRxSPogaLMfdFDEFVMRxuxNfV/K7JUGj2HYs9ZEE/+zyVnbBZHP9tv+CYcm EjyQA+xM6vT4nUZbyKdk6NyDpk1rwkdkFQmc5w4wXm21dchwLYnSEfzwzXfgSqAkZGVaGH0MXyy i5DmXBuMrSCz8HyRvjA== X-Google-Smtp-Source: AGHT+IEq5v8Tp1zyjzJOs2uD/k82silnFhwbjeiDtXg0gdPGWg8kcS6uA7Vblx5cKJOU3S6RH6Gjbg== X-Received: by 2002:a05:6808:1691:b0:3fe:aeaf:26a5 with SMTP id 5614622812f47-400acb367b7mr399141b6e.31.1744741710778; Tue, 15 Apr 2025 11:28:30 -0700 (PDT) Received: from stbirv-lnx-1.igp.broadcom.net ([192.19.223.252]) by smtp.gmail.com with ESMTPSA id 5614622812f47-400763baf5esm2434177b6e.47.2025.04.15.11.28.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Apr 2025 11:28:30 -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 v4 1/2] dt-bindings: mailbox: Add support for bcm74110 Date: Tue, 15 Apr 2025 11:28:25 -0700 Message-Id: <20250415182826.3905917-2-justin.chen@broadcom.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250415182826.3905917-1-justin.chen@broadcom.com> References: <20250415182826.3905917-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 Reviewed-by: Krzysztof Kozlowski --- v4 Dropped minItems from interrupts v3 Added list for interrupts. Corrected dts example. Fixed ordering and naming. v2 Renamed brcm,brcm_{tx|rx} to brcm,{tx|rx}. Removed brcm,shmem node. Not necessary to keep in dt. Fixed example and added scmi node. .../bindings/mailbox/brcm,bcm74110-mbox.yaml | 64 +++++++++++++++++++ 1 file changed, 64 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..750cc96edb46 --- /dev/null +++ b/Documentation/devicetree/bindings/mailbox/brcm,bcm74110-mbox.yaml @@ -0,0 +1,64 @@ +# 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 + +maintainers: + - Justin Chen + - Florian Fainelli + +description: Broadcom mailbox hardware first introduced with 74110 + +properties: + compatible: + enum: + - brcm,bcm74110-mbox + + reg: + maxItems: 1 + + interrupts: + items: + - description: RX doorbell and watermark interrupts + - description: TX doorbell and watermark interrupts + + "#mbox-cells": + const: 2 + description: + The first cell is channel type and second cell is shared memory slot + + brcm,rx: + $ref: /schemas/types.yaml#/definitions/uint32 + description: RX Mailbox number + + brcm,tx: + $ref: /schemas/types.yaml#/definitions/uint32 + description: TX Mailbox number + +required: + - compatible + - reg + - interrupts + - "#mbox-cells" + - brcm,rx + - brcm,tx + +additionalProperties: false + +examples: + - | + #include + #include + + mailbox@a552000 { + compatible =3D "brcm,bcm74110-mbox"; + reg =3D <0xa552000 0x1104>; + interrupts =3D , + ; + #mbox-cells =3D <0x2>; + brcm,rx =3D <0x7>; + brcm,tx =3D <0x6>; + }; --=20 2.34.1 From nobody Fri Dec 19 22:02:09 2025 Received: from mail-oi1-f175.google.com (mail-oi1-f175.google.com [209.85.167.175]) (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 BAFAB227BAA for ; Tue, 15 Apr 2025 18:28:33 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.167.175 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1744741715; cv=none; b=dXY/j54y58dlWSs/7WVsn85BDbakK9aSEEJFqiqUw1U0UGQQ8JNp91af1JXXaHMry/NWZsgp1dCehTiwPFMKUmi6/HJL3wP/zcUVGHgIdhhq/xna0+PY/l3rToKBbmkQtXRczTfsG58+5KWc9j/K2E9l2Q2XVS2DNRJ1tYt8txI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1744741715; c=relaxed/simple; bh=1ZpYnkwEkzehUf34+luCinxOwC/G7Rm+QDZ1RSQKQS4=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=kESXs3vzyjCCFZMzYImre2q2ygutx7N2IDOr0Q5zYvEP8aI24VRqnCAGdQRfZG+v9K2DOkyTd+VZIthZzeYKczlgxkFrhoKJCVdiutlLgW/br71Bw7YKwEta1ZRFXxuXmNRCHA+DcVusnDFNgzDIL4xSrcMolbH7OU7A+7kEc1g= 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=GJcnMjGr; arc=none smtp.client-ip=209.85.167.175 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="GJcnMjGr" Received: by mail-oi1-f175.google.com with SMTP id 5614622812f47-3feaedb6670so3915622b6e.1 for ; Tue, 15 Apr 2025 11:28:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=broadcom.com; s=google; t=1744741713; x=1745346513; 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=+Y8NnACZiT9j5kT8YQXM+xltY5Vhe9F9jexNNLMasjs=; b=GJcnMjGrcslFqgEYBhCx74LN1IZB/Gjyf1+ypTpRkqeXuf6f8LRgE/QBkL5CUlcNX2 kgfVrQ1+ZZUCbhPjaAFP2i0BBcmipfYVylnI/9P8Ajg4Im5vqhfdXeuwcUQ6Py72llx2 SqlpE7hBjbSSiOZugqKH62ff4pH1H/MTpQ/f4= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1744741713; x=1745346513; 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=+Y8NnACZiT9j5kT8YQXM+xltY5Vhe9F9jexNNLMasjs=; b=bMSC1OrlN6IhJf/i7BLsG4WWeAUr2JGUDMyOjqOw40eigtk2mGUXXMOY/Eo6RtTHEk 5X9S0y8SbzVfrceOEmx68PQtXwToG4mlrLgD8vx28UkadJ7H0rzHXvMdV401NYNfEdmP fzTrHJuyFUL6Bl54E9gqnMd7saz9kPLQM1soLyUeFP3T8lU23udfkEN36VN1+e8UXBMe 0pUn/cp7hFfclepYl2UY/HIc7j9nW0U8kUS8/H9/uN9qm41KSQbtQA/3l+oeMuyqlD8X xiONeGIZTwp/+ZOVpFO7KxAMbNo9dHGKzjdL3tdCl38vILzO6JBRF4aF7JDkIK6CWi7u IvjA== X-Forwarded-Encrypted: i=1; AJvYcCUxBpxuEj6xZUuJJdflYaE60j5s/a0fJH6cmrp35zSPJStDfY9xYyvPU7kPBErbFUz6+VwiG8Qtsm7CjlU=@vger.kernel.org X-Gm-Message-State: AOJu0YyV3UdjL7PYUATOeO2hPA+ADz/EVZaLdtVnI5krj9wNjj4ZLsTi 5suDkzJnTlmJZWLQio+Y4GjJIIUReFErV+hG9wBuN310+sLIfs3pRlek94fKCg== X-Gm-Gg: ASbGncsGsjkBpgPw4aF5uVxgDHjWp56vMc7s8g12H+oxSxbq9AVW0S667+j1DIyh2q+ YzZCXeFVSz896bmifmUQFmTqKPYVfPOCmybA6anWPya73VoyspLpst/QDRYbgtOEjni1oNDaF4u HC4JqvcWIHTuGJrt4wSRIFiCkeWJVJgyiPh7qcOCt+jr9ux1mSPjVataA2wKYcJdtH/Jm12YaSd zbj5nVRqap+kk2bkXUbXZrc0gxzg6gyzdc1fAoGmFYQh0e/qrN3e4mXiYZ60PRAC1t503Oe/juH 3uEONyjPGeRssIVstlXYmVBsf43GGi6MyY3PF2BAJ7EAgsioLtWYVgi6zU+S5DxQ0mkvmoGvhxx BDECNjrUNVAHJNVXxmA== X-Google-Smtp-Source: AGHT+IH/FoL7++9Dw7RpG3ssyEz62VGxebcE1CZZ4MsCtn5DI0eIdKYYOQ6dZwEynKv8UOoXhV+hjQ== X-Received: by 2002:a05:6808:2394:b0:3f6:7192:6aaf with SMTP id 5614622812f47-400acae8f64mr421968b6e.22.1744741712534; Tue, 15 Apr 2025 11:28:32 -0700 (PDT) Received: from stbirv-lnx-1.igp.broadcom.net ([192.19.223.252]) by smtp.gmail.com with ESMTPSA id 5614622812f47-400763baf5esm2434177b6e.47.2025.04.15.11.28.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Apr 2025 11:28:31 -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 v4 2/2] mailbox: Add support for bcm74110 Date: Tue, 15 Apr 2025 11:28:26 -0700 Message-Id: <20250415182826.3905917-3-justin.chen@broadcom.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250415182826.3905917-1-justin.chen@broadcom.com> References: <20250415182826.3905917-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 --- v3/v4 No changes v2 Fixed minor formatting issues Fixed error check of platform_get_irq() Removed offsetted base iomem vars. Instead we just offset directly from base. Removed shmem variable. Hardcode it instead. drivers/mailbox/Kconfig | 10 + drivers/mailbox/Makefile | 2 + drivers/mailbox/bcm74110-mailbox.c | 655 +++++++++++++++++++++++++++++ 3 files changed, 667 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..04600f2b075e --- /dev/null +++ b/drivers/mailbox/bcm74110-mailbox.c @@ -0,0 +1,655 @@ +// 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; +}; + +struct bcm74110_mbox { + struct platform_device *pdev; + void __iomem *base; + + int tx_chan; + int rx_chan; + int 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; +}; + +#define BCM74110_OFFSET_IO_WRITEL_MACRO(name, offset_base) \ +static void bcm74110_##name##_writel(struct bcm74110_mbox *mbox,\ + u32 val, u32 off) \ +{ \ + writel_relaxed(val, mbox->base + offset_base + off); \ +} +BCM74110_OFFSET_IO_WRITEL_MACRO(tx, BCM_MBOX_BASE(mbox->tx_chan)); +BCM74110_OFFSET_IO_WRITEL_MACRO(irq, BCM_MBOX_IRQ_BASE(mbox->rx_chan)); + +#define BCM74110_OFFSET_IO_READL_MACRO(name, offset_base) \ +static u32 bcm74110_##name##_readl(struct bcm74110_mbox *mbox, \ + u32 off) \ +{ \ + return readl_relaxed(mbox->base + offset_base + off); \ +} +BCM74110_OFFSET_IO_READL_MACRO(tx, BCM_MBOX_BASE(mbox->tx_chan)); +BCM74110_OFFSET_IO_READL_MACRO(rx, BCM_MBOX_BASE(mbox->rx_chan)); +BCM74110_OFFSET_IO_READL_MACRO(irq, BCM_MBOX_IRQ_BASE(mbox->rx_chan)); + +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 bcm74110_rx_readl(mbox, BCM_MBOX_RDATA); + status =3D bcm74110_rx_readl(mbox, 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 bcm74110_irq_readl(mbox, BCM_MBOX_IRQ_STATUS); + + bcm74110_irq_writel(mbox, 0xffffffff, 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) +{ + bcm74110_irq_writel(mbox, 0xffffffff, BCM_MBOX_IRQ_MASK_SET); + bcm74110_irq_writel(mbox, 0xffffffff, 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 bcm74110_tx_readl(mbox, 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)); + + bcm74110_tx_writel(mbox, msg, 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; +} + +/* Each index points to 0x100 of HAB MEM. IDX size counts from 0 */ +#define BCM_MBOX_HAB_MEM_IDX_START 0x30 +#define BCM_MBOX_HAB_MEM_IDX_SIZE 0x0 +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, + BCM_MBOX_HAB_MEM_IDX_START, + BCM_MBOX_HAB_MEM_IDX_SIZE); + 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, + BCM_MBOX_HAB_MEM_IDX_START, + BCM_MBOX_HAB_MEM_IDX_SIZE); + 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 */ + bcm74110_tx_writel(mbox, 0x0, BCM_MBOX_CTRL); + + /* Clear status & restart tx/rx*/ + bcm74110_tx_writel(mbox, BCM_MBOX_CTRL_EN | BCM_MBOX_CTRL_CLR, + BCM_MBOX_CTRL); + + /* Unmask irq */ + bcm74110_irq_writel(mbox, BCM_MBOX_IRQ_NOT_EMPTY, 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 */ + bcm74110_tx_writel(mbox, 0x0, 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_HAB_MEM_IDX_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"); + + mbox->rx_irq =3D platform_get_irq(pdev, 0); + if (mbox->rx_irq < 0) + return mbox->rx_irq; + + 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; + + 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