mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-25 05:34:00 +08:00
7938f42181
Rename struct dma_buf_map to struct iosys_map and corresponding APIs. Over time dma-buf-map grew up to more functionality than the one used by dma-buf: in fact it's just a shim layer to abstract system memory, that can be accessed via regular load and store, from IO memory that needs to be acessed via arch helpers. The idea is to extend this API so it can fulfill other needs, internal to a single driver. Example: in the i915 driver it's desired to share the implementation for integrated graphics, which uses mostly system memory, with discrete graphics, which may need to access IO memory. The conversion was mostly done with the following semantic patch: @r1@ @@ - struct dma_buf_map + struct iosys_map @r2@ @@ ( - DMA_BUF_MAP_INIT_VADDR + IOSYS_MAP_INIT_VADDR | - dma_buf_map_set_vaddr + iosys_map_set_vaddr | - dma_buf_map_set_vaddr_iomem + iosys_map_set_vaddr_iomem | - dma_buf_map_is_equal + iosys_map_is_equal | - dma_buf_map_is_null + iosys_map_is_null | - dma_buf_map_is_set + iosys_map_is_set | - dma_buf_map_clear + iosys_map_clear | - dma_buf_map_memcpy_to + iosys_map_memcpy_to | - dma_buf_map_incr + iosys_map_incr ) @@ @@ - #include <linux/dma-buf-map.h> + #include <linux/iosys-map.h> Then some files had their includes adjusted and some comments were update to remove mentions to dma-buf-map. Since this is not specific to dma-buf anymore, move the documentation to the "Bus-Independent Device Accesses" section. v2: - Squash patches v3: - Fix wrong removal of dma-buf.h from MAINTAINERS - Move documentation from dma-buf.rst to device-io.rst v4: - Change documentation title and level Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com> Acked-by: Christian König <christian.koenig@amd.com> Acked-by: Sumit Semwal <sumit.semwal@linaro.org> Acked-by: Thomas Zimmermann <tzimmermann@suse.de> Link: https://patchwork.freedesktop.org/patch/msgid/20220204170541.829227-1-lucas.demarchi@intel.com
280 lines
9.5 KiB
C
280 lines
9.5 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef __DRM_GEM_CMA_HELPER_H__
|
|
#define __DRM_GEM_CMA_HELPER_H__
|
|
|
|
#include <drm/drm_file.h>
|
|
#include <drm/drm_ioctl.h>
|
|
#include <drm/drm_gem.h>
|
|
|
|
struct drm_mode_create_dumb;
|
|
|
|
/**
|
|
* struct drm_gem_cma_object - GEM object backed by CMA memory allocations
|
|
* @base: base GEM object
|
|
* @paddr: physical address of the backing memory
|
|
* @sgt: scatter/gather table for imported PRIME buffers. The table can have
|
|
* more than one entry but they are guaranteed to have contiguous
|
|
* DMA addresses.
|
|
* @vaddr: kernel virtual address of the backing memory
|
|
* @map_noncoherent: if true, the GEM object is backed by non-coherent memory
|
|
*/
|
|
struct drm_gem_cma_object {
|
|
struct drm_gem_object base;
|
|
dma_addr_t paddr;
|
|
struct sg_table *sgt;
|
|
|
|
/* For objects with DMA memory allocated by GEM CMA */
|
|
void *vaddr;
|
|
|
|
bool map_noncoherent;
|
|
};
|
|
|
|
#define to_drm_gem_cma_obj(gem_obj) \
|
|
container_of(gem_obj, struct drm_gem_cma_object, base)
|
|
|
|
struct drm_gem_cma_object *drm_gem_cma_create(struct drm_device *drm,
|
|
size_t size);
|
|
void drm_gem_cma_free(struct drm_gem_cma_object *cma_obj);
|
|
void drm_gem_cma_print_info(const struct drm_gem_cma_object *cma_obj,
|
|
struct drm_printer *p, unsigned int indent);
|
|
struct sg_table *drm_gem_cma_get_sg_table(struct drm_gem_cma_object *cma_obj);
|
|
int drm_gem_cma_vmap(struct drm_gem_cma_object *cma_obj,
|
|
struct iosys_map *map);
|
|
int drm_gem_cma_mmap(struct drm_gem_cma_object *cma_obj, struct vm_area_struct *vma);
|
|
|
|
extern const struct vm_operations_struct drm_gem_cma_vm_ops;
|
|
|
|
/*
|
|
* GEM object functions
|
|
*/
|
|
|
|
/**
|
|
* drm_gem_cma_object_free - GEM object function for drm_gem_cma_free()
|
|
* @obj: GEM object to free
|
|
*
|
|
* This function wraps drm_gem_cma_free_object(). Drivers that employ the CMA helpers
|
|
* should use it as their &drm_gem_object_funcs.free handler.
|
|
*/
|
|
static inline void drm_gem_cma_object_free(struct drm_gem_object *obj)
|
|
{
|
|
struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
|
|
|
|
drm_gem_cma_free(cma_obj);
|
|
}
|
|
|
|
/**
|
|
* drm_gem_cma_object_print_info() - Print &drm_gem_cma_object info for debugfs
|
|
* @p: DRM printer
|
|
* @indent: Tab indentation level
|
|
* @obj: GEM object
|
|
*
|
|
* This function wraps drm_gem_cma_print_info(). Drivers that employ the CMA helpers
|
|
* should use this function as their &drm_gem_object_funcs.print_info handler.
|
|
*/
|
|
static inline void drm_gem_cma_object_print_info(struct drm_printer *p, unsigned int indent,
|
|
const struct drm_gem_object *obj)
|
|
{
|
|
const struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
|
|
|
|
drm_gem_cma_print_info(cma_obj, p, indent);
|
|
}
|
|
|
|
/**
|
|
* drm_gem_cma_object_get_sg_table - GEM object function for drm_gem_cma_get_sg_table()
|
|
* @obj: GEM object
|
|
*
|
|
* This function wraps drm_gem_cma_get_sg_table(). Drivers that employ the CMA helpers should
|
|
* use it as their &drm_gem_object_funcs.get_sg_table handler.
|
|
*
|
|
* Returns:
|
|
* A pointer to the scatter/gather table of pinned pages or NULL on failure.
|
|
*/
|
|
static inline struct sg_table *drm_gem_cma_object_get_sg_table(struct drm_gem_object *obj)
|
|
{
|
|
struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
|
|
|
|
return drm_gem_cma_get_sg_table(cma_obj);
|
|
}
|
|
|
|
/*
|
|
* drm_gem_cma_object_vmap - GEM object function for drm_gem_cma_vmap()
|
|
* @obj: GEM object
|
|
* @map: Returns the kernel virtual address of the CMA GEM object's backing store.
|
|
*
|
|
* This function wraps drm_gem_cma_vmap(). Drivers that employ the CMA helpers should
|
|
* use it as their &drm_gem_object_funcs.vmap handler.
|
|
*
|
|
* Returns:
|
|
* 0 on success or a negative error code on failure.
|
|
*/
|
|
static inline int drm_gem_cma_object_vmap(struct drm_gem_object *obj,
|
|
struct iosys_map *map)
|
|
{
|
|
struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
|
|
|
|
return drm_gem_cma_vmap(cma_obj, map);
|
|
}
|
|
|
|
/**
|
|
* drm_gem_cma_object_mmap - GEM object function for drm_gem_cma_mmap()
|
|
* @obj: GEM object
|
|
* @vma: VMA for the area to be mapped
|
|
*
|
|
* This function wraps drm_gem_cma_mmap(). Drivers that employ the cma helpers should
|
|
* use it as their &drm_gem_object_funcs.mmap handler.
|
|
*
|
|
* Returns:
|
|
* 0 on success or a negative error code on failure.
|
|
*/
|
|
static inline int drm_gem_cma_object_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
|
|
{
|
|
struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
|
|
|
|
return drm_gem_cma_mmap(cma_obj, vma);
|
|
}
|
|
|
|
/*
|
|
* Driver ops
|
|
*/
|
|
|
|
/* create memory region for DRM framebuffer */
|
|
int drm_gem_cma_dumb_create_internal(struct drm_file *file_priv,
|
|
struct drm_device *drm,
|
|
struct drm_mode_create_dumb *args);
|
|
|
|
/* create memory region for DRM framebuffer */
|
|
int drm_gem_cma_dumb_create(struct drm_file *file_priv,
|
|
struct drm_device *drm,
|
|
struct drm_mode_create_dumb *args);
|
|
|
|
struct drm_gem_object *
|
|
drm_gem_cma_prime_import_sg_table(struct drm_device *dev,
|
|
struct dma_buf_attachment *attach,
|
|
struct sg_table *sgt);
|
|
|
|
/**
|
|
* DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE - CMA GEM driver operations
|
|
* @dumb_create_func: callback function for .dumb_create
|
|
*
|
|
* This macro provides a shortcut for setting the default GEM operations in the
|
|
* &drm_driver structure.
|
|
*
|
|
* This macro is a variant of DRM_GEM_CMA_DRIVER_OPS for drivers that
|
|
* override the default implementation of &struct rm_driver.dumb_create. Use
|
|
* DRM_GEM_CMA_DRIVER_OPS if possible. Drivers that require a virtual address
|
|
* on imported buffers should use
|
|
* DRM_GEM_CMA_DRIVER_OPS_VMAP_WITH_DUMB_CREATE() instead.
|
|
*/
|
|
#define DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE(dumb_create_func) \
|
|
.dumb_create = (dumb_create_func), \
|
|
.prime_handle_to_fd = drm_gem_prime_handle_to_fd, \
|
|
.prime_fd_to_handle = drm_gem_prime_fd_to_handle, \
|
|
.gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table, \
|
|
.gem_prime_mmap = drm_gem_prime_mmap
|
|
|
|
/**
|
|
* DRM_GEM_CMA_DRIVER_OPS - CMA GEM driver operations
|
|
*
|
|
* This macro provides a shortcut for setting the default GEM operations in the
|
|
* &drm_driver structure.
|
|
*
|
|
* Drivers that come with their own implementation of
|
|
* &struct drm_driver.dumb_create should use
|
|
* DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE() instead. Use
|
|
* DRM_GEM_CMA_DRIVER_OPS if possible. Drivers that require a virtual address
|
|
* on imported buffers should use DRM_GEM_CMA_DRIVER_OPS_VMAP instead.
|
|
*/
|
|
#define DRM_GEM_CMA_DRIVER_OPS \
|
|
DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE(drm_gem_cma_dumb_create)
|
|
|
|
/**
|
|
* DRM_GEM_CMA_DRIVER_OPS_VMAP_WITH_DUMB_CREATE - CMA GEM driver operations
|
|
* ensuring a virtual address
|
|
* on the buffer
|
|
* @dumb_create_func: callback function for .dumb_create
|
|
*
|
|
* This macro provides a shortcut for setting the default GEM operations in the
|
|
* &drm_driver structure for drivers that need the virtual address also on
|
|
* imported buffers.
|
|
*
|
|
* This macro is a variant of DRM_GEM_CMA_DRIVER_OPS_VMAP for drivers that
|
|
* override the default implementation of &struct drm_driver.dumb_create. Use
|
|
* DRM_GEM_CMA_DRIVER_OPS_VMAP if possible. Drivers that do not require a
|
|
* virtual address on imported buffers should use
|
|
* DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE() instead.
|
|
*/
|
|
#define DRM_GEM_CMA_DRIVER_OPS_VMAP_WITH_DUMB_CREATE(dumb_create_func) \
|
|
.dumb_create = dumb_create_func, \
|
|
.prime_handle_to_fd = drm_gem_prime_handle_to_fd, \
|
|
.prime_fd_to_handle = drm_gem_prime_fd_to_handle, \
|
|
.gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table_vmap, \
|
|
.gem_prime_mmap = drm_gem_prime_mmap
|
|
|
|
/**
|
|
* DRM_GEM_CMA_DRIVER_OPS_VMAP - CMA GEM driver operations ensuring a virtual
|
|
* address on the buffer
|
|
*
|
|
* This macro provides a shortcut for setting the default GEM operations in the
|
|
* &drm_driver structure for drivers that need the virtual address also on
|
|
* imported buffers.
|
|
*
|
|
* Drivers that come with their own implementation of
|
|
* &struct drm_driver.dumb_create should use
|
|
* DRM_GEM_CMA_DRIVER_OPS_VMAP_WITH_DUMB_CREATE() instead. Use
|
|
* DRM_GEM_CMA_DRIVER_OPS_VMAP if possible. Drivers that do not require a
|
|
* virtual address on imported buffers should use DRM_GEM_CMA_DRIVER_OPS
|
|
* instead.
|
|
*/
|
|
#define DRM_GEM_CMA_DRIVER_OPS_VMAP \
|
|
DRM_GEM_CMA_DRIVER_OPS_VMAP_WITH_DUMB_CREATE(drm_gem_cma_dumb_create)
|
|
|
|
struct drm_gem_object *
|
|
drm_gem_cma_prime_import_sg_table_vmap(struct drm_device *drm,
|
|
struct dma_buf_attachment *attach,
|
|
struct sg_table *sgt);
|
|
|
|
/*
|
|
* File ops
|
|
*/
|
|
|
|
#ifndef CONFIG_MMU
|
|
unsigned long drm_gem_cma_get_unmapped_area(struct file *filp,
|
|
unsigned long addr,
|
|
unsigned long len,
|
|
unsigned long pgoff,
|
|
unsigned long flags);
|
|
#define DRM_GEM_CMA_UNMAPPED_AREA_FOPS \
|
|
.get_unmapped_area = drm_gem_cma_get_unmapped_area,
|
|
#else
|
|
#define DRM_GEM_CMA_UNMAPPED_AREA_FOPS
|
|
#endif
|
|
|
|
/**
|
|
* DEFINE_DRM_GEM_CMA_FOPS() - macro to generate file operations for CMA drivers
|
|
* @name: name for the generated structure
|
|
*
|
|
* This macro autogenerates a suitable &struct file_operations for CMA based
|
|
* drivers, which can be assigned to &drm_driver.fops. Note that this structure
|
|
* cannot be shared between drivers, because it contains a reference to the
|
|
* current module using THIS_MODULE.
|
|
*
|
|
* Note that the declaration is already marked as static - if you need a
|
|
* non-static version of this you're probably doing it wrong and will break the
|
|
* THIS_MODULE reference by accident.
|
|
*/
|
|
#define DEFINE_DRM_GEM_CMA_FOPS(name) \
|
|
static const struct file_operations name = {\
|
|
.owner = THIS_MODULE,\
|
|
.open = drm_open,\
|
|
.release = drm_release,\
|
|
.unlocked_ioctl = drm_ioctl,\
|
|
.compat_ioctl = drm_compat_ioctl,\
|
|
.poll = drm_poll,\
|
|
.read = drm_read,\
|
|
.llseek = noop_llseek,\
|
|
.mmap = drm_gem_mmap,\
|
|
DRM_GEM_CMA_UNMAPPED_AREA_FOPS \
|
|
}
|
|
|
|
#endif /* __DRM_GEM_CMA_HELPER_H__ */
|