1 // SPDX-License-Identifier: GPL-2.0
2
3 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4 * Copyright (C) 2019-2022 Linaro Ltd.
5 */
6
7 #include <linux/types.h>
8 #include <linux/device.h>
9 #include <linux/slab.h>
10 #include <linux/bitfield.h>
11 #include <linux/dma-direction.h>
12
13 #include "gsi.h"
14 #include "gsi_trans.h"
15 #include "ipa.h"
16 #include "ipa_endpoint.h"
17 #include "ipa_table.h"
18 #include "ipa_cmd.h"
19 #include "ipa_mem.h"
20
21 /**
22 * DOC: IPA Immediate Commands
23 *
24 * The AP command TX endpoint is used to issue immediate commands to the IPA.
25 * An immediate command is generally used to request the IPA do something
26 * other than data transfer to another endpoint.
27 *
28 * Immediate commands are represented by GSI transactions just like other
29 * transfer requests, and use a single GSI TRE. Each immediate command
30 * has a well-defined format, having a payload of a known length. This
31 * allows the transfer element's length field to be used to hold an
32 * immediate command's opcode. The payload for a command resides in AP
33 * memory and is described by a single scatterlist entry in its transaction.
34 * Commands do not require a transaction completion callback, and are
35 * always issued using gsi_trans_commit_wait().
36 */
37
38 /* Some commands can wait until indicated pipeline stages are clear */
39 enum pipeline_clear_options {
40 pipeline_clear_hps = 0x0,
41 pipeline_clear_src_grp = 0x1,
42 pipeline_clear_full = 0x2,
43 };
44
45 /* IPA_CMD_IP_V{4,6}_{FILTER,ROUTING}_INIT */
46
47 struct ipa_cmd_hw_ip_fltrt_init {
48 __le64 hash_rules_addr;
49 __le64 flags;
50 __le64 nhash_rules_addr;
51 };
52
53 /* Field masks for ipa_cmd_hw_ip_fltrt_init structure fields */
54 #define IP_FLTRT_FLAGS_HASH_SIZE_FMASK GENMASK_ULL(11, 0)
55 #define IP_FLTRT_FLAGS_HASH_ADDR_FMASK GENMASK_ULL(27, 12)
56 #define IP_FLTRT_FLAGS_NHASH_SIZE_FMASK GENMASK_ULL(39, 28)
57 #define IP_FLTRT_FLAGS_NHASH_ADDR_FMASK GENMASK_ULL(55, 40)
58
59 /* IPA_CMD_HDR_INIT_LOCAL */
60
61 struct ipa_cmd_hw_hdr_init_local {
62 __le64 hdr_table_addr;
63 __le32 flags;
64 __le32 reserved;
65 };
66
67 /* Field masks for ipa_cmd_hw_hdr_init_local structure fields */
68 #define HDR_INIT_LOCAL_FLAGS_TABLE_SIZE_FMASK GENMASK(11, 0)
69 #define HDR_INIT_LOCAL_FLAGS_HDR_ADDR_FMASK GENMASK(27, 12)
70
71 /* IPA_CMD_REGISTER_WRITE */
72
73 /* For IPA v4.0+, the pipeline clear options are encoded in the opcode */
74 #define REGISTER_WRITE_OPCODE_SKIP_CLEAR_FMASK GENMASK(8, 8)
75 #define REGISTER_WRITE_OPCODE_CLEAR_OPTION_FMASK GENMASK(10, 9)
76
77 struct ipa_cmd_register_write {
78 __le16 flags; /* Unused/reserved prior to IPA v4.0 */
79 __le16 offset;
80 __le32 value;
81 __le32 value_mask;
82 __le32 clear_options; /* Unused/reserved for IPA v4.0+ */
83 };
84
85 /* Field masks for ipa_cmd_register_write structure fields */
86 /* The next field is present for IPA v4.0+ */
87 #define REGISTER_WRITE_FLAGS_OFFSET_HIGH_FMASK GENMASK(14, 11)
88 /* The next field is not present for IPA v4.0+ */
89 #define REGISTER_WRITE_FLAGS_SKIP_CLEAR_FMASK GENMASK(15, 15)
90
91 /* The next field and its values are not present for IPA v4.0+ */
92 #define REGISTER_WRITE_CLEAR_OPTIONS_FMASK GENMASK(1, 0)
93
94 /* IPA_CMD_IP_PACKET_INIT */
95
96 struct ipa_cmd_ip_packet_init {
97 u8 dest_endpoint;
98 u8 reserved[7];
99 };
100
101 /* Field masks for ipa_cmd_ip_packet_init dest_endpoint field */
102 #define IPA_PACKET_INIT_DEST_ENDPOINT_FMASK GENMASK(4, 0)
103
104 /* IPA_CMD_DMA_SHARED_MEM */
105
106 /* For IPA v4.0+, this opcode gets modified with pipeline clear options */
107
108 #define DMA_SHARED_MEM_OPCODE_SKIP_CLEAR_FMASK GENMASK(8, 8)
109 #define DMA_SHARED_MEM_OPCODE_CLEAR_OPTION_FMASK GENMASK(10, 9)
110
111 struct ipa_cmd_hw_dma_mem_mem {
112 __le16 clear_after_read; /* 0 or DMA_SHARED_MEM_CLEAR_AFTER_READ */
113 __le16 size;
114 __le16 local_addr;
115 __le16 flags;
116 __le64 system_addr;
117 };
118
119 /* Flag allowing atomic clear of target region after reading data (v4.0+)*/
120 #define DMA_SHARED_MEM_CLEAR_AFTER_READ GENMASK(15, 15)
121
122 /* Field masks for ipa_cmd_hw_dma_mem_mem structure fields */
123 #define DMA_SHARED_MEM_FLAGS_DIRECTION_FMASK GENMASK(0, 0)
124 /* The next two fields are not present for IPA v4.0+ */
125 #define DMA_SHARED_MEM_FLAGS_SKIP_CLEAR_FMASK GENMASK(1, 1)
126 #define DMA_SHARED_MEM_FLAGS_CLEAR_OPTIONS_FMASK GENMASK(3, 2)
127
128 /* IPA_CMD_IP_PACKET_TAG_STATUS */
129
130 struct ipa_cmd_ip_packet_tag_status {
131 __le64 tag;
132 };
133
134 #define IP_PACKET_TAG_STATUS_TAG_FMASK GENMASK_ULL(63, 16)
135
136 /* Immediate command payload */
137 union ipa_cmd_payload {
138 struct ipa_cmd_hw_ip_fltrt_init table_init;
139 struct ipa_cmd_hw_hdr_init_local hdr_init_local;
140 struct ipa_cmd_register_write register_write;
141 struct ipa_cmd_ip_packet_init ip_packet_init;
142 struct ipa_cmd_hw_dma_mem_mem dma_shared_mem;
143 struct ipa_cmd_ip_packet_tag_status ip_packet_tag_status;
144 };
145
ipa_cmd_validate_build(void)146 static void ipa_cmd_validate_build(void)
147 {
148 /* The sizes of a filter and route tables need to fit into fields
149 * in the ipa_cmd_hw_ip_fltrt_init structure. Although hashed tables
150 * might not be used, non-hashed and hashed tables have the same
151 * maximum size. IPv4 and IPv6 filter tables have the same number
152 * of entries, as and IPv4 and IPv6 route tables have the same number
153 * of entries.
154 */
155 #define TABLE_SIZE (TABLE_COUNT_MAX * sizeof(__le64))
156 #define TABLE_COUNT_MAX max_t(u32, IPA_ROUTE_COUNT_MAX, IPA_FILTER_COUNT_MAX)
157 BUILD_BUG_ON(TABLE_SIZE > field_max(IP_FLTRT_FLAGS_HASH_SIZE_FMASK));
158 BUILD_BUG_ON(TABLE_SIZE > field_max(IP_FLTRT_FLAGS_NHASH_SIZE_FMASK));
159 #undef TABLE_COUNT_MAX
160 #undef TABLE_SIZE
161
162 /* Hashed and non-hashed fields are assumed to be the same size */
163 BUILD_BUG_ON(field_max(IP_FLTRT_FLAGS_HASH_SIZE_FMASK) !=
164 field_max(IP_FLTRT_FLAGS_NHASH_SIZE_FMASK));
165 BUILD_BUG_ON(field_max(IP_FLTRT_FLAGS_HASH_ADDR_FMASK) !=
166 field_max(IP_FLTRT_FLAGS_NHASH_ADDR_FMASK));
167
168 /* Valid endpoint numbers must fit in the IP packet init command */
169 BUILD_BUG_ON(field_max(IPA_PACKET_INIT_DEST_ENDPOINT_FMASK) <
170 IPA_ENDPOINT_MAX - 1);
171 }
172
173 /* Validate a memory region holding a table */
ipa_cmd_table_valid(struct ipa * ipa,const struct ipa_mem * mem,bool route)174 bool ipa_cmd_table_valid(struct ipa *ipa, const struct ipa_mem *mem, bool route)
175 {
176 u32 offset_max = field_max(IP_FLTRT_FLAGS_NHASH_ADDR_FMASK);
177 u32 size_max = field_max(IP_FLTRT_FLAGS_NHASH_SIZE_FMASK);
178 const char *table = route ? "route" : "filter";
179 struct device *dev = &ipa->pdev->dev;
180
181 /* Size must fit in the immediate command field that holds it */
182 if (mem->size > size_max) {
183 dev_err(dev, "%s table region size too large\n", table);
184 dev_err(dev, " (0x%04x > 0x%04x)\n",
185 mem->size, size_max);
186
187 return false;
188 }
189
190 /* Offset must fit in the immediate command field that holds it */
191 if (mem->offset > offset_max ||
192 ipa->mem_offset > offset_max - mem->offset) {
193 dev_err(dev, "%s table region offset too large\n", table);
194 dev_err(dev, " (0x%04x + 0x%04x > 0x%04x)\n",
195 ipa->mem_offset, mem->offset, offset_max);
196
197 return false;
198 }
199
200 /* Entire memory range must fit within IPA-local memory */
201 if (mem->offset > ipa->mem_size ||
202 mem->size > ipa->mem_size - mem->offset) {
203 dev_err(dev, "%s table region out of range\n", table);
204 dev_err(dev, " (0x%04x + 0x%04x > 0x%04x)\n",
205 mem->offset, mem->size, ipa->mem_size);
206
207 return false;
208 }
209
210 return true;
211 }
212
213 /* Validate the memory region that holds headers */
ipa_cmd_header_valid(struct ipa * ipa)214 static bool ipa_cmd_header_valid(struct ipa *ipa)
215 {
216 struct device *dev = &ipa->pdev->dev;
217 const struct ipa_mem *mem;
218 u32 offset_max;
219 u32 size_max;
220 u32 offset;
221 u32 size;
222
223 /* In ipa_cmd_hdr_init_local_add() we record the offset and size of
224 * the header table memory area in an immediate command. Make sure
225 * the offset and size fit in the fields that need to hold them, and
226 * that the entire range is within the overall IPA memory range.
227 */
228 offset_max = field_max(HDR_INIT_LOCAL_FLAGS_HDR_ADDR_FMASK);
229 size_max = field_max(HDR_INIT_LOCAL_FLAGS_TABLE_SIZE_FMASK);
230
231 /* The header memory area contains both the modem and AP header
232 * regions. The modem portion defines the address of the region.
233 */
234 mem = ipa_mem_find(ipa, IPA_MEM_MODEM_HEADER);
235 offset = mem->offset;
236 size = mem->size;
237
238 /* Make sure the offset fits in the IPA command */
239 if (offset > offset_max || ipa->mem_offset > offset_max - offset) {
240 dev_err(dev, "header table region offset too large\n");
241 dev_err(dev, " (0x%04x + 0x%04x > 0x%04x)\n",
242 ipa->mem_offset, offset, offset_max);
243
244 return false;
245 }
246
247 /* Add the size of the AP portion (if defined) to the combined size */
248 mem = ipa_mem_find(ipa, IPA_MEM_AP_HEADER);
249 if (mem)
250 size += mem->size;
251
252 /* Make sure the combined size fits in the IPA command */
253 if (size > size_max) {
254 dev_err(dev, "header table region size too large\n");
255 dev_err(dev, " (0x%04x > 0x%08x)\n", size, size_max);
256
257 return false;
258 }
259
260 /* Make sure the entire combined area fits in IPA memory */
261 if (size > ipa->mem_size || offset > ipa->mem_size - size) {
262 dev_err(dev, "header table region out of range\n");
263 dev_err(dev, " (0x%04x + 0x%04x > 0x%04x)\n",
264 offset, size, ipa->mem_size);
265
266 return false;
267 }
268
269 return true;
270 }
271
272 /* Indicate whether an offset can be used with a register_write command */
ipa_cmd_register_write_offset_valid(struct ipa * ipa,const char * name,u32 offset)273 static bool ipa_cmd_register_write_offset_valid(struct ipa *ipa,
274 const char *name, u32 offset)
275 {
276 struct ipa_cmd_register_write *payload;
277 struct device *dev = &ipa->pdev->dev;
278 u32 offset_max;
279 u32 bit_count;
280
281 /* The maximum offset in a register_write immediate command depends
282 * on the version of IPA. A 16 bit offset is always supported,
283 * but starting with IPA v4.0 some additional high-order bits are
284 * allowed.
285 */
286 bit_count = BITS_PER_BYTE * sizeof(payload->offset);
287 if (ipa->version >= IPA_VERSION_4_0)
288 bit_count += hweight32(REGISTER_WRITE_FLAGS_OFFSET_HIGH_FMASK);
289 BUILD_BUG_ON(bit_count > 32);
290 offset_max = ~0U >> (32 - bit_count);
291
292 /* Make sure the offset can be represented by the field(s)
293 * that holds it. Also make sure the offset is not outside
294 * the overall IPA memory range.
295 */
296 if (offset > offset_max || ipa->mem_offset > offset_max - offset) {
297 dev_err(dev, "%s offset too large 0x%04x + 0x%04x > 0x%04x)\n",
298 name, ipa->mem_offset, offset, offset_max);
299 return false;
300 }
301
302 return true;
303 }
304
305 /* Check whether offsets passed to register_write are valid */
ipa_cmd_register_write_valid(struct ipa * ipa)306 static bool ipa_cmd_register_write_valid(struct ipa *ipa)
307 {
308 const struct ipa_reg *reg;
309 const char *name;
310 u32 offset;
311
312 /* If hashed tables are supported, ensure the hash flush register
313 * offset will fit in a register write IPA immediate command.
314 */
315 if (ipa_table_hash_support(ipa)) {
316 reg = ipa_reg(ipa, FILT_ROUT_HASH_FLUSH);
317 offset = ipa_reg_offset(reg);
318 name = "filter/route hash flush";
319 if (!ipa_cmd_register_write_offset_valid(ipa, name, offset))
320 return false;
321 }
322
323 /* Each endpoint can have a status endpoint associated with it,
324 * and this is recorded in an endpoint register. If the modem
325 * crashes, we reset the status endpoint for all modem endpoints
326 * using a register write IPA immediate command. Make sure the
327 * worst case (highest endpoint number) offset of that endpoint
328 * fits in the register write command field(s) that must hold it.
329 */
330 reg = ipa_reg(ipa, ENDP_STATUS);
331 offset = ipa_reg_n_offset(reg, IPA_ENDPOINT_COUNT - 1);
332 name = "maximal endpoint status";
333 if (!ipa_cmd_register_write_offset_valid(ipa, name, offset))
334 return false;
335
336 return true;
337 }
338
ipa_cmd_data_valid(struct ipa * ipa)339 bool ipa_cmd_data_valid(struct ipa *ipa)
340 {
341 if (!ipa_cmd_header_valid(ipa))
342 return false;
343
344 if (!ipa_cmd_register_write_valid(ipa))
345 return false;
346
347 return true;
348 }
349
350
ipa_cmd_pool_init(struct gsi_channel * channel,u32 tre_max)351 int ipa_cmd_pool_init(struct gsi_channel *channel, u32 tre_max)
352 {
353 struct gsi_trans_info *trans_info = &channel->trans_info;
354 struct device *dev = channel->gsi->dev;
355
356 /* This is as good a place as any to validate build constants */
357 ipa_cmd_validate_build();
358
359 /* Command payloads are allocated one at a time, but a single
360 * transaction can require up to the maximum supported by the
361 * channel; treat them as if they were allocated all at once.
362 */
363 return gsi_trans_pool_init_dma(dev, &trans_info->cmd_pool,
364 sizeof(union ipa_cmd_payload),
365 tre_max, channel->trans_tre_max);
366 }
367
ipa_cmd_pool_exit(struct gsi_channel * channel)368 void ipa_cmd_pool_exit(struct gsi_channel *channel)
369 {
370 struct gsi_trans_info *trans_info = &channel->trans_info;
371 struct device *dev = channel->gsi->dev;
372
373 gsi_trans_pool_exit_dma(dev, &trans_info->cmd_pool);
374 }
375
376 static union ipa_cmd_payload *
ipa_cmd_payload_alloc(struct ipa * ipa,dma_addr_t * addr)377 ipa_cmd_payload_alloc(struct ipa *ipa, dma_addr_t *addr)
378 {
379 struct gsi_trans_info *trans_info;
380 struct ipa_endpoint *endpoint;
381
382 endpoint = ipa->name_map[IPA_ENDPOINT_AP_COMMAND_TX];
383 trans_info = &ipa->gsi.channel[endpoint->channel_id].trans_info;
384
385 return gsi_trans_pool_alloc_dma(&trans_info->cmd_pool, addr);
386 }
387
388 /* If hash_size is 0, hash_offset and hash_addr ignored. */
ipa_cmd_table_init_add(struct gsi_trans * trans,enum ipa_cmd_opcode opcode,u16 size,u32 offset,dma_addr_t addr,u16 hash_size,u32 hash_offset,dma_addr_t hash_addr)389 void ipa_cmd_table_init_add(struct gsi_trans *trans,
390 enum ipa_cmd_opcode opcode, u16 size, u32 offset,
391 dma_addr_t addr, u16 hash_size, u32 hash_offset,
392 dma_addr_t hash_addr)
393 {
394 struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
395 struct ipa_cmd_hw_ip_fltrt_init *payload;
396 union ipa_cmd_payload *cmd_payload;
397 dma_addr_t payload_addr;
398 u64 val;
399
400 /* Record the non-hash table offset and size */
401 offset += ipa->mem_offset;
402 val = u64_encode_bits(offset, IP_FLTRT_FLAGS_NHASH_ADDR_FMASK);
403 val |= u64_encode_bits(size, IP_FLTRT_FLAGS_NHASH_SIZE_FMASK);
404
405 /* The hash table offset and address are zero if its size is 0 */
406 if (hash_size) {
407 /* Record the hash table offset and size */
408 hash_offset += ipa->mem_offset;
409 val |= u64_encode_bits(hash_offset,
410 IP_FLTRT_FLAGS_HASH_ADDR_FMASK);
411 val |= u64_encode_bits(hash_size,
412 IP_FLTRT_FLAGS_HASH_SIZE_FMASK);
413 }
414
415 cmd_payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
416 payload = &cmd_payload->table_init;
417
418 /* Fill in all offsets and sizes and the non-hash table address */
419 if (hash_size)
420 payload->hash_rules_addr = cpu_to_le64(hash_addr);
421 payload->flags = cpu_to_le64(val);
422 payload->nhash_rules_addr = cpu_to_le64(addr);
423
424 gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
425 opcode);
426 }
427
428 /* Initialize header space in IPA-local memory */
ipa_cmd_hdr_init_local_add(struct gsi_trans * trans,u32 offset,u16 size,dma_addr_t addr)429 void ipa_cmd_hdr_init_local_add(struct gsi_trans *trans, u32 offset, u16 size,
430 dma_addr_t addr)
431 {
432 struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
433 enum ipa_cmd_opcode opcode = IPA_CMD_HDR_INIT_LOCAL;
434 struct ipa_cmd_hw_hdr_init_local *payload;
435 union ipa_cmd_payload *cmd_payload;
436 dma_addr_t payload_addr;
437 u32 flags;
438
439 offset += ipa->mem_offset;
440
441 /* With this command we tell the IPA where in its local memory the
442 * header tables reside. The content of the buffer provided is
443 * also written via DMA into that space. The IPA hardware owns
444 * the table, but the AP must initialize it.
445 */
446 cmd_payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
447 payload = &cmd_payload->hdr_init_local;
448
449 payload->hdr_table_addr = cpu_to_le64(addr);
450 flags = u32_encode_bits(size, HDR_INIT_LOCAL_FLAGS_TABLE_SIZE_FMASK);
451 flags |= u32_encode_bits(offset, HDR_INIT_LOCAL_FLAGS_HDR_ADDR_FMASK);
452 payload->flags = cpu_to_le32(flags);
453
454 gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
455 opcode);
456 }
457
ipa_cmd_register_write_add(struct gsi_trans * trans,u32 offset,u32 value,u32 mask,bool clear_full)458 void ipa_cmd_register_write_add(struct gsi_trans *trans, u32 offset, u32 value,
459 u32 mask, bool clear_full)
460 {
461 struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
462 struct ipa_cmd_register_write *payload;
463 union ipa_cmd_payload *cmd_payload;
464 u32 opcode = IPA_CMD_REGISTER_WRITE;
465 dma_addr_t payload_addr;
466 u32 clear_option;
467 u32 options;
468 u16 flags;
469
470 /* pipeline_clear_src_grp is not used */
471 clear_option = clear_full ? pipeline_clear_full : pipeline_clear_hps;
472
473 /* IPA v4.0+ represents the pipeline clear options in the opcode. It
474 * also supports a larger offset by encoding additional high-order
475 * bits in the payload flags field.
476 */
477 if (ipa->version >= IPA_VERSION_4_0) {
478 u16 offset_high;
479 u32 val;
480
481 /* Opcode encodes pipeline clear options */
482 /* SKIP_CLEAR is always 0 (don't skip pipeline clear) */
483 val = u16_encode_bits(clear_option,
484 REGISTER_WRITE_OPCODE_CLEAR_OPTION_FMASK);
485 opcode |= val;
486
487 /* Extract the high 4 bits from the offset */
488 offset_high = (u16)u32_get_bits(offset, GENMASK(19, 16));
489 offset &= (1 << 16) - 1;
490
491 /* Extract the top 4 bits and encode it into the flags field */
492 flags = u16_encode_bits(offset_high,
493 REGISTER_WRITE_FLAGS_OFFSET_HIGH_FMASK);
494 options = 0; /* reserved */
495
496 } else {
497 flags = 0; /* SKIP_CLEAR flag is always 0 */
498 options = u16_encode_bits(clear_option,
499 REGISTER_WRITE_CLEAR_OPTIONS_FMASK);
500 }
501
502 cmd_payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
503 payload = &cmd_payload->register_write;
504
505 payload->flags = cpu_to_le16(flags);
506 payload->offset = cpu_to_le16((u16)offset);
507 payload->value = cpu_to_le32(value);
508 payload->value_mask = cpu_to_le32(mask);
509 payload->clear_options = cpu_to_le32(options);
510
511 gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
512 opcode);
513 }
514
515 /* Skip IP packet processing on the next data transfer on a TX channel */
ipa_cmd_ip_packet_init_add(struct gsi_trans * trans,u8 endpoint_id)516 static void ipa_cmd_ip_packet_init_add(struct gsi_trans *trans, u8 endpoint_id)
517 {
518 struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
519 enum ipa_cmd_opcode opcode = IPA_CMD_IP_PACKET_INIT;
520 struct ipa_cmd_ip_packet_init *payload;
521 union ipa_cmd_payload *cmd_payload;
522 dma_addr_t payload_addr;
523
524 cmd_payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
525 payload = &cmd_payload->ip_packet_init;
526
527 payload->dest_endpoint = u8_encode_bits(endpoint_id,
528 IPA_PACKET_INIT_DEST_ENDPOINT_FMASK);
529
530 gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
531 opcode);
532 }
533
534 /* Use a DMA command to read or write a block of IPA-resident memory */
ipa_cmd_dma_shared_mem_add(struct gsi_trans * trans,u32 offset,u16 size,dma_addr_t addr,bool toward_ipa)535 void ipa_cmd_dma_shared_mem_add(struct gsi_trans *trans, u32 offset, u16 size,
536 dma_addr_t addr, bool toward_ipa)
537 {
538 struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
539 enum ipa_cmd_opcode opcode = IPA_CMD_DMA_SHARED_MEM;
540 struct ipa_cmd_hw_dma_mem_mem *payload;
541 union ipa_cmd_payload *cmd_payload;
542 dma_addr_t payload_addr;
543 u16 flags;
544
545 /* size and offset must fit in 16 bit fields */
546 WARN_ON(!size);
547 WARN_ON(size > U16_MAX);
548 WARN_ON(offset > U16_MAX || ipa->mem_offset > U16_MAX - offset);
549
550 offset += ipa->mem_offset;
551
552 cmd_payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
553 payload = &cmd_payload->dma_shared_mem;
554
555 /* payload->clear_after_read was reserved prior to IPA v4.0. It's
556 * never needed for current code, so it's 0 regardless of version.
557 */
558 payload->size = cpu_to_le16(size);
559 payload->local_addr = cpu_to_le16(offset);
560 /* payload->flags:
561 * direction: 0 = write to IPA, 1 read from IPA
562 * Starting at v4.0 these are reserved; either way, all zero:
563 * pipeline clear: 0 = wait for pipeline clear (don't skip)
564 * clear_options: 0 = pipeline_clear_hps
565 * Instead, for v4.0+ these are encoded in the opcode. But again
566 * since both values are 0 we won't bother OR'ing them in.
567 */
568 flags = toward_ipa ? 0 : DMA_SHARED_MEM_FLAGS_DIRECTION_FMASK;
569 payload->flags = cpu_to_le16(flags);
570 payload->system_addr = cpu_to_le64(addr);
571
572 gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
573 opcode);
574 }
575
ipa_cmd_ip_tag_status_add(struct gsi_trans * trans)576 static void ipa_cmd_ip_tag_status_add(struct gsi_trans *trans)
577 {
578 struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
579 enum ipa_cmd_opcode opcode = IPA_CMD_IP_PACKET_TAG_STATUS;
580 struct ipa_cmd_ip_packet_tag_status *payload;
581 union ipa_cmd_payload *cmd_payload;
582 dma_addr_t payload_addr;
583
584 cmd_payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
585 payload = &cmd_payload->ip_packet_tag_status;
586
587 payload->tag = le64_encode_bits(0, IP_PACKET_TAG_STATUS_TAG_FMASK);
588
589 gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
590 opcode);
591 }
592
593 /* Issue a small command TX data transfer */
ipa_cmd_transfer_add(struct gsi_trans * trans)594 static void ipa_cmd_transfer_add(struct gsi_trans *trans)
595 {
596 struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
597 enum ipa_cmd_opcode opcode = IPA_CMD_NONE;
598 union ipa_cmd_payload *payload;
599 dma_addr_t payload_addr;
600
601 /* Just transfer a zero-filled payload structure */
602 payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
603
604 gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
605 opcode);
606 }
607
608 /* Add immediate commands to a transaction to clear the hardware pipeline */
ipa_cmd_pipeline_clear_add(struct gsi_trans * trans)609 void ipa_cmd_pipeline_clear_add(struct gsi_trans *trans)
610 {
611 struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
612 struct ipa_endpoint *endpoint;
613
614 /* This will complete when the transfer is received */
615 reinit_completion(&ipa->completion);
616
617 /* Issue a no-op register write command (mask 0 means no write) */
618 ipa_cmd_register_write_add(trans, 0, 0, 0, true);
619
620 /* Send a data packet through the IPA pipeline. The packet_init
621 * command says to send the next packet directly to the exception
622 * endpoint without any other IPA processing. The tag_status
623 * command requests that status be generated on completion of
624 * that transfer, and that it will be tagged with a value.
625 * Finally, the transfer command sends a small packet of data
626 * (instead of a command) using the command endpoint.
627 */
628 endpoint = ipa->name_map[IPA_ENDPOINT_AP_LAN_RX];
629 ipa_cmd_ip_packet_init_add(trans, endpoint->endpoint_id);
630 ipa_cmd_ip_tag_status_add(trans);
631 ipa_cmd_transfer_add(trans);
632 }
633
634 /* Returns the number of commands required to clear the pipeline */
ipa_cmd_pipeline_clear_count(void)635 u32 ipa_cmd_pipeline_clear_count(void)
636 {
637 return 4;
638 }
639
ipa_cmd_pipeline_clear_wait(struct ipa * ipa)640 void ipa_cmd_pipeline_clear_wait(struct ipa *ipa)
641 {
642 wait_for_completion(&ipa->completion);
643 }
644
645 /* Allocate a transaction for the command TX endpoint */
ipa_cmd_trans_alloc(struct ipa * ipa,u32 tre_count)646 struct gsi_trans *ipa_cmd_trans_alloc(struct ipa *ipa, u32 tre_count)
647 {
648 struct ipa_endpoint *endpoint;
649
650 if (WARN_ON(tre_count > IPA_COMMAND_TRANS_TRE_MAX))
651 return NULL;
652
653 endpoint = ipa->name_map[IPA_ENDPOINT_AP_COMMAND_TX];
654
655 return gsi_channel_trans_alloc(&ipa->gsi, endpoint->channel_id,
656 tre_count, DMA_NONE);
657 }
658