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