Commit 4a83c26a authored by Danilo Krummrich's avatar Danilo Krummrich Committed by Sam Ravnborg
Browse files

drm/gem: rename GEM CMA helpers to GEM DMA helpers 



Rename "GEM CMA" helpers to "GEM DMA" helpers - considering the
hierarchy of APIs (mm/cma -> dma -> gem dma) calling them "GEM
DMA" seems to be more applicable.

Besides that, commit e57924d4 ("drm/doc: Task to rename CMA helpers")
requests to rename the CMA helpers and implies that people seem to be
confused about the naming.

In order to do this renaming the following script was used:

```
	#!/bin/bash

	DIRS="drivers/gpu include/drm Documentation/gpu"

	REGEX_SYM_UPPER="[0-9A-Z_\-]"
	REGEX_SYM_LOWER="[0-9a-z_\-]"

	REGEX_GREP_UPPER="(${REGEX_SYM_UPPER}*)(GEM)_CMA_(${REGEX_SYM_UPPER}*)"
	REGEX_GREP_LOWER="(${REGEX_SYM_LOWER}*)(gem)_cma_(${REGEX_SYM_LOWER}*)"

	REGEX_SED_UPPER="s/${REGEX_GREP_UPPER}/\1\2_DMA_\3/g"
	REGEX_SED_LOWER="s/${REGEX_GREP_LOWER}/\1\2_dma_\3/g"

	# Find all upper case 'CMA' symbols and replace them with 'DMA'.
	for ff in $(grep -REHl "${REGEX_GREP_UPPER}" $DIRS)
	do
	       sed -i -E "$REGEX_SED_UPPER" $ff
	done

	# Find all lower case 'cma' symbols and replace them with 'dma'.
	for ff in $(grep -REHl "${REGEX_GREP_LOWER}" $DIRS)
	do
	       sed -i -E "$REGEX_SED_LOWER" $ff
	done

	# Replace all occurrences of 'CMA' / 'cma' in comments and
	# documentation files with 'DMA' / 'dma'.
	for ff in $(grep -RiHl " cma " $DIRS)
	do
		sed -i -E "s/ cma / dma /g" $ff
		sed -i -E "s/ CMA / DMA /g" $ff
	done

	# Rename all 'cma_obj's to 'dma_obj'.
	for ff in $(grep -RiHl "cma_obj" $DIRS)
	do
		sed -i -E "s/cma_obj/dma_obj/g" $ff
	done
```

Only a few more manual modifications were needed, e.g. reverting the
following modifications in some DRM Kconfig files

    -       select CMA if HAVE_DMA_CONTIGUOUS
    +       select DMA if HAVE_DMA_CONTIGUOUS

as well as manually picking the occurrences of 'CMA'/'cma' in comments and
documentation which relate to "GEM CMA", but not "FB CMA".

Also drivers/gpu/drm/Makefile was fixed up manually after renaming
drm_gem_cma_helper.c to drm_gem_dma_helper.c.

This patch is compile-time tested building a x86_64 kernel with
`make allyesconfig && make drivers/gpu/drm`.

Acked-by: default avatarSam Ravnborg <sam@ravnborg.org>
Acked-by: default avatarThomas Zimmermann <tzimmermann@suse.de>
Reviewed-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: default avatarDanilo Krummrich <dakr@redhat.com>
Reviewed-by: Liviu Dudau <liviu.dudau@arm.com> #drivers/gpu/drm/arm
Signed-off-by: default avatarSam Ravnborg <sam@ravnborg.org>
Link: https://patchwork.freedesktop.org/patch/msgid/20220802000405.949236-4-dakr@redhat.com
parent 6bcfe8ea

Documentation/gpu/drm-mm.rst

+8 −8
Original line number Diff line number Diff line
@@ -300,12 +300,12 @@ Drivers that want to map the GEM object upfront instead of handling page 
faults can implement their own mmap file operation handler.



For platforms without MMU the GEM core provides a helper method

drm_gem_cma_get_unmapped_area(). The mmap() routines will call this to get a

drm_gem_dma_get_unmapped_area(). The mmap() routines will call this to get a

proposed address for the mapping.



To use drm_gem_cma_get_unmapped_area(), drivers must fill the struct

To use drm_gem_dma_get_unmapped_area(), drivers must fill the struct

:c:type:`struct file_operations <file_operations>` get_unmapped_area field with

a pointer on drm_gem_cma_get_unmapped_area().

a pointer on drm_gem_dma_get_unmapped_area().



More detailed information about get_unmapped_area can be found in

Documentation/admin-guide/mm/nommu-mmap.rst
@@ -355,16 +355,16 @@ GEM Function Reference 
.. kernel-doc:: drivers/gpu/drm/drm_gem.c

   :export:



GEM CMA Helper Functions Reference

GEM DMA Helper Functions Reference

----------------------------------



.. kernel-doc:: drivers/gpu/drm/drm_gem_cma_helper.c

   :doc: cma helpers

.. kernel-doc:: drivers/gpu/drm/drm_gem_dma_helper.c

   :doc: dma helpers



.. kernel-doc:: include/drm/drm_gem_cma_helper.h

.. kernel-doc:: include/drm/drm_gem_dma_helper.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_gem_cma_helper.c

.. kernel-doc:: drivers/gpu/drm/drm_gem_dma_helper.c

   :export:



GEM SHMEM Helper Function Reference

drivers/gpu/drm/Kconfig

+2 −2
Original line number Diff line number Diff line
@@ -200,11 +200,11 @@ config DRM_TTM_HELPER 
	help

	  Helpers for ttm-based gem objects



config DRM_GEM_CMA_HELPER

config DRM_GEM_DMA_HELPER

	tristate

	depends on DRM

	help

	  Choose this if you need the GEM CMA helper functions

	  Choose this if you need the GEM DMA helper functions



config DRM_GEM_SHMEM_HELPER

	tristate

drivers/gpu/drm/Makefile

+3 −3
Original line number Diff line number Diff line
@@ -40,9 +40,9 @@ obj-$(CONFIG_DRM_PANEL_ORIENTATION_QUIRKS) += drm_panel_orientation_quirks.o 


obj-$(CONFIG_DRM_BUDDY) += drm_buddy.o



drm_cma_helper-y := drm_gem_cma_helper.o

drm_cma_helper-$(CONFIG_DRM_KMS_HELPER) += drm_fb_dma_helper.o

obj-$(CONFIG_DRM_GEM_CMA_HELPER) += drm_cma_helper.o

drm_dma_helper-y := drm_gem_dma_helper.o

drm_dma_helper-$(CONFIG_DRM_KMS_HELPER) += drm_fb_dma_helper.o

obj-$(CONFIG_DRM_GEM_DMA_HELPER) += drm_dma_helper.o



drm_shmem_helper-y := drm_gem_shmem_helper.o

obj-$(CONFIG_DRM_GEM_SHMEM_HELPER) += drm_shmem_helper.o

drivers/gpu/drm/arm/Kconfig

+2 −2
Original line number Diff line number Diff line
@@ -6,7 +6,7 @@ config DRM_HDLCD 
	depends on DRM && OF && (ARM || ARM64 || COMPILE_TEST)

	depends on COMMON_CLK

	select DRM_KMS_HELPER

	select DRM_GEM_CMA_HELPER

	select DRM_GEM_DMA_HELPER

	help

	  Choose this option if you have an ARM High Definition Colour LCD

	  controller.
@@ -27,7 +27,7 @@ config DRM_MALI_DISPLAY 
	depends on DRM && OF && (ARM || ARM64 || COMPILE_TEST)

	depends on COMMON_CLK

	select DRM_KMS_HELPER

	select DRM_GEM_CMA_HELPER

	select DRM_GEM_DMA_HELPER

	select VIDEOMODE_HELPERS

	help

	  Choose this option if you want to compile the ARM Mali Display

drivers/gpu/drm/arm/display/Kconfig

+1 −1
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ config DRM_KOMEDA 
	depends on DRM && OF

	depends on COMMON_CLK

	select DRM_KMS_HELPER

	select DRM_GEM_CMA_HELPER

	select DRM_GEM_DMA_HELPER

	select VIDEOMODE_HELPERS

	help

	  Choose this option if you want to compile the ARM Komeda display