1 /* 2 * Copyright (C) 2013 Red Hat 3 * Author: Rob Clark <robdclark@gmail.com> 4 * 5 * Permission is hereby granted, free of charge, to any person obtaining a 6 * copy of this software and associated documentation files (the "Software"), 7 * to deal in the Software without restriction, including without limitation 8 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 9 * and/or sell copies of the Software, and to permit persons to whom the 10 * Software is furnished to do so, subject to the following conditions: 11 * 12 * The above copyright notice and this permission notice (including the next 13 * paragraph) shall be included in all copies or substantial portions of the 14 * Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 * SOFTWARE. 23 */ 24 25 #ifndef __MSM_DRM_H__ 26 #define __MSM_DRM_H__ 27 28 #include "drm.h" 29 30 #if defined(__cplusplus) 31 extern "C" { 32 #endif 33 34 /* Please note that modifications to all structs defined here are 35 * subject to backwards-compatibility constraints: 36 * 1) Do not use pointers, use __u64 instead for 32 bit / 64 bit 37 * user/kernel compatibility 38 * 2) Keep fields aligned to their size 39 * 3) Because of how drm_ioctl() works, we can add new fields at 40 * the end of an ioctl if some care is taken: drm_ioctl() will 41 * zero out the new fields at the tail of the ioctl, so a zero 42 * value should have a backwards compatible meaning. And for 43 * output params, userspace won't see the newly added output 44 * fields.. so that has to be somehow ok. 45 */ 46 47 #define MSM_PIPE_NONE 0x00 48 #define MSM_PIPE_2D0 0x01 49 #define MSM_PIPE_2D1 0x02 50 #define MSM_PIPE_3D0 0x10 51 52 /* The pipe-id just uses the lower bits, so can be OR'd with flags in 53 * the upper 16 bits (which could be extended further, if needed, maybe 54 * we extend/overload the pipe-id some day to deal with multiple rings, 55 * but even then I don't think we need the full lower 16 bits). 56 */ 57 #define MSM_PIPE_ID_MASK 0xffff 58 #define MSM_PIPE_ID(x) ((x) & MSM_PIPE_ID_MASK) 59 #define MSM_PIPE_FLAGS(x) ((x) & ~MSM_PIPE_ID_MASK) 60 61 /* timeouts are specified in clock-monotonic absolute times (to simplify 62 * restarting interrupted ioctls). The following struct is logically the 63 * same as 'struct timespec' but 32/64b ABI safe. 64 */ 65 struct drm_msm_timespec { 66 __s64 tv_sec; /* seconds */ 67 __s64 tv_nsec; /* nanoseconds */ 68 }; 69 70 /* Below "RO" indicates a read-only param, "WO" indicates write-only, and 71 * "RW" indicates a param that can be both read (GET_PARAM) and written 72 * (SET_PARAM) 73 */ 74 #define MSM_PARAM_GPU_ID 0x01 /* RO */ 75 #define MSM_PARAM_GMEM_SIZE 0x02 /* RO */ 76 #define MSM_PARAM_CHIP_ID 0x03 /* RO */ 77 #define MSM_PARAM_MAX_FREQ 0x04 /* RO */ 78 #define MSM_PARAM_TIMESTAMP 0x05 /* RO */ 79 #define MSM_PARAM_GMEM_BASE 0x06 /* RO */ 80 #define MSM_PARAM_PRIORITIES 0x07 /* RO: The # of priority levels */ 81 #define MSM_PARAM_PP_PGTABLE 0x08 /* RO: Deprecated, always returns zero */ 82 #define MSM_PARAM_FAULTS 0x09 /* RO */ 83 #define MSM_PARAM_SUSPENDS 0x0a /* RO */ 84 #define MSM_PARAM_SYSPROF 0x0b /* WO: 1 preserves perfcntrs, 2 also disables suspend */ 85 86 /* For backwards compat. The original support for preemption was based on 87 * a single ring per priority level so # of priority levels equals the # 88 * of rings. With drm/scheduler providing additional levels of priority, 89 * the number of priorities is greater than the # of rings. The param is 90 * renamed to better reflect this. 91 */ 92 #define MSM_PARAM_NR_RINGS MSM_PARAM_PRIORITIES 93 94 struct drm_msm_param { 95 __u32 pipe; /* in, MSM_PIPE_x */ 96 __u32 param; /* in, MSM_PARAM_x */ 97 __u64 value; /* out (get_param) or in (set_param) */ 98 }; 99 100 /* 101 * GEM buffers: 102 */ 103 104 #define MSM_BO_SCANOUT 0x00000001 /* scanout capable */ 105 #define MSM_BO_GPU_READONLY 0x00000002 106 #define MSM_BO_CACHE_MASK 0x000f0000 107 /* cache modes */ 108 #define MSM_BO_CACHED 0x00010000 109 #define MSM_BO_WC 0x00020000 110 #define MSM_BO_UNCACHED 0x00040000 /* deprecated, use MSM_BO_WC */ 111 #define MSM_BO_CACHED_COHERENT 0x080000 112 113 #define MSM_BO_FLAGS (MSM_BO_SCANOUT | \ 114 MSM_BO_GPU_READONLY | \ 115 MSM_BO_CACHE_MASK) 116 117 struct drm_msm_gem_new { 118 __u64 size; /* in */ 119 __u32 flags; /* in, mask of MSM_BO_x */ 120 __u32 handle; /* out */ 121 }; 122 123 /* Get or set GEM buffer info. The requested value can be passed 124 * directly in 'value', or for data larger than 64b 'value' is a 125 * pointer to userspace buffer, with 'len' specifying the number of 126 * bytes copied into that buffer. For info returned by pointer, 127 * calling the GEM_INFO ioctl with null 'value' will return the 128 * required buffer size in 'len' 129 */ 130 #define MSM_INFO_GET_OFFSET 0x00 /* get mmap() offset, returned by value */ 131 #define MSM_INFO_GET_IOVA 0x01 /* get iova, returned by value */ 132 #define MSM_INFO_SET_NAME 0x02 /* set the debug name (by pointer) */ 133 #define MSM_INFO_GET_NAME 0x03 /* get debug name, returned by pointer */ 134 135 struct drm_msm_gem_info { 136 __u32 handle; /* in */ 137 __u32 info; /* in - one of MSM_INFO_* */ 138 __u64 value; /* in or out */ 139 __u32 len; /* in or out */ 140 __u32 pad; 141 }; 142 143 #define MSM_PREP_READ 0x01 144 #define MSM_PREP_WRITE 0x02 145 #define MSM_PREP_NOSYNC 0x04 146 147 #define MSM_PREP_FLAGS (MSM_PREP_READ | MSM_PREP_WRITE | MSM_PREP_NOSYNC) 148 149 struct drm_msm_gem_cpu_prep { 150 __u32 handle; /* in */ 151 __u32 op; /* in, mask of MSM_PREP_x */ 152 struct drm_msm_timespec timeout; /* in */ 153 }; 154 155 struct drm_msm_gem_cpu_fini { 156 __u32 handle; /* in */ 157 }; 158 159 /* 160 * Cmdstream Submission: 161 */ 162 163 /* The value written into the cmdstream is logically: 164 * 165 * ((relocbuf->gpuaddr + reloc_offset) << shift) | or 166 * 167 * When we have GPU's w/ >32bit ptrs, it should be possible to deal 168 * with this by emit'ing two reloc entries with appropriate shift 169 * values. Or a new MSM_SUBMIT_CMD_x type would also be an option. 170 * 171 * NOTE that reloc's must be sorted by order of increasing submit_offset, 172 * otherwise EINVAL. 173 */ 174 struct drm_msm_gem_submit_reloc { 175 __u32 submit_offset; /* in, offset from submit_bo */ 176 __u32 or; /* in, value OR'd with result */ 177 __s32 shift; /* in, amount of left shift (can be negative) */ 178 __u32 reloc_idx; /* in, index of reloc_bo buffer */ 179 __u64 reloc_offset; /* in, offset from start of reloc_bo */ 180 }; 181 182 /* submit-types: 183 * BUF - this cmd buffer is executed normally. 184 * IB_TARGET_BUF - this cmd buffer is an IB target. Reloc's are 185 * processed normally, but the kernel does not setup an IB to 186 * this buffer in the first-level ringbuffer 187 * CTX_RESTORE_BUF - only executed if there has been a GPU context 188 * switch since the last SUBMIT ioctl 189 */ 190 #define MSM_SUBMIT_CMD_BUF 0x0001 191 #define MSM_SUBMIT_CMD_IB_TARGET_BUF 0x0002 192 #define MSM_SUBMIT_CMD_CTX_RESTORE_BUF 0x0003 193 struct drm_msm_gem_submit_cmd { 194 __u32 type; /* in, one of MSM_SUBMIT_CMD_x */ 195 __u32 submit_idx; /* in, index of submit_bo cmdstream buffer */ 196 __u32 submit_offset; /* in, offset into submit_bo */ 197 __u32 size; /* in, cmdstream size */ 198 __u32 pad; 199 __u32 nr_relocs; /* in, number of submit_reloc's */ 200 __u64 relocs; /* in, ptr to array of submit_reloc's */ 201 }; 202 203 /* Each buffer referenced elsewhere in the cmdstream submit (ie. the 204 * cmdstream buffer(s) themselves or reloc entries) has one (and only 205 * one) entry in the submit->bos[] table. 206 * 207 * As a optimization, the current buffer (gpu virtual address) can be 208 * passed back through the 'presumed' field. If on a subsequent reloc, 209 * userspace passes back a 'presumed' address that is still valid, 210 * then patching the cmdstream for this entry is skipped. This can 211 * avoid kernel needing to map/access the cmdstream bo in the common 212 * case. 213 */ 214 #define MSM_SUBMIT_BO_READ 0x0001 215 #define MSM_SUBMIT_BO_WRITE 0x0002 216 #define MSM_SUBMIT_BO_DUMP 0x0004 217 218 #define MSM_SUBMIT_BO_FLAGS (MSM_SUBMIT_BO_READ | \ 219 MSM_SUBMIT_BO_WRITE | \ 220 MSM_SUBMIT_BO_DUMP) 221 222 struct drm_msm_gem_submit_bo { 223 __u32 flags; /* in, mask of MSM_SUBMIT_BO_x */ 224 __u32 handle; /* in, GEM handle */ 225 __u64 presumed; /* in/out, presumed buffer address */ 226 }; 227 228 /* Valid submit ioctl flags: */ 229 #define MSM_SUBMIT_NO_IMPLICIT 0x80000000 /* disable implicit sync */ 230 #define MSM_SUBMIT_FENCE_FD_IN 0x40000000 /* enable input fence_fd */ 231 #define MSM_SUBMIT_FENCE_FD_OUT 0x20000000 /* enable output fence_fd */ 232 #define MSM_SUBMIT_SUDO 0x10000000 /* run submitted cmds from RB */ 233 #define MSM_SUBMIT_SYNCOBJ_IN 0x08000000 /* enable input syncobj */ 234 #define MSM_SUBMIT_SYNCOBJ_OUT 0x04000000 /* enable output syncobj */ 235 #define MSM_SUBMIT_FENCE_SN_IN 0x02000000 /* userspace passes in seqno fence */ 236 #define MSM_SUBMIT_FLAGS ( \ 237 MSM_SUBMIT_NO_IMPLICIT | \ 238 MSM_SUBMIT_FENCE_FD_IN | \ 239 MSM_SUBMIT_FENCE_FD_OUT | \ 240 MSM_SUBMIT_SUDO | \ 241 MSM_SUBMIT_SYNCOBJ_IN | \ 242 MSM_SUBMIT_SYNCOBJ_OUT | \ 243 MSM_SUBMIT_FENCE_SN_IN | \ 244 0) 245 246 #define MSM_SUBMIT_SYNCOBJ_RESET 0x00000001 /* Reset syncobj after wait. */ 247 #define MSM_SUBMIT_SYNCOBJ_FLAGS ( \ 248 MSM_SUBMIT_SYNCOBJ_RESET | \ 249 0) 250 251 struct drm_msm_gem_submit_syncobj { 252 __u32 handle; /* in, syncobj handle. */ 253 __u32 flags; /* in, from MSM_SUBMIT_SYNCOBJ_FLAGS */ 254 __u64 point; /* in, timepoint for timeline syncobjs. */ 255 }; 256 257 /* Each cmdstream submit consists of a table of buffers involved, and 258 * one or more cmdstream buffers. This allows for conditional execution 259 * (context-restore), and IB buffers needed for per tile/bin draw cmds. 260 */ 261 struct drm_msm_gem_submit { 262 __u32 flags; /* MSM_PIPE_x | MSM_SUBMIT_x */ 263 __u32 fence; /* out (or in with MSM_SUBMIT_FENCE_SN_IN flag) */ 264 __u32 nr_bos; /* in, number of submit_bo's */ 265 __u32 nr_cmds; /* in, number of submit_cmd's */ 266 __u64 bos; /* in, ptr to array of submit_bo's */ 267 __u64 cmds; /* in, ptr to array of submit_cmd's */ 268 __s32 fence_fd; /* in/out fence fd (see MSM_SUBMIT_FENCE_FD_IN/OUT) */ 269 __u32 queueid; /* in, submitqueue id */ 270 __u64 in_syncobjs; /* in, ptr to array of drm_msm_gem_submit_syncobj */ 271 __u64 out_syncobjs; /* in, ptr to array of drm_msm_gem_submit_syncobj */ 272 __u32 nr_in_syncobjs; /* in, number of entries in in_syncobj */ 273 __u32 nr_out_syncobjs; /* in, number of entries in out_syncobj. */ 274 __u32 syncobj_stride; /* in, stride of syncobj arrays. */ 275 __u32 pad; /*in, reserved for future use, always 0. */ 276 277 }; 278 279 /* The normal way to synchronize with the GPU is just to CPU_PREP on 280 * a buffer if you need to access it from the CPU (other cmdstream 281 * submission from same or other contexts, PAGE_FLIP ioctl, etc, all 282 * handle the required synchronization under the hood). This ioctl 283 * mainly just exists as a way to implement the gallium pipe_fence 284 * APIs without requiring a dummy bo to synchronize on. 285 */ 286 struct drm_msm_wait_fence { 287 __u32 fence; /* in */ 288 __u32 pad; 289 struct drm_msm_timespec timeout; /* in */ 290 __u32 queueid; /* in, submitqueue id */ 291 }; 292 293 /* madvise provides a way to tell the kernel in case a buffers contents 294 * can be discarded under memory pressure, which is useful for userspace 295 * bo cache where we want to optimistically hold on to buffer allocate 296 * and potential mmap, but allow the pages to be discarded under memory 297 * pressure. 298 * 299 * Typical usage would involve madvise(DONTNEED) when buffer enters BO 300 * cache, and madvise(WILLNEED) if trying to recycle buffer from BO cache. 301 * In the WILLNEED case, 'retained' indicates to userspace whether the 302 * backing pages still exist. 303 */ 304 #define MSM_MADV_WILLNEED 0 /* backing pages are needed, status returned in 'retained' */ 305 #define MSM_MADV_DONTNEED 1 /* backing pages not needed */ 306 #define __MSM_MADV_PURGED 2 /* internal state */ 307 308 struct drm_msm_gem_madvise { 309 __u32 handle; /* in, GEM handle */ 310 __u32 madv; /* in, MSM_MADV_x */ 311 __u32 retained; /* out, whether backing store still exists */ 312 }; 313 314 /* 315 * Draw queues allow the user to set specific submission parameter. Command 316 * submissions specify a specific submitqueue to use. ID 0 is reserved for 317 * backwards compatibility as a "default" submitqueue 318 */ 319 320 #define MSM_SUBMITQUEUE_FLAGS (0) 321 322 /* 323 * The submitqueue priority should be between 0 and MSM_PARAM_PRIORITIES-1, 324 * a lower numeric value is higher priority. 325 */ 326 struct drm_msm_submitqueue { 327 __u32 flags; /* in, MSM_SUBMITQUEUE_x */ 328 __u32 prio; /* in, Priority level */ 329 __u32 id; /* out, identifier */ 330 }; 331 332 #define MSM_SUBMITQUEUE_PARAM_FAULTS 0 333 334 struct drm_msm_submitqueue_query { 335 __u64 data; 336 __u32 id; 337 __u32 param; 338 __u32 len; 339 __u32 pad; 340 }; 341 342 #define DRM_MSM_GET_PARAM 0x00 343 #define DRM_MSM_SET_PARAM 0x01 344 #define DRM_MSM_GEM_NEW 0x02 345 #define DRM_MSM_GEM_INFO 0x03 346 #define DRM_MSM_GEM_CPU_PREP 0x04 347 #define DRM_MSM_GEM_CPU_FINI 0x05 348 #define DRM_MSM_GEM_SUBMIT 0x06 349 #define DRM_MSM_WAIT_FENCE 0x07 350 #define DRM_MSM_GEM_MADVISE 0x08 351 /* placeholder: 352 #define DRM_MSM_GEM_SVM_NEW 0x09 353 */ 354 #define DRM_MSM_SUBMITQUEUE_NEW 0x0A 355 #define DRM_MSM_SUBMITQUEUE_CLOSE 0x0B 356 #define DRM_MSM_SUBMITQUEUE_QUERY 0x0C 357 358 #define DRM_IOCTL_MSM_GET_PARAM DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GET_PARAM, struct drm_msm_param) 359 #define DRM_IOCTL_MSM_SET_PARAM DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_SET_PARAM, struct drm_msm_param) 360 #define DRM_IOCTL_MSM_GEM_NEW DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GEM_NEW, struct drm_msm_gem_new) 361 #define DRM_IOCTL_MSM_GEM_INFO DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GEM_INFO, struct drm_msm_gem_info) 362 #define DRM_IOCTL_MSM_GEM_CPU_PREP DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_GEM_CPU_PREP, struct drm_msm_gem_cpu_prep) 363 #define DRM_IOCTL_MSM_GEM_CPU_FINI DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_GEM_CPU_FINI, struct drm_msm_gem_cpu_fini) 364 #define DRM_IOCTL_MSM_GEM_SUBMIT DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GEM_SUBMIT, struct drm_msm_gem_submit) 365 #define DRM_IOCTL_MSM_WAIT_FENCE DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_WAIT_FENCE, struct drm_msm_wait_fence) 366 #define DRM_IOCTL_MSM_GEM_MADVISE DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GEM_MADVISE, struct drm_msm_gem_madvise) 367 #define DRM_IOCTL_MSM_SUBMITQUEUE_NEW DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_SUBMITQUEUE_NEW, struct drm_msm_submitqueue) 368 #define DRM_IOCTL_MSM_SUBMITQUEUE_CLOSE DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_SUBMITQUEUE_CLOSE, __u32) 369 #define DRM_IOCTL_MSM_SUBMITQUEUE_QUERY DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_SUBMITQUEUE_QUERY, struct drm_msm_submitqueue_query) 370 371 #if defined(__cplusplus) 372 } 373 #endif 374 375 #endif /* __MSM_DRM_H__ */ 376