net/ipa/ipa_mem.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4  * Copyright (C) 2019-2023 Linaro Ltd.
9 struct ipa;
13  * DOC: IPA Local Memory
15  * The IPA has a block of shared memory, divided into regions used for
18  * The regions within the shared block are bounded by an offset (relative to
19  * the "ipa-shared" memory range) and size found in the IPA_SHARED_MEM_SIZE
22  * Each region is optionally preceded by one or more 32-bit "canary" values.
23  * These are meant to detect out-of-range writes (if they become corrupted).
25  * of canaries for all IPA hardware versions.  Still, the number used is
30  * - a zero offset and zero size represents and undefined region
31  * - a region's size does not include space for its "canary" values
32  * - a region's offset is defined to be *past* all "canary" values
33  * - offset must be large enough to account for all canaries
34  * - a region's size may be zero, but may still have canaries
35  * - all offsets must be 8-byte aligned
36  * - most sizes must be a multiple of 8
37  * - modem memory size must be a multiple of 4
38  * - the microcontroller ring offset must be a multiple of 1024
44 /* IPA-resident memory region ids */
62 	IPA_MEM_PDN_CONFIG,		/* 0/2 canaries (IPA v4.0+) */
63 	IPA_MEM_STATS_QUOTA_MODEM,	/* 2/4 canaries (IPA v4.0+) */
64 	IPA_MEM_STATS_QUOTA_AP,		/* 0 canaries, optional (IPA v4.0+) */
65 	IPA_MEM_STATS_TETHERING,	/* 0 canaries, optional (IPA v4.0+) */
66 	IPA_MEM_STATS_DROP,		/* 0 canaries, optional (IPA v4.0+) */
68 	IPA_MEM_STATS_V4_FILTER,	/* 0 canaries (IPA v4.0-v4.2) */
69 	IPA_MEM_STATS_V6_FILTER,	/* 0 canaries (IPA v4.0-v4.2) */
70 	IPA_MEM_STATS_V4_ROUTE,		/* 0 canaries (IPA v4.0-v4.2) */
71 	IPA_MEM_STATS_V6_ROUTE,		/* 0 canaries (IPA v4.0-v4.2) */
72 	IPA_MEM_AP_V4_FILTER,		/* 2 canaries (IPA v5.0) */
73 	IPA_MEM_AP_V6_FILTER,		/* 0 canaries (IPA v5.0) */
74 	IPA_MEM_STATS_FILTER_ROUTE,	/* 0 canaries (IPA v4.5+) */
75 	IPA_MEM_NAT_TABLE,		/* 4 canaries, optional (IPA v4.5+) */
81  * struct ipa_mem - IPA local memory region description
83  * @offset:		offset in IPA memory space to base of the region
85  * @canary_count:	Number of 32-bit "canary" values that precede region
94 const struct ipa_mem *ipa_mem_find(struct ipa *ipa, enum ipa_mem_id mem_id);
96 int ipa_mem_config(struct ipa *ipa);
97 void ipa_mem_deconfig(struct ipa *ipa);
99 int ipa_mem_setup(struct ipa *ipa);	/* No ipa_mem_teardown() needed */
101 int ipa_mem_zero_modem(struct ipa *ipa);
103 int ipa_mem_init(struct ipa *ipa, const struct ipa_mem_data *mem_data);
104 void ipa_mem_exit(struct ipa *ipa);