summaryrefslogtreecommitdiffstats
path: root/drivers/firmware/arm_scmi/msg.c
blob: d33a704e58144cd88a269b0245a5b2f51e330496 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
// SPDX-License-Identifier: GPL-2.0
/*
 * For transports using message passing.
 *
 * Derived from shm.c.
 *
 * Copyright (C) 2019-2021 ARM Ltd.
 * Copyright (C) 2020-2021 OpenSynergy GmbH
 */

#include <linux/types.h>

#include "common.h"

/*
 * struct scmi_msg_payld - Transport SDU layout
 *
 * The SCMI specification requires all parameters, message headers, return
 * arguments or any protocol data to be expressed in little endian format only.
 */
struct scmi_msg_payld {
	__le32 msg_header;
	__le32 msg_payload[];
};

/**
 * msg_command_size() - Actual size of transport SDU for command.
 *
 * @xfer: message which core has prepared for sending
 *
 * Return: transport SDU size.
 */
size_t msg_command_size(struct scmi_xfer *xfer)
{
	return sizeof(struct scmi_msg_payld) + xfer->tx.len;
}

/**
 * msg_response_size() - Maximum size of transport SDU for response.
 *
 * @xfer: message which core has prepared for sending
 *
 * Return: transport SDU size.
 */
size_t msg_response_size(struct scmi_xfer *xfer)
{
	return sizeof(struct scmi_msg_payld) + sizeof(__le32) + xfer->rx.len;
}

/**
 * msg_tx_prepare() - Set up transport SDU for command.
 *
 * @msg: transport SDU for command
 * @xfer: message which is being sent
 */
void msg_tx_prepare(struct scmi_msg_payld *msg, struct scmi_xfer *xfer)
{
	msg->msg_header = cpu_to_le32(pack_scmi_header(&xfer->hdr));
	if (xfer->tx.buf)
		memcpy(msg->msg_payload, xfer->tx.buf, xfer->tx.len);
}

/**
 * msg_read_header() - Read SCMI header from transport SDU.
 *
 * @msg: transport SDU
 *
 * Return: SCMI header
 */
u32 msg_read_header(struct scmi_msg_payld *msg)
{
	return le32_to_cpu(msg->msg_header);
}

/**
 * msg_fetch_response() - Fetch response SCMI payload from transport SDU.
 *
 * @msg: transport SDU with response
 * @len: transport SDU size
 * @xfer: message being responded to
 */
void msg_fetch_response(struct scmi_msg_payld *msg, size_t len,
			struct scmi_xfer *xfer)
{
	size_t prefix_len = sizeof(*msg) + sizeof(msg->msg_payload[0]);

	xfer->hdr.status = le32_to_cpu(msg->msg_payload[0]);
	xfer->rx.len = min_t(size_t, xfer->rx.len,
			     len >= prefix_len ? len - prefix_len : 0);

	/* Take a copy to the rx buffer.. */
	memcpy(xfer->rx.buf, &msg->msg_payload[1], xfer->rx.len);
}

/**
 * msg_fetch_notification() - Fetch notification payload from transport SDU.
 *
 * @msg: transport SDU with notification
 * @len: transport SDU size
 * @max_len: maximum SCMI payload size to fetch
 * @xfer: notification message
 */
void msg_fetch_notification(struct scmi_msg_payld *msg, size_t len,
			    size_t max_len, struct scmi_xfer *xfer)
{
	xfer->rx.len = min_t(size_t, max_len,
			     len >= sizeof(*msg) ? len - sizeof(*msg) : 0);

	/* Take a copy to the rx buffer.. */
	memcpy(xfer->rx.buf, msg->msg_payload, xfer->rx.len);
}