xref: /kvm-unit-tests/lib/arm64/gic-v3-its-cmd.c (revision 5b70cbdb7bc2ea65096b51565c75815cc95945b8)
1 /*
2  * Copyright (C) 2020, Red Hat Inc, Eric Auger <eric.auger@redhat.com>
3  *
4  * Most of the code is copy-pasted from:
5  * drivers/irqchip/irq-gic-v3-its.c
6  * This work is licensed under the terms of the GNU LGPL, version 2.
7  */
8 #include <asm/io.h>
9 #include <asm/gic.h>
10 
11 #define ITS_ITT_ALIGN		SZ_256
12 
13 static const char * const its_cmd_string[] = {
14 	[GITS_CMD_MAPD]		= "MAPD",
15 	[GITS_CMD_MAPC]		= "MAPC",
16 	[GITS_CMD_MAPTI]	= "MAPTI",
17 	[GITS_CMD_MAPI]		= "MAPI",
18 	[GITS_CMD_MOVI]		= "MOVI",
19 	[GITS_CMD_DISCARD]	= "DISCARD",
20 	[GITS_CMD_INV]		= "INV",
21 	[GITS_CMD_MOVALL]	= "MOVALL",
22 	[GITS_CMD_INVALL]	= "INVALL",
23 	[GITS_CMD_INT]		= "INT",
24 	[GITS_CMD_CLEAR]	= "CLEAR",
25 	[GITS_CMD_SYNC]		= "SYNC",
26 };
27 
28 struct its_cmd_desc {
29 	union {
30 		struct {
31 			struct its_device *dev;
32 			u32 event_id;
33 		} its_inv_cmd;
34 
35 		struct {
36 			struct its_device *dev;
37 			u32 event_id;
38 		} its_int_cmd;
39 
40 		struct {
41 			struct its_device *dev;
42 			bool valid;
43 		} its_mapd_cmd;
44 
45 		struct {
46 			struct its_collection *col;
47 			bool valid;
48 		} its_mapc_cmd;
49 
50 		struct {
51 			struct its_device *dev;
52 			u32 phys_id;
53 			u32 event_id;
54 			u32 col_id;
55 		} its_mapti_cmd;
56 
57 		struct {
58 			struct its_device *dev;
59 			struct its_collection *col;
60 			u32 event_id;
61 		} its_movi_cmd;
62 
63 		struct {
64 			struct its_device *dev;
65 			u32 event_id;
66 		} its_discard_cmd;
67 
68 		struct {
69 			struct its_device *dev;
70 			u32 event_id;
71 		} its_clear_cmd;
72 
73 		struct {
74 			struct its_collection *col;
75 		} its_invall_cmd;
76 
77 		struct {
78 			struct its_collection *col;
79 		} its_sync_cmd;
80 	};
81 	bool verbose;
82 };
83 
84 typedef void (*its_cmd_builder_t)(struct its_cmd_block *,
85 				  struct its_cmd_desc *);
86 
87 /* ITS COMMANDS */
88 
89 static void its_mask_encode(u64 *raw_cmd, u64 val, int h, int l)
90 {
91 	u64 mask = GENMASK_ULL(h, l);
92 	*raw_cmd &= ~mask;
93 	*raw_cmd |= (val << l) & mask;
94 }
95 
96 static void its_encode_cmd(struct its_cmd_block *cmd, u8 cmd_nr)
97 {
98 	its_mask_encode(&cmd->raw_cmd[0], cmd_nr, 7, 0);
99 }
100 
101 static void its_encode_devid(struct its_cmd_block *cmd, u32 devid)
102 {
103 	its_mask_encode(&cmd->raw_cmd[0], devid, 63, 32);
104 }
105 
106 static void its_encode_event_id(struct its_cmd_block *cmd, u32 id)
107 {
108 	its_mask_encode(&cmd->raw_cmd[1], id, 31, 0);
109 }
110 
111 static void its_encode_phys_id(struct its_cmd_block *cmd, u32 phys_id)
112 {
113 	its_mask_encode(&cmd->raw_cmd[1], phys_id, 63, 32);
114 }
115 
116 static void its_encode_size(struct its_cmd_block *cmd, u8 size)
117 {
118 	its_mask_encode(&cmd->raw_cmd[1], size, 4, 0);
119 }
120 
121 static void its_encode_itt(struct its_cmd_block *cmd, u64 itt_addr)
122 {
123 	its_mask_encode(&cmd->raw_cmd[2], itt_addr >> 8, 50, 8);
124 }
125 
126 static void its_encode_valid(struct its_cmd_block *cmd, int valid)
127 {
128 	its_mask_encode(&cmd->raw_cmd[2], !!valid, 63, 63);
129 }
130 
131 static void its_encode_target(struct its_cmd_block *cmd, u64 target_addr)
132 {
133 	its_mask_encode(&cmd->raw_cmd[2], target_addr >> 16, 50, 16);
134 }
135 
136 static void its_encode_collection(struct its_cmd_block *cmd, u16 col)
137 {
138 	its_mask_encode(&cmd->raw_cmd[2], col, 15, 0);
139 }
140 
141 static inline void its_fixup_cmd(struct its_cmd_block *cmd)
142 {
143 	/* Let's fixup BE commands */
144 	cmd->raw_cmd[0] = cpu_to_le64(cmd->raw_cmd[0]);
145 	cmd->raw_cmd[1] = cpu_to_le64(cmd->raw_cmd[1]);
146 	cmd->raw_cmd[2] = cpu_to_le64(cmd->raw_cmd[2]);
147 	cmd->raw_cmd[3] = cpu_to_le64(cmd->raw_cmd[3]);
148 }
149 
150 static u64 its_cmd_ptr_to_offset(struct its_cmd_block *ptr)
151 {
152 	return (ptr - its_data.cmd_base) * sizeof(*ptr);
153 }
154 
155 static struct its_cmd_block *its_post_commands(void)
156 {
157 	u64 wr = its_cmd_ptr_to_offset(its_data.cmd_write);
158 
159 	writeq(wr, its_data.base + GITS_CWRITER);
160 	return its_data.cmd_write;
161 }
162 
163 static struct its_cmd_block *its_allocate_entry(void)
164 {
165 	struct its_cmd_block *cmd;
166 
167 	assert((u64)its_data.cmd_write < (u64)its_data.cmd_base + SZ_64K);
168 	cmd = its_data.cmd_write++;
169 	return cmd;
170 }
171 
172 static void its_wait_for_range_completion(struct its_cmd_block *from,
173 					  struct its_cmd_block *to)
174 {
175 	u64 rd_idx, from_idx, to_idx;
176 	u32 count = 1000000;    /* 1s! */
177 
178 	from_idx = its_cmd_ptr_to_offset(from);
179 	to_idx = its_cmd_ptr_to_offset(to);
180 	while (1) {
181 		rd_idx = readq(its_data.base + GITS_CREADR);
182 		if (rd_idx >= to_idx || rd_idx < from_idx)
183 			break;
184 
185 		count--;
186 		if (!count) {
187 			unsigned int cmd_id = from->raw_cmd[0] & 0xFF;
188 
189 			assert_msg(false, "%s timeout!",
190 			       cmd_id <= 0xF ? its_cmd_string[cmd_id] :
191 			       "Unexpected");
192 		}
193 		udelay(1);
194 	}
195 }
196 
197 static void its_send_single_command(its_cmd_builder_t builder,
198 				    struct its_cmd_desc *desc)
199 {
200 	struct its_cmd_block *cmd, *next_cmd;
201 
202 	cmd = its_allocate_entry();
203 	builder(cmd, desc);
204 	next_cmd = its_post_commands();
205 
206 	its_wait_for_range_completion(cmd, next_cmd);
207 }
208 
209 static void its_build_mapd_cmd(struct its_cmd_block *cmd,
210 			       struct its_cmd_desc *desc)
211 {
212 	unsigned long itt_addr;
213 	u8 size = desc->its_mapd_cmd.dev->nr_ites;
214 
215 	itt_addr = (unsigned long)(virt_to_phys(desc->its_mapd_cmd.dev->itt));
216 	itt_addr = ALIGN(itt_addr, ITS_ITT_ALIGN);
217 
218 	its_encode_cmd(cmd, GITS_CMD_MAPD);
219 	its_encode_devid(cmd, desc->its_mapd_cmd.dev->device_id);
220 	its_encode_size(cmd, size - 1);
221 	its_encode_itt(cmd, itt_addr);
222 	its_encode_valid(cmd, desc->its_mapd_cmd.valid);
223 	its_fixup_cmd(cmd);
224 	if (desc->verbose)
225 		printf("ITS: MAPD devid=%d size = 0x%x itt=0x%lx valid=%d\n",
226 			desc->its_mapd_cmd.dev->device_id,
227 			size, itt_addr, desc->its_mapd_cmd.valid);
228 }
229 
230 static void its_build_mapc_cmd(struct its_cmd_block *cmd,
231 			       struct its_cmd_desc *desc)
232 {
233 	its_encode_cmd(cmd, GITS_CMD_MAPC);
234 	its_encode_collection(cmd, desc->its_mapc_cmd.col->col_id);
235 	its_encode_target(cmd, desc->its_mapc_cmd.col->target_address);
236 	its_encode_valid(cmd, desc->its_mapc_cmd.valid);
237 	its_fixup_cmd(cmd);
238 	if (desc->verbose)
239 		printf("MAPC col_id=%d target_addr = 0x%lx valid=%d\n",
240 		       desc->its_mapc_cmd.col->col_id,
241 		       desc->its_mapc_cmd.col->target_address,
242 		       desc->its_mapc_cmd.valid);
243 }
244 
245 static void its_build_mapti_cmd(struct its_cmd_block *cmd,
246 				struct its_cmd_desc *desc)
247 {
248 	its_encode_cmd(cmd, GITS_CMD_MAPTI);
249 	its_encode_devid(cmd, desc->its_mapti_cmd.dev->device_id);
250 	its_encode_event_id(cmd, desc->its_mapti_cmd.event_id);
251 	its_encode_phys_id(cmd, desc->its_mapti_cmd.phys_id);
252 	its_encode_collection(cmd, desc->its_mapti_cmd.col_id);
253 	its_fixup_cmd(cmd);
254 	if (desc->verbose)
255 		printf("MAPTI dev_id=%d event_id=%d -> phys_id=%d, col_id=%d\n",
256 		       desc->its_mapti_cmd.dev->device_id,
257 		       desc->its_mapti_cmd.event_id,
258 		       desc->its_mapti_cmd.phys_id,
259 		       desc->its_mapti_cmd.col_id);
260 }
261 
262 static void its_build_invall_cmd(struct its_cmd_block *cmd,
263 			      struct its_cmd_desc *desc)
264 {
265 	its_encode_cmd(cmd, GITS_CMD_INVALL);
266 	its_encode_collection(cmd, desc->its_invall_cmd.col->col_id);
267 	its_fixup_cmd(cmd);
268 	if (desc->verbose)
269 		printf("INVALL col_id=%d\n", desc->its_invall_cmd.col->col_id);
270 }
271 
272 static void its_build_clear_cmd(struct its_cmd_block *cmd,
273 				struct its_cmd_desc *desc)
274 {
275 	its_encode_cmd(cmd, GITS_CMD_CLEAR);
276 	its_encode_devid(cmd, desc->its_clear_cmd.dev->device_id);
277 	its_encode_event_id(cmd, desc->its_clear_cmd.event_id);
278 	its_fixup_cmd(cmd);
279 	if (desc->verbose)
280 		printf("CLEAR dev_id=%d event_id=%d\n", desc->its_clear_cmd.dev->device_id, desc->its_clear_cmd.event_id);
281 }
282 
283 static void its_build_discard_cmd(struct its_cmd_block *cmd,
284 				  struct its_cmd_desc *desc)
285 {
286 	its_encode_cmd(cmd, GITS_CMD_DISCARD);
287 	its_encode_devid(cmd, desc->its_discard_cmd.dev->device_id);
288 	its_encode_event_id(cmd, desc->its_discard_cmd.event_id);
289 	its_fixup_cmd(cmd);
290 	if (desc->verbose)
291 		printf("DISCARD dev_id=%d event_id=%d\n",
292 			desc->its_clear_cmd.dev->device_id, desc->its_clear_cmd.event_id);
293 }
294 
295 static void its_build_inv_cmd(struct its_cmd_block *cmd,
296 			      struct its_cmd_desc *desc)
297 {
298 	its_encode_cmd(cmd, GITS_CMD_INV);
299 	its_encode_devid(cmd, desc->its_inv_cmd.dev->device_id);
300 	its_encode_event_id(cmd, desc->its_inv_cmd.event_id);
301 	its_fixup_cmd(cmd);
302 	if (desc->verbose)
303 		printf("INV dev_id=%d event_id=%d\n",
304 		       desc->its_inv_cmd.dev->device_id,
305 		       desc->its_inv_cmd.event_id);
306 }
307 
308 static void its_build_int_cmd(struct its_cmd_block *cmd,
309 			      struct its_cmd_desc *desc)
310 {
311 	its_encode_cmd(cmd, GITS_CMD_INT);
312 	its_encode_devid(cmd, desc->its_int_cmd.dev->device_id);
313 	its_encode_event_id(cmd, desc->its_int_cmd.event_id);
314 	its_fixup_cmd(cmd);
315 	if (desc->verbose)
316 		printf("INT dev_id=%d event_id=%d\n",
317 		       desc->its_int_cmd.dev->device_id,
318 		       desc->its_int_cmd.event_id);
319 }
320 
321 static void its_build_sync_cmd(struct its_cmd_block *cmd,
322 			       struct its_cmd_desc *desc)
323 {
324 	its_encode_cmd(cmd, GITS_CMD_SYNC);
325 	its_encode_target(cmd, desc->its_sync_cmd.col->target_address);
326 	its_fixup_cmd(cmd);
327 	if (desc->verbose)
328 		printf("SYNC target_addr = 0x%lx\n",
329 		       desc->its_sync_cmd.col->target_address);
330 }
331 
332 static void its_build_movi_cmd(struct its_cmd_block *cmd,
333 			       struct its_cmd_desc *desc)
334 {
335 	its_encode_cmd(cmd, GITS_CMD_MOVI);
336 	its_encode_devid(cmd, desc->its_movi_cmd.dev->device_id);
337 	its_encode_event_id(cmd, desc->its_movi_cmd.event_id);
338 	its_encode_collection(cmd, desc->its_movi_cmd.col->col_id);
339 	its_fixup_cmd(cmd);
340 	if (desc->verbose)
341 		printf("MOVI dev_id=%d event_id = %d col_id=%d\n",
342 		       desc->its_movi_cmd.dev->device_id,
343 		       desc->its_movi_cmd.event_id,
344 		       desc->its_movi_cmd.col->col_id);
345 }
346 
347 void __its_send_mapd(struct its_device *dev, int valid, bool verbose)
348 {
349 	struct its_cmd_desc desc;
350 
351 	desc.its_mapd_cmd.dev = dev;
352 	desc.its_mapd_cmd.valid = !!valid;
353 	desc.verbose = verbose;
354 
355 	its_send_single_command(its_build_mapd_cmd, &desc);
356 }
357 
358 void __its_send_mapc(struct its_collection *col, int valid, bool verbose)
359 {
360 	struct its_cmd_desc desc;
361 
362 	desc.its_mapc_cmd.col = col;
363 	desc.its_mapc_cmd.valid = !!valid;
364 	desc.verbose = verbose;
365 
366 	its_send_single_command(its_build_mapc_cmd, &desc);
367 }
368 
369 void __its_send_mapti(struct its_device *dev, u32 irq_id,
370 		      u32 event_id, struct its_collection *col, bool verbose)
371 {
372 	struct its_cmd_desc desc;
373 
374 	desc.its_mapti_cmd.dev = dev;
375 	desc.its_mapti_cmd.phys_id = irq_id;
376 	desc.its_mapti_cmd.event_id = event_id;
377 	desc.its_mapti_cmd.col_id = col->col_id;
378 	desc.verbose = verbose;
379 
380 	its_send_single_command(its_build_mapti_cmd, &desc);
381 }
382 
383 void __its_send_int(struct its_device *dev, u32 event_id, bool verbose)
384 {
385 	struct its_cmd_desc desc;
386 
387 	desc.its_int_cmd.dev = dev;
388 	desc.its_int_cmd.event_id = event_id;
389 	desc.verbose = verbose;
390 
391 	its_send_single_command(its_build_int_cmd, &desc);
392 }
393 
394 void __its_send_movi(struct its_device *dev, struct its_collection *col,
395 		     u32 id, bool verbose)
396 {
397 	struct its_cmd_desc desc;
398 
399 	desc.its_movi_cmd.dev = dev;
400 	desc.its_movi_cmd.col = col;
401 	desc.its_movi_cmd.event_id = id;
402 	desc.verbose = verbose;
403 
404 	its_send_single_command(its_build_movi_cmd, &desc);
405 }
406 
407 void __its_send_invall(struct its_collection *col, bool verbose)
408 {
409 	struct its_cmd_desc desc;
410 
411 	desc.its_invall_cmd.col = col;
412 	desc.verbose = verbose;
413 
414 	its_send_single_command(its_build_invall_cmd, &desc);
415 }
416 
417 void __its_send_inv(struct its_device *dev, u32 event_id, bool verbose)
418 {
419 	struct its_cmd_desc desc;
420 
421 	desc.its_inv_cmd.dev = dev;
422 	desc.its_inv_cmd.event_id = event_id;
423 	desc.verbose = verbose;
424 
425 	its_send_single_command(its_build_inv_cmd, &desc);
426 }
427 
428 void __its_send_discard(struct its_device *dev, u32 event_id, bool verbose)
429 {
430 	struct its_cmd_desc desc;
431 
432 	desc.its_discard_cmd.dev = dev;
433 	desc.its_discard_cmd.event_id = event_id;
434 	desc.verbose = verbose;
435 
436 	its_send_single_command(its_build_discard_cmd, &desc);
437 }
438 
439 void __its_send_clear(struct its_device *dev, u32 event_id, bool verbose)
440 {
441 	struct its_cmd_desc desc;
442 
443 	desc.its_clear_cmd.dev = dev;
444 	desc.its_clear_cmd.event_id = event_id;
445 	desc.verbose = verbose;
446 
447 	its_send_single_command(its_build_clear_cmd, &desc);
448 }
449 
450 void __its_send_sync(struct its_collection *col, bool verbose)
451 {
452 	struct its_cmd_desc desc;
453 
454 	desc.its_sync_cmd.col = col;
455 	desc.verbose = verbose;
456 
457 	its_send_single_command(its_build_sync_cmd, &desc);
458 }
459 
460