xref: /openbmc/linux/drivers/gpu/drm/msm/adreno/a5xx_gpu.h (revision feac8c8b)
1 /* Copyright (c) 2016-2017 The Linux Foundation. All rights reserved.
2  *
3  * This program is free software; you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License version 2 and
5  * only version 2 as published by the Free Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  */
13 #ifndef __A5XX_GPU_H__
14 #define __A5XX_GPU_H__
15 
16 #include "adreno_gpu.h"
17 
18 /* Bringing over the hack from the previous targets */
19 #undef ROP_COPY
20 #undef ROP_XOR
21 
22 #include "a5xx.xml.h"
23 
24 struct a5xx_gpu {
25 	struct adreno_gpu base;
26 
27 	struct drm_gem_object *pm4_bo;
28 	uint64_t pm4_iova;
29 
30 	struct drm_gem_object *pfp_bo;
31 	uint64_t pfp_iova;
32 
33 	struct drm_gem_object *gpmu_bo;
34 	uint64_t gpmu_iova;
35 	uint32_t gpmu_dwords;
36 
37 	uint32_t lm_leakage;
38 
39 	struct msm_ringbuffer *cur_ring;
40 	struct msm_ringbuffer *next_ring;
41 
42 	struct drm_gem_object *preempt_bo[MSM_GPU_MAX_RINGS];
43 	struct a5xx_preempt_record *preempt[MSM_GPU_MAX_RINGS];
44 	uint64_t preempt_iova[MSM_GPU_MAX_RINGS];
45 
46 	atomic_t preempt_state;
47 	struct timer_list preempt_timer;
48 };
49 
50 #define to_a5xx_gpu(x) container_of(x, struct a5xx_gpu, base)
51 
52 /*
53  * In order to do lockless preemption we use a simple state machine to progress
54  * through the process.
55  *
56  * PREEMPT_NONE - no preemption in progress.  Next state START.
57  * PREEMPT_START - The trigger is evaulating if preemption is possible. Next
58  * states: TRIGGERED, NONE
59  * PREEMPT_ABORT - An intermediate state before moving back to NONE. Next
60  * state: NONE.
61  * PREEMPT_TRIGGERED: A preemption has been executed on the hardware. Next
62  * states: FAULTED, PENDING
63  * PREEMPT_FAULTED: A preemption timed out (never completed). This will trigger
64  * recovery.  Next state: N/A
65  * PREEMPT_PENDING: Preemption complete interrupt fired - the callback is
66  * checking the success of the operation. Next state: FAULTED, NONE.
67  */
68 
69 enum preempt_state {
70 	PREEMPT_NONE = 0,
71 	PREEMPT_START,
72 	PREEMPT_ABORT,
73 	PREEMPT_TRIGGERED,
74 	PREEMPT_FAULTED,
75 	PREEMPT_PENDING,
76 };
77 
78 /*
79  * struct a5xx_preempt_record is a shared buffer between the microcode and the
80  * CPU to store the state for preemption. The record itself is much larger
81  * (64k) but most of that is used by the CP for storage.
82  *
83  * There is a preemption record assigned per ringbuffer. When the CPU triggers a
84  * preemption, it fills out the record with the useful information (wptr, ring
85  * base, etc) and the microcode uses that information to set up the CP following
86  * the preemption.  When a ring is switched out, the CP will save the ringbuffer
87  * state back to the record. In this way, once the records are properly set up
88  * the CPU can quickly switch back and forth between ringbuffers by only
89  * updating a few registers (often only the wptr).
90  *
91  * These are the CPU aware registers in the record:
92  * @magic: Must always be 0x27C4BAFC
93  * @info: Type of the record - written 0 by the CPU, updated by the CP
94  * @data: Data field from SET_RENDER_MODE or a checkpoint. Written and used by
95  * the CP
96  * @cntl: Value of RB_CNTL written by CPU, save/restored by CP
97  * @rptr: Value of RB_RPTR written by CPU, save/restored by CP
98  * @wptr: Value of RB_WPTR written by CPU, save/restored by CP
99  * @rptr_addr: Value of RB_RPTR_ADDR written by CPU, save/restored by CP
100  * @rbase: Value of RB_BASE written by CPU, save/restored by CP
101  * @counter: GPU address of the storage area for the performance counters
102  */
103 struct a5xx_preempt_record {
104 	uint32_t magic;
105 	uint32_t info;
106 	uint32_t data;
107 	uint32_t cntl;
108 	uint32_t rptr;
109 	uint32_t wptr;
110 	uint64_t rptr_addr;
111 	uint64_t rbase;
112 	uint64_t counter;
113 };
114 
115 /* Magic identifier for the preemption record */
116 #define A5XX_PREEMPT_RECORD_MAGIC 0x27C4BAFCUL
117 
118 /*
119  * Even though the structure above is only a few bytes, we need a full 64k to
120  * store the entire preemption record from the CP
121  */
122 #define A5XX_PREEMPT_RECORD_SIZE (64 * 1024)
123 
124 /*
125  * The preemption counter block is a storage area for the value of the
126  * preemption counters that are saved immediately before context switch. We
127  * append it on to the end of the allocation for the preemption record.
128  */
129 #define A5XX_PREEMPT_COUNTER_SIZE (16 * 4)
130 
131 
132 int a5xx_power_init(struct msm_gpu *gpu);
133 void a5xx_gpmu_ucode_init(struct msm_gpu *gpu);
134 
135 static inline int spin_usecs(struct msm_gpu *gpu, uint32_t usecs,
136 		uint32_t reg, uint32_t mask, uint32_t value)
137 {
138 	while (usecs--) {
139 		udelay(1);
140 		if ((gpu_read(gpu, reg) & mask) == value)
141 			return 0;
142 		cpu_relax();
143 	}
144 
145 	return -ETIMEDOUT;
146 }
147 
148 bool a5xx_idle(struct msm_gpu *gpu, struct msm_ringbuffer *ring);
149 void a5xx_set_hwcg(struct msm_gpu *gpu, bool state);
150 
151 void a5xx_preempt_init(struct msm_gpu *gpu);
152 void a5xx_preempt_hw_init(struct msm_gpu *gpu);
153 void a5xx_preempt_trigger(struct msm_gpu *gpu);
154 void a5xx_preempt_irq(struct msm_gpu *gpu);
155 void a5xx_preempt_fini(struct msm_gpu *gpu);
156 
157 /* Return true if we are in a preempt state */
158 static inline bool a5xx_in_preempt(struct a5xx_gpu *a5xx_gpu)
159 {
160 	int preempt_state = atomic_read(&a5xx_gpu->preempt_state);
161 
162 	return !(preempt_state == PREEMPT_NONE ||
163 			preempt_state == PREEMPT_ABORT);
164 }
165 
166 #endif /* __A5XX_GPU_H__ */
167