1 // SPDX-License-Identifier: GPL-2.0
3 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4 * Copyright (C) 2018-2024 Linaro Ltd.
7 #include <linux/bitops.h>
8 #include <linux/build_bug.h>
9 #include <linux/device.h>
10 #include <linux/dma-mapping.h>
12 #include <linux/types.h>
15 #include "gsi_trans.h"
18 #include "ipa_endpoint.h"
21 #include "ipa_table.h"
22 #include "ipa_version.h"
25 * DOC: IPA Filter and Route Tables
27 * The IPA has tables defined in its local (IPA-resident) memory that define
28 * filter and routing rules. An entry in either of these tables is a little
29 * endian 64-bit "slot" that holds the address of a rule definition. (The
30 * size of these slots is 64 bits regardless of the host DMA address size.)
32 * Separate tables (both filter and route) are used for IPv4 and IPv6. There
33 * is normally another set of "hashed" filter and route tables, which are
34 * used with a hash of message metadata. Hashed operation is not supported
35 * by all IPA hardware (IPA v4.2 doesn't support hashed tables).
37 * Rules can be in local memory or in DRAM (system memory). The offset of
38 * an object (such as a route or filter table) in IPA-resident memory must
39 * 128-byte aligned. An object in system memory (such as a route or filter
40 * rule) must be at an 8-byte aligned address. We currently only place
41 * route or filter rules in system memory.
43 * A rule consists of a contiguous block of 32-bit values terminated with
44 * 32 zero bits. A special "zero entry" rule consisting of 64 zero bits
45 * represents "no filtering" or "no routing," and is the reset value for
46 * filter or route table rules.
48 * Each filter rule is associated with an AP or modem TX endpoint, though
49 * not all TX endpoints support filtering. The first 64-bit slot in a
50 * filter table is a bitmap indicating which endpoints have entries in
51 * the table. Each set bit in this bitmap indicates the presence of the
52 * address of a filter rule in the memory following the bitmap. Until IPA
53 * v5.0, the low-order bit (bit 0) in this bitmap represents a special
54 * global filter, which applies to all traffic. Otherwise the position of
55 * each set bit represents an endpoint for which a filter rule is defined.
57 * The global rule is not used in current code, and support for it is
58 * removed starting at IPA v5.0. For IPA v5.0+, the endpoint bitmap
59 * position defines the endpoint ID--i.e. if bit 1 is set in the endpoint
60 * bitmap, endpoint 1 has a filter rule. Older versions of IPA represent
61 * the presence of a filter rule for endpoint X by bit (X + 1) being set.
62 * I.e., bit 1 set indicates the presence of a filter rule for endpoint 0,
63 * and bit 3 set means there is a filter rule present for endpoint 2.
65 * Each filter table entry has the address of a set of equations that
66 * implement a filter rule. So following the endpoint bitmap there
67 * will be such an address/entry for each endpoint with a set bit in
70 * The AP initializes all entries in a filter table to refer to a "zero"
71 * rule. Once initialized, the modem and AP update the entries for
72 * endpoints they "own" directly. Currently the AP does not use the IPA
73 * filtering functionality.
75 * This diagram shows an example of a filter table with an endpoint
76 * bitmap as defined prior to IPA v5.0.
79 * ----------------------
80 * endpoint bitmap | 0x0000000000000048 | Bits 3 and 6 set (endpoints 2 and 5)
81 * |--------------------|
82 * 1st endpoint | 0x000123456789abc0 | DMA address for modem endpoint 2 rule
83 * |--------------------|
84 * 2nd endpoint | 0x000123456789abf0 | DMA address for AP endpoint 5 rule
85 * |--------------------|
86 * (unused) | | (Unused space in filter table)
87 * |--------------------|
89 * |--------------------|
90 * (unused) | | (Unused space in filter table)
91 * ----------------------
93 * The set of available route rules is divided about equally between the AP
94 * and modem. The AP initializes all entries in a route table to refer to
95 * a "zero entry". Once initialized, the modem and AP are responsible for
96 * updating their own entries. All entries in a route table are usable,
97 * though the AP currently does not use the IPA routing functionality.
100 * ----------------------
101 * 1st modem route | 0x0001234500001100 | DMA address for first route rule
102 * |--------------------|
103 * 2nd modem route | 0x0001234500001140 | DMA address for second route rule
104 * |--------------------|
106 * |--------------------|
107 * Last modem route| 0x0001234500002280 | DMA address for Nth route rule
108 * |--------------------|
109 * 1st AP route | 0x0001234500001100 | DMA address for route rule (N+1)
110 * |--------------------|
111 * 2nd AP route | 0x0001234500001140 | DMA address for next route rule
112 * |--------------------|
114 * |--------------------|
115 * Last AP route | 0x0001234500002280 | DMA address for last route rule
116 * ----------------------
119 /* Filter or route rules consist of a set of 32-bit values followed by a
120 * 32-bit all-zero rule list terminator. The "zero rule" is simply an
121 * all-zero rule followed by the list terminator.
123 #define IPA_ZERO_RULE_SIZE (2 * sizeof(__le32))
125 /* Check things that can be validated at build time. */
126 static void ipa_table_validate_build(void)
128 /* Filter and route tables contain DMA addresses that refer
129 * to filter or route rules. But the size of a table entry
130 * is 64 bits regardless of what the size of an AP DMA address
131 * is. A fixed constant defines the size of an entry, and
132 * code in ipa_table_init() uses a pointer to __le64 to
135 BUILD_BUG_ON(sizeof(dma_addr_t) > sizeof(__le64));
137 /* A "zero rule" is used to represent no filtering or no routing.
138 * It is a 64-bit block of zeroed memory. Code in ipa_table_init()
139 * assumes that it can be written using a pointer to __le64.
141 BUILD_BUG_ON(IPA_ZERO_RULE_SIZE != sizeof(__le64));
144 static const struct ipa_mem *
145 ipa_table_mem(struct ipa *ipa, bool filter, bool hashed, bool ipv6)
147 enum ipa_mem_id mem_id;
149 mem_id = filter ? hashed ? ipv6 ? IPA_MEM_V6_FILTER_HASHED
150 : IPA_MEM_V4_FILTER_HASHED
151 : ipv6 ? IPA_MEM_V6_FILTER
153 : hashed ? ipv6 ? IPA_MEM_V6_ROUTE_HASHED
154 : IPA_MEM_V4_ROUTE_HASHED
155 : ipv6 ? IPA_MEM_V6_ROUTE
158 return ipa_mem_find(ipa, mem_id);
161 /* Return true if hashed tables are supported */
162 bool ipa_table_hash_support(struct ipa *ipa)
164 return ipa->version != IPA_VERSION_4_2;
167 bool ipa_filtered_valid(struct ipa *ipa, u64 filtered)
169 struct device *dev = ipa->dev;
173 dev_err(dev, "at least one filtering endpoint is required\n");
178 count = hweight64(filtered);
179 if (count > ipa->filter_count) {
180 dev_err(dev, "too many filtering endpoints (%u > %u)\n",
181 count, ipa->filter_count);
189 /* Zero entry count means no table, so just return a 0 address */
190 static dma_addr_t ipa_table_addr(struct ipa *ipa, bool filter_mask, u16 count)
197 WARN_ON(count > max_t(u32, ipa->filter_count, ipa->route_count));
199 /* Skip over the zero rule and possibly the filter mask */
200 skip = filter_mask ? 1 : 2;
202 return ipa->table_addr + skip * sizeof(*ipa->table_virt);
205 static void ipa_table_reset_add(struct gsi_trans *trans, bool filter,
206 bool hashed, bool ipv6, u16 first, u16 count)
208 struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
209 const struct ipa_mem *mem;
214 /* Nothing to do if the memory region is doesn't exist or is empty */
215 mem = ipa_table_mem(ipa, filter, hashed, ipv6);
216 if (!mem || !mem->size)
220 first++; /* skip over bitmap */
222 offset = mem->offset + first * sizeof(__le64);
223 size = count * sizeof(__le64);
224 addr = ipa_table_addr(ipa, false, count);
226 ipa_cmd_dma_shared_mem_add(trans, offset, size, addr, true);
229 /* Reset entries in a single filter table belonging to either the AP or
230 * modem to refer to the zero entry. The memory region supplied will be
231 * for the IPv4 and IPv6 non-hashed and hashed filter tables.
234 ipa_filter_reset_table(struct ipa *ipa, bool hashed, bool ipv6, bool modem)
236 u64 ep_mask = ipa->filtered;
237 struct gsi_trans *trans;
238 enum gsi_ee_id ee_id;
240 trans = ipa_cmd_trans_alloc(ipa, hweight64(ep_mask));
242 dev_err(ipa->dev, "no transaction for %s filter reset\n",
243 modem ? "modem" : "AP");
247 ee_id = modem ? GSI_EE_MODEM : GSI_EE_AP;
249 u32 endpoint_id = __ffs(ep_mask);
250 struct ipa_endpoint *endpoint;
252 ep_mask ^= BIT(endpoint_id);
254 endpoint = &ipa->endpoint[endpoint_id];
255 if (endpoint->ee_id != ee_id)
258 ipa_table_reset_add(trans, true, hashed, ipv6, endpoint_id, 1);
261 gsi_trans_commit_wait(trans);
266 /* Theoretically, each filter table could have more filter slots to
267 * update than the maximum number of commands in a transaction. So
268 * we do each table separately.
270 static int ipa_filter_reset(struct ipa *ipa, bool modem)
274 ret = ipa_filter_reset_table(ipa, false, false, modem);
278 ret = ipa_filter_reset_table(ipa, false, true, modem);
279 if (ret || !ipa_table_hash_support(ipa))
282 ret = ipa_filter_reset_table(ipa, true, false, modem);
286 return ipa_filter_reset_table(ipa, true, true, modem);
289 /* The AP routes and modem routes are each contiguous within the
290 * table. We can update each table with a single command, and we
291 * won't exceed the per-transaction command limit.
293 static int ipa_route_reset(struct ipa *ipa, bool modem)
295 bool hash_support = ipa_table_hash_support(ipa);
296 u32 modem_route_count = ipa->modem_route_count;
297 struct gsi_trans *trans;
301 trans = ipa_cmd_trans_alloc(ipa, hash_support ? 4 : 2);
303 dev_err(ipa->dev, "no transaction for %s route reset\n",
304 modem ? "modem" : "AP");
310 count = modem_route_count;
312 first = modem_route_count;
313 count = ipa->route_count - modem_route_count;
316 ipa_table_reset_add(trans, false, false, false, first, count);
317 ipa_table_reset_add(trans, false, false, true, first, count);
320 ipa_table_reset_add(trans, false, true, false, first, count);
321 ipa_table_reset_add(trans, false, true, true, first, count);
324 gsi_trans_commit_wait(trans);
329 void ipa_table_reset(struct ipa *ipa, bool modem)
331 struct device *dev = ipa->dev;
335 ee_name = modem ? "modem" : "AP";
337 /* Report errors, but reset filter and route tables */
338 ret = ipa_filter_reset(ipa, modem);
340 dev_err(dev, "error %d resetting filter table for %s\n",
343 ret = ipa_route_reset(ipa, modem);
345 dev_err(dev, "error %d resetting route table for %s\n",
349 int ipa_table_hash_flush(struct ipa *ipa)
351 struct gsi_trans *trans;
352 const struct reg *reg;
355 if (!ipa_table_hash_support(ipa))
358 trans = ipa_cmd_trans_alloc(ipa, 1);
360 dev_err(ipa->dev, "no transaction for hash flush\n");
364 if (ipa->version < IPA_VERSION_5_0) {
365 reg = ipa_reg(ipa, FILT_ROUT_HASH_FLUSH);
367 val = reg_bit(reg, IPV6_ROUTER_HASH);
368 val |= reg_bit(reg, IPV6_FILTER_HASH);
369 val |= reg_bit(reg, IPV4_ROUTER_HASH);
370 val |= reg_bit(reg, IPV4_FILTER_HASH);
372 reg = ipa_reg(ipa, FILT_ROUT_CACHE_FLUSH);
374 /* IPA v5.0+ uses a unified cache (both IPv4 and IPv6) */
375 val = reg_bit(reg, ROUTER_CACHE);
376 val |= reg_bit(reg, FILTER_CACHE);
379 ipa_cmd_register_write_add(trans, reg_offset(reg), val, val, false);
381 gsi_trans_commit_wait(trans);
386 static void ipa_table_init_add(struct gsi_trans *trans, bool filter, bool ipv6)
388 struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
389 const struct ipa_mem *hash_mem;
390 enum ipa_cmd_opcode opcode;
391 const struct ipa_mem *mem;
392 dma_addr_t hash_addr;
402 opcode = filter ? ipv6 ? IPA_CMD_IP_V6_FILTER_INIT
403 : IPA_CMD_IP_V4_FILTER_INIT
404 : ipv6 ? IPA_CMD_IP_V6_ROUTING_INIT
405 : IPA_CMD_IP_V4_ROUTING_INIT;
407 /* The non-hashed region will exist (see ipa_table_mem_valid()) */
408 mem = ipa_table_mem(ipa, filter, false, ipv6);
409 hash_mem = ipa_table_mem(ipa, filter, true, ipv6);
410 hash_offset = hash_mem ? hash_mem->offset : 0;
412 /* Compute the number of table entries to initialize */
414 /* The number of filtering endpoints determines number of
415 * entries in the filter table; we also add one more "slot"
416 * to hold the bitmap itself. The size of the hashed filter
417 * table is either the same as the non-hashed one, or zero.
419 count = 1 + hweight64(ipa->filtered);
420 hash_count = hash_mem && hash_mem->size ? count : 0;
422 /* The size of a route table region determines the number
425 count = mem->size / sizeof(__le64);
426 hash_count = hash_mem ? hash_mem->size / sizeof(__le64) : 0;
428 size = count * sizeof(__le64);
429 hash_size = hash_count * sizeof(__le64);
431 addr = ipa_table_addr(ipa, filter, count);
432 hash_addr = ipa_table_addr(ipa, filter, hash_count);
434 ipa_cmd_table_init_add(trans, opcode, size, mem->offset, addr,
435 hash_size, hash_offset, hash_addr);
439 /* Zero the unused space in the filter table */
440 zero_offset = mem->offset + size;
441 zero_size = mem->size - size;
442 ipa_cmd_dma_shared_mem_add(trans, zero_offset, zero_size,
443 ipa->zero_addr, true);
447 /* Zero the unused space in the hashed filter table */
448 zero_offset = hash_offset + hash_size;
449 zero_size = hash_mem->size - hash_size;
450 ipa_cmd_dma_shared_mem_add(trans, zero_offset, zero_size,
451 ipa->zero_addr, true);
454 int ipa_table_setup(struct ipa *ipa)
456 struct gsi_trans *trans;
458 /* We will need at most 8 TREs:
460 * - One for route table initialization (non-hashed and hashed)
461 * - One for filter table initialization (non-hashed and hashed)
462 * - One to zero unused entries in the non-hashed filter table
463 * - One to zero unused entries in the hashed filter table
465 * - One for route table initialization (non-hashed and hashed)
466 * - One for filter table initialization (non-hashed and hashed)
467 * - One to zero unused entries in the non-hashed filter table
468 * - One to zero unused entries in the hashed filter table
469 * All platforms support at least 8 TREs in a transaction.
471 trans = ipa_cmd_trans_alloc(ipa, 8);
473 dev_err(ipa->dev, "no transaction for table setup\n");
477 ipa_table_init_add(trans, false, false);
478 ipa_table_init_add(trans, false, true);
479 ipa_table_init_add(trans, true, false);
480 ipa_table_init_add(trans, true, true);
482 gsi_trans_commit_wait(trans);
488 * ipa_filter_tuple_zero() - Zero an endpoint's hashed filter tuple
489 * @endpoint: Endpoint whose filter hash tuple should be zeroed
491 * Endpoint must be for the AP (not modem) and support filtering. Updates
492 * the filter hash values without changing route ones.
494 static void ipa_filter_tuple_zero(struct ipa_endpoint *endpoint)
496 u32 endpoint_id = endpoint->endpoint_id;
497 struct ipa *ipa = endpoint->ipa;
498 const struct reg *reg;
502 if (ipa->version < IPA_VERSION_5_0) {
503 reg = ipa_reg(ipa, ENDP_FILTER_ROUTER_HSH_CFG);
505 offset = reg_n_offset(reg, endpoint_id);
506 val = ioread32(endpoint->ipa->reg_virt + offset);
508 /* Zero all filter-related fields, preserving the rest */
509 val &= ~reg_fmask(reg, FILTER_HASH_MSK_ALL);
511 /* IPA v5.0 separates filter and router cache configuration */
512 reg = ipa_reg(ipa, ENDP_FILTER_CACHE_CFG);
513 offset = reg_n_offset(reg, endpoint_id);
515 /* Zero all filter-related fields */
519 iowrite32(val, endpoint->ipa->reg_virt + offset);
522 /* Configure a hashed filter table; there is no ipa_filter_deconfig() */
523 static void ipa_filter_config(struct ipa *ipa, bool modem)
525 enum gsi_ee_id ee_id = modem ? GSI_EE_MODEM : GSI_EE_AP;
526 u64 ep_mask = ipa->filtered;
528 if (!ipa_table_hash_support(ipa))
532 u32 endpoint_id = __ffs(ep_mask);
533 struct ipa_endpoint *endpoint;
535 ep_mask ^= BIT(endpoint_id);
537 endpoint = &ipa->endpoint[endpoint_id];
538 if (endpoint->ee_id == ee_id)
539 ipa_filter_tuple_zero(endpoint);
543 static bool ipa_route_id_modem(struct ipa *ipa, u32 route_id)
545 return route_id < ipa->modem_route_count;
549 * ipa_route_tuple_zero() - Zero a hashed route table entry tuple
551 * @route_id: Route table entry whose hash tuple should be zeroed
553 * Updates the route hash values without changing filter ones.
555 static void ipa_route_tuple_zero(struct ipa *ipa, u32 route_id)
557 const struct reg *reg;
561 if (ipa->version < IPA_VERSION_5_0) {
562 reg = ipa_reg(ipa, ENDP_FILTER_ROUTER_HSH_CFG);
563 offset = reg_n_offset(reg, route_id);
565 val = ioread32(ipa->reg_virt + offset);
567 /* Zero all route-related fields, preserving the rest */
568 val &= ~reg_fmask(reg, ROUTER_HASH_MSK_ALL);
570 /* IPA v5.0 separates filter and router cache configuration */
571 reg = ipa_reg(ipa, ENDP_ROUTER_CACHE_CFG);
572 offset = reg_n_offset(reg, route_id);
574 /* Zero all route-related fields */
578 iowrite32(val, ipa->reg_virt + offset);
581 /* Configure a hashed route table; there is no ipa_route_deconfig() */
582 static void ipa_route_config(struct ipa *ipa, bool modem)
586 if (!ipa_table_hash_support(ipa))
589 for (route_id = 0; route_id < ipa->route_count; route_id++)
590 if (ipa_route_id_modem(ipa, route_id) == modem)
591 ipa_route_tuple_zero(ipa, route_id);
594 /* Configure a filter and route tables; there is no ipa_table_deconfig() */
595 void ipa_table_config(struct ipa *ipa)
597 ipa_filter_config(ipa, false);
598 ipa_filter_config(ipa, true);
599 ipa_route_config(ipa, false);
600 ipa_route_config(ipa, true);
603 /* Verify the sizes of all IPA table filter or routing table memory regions
604 * are valid. If valid, this records the size of the routing table.
606 bool ipa_table_mem_valid(struct ipa *ipa, bool filter)
608 bool hash_support = ipa_table_hash_support(ipa);
609 const struct ipa_mem *mem_hashed;
610 const struct ipa_mem *mem_ipv4;
611 const struct ipa_mem *mem_ipv6;
614 /* IPv4 and IPv6 non-hashed tables are expected to be defined and
615 * have the same size. Both must have at least two entries (and
616 * would normally have more than that).
618 mem_ipv4 = ipa_table_mem(ipa, filter, false, false);
622 mem_ipv6 = ipa_table_mem(ipa, filter, false, true);
626 if (mem_ipv4->size != mem_ipv6->size)
629 /* Compute and record the number of entries for each table type */
630 count = mem_ipv4->size / sizeof(__le64);
634 ipa->filter_count = count - 1; /* Filter map in first entry */
636 ipa->route_count = count;
638 /* Table offset and size must fit in TABLE_INIT command fields */
639 if (!ipa_cmd_table_init_valid(ipa, mem_ipv4, !filter))
642 /* Make sure the regions are big enough */
644 /* Filter tables must able to hold the endpoint bitmap plus
645 * an entry for each endpoint that supports filtering
647 if (count < 1 + hweight64(ipa->filtered))
650 /* Routing tables must be able to hold all modem entries,
651 * plus at least one entry for the AP.
653 if (count < ipa->modem_route_count + 1)
657 /* If hashing is supported, hashed tables are expected to be defined,
658 * and have the same size as non-hashed tables. If hashing is not
659 * supported, hashed tables are expected to have zero size (or not
662 mem_hashed = ipa_table_mem(ipa, filter, true, false);
664 if (!mem_hashed || mem_hashed->size != mem_ipv4->size)
667 if (mem_hashed && mem_hashed->size)
671 /* Same check for IPv6 tables */
672 mem_hashed = ipa_table_mem(ipa, filter, true, true);
674 if (!mem_hashed || mem_hashed->size != mem_ipv6->size)
677 if (mem_hashed && mem_hashed->size)
684 /* Initialize a coherent DMA allocation containing initialized filter and
685 * route table data. This is used when initializing or resetting the IPA
686 * filter or route table.
688 * The first entry in a filter table contains a bitmap indicating which
689 * endpoints contain entries in the table. In addition to that first entry,
690 * there is a fixed maximum number of entries that follow. Filter table
691 * entries are 64 bits wide, and (other than the bitmap) contain the DMA
692 * address of a filter rule. A "zero rule" indicates no filtering, and
693 * consists of 64 bits of zeroes. When a filter table is initialized (or
694 * reset) its entries are made to refer to the zero rule.
696 * Each entry in a route table is the DMA address of a routing rule. For
697 * routing there is also a 64-bit "zero rule" that means no routing, and
698 * when a route table is initialized or reset, its entries are made to refer
699 * to the zero rule. The zero rule is shared for route and filter tables.
701 * +-------------------+
703 * / |-------------------|
705 * |\ |-------------------|
706 * | ---- zero rule address | \
707 * |\ |-------------------| |
708 * | ---- zero rule address | | Max IPA filter count
709 * | |-------------------| > or IPA route count,
710 * | ... | whichever is greater
711 * \ |-------------------| |
712 * ---- zero rule address | /
713 * +-------------------+
715 int ipa_table_init(struct ipa *ipa)
717 struct device *dev = ipa->dev;
724 ipa_table_validate_build();
726 count = max_t(u32, ipa->filter_count, ipa->route_count);
728 /* The IPA hardware requires route and filter table rules to be
729 * aligned on a 128-byte boundary. We put the "zero rule" at the
730 * base of the table area allocated here. The DMA address returned
731 * by dma_alloc_coherent() is guaranteed to be a power-of-2 number
732 * of pages, which satisfies the rule alignment requirement.
734 size = IPA_ZERO_RULE_SIZE + (1 + count) * sizeof(__le64);
735 virt = dma_alloc_coherent(dev, size, &addr, GFP_KERNEL);
739 ipa->table_virt = virt;
740 ipa->table_addr = addr;
742 /* First slot is the zero rule */
745 /* Next is the filter table bitmap. The "soft" bitmap value might
746 * need to be converted to the hardware representation by shifting
747 * it left one position. Prior to IPA v5.0, bit 0 repesents global
748 * filtering, which is possible but not used. IPA v5.0+ eliminated
749 * that option, so there's no shifting required.
751 if (ipa->version < IPA_VERSION_5_0)
752 *virt++ = cpu_to_le64(ipa->filtered << 1);
754 *virt++ = cpu_to_le64(ipa->filtered);
756 /* All the rest contain the DMA address of the zero rule */
757 le_addr = cpu_to_le64(addr);
764 void ipa_table_exit(struct ipa *ipa)
766 u32 count = max_t(u32, 1 + ipa->filter_count, ipa->route_count);
767 struct device *dev = ipa->dev;
770 size = IPA_ZERO_RULE_SIZE + (1 + count) * sizeof(__le64);
772 dma_free_coherent(dev, size, ipa->table_virt, ipa->table_addr);
774 ipa->table_virt = NULL;