Differential D43041 Diff 131347 sys/dev/firmware/arm/scmi_shmem.h

Changeset View

Standalone View

sys/dev/firmware/arm/scmi_shmem.h

This file was copied from sys/dev/firmware/arm/scmi.h.

	/*-			/*-
	* SPDX-License-Identifier: BSD-2-Clause			* SPDX-License-Identifier: BSD-2-Clause
	*			*
	* Copyright (c) 2022 Ruslan Bukin <br@bsdpad.com>			* Copyright (c) 2022 Ruslan Bukin <br@bsdpad.com>
				* Copyright (c) 2023 Arm Ltd
	*			*
	* This work was supported by Innovate UK project 105694, "Digital Security			* This work was supported by Innovate UK project 105694, "Digital Security
	* by Design (DSbD) Technology Platform Prototype".			* by Design (DSbD) Technology Platform Prototype".
	*			*
	* Redistribution and use in source and binary forms, with or without			* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions			* modification, are permitted provided that the following conditions
	* are met:			* are met:
	* 1. Redistributions of source code must retain the above copyright			* 1. Redistributions of source code must retain the above copyright
	Show All 10 Lines
	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS			* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)			* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	* SUCH DAMAGE.			* SUCH DAMAGE.
	*/			*/

	#ifndef _ARM64_SCMI_SCMI_H_			#ifndef _ARM64_SCMI_SCMI_SHMEM_H_
	#define _ARM64_SCMI_SCMI_H_			#define _ARM64_SCMI_SCMI_SHMEM_H_

	#include "scmi_if.h"

	#define SCMI_LOCK(sc) mtx_lock(&(sc)->mtx)
	#define SCMI_UNLOCK(sc) mtx_unlock(&(sc)->mtx)
	#define SCMI_ASSERT_LOCKED(sc) mtx_assert(&(sc)->mtx, MA_OWNED)

	#define dprintf(fmt, ...)

	struct scmi_softc {
	struct simplebus_softc simplebus_sc;
	device_t dev;
	device_t tx_shmem;
	struct mtx mtx;
	};

	/* Shared Memory Transfer. */			/* Shared Memory Transfer. */
	struct scmi_smt_header {			struct scmi_smt_header {
	uint32_t reserved;			uint32_t reserved;
	uint32_t channel_status;			uint32_t channel_status;
	#define SCMI_SHMEM_CHAN_STAT_CHANNEL_ERROR (1 << 1)			#define SCMI_SHMEM_CHAN_STAT_CHANNEL_ERROR (1 << 1)
	#define SCMI_SHMEM_CHAN_STAT_CHANNEL_FREE (1 << 0)			#define SCMI_SHMEM_CHAN_STAT_CHANNEL_FREE (1 << 0)
	uint32_t reserved1[2];			uint32_t reserved1[2];
	uint32_t flags;			uint32_t flags;
	#define SCMI_SHMEM_FLAG_INTR_ENABLED (1 << 0)			#define SCMI_SHMEM_FLAG_INTR_ENABLED (1 << 0)
	uint32_t length;			uint32_t length;
	uint32_t msg_header;			uint32_t msg_header;
	uint8_t msg_payload[0];			uint8_t msg_payload[0];
	};			};

	#define SMT_HEADER_SIZE sizeof(struct scmi_smt_header)			#define SMT_SIZE_HEADER sizeof(struct scmi_smt_header)

	#define SMT_HEADER_TOKEN_S 18			#define SMT_OFFSET_CHAN_STATUS \
	#define SMT_HEADER_TOKEN_M (0x3fff << SMT_HEADER_TOKEN_S)			__offsetof(struct scmi_smt_header, channel_status)
	#define SMT_HEADER_PROTOCOL_ID_S 10			#define SMT_SIZE_CHAN_STATUS sizeof(uint32_t)
	#define SMT_HEADER_PROTOCOL_ID_M (0xff << SMT_HEADER_PROTOCOL_ID_S)
	#define SMT_HEADER_MESSAGE_TYPE_S 8
	#define SMT_HEADER_MESSAGE_TYPE_M (0x3 << SMT_HEADER_MESSAGE_TYPE_S)
	#define SMT_HEADER_MESSAGE_ID_S 0
	#define SMT_HEADER_MESSAGE_ID_M (0xff << SMT_HEADER_MESSAGE_ID_S)

	struct scmi_req {			#define SMT_OFFSET_LENGTH \
	int protocol_id;			__offsetof(struct scmi_smt_header, length)
	int message_id;			#define SMT_SIZE_LENGTH sizeof(uint32_t)
	const void *in_buf;
	uint32_t in_size;
	void *out_buf;
	uint32_t out_size;
	};

	DECLARE_CLASS(scmi_driver);			#define SMT_OFFSET_MSG_HEADER \
				__offsetof(struct scmi_smt_header, msg_header)
				#define SMT_SIZE_MSG_HEADER sizeof(uint32_t)

	int scmi_attach(device_t dev);			struct scmi_req;
	int scmi_request(device_t dev, struct scmi_req *req);

	void scmi_shmem_read(device_t dev, bus_size_t offset, void *buf,			device_t scmi_shmem_get(device_t sdev, phandle_t node, int index);
	bus_size_t len);			int scmi_shmem_prepare_msg(device_t dev, struct scmi_req *req);
	void scmi_shmem_write(device_t dev, bus_size_t offset, const void *buf,			int scmi_shmem_read_msg_header(device_t dev, uint32_t *msg_header);
	bus_size_t len);			int scmi_shmem_read_msg_payload(device_t dev, uint8_t *buf, uint32_t buf_len);

	#endif /* !_ARM64_SCMI_SCMI_H_ */			#endif /* !_ARM64_SCMI_SCMI_SHMEM_H_ */