firmware: thead: Add AON firmware protocol driver (e4b3cbd8) · Commits · git / linux-net

MAINTAINERS

+2 −0

Original line number	Diff line number	Diff line
		@@ -20426,10 +20426,12 @@ F: Documentation/devicetree/bindings/net/thead,th1520-gmac.yaml
		F: Documentation/devicetree/bindings/pinctrl/thead,th1520-pinctrl.yaml
		F: arch/riscv/boot/dts/thead/
		F: drivers/clk/thead/clk-th1520-ap.c
		F: drivers/firmware/thead,th1520-aon.c
		F: drivers/mailbox/mailbox-th1520.c
		F: drivers/net/ethernet/stmicro/stmmac/dwmac-thead.c
		F: drivers/pinctrl/pinctrl-th1520.c
		F: include/dt-bindings/clock/thead,th1520-clk-ap.h
		F: include/linux/firmware/thead/thead,th1520-aon.h

		RNBD BLOCK DRIVERS
		M: Md. Haris Iqbal <haris.iqbal@ionos.com>

drivers/firmware/Kconfig

+9 −0

Original line number	Diff line number	Diff line
		@@ -212,6 +212,15 @@ config SYSFB_SIMPLEFB

		If unsure, say Y.

		config TH1520_AON_PROTOCOL
		tristate "Always-On firmware protocol"
		depends on ARCH_THEAD \|\| COMPILE_TEST
		help
		Power, clock, and resource management capabilities on the TH1520 SoC are
		managed by the E902 core. Firmware running on this core communicates with
		the kernel through the Always-On protocol, using hardware mailbox as a medium.
		Say yes if you need such capabilities.

		config TI_SCI_PROTOCOL
		tristate "TI System Control Interface (TISCI) Message Protocol"
		depends on TI_MESSAGE_MANAGER

drivers/firmware/Makefile

+1 −0

Original line number	Diff line number	Diff line
		@@ -18,6 +18,7 @@ obj-$(CONFIG_RASPBERRYPI_FIRMWARE) += raspberrypi.o
		obj-$(CONFIG_FW_CFG_SYSFS) += qemu_fw_cfg.o
		obj-$(CONFIG_SYSFB) += sysfb.o
		obj-$(CONFIG_SYSFB_SIMPLEFB) += sysfb_simplefb.o
		obj-$(CONFIG_TH1520_AON_PROTOCOL) += thead,th1520-aon.o
		obj-$(CONFIG_TI_SCI_PROTOCOL) += ti_sci.o
		obj-$(CONFIG_TRUSTED_FOUNDATIONS) += trusted_foundations.o
		obj-$(CONFIG_TURRIS_MOX_RWTM) += turris-mox-rwtm.o

drivers/firmware/thead,th1520-aon.c

0 → 100644

+248 −0

Original line number	Diff line number	Diff line
		// SPDX-License-Identifier: GPL-2.0
		/*
		* Copyright (C) 2021 Alibaba Group Holding Limited.
		* Copyright (c) 2024 Samsung Electronics Co., Ltd.
		* Author: Michal Wilczynski <m.wilczynski@samsung.com>
		*/

		#include <linux/device.h>
		#include <linux/firmware/thead/thead,th1520-aon.h>
		#include <linux/mailbox_client.h>
		#include <linux/mailbox_controller.h>
		#include <linux/slab.h>

		#define MAX_RX_TIMEOUT (msecs_to_jiffies(3000))
		#define MAX_TX_TIMEOUT 500

		struct th1520_aon_chan {
		struct mbox_chan *ch;
		struct th1520_aon_rpc_ack_common ack_msg;
		struct mbox_client cl;
		struct completion done;

		/* make sure only one RPC is performed at a time */
		struct mutex transaction_lock;
		};

		struct th1520_aon_msg_req_set_resource_power_mode {
		struct th1520_aon_rpc_msg_hdr hdr;
		u16 resource;
		u16 mode;
		u16 reserved[10];
		} __packed __aligned(1);

		/*
		* This type is used to indicate error response for most functions.
		*/
		enum th1520_aon_error_codes {
		LIGHT_AON_ERR_NONE = 0, /* Success */
		LIGHT_AON_ERR_VERSION = 1, /* Incompatible API version */
		LIGHT_AON_ERR_CONFIG = 2, /* Configuration error */
		LIGHT_AON_ERR_PARM = 3, /* Bad parameter */
		LIGHT_AON_ERR_NOACCESS = 4, /* Permission error (no access) */
		LIGHT_AON_ERR_LOCKED = 5, /* Permission error (locked) */
		LIGHT_AON_ERR_UNAVAILABLE = 6, /* Unavailable (out of resources) */
		LIGHT_AON_ERR_NOTFOUND = 7, /* Not found */
		LIGHT_AON_ERR_NOPOWER = 8, /* No power */
		LIGHT_AON_ERR_IPC = 9, /* Generic IPC error */
		LIGHT_AON_ERR_BUSY = 10, /* Resource is currently busy/active */
		LIGHT_AON_ERR_FAIL = 11, /* General I/O failure */
		LIGHT_AON_ERR_LAST
		};

		static int th1520_aon_linux_errmap[LIGHT_AON_ERR_LAST] = {
		0, /* LIGHT_AON_ERR_NONE */
		-EINVAL, /* LIGHT_AON_ERR_VERSION */
		-EINVAL, /* LIGHT_AON_ERR_CONFIG */
		-EINVAL, /* LIGHT_AON_ERR_PARM */
		-EACCES, /* LIGHT_AON_ERR_NOACCESS */
		-EACCES, /* LIGHT_AON_ERR_LOCKED */
		-ERANGE, /* LIGHT_AON_ERR_UNAVAILABLE */
		-EEXIST, /* LIGHT_AON_ERR_NOTFOUND */
		-EPERM, /* LIGHT_AON_ERR_NOPOWER */
		-EPIPE, /* LIGHT_AON_ERR_IPC */
		-EBUSY, /* LIGHT_AON_ERR_BUSY */
		-EIO, /* LIGHT_AON_ERR_FAIL */
		};

		static inline int th1520_aon_to_linux_errno(int errno)
		{
		if (errno >= LIGHT_AON_ERR_NONE && errno < LIGHT_AON_ERR_LAST)
		return th1520_aon_linux_errmap[errno];

		return -EIO;
		}

		static void th1520_aon_rx_callback(struct mbox_client c, void rx_msg)
		{
		struct th1520_aon_chan *aon_chan =
		container_of(c, struct th1520_aon_chan, cl);
		struct th1520_aon_rpc_msg_hdr *hdr =
		(struct th1520_aon_rpc_msg_hdr *)rx_msg;
		u8 recv_size = sizeof(struct th1520_aon_rpc_msg_hdr) + hdr->size;

		if (recv_size != sizeof(struct th1520_aon_rpc_ack_common)) {
		dev_err(c->dev, "Invalid ack size, not completing\n");
		return;
		}

		memcpy(&aon_chan->ack_msg, rx_msg, recv_size);
		complete(&aon_chan->done);
		}

		/**
		* th1520_aon_call_rpc() - Send an RPC request to the TH1520 AON subsystem
		* @aon_chan: Pointer to the AON channel structure
		* @msg: Pointer to the message (RPC payload) that will be sent
		*
		* This function sends an RPC message to the TH1520 AON subsystem via mailbox.
		* It takes the provided @msg buffer, formats it with version and service flags,
		* then blocks until the RPC completes or times out. The completion is signaled
		* by the `aon_chan->done` completion, which is waited upon for a duration
		* defined by `MAX_RX_TIMEOUT`.
		*
		* Return:
		* * 0 on success
		* * -ETIMEDOUT if the RPC call times out
		* * A negative error code if the mailbox send fails or if AON responds with
		* a non-zero error code (converted via th1520_aon_to_linux_errno()).
		*/
		int th1520_aon_call_rpc(struct th1520_aon_chan aon_chan, void msg)
		{
		struct th1520_aon_rpc_msg_hdr *hdr = msg;
		int ret;

		mutex_lock(&aon_chan->transaction_lock);
		reinit_completion(&aon_chan->done);

		RPC_SET_VER(hdr, TH1520_AON_RPC_VERSION);
		RPC_SET_SVC_ID(hdr, hdr->svc);
		RPC_SET_SVC_FLAG_MSG_TYPE(hdr, RPC_SVC_MSG_TYPE_DATA);
		RPC_SET_SVC_FLAG_ACK_TYPE(hdr, RPC_SVC_MSG_NEED_ACK);

		ret = mbox_send_message(aon_chan->ch, msg);
		if (ret < 0) {
		dev_err(aon_chan->cl.dev, "RPC send msg failed: %d\n", ret);
		goto out;
		}

		if (!wait_for_completion_timeout(&aon_chan->done, MAX_RX_TIMEOUT)) {
		dev_err(aon_chan->cl.dev, "RPC send msg timeout\n");
		mutex_unlock(&aon_chan->transaction_lock);
		return -ETIMEDOUT;
		}

		ret = aon_chan->ack_msg.err_code;

		out:
		mutex_unlock(&aon_chan->transaction_lock);

		return th1520_aon_to_linux_errno(ret);
		}
		EXPORT_SYMBOL_GPL(th1520_aon_call_rpc);

		/**
		* th1520_aon_power_update() - Change power state of a resource via TH1520 AON
		* @aon_chan: Pointer to the AON channel structure
		* @rsrc: Resource ID whose power state needs to be updated
		* @power_on: Boolean indicating whether the resource should be powered on (true)
		* or powered off (false)
		*
		* This function requests the TH1520 AON subsystem to set the power mode of the
		* given resource (@rsrc) to either on or off. It constructs the message in
		* `struct th1520_aon_msg_req_set_resource_power_mode` and then invokes
		* th1520_aon_call_rpc() to make the request. If the AON call fails, an error
		* message is logged along with the specific return code.
		*
		* Return:
		* * 0 on success
		* * A negative error code in case of failures (propagated from
		* th1520_aon_call_rpc()).
		*/
		int th1520_aon_power_update(struct th1520_aon_chan *aon_chan, u16 rsrc,
		bool power_on)
		{
		struct th1520_aon_msg_req_set_resource_power_mode msg = {};
		struct th1520_aon_rpc_msg_hdr *hdr = &msg.hdr;
		int ret;

		hdr->svc = TH1520_AON_RPC_SVC_PM;
		hdr->func = TH1520_AON_PM_FUNC_SET_RESOURCE_POWER_MODE;
		hdr->size = TH1520_AON_RPC_MSG_NUM;

		RPC_SET_BE16(&msg.resource, 0, rsrc);
		RPC_SET_BE16(&msg.resource, 2,
		(power_on ? TH1520_AON_PM_PW_MODE_ON :
		TH1520_AON_PM_PW_MODE_OFF));

		ret = th1520_aon_call_rpc(aon_chan, &msg);
		if (ret)
		dev_err(aon_chan->cl.dev, "failed to power %s resource %d ret %d\n",
		power_on ? "up" : "off", rsrc, ret);

		return ret;
		}
		EXPORT_SYMBOL_GPL(th1520_aon_power_update);

		/**
		* th1520_aon_init() - Initialize TH1520 AON firmware protocol interface
		* @dev: Device pointer for the AON subsystem
		*
		* This function initializes the TH1520 AON firmware protocol interface by:
		* - Allocating and initializing the AON channel structure
		* - Setting up the mailbox client
		* - Requesting the AON mailbox channel
		* - Initializing synchronization primitives
		*
		* Return:
		* * Valid pointer to th1520_aon_chan structure on success
		* * ERR_PTR(-ENOMEM) if memory allocation fails
		* * ERR_PTR() with other negative error codes from mailbox operations
		*/
		struct th1520_aon_chan th1520_aon_init(struct device dev)
		{
		struct th1520_aon_chan *aon_chan;
		struct mbox_client *cl;

		aon_chan = kzalloc(sizeof(*aon_chan), GFP_KERNEL);
		if (!aon_chan)
		return ERR_PTR(-ENOMEM);

		cl = &aon_chan->cl;
		cl->dev = dev;
		cl->tx_block = true;
		cl->tx_tout = MAX_TX_TIMEOUT;
		cl->rx_callback = th1520_aon_rx_callback;

		aon_chan->ch = mbox_request_channel_byname(cl, "aon");
		if (IS_ERR(aon_chan->ch)) {
		dev_err(dev, "Failed to request aon mbox chan\n");
		kfree(aon_chan);
		return ERR_CAST(aon_chan->ch);
		}

		mutex_init(&aon_chan->transaction_lock);
		init_completion(&aon_chan->done);

		return aon_chan;
		}
		EXPORT_SYMBOL_GPL(th1520_aon_init);

		/**
		* th1520_aon_deinit() - Clean up TH1520 AON firmware protocol interface
		* @aon_chan: Pointer to the AON channel structure to clean up
		*
		* This function cleans up resources allocated by th1520_aon_init():
		* - Frees the mailbox channel
		* - Frees the AON channel
		*/
		void th1520_aon_deinit(struct th1520_aon_chan *aon_chan)
		{
		mbox_free_channel(aon_chan->ch);
		kfree(aon_chan);
		}
		EXPORT_SYMBOL_GPL(th1520_aon_deinit);

		MODULE_AUTHOR("Michal Wilczynski <m.wilczynski@samsung.com>");
		MODULE_DESCRIPTION("T-HEAD TH1520 Always-On firmware protocol library");
		MODULE_LICENSE("GPL");

include/linux/firmware/thead/thead,th1520-aon.h

0 → 100644

+200 −0

Original line number	Diff line number	Diff line
		/* SPDX-License-Identifier: GPL-2.0 */
		/*
		* Copyright (C) 2021 Alibaba Group Holding Limited.
		*/

		#ifndef _THEAD_AON_H
		#define _THEAD_AON_H

		#include <linux/device.h>
		#include <linux/types.h>

		#define AON_RPC_MSG_MAGIC (0xef)
		#define TH1520_AON_RPC_VERSION 2
		#define TH1520_AON_RPC_MSG_NUM 7

		struct th1520_aon_chan;

		enum th1520_aon_rpc_svc {
		TH1520_AON_RPC_SVC_UNKNOWN = 0,
		TH1520_AON_RPC_SVC_PM = 1,
		TH1520_AON_RPC_SVC_MISC = 2,
		TH1520_AON_RPC_SVC_AVFS = 3,
		TH1520_AON_RPC_SVC_SYS = 4,
		TH1520_AON_RPC_SVC_WDG = 5,
		TH1520_AON_RPC_SVC_LPM = 6,
		TH1520_AON_RPC_SVC_MAX = 0x3F,
		};

		enum th1520_aon_misc_func {
		TH1520_AON_MISC_FUNC_UNKNOWN = 0,
		TH1520_AON_MISC_FUNC_SET_CONTROL = 1,
		TH1520_AON_MISC_FUNC_GET_CONTROL = 2,
		TH1520_AON_MISC_FUNC_REGDUMP_CFG = 3,
		};

		enum th1520_aon_wdg_func {
		TH1520_AON_WDG_FUNC_UNKNOWN = 0,
		TH1520_AON_WDG_FUNC_START = 1,
		TH1520_AON_WDG_FUNC_STOP = 2,
		TH1520_AON_WDG_FUNC_PING = 3,
		TH1520_AON_WDG_FUNC_TIMEOUTSET = 4,
		TH1520_AON_WDG_FUNC_RESTART = 5,
		TH1520_AON_WDG_FUNC_GET_STATE = 6,
		TH1520_AON_WDG_FUNC_POWER_OFF = 7,
		TH1520_AON_WDG_FUNC_AON_WDT_ON = 8,
		TH1520_AON_WDG_FUNC_AON_WDT_OFF = 9,
		};

		enum th1520_aon_sys_func {
		TH1520_AON_SYS_FUNC_UNKNOWN = 0,
		TH1520_AON_SYS_FUNC_AON_RESERVE_MEM = 1,
		};

		enum th1520_aon_lpm_func {
		TH1520_AON_LPM_FUNC_UNKNOWN = 0,
		TH1520_AON_LPM_FUNC_REQUIRE_STR = 1,
		TH1520_AON_LPM_FUNC_RESUME_STR = 2,
		TH1520_AON_LPM_FUNC_REQUIRE_STD = 3,
		TH1520_AON_LPM_FUNC_CPUHP = 4,
		TH1520_AON_LPM_FUNC_REGDUMP_CFG = 5,
		};

		enum th1520_aon_pm_func {
		TH1520_AON_PM_FUNC_UNKNOWN = 0,
		TH1520_AON_PM_FUNC_SET_RESOURCE_REGULATOR = 1,
		TH1520_AON_PM_FUNC_GET_RESOURCE_REGULATOR = 2,
		TH1520_AON_PM_FUNC_SET_RESOURCE_POWER_MODE = 3,
		TH1520_AON_PM_FUNC_PWR_SET = 4,
		TH1520_AON_PM_FUNC_PWR_GET = 5,
		TH1520_AON_PM_FUNC_CHECK_FAULT = 6,
		TH1520_AON_PM_FUNC_GET_TEMPERATURE = 7,
		};

		struct th1520_aon_rpc_msg_hdr {
		u8 ver; /* version of msg hdr */
		u8 size; /* msg size ,uinit in bytes,the size includes rpc msg header self */
		u8 svc; /* rpc main service id */
		u8 func; /* rpc sub func id of specific service, sent by caller */
		} __packed __aligned(1);

		struct th1520_aon_rpc_ack_common {
		struct th1520_aon_rpc_msg_hdr hdr;
		u8 err_code;
		} __packed __aligned(1);

		#define RPC_SVC_MSG_TYPE_DATA 0
		#define RPC_SVC_MSG_TYPE_ACK 1
		#define RPC_SVC_MSG_NEED_ACK 0
		#define RPC_SVC_MSG_NO_NEED_ACK 1

		#define RPC_GET_VER(MESG) ((MESG)->ver)
		#define RPC_SET_VER(MESG, VER) ((MESG)->ver = (VER))
		#define RPC_GET_SVC_ID(MESG) ((MESG)->svc & 0x3F)
		#define RPC_SET_SVC_ID(MESG, ID) ((MESG)->svc \|= 0x3F & (ID))
		#define RPC_GET_SVC_FLAG_MSG_TYPE(MESG) (((MESG)->svc & 0x80) >> 7)
		#define RPC_SET_SVC_FLAG_MSG_TYPE(MESG, TYPE) ((MESG)->svc \|= (TYPE) << 7)
		#define RPC_GET_SVC_FLAG_ACK_TYPE(MESG) (((MESG)->svc & 0x40) >> 6)
		#define RPC_SET_SVC_FLAG_ACK_TYPE(MESG, ACK) ((MESG)->svc \|= (ACK) << 6)

		#define RPC_SET_BE64(MESG, OFFSET, SET_DATA) \
		do { \
		u8 data = (u8 )(MESG); \
		u64 _offset = (OFFSET); \
		u64 _set_data = (SET_DATA); \
		data[_offset + 7] = _set_data & 0xFF; \
		data[_offset + 6] = (_set_data & 0xFF00) >> 8; \
		data[_offset + 5] = (_set_data & 0xFF0000) >> 16; \
		data[_offset + 4] = (_set_data & 0xFF000000) >> 24; \
		data[_offset + 3] = (_set_data & 0xFF00000000) >> 32; \
		data[_offset + 2] = (_set_data & 0xFF0000000000) >> 40; \
		data[_offset + 1] = (_set_data & 0xFF000000000000) >> 48; \
		data[_offset + 0] = (_set_data & 0xFF00000000000000) >> 56; \
		} while (0)

		#define RPC_SET_BE32(MESG, OFFSET, SET_DATA) \
		do { \
		u8 data = (u8 )(MESG); \
		u64 _offset = (OFFSET); \
		u64 _set_data = (SET_DATA); \
		data[_offset + 3] = (_set_data) & 0xFF; \
		data[_offset + 2] = (_set_data & 0xFF00) >> 8; \
		data[_offset + 1] = (_set_data & 0xFF0000) >> 16; \
		data[_offset + 0] = (_set_data & 0xFF000000) >> 24; \
		} while (0)

		#define RPC_SET_BE16(MESG, OFFSET, SET_DATA) \
		do { \
		u8 data = (u8 )(MESG); \
		u64 _offset = (OFFSET); \
		u64 _set_data = (SET_DATA); \
		data[_offset + 1] = (_set_data) & 0xFF; \
		data[_offset + 0] = (_set_data & 0xFF00) >> 8; \
		} while (0)

		#define RPC_SET_U8(MESG, OFFSET, SET_DATA) \
		do { \
		u8 data = (u8 )(MESG); \
		data[OFFSET] = (SET_DATA) & 0xFF; \
		} while (0)

		#define RPC_GET_BE64(MESG, OFFSET, PTR) \
		do { \
		u8 data = (u8 )(MESG); \
		u64 _offset = (OFFSET); \
		(u32 )(PTR) = \
		(data[_offset + 7] \| data[_offset + 6] << 8 \| \
		data[_offset + 5] << 16 \| data[_offset + 4] << 24 \| \
		data[_offset + 3] << 32 \| data[_offset + 2] << 40 \| \
		data[_offset + 1] << 48 \| data[_offset + 0] << 56); \
		} while (0)

		#define RPC_GET_BE32(MESG, OFFSET, PTR) \
		do { \
		u8 data = (u8 )(MESG); \
		u64 _offset = (OFFSET); \
		(u32 )(PTR) = \
		(data[_offset + 3] \| data[_offset + 2] << 8 \| \
		data[_offset + 1] << 16 \| data[_offset + 0] << 24); \
		} while (0)

		#define RPC_GET_BE16(MESG, OFFSET, PTR) \
		do { \
		u8 data = (u8 )(MESG); \
		u64 _offset = (OFFSET); \
		(u16 )(PTR) = (data[_offset + 1] \| data[_offset + 0] << 8); \
		} while (0)

		#define RPC_GET_U8(MESG, OFFSET, PTR) \
		do { \
		u8 data = (u8 )(MESG); \
		(u8 )(PTR) = (data[OFFSET]); \
		} while (0)

		/*
		* Defines for SC PM Power Mode
		*/
		#define TH1520_AON_PM_PW_MODE_OFF 0 /* Power off */
		#define TH1520_AON_PM_PW_MODE_STBY 1 /* Power in standby */
		#define TH1520_AON_PM_PW_MODE_LP 2 /* Power in low-power */
		#define TH1520_AON_PM_PW_MODE_ON 3 /* Power on */

		/*
		* Defines for AON power islands
		*/
		#define TH1520_AON_AUDIO_PD 0
		#define TH1520_AON_VDEC_PD 1
		#define TH1520_AON_NPU_PD 2
		#define TH1520_AON_VENC_PD 3
		#define TH1520_AON_GPU_PD 4
		#define TH1520_AON_DSP0_PD 5
		#define TH1520_AON_DSP1_PD 6

		struct th1520_aon_chan th1520_aon_init(struct device dev);
		void th1520_aon_deinit(struct th1520_aon_chan *aon_chan);

		int th1520_aon_call_rpc(struct th1520_aon_chan aon_chan, void msg);
		int th1520_aon_power_update(struct th1520_aon_chan *aon_chan, u16 rsrc,
		bool power_on);

		#endif /* _THEAD_AON_H */