bifrost/r38p2/kernel/drivers/gpu/arm/midgard/csf/mali_kbase_csf_tiler_heap_def.h - manifest_repos/mali-driver - Git at Google

 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
 /*
  *
  * (C) COPYRIGHT 2020-2022 ARM Limited. All rights reserved.
  *
  * This program is free software and is provided to you under the terms of the
  * GNU General Public License version 2 as published by the Free Software
  * Foundation, and any use by you of this program is subject to the terms
  * of such GNU license.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, you can access it online at
  * http://www.gnu.org/licenses/gpl-2.0.html.
  *
  */

 #ifndef _KBASE_CSF_TILER_HEAP_DEF_H_
 #define _KBASE_CSF_TILER_HEAP_DEF_H_

 #include <mali_kbase.h>

 /* Size of a tiler heap chunk header, in bytes. */
 #define CHUNK_HDR_SIZE ((size_t)64)

 /* Bit-position of the next chunk's size when stored in a chunk header. */
 #define CHUNK_HDR_NEXT_SIZE_POS (0)

 /* Bit-position of the next chunk's address when stored in a chunk header. */
 #define CHUNK_HDR_NEXT_ADDR_POS (12)

 /* Bitmask of the next chunk's size when stored in a chunk header. */
 #define CHUNK_HDR_NEXT_SIZE_MASK (((u64)1 << CHUNK_HDR_NEXT_ADDR_POS) - 1u)

 /* Bitmask of the address of the next chunk when stored in a chunk header. */
 #define CHUNK_HDR_NEXT_ADDR_MASK (~CHUNK_HDR_NEXT_SIZE_MASK)

 /* Right-shift before storing the next chunk's size in a chunk header. */
 #define CHUNK_HDR_NEXT_SIZE_ENCODE_SHIFT (12)

 /* Right-shift before storing the next chunk's address in a chunk header. */
 #define CHUNK_HDR_NEXT_ADDR_ENCODE_SHIFT (12)

 /* Bitmask of valid chunk sizes. This is also the maximum chunk size, in bytes.
  */
 #define CHUNK_SIZE_MASK \
 	((CHUNK_HDR_NEXT_SIZE_MASK >> CHUNK_HDR_NEXT_SIZE_POS) << \
 	 CHUNK_HDR_NEXT_SIZE_ENCODE_SHIFT)

 /* Bitmask of valid chunk addresses. This is also the highest address. */
 #define CHUNK_ADDR_MASK \
 	((CHUNK_HDR_NEXT_ADDR_MASK >> CHUNK_HDR_NEXT_ADDR_POS) << \
 	 CHUNK_HDR_NEXT_ADDR_ENCODE_SHIFT)

 /* Tiler heap shrink stop limit for maintaining a minimum number of chunks */
 #define HEAP_SHRINK_STOP_LIMIT (1)

 /* Tiler heap shrinker seek value, needs to be higher than jit and memory pools */
 #define HEAP_SHRINKER_SEEKS (DEFAULT_SEEKS + 2)

 /* Tiler heap shrinker batch value */
 #define HEAP_SHRINKER_BATCH (512)

 /* The size of the area needed to be vmapped prior to handing the tiler heap
  * over to the tiler, so that the shrinker could be invoked.
  */
 #define NEXT_CHUNK_ADDR_SIZE (sizeof(u64))

 /**
  * struct kbase_csf_tiler_heap_chunk - A tiler heap chunk managed by the kernel
  *
  * @link:   Link to this chunk in a list of chunks belonging to a
  *          @kbase_csf_tiler_heap.
  * @region: Pointer to the GPU memory region allocated for the chunk.
  * @map:    Kernel VA mapping so that we would not need to use vmap in the
  *          shrinker callback, which can allocate. This maps only the header
  *          of the chunk, so it could be traversed.
  * @gpu_va: GPU virtual address of the start of the memory region.
  *          This points to the header of the chunk and not to the low address
  *          of free memory within it.
  *
  * Chunks are allocated upon initialization of a tiler heap or in response to
  * out-of-memory events from the firmware. Chunks are always fully backed by
  * physical memory to avoid the overhead of processing GPU page faults. The
  * allocated GPU memory regions are linked together independent of the list of
  * kernel objects of this type.
  */
 struct kbase_csf_tiler_heap_chunk {
 	struct list_head link;
 	struct kbase_va_region *region;
 	struct kbase_vmap_struct map;
 	u64 gpu_va;
 };

 #define HEAP_BUF_DESCRIPTOR_CHECKED (1 << 0)

 /**
  * struct kbase_csf_tiler_heap - A tiler heap managed by the kernel
  *
  * @kctx:            Pointer to the kbase context with which this heap is
  *                   associated.
  * @link:            Link to this heap in a list of tiler heaps belonging to
  *                   the @kbase_csf_tiler_heap_context.
  * @chunks_list:     Linked list of allocated chunks.
  * @gpu_va:          The GPU virtual address of the heap context structure that
  *                   was allocated for the firmware. This is also used to
  *                   uniquely identify the heap.
  * @heap_id:         Unique id representing the heap, assigned during heap
  *                   initialization.
  * @buf_desc_va:     Buffer descriptor GPU VA. Can be 0 for backward compatible
  *                   to earlier version base interfaces.
  * @buf_desc_reg:    Pointer to the VA region that covers the provided buffer
  *                   descriptor memory object pointed to by buf_desc_va.
  * @gpu_va_map:      Kernel VA mapping of the GPU VA region.
  * @buf_desc_map:    Kernel VA mapping of the buffer descriptor, read from
  *                   during the tiler heap shrinker. Sync operations may need
  *                   to be done before each read.
  * @chunk_size:      Size of each chunk, in bytes. Must be page-aligned.
  * @chunk_count:     The number of chunks currently allocated. Must not be
  *                   zero or greater than @max_chunks.
  * @max_chunks:      The maximum number of chunks that the heap should be
  *                   allowed to use. Must not be less than @chunk_count.
  * @target_in_flight: Number of render-passes that the driver should attempt
  *                    to keep in flight for which allocation of new chunks is
  *                    allowed. Must not be zero.
  * @desc_chk_flags:  Runtime sanity check flags on heap chunk reclaim.
  * @desc_chk_cnt:    Counter for providing a deferral gap if runtime sanity check
  *                   needs to be retried later.
  */
 struct kbase_csf_tiler_heap {
 	struct kbase_context *kctx;
 	struct list_head link;
 	struct list_head chunks_list;
 	u64 gpu_va;
 	u64 heap_id;
 	u64 buf_desc_va;
 	struct kbase_va_region *buf_desc_reg;
 	struct kbase_vmap_struct buf_desc_map;
 	struct kbase_vmap_struct gpu_va_map;
 	u32 chunk_size;
 	u32 chunk_count;
 	u32 max_chunks;
 	u16 target_in_flight;
 	u8 desc_chk_flags;
 	u8 desc_chk_cnt;
 };

 /**
  * struct kbase_csf_gpu_buffer_heap - A gpu buffer object specific to tiler heap
  *
  * @cdsbp_0:       Descriptor_type and buffer_type
  * @size:          The size of the current heap chunk
  * @pointer:       Pointer to the current heap chunk
  * @low_pointer:   Pointer to low end of current heap chunk
  * @high_pointer:  Pointer to high end of current heap chunk
  */
 struct kbase_csf_gpu_buffer_heap {
 	u32 cdsbp_0;
 	u32 size;
 	u64 pointer;
 	u64 low_pointer;
 	u64 high_pointer;
 } __packed;

 /**
  * struct kbase_csf_tiler_heap_shrink_control - Kbase wraper object that wraps around
  *                                              kernel shrink_control
  *
  * @sc:          Pointer to shrinker control object in reclaim callback.
  * @count_cb:    function pointer for counting tiler heap free list.
  * @scan_cb:     function pointer for counting tiler heap free list.
  */

 struct kbase_csf_tiler_heap_shrink_control {
 	struct shrink_control *sc;
 	u32 (*count_cb)(struct kbase_context *kctx);
 	u32 (*scan_cb)(struct kbase_context *kctx, u32 pages);
 };

 #endif /* !_KBASE_CSF_TILER_HEAP_DEF_H_ */
	/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
	/*
	*
	* (C) COPYRIGHT 2020-2022 ARM Limited. All rights reserved.
	*
	* This program is free software and is provided to you under the terms of the
	* GNU General Public License version 2 as published by the Free Software
	* Foundation, and any use by you of this program is subject to the terms
	* of such GNU license.
	*
	* This program is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	* GNU General Public License for more details.
	*
	* You should have received a copy of the GNU General Public License
	* along with this program; if not, you can access it online at
	* http://www.gnu.org/licenses/gpl-2.0.html.
	*
	*/

	#ifndef _KBASE_CSF_TILER_HEAP_DEF_H_
	#define _KBASE_CSF_TILER_HEAP_DEF_H_

	#include <mali_kbase.h>

	/* Size of a tiler heap chunk header, in bytes. */
	#define CHUNK_HDR_SIZE ((size_t)64)

	/* Bit-position of the next chunk's size when stored in a chunk header. */
	#define CHUNK_HDR_NEXT_SIZE_POS (0)

	/* Bit-position of the next chunk's address when stored in a chunk header. */
	#define CHUNK_HDR_NEXT_ADDR_POS (12)

	/* Bitmask of the next chunk's size when stored in a chunk header. */
	#define CHUNK_HDR_NEXT_SIZE_MASK (((u64)1 << CHUNK_HDR_NEXT_ADDR_POS) - 1u)

	/* Bitmask of the address of the next chunk when stored in a chunk header. */
	#define CHUNK_HDR_NEXT_ADDR_MASK (~CHUNK_HDR_NEXT_SIZE_MASK)

	/* Right-shift before storing the next chunk's size in a chunk header. */
	#define CHUNK_HDR_NEXT_SIZE_ENCODE_SHIFT (12)

	/* Right-shift before storing the next chunk's address in a chunk header. */
	#define CHUNK_HDR_NEXT_ADDR_ENCODE_SHIFT (12)

	/* Bitmask of valid chunk sizes. This is also the maximum chunk size, in bytes.
	*/
	#define CHUNK_SIZE_MASK \
	((CHUNK_HDR_NEXT_SIZE_MASK >> CHUNK_HDR_NEXT_SIZE_POS) << \
	CHUNK_HDR_NEXT_SIZE_ENCODE_SHIFT)

	/* Bitmask of valid chunk addresses. This is also the highest address. */
	#define CHUNK_ADDR_MASK \
	((CHUNK_HDR_NEXT_ADDR_MASK >> CHUNK_HDR_NEXT_ADDR_POS) << \
	CHUNK_HDR_NEXT_ADDR_ENCODE_SHIFT)

	/* Tiler heap shrink stop limit for maintaining a minimum number of chunks */
	#define HEAP_SHRINK_STOP_LIMIT (1)

	/* Tiler heap shrinker seek value, needs to be higher than jit and memory pools */
	#define HEAP_SHRINKER_SEEKS (DEFAULT_SEEKS + 2)

	/* Tiler heap shrinker batch value */
	#define HEAP_SHRINKER_BATCH (512)

	/* The size of the area needed to be vmapped prior to handing the tiler heap
	* over to the tiler, so that the shrinker could be invoked.
	*/
	#define NEXT_CHUNK_ADDR_SIZE (sizeof(u64))

	/**
	* struct kbase_csf_tiler_heap_chunk - A tiler heap chunk managed by the kernel
	*
	* @link: Link to this chunk in a list of chunks belonging to a
	* @kbase_csf_tiler_heap.
	* @region: Pointer to the GPU memory region allocated for the chunk.
	* @map: Kernel VA mapping so that we would not need to use vmap in the
	* shrinker callback, which can allocate. This maps only the header
	* of the chunk, so it could be traversed.
	* @gpu_va: GPU virtual address of the start of the memory region.
	* This points to the header of the chunk and not to the low address
	* of free memory within it.
	*
	* Chunks are allocated upon initialization of a tiler heap or in response to
	* out-of-memory events from the firmware. Chunks are always fully backed by
	* physical memory to avoid the overhead of processing GPU page faults. The
	* allocated GPU memory regions are linked together independent of the list of
	* kernel objects of this type.
	*/
	struct kbase_csf_tiler_heap_chunk {
	struct list_head link;
	struct kbase_va_region *region;
	struct kbase_vmap_struct map;
	u64 gpu_va;
	};

	#define HEAP_BUF_DESCRIPTOR_CHECKED (1 << 0)

	/**
	* struct kbase_csf_tiler_heap - A tiler heap managed by the kernel
	*
	* @kctx: Pointer to the kbase context with which this heap is
	* associated.
	* @link: Link to this heap in a list of tiler heaps belonging to
	* the @kbase_csf_tiler_heap_context.
	* @chunks_list: Linked list of allocated chunks.
	* @gpu_va: The GPU virtual address of the heap context structure that
	* was allocated for the firmware. This is also used to
	* uniquely identify the heap.
	* @heap_id: Unique id representing the heap, assigned during heap
	* initialization.
	* @buf_desc_va: Buffer descriptor GPU VA. Can be 0 for backward compatible
	* to earlier version base interfaces.
	* @buf_desc_reg: Pointer to the VA region that covers the provided buffer
	* descriptor memory object pointed to by buf_desc_va.
	* @gpu_va_map: Kernel VA mapping of the GPU VA region.
	* @buf_desc_map: Kernel VA mapping of the buffer descriptor, read from
	* during the tiler heap shrinker. Sync operations may need
	* to be done before each read.
	* @chunk_size: Size of each chunk, in bytes. Must be page-aligned.
	* @chunk_count: The number of chunks currently allocated. Must not be
	* zero or greater than @max_chunks.
	* @max_chunks: The maximum number of chunks that the heap should be
	* allowed to use. Must not be less than @chunk_count.
	* @target_in_flight: Number of render-passes that the driver should attempt
	* to keep in flight for which allocation of new chunks is
	* allowed. Must not be zero.
	* @desc_chk_flags: Runtime sanity check flags on heap chunk reclaim.
	* @desc_chk_cnt: Counter for providing a deferral gap if runtime sanity check
	* needs to be retried later.
	*/
	struct kbase_csf_tiler_heap {
	struct kbase_context *kctx;
	struct list_head link;
	struct list_head chunks_list;
	u64 gpu_va;
	u64 heap_id;
	u64 buf_desc_va;
	struct kbase_va_region *buf_desc_reg;
	struct kbase_vmap_struct buf_desc_map;
	struct kbase_vmap_struct gpu_va_map;
	u32 chunk_size;
	u32 chunk_count;
	u32 max_chunks;
	u16 target_in_flight;
	u8 desc_chk_flags;
	u8 desc_chk_cnt;
	};

	/**
	* struct kbase_csf_gpu_buffer_heap - A gpu buffer object specific to tiler heap
	*
	* @cdsbp_0: Descriptor_type and buffer_type
	* @size: The size of the current heap chunk
	* @pointer: Pointer to the current heap chunk
	* @low_pointer: Pointer to low end of current heap chunk
	* @high_pointer: Pointer to high end of current heap chunk
	*/
	struct kbase_csf_gpu_buffer_heap {
	u32 cdsbp_0;
	u32 size;
	u64 pointer;
	u64 low_pointer;
	u64 high_pointer;
	} __packed;

	/**
	* struct kbase_csf_tiler_heap_shrink_control - Kbase wraper object that wraps around
	* kernel shrink_control
	*
	* @sc: Pointer to shrinker control object in reclaim callback.
	* @count_cb: function pointer for counting tiler heap free list.
	* @scan_cb: function pointer for counting tiler heap free list.
	*/

	struct kbase_csf_tiler_heap_shrink_control {
	struct shrink_control *sc;
	u32 (count_cb)(struct kbase_context kctx);
	u32 (scan_cb)(struct kbase_context kctx, u32 pages);
	};

	#endif /* !_KBASE_CSF_TILER_HEAP_DEF_H_ */