1 // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
2 /*
3  * Copyright (C) 2012-2014, 2018-2019 Intel Corporation
4  * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
5  * Copyright (C) 2016-2017 Intel Deutschland GmbH
6  */
7 #include "iwl-drv.h"
8 #include "runtime.h"
9 #include "fw/api/commands.h"
10 
11 void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt)
12 {
13 	int i;
14 
15 	if (!fwrt->fw_paging_db[0].fw_paging_block)
16 		return;
17 
18 	for (i = 0; i < NUM_OF_FW_PAGING_BLOCKS; i++) {
19 		struct iwl_fw_paging *paging = &fwrt->fw_paging_db[i];
20 
21 		if (!paging->fw_paging_block) {
22 			IWL_DEBUG_FW(fwrt,
23 				     "Paging: block %d already freed, continue to next page\n",
24 				     i);
25 
26 			continue;
27 		}
28 		dma_unmap_page(fwrt->trans->dev, paging->fw_paging_phys,
29 			       paging->fw_paging_size, DMA_BIDIRECTIONAL);
30 
31 		__free_pages(paging->fw_paging_block,
32 			     get_order(paging->fw_paging_size));
33 		paging->fw_paging_block = NULL;
34 	}
35 
36 	memset(fwrt->fw_paging_db, 0, sizeof(fwrt->fw_paging_db));
37 }
38 IWL_EXPORT_SYMBOL(iwl_free_fw_paging);
39 
40 static int iwl_alloc_fw_paging_mem(struct iwl_fw_runtime *fwrt,
41 				   const struct fw_img *image)
42 {
43 	struct page *block;
44 	dma_addr_t phys = 0;
45 	int blk_idx, order, num_of_pages, size;
46 
47 	if (fwrt->fw_paging_db[0].fw_paging_block)
48 		return 0;
49 
50 	/* ensure BLOCK_2_EXP_SIZE is power of 2 of PAGING_BLOCK_SIZE */
51 	BUILD_BUG_ON(BIT(BLOCK_2_EXP_SIZE) != PAGING_BLOCK_SIZE);
52 
53 	num_of_pages = image->paging_mem_size / FW_PAGING_SIZE;
54 	fwrt->num_of_paging_blk =
55 		DIV_ROUND_UP(num_of_pages, NUM_OF_PAGE_PER_GROUP);
56 	fwrt->num_of_pages_in_last_blk =
57 		num_of_pages -
58 		NUM_OF_PAGE_PER_GROUP * (fwrt->num_of_paging_blk - 1);
59 
60 	IWL_DEBUG_FW(fwrt,
61 		     "Paging: allocating mem for %d paging blocks, each block holds 8 pages, last block holds %d pages\n",
62 		     fwrt->num_of_paging_blk,
63 		     fwrt->num_of_pages_in_last_blk);
64 
65 	/*
66 	 * Allocate CSS and paging blocks in dram.
67 	 */
68 	for (blk_idx = 0; blk_idx < fwrt->num_of_paging_blk + 1; blk_idx++) {
69 		/* For CSS allocate 4KB, for others PAGING_BLOCK_SIZE (32K) */
70 		size = blk_idx ? PAGING_BLOCK_SIZE : FW_PAGING_SIZE;
71 		order = get_order(size);
72 		block = alloc_pages(GFP_KERNEL, order);
73 		if (!block) {
74 			/* free all the previous pages since we failed */
75 			iwl_free_fw_paging(fwrt);
76 			return -ENOMEM;
77 		}
78 
79 		fwrt->fw_paging_db[blk_idx].fw_paging_block = block;
80 		fwrt->fw_paging_db[blk_idx].fw_paging_size = size;
81 
82 		phys = dma_map_page(fwrt->trans->dev, block, 0,
83 				    PAGE_SIZE << order,
84 				    DMA_BIDIRECTIONAL);
85 		if (dma_mapping_error(fwrt->trans->dev, phys)) {
86 			/*
87 			 * free the previous pages and the current one
88 			 * since we failed to map_page.
89 			 */
90 			iwl_free_fw_paging(fwrt);
91 			return -ENOMEM;
92 		}
93 		fwrt->fw_paging_db[blk_idx].fw_paging_phys = phys;
94 
95 		if (!blk_idx)
96 			IWL_DEBUG_FW(fwrt,
97 				     "Paging: allocated 4K(CSS) bytes (order %d) for firmware paging.\n",
98 				     order);
99 		else
100 			IWL_DEBUG_FW(fwrt,
101 				     "Paging: allocated 32K bytes (order %d) for firmware paging.\n",
102 				     order);
103 	}
104 
105 	return 0;
106 }
107 
108 static int iwl_fill_paging_mem(struct iwl_fw_runtime *fwrt,
109 			       const struct fw_img *image)
110 {
111 	int sec_idx, idx, ret;
112 	u32 offset = 0;
113 
114 	/*
115 	 * find where is the paging image start point:
116 	 * if CPU2 exist and it's in paging format, then the image looks like:
117 	 * CPU1 sections (2 or more)
118 	 * CPU1_CPU2_SEPARATOR_SECTION delimiter - separate between CPU1 to CPU2
119 	 * CPU2 sections (not paged)
120 	 * PAGING_SEPARATOR_SECTION delimiter - separate between CPU2
121 	 * non paged to CPU2 paging sec
122 	 * CPU2 paging CSS
123 	 * CPU2 paging image (including instruction and data)
124 	 */
125 	for (sec_idx = 0; sec_idx < image->num_sec; sec_idx++) {
126 		if (image->sec[sec_idx].offset == PAGING_SEPARATOR_SECTION) {
127 			sec_idx++;
128 			break;
129 		}
130 	}
131 
132 	/*
133 	 * If paging is enabled there should be at least 2 more sections left
134 	 * (one for CSS and one for Paging data)
135 	 */
136 	if (sec_idx >= image->num_sec - 1) {
137 		IWL_ERR(fwrt, "Paging: Missing CSS and/or paging sections\n");
138 		ret = -EINVAL;
139 		goto err;
140 	}
141 
142 	/* copy the CSS block to the dram */
143 	IWL_DEBUG_FW(fwrt, "Paging: load paging CSS to FW, sec = %d\n",
144 		     sec_idx);
145 
146 	if (image->sec[sec_idx].len > fwrt->fw_paging_db[0].fw_paging_size) {
147 		IWL_ERR(fwrt, "CSS block is larger than paging size\n");
148 		ret = -EINVAL;
149 		goto err;
150 	}
151 
152 	memcpy(page_address(fwrt->fw_paging_db[0].fw_paging_block),
153 	       image->sec[sec_idx].data,
154 	       image->sec[sec_idx].len);
155 	dma_sync_single_for_device(fwrt->trans->dev,
156 				   fwrt->fw_paging_db[0].fw_paging_phys,
157 				   fwrt->fw_paging_db[0].fw_paging_size,
158 				   DMA_BIDIRECTIONAL);
159 
160 	IWL_DEBUG_FW(fwrt,
161 		     "Paging: copied %d CSS bytes to first block\n",
162 		     fwrt->fw_paging_db[0].fw_paging_size);
163 
164 	sec_idx++;
165 
166 	/*
167 	 * Copy the paging blocks to the dram.  The loop index starts
168 	 * from 1 since the CSS block (index 0) was already copied to
169 	 * dram.  We use num_of_paging_blk + 1 to account for that.
170 	 */
171 	for (idx = 1; idx < fwrt->num_of_paging_blk + 1; idx++) {
172 		struct iwl_fw_paging *block = &fwrt->fw_paging_db[idx];
173 		int remaining = image->sec[sec_idx].len - offset;
174 		int len = block->fw_paging_size;
175 
176 		/*
177 		 * For the last block, we copy all that is remaining,
178 		 * for all other blocks, we copy fw_paging_size at a
179 		 * time. */
180 		if (idx == fwrt->num_of_paging_blk) {
181 			len = remaining;
182 			if (remaining !=
183 			    fwrt->num_of_pages_in_last_blk * FW_PAGING_SIZE) {
184 				IWL_ERR(fwrt,
185 					"Paging: last block contains more data than expected %d\n",
186 					remaining);
187 				ret = -EINVAL;
188 				goto err;
189 			}
190 		} else if (block->fw_paging_size > remaining) {
191 			IWL_ERR(fwrt,
192 				"Paging: not enough data in other in block %d (%d)\n",
193 				idx, remaining);
194 			ret = -EINVAL;
195 			goto err;
196 		}
197 
198 		memcpy(page_address(block->fw_paging_block),
199 		       image->sec[sec_idx].data + offset, len);
200 		dma_sync_single_for_device(fwrt->trans->dev,
201 					   block->fw_paging_phys,
202 					   block->fw_paging_size,
203 					   DMA_BIDIRECTIONAL);
204 
205 		IWL_DEBUG_FW(fwrt,
206 			     "Paging: copied %d paging bytes to block %d\n",
207 			     len, idx);
208 
209 		offset += block->fw_paging_size;
210 	}
211 
212 	return 0;
213 
214 err:
215 	iwl_free_fw_paging(fwrt);
216 	return ret;
217 }
218 
219 static int iwl_save_fw_paging(struct iwl_fw_runtime *fwrt,
220 			      const struct fw_img *fw)
221 {
222 	int ret;
223 
224 	ret = iwl_alloc_fw_paging_mem(fwrt, fw);
225 	if (ret)
226 		return ret;
227 
228 	return iwl_fill_paging_mem(fwrt, fw);
229 }
230 
231 /* send paging cmd to FW in case CPU2 has paging image */
232 static int iwl_send_paging_cmd(struct iwl_fw_runtime *fwrt,
233 			       const struct fw_img *fw)
234 {
235 	struct iwl_fw_paging_cmd paging_cmd = {
236 		.flags = cpu_to_le32(PAGING_CMD_IS_SECURED |
237 				     PAGING_CMD_IS_ENABLED |
238 				     (fwrt->num_of_pages_in_last_blk <<
239 				      PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS)),
240 		.block_size = cpu_to_le32(BLOCK_2_EXP_SIZE),
241 		.block_num = cpu_to_le32(fwrt->num_of_paging_blk),
242 	};
243 	struct iwl_host_cmd hcmd = {
244 		.id = iwl_cmd_id(FW_PAGING_BLOCK_CMD, IWL_ALWAYS_LONG_GROUP, 0),
245 		.len = { sizeof(paging_cmd), },
246 		.data = { &paging_cmd, },
247 	};
248 	int blk_idx;
249 
250 	/* loop for for all paging blocks + CSS block */
251 	for (blk_idx = 0; blk_idx < fwrt->num_of_paging_blk + 1; blk_idx++) {
252 		dma_addr_t addr = fwrt->fw_paging_db[blk_idx].fw_paging_phys;
253 		__le32 phy_addr;
254 
255 		addr = addr >> PAGE_2_EXP_SIZE;
256 		phy_addr = cpu_to_le32(addr);
257 		paging_cmd.device_phy_addr[blk_idx] = phy_addr;
258 	}
259 
260 	return iwl_trans_send_cmd(fwrt->trans, &hcmd);
261 }
262 
263 int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type)
264 {
265 	const struct fw_img *fw = &fwrt->fw->img[type];
266 	int ret;
267 
268 	if (fwrt->trans->trans_cfg->gen2)
269 		return 0;
270 
271 	/*
272 	 * Configure and operate fw paging mechanism.
273 	 * The driver configures the paging flow only once.
274 	 * The CPU2 paging image is included in the IWL_UCODE_INIT image.
275 	 */
276 	if (!fw->paging_mem_size)
277 		return 0;
278 
279 	ret = iwl_save_fw_paging(fwrt, fw);
280 	if (ret) {
281 		IWL_ERR(fwrt, "failed to save the FW paging image\n");
282 		return ret;
283 	}
284 
285 	ret = iwl_send_paging_cmd(fwrt, fw);
286 	if (ret) {
287 		IWL_ERR(fwrt, "failed to send the paging cmd\n");
288 		iwl_free_fw_paging(fwrt);
289 		return ret;
290 	}
291 
292 	return 0;
293 }
294 IWL_EXPORT_SYMBOL(iwl_init_paging);
295