Commit 6bcfe8ea authored by Danilo Krummrich's avatar Danilo Krummrich Committed by Sam Ravnborg
Browse files

drm/fb: rename FB CMA helpers to FB DMA helpers 



Rename "FB CMA" helpers to "FB DMA" helpers - considering the hierarchy
of APIs (mm/cma -> dma -> fb dma) calling them "FB 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}*)(FB)_CMA_(${REGEX_SYM_UPPER}*)"
	REGEX_GREP_LOWER="(${REGEX_SYM_LOWER}*)(fb)_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
```

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 "FB CMA", but not "GEM CMA".

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-3-dakr@redhat.com
parent 5e8bf00e

Documentation/gpu/drm-kms-helpers.rst

+4 −4
Original line number Diff line number Diff line
@@ -122,13 +122,13 @@ format Helper Functions Reference 
.. kernel-doc:: drivers/gpu/drm/drm_format_helper.c

   :export:



Framebuffer CMA Helper Functions Reference

Framebuffer DMA Helper Functions Reference

==========================================



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

   :doc: framebuffer cma helper functions

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

   :doc: framebuffer dma helper functions



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

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

   :export:



Framebuffer GEM Helper Reference

drivers/gpu/drm/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -41,7 +41,7 @@ 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_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_shmem_helper-y := drm_gem_shmem_helper.o

drivers/gpu/drm/arm/display/komeda/komeda_framebuffer.c

+2 −2
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
 *

 */

#include <drm/drm_device.h>

#include <drm/drm_fb_cma_helper.h>

#include <drm/drm_fb_dma_helper.h>

#include <drm/drm_gem.h>

#include <drm/drm_gem_cma_helper.h>

#include <drm/drm_gem_framebuffer_helper.h>
@@ -247,7 +247,7 @@ komeda_fb_get_pixel_addr(struct komeda_fb *kfb, int x, int y, int plane) 
		return -EINVAL;

	}



	obj = drm_fb_cma_get_gem_obj(fb, plane);

	obj = drm_fb_dma_get_gem_obj(fb, plane);



	offset = fb->offsets[plane];

	if (!fb->modifier) {

drivers/gpu/drm/arm/hdlcd_crtc.c

+2 −2
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ 
#include <drm/drm_atomic.h>

#include <drm/drm_atomic_helper.h>

#include <drm/drm_crtc.h>

#include <drm/drm_fb_cma_helper.h>

#include <drm/drm_fb_dma_helper.h>

#include <drm/drm_fb_helper.h>

#include <drm/drm_framebuffer.h>

#include <drm/drm_gem_cma_helper.h>
@@ -273,7 +273,7 @@ static void hdlcd_plane_atomic_update(struct drm_plane *plane, 
		return;



	dest_h = drm_rect_height(&new_plane_state->dst);

	scanout_start = drm_fb_cma_get_gem_addr(fb, new_plane_state, 0);

	scanout_start = drm_fb_dma_get_gem_addr(fb, new_plane_state, 0);



	hdlcd = plane->dev->dev_private;

	hdlcd_write(hdlcd, HDLCD_REG_FB_LINE_LENGTH, fb->pitches[0]);

drivers/gpu/drm/arm/malidp_mw.c

+2 −2
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ 
#include <drm/drm_atomic_helper.h>

#include <drm/drm_crtc.h>

#include <drm/drm_edid.h>

#include <drm/drm_fb_cma_helper.h>

#include <drm/drm_fb_dma_helper.h>

#include <drm/drm_fourcc.h>

#include <drm/drm_framebuffer.h>

#include <drm/drm_gem_cma_helper.h>
@@ -160,7 +160,7 @@ malidp_mw_encoder_atomic_check(struct drm_encoder *encoder, 


	n_planes = fb->format->num_planes;

	for (i = 0; i < n_planes; i++) {

		struct drm_gem_cma_object *obj = drm_fb_cma_get_gem_obj(fb, i);

		struct drm_gem_cma_object *obj = drm_fb_dma_get_gem_obj(fb, i);

		/* memory write buffers are never rotated */

		u8 alignment = malidp_hw_get_pitch_align(malidp->dev, 0);