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
  9struct ipa;
 10struct ipa_mem_data;
 11
 12/**
 13 * DOC: IPA Local Memory
 14 *
 15 * The IPA has a block of shared memory, divided into regions used for
 16 * specific purposes.
 17 *
 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
 20 * register.
 21 *
 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
 25 * of canaries for all IPA hardware versions.  Still, the number used is
 26 * defined in the config data, allowing for generic handling of regions.
 27 *
 28 * The set of memory regions is defined in configuration data.  They are
 29 * subject to these constraints:
 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
 39 */
 40
 41/* The maximum allowed size for any memory region */
 42#define IPA_MEM_MAX	(2 * PAGE_SIZE)
 43
 44/* IPA-resident memory region ids */
 45enum ipa_mem_id {
 46	IPA_MEM_UC_SHARED,		/* 0 canaries */
 47	IPA_MEM_UC_INFO,		/* 0 canaries */
 48	IPA_MEM_V4_FILTER_HASHED,	/* 2 canaries */
 49	IPA_MEM_V4_FILTER,		/* 2 canaries */
 50	IPA_MEM_V6_FILTER_HASHED,	/* 2 canaries */
 51	IPA_MEM_V6_FILTER,		/* 2 canaries */
 52	IPA_MEM_V4_ROUTE_HASHED,	/* 2 canaries */
 53	IPA_MEM_V4_ROUTE,		/* 2 canaries */
 54	IPA_MEM_V6_ROUTE_HASHED,	/* 2 canaries */
 55	IPA_MEM_V6_ROUTE,		/* 2 canaries */
 56	IPA_MEM_MODEM_HEADER,		/* 2 canaries */
 57	IPA_MEM_AP_HEADER,		/* 0 canaries, optional */
 58	IPA_MEM_MODEM_PROC_CTX,		/* 2 canaries */
 59	IPA_MEM_AP_PROC_CTX,		/* 0 canaries */
 60	IPA_MEM_MODEM,			/* 0/2 canaries */
 61	IPA_MEM_UC_EVENT_RING,		/* 1 canary, optional */
 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+) */
 67	/* The next 7 filter and route statistics regions are optional */
 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+) */
 76	IPA_MEM_END_MARKER,		/* 1 canary (not a real region) */
 77	IPA_MEM_COUNT,			/* Number of regions (not an index) */
 78};
 79
 80/**
 81 * struct ipa_mem - IPA local memory region description
 82 * @id:			memory region identifier
 83 * @offset:		offset in IPA memory space to base of the region
 84 * @size:		size in bytes base of the region
 85 * @canary_count:	Number of 32-bit "canary" values that precede region
 86 */
 87struct ipa_mem {
 88	enum ipa_mem_id id;
 89	u32 offset;
 90	u16 size;
 91	u16 canary_count;
 92};
 93
 94const struct ipa_mem *ipa_mem_find(struct ipa *ipa, enum ipa_mem_id mem_id);
 95
 96int ipa_mem_config(struct ipa *ipa);
 97void ipa_mem_deconfig(struct ipa *ipa);
 98
 99int ipa_mem_setup(struct ipa *ipa);	/* No ipa_mem_teardown() needed */
100
101int ipa_mem_zero_modem(struct ipa *ipa);
102
103int ipa_mem_init(struct ipa *ipa, const struct ipa_mem_data *mem_data);
104void ipa_mem_exit(struct ipa *ipa);
105
106#endif /* _IPA_MEM_H_ */