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