1 // SPDX-License-Identifier: GPL-2.0
3 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4  * Copyright (C) 2019-2024 Linaro Ltd.
7 #include <linux/dma-mapping.h>
23 /* "Canary" value placed between memory regions to detect overflow */
33 	for (i = 0; i < ipa->mem_count; i++) {  in ipa_mem_find()
34 		const struct ipa_mem *mem = &ipa->mem[i];  in ipa_mem_find()
36 		if (mem->id == mem_id)  in ipa_mem_find()
43 /* Add an immediate command to a transaction that zeroes a memory region */
47 	struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);  in ipa_mem_zero_region_add()
49 	dma_addr_t addr = ipa->zero_addr;  in ipa_mem_zero_region_add()
51 	if (!mem->size)  in ipa_mem_zero_region_add()
54 	ipa_cmd_dma_shared_mem_add(trans, mem->offset, mem->size, addr, true);  in ipa_mem_zero_region_add()
58  * ipa_mem_setup() - Set up IPA AP and modem shared memory areas
61  * Set up the shared memory regions in IPA local memory.  This involves
62  * zero-filling memory regions, and in the case of header memory, telling
65  * This function performs the initial setup of this memory.  If the modem
66  * crashes, its regions are re-zeroed in ipa_mem_zero_modem().
68  * The AP informs the modem where its portions of memory are located
77 	dma_addr_t addr = ipa->zero_addr;  in ipa_mem_setup()
85 	/* Get a transaction to define the header memory region and to zero  in ipa_mem_setup()
86 	 * the processing context and modem memory regions.  in ipa_mem_setup()
90 		dev_err(ipa->dev, "no transaction for memory setup\n");  in ipa_mem_setup()
91 		return -EBUSY;  in ipa_mem_setup()
94 	/* Initialize IPA-local header memory.  The AP header region, if  in ipa_mem_setup()
95 	 * present, is contiguous with and follows the modem header region,  in ipa_mem_setup()
99 	offset = mem->offset;  in ipa_mem_setup()
100 	size = mem->size;  in ipa_mem_setup()
103 		size += mem->size;  in ipa_mem_setup()
115 	offset = ipa->mem_offset + mem->offset;  in ipa_mem_setup()
119 	iowrite32(val, ipa->reg_virt + reg_offset(reg));  in ipa_mem_setup()
124 /* Is the given memory region ID is valid for the current IPA version? */
127 	enum ipa_version version = ipa->version;  in ipa_mem_id_valid()
149 	case IPA_MEM_END_MARKER:	/* pseudo region */  in ipa_mem_id_valid()
185 /* Must the given memory region be present in the configuration? */
207 		return ipa->version >= IPA_VERSION_4_0;  in ipa_mem_id_required()
210 		return ipa->version >= IPA_VERSION_4_0 &&  in ipa_mem_id_required()
211 			ipa->version != IPA_VERSION_5_0;  in ipa_mem_id_required()
220 	enum ipa_mem_id mem_id = mem->id;  in ipa_mem_valid_one()
221 	struct device *dev = ipa->dev;  in ipa_mem_valid_one()
224 	/* Make sure the memory region is valid for this version of IPA */  in ipa_mem_valid_one()
226 		dev_err(dev, "region id %u not valid\n", mem_id);  in ipa_mem_valid_one()
230 	if (!mem->size && !mem->canary_count) {  in ipa_mem_valid_one()
231 		dev_err(dev, "empty memory region %u\n", mem_id);  in ipa_mem_valid_one()
235 	/* Other than modem memory, sizes must be a multiple of 8 */  in ipa_mem_valid_one()
237 	if (mem->size % size_multiple)  in ipa_mem_valid_one()
238 		dev_err(dev, "region %u size not a multiple of %u bytes\n",  in ipa_mem_valid_one()
240 	else if (mem->offset % 8)  in ipa_mem_valid_one()
241 		dev_err(dev, "region %u offset not 8-byte aligned\n", mem_id);  in ipa_mem_valid_one()
242 	else if (mem->offset < mem->canary_count * sizeof(__le32))  in ipa_mem_valid_one()
243 		dev_err(dev, "region %u offset too small for %hu canaries\n",  in ipa_mem_valid_one()
244 			mem_id, mem->canary_count);  in ipa_mem_valid_one()
245 	else if (mem_id == IPA_MEM_END_MARKER && mem->size)  in ipa_mem_valid_one()
246 		dev_err(dev, "non-zero end marker region size\n");  in ipa_mem_valid_one()
253 /* Verify each defined memory region is valid. */
257 	struct device *dev = ipa->dev;  in ipa_mem_valid()
261 	if (mem_data->local_count > IPA_MEM_COUNT) {  in ipa_mem_valid()
262 		dev_err(dev, "too many memory regions (%u > %u)\n",  in ipa_mem_valid()
263 			mem_data->local_count, IPA_MEM_COUNT);  in ipa_mem_valid()
267 	for (i = 0; i < mem_data->local_count; i++) {  in ipa_mem_valid()
268 		const struct ipa_mem *mem = &mem_data->local[i];  in ipa_mem_valid()
270 		if (__test_and_set_bit(mem->id, regions)) {  in ipa_mem_valid()
271 			dev_err(dev, "duplicate memory region %u\n", mem->id);  in ipa_mem_valid()
275 		/* Defined regions have non-zero size and/or canary count */  in ipa_mem_valid()
283 			dev_err(dev, "required memory region %u missing\n",  in ipa_mem_valid()
290 /* Do all memory regions fit within the IPA local memory? */
293 	struct device *dev = ipa->dev;  in ipa_mem_size_valid()
294 	u32 limit = ipa->mem_size;  in ipa_mem_size_valid()
297 	for (i = 0; i < ipa->mem_count; i++) {  in ipa_mem_size_valid()
298 		const struct ipa_mem *mem = &ipa->mem[i];  in ipa_mem_size_valid()
300 		if (mem->offset + mem->size <= limit)  in ipa_mem_size_valid()
303 		dev_err(dev, "region %u ends beyond memory limit (0x%08x)\n",  in ipa_mem_size_valid()
304 			mem->id, limit);  in ipa_mem_size_valid()
313  * ipa_mem_config() - Configure IPA shared memory
320 	struct device *dev = ipa->dev;  in ipa_mem_config()
329 	/* Check the advertised location and size of the shared memory area */  in ipa_mem_config()
331 	val = ioread32(ipa->reg_virt + reg_offset(reg));  in ipa_mem_config()
334 	ipa->mem_offset = 8 * reg_decode(reg, MEM_BADDR, val);  in ipa_mem_config()
336 	/* Make sure the end is within the region's mapped space */  in ipa_mem_config()
340 	if (ipa->mem_offset + mem_size < ipa->mem_size) {  in ipa_mem_config()
341 		dev_warn(dev, "limiting IPA memory size to 0x%08x\n",  in ipa_mem_config()
343 		ipa->mem_size = mem_size;  in ipa_mem_config()
344 	} else if (ipa->mem_offset + mem_size > ipa->mem_size) {  in ipa_mem_config()
345 		dev_dbg(dev, "ignoring larger reported memory size: 0x%08x\n",  in ipa_mem_config()
349 	/* We know our memory size; make sure regions are all in range */  in ipa_mem_config()
351 		return -EINVAL;  in ipa_mem_config()
353 	/* Prealloc DMA memory for zeroing regions */  in ipa_mem_config()
356 		return -ENOMEM;  in ipa_mem_config()
357 	ipa->zero_addr = addr;  in ipa_mem_config()
358 	ipa->zero_virt = virt;  in ipa_mem_config()
359 	ipa->zero_size = IPA_MEM_MAX;  in ipa_mem_config()
361 	/* For each defined region, write "canary" values in the  in ipa_mem_config()
362 	 * space prior to the region's base address if indicated.  in ipa_mem_config()
364 	for (i = 0; i < ipa->mem_count; i++) {  in ipa_mem_config()
365 		u16 canary_count = ipa->mem[i].canary_count;  in ipa_mem_config()
371 		/* Write canary values in the space before the region */  in ipa_mem_config()
372 		canary = ipa->mem_virt + ipa->mem_offset + ipa->mem[i].offset;  in ipa_mem_config()
374 			*--canary = IPA_MEM_CANARY_VAL;  in ipa_mem_config()
375 		while (--canary_count);  in ipa_mem_config()
380 	if (mem && mem->offset % 1024) {  in ipa_mem_config()
381 		dev_err(dev, "microcontroller ring not 1024-byte aligned\n");  in ipa_mem_config()
388 	dma_free_coherent(dev, IPA_MEM_MAX, ipa->zero_virt, ipa->zero_addr);  in ipa_mem_config()
390 	return -EINVAL;  in ipa_mem_config()
396 	struct device *dev = ipa->dev;  in ipa_mem_deconfig()
398 	dma_free_coherent(dev, ipa->zero_size, ipa->zero_virt, ipa->zero_addr);  in ipa_mem_deconfig()
399 	ipa->zero_size = 0;  in ipa_mem_deconfig()
400 	ipa->zero_virt = NULL;  in ipa_mem_deconfig()
401 	ipa->zero_addr = 0;  in ipa_mem_deconfig()
405  * ipa_mem_zero_modem() - Zero IPA-local memory regions owned by the modem
408  * Zero regions of IPA-local memory used by the modem.  These are configured
410  * restarts via SSR we need to re-initialize them.  A QMI message tells the
411  * modem where to find regions of IPA local memory it needs to know about
418 	/* Get a transaction to zero the modem memory, modem header,  in ipa_mem_zero_modem()
423 		dev_err(ipa->dev, "no transaction to zero modem memory\n");  in ipa_mem_zero_modem()
424 		return -EBUSY;  in ipa_mem_zero_modem()
437  * ipa_imem_init() - Initialize IMEM memory used by the IPA
439  * @addr:	Physical address of the IPA region in IMEM
440  * @size:	Size (bytes) of the IPA region in IMEM
442  * IMEM is a block of shared memory separate from system DRAM, and
443  * a portion of this memory is available for the IPA to use.  The
444  * modem accesses this memory directly, but the IPA accesses it
447  * If this region exists (size > 0) we map it for read/write access
450  * Note: @addr and @size are not guaranteed to be page-aligned.
454 	struct device *dev = ipa->dev;  in ipa_imem_init()
461 		return 0;	/* IMEM memory not used */  in ipa_imem_init()
466 		return -EINVAL;  in ipa_imem_init()
471 	size = PAGE_ALIGN(size + addr - phys);  in ipa_imem_init()
479 	ipa->imem_iova = iova;  in ipa_imem_init()
480 	ipa->imem_size = size;  in ipa_imem_init()
487 	struct device *dev = ipa->dev;  in ipa_imem_exit()
490 	if (!ipa->imem_size)  in ipa_imem_exit()
497 		size = iommu_unmap(domain, ipa->imem_iova, ipa->imem_size);  in ipa_imem_exit()
498 		if (size != ipa->imem_size)  in ipa_imem_exit()
500 				 size, ipa->imem_size);  in ipa_imem_exit()
505 	ipa->imem_size = 0;  in ipa_imem_exit()
506 	ipa->imem_iova = 0;  in ipa_imem_exit()
510  * ipa_smem_init() - Initialize SMEM memory used by the IPA
512  * @item:	Item ID of SMEM memory
513  * @size:	Size (bytes) of SMEM memory region
518  * The modem accesses SMEM memory directly, but the IPA accesses it
521  * If size provided is non-zero, we allocate it and map it for
524  * Note: @size and the item address are is not guaranteed to be page-aligned.
528 	struct device *dev = ipa->dev;  in ipa_smem_init()
538 		return 0;	/* SMEM memory not used */  in ipa_smem_init()
540 	/* SMEM is memory shared between the AP and another system entity  in ipa_smem_init()
543 	 * region.  Allocation only reserves the space; to use it you need  in ipa_smem_init()
549 	if (ret && ret != -EEXIST) {  in ipa_smem_init()
555 	/* Now get the address of the SMEM memory region */  in ipa_smem_init()
563 	/* In case the region was already allocated, verify the size */  in ipa_smem_init()
567 		return -EINVAL;  in ipa_smem_init()
573 		return -EINVAL;  in ipa_smem_init()
579 	size = PAGE_ALIGN(size + addr - phys);  in ipa_smem_init()
587 	ipa->smem_iova = iova;  in ipa_smem_init()
588 	ipa->smem_size = size;  in ipa_smem_init()
595 	struct device *dev = ipa->dev;  in ipa_smem_exit()
602 		size = iommu_unmap(domain, ipa->smem_iova, ipa->smem_size);  in ipa_smem_exit()
603 		if (size != ipa->smem_size)  in ipa_smem_exit()
605 				 size, ipa->smem_size);  in ipa_smem_exit()
611 	ipa->smem_size = 0;  in ipa_smem_exit()
612 	ipa->smem_iova = 0;  in ipa_smem_exit()
615 /* Perform memory region-related initialization */
619 	struct device *dev = &pdev->dev;  in ipa_mem_init()
623 	/* Make sure the set of defined memory regions is valid */  in ipa_mem_init()
625 		return -EINVAL;  in ipa_mem_init()
627 	ipa->mem_count = mem_data->local_count;  in ipa_mem_init()
628 	ipa->mem = mem_data->local;  in ipa_mem_init()
630 	/* Check the route and filter table memory regions */  in ipa_mem_init()
632 		return -EINVAL;  in ipa_mem_init()
634 		return -EINVAL;  in ipa_mem_init()
642 	res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "ipa-shared");  in ipa_mem_init()
645 			"DT error getting \"ipa-shared\" memory property\n");  in ipa_mem_init()
646 		return -ENODEV;  in ipa_mem_init()
649 	ipa->mem_virt = memremap(res->start, resource_size(res), MEMREMAP_WC);  in ipa_mem_init()
650 	if (!ipa->mem_virt) {  in ipa_mem_init()
651 		dev_err(dev, "unable to remap \"ipa-shared\" memory\n");  in ipa_mem_init()
652 		return -ENOMEM;  in ipa_mem_init()
655 	ipa->mem_addr = res->start;  in ipa_mem_init()
656 	ipa->mem_size = resource_size(res);  in ipa_mem_init()
658 	ret = ipa_imem_init(ipa, mem_data->imem_addr, mem_data->imem_size);  in ipa_mem_init()
662 	ret = ipa_smem_init(ipa, mem_data->smem_id, mem_data->smem_size);  in ipa_mem_init()
671 	memunmap(ipa->mem_virt);  in ipa_mem_init()
681 	memunmap(ipa->mem_virt);  in ipa_mem_exit()