1 | /* SPDX-License-Identifier: GPL-2.0 */ |
2 | |
3 | /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved. |
4 | * Copyright (C) 2019-2023 Linaro Ltd. |
5 | */ |
6 | #ifndef _IPA_MEM_H_ |
7 | #define _IPA_MEM_H_ |
8 | |
9 | struct platform_device; |
10 | |
11 | struct ipa; |
12 | struct ipa_mem_data; |
13 | |
14 | /** |
15 | * DOC: IPA Local Memory |
16 | * |
17 | * The IPA has a block of shared memory, divided into regions used for |
18 | * specific purposes. |
19 | * |
20 | * The regions within the shared block are bounded by an offset (relative to |
21 | * the "ipa-shared" memory range) and size found in the IPA_SHARED_MEM_SIZE |
22 | * register. |
23 | * |
24 | * Each region is optionally preceded by one or more 32-bit "canary" values. |
25 | * These are meant to detect out-of-range writes (if they become corrupted). |
26 | * A given region (such as a filter or routing table) has the same number |
27 | * of canaries for all IPA hardware versions. Still, the number used is |
28 | * defined in the config data, allowing for generic handling of regions. |
29 | * |
30 | * The set of memory regions is defined in configuration data. They are |
31 | * subject to these constraints: |
32 | * - a zero offset and zero size represents and undefined region |
33 | * - a region's size does not include space for its "canary" values |
34 | * - a region's offset is defined to be *past* all "canary" values |
35 | * - offset must be large enough to account for all canaries |
36 | * - a region's size may be zero, but may still have canaries |
37 | * - all offsets must be 8-byte aligned |
38 | * - most sizes must be a multiple of 8 |
39 | * - modem memory size must be a multiple of 4 |
40 | * - the microcontroller ring offset must be a multiple of 1024 |
41 | */ |
42 | |
43 | /* The maximum allowed size for any memory region */ |
44 | #define IPA_MEM_MAX (2 * PAGE_SIZE) |
45 | |
46 | /* IPA-resident memory region ids */ |
47 | enum ipa_mem_id { |
48 | IPA_MEM_UC_SHARED, /* 0 canaries */ |
49 | IPA_MEM_UC_INFO, /* 0 canaries */ |
50 | IPA_MEM_V4_FILTER_HASHED, /* 2 canaries */ |
51 | IPA_MEM_V4_FILTER, /* 2 canaries */ |
52 | IPA_MEM_V6_FILTER_HASHED, /* 2 canaries */ |
53 | IPA_MEM_V6_FILTER, /* 2 canaries */ |
54 | IPA_MEM_V4_ROUTE_HASHED, /* 2 canaries */ |
55 | IPA_MEM_V4_ROUTE, /* 2 canaries */ |
56 | IPA_MEM_V6_ROUTE_HASHED, /* 2 canaries */ |
57 | IPA_MEM_V6_ROUTE, /* 2 canaries */ |
58 | , /* 2 canaries */ |
59 | , /* 0 canaries, optional */ |
60 | IPA_MEM_MODEM_PROC_CTX, /* 2 canaries */ |
61 | IPA_MEM_AP_PROC_CTX, /* 0 canaries */ |
62 | IPA_MEM_MODEM, /* 0/2 canaries */ |
63 | IPA_MEM_UC_EVENT_RING, /* 1 canary, optional */ |
64 | IPA_MEM_PDN_CONFIG, /* 0/2 canaries (IPA v4.0+) */ |
65 | IPA_MEM_STATS_QUOTA_MODEM, /* 2/4 canaries (IPA v4.0+) */ |
66 | IPA_MEM_STATS_QUOTA_AP, /* 0 canaries, optional (IPA v4.0+) */ |
67 | IPA_MEM_STATS_TETHERING, /* 0 canaries, optional (IPA v4.0+) */ |
68 | IPA_MEM_STATS_DROP, /* 0 canaries, optional (IPA v4.0+) */ |
69 | /* The next 7 filter and route statistics regions are optional */ |
70 | IPA_MEM_STATS_V4_FILTER, /* 0 canaries (IPA v4.0-v4.2) */ |
71 | IPA_MEM_STATS_V6_FILTER, /* 0 canaries (IPA v4.0-v4.2) */ |
72 | IPA_MEM_STATS_V4_ROUTE, /* 0 canaries (IPA v4.0-v4.2) */ |
73 | IPA_MEM_STATS_V6_ROUTE, /* 0 canaries (IPA v4.0-v4.2) */ |
74 | IPA_MEM_AP_V4_FILTER, /* 2 canaries (IPA v5.0) */ |
75 | IPA_MEM_AP_V6_FILTER, /* 0 canaries (IPA v5.0) */ |
76 | IPA_MEM_STATS_FILTER_ROUTE, /* 0 canaries (IPA v4.5+) */ |
77 | IPA_MEM_NAT_TABLE, /* 4 canaries, optional (IPA v4.5+) */ |
78 | IPA_MEM_END_MARKER, /* 1 canary (not a real region) */ |
79 | IPA_MEM_COUNT, /* Number of regions (not an index) */ |
80 | }; |
81 | |
82 | /** |
83 | * struct ipa_mem - IPA local memory region description |
84 | * @id: memory region identifier |
85 | * @offset: offset in IPA memory space to base of the region |
86 | * @size: size in bytes base of the region |
87 | * @canary_count: Number of 32-bit "canary" values that precede region |
88 | */ |
89 | struct ipa_mem { |
90 | enum ipa_mem_id id; |
91 | u32 offset; |
92 | u16 size; |
93 | u16 canary_count; |
94 | }; |
95 | |
96 | const struct ipa_mem *ipa_mem_find(struct ipa *ipa, enum ipa_mem_id mem_id); |
97 | |
98 | int ipa_mem_config(struct ipa *ipa); |
99 | void ipa_mem_deconfig(struct ipa *ipa); |
100 | |
101 | int ipa_mem_setup(struct ipa *ipa); /* No ipa_mem_teardown() needed */ |
102 | |
103 | int ipa_mem_zero_modem(struct ipa *ipa); |
104 | |
105 | int ipa_mem_init(struct ipa *ipa, struct platform_device *pdev, |
106 | const struct ipa_mem_data *mem_data); |
107 | void ipa_mem_exit(struct ipa *ipa); |
108 | |
109 | #endif /* _IPA_MEM_H_ */ |
110 | |