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.
13  * DOC: IPA Local Memory
15  * The IPA has a block of shared memory, divided into regions used for
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).
24  * A given region (such as a filter or routing table) has the same number
28  * The set of memory regions is defined in configuration data.  They are
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
40 /* The maximum allowed size for any memory region */
43 /* IPA-resident memory region ids */
69  * struct ipa_mem - IPA local memory region description
70  * @offset:		offset in IPA memory space to base of the region
71  * @size:		size in bytes base of the region
72  * @canary_count	# 32-bit "canary" values that precede region