| /*************************************************************************/ /*! |
| @File |
| @Title Device Memory Management |
| @Copyright Copyright (c) Imagination Technologies Ltd. All Rights Reserved |
| @Description This file defines flags used on memory allocations and mappings |
| These flags are relevant throughout the memory management |
| software stack and are specified by users of services and |
| understood by all levels of the memory management in both |
| client and server. |
| @License Dual MIT/GPLv2 |
| |
| The contents of this file are subject to the MIT license as set out below. |
| |
| Permission is hereby granted, free of charge, to any person obtaining a copy |
| of this software and associated documentation files (the "Software"), to deal |
| in the Software without restriction, including without limitation the rights |
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| copies of the Software, and to permit persons to whom the Software is |
| furnished to do so, subject to the following conditions: |
| |
| The above copyright notice and this permission notice shall be included in |
| all copies or substantial portions of the Software. |
| |
| Alternatively, the contents of this file may be used under the terms of |
| the GNU General Public License Version 2 ("GPL") in which case the provisions |
| of GPL are applicable instead of those above. |
| |
| If you wish to allow use of your version of this file only under the terms of |
| GPL, and not to allow others to use your version of this file under the terms |
| of the MIT license, indicate your decision by deleting the provisions above |
| and replace them with the notice and other provisions required by GPL as set |
| out in the file called "GPL-COPYING" included in this distribution. If you do |
| not delete the provisions above, a recipient may use your version of this file |
| under the terms of either the MIT license or GPL. |
| |
| This License is also included in this distribution in the file called |
| "MIT-COPYING". |
| |
| EXCEPT AS OTHERWISE STATED IN A NEGOTIATED AGREEMENT: (A) THE SOFTWARE IS |
| PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
| BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR |
| PURPOSE AND NONINFRINGEMENT; AND (B) IN NO EVENT SHALL THE AUTHORS OR |
| COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER |
| IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
| CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| */ /**************************************************************************/ |
| |
| #ifndef PVRSRV_MEMALLOCFLAGS_H |
| #define PVRSRV_MEMALLOCFLAGS_H |
| |
| #include "img_types.h" |
| #include "rgx_memallocflags.h" |
| |
| /*! |
| Type for specifying memory allocation flags. |
| */ |
| #if defined(SUPPORT_VALIDATION) |
| typedef IMG_UINT64 PVRSRV_MEMALLOCFLAGS_T; |
| #define PVRSRV_MEMALLOCFLAGS_FMTSPEC IMG_UINT64_FMTSPECx |
| #else |
| typedef IMG_UINT32 PVRSRV_MEMALLOCFLAGS_T; |
| #define PVRSRV_MEMALLOCFLAGS_FMTSPEC "x" |
| #endif |
| |
| |
| /* |
| * --- MAPPING FLAGS --- |
| * | 0-3 | 4-7 | 8-10 | 11-13 | 14 | |
| * | GPU-RW | CPU-RW | GPU-Caching | CPU-Caching | KM-Mappable | |
| * |
| * --- MISC FLAGS --- |
| * | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | |
| * | Defer | CPU-Local | FW-Local | SVM | Sparse-Dummy-Page | CPU-Cache-Clean | FW-Config | FW-Guest | |
| * |
| * --- DEV CONTROL FLAGS --- |
| * | 24-27 | |
| * | Device-Flags | |
| * |
| * --- MEMSET FLAGS --- |
| * | 29 | 30 | 31 | |
| * | Poison-On-Free | P.-On-Alloc | Zero-On-Alloc | |
| * |
| */ |
| |
| /* |
| * ********************************************************** |
| * * * |
| * * MAPPING FLAGS * |
| * * * |
| * ********************************************************** |
| */ |
| |
| /*! |
| * This flag affects the device MMU protection flags, and specifies |
| * that the memory may be read by the GPU. |
| * |
| * Typically all device memory allocations would specify this flag. |
| * |
| * At the moment, memory allocations without this flag are not supported |
| * |
| * This flag will live with the PMR, thus subsequent mappings would |
| * honour this flag. |
| * |
| * This is a dual purpose flag. It specifies that memory is permitted |
| * to be read by the GPU, and also requests that the allocation is |
| * mapped into the GPU as a readable mapping |
| * |
| * To be clear: |
| * - When used as an argument on PMR creation; it specifies |
| * that GPU readable mappings will be _permitted_ |
| * - When used as an argument to a "map" function: it specifies |
| * that a GPU readable mapping is _desired_ |
| * - When used as an argument to "AllocDeviceMem": it specifies |
| * that the PMR will be created with permission to be mapped |
| * with a GPU readable mapping, _and_ that this PMR will be |
| * mapped with a GPU readable mapping. |
| * This distinction becomes important when (a) we export allocations; |
| * and (b) when we separate the creation of the PMR from the mapping. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_GPU_READABLE (1U<<0) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_GPU_READABLE flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_GPU_READABLE(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_GPU_READABLE) != 0) |
| |
| /*! |
| * This flag affects the device MMU protection flags, and specifies |
| * that the memory may be written by the GPU |
| * |
| * Using this flag on an allocation signifies that the allocation is |
| * intended to be written by the GPU. |
| * |
| * Omitting this flag causes a read-only mapping. |
| * |
| * This flag will live with the PMR, thus subsequent mappings would |
| * honour this flag. |
| * |
| * This is a dual purpose flag. It specifies that memory is permitted |
| * to be written by the GPU, and also requests that the allocation is |
| * mapped into the GPU as a writable mapping (see note above about |
| * permission vs. mapping mode, and why this flag causes permissions |
| * to be inferred from mapping mode on first allocation) |
| * |
| * N.B. This flag has no relevance to the CPU's MMU mapping, if any, |
| * and would therefore not enforce read-only mapping on CPU. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_GPU_WRITEABLE (1U<<1) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_GPU_WRITEABLE flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_GPU_WRITEABLE(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_GPU_WRITEABLE) != 0) |
| |
| /*! |
| The flag indicates whether an allocation can be mapped as GPU readable in another GPU memory context. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_GPU_READ_PERMITTED (1U<<2) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_GPU_READ_PERMITTED flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_GPU_READ_PERMITTED(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_GPU_READ_PERMITTED) != 0) |
| |
| /*! |
| The flag indicates whether an allocation can be mapped as GPU writable in another GPU memory context. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_GPU_WRITE_PERMITTED (1U<<3) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_GPU_WRITE_PERMITTED flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_GPU_WRITE_PERMITTED(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_GPU_WRITE_PERMITTED) != 0) |
| |
| /*! |
| The flag indicates that an allocation is mapped as readable to the CPU. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CPU_READABLE (1U<<4) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_CPU_READABLE flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_CPU_READABLE(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_CPU_READABLE) != 0) |
| |
| /*! |
| The flag indicates that an allocation is mapped as writable to the CPU. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CPU_WRITEABLE (1U<<5) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_CPU_WRITEABLE flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_CPU_WRITEABLE(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_CPU_WRITEABLE) != 0) |
| |
| /*! |
| The flag indicates whether an allocation can be mapped as CPU readable in another CPU memory context. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CPU_READ_PERMITTED (1U<<6) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_CPU_READ_PERMITTED flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_CPU_READ_PERMITTED(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_CPU_READ_PERMITTED) != 0) |
| |
| /*! |
| The flag indicates whether an allocation can be mapped as CPU writable in another CPU memory context. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CPU_WRITE_PERMITTED (1U<<7) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_CPU_WRITE_PERMITTED flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_CPU_WRITE_PERMITTED(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_CPU_WRITE_PERMITTED) != 0) |
| |
| |
| /* |
| * ********************************************************** |
| * * * |
| * * CACHE CONTROL FLAGS * |
| * * * |
| * ********************************************************** |
| */ |
| |
| /* |
| GPU domain |
| ========== |
| |
| The following defines are used to control the GPU cache bit field. |
| The defines are mutually exclusive. |
| |
| A helper macro, PVRSRV_GPU_CACHE_MODE, is provided to obtain just the GPU |
| cache bit field from the flags. This should be used whenever the GPU cache |
| mode needs to be determined. |
| */ |
| |
| /*! |
| GPU domain. Flag indicating uncached memory. This means that any writes to memory |
| allocated with this flag are written straight to memory and thus are |
| coherent for any device in the system. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_GPU_UNCACHED (0U<<8) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_GPU_UNCACHED mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_GPU_UNCACHED(uiFlags) (PVRSRV_GPU_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_GPU_UNCACHED) |
| |
| /*! |
| GPU domain. Use write combiner (if supported) to combine sequential writes |
| together to reduce memory access by doing burst writes. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_GPU_WRITE_COMBINE (1U<<8) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_GPU_WRITE_COMBINE mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_GPU_WRITE_COMBINE(uiFlags) (PVRSRV_GPU_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_GPU_WRITE_COMBINE) |
| |
| /*! |
| GPU domain. This flag affects the GPU MMU protection flags. |
| The allocation will be cached. |
| Services will try to set the coherent bit in the GPU MMU tables so the |
| GPU cache is snooping the CPU cache. If coherency is not supported the |
| caller is responsible to ensure the caches are up to date. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_GPU_CACHE_COHERENT (2U<<8) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_GPU_CACHE_COHERENT mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_GPU_CACHE_COHERENT(uiFlags) (PVRSRV_GPU_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_GPU_CACHE_COHERENT) |
| |
| /*! |
| GPU domain. Request cached memory, but not coherent (i.e. no cache |
| snooping). Services will flush the GPU internal caches after every GPU |
| task so no cache maintenance requests from the users are necessary. |
| |
| Note: We reserve 3 bits in the CPU/GPU cache mode to allow for future |
| expansion. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_GPU_CACHE_INCOHERENT (3U<<8) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_GPU_CACHE_INCOHERENT mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_GPU_CACHE_INCOHERENT(uiFlags) (PVRSRV_GPU_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_GPU_CACHE_INCOHERENT) |
| |
| /*! |
| GPU domain. This flag is for internal use only and is used to indicate |
| that the underlying allocation should be cached on the GPU after all |
| the snooping and coherent checks have been done |
| */ |
| #define PVRSRV_MEMALLOCFLAG_GPU_CACHED (7U<<8) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_GPU_CACHED mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_GPU_CACHED(uiFlags) (PVRSRV_GPU_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_GPU_CACHED) |
| |
| /*! |
| GPU domain. GPU cache mode mask. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_GPU_CACHE_MODE_MASK (7U<<8) |
| |
| /*! |
| @Description A helper macro to obtain just the GPU cache bit field from the flags. |
| This should be used whenever the GPU cache mode needs to be determined. |
| @Input uiFlags Allocation flags. |
| @Return Value of the GPU cache bit field. |
| */ |
| #define PVRSRV_GPU_CACHE_MODE(uiFlags) ((uiFlags) & PVRSRV_MEMALLOCFLAG_GPU_CACHE_MODE_MASK) |
| |
| |
| /* |
| CPU domain |
| ========== |
| |
| The following defines are used to control the CPU cache bit field. |
| The defines are mutually exclusive. |
| |
| A helper macro, PVRSRV_CPU_CACHE_MODE, is provided to obtain just the CPU |
| cache bit field from the flags. This should be used whenever the CPU cache |
| mode needs to be determined. |
| */ |
| |
| /*! |
| CPU domain. Request uncached memory. This means that any writes to memory |
| allocated with this flag are written straight to memory and thus are |
| coherent for any device in the system. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CPU_UNCACHED (0U<<11) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_CPU_UNCACHED mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_CPU_UNCACHED(uiFlags) (PVRSRV_CPU_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_CPU_UNCACHED) |
| |
| /*! |
| CPU domain. Use write combiner (if supported) to combine sequential writes |
| together to reduce memory access by doing burst writes. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CPU_WRITE_COMBINE (1U<<11) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_CPU_WRITE_COMBINE mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_CPU_WRITE_COMBINE(uiFlags) (PVRSRV_CPU_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_CPU_WRITE_COMBINE) |
| |
| /*! |
| CPU domain. This flag affects the CPU MMU protection flags. |
| The allocation will be cached. |
| Services will try to set the coherent bit in the CPU MMU tables so the |
| CPU cache is snooping the GPU cache. If coherency is not supported the |
| caller is responsible to ensure the caches are up to date. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CPU_CACHE_COHERENT (2U<<11) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_CPU_CACHE_COHERENT mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_CPU_CACHE_COHERENT(uiFlags) (PVRSRV_CPU_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_CPU_CACHE_COHERENT) |
| |
| /*! |
| CPU domain. Request cached memory, but not coherent (i.e. no cache |
| snooping). This means that if the allocation needs to transition from |
| one device to another services has to be informed so it can |
| flush/invalidate the appropriate caches. |
| |
| Note: We reserve 3 bits in the CPU/GPU cache mode to allow for future |
| expansion. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CPU_CACHE_INCOHERENT (3U<<11) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_CPU_CACHE_INCOHERENT mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_CPU_CACHE_INCOHERENT(uiFlags) (PVRSRV_CPU_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_CPU_CACHE_INCOHERENT) |
| |
| /*! |
| CPU domain. This flag is for internal use only and is used to indicate |
| that the underlying allocation should be cached on the CPU |
| after all the snooping and coherent checks have been done |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CPU_CACHED (7U<<11) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_CPU_CACHED mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_CPU_CACHED(uiFlags) (PVRSRV_CPU_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_CPU_CACHED) |
| |
| /*! |
| CPU domain. CPU cache mode mask |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CPU_CACHE_MODE_MASK (7U<<11) |
| |
| /*! |
| @Description A helper macro to obtain just the CPU cache bit field from the flags. |
| This should be used whenever the CPU cache mode needs to be determined. |
| @Input uiFlags Allocation flags. |
| @Return Value of the CPU cache bit field. |
| */ |
| #define PVRSRV_CPU_CACHE_MODE(uiFlags) ((uiFlags) & PVRSRV_MEMALLOCFLAG_CPU_CACHE_MODE_MASK) |
| |
| /* Helper flags for usual cases */ |
| |
| /*! |
| * Memory will be uncached on CPU and GPU |
| */ |
| #define PVRSRV_MEMALLOCFLAG_UNCACHED (PVRSRV_MEMALLOCFLAG_GPU_UNCACHED | PVRSRV_MEMALLOCFLAG_CPU_UNCACHED) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_UNCACHED mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_UNCACHED(uiFlags) (PVRSRV_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_UNCACHED) |
| |
| /*! |
| * Memory will be write-combined on CPU and GPU |
| */ |
| #define PVRSRV_MEMALLOCFLAG_WRITE_COMBINE (PVRSRV_MEMALLOCFLAG_GPU_WRITE_COMBINE | PVRSRV_MEMALLOCFLAG_CPU_WRITE_COMBINE) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_WRITE_COMBINE mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_WRITE_COMBINE(uiFlags) (PVRSRV_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_WRITE_COMBINE) |
| |
| /*! |
| * Memory will be cache-incoherent on CPU and GPU |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CACHE_INCOHERENT (PVRSRV_MEMALLOCFLAG_GPU_CACHE_INCOHERENT | PVRSRV_MEMALLOCFLAG_CPU_CACHE_INCOHERENT) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_CACHE_INCOHERENT mode is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the mode is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_CACHE_INCOHERENT(uiFlags) (PVRSRV_CACHE_MODE(uiFlags) == PVRSRV_MEMALLOCFLAG_CACHE_INCOHERENT) |
| |
| /*! |
| Cache mode mask |
| */ |
| #define PVRSRV_CACHE_MODE(uiFlags) (PVRSRV_GPU_CACHE_MODE(uiFlags) | PVRSRV_CPU_CACHE_MODE(uiFlags)) |
| |
| |
| /*! |
| CPU MMU Flags mask -- intended for use internal to services only |
| */ |
| #define PVRSRV_MEMALLOCFLAGS_CPU_MMUFLAGSMASK (PVRSRV_MEMALLOCFLAG_CPU_READABLE | \ |
| PVRSRV_MEMALLOCFLAG_CPU_WRITEABLE | \ |
| PVRSRV_MEMALLOCFLAG_CPU_CACHE_MODE_MASK) |
| |
| /*! |
| MMU Flags mask -- intended for use internal to services only - used for |
| partitioning the flags bits and determining which flags to pass down to |
| mmu_common.c |
| */ |
| #define PVRSRV_MEMALLOCFLAGS_GPU_MMUFLAGSMASK (PVRSRV_MEMALLOCFLAG_GPU_READABLE | \ |
| PVRSRV_MEMALLOCFLAG_GPU_WRITEABLE | \ |
| PVRSRV_MEMALLOCFLAG_GPU_CACHE_MODE_MASK) |
| |
| /*! |
| Indicates that the PMR created due to this allocation will support |
| in-kernel CPU mappings. Only privileged processes may use this flag as |
| it may cause wastage of precious kernel virtual memory on some platforms. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_KERNEL_CPU_MAPPABLE (1U<<14) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_KERNEL_CPU_MAPPABLE flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_KERNEL_CPU_MAPPABLE(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_KERNEL_CPU_MAPPABLE) != 0) |
| |
| |
| |
| /* |
| * |
| * ********************************************************** |
| * * * |
| * * ALLOC MEMORY FLAGS * |
| * * * |
| * ********************************************************** |
| * |
| * (Bits 15) |
| * |
| */ |
| #define PVRSRV_MEMALLOCFLAG_NO_OSPAGES_ON_ALLOC (1U<<15) |
| #define PVRSRV_CHECK_ON_DEMAND(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_NO_OSPAGES_ON_ALLOC) != 0) |
| |
| /*! |
| Indicates that the allocation will primarily be accessed by the CPU, so |
| a UMA allocation (if available) is preferable. If not set, the allocation |
| will primarily be accessed by the GPU, so LMA allocation (if available) |
| is preferable. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CPU_LOCAL (1U<<16) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_CPU_LOCAL flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_CPU_LOCAL(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_CPU_LOCAL) != 0) |
| |
| |
| /*! |
| Indicates that the allocation will primarily be accessed by the FW. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_FW_LOCAL (1U<<17) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_FW_LOCAL flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_FW_LOCAL(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_FW_LOCAL) != 0) |
| |
| /*! |
| Indicates that the allocation will be accessed by the CPU and GPU using |
| the same virtual address, i.e. for all SVM allocs, |
| IMG_CPU_VIRTADDR == IMG_DEV_VIRTADDR |
| */ |
| #define PVRSRV_MEMALLOCFLAG_SVM_ALLOC (1U<<18) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_SVM_ALLOC flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_SVM_ALLOC(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_SVM_ALLOC) != 0) |
| |
| /*! |
| Indicates the particular memory that's being allocated is sparse and the |
| sparse regions should not be backed by dummy page |
| */ |
| #define PVRSRV_MEMALLOCFLAG_SPARSE_NO_DUMMY_BACKING (1U << 19) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_SPARSE_NO_DUMMY_BACKING flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_IS_SPARSE_DUMMY_BACKING_REQUIRED(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_SPARSE_NO_DUMMY_BACKING) == 0) |
| |
| /*! |
| Services is going to clean the cache for the allocated memory. |
| For performance reasons avoid usage if allocation is written to by the |
| CPU anyway before the next GPU kick. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_CPU_CACHE_CLEAN (1U<<20) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_CPU_CACHE_CLEAN flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_CPU_CACHE_CLEAN(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_CPU_CACHE_CLEAN) != 0) |
| |
| /*! |
| * Indicates that the particular allocation will exist at the FW Config heap |
| * residing right after the end of the FW Main heap |
| */ |
| #define PVRSRV_MEMALLOCFLAG_FW_CONFIG (1U<<21) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_FW_CONFIG flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_FW_CONFIG(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_FW_CONFIG) != 0) |
| |
| /*! |
| * Indicates that the particular allocation is being mapped into FW by the |
| * privileged OSID-0 (i.e. host/primary) driver on behalf of an unprivileged |
| * guest OSID-x (i.e. OSID-1 up to OSID-7) driver |
| */ |
| #define PVRSRV_MEMALLOCFLAG_FW_GUEST (1U<<22) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_FW_GUEST flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_FW_GUEST(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_FW_GUEST) != 0) |
| |
| /*! PVRSRV_MEMALLOCFLAG_SPARSE_ZERO_BACKING |
| |
| Indicates the particular memory that's being allocated is sparse and the |
| sparse regions should be backed by zero page. This is different with |
| zero on alloc flag such that only physically unbacked pages are backed |
| by zero page at the time of mapping. |
| The zero backed page is always with read only attribute irrespective of its |
| original attributes. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_SPARSE_ZERO_BACKING (1U << 23) |
| #define PVRSRV_IS_SPARSE_ZERO_BACKING_REQUIRED(uiFlags) (((uiFlags) & \ |
| PVRSRV_MEMALLOCFLAG_SPARSE_ZERO_BACKING) == PVRSRV_MEMALLOCFLAG_SPARSE_ZERO_BACKING) |
| |
| |
| /* |
| * |
| * ********************************************************** |
| * * * |
| * * MEMORY ZEROING AND POISONING FLAGS * |
| * * * |
| * ********************************************************** |
| * |
| * Zero / Poison, on alloc/free |
| * |
| * We think the following usecases are required: |
| * |
| * don't poison or zero on alloc or free |
| * (normal operation, also most efficient) |
| * poison on alloc |
| * (for helping to highlight bugs) |
| * poison on alloc and free |
| * (for helping to highlight bugs) |
| * zero on alloc |
| * (avoid highlighting security issues in other uses of memory) |
| * zero on alloc and poison on free |
| * (avoid highlighting security issues in other uses of memory, while |
| * helping to highlight a subset of bugs e.g. memory freed prematurely) |
| * |
| * Since there are more than 4, we can't encode this in just two bits, |
| * so we might as well have a separate flag for each of the three |
| * actions. |
| */ |
| |
| /*! |
| Ensures that the memory allocated is initialised with zeroes. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_ZERO_ON_ALLOC (1U<<31) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_ZERO_ON_ALLOC flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_ZERO_ON_ALLOC(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_ZERO_ON_ALLOC) != 0) |
| |
| /*! |
| Scribbles over the allocated memory with a poison value |
| |
| Not compatible with ZERO_ON_ALLOC |
| |
| Poisoning is very deliberately _not_ reflected in PDump as we want |
| a simulation to cry loudly if the initialised data propagates to a |
| result. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_POISON_ON_ALLOC (1U<<30) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_POISON_ON_ALLOC flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_POISON_ON_ALLOC(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_POISON_ON_ALLOC) != 0) |
| |
| /*! |
| Causes memory to be trashed when freed, as a lazy man's security measure. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_POISON_ON_FREE (1U<<29) |
| |
| /*! |
| @Description Macro checking whether the PVRSRV_MEMALLOCFLAG_POISON_ON_FREE flag is set. |
| @Input uiFlags Allocation flags. |
| @Return True if the flag is set, false otherwise |
| */ |
| #define PVRSRV_CHECK_POISON_ON_FREE(uiFlags) (((uiFlags) & PVRSRV_MEMALLOCFLAG_POISON_ON_FREE) != 0) |
| |
| /* |
| * |
| * ********************************************************** |
| * * * |
| * * Device specific MMU flags * |
| * * * |
| * ********************************************************** |
| * |
| * (Bits 24 to 27) |
| * |
| * Some services controlled devices have device specific control bits in |
| * their page table entries, we need to allow these flags to be passed down |
| * the memory management layers so the user can control these bits. |
| * For example, RGX device has the file rgx_memallocflags.h |
| */ |
| |
| /*! |
| * Offset of device specific MMU flags. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_DEVICE_FLAGS_OFFSET 24 |
| |
| /*! |
| * Mask for retrieving device specific MMU flags. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_DEVICE_FLAGS_MASK 0x0f000000UL |
| |
| /*! |
| @Description Helper macro for setting device specific MMU flags. |
| @Input n Flag index. |
| @Return Flag vector with the specified bit set. |
| */ |
| #define PVRSRV_MEMALLOCFLAG_DEVICE_FLAG(n) \ |
| (((n) << PVRSRV_MEMALLOCFLAG_DEVICE_FLAGS_OFFSET) & \ |
| PVRSRV_MEMALLOCFLAG_DEVICE_FLAGS_MASK) |
| |
| |
| /*! |
| * Secure buffer mask -- Flags in the mask are allowed for secure buffers |
| * because they are not related to CPU mappings. |
| */ |
| #define PVRSRV_MEMALLOCFLAGS_SECBUFMASK ~(PVRSRV_MEMALLOCFLAG_CPU_CACHE_MODE_MASK | \ |
| PVRSRV_MEMALLOCFLAG_CPU_WRITEABLE | \ |
| PVRSRV_MEMALLOCFLAG_CPU_READABLE | \ |
| PVRSRV_MEMALLOCFLAG_KERNEL_CPU_MAPPABLE | \ |
| PVRSRV_MEMALLOCFLAG_CPU_CACHE_CLEAN | \ |
| PVRSRV_MEMALLOCFLAG_SVM_ALLOC | \ |
| PVRSRV_MEMALLOCFLAG_CPU_READ_PERMITTED | \ |
| PVRSRV_MEMALLOCFLAG_CPU_WRITE_PERMITTED) |
| |
| |
| |
| /*! |
| PMR flags mask -- for internal services use only. This is the set of flags |
| that will be passed down and stored with the PMR, this also includes the |
| MMU flags which the PMR has to pass down to mm_common.c at PMRMap time. |
| */ |
| #define PVRSRV_MEMALLOCFLAGS_PMRFLAGSMASK (PVRSRV_MEMALLOCFLAG_DEVICE_FLAGS_MASK | \ |
| PVRSRV_MEMALLOCFLAG_CPU_CACHE_CLEAN | \ |
| PVRSRV_MEMALLOCFLAG_KERNEL_CPU_MAPPABLE | \ |
| PVRSRV_MEMALLOCFLAG_ZERO_ON_ALLOC | \ |
| PVRSRV_MEMALLOCFLAG_SVM_ALLOC | \ |
| PVRSRV_MEMALLOCFLAG_POISON_ON_ALLOC | \ |
| PVRSRV_MEMALLOCFLAG_POISON_ON_FREE | \ |
| PVRSRV_MEMALLOCFLAGS_GPU_MMUFLAGSMASK | \ |
| PVRSRV_MEMALLOCFLAGS_CPU_MMUFLAGSMASK | \ |
| PVRSRV_MEMALLOCFLAG_NO_OSPAGES_ON_ALLOC | \ |
| PVRSRV_MEMALLOCFLAG_SPARSE_NO_DUMMY_BACKING | \ |
| PVRSRV_MEMALLOCFLAG_SPARSE_ZERO_BACKING | \ |
| PVRSRV_MEMALLOCFLAG_FW_LOCAL | \ |
| PVRSRV_MEMALLOCFLAG_FW_CONFIG | \ |
| PVRSRV_MEMALLOCFLAG_FW_GUEST | \ |
| PVRSRV_MEMALLOCFLAG_CPU_LOCAL) |
| |
| /*! |
| RA differentiation mask |
| |
| for use internal to services |
| |
| this is the set of flags bits that are able to determine whether a pair of |
| allocations are permitted to live in the same page table. Allocations |
| whose flags differ in any of these places would be allocated from separate |
| RA Imports and therefore would never coexist in the same page. |
| Special cases are zeroing and poisoning of memory. The caller is responsible |
| to set the sub-allocations to the value he wants it to be. To differentiate |
| between zeroed and poisoned RA Imports does not make sense because the |
| memory might be reused. |
| |
| */ |
| #define PVRSRV_MEMALLOCFLAGS_RA_DIFFERENTIATION_MASK (PVRSRV_MEMALLOCFLAGS_PMRFLAGSMASK \ |
| & \ |
| ~(PVRSRV_MEMALLOCFLAG_ZERO_ON_ALLOC | \ |
| PVRSRV_MEMALLOCFLAG_POISON_ON_ALLOC)) |
| |
| /*! |
| Flags that affect _allocation_ |
| */ |
| #define PVRSRV_MEMALLOCFLAGS_PERALLOCFLAGSMASK (0xFFFFFFFFU) |
| |
| /*! |
| Flags that affect _mapping_ |
| */ |
| #define PVRSRV_MEMALLOCFLAGS_PERMAPPINGFLAGSMASK (PVRSRV_MEMALLOCFLAG_DEVICE_FLAGS_MASK | \ |
| PVRSRV_MEMALLOCFLAGS_GPU_MMUFLAGSMASK | \ |
| PVRSRV_MEMALLOCFLAGS_CPU_MMUFLAGSMASK | \ |
| PVRSRV_MEMALLOCFLAG_NO_OSPAGES_ON_ALLOC | \ |
| PVRSRV_MEMALLOCFLAG_SVM_ALLOC | \ |
| PVRSRV_MEMALLOCFLAG_SPARSE_ZERO_BACKING | \ |
| PVRSRV_MEMALLOCFLAG_SPARSE_NO_DUMMY_BACKING) |
| |
| #if ((~(PVRSRV_MEMALLOCFLAGS_RA_DIFFERENTIATION_MASK) & PVRSRV_MEMALLOCFLAGS_PERMAPPINGFLAGSMASK) != 0) |
| #error PVRSRV_MEMALLOCFLAGS_PERMAPPINGFLAGSMASK is not a subset of PVRSRV_MEMALLOCFLAGS_RA_DIFFERENTIATION_MASK |
| #endif |
| |
| |
| /*! |
| Flags that affect _physical allocations_ in the DevMemX API |
| */ |
| #define PVRSRV_MEMALLOCFLAGS_DEVMEMX_PHYSICAL_MASK (PVRSRV_MEMALLOCFLAGS_CPU_MMUFLAGSMASK | \ |
| PVRSRV_MEMALLOCFLAG_CPU_READ_PERMITTED | \ |
| PVRSRV_MEMALLOCFLAG_CPU_WRITE_PERMITTED | \ |
| PVRSRV_MEMALLOCFLAG_CPU_CACHE_CLEAN | \ |
| PVRSRV_MEMALLOCFLAG_CPU_LOCAL | \ |
| PVRSRV_MEMALLOCFLAG_ZERO_ON_ALLOC | \ |
| PVRSRV_MEMALLOCFLAG_POISON_ON_ALLOC | \ |
| PVRSRV_MEMALLOCFLAG_POISON_ON_FREE) |
| |
| /*! |
| Flags that affect _virtual allocations_ in the DevMemX API |
| */ |
| #define PVRSRV_MEMALLOCFLAGS_DEVMEMX_VIRTUAL_MASK (PVRSRV_MEMALLOCFLAGS_GPU_MMUFLAGSMASK | \ |
| PVRSRV_MEMALLOCFLAG_GPU_READ_PERMITTED | \ |
| PVRSRV_MEMALLOCFLAG_GPU_WRITE_PERMITTED) |
| |
| #endif /* PVRSRV_MEMALLOCFLAGS_H */ |
