u-boot/drivers/mailbox/mpfs-mbox.c

// SPDX-License-Identifier: GPL-2.0
/*
 * Microchip's PolarFire SoC (MPFS) Mailbox Driver
 *
 * Copyright (C) 2024 Microchip Technology Inc. All rights reserved.
 *
 * Author: Jamie Gibbons <jamie.gibbons@microchip.com>
 *
 */

#include <asm/io.h>
#include <dm.h>
#include <dm/device-internal.h>
#include <dm/device.h>
#include <dm/device_compat.h>
#include <dm/ofnode.h>
#include <linux/bitops.h>
#include <linux/compat.h>
#include <linux/err.h>
#include <linux/errno.h>
#include <log.h>
#include <mailbox-uclass.h>
#include <mpfs-mailbox.h>
#include <regmap.h>
#include <syscon.h>

#define SERVICES_CR_OFFSET 0x50u
#define SERVICES_SR_OFFSET 0x54u
#define MESSAGE_INT_OFFSET 0x18cu
#define MAILBOX_REG_OFFSET 0x800u

#define SERVICE_CR_REQ_MASK 0x1u
#define SERVICE_SR_BUSY_MASK 0x2u
#define SERVICE_SR_STATUS_SHIFT 16
#define SERVICE_CR_COMMAND_SHIFT 16
#define MASK_8BIT 0xFF

struct mpfs_mbox {
	struct udevice *dev;
	void __iomem *mbox_base;
	void __iomem *int_reg;
	struct regmap *control_scb;
	struct regmap *sysreg_scb;
};

static bool mpfs_mbox_busy(struct mbox_chan *chan)
{
	struct mpfs_mbox *mbox = dev_get_priv(chan->dev);
	u32 status;

	regmap_read(mbox->control_scb, SERVICES_SR_OFFSET, &status);

	return status & SERVICE_SR_BUSY_MASK;
}

static int mpfs_mbox_send(struct mbox_chan *chan, const void *data)
{
	struct mpfs_mbox *mbox = dev_get_priv(chan->dev);
	struct mpfs_mss_msg *msg = (struct mpfs_mss_msg *)data;
	u32 mailbox_val, cmd_shifted, value;
	u8 *byte_buf;
	u8 idx, byte_idx, byte_offset;

	u32 *word_buf = (u32 *)msg->cmd_data;

	if (mpfs_mbox_busy(chan))
		return -EBUSY;

	for (idx = 0; idx < (msg->cmd_data_size / BYTES_4); idx++)
		writel(word_buf[idx], mbox->mbox_base + msg->mbox_offset + idx * BYTES_4);

	if ((msg->cmd_data_size % BYTES_4) > 0) {
		byte_offset = (msg->cmd_data_size / BYTES_4) * BYTES_4;
		byte_buf = (u8 *)(msg->cmd_data + byte_offset);
		mailbox_val = readl(mbox->mbox_base + msg->mbox_offset + idx * BYTES_4);

		for (byte_idx = 0; byte_idx < (msg->cmd_data_size % BYTES_4); byte_idx++) {
			mailbox_val &= ~(MASK_8BIT << (byte_idx * 0x8u));
			mailbox_val |= (u32)byte_buf[byte_idx] << (byte_idx * 0x8u);
		}
		writel(mailbox_val, mbox->mbox_base + msg->mbox_offset + idx * BYTES_4);
	}

	cmd_shifted = msg->cmd_opcode << SERVICE_CR_COMMAND_SHIFT;
	cmd_shifted |= SERVICE_CR_REQ_MASK;

	regmap_write(mbox->control_scb, SERVICES_CR_OFFSET, cmd_shifted);

	do {
		regmap_read(mbox->control_scb, SERVICES_CR_OFFSET, &value);
	} while (SERVICE_CR_REQ_MASK == (value & SERVICE_CR_REQ_MASK));

	do {
		regmap_read(mbox->control_scb, SERVICES_SR_OFFSET, &value);
	} while (SERVICE_SR_BUSY_MASK == (value & SERVICE_SR_BUSY_MASK));

	msg->response->resp_status = (value >> SERVICE_SR_STATUS_SHIFT);
	if (msg->response->resp_status)
		return -EBADMSG;

	return 0;
}

static int mpfs_mbox_recv(struct mbox_chan *chan, void *data)
{
	struct mpfs_mbox *mbox = dev_get_priv(chan->dev);
	struct mpfs_mss_msg *msg = data;
	struct mpfs_mss_response *response = msg->response;
	u8 idx;

	if (!response->resp_msg) {
		dev_err(chan->dev, "failed to assign memory for response %d\n", -ENOMEM);
		return -EINVAL;
	}

	if (mpfs_mbox_busy(chan)) {
		dev_err(chan->dev, "mailbox is busy\n");
		response->resp_status = 0xDEAD;
		return -EINVAL;
	}

	for (idx = 0; idx < response->resp_size; idx++)
		*((u8 *)(response->resp_msg) + idx) = readb(mbox->mbox_base + msg->resp_offset  + idx);

	if (mbox->sysreg_scb)
		regmap_write(mbox->sysreg_scb, MESSAGE_INT_OFFSET, 0);
	else
		writel_relaxed(0, mbox->int_reg);

	return 0;
}

static const struct mbox_ops mpfs_mbox_ops = {
	.send = mpfs_mbox_send,
	.recv = mpfs_mbox_recv,
};

/*
 * Use global compatible lookup instead of phandles, as U-Boot may run
 * with a reduced or firmware-provided device tree where mailbox syscon
 * phandle properties are not guaranteed to be present.
 */
static int mpfs_mbox_syscon_probe(struct udevice *dev, struct mpfs_mbox *mbox)
{
	ofnode node;

	node = ofnode_by_compatible(ofnode_null(), "microchip,mpfs-control-scb");
	if (!ofnode_valid(node))
		return -ENODEV;

	mbox->control_scb = syscon_node_to_regmap(node);
	if (IS_ERR(mbox->control_scb))
		return PTR_ERR(mbox->control_scb);

	node = ofnode_by_compatible(ofnode_null(), "microchip,mpfs-sysreg-scb");
	if (!ofnode_valid(node))
		return -ENODEV;

	mbox->sysreg_scb = syscon_node_to_regmap(node);
	if (IS_ERR(mbox->sysreg_scb))
		return PTR_ERR(mbox->sysreg_scb);

	mbox->mbox_base = dev_read_addr_ptr(dev);
	if (!mbox->mbox_base)
		return -EINVAL;

	return 0;
}

static int mpfs_mbox_legacy_probe(struct udevice *dev, struct mpfs_mbox *mbox)
{
	int ret;

	ret = regmap_init_mem_index(dev_ofnode(dev), &mbox->control_scb, 0);
	if (ret)
		return ret;

	mbox->mbox_base = dev_read_addr_index_ptr(dev, 2);
	if (!mbox->mbox_base)
		mbox->mbox_base = dev_read_addr_index_ptr(dev, 0) + MAILBOX_REG_OFFSET;

	mbox->int_reg = dev_read_addr_index_ptr(dev, 1);
	if (!mbox->int_reg)
		return -EINVAL;

	return 0;
}

static int mpfs_mbox_probe(struct udevice *dev)
{
	struct mpfs_mbox *mbox = dev_get_priv(dev);
	int ret;

	mbox->dev = dev;

	ret = mpfs_mbox_syscon_probe(dev, mbox);
	if (!ret)
		return 0;

	return mpfs_mbox_legacy_probe(dev, mbox);
}

static const struct udevice_id mpfs_mbox_ids[] = {
	{.compatible = "microchip,mpfs-mailbox"},
	{ }
};

U_BOOT_DRIVER(mpfs_mbox) = {
	.name = "mpfs-mbox",
	.id = UCLASS_MAILBOX,
	.of_match = mpfs_mbox_ids,
	.probe = mpfs_mbox_probe,
	.priv_auto = sizeof(struct mpfs_mbox),
	.ops = &mpfs_mbox_ops,
};