1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2013 Red Hat
4  * Author: Rob Clark <robdclark@gmail.com>
5  *
6  * Copyright (c) 2014 The Linux Foundation. All rights reserved.
7  */
8 
9 #include <linux/ascii85.h>
10 #include <linux/interconnect.h>
11 #include <linux/qcom_scm.h>
12 #include <linux/kernel.h>
13 #include <linux/of_address.h>
14 #include <linux/pm_opp.h>
15 #include <linux/slab.h>
16 #include <linux/soc/qcom/mdt_loader.h>
17 #include "adreno_gpu.h"
18 #include "msm_gem.h"
19 #include "msm_mmu.h"
20 
21 static bool zap_available = true;
22 
23 static int zap_shader_load_mdt(struct msm_gpu *gpu, const char *fwname,
24 		u32 pasid)
25 {
26 	struct device *dev = &gpu->pdev->dev;
27 	const struct firmware *fw;
28 	struct device_node *np, *mem_np;
29 	struct resource r;
30 	phys_addr_t mem_phys;
31 	ssize_t mem_size;
32 	void *mem_region = NULL;
33 	int ret;
34 
35 	if (!IS_ENABLED(CONFIG_ARCH_QCOM)) {
36 		zap_available = false;
37 		return -EINVAL;
38 	}
39 
40 	np = of_get_child_by_name(dev->of_node, "zap-shader");
41 	if (!np) {
42 		zap_available = false;
43 		return -ENODEV;
44 	}
45 
46 	mem_np = of_parse_phandle(np, "memory-region", 0);
47 	of_node_put(np);
48 	if (!mem_np) {
49 		zap_available = false;
50 		return -EINVAL;
51 	}
52 
53 	ret = of_address_to_resource(mem_np, 0, &r);
54 	of_node_put(mem_np);
55 	if (ret)
56 		return ret;
57 
58 	mem_phys = r.start;
59 
60 	/* Request the MDT file for the firmware */
61 	fw = adreno_request_fw(to_adreno_gpu(gpu), fwname);
62 	if (IS_ERR(fw)) {
63 		DRM_DEV_ERROR(dev, "Unable to load %s\n", fwname);
64 		return PTR_ERR(fw);
65 	}
66 
67 	/* Figure out how much memory we need */
68 	mem_size = qcom_mdt_get_size(fw);
69 	if (mem_size < 0) {
70 		ret = mem_size;
71 		goto out;
72 	}
73 
74 	if (mem_size > resource_size(&r)) {
75 		DRM_DEV_ERROR(dev,
76 			"memory region is too small to load the MDT\n");
77 		ret = -E2BIG;
78 		goto out;
79 	}
80 
81 	/* Allocate memory for the firmware image */
82 	mem_region = memremap(mem_phys, mem_size,  MEMREMAP_WC);
83 	if (!mem_region) {
84 		ret = -ENOMEM;
85 		goto out;
86 	}
87 
88 	/*
89 	 * Load the rest of the MDT
90 	 *
91 	 * Note that we could be dealing with two different paths, since
92 	 * with upstream linux-firmware it would be in a qcom/ subdir..
93 	 * adreno_request_fw() handles this, but qcom_mdt_load() does
94 	 * not.  But since we've already gotten through adreno_request_fw()
95 	 * we know which of the two cases it is:
96 	 */
97 	if (to_adreno_gpu(gpu)->fwloc == FW_LOCATION_LEGACY) {
98 		ret = qcom_mdt_load(dev, fw, fwname, pasid,
99 				mem_region, mem_phys, mem_size, NULL);
100 	} else {
101 		char *newname;
102 
103 		newname = kasprintf(GFP_KERNEL, "qcom/%s", fwname);
104 
105 		ret = qcom_mdt_load(dev, fw, newname, pasid,
106 				mem_region, mem_phys, mem_size, NULL);
107 		kfree(newname);
108 	}
109 	if (ret)
110 		goto out;
111 
112 	/* Send the image to the secure world */
113 	ret = qcom_scm_pas_auth_and_reset(pasid);
114 
115 	/*
116 	 * If the scm call returns -EOPNOTSUPP we assume that this target
117 	 * doesn't need/support the zap shader so quietly fail
118 	 */
119 	if (ret == -EOPNOTSUPP)
120 		zap_available = false;
121 	else if (ret)
122 		DRM_DEV_ERROR(dev, "Unable to authorize the image\n");
123 
124 out:
125 	if (mem_region)
126 		memunmap(mem_region);
127 
128 	release_firmware(fw);
129 
130 	return ret;
131 }
132 
133 int adreno_zap_shader_load(struct msm_gpu *gpu, u32 pasid)
134 {
135 	struct adreno_gpu *adreno_gpu = to_adreno_gpu(gpu);
136 	struct platform_device *pdev = gpu->pdev;
137 
138 	/* Short cut if we determine the zap shader isn't available/needed */
139 	if (!zap_available)
140 		return -ENODEV;
141 
142 	/* We need SCM to be able to load the firmware */
143 	if (!qcom_scm_is_available()) {
144 		DRM_DEV_ERROR(&pdev->dev, "SCM is not available\n");
145 		return -EPROBE_DEFER;
146 	}
147 
148 	/* Each GPU has a target specific zap shader firmware name to use */
149 	if (!adreno_gpu->info->zapfw) {
150 		zap_available = false;
151 		DRM_DEV_ERROR(&pdev->dev,
152 			"Zap shader firmware file not specified for this target\n");
153 		return -ENODEV;
154 	}
155 
156 	return zap_shader_load_mdt(gpu, adreno_gpu->info->zapfw, pasid);
157 }
158 
159 int adreno_get_param(struct msm_gpu *gpu, uint32_t param, uint64_t *value)
160 {
161 	struct adreno_gpu *adreno_gpu = to_adreno_gpu(gpu);
162 
163 	switch (param) {
164 	case MSM_PARAM_GPU_ID:
165 		*value = adreno_gpu->info->revn;
166 		return 0;
167 	case MSM_PARAM_GMEM_SIZE:
168 		*value = adreno_gpu->gmem;
169 		return 0;
170 	case MSM_PARAM_GMEM_BASE:
171 		*value = 0x100000;
172 		return 0;
173 	case MSM_PARAM_CHIP_ID:
174 		*value = adreno_gpu->rev.patchid |
175 				(adreno_gpu->rev.minor << 8) |
176 				(adreno_gpu->rev.major << 16) |
177 				(adreno_gpu->rev.core << 24);
178 		return 0;
179 	case MSM_PARAM_MAX_FREQ:
180 		*value = adreno_gpu->base.fast_rate;
181 		return 0;
182 	case MSM_PARAM_TIMESTAMP:
183 		if (adreno_gpu->funcs->get_timestamp) {
184 			int ret;
185 
186 			pm_runtime_get_sync(&gpu->pdev->dev);
187 			ret = adreno_gpu->funcs->get_timestamp(gpu, value);
188 			pm_runtime_put_autosuspend(&gpu->pdev->dev);
189 
190 			return ret;
191 		}
192 		return -EINVAL;
193 	case MSM_PARAM_NR_RINGS:
194 		*value = gpu->nr_rings;
195 		return 0;
196 	case MSM_PARAM_PP_PGTABLE:
197 		*value = 0;
198 		return 0;
199 	case MSM_PARAM_FAULTS:
200 		*value = gpu->global_faults;
201 		return 0;
202 	default:
203 		DBG("%s: invalid param: %u", gpu->name, param);
204 		return -EINVAL;
205 	}
206 }
207 
208 const struct firmware *
209 adreno_request_fw(struct adreno_gpu *adreno_gpu, const char *fwname)
210 {
211 	struct drm_device *drm = adreno_gpu->base.dev;
212 	const struct firmware *fw = NULL;
213 	char *newname;
214 	int ret;
215 
216 	newname = kasprintf(GFP_KERNEL, "qcom/%s", fwname);
217 	if (!newname)
218 		return ERR_PTR(-ENOMEM);
219 
220 	/*
221 	 * Try first to load from qcom/$fwfile using a direct load (to avoid
222 	 * a potential timeout waiting for usermode helper)
223 	 */
224 	if ((adreno_gpu->fwloc == FW_LOCATION_UNKNOWN) ||
225 	    (adreno_gpu->fwloc == FW_LOCATION_NEW)) {
226 
227 		ret = request_firmware_direct(&fw, newname, drm->dev);
228 		if (!ret) {
229 			DRM_DEV_INFO(drm->dev, "loaded %s from new location\n",
230 				newname);
231 			adreno_gpu->fwloc = FW_LOCATION_NEW;
232 			goto out;
233 		} else if (adreno_gpu->fwloc != FW_LOCATION_UNKNOWN) {
234 			DRM_DEV_ERROR(drm->dev, "failed to load %s: %d\n",
235 				newname, ret);
236 			fw = ERR_PTR(ret);
237 			goto out;
238 		}
239 	}
240 
241 	/*
242 	 * Then try the legacy location without qcom/ prefix
243 	 */
244 	if ((adreno_gpu->fwloc == FW_LOCATION_UNKNOWN) ||
245 	    (adreno_gpu->fwloc == FW_LOCATION_LEGACY)) {
246 
247 		ret = request_firmware_direct(&fw, fwname, drm->dev);
248 		if (!ret) {
249 			DRM_DEV_INFO(drm->dev, "loaded %s from legacy location\n",
250 				newname);
251 			adreno_gpu->fwloc = FW_LOCATION_LEGACY;
252 			goto out;
253 		} else if (adreno_gpu->fwloc != FW_LOCATION_UNKNOWN) {
254 			DRM_DEV_ERROR(drm->dev, "failed to load %s: %d\n",
255 				fwname, ret);
256 			fw = ERR_PTR(ret);
257 			goto out;
258 		}
259 	}
260 
261 	/*
262 	 * Finally fall back to request_firmware() for cases where the
263 	 * usermode helper is needed (I think mainly android)
264 	 */
265 	if ((adreno_gpu->fwloc == FW_LOCATION_UNKNOWN) ||
266 	    (adreno_gpu->fwloc == FW_LOCATION_HELPER)) {
267 
268 		ret = request_firmware(&fw, newname, drm->dev);
269 		if (!ret) {
270 			DRM_DEV_INFO(drm->dev, "loaded %s with helper\n",
271 				newname);
272 			adreno_gpu->fwloc = FW_LOCATION_HELPER;
273 			goto out;
274 		} else if (adreno_gpu->fwloc != FW_LOCATION_UNKNOWN) {
275 			DRM_DEV_ERROR(drm->dev, "failed to load %s: %d\n",
276 				newname, ret);
277 			fw = ERR_PTR(ret);
278 			goto out;
279 		}
280 	}
281 
282 	DRM_DEV_ERROR(drm->dev, "failed to load %s\n", fwname);
283 	fw = ERR_PTR(-ENOENT);
284 out:
285 	kfree(newname);
286 	return fw;
287 }
288 
289 int adreno_load_fw(struct adreno_gpu *adreno_gpu)
290 {
291 	int i;
292 
293 	for (i = 0; i < ARRAY_SIZE(adreno_gpu->info->fw); i++) {
294 		const struct firmware *fw;
295 
296 		if (!adreno_gpu->info->fw[i])
297 			continue;
298 
299 		/* Skip if the firmware has already been loaded */
300 		if (adreno_gpu->fw[i])
301 			continue;
302 
303 		fw = adreno_request_fw(adreno_gpu, adreno_gpu->info->fw[i]);
304 		if (IS_ERR(fw))
305 			return PTR_ERR(fw);
306 
307 		adreno_gpu->fw[i] = fw;
308 	}
309 
310 	return 0;
311 }
312 
313 struct drm_gem_object *adreno_fw_create_bo(struct msm_gpu *gpu,
314 		const struct firmware *fw, u64 *iova)
315 {
316 	struct drm_gem_object *bo;
317 	void *ptr;
318 
319 	ptr = msm_gem_kernel_new_locked(gpu->dev, fw->size - 4,
320 		MSM_BO_UNCACHED | MSM_BO_GPU_READONLY, gpu->aspace, &bo, iova);
321 
322 	if (IS_ERR(ptr))
323 		return ERR_CAST(ptr);
324 
325 	memcpy(ptr, &fw->data[4], fw->size - 4);
326 
327 	msm_gem_put_vaddr(bo);
328 
329 	return bo;
330 }
331 
332 int adreno_hw_init(struct msm_gpu *gpu)
333 {
334 	struct adreno_gpu *adreno_gpu = to_adreno_gpu(gpu);
335 	int ret, i;
336 
337 	DBG("%s", gpu->name);
338 
339 	ret = adreno_load_fw(adreno_gpu);
340 	if (ret)
341 		return ret;
342 
343 	for (i = 0; i < gpu->nr_rings; i++) {
344 		struct msm_ringbuffer *ring = gpu->rb[i];
345 
346 		if (!ring)
347 			continue;
348 
349 		ring->cur = ring->start;
350 		ring->next = ring->start;
351 
352 		/* reset completed fence seqno: */
353 		ring->memptrs->fence = ring->seqno;
354 		ring->memptrs->rptr = 0;
355 	}
356 
357 	/*
358 	 * Setup REG_CP_RB_CNTL.  The same value is used across targets (with
359 	 * the excpetion of A430 that disables the RPTR shadow) - the cacluation
360 	 * for the ringbuffer size and block size is moved to msm_gpu.h for the
361 	 * pre-processor to deal with and the A430 variant is ORed in here
362 	 */
363 	adreno_gpu_write(adreno_gpu, REG_ADRENO_CP_RB_CNTL,
364 		MSM_GPU_RB_CNTL_DEFAULT |
365 		(adreno_is_a430(adreno_gpu) ? AXXX_CP_RB_CNTL_NO_UPDATE : 0));
366 
367 	/* Setup ringbuffer address - use ringbuffer[0] for GPU init */
368 	adreno_gpu_write64(adreno_gpu, REG_ADRENO_CP_RB_BASE,
369 		REG_ADRENO_CP_RB_BASE_HI, gpu->rb[0]->iova);
370 
371 	if (!adreno_is_a430(adreno_gpu)) {
372 		adreno_gpu_write64(adreno_gpu, REG_ADRENO_CP_RB_RPTR_ADDR,
373 			REG_ADRENO_CP_RB_RPTR_ADDR_HI,
374 			rbmemptr(gpu->rb[0], rptr));
375 	}
376 
377 	return 0;
378 }
379 
380 /* Use this helper to read rptr, since a430 doesn't update rptr in memory */
381 static uint32_t get_rptr(struct adreno_gpu *adreno_gpu,
382 		struct msm_ringbuffer *ring)
383 {
384 	if (adreno_is_a430(adreno_gpu))
385 		return ring->memptrs->rptr = adreno_gpu_read(
386 			adreno_gpu, REG_ADRENO_CP_RB_RPTR);
387 	else
388 		return ring->memptrs->rptr;
389 }
390 
391 struct msm_ringbuffer *adreno_active_ring(struct msm_gpu *gpu)
392 {
393 	return gpu->rb[0];
394 }
395 
396 void adreno_recover(struct msm_gpu *gpu)
397 {
398 	struct drm_device *dev = gpu->dev;
399 	int ret;
400 
401 	// XXX pm-runtime??  we *need* the device to be off after this
402 	// so maybe continuing to call ->pm_suspend/resume() is better?
403 
404 	gpu->funcs->pm_suspend(gpu);
405 	gpu->funcs->pm_resume(gpu);
406 
407 	ret = msm_gpu_hw_init(gpu);
408 	if (ret) {
409 		DRM_DEV_ERROR(dev->dev, "gpu hw init failed: %d\n", ret);
410 		/* hmm, oh well? */
411 	}
412 }
413 
414 void adreno_submit(struct msm_gpu *gpu, struct msm_gem_submit *submit,
415 		struct msm_file_private *ctx)
416 {
417 	struct adreno_gpu *adreno_gpu = to_adreno_gpu(gpu);
418 	struct msm_drm_private *priv = gpu->dev->dev_private;
419 	struct msm_ringbuffer *ring = submit->ring;
420 	unsigned i;
421 
422 	for (i = 0; i < submit->nr_cmds; i++) {
423 		switch (submit->cmd[i].type) {
424 		case MSM_SUBMIT_CMD_IB_TARGET_BUF:
425 			/* ignore IB-targets */
426 			break;
427 		case MSM_SUBMIT_CMD_CTX_RESTORE_BUF:
428 			/* ignore if there has not been a ctx switch: */
429 			if (priv->lastctx == ctx)
430 				break;
431 			/* fall-thru */
432 		case MSM_SUBMIT_CMD_BUF:
433 			OUT_PKT3(ring, adreno_is_a430(adreno_gpu) ?
434 				CP_INDIRECT_BUFFER_PFE : CP_INDIRECT_BUFFER_PFD, 2);
435 			OUT_RING(ring, lower_32_bits(submit->cmd[i].iova));
436 			OUT_RING(ring, submit->cmd[i].size);
437 			OUT_PKT2(ring);
438 			break;
439 		}
440 	}
441 
442 	OUT_PKT0(ring, REG_AXXX_CP_SCRATCH_REG2, 1);
443 	OUT_RING(ring, submit->seqno);
444 
445 	if (adreno_is_a3xx(adreno_gpu) || adreno_is_a4xx(adreno_gpu)) {
446 		/* Flush HLSQ lazy updates to make sure there is nothing
447 		 * pending for indirect loads after the timestamp has
448 		 * passed:
449 		 */
450 		OUT_PKT3(ring, CP_EVENT_WRITE, 1);
451 		OUT_RING(ring, HLSQ_FLUSH);
452 	}
453 
454 	/* wait for idle before cache flush/interrupt */
455 	OUT_PKT3(ring, CP_WAIT_FOR_IDLE, 1);
456 	OUT_RING(ring, 0x00000000);
457 
458 	if (!adreno_is_a2xx(adreno_gpu)) {
459 		/* BIT(31) of CACHE_FLUSH_TS triggers CACHE_FLUSH_TS IRQ from GPU */
460 		OUT_PKT3(ring, CP_EVENT_WRITE, 3);
461 		OUT_RING(ring, CACHE_FLUSH_TS | BIT(31));
462 		OUT_RING(ring, rbmemptr(ring, fence));
463 		OUT_RING(ring, submit->seqno);
464 	} else {
465 		/* BIT(31) means something else on a2xx */
466 		OUT_PKT3(ring, CP_EVENT_WRITE, 3);
467 		OUT_RING(ring, CACHE_FLUSH_TS);
468 		OUT_RING(ring, rbmemptr(ring, fence));
469 		OUT_RING(ring, submit->seqno);
470 		OUT_PKT3(ring, CP_INTERRUPT, 1);
471 		OUT_RING(ring, 0x80000000);
472 	}
473 
474 #if 0
475 	if (adreno_is_a3xx(adreno_gpu)) {
476 		/* Dummy set-constant to trigger context rollover */
477 		OUT_PKT3(ring, CP_SET_CONSTANT, 2);
478 		OUT_RING(ring, CP_REG(REG_A3XX_HLSQ_CL_KERNEL_GROUP_X_REG));
479 		OUT_RING(ring, 0x00000000);
480 	}
481 #endif
482 
483 	gpu->funcs->flush(gpu, ring);
484 }
485 
486 void adreno_flush(struct msm_gpu *gpu, struct msm_ringbuffer *ring)
487 {
488 	struct adreno_gpu *adreno_gpu = to_adreno_gpu(gpu);
489 	uint32_t wptr;
490 
491 	/* Copy the shadow to the actual register */
492 	ring->cur = ring->next;
493 
494 	/*
495 	 * Mask wptr value that we calculate to fit in the HW range. This is
496 	 * to account for the possibility that the last command fit exactly into
497 	 * the ringbuffer and rb->next hasn't wrapped to zero yet
498 	 */
499 	wptr = get_wptr(ring);
500 
501 	/* ensure writes to ringbuffer have hit system memory: */
502 	mb();
503 
504 	adreno_gpu_write(adreno_gpu, REG_ADRENO_CP_RB_WPTR, wptr);
505 }
506 
507 bool adreno_idle(struct msm_gpu *gpu, struct msm_ringbuffer *ring)
508 {
509 	struct adreno_gpu *adreno_gpu = to_adreno_gpu(gpu);
510 	uint32_t wptr = get_wptr(ring);
511 
512 	/* wait for CP to drain ringbuffer: */
513 	if (!spin_until(get_rptr(adreno_gpu, ring) == wptr))
514 		return true;
515 
516 	/* TODO maybe we need to reset GPU here to recover from hang? */
517 	DRM_ERROR("%s: timeout waiting to drain ringbuffer %d rptr/wptr = %X/%X\n",
518 		gpu->name, ring->id, get_rptr(adreno_gpu, ring), wptr);
519 
520 	return false;
521 }
522 
523 int adreno_gpu_state_get(struct msm_gpu *gpu, struct msm_gpu_state *state)
524 {
525 	struct adreno_gpu *adreno_gpu = to_adreno_gpu(gpu);
526 	int i, count = 0;
527 
528 	kref_init(&state->ref);
529 
530 	ktime_get_real_ts64(&state->time);
531 
532 	for (i = 0; i < gpu->nr_rings; i++) {
533 		int size = 0, j;
534 
535 		state->ring[i].fence = gpu->rb[i]->memptrs->fence;
536 		state->ring[i].iova = gpu->rb[i]->iova;
537 		state->ring[i].seqno = gpu->rb[i]->seqno;
538 		state->ring[i].rptr = get_rptr(adreno_gpu, gpu->rb[i]);
539 		state->ring[i].wptr = get_wptr(gpu->rb[i]);
540 
541 		/* Copy at least 'wptr' dwords of the data */
542 		size = state->ring[i].wptr;
543 
544 		/* After wptr find the last non zero dword to save space */
545 		for (j = state->ring[i].wptr; j < MSM_GPU_RINGBUFFER_SZ >> 2; j++)
546 			if (gpu->rb[i]->start[j])
547 				size = j + 1;
548 
549 		if (size) {
550 			state->ring[i].data = kvmalloc(size << 2, GFP_KERNEL);
551 			if (state->ring[i].data) {
552 				memcpy(state->ring[i].data, gpu->rb[i]->start, size << 2);
553 				state->ring[i].data_size = size << 2;
554 			}
555 		}
556 	}
557 
558 	/* Some targets prefer to collect their own registers */
559 	if (!adreno_gpu->registers)
560 		return 0;
561 
562 	/* Count the number of registers */
563 	for (i = 0; adreno_gpu->registers[i] != ~0; i += 2)
564 		count += adreno_gpu->registers[i + 1] -
565 			adreno_gpu->registers[i] + 1;
566 
567 	state->registers = kcalloc(count * 2, sizeof(u32), GFP_KERNEL);
568 	if (state->registers) {
569 		int pos = 0;
570 
571 		for (i = 0; adreno_gpu->registers[i] != ~0; i += 2) {
572 			u32 start = adreno_gpu->registers[i];
573 			u32 end   = adreno_gpu->registers[i + 1];
574 			u32 addr;
575 
576 			for (addr = start; addr <= end; addr++) {
577 				state->registers[pos++] = addr;
578 				state->registers[pos++] = gpu_read(gpu, addr);
579 			}
580 		}
581 
582 		state->nr_registers = count;
583 	}
584 
585 	return 0;
586 }
587 
588 void adreno_gpu_state_destroy(struct msm_gpu_state *state)
589 {
590 	int i;
591 
592 	for (i = 0; i < ARRAY_SIZE(state->ring); i++)
593 		kvfree(state->ring[i].data);
594 
595 	for (i = 0; state->bos && i < state->nr_bos; i++)
596 		kvfree(state->bos[i].data);
597 
598 	kfree(state->bos);
599 	kfree(state->comm);
600 	kfree(state->cmd);
601 	kfree(state->registers);
602 }
603 
604 static void adreno_gpu_state_kref_destroy(struct kref *kref)
605 {
606 	struct msm_gpu_state *state = container_of(kref,
607 		struct msm_gpu_state, ref);
608 
609 	adreno_gpu_state_destroy(state);
610 	kfree(state);
611 }
612 
613 int adreno_gpu_state_put(struct msm_gpu_state *state)
614 {
615 	if (IS_ERR_OR_NULL(state))
616 		return 1;
617 
618 	return kref_put(&state->ref, adreno_gpu_state_kref_destroy);
619 }
620 
621 #if defined(CONFIG_DEBUG_FS) || defined(CONFIG_DEV_COREDUMP)
622 
623 static char *adreno_gpu_ascii85_encode(u32 *src, size_t len)
624 {
625 	void *buf;
626 	size_t buf_itr = 0, buffer_size;
627 	char out[ASCII85_BUFSZ];
628 	long l;
629 	int i;
630 
631 	if (!src || !len)
632 		return NULL;
633 
634 	l = ascii85_encode_len(len);
635 
636 	/*
637 	 * Ascii85 outputs either a 5 byte string or a 1 byte string. So we
638 	 * account for the worst case of 5 bytes per dword plus the 1 for '\0'
639 	 */
640 	buffer_size = (l * 5) + 1;
641 
642 	buf = kvmalloc(buffer_size, GFP_KERNEL);
643 	if (!buf)
644 		return NULL;
645 
646 	for (i = 0; i < l; i++)
647 		buf_itr += snprintf(buf + buf_itr, buffer_size - buf_itr, "%s",
648 				ascii85_encode(src[i], out));
649 
650 	return buf;
651 }
652 
653 /* len is expected to be in bytes */
654 static void adreno_show_object(struct drm_printer *p, void **ptr, int len,
655 		bool *encoded)
656 {
657 	if (!*ptr || !len)
658 		return;
659 
660 	if (!*encoded) {
661 		long datalen, i;
662 		u32 *buf = *ptr;
663 
664 		/*
665 		 * Only dump the non-zero part of the buffer - rarely will
666 		 * any data completely fill the entire allocated size of
667 		 * the buffer.
668 		 */
669 		for (datalen = 0, i = 0; i < len >> 2; i++)
670 			if (buf[i])
671 				datalen = ((i + 1) << 2);
672 
673 		/*
674 		 * If we reach here, then the originally captured binary buffer
675 		 * will be replaced with the ascii85 encoded string
676 		 */
677 		*ptr = adreno_gpu_ascii85_encode(buf, datalen);
678 
679 		kvfree(buf);
680 
681 		*encoded = true;
682 	}
683 
684 	if (!*ptr)
685 		return;
686 
687 	drm_puts(p, "    data: !!ascii85 |\n");
688 	drm_puts(p, "     ");
689 
690 	drm_puts(p, *ptr);
691 
692 	drm_puts(p, "\n");
693 }
694 
695 void adreno_show(struct msm_gpu *gpu, struct msm_gpu_state *state,
696 		struct drm_printer *p)
697 {
698 	struct adreno_gpu *adreno_gpu = to_adreno_gpu(gpu);
699 	int i;
700 
701 	if (IS_ERR_OR_NULL(state))
702 		return;
703 
704 	drm_printf(p, "revision: %d (%d.%d.%d.%d)\n",
705 			adreno_gpu->info->revn, adreno_gpu->rev.core,
706 			adreno_gpu->rev.major, adreno_gpu->rev.minor,
707 			adreno_gpu->rev.patchid);
708 
709 	drm_printf(p, "rbbm-status: 0x%08x\n", state->rbbm_status);
710 
711 	drm_puts(p, "ringbuffer:\n");
712 
713 	for (i = 0; i < gpu->nr_rings; i++) {
714 		drm_printf(p, "  - id: %d\n", i);
715 		drm_printf(p, "    iova: 0x%016llx\n", state->ring[i].iova);
716 		drm_printf(p, "    last-fence: %d\n", state->ring[i].seqno);
717 		drm_printf(p, "    retired-fence: %d\n", state->ring[i].fence);
718 		drm_printf(p, "    rptr: %d\n", state->ring[i].rptr);
719 		drm_printf(p, "    wptr: %d\n", state->ring[i].wptr);
720 		drm_printf(p, "    size: %d\n", MSM_GPU_RINGBUFFER_SZ);
721 
722 		adreno_show_object(p, &state->ring[i].data,
723 			state->ring[i].data_size, &state->ring[i].encoded);
724 	}
725 
726 	if (state->bos) {
727 		drm_puts(p, "bos:\n");
728 
729 		for (i = 0; i < state->nr_bos; i++) {
730 			drm_printf(p, "  - iova: 0x%016llx\n",
731 				state->bos[i].iova);
732 			drm_printf(p, "    size: %zd\n", state->bos[i].size);
733 
734 			adreno_show_object(p, &state->bos[i].data,
735 				state->bos[i].size, &state->bos[i].encoded);
736 		}
737 	}
738 
739 	if (state->nr_registers) {
740 		drm_puts(p, "registers:\n");
741 
742 		for (i = 0; i < state->nr_registers; i++) {
743 			drm_printf(p, "  - { offset: 0x%04x, value: 0x%08x }\n",
744 				state->registers[i * 2] << 2,
745 				state->registers[(i * 2) + 1]);
746 		}
747 	}
748 }
749 #endif
750 
751 /* Dump common gpu status and scratch registers on any hang, to make
752  * the hangcheck logs more useful.  The scratch registers seem always
753  * safe to read when GPU has hung (unlike some other regs, depending
754  * on how the GPU hung), and they are useful to match up to cmdstream
755  * dumps when debugging hangs:
756  */
757 void adreno_dump_info(struct msm_gpu *gpu)
758 {
759 	struct adreno_gpu *adreno_gpu = to_adreno_gpu(gpu);
760 	int i;
761 
762 	printk("revision: %d (%d.%d.%d.%d)\n",
763 			adreno_gpu->info->revn, adreno_gpu->rev.core,
764 			adreno_gpu->rev.major, adreno_gpu->rev.minor,
765 			adreno_gpu->rev.patchid);
766 
767 	for (i = 0; i < gpu->nr_rings; i++) {
768 		struct msm_ringbuffer *ring = gpu->rb[i];
769 
770 		printk("rb %d: fence:    %d/%d\n", i,
771 			ring->memptrs->fence,
772 			ring->seqno);
773 
774 		printk("rptr:     %d\n", get_rptr(adreno_gpu, ring));
775 		printk("rb wptr:  %d\n", get_wptr(ring));
776 	}
777 }
778 
779 /* would be nice to not have to duplicate the _show() stuff with printk(): */
780 void adreno_dump(struct msm_gpu *gpu)
781 {
782 	struct adreno_gpu *adreno_gpu = to_adreno_gpu(gpu);
783 	int i;
784 
785 	if (!adreno_gpu->registers)
786 		return;
787 
788 	/* dump these out in a form that can be parsed by demsm: */
789 	printk("IO:region %s 00000000 00020000\n", gpu->name);
790 	for (i = 0; adreno_gpu->registers[i] != ~0; i += 2) {
791 		uint32_t start = adreno_gpu->registers[i];
792 		uint32_t end   = adreno_gpu->registers[i+1];
793 		uint32_t addr;
794 
795 		for (addr = start; addr <= end; addr++) {
796 			uint32_t val = gpu_read(gpu, addr);
797 			printk("IO:R %08x %08x\n", addr<<2, val);
798 		}
799 	}
800 }
801 
802 static uint32_t ring_freewords(struct msm_ringbuffer *ring)
803 {
804 	struct adreno_gpu *adreno_gpu = to_adreno_gpu(ring->gpu);
805 	uint32_t size = MSM_GPU_RINGBUFFER_SZ >> 2;
806 	/* Use ring->next to calculate free size */
807 	uint32_t wptr = ring->next - ring->start;
808 	uint32_t rptr = get_rptr(adreno_gpu, ring);
809 	return (rptr + (size - 1) - wptr) % size;
810 }
811 
812 void adreno_wait_ring(struct msm_ringbuffer *ring, uint32_t ndwords)
813 {
814 	if (spin_until(ring_freewords(ring) >= ndwords))
815 		DRM_DEV_ERROR(ring->gpu->dev->dev,
816 			"timeout waiting for space in ringbuffer %d\n",
817 			ring->id);
818 }
819 
820 /* Get legacy powerlevels from qcom,gpu-pwrlevels and populate the opp table */
821 static int adreno_get_legacy_pwrlevels(struct device *dev)
822 {
823 	struct device_node *child, *node;
824 	int ret;
825 
826 	node = of_get_compatible_child(dev->of_node, "qcom,gpu-pwrlevels");
827 	if (!node) {
828 		DRM_DEV_ERROR(dev, "Could not find the GPU powerlevels\n");
829 		return -ENXIO;
830 	}
831 
832 	for_each_child_of_node(node, child) {
833 		unsigned int val;
834 
835 		ret = of_property_read_u32(child, "qcom,gpu-freq", &val);
836 		if (ret)
837 			continue;
838 
839 		/*
840 		 * Skip the intentionally bogus clock value found at the bottom
841 		 * of most legacy frequency tables
842 		 */
843 		if (val != 27000000)
844 			dev_pm_opp_add(dev, val, 0);
845 	}
846 
847 	of_node_put(node);
848 
849 	return 0;
850 }
851 
852 static int adreno_get_pwrlevels(struct device *dev,
853 		struct msm_gpu *gpu)
854 {
855 	unsigned long freq = ULONG_MAX;
856 	struct dev_pm_opp *opp;
857 	int ret;
858 
859 	gpu->fast_rate = 0;
860 
861 	/* You down with OPP? */
862 	if (!of_find_property(dev->of_node, "operating-points-v2", NULL))
863 		ret = adreno_get_legacy_pwrlevels(dev);
864 	else {
865 		ret = dev_pm_opp_of_add_table(dev);
866 		if (ret)
867 			DRM_DEV_ERROR(dev, "Unable to set the OPP table\n");
868 	}
869 
870 	if (!ret) {
871 		/* Find the fastest defined rate */
872 		opp = dev_pm_opp_find_freq_floor(dev, &freq);
873 		if (!IS_ERR(opp)) {
874 			gpu->fast_rate = freq;
875 			dev_pm_opp_put(opp);
876 		}
877 	}
878 
879 	if (!gpu->fast_rate) {
880 		dev_warn(dev,
881 			"Could not find a clock rate. Using a reasonable default\n");
882 		/* Pick a suitably safe clock speed for any target */
883 		gpu->fast_rate = 200000000;
884 	}
885 
886 	DBG("fast_rate=%u, slow_rate=27000000", gpu->fast_rate);
887 
888 	/* Check for an interconnect path for the bus */
889 	gpu->icc_path = of_icc_get(dev, NULL);
890 	if (IS_ERR(gpu->icc_path))
891 		gpu->icc_path = NULL;
892 
893 	return 0;
894 }
895 
896 int adreno_gpu_init(struct drm_device *drm, struct platform_device *pdev,
897 		struct adreno_gpu *adreno_gpu,
898 		const struct adreno_gpu_funcs *funcs, int nr_rings)
899 {
900 	struct adreno_platform_config *config = pdev->dev.platform_data;
901 	struct msm_gpu_config adreno_gpu_config  = { 0 };
902 	struct msm_gpu *gpu = &adreno_gpu->base;
903 
904 	adreno_gpu->funcs = funcs;
905 	adreno_gpu->info = adreno_info(config->rev);
906 	adreno_gpu->gmem = adreno_gpu->info->gmem;
907 	adreno_gpu->revn = adreno_gpu->info->revn;
908 	adreno_gpu->rev = config->rev;
909 
910 	adreno_gpu_config.ioname = "kgsl_3d0_reg_memory";
911 
912 	adreno_gpu_config.va_start = SZ_16M;
913 	adreno_gpu_config.va_end = 0xffffffff;
914 	/* maximum range of a2xx mmu */
915 	if (adreno_is_a2xx(adreno_gpu))
916 		adreno_gpu_config.va_end = SZ_16M + 0xfff * SZ_64K;
917 
918 	adreno_gpu_config.nr_rings = nr_rings;
919 
920 	adreno_get_pwrlevels(&pdev->dev, gpu);
921 
922 	pm_runtime_set_autosuspend_delay(&pdev->dev,
923 		adreno_gpu->info->inactive_period);
924 	pm_runtime_use_autosuspend(&pdev->dev);
925 	pm_runtime_enable(&pdev->dev);
926 
927 	return msm_gpu_init(drm, pdev, &adreno_gpu->base, &funcs->base,
928 			adreno_gpu->info->name, &adreno_gpu_config);
929 }
930 
931 void adreno_gpu_cleanup(struct adreno_gpu *adreno_gpu)
932 {
933 	struct msm_gpu *gpu = &adreno_gpu->base;
934 	unsigned int i;
935 
936 	for (i = 0; i < ARRAY_SIZE(adreno_gpu->info->fw); i++)
937 		release_firmware(adreno_gpu->fw[i]);
938 
939 	icc_put(gpu->icc_path);
940 
941 	msm_gpu_cleanup(&adreno_gpu->base);
942 }
943