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-2020 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 offset is defined to be *past* all "canary" values
32  * - offset must be large enough to account for all canaries
33  * - a region's size may be zero, but may still have canaries
34  * - all offsets must be 8-byte aligned
35  * - most sizes must be a multiple of 8
36  * - modem memory size must be a multiple of 4
37  * - the microcontroller ring offset must be a multiple of 1024
43 /* IPA-resident memory region ids */
59 	IPA_MEM_PDN_CONFIG,		/* 2 canaries (IPA v4.0 and above) */
60 	IPA_MEM_STATS_QUOTA,		/* 2 canaries (IPA v4.0 and above) */
61 	IPA_MEM_STATS_TETHERING,	/* 0 canaries (IPA v4.0 and above) */
62 	IPA_MEM_STATS_DROP,		/* 0 canaries (IPA v4.0 and above) */
69  * struct ipa_mem - IPA local memory region description
70  * @offset:		offset in IPA memory space to base of the region
72  * @canary_count	# 32-bit "canary" values that precede region
80 int ipa_mem_config(struct ipa *ipa);
81 void ipa_mem_deconfig(struct ipa *ipa);
83 int ipa_mem_setup(struct ipa *ipa);
84 void ipa_mem_teardown(struct ipa *ipa);
86 int ipa_mem_zero_modem(struct ipa *ipa);
88 int ipa_mem_init(struct ipa *ipa, const struct ipa_mem_data *mem_data);
89 void ipa_mem_exit(struct ipa *ipa);