aboutsummaryrefslogtreecommitdiff
path: root/components/messaging/ffa/libsp/ffa_memory_descriptors.c
blob: 6bf097de17c729a50eb361d923e769f0b8c1ce78 (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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
// SPDX-License-Identifier: BSD-3-Clause
/*
 * Copyright (c) 2020-2021, Arm Limited and Contributors. All rights reserved.
 */

#include "ffa_memory_descriptors.h"
#include "ffa_api.h"
#include <assert.h>
#include <string.h>

static struct ffa_mem_transaction_desc *
get_mem_transaction_desc(struct ffa_mem_transaction_buffer *buffer)
{
	assert(sizeof(struct ffa_mem_transaction_desc) <= buffer->length);
	return (struct ffa_mem_transaction_desc *)buffer->buffer;
}

static uintptr_t get_offset_in_buffer(struct ffa_mem_transaction_buffer *buffer,
				      void *object)
{
	return (uintptr_t)(((uint8_t *)object) - ((uint8_t *)buffer->buffer));
}

static struct ffa_composite_mem_region_desc *
get_composite_desc_by_offset(struct ffa_mem_transaction_buffer *buffer,
			     uint32_t offset)
{
	void *ptr = NULL;

	assert(offset + sizeof(struct ffa_composite_mem_region_desc) <=
	       buffer->length);
	ptr = (((uint8_t *)buffer->buffer) + offset);

	return (struct ffa_composite_mem_region_desc *)ptr;
}

static uint32_t
get_composite_desc_offset(struct ffa_mem_transaction_buffer *buffer)
{
	const struct ffa_mem_access_desc *access_desc = NULL;

	if (ffa_get_mem_access_desc_count(buffer) == 0)
		return 0;

	/*
	 * All access descriptors have the same offset so we use the first one
	 * if it exists.
	 */
	access_desc = ffa_get_mem_access_desc(buffer, 0);
	return access_desc->composite_mem_region_desc_offset;
}

static struct ffa_composite_mem_region_desc *
get_composite_desc(struct ffa_mem_transaction_buffer *buffer)
{
	uint32_t offset = 0;

	offset = get_composite_desc_offset(buffer);

	return get_composite_desc_by_offset(buffer, offset);
}

void ffa_init_mem_transaction_buffer(void *address, size_t length,
				     struct ffa_mem_transaction_buffer *buffer)
{
	buffer->buffer = address;
	buffer->length = length;
	buffer->used = 0;
}

void ffa_init_mem_transaction_desc(struct ffa_mem_transaction_buffer *buffer,
				   uint16_t sender_id, uint8_t mem_region_attr,
				   uint32_t flags, uint64_t handle,
				   uint64_t tag)
{
	struct ffa_mem_transaction_desc *transaction = NULL;

	transaction = get_mem_transaction_desc(buffer);

	transaction->sender_id = sender_id;
	transaction->mem_region_attr = mem_region_attr;
	transaction->reserved_mbz0 = 0;
	transaction->flags = flags;
	transaction->handle = handle;
	transaction->tag = tag;
	transaction->reserved_mbz1 = 0;
	transaction->mem_access_desc_count = 0;

	buffer->used = sizeof(struct ffa_mem_transaction_desc);
}

const struct ffa_mem_transaction_desc *
ffa_get_mem_transaction_desc(struct ffa_mem_transaction_buffer *buffer)
{
	return get_mem_transaction_desc(buffer);
}

void ffa_reserve_mem_access_desc(struct ffa_mem_transaction_buffer *buffer,
				 size_t count)
{
	const struct ffa_mem_transaction_desc *transaction = NULL;
	size_t required_size = 0;
	uint32_t __maybe_unused composite_offset = 0;

	transaction = ffa_get_mem_transaction_desc(buffer);
	if (count <= transaction->mem_access_desc_count) {
		/* Prevent shrinking below the current count */
		return;
	}

	/* Checking if the descriptors fit in the buffer */
	required_size = sizeof(struct ffa_mem_transaction_desc);
	required_size += sizeof(struct ffa_mem_access_desc) * count;

	assert(required_size <= buffer->length);

	/*
	 * Checking if the descriptor array won't overlap with the composite
	 * memory region descriptor if it exists
	 */
	composite_offset = get_composite_desc_offset(buffer);
	/* The following assert's branches cannot be fully covered. */
	assert(composite_offset == 0 || required_size <= composite_offset);

	if (buffer->used < required_size)
		buffer->used = required_size;
}

uint32_t ffa_add_mem_access_desc(struct ffa_mem_transaction_buffer *buffer,
				 uint16_t endpoint_id, uint8_t mem_access_perm,
				 uint8_t flags)
{
	struct ffa_mem_transaction_desc *transaction = NULL;
	struct ffa_mem_access_desc *access_desc = NULL;
	struct ffa_mem_access_perm_desc *access_perm_desc = NULL;
	uint32_t index = 0;
	uint32_t composite_offset = 0;
	size_t required_size = 0;

	/* Get next access descriptor index */
	transaction = get_mem_transaction_desc(buffer);
	index = transaction->mem_access_desc_count;

	assert(index != UINT32_MAX);

	/* Allocating access descriptor */
	required_size = sizeof(struct ffa_mem_transaction_desc);
	required_size += sizeof(struct ffa_mem_access_desc) * (index + 1);
	assert(required_size <= buffer->length);

	/*
	 * Checking if the descriptor array won't overlap with the composite
	 * memory region descriptor if it exists
	 */
	composite_offset = get_composite_desc_offset(buffer);
	assert(composite_offset == 0 || required_size <= composite_offset);

	if (buffer->used < required_size)
		buffer->used = required_size;

	transaction->mem_access_desc_count++;

	/* Initializing access descriptor */
	access_desc = &transaction->mem_access_desc[index];

	access_perm_desc = &access_desc->mem_access_perm_desc;
	access_perm_desc->endpoint_id = endpoint_id;
	access_perm_desc->mem_access_permissions = mem_access_perm;
	access_perm_desc->flags = flags;

	/*
	 * Assigning the composite memory descriptor offset as it is either 0
	 * for indicating that the composite descriptor has not been added to
	 * the transaction buffer or setting it the point to the valid and
	 * only composite descriptor.
	 */
	access_desc->composite_mem_region_desc_offset = composite_offset;
	access_desc->reserved_mbz = 0;

	return index;
}

uint32_t
ffa_get_mem_access_desc_count(struct ffa_mem_transaction_buffer *buffer)
{
	const struct ffa_mem_transaction_desc *transaction = NULL;

	transaction = ffa_get_mem_transaction_desc(buffer);

	return transaction->mem_access_desc_count;
}

const struct ffa_mem_access_desc *
ffa_get_mem_access_desc(struct ffa_mem_transaction_buffer *buffer,
			uint32_t descriptor_index)
{
	struct ffa_mem_transaction_desc *transaction = NULL;
	struct ffa_mem_access_desc *access_desc = NULL;
	size_t offset = 0;

	transaction = get_mem_transaction_desc(buffer);

	assert(descriptor_index < transaction->mem_access_desc_count);

	access_desc = &transaction->mem_access_desc[descriptor_index];

	/* Validating if the whole descriptor is within the buffer boundaries */
	offset = get_offset_in_buffer(buffer, access_desc);
	offset += sizeof(struct ffa_mem_access_desc);
	assert(offset <= buffer->length);

	return access_desc;
}

void ffa_add_memory_region(struct ffa_mem_transaction_buffer *buffer,
			   const void *address, uint32_t page_count)
{
	struct ffa_mem_transaction_desc *transaction = NULL;

	struct ffa_composite_mem_region_desc *comp_desc = NULL;
	struct ffa_constituent_mem_region_desc *region_desc = NULL;
	size_t required_size = 0;
	uint32_t range_index = 0;
	uint32_t offset = 0;

	transaction = get_mem_transaction_desc(buffer);

	assert(transaction->mem_access_desc_count > 0);

	offset = get_composite_desc_offset(buffer);

	if (offset == 0) {
		/* Adding new composite descriptor */
		struct ffa_mem_access_desc *access_desc = NULL;
		uint32_t i = 0;

		/*
		 * Allocate composite memory regions descriptor to the end of
		 * the currently used area
		 */
		required_size = buffer->used +
				sizeof(struct ffa_composite_mem_region_desc);

		/* Overflow and truncation checks */
		assert(required_size <= buffer->length);
		assert(buffer->used == (size_t)((uint32_t)buffer->used));

		offset = buffer->used;
		buffer->used = required_size;

		/*
		 * Setting composite memory region descriptor offset in all the
		 * memory access descriptors
		 */
		for (i = 0; i < transaction->mem_access_desc_count; i++) {
			access_desc = &transaction->mem_access_desc[i];
			access_desc->composite_mem_region_desc_offset = offset;
		}

		/* Initializing composite descriptor values */
		comp_desc = get_composite_desc_by_offset(buffer, offset);
		comp_desc->total_page_count = 0;
		comp_desc->address_range_count = 0;
		comp_desc->reserved_mbz = 0;
	} else {
		/* The composite descriptor already exists */
		comp_desc = get_composite_desc_by_offset(buffer, offset);
	}

	range_index = comp_desc->address_range_count;
	required_size = buffer->used +
			sizeof(struct ffa_constituent_mem_region_desc);
	assert(required_size <= buffer->length);
	buffer->used = required_size;

	comp_desc->total_page_count += page_count;
	comp_desc->address_range_count++;

	region_desc = &comp_desc->constituent_mem_region_desc[range_index];

	region_desc->address = (uintptr_t)address;
	region_desc->page_count = page_count;
	region_desc->reserved_mbz = 0;
}

const struct ffa_composite_mem_region_desc *
ffa_get_memory_region(struct ffa_mem_transaction_buffer *buffer)
{
	struct ffa_composite_mem_region_desc *desc = NULL;
	size_t __maybe_unused end_offset = 0;

	desc = get_composite_desc(buffer);

	/*
	 * Checking if the constituent region descriptors are also in the buffer
	 */
	end_offset = ((uint8_t *)desc) - (uint8_t *)buffer->buffer;
	end_offset += sizeof(struct ffa_composite_mem_region_desc);
	end_offset += desc->address_range_count *
		      sizeof(struct ffa_constituent_mem_region_desc);
	assert(end_offset <= buffer->length);

	return desc;
}