1 // SPDX-License-Identifier: GPL-2.0-or-later
62  *    1. 9-bit with the Data/Command signal as the ninth bit
64  *    3. 8-bit with the Data/Command signal as a separate D/CX pin
108 	if (!dbi->read_commands)  in mipi_dbi_command_is_read()
112 		if (!dbi->read_commands[i])  in mipi_dbi_command_is_read()
114 		if (cmd == dbi->read_commands[i])  in mipi_dbi_command_is_read()
122  * mipi_dbi_command_read - MIPI DCS read command
134 	if (!dbi->read_commands)  in mipi_dbi_command_read()
135 		return -EACCES;  in mipi_dbi_command_read()
138 		return -EINVAL;  in mipi_dbi_command_read()
145  * mipi_dbi_command_buf - MIPI DCS command with parameter(s) in an array
159 	/* SPI requires dma-safe buffers */  in mipi_dbi_command_buf()
162 		return -ENOMEM;  in mipi_dbi_command_buf()
164 	mutex_lock(&dbi->cmdlock);  in mipi_dbi_command_buf()
165 	ret = dbi->command(dbi, cmdbuf, data, len);  in mipi_dbi_command_buf()
166 	mutex_unlock(&dbi->cmdlock);  in mipi_dbi_command_buf()
183 		return -ENOMEM;  in mipi_dbi_command_stackbuf()
194  * mipi_dbi_buf_copy - Copy a framebuffer, transforming it if necessary
199  * @swap: When true, swap MSB/LSB of 16-bit values
215 	switch (fb->format->format) {  in mipi_dbi_buf_copy()
218 			drm_fb_swab(&dst_map, NULL, src, fb, clip, !gem->import_attach);  in mipi_dbi_buf_copy()
226 		drm_err_once(fb->dev, "Format is not supported: %p4cc\n",  in mipi_dbi_buf_copy()
227 			     &fb->format->format);  in mipi_dbi_buf_copy()
228 		ret = -EINVAL;  in mipi_dbi_buf_copy()
241 	struct mipi_dbi *dbi = &dbidev->dbi;  in mipi_dbi_set_window_address()
243 	xs += dbidev->left_offset;  in mipi_dbi_set_window_address()
244 	xe += dbidev->left_offset;  in mipi_dbi_set_window_address()
245 	ys += dbidev->top_offset;  in mipi_dbi_set_window_address()
246 	ye += dbidev->top_offset;  in mipi_dbi_set_window_address()
257 	struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(fb->dev);  in mipi_dbi_fb_dirty()
258 	unsigned int height = rect->y2 - rect->y1;  in mipi_dbi_fb_dirty()
259 	unsigned int width = rect->x2 - rect->x1;  in mipi_dbi_fb_dirty()
260 	struct mipi_dbi *dbi = &dbidev->dbi;  in mipi_dbi_fb_dirty()
261 	bool swap = dbi->swap_bytes;  in mipi_dbi_fb_dirty()
266 	full = width == fb->width && height == fb->height;  in mipi_dbi_fb_dirty()
268 	DRM_DEBUG_KMS("Flushing [FB:%d] " DRM_RECT_FMT "\n", fb->base.id, DRM_RECT_ARG(rect));  in mipi_dbi_fb_dirty()
270 	if (!dbi->dc || !full || swap ||  in mipi_dbi_fb_dirty()
271 	    fb->format->format == DRM_FORMAT_XRGB8888) {  in mipi_dbi_fb_dirty()
272 		tr = dbidev->tx_buf;  in mipi_dbi_fb_dirty()
277 		tr = src->vaddr; /* TODO: Use mapping abstraction properly */  in mipi_dbi_fb_dirty()
280 	mipi_dbi_set_window_address(dbidev, rect->x1, rect->x2 - 1, rect->y1,  in mipi_dbi_fb_dirty()
281 				    rect->y2 - 1);  in mipi_dbi_fb_dirty()
287 		drm_err_once(fb->dev, "Failed to update display %d\n", ret);  in mipi_dbi_fb_dirty()
291  * mipi_dbi_pipe_mode_valid - MIPI DBI mode-valid helper
295  * This function validates a given display mode against the MIPI DBI's hardware
296  * display. Drivers can use this as their &drm_simple_display_pipe_funcs->mode_valid
302 	struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(pipe->crtc.dev);  in mipi_dbi_pipe_mode_valid()
304 	return drm_crtc_helper_mode_valid_fixed(&pipe->crtc, mode, &dbidev->mode);  in mipi_dbi_pipe_mode_valid()
309  * mipi_dbi_pipe_update - Display pipe update helper
314  * this as their &drm_simple_display_pipe_funcs->update callback.
319 	struct drm_plane_state *state = pipe->plane.state;  in mipi_dbi_pipe_update()
321 	struct drm_framebuffer *fb = state->fb;  in mipi_dbi_pipe_update()
325 	if (!pipe->crtc.state->active)  in mipi_dbi_pipe_update()
331 	if (!drm_dev_enter(fb->dev, &idx))  in mipi_dbi_pipe_update()
335 		mipi_dbi_fb_dirty(&shadow_plane_state->data[0], fb, &rect);  in mipi_dbi_pipe_update()
342  * mipi_dbi_enable_flush - MIPI DBI enable helper
348  * in their &drm_simple_display_pipe_funcs->enable callback.
359 	struct drm_framebuffer *fb = plane_state->fb;  in mipi_dbi_enable_flush()
362 		.x2 = fb->width,  in mipi_dbi_enable_flush()
364 		.y2 = fb->height,  in mipi_dbi_enable_flush()
368 	if (!drm_dev_enter(&dbidev->drm, &idx))  in mipi_dbi_enable_flush()
371 	mipi_dbi_fb_dirty(&shadow_plane_state->data[0], fb, &rect);  in mipi_dbi_enable_flush()
372 	backlight_enable(dbidev->backlight);  in mipi_dbi_enable_flush()
380 	struct drm_device *drm = &dbidev->drm;  in mipi_dbi_blank()
381 	u16 height = drm->mode_config.min_height;  in mipi_dbi_blank()
382 	u16 width = drm->mode_config.min_width;  in mipi_dbi_blank()
383 	struct mipi_dbi *dbi = &dbidev->dbi;  in mipi_dbi_blank()
390 	memset(dbidev->tx_buf, 0, len);  in mipi_dbi_blank()
392 	mipi_dbi_set_window_address(dbidev, 0, width - 1, 0, height - 1);  in mipi_dbi_blank()
394 			     (u8 *)dbidev->tx_buf, len);  in mipi_dbi_blank()
400  * mipi_dbi_pipe_disable - MIPI DBI pipe disable helper
405  * &drm_simple_display_pipe_funcs->disable callback.
409 	struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(pipe->crtc.dev);  in mipi_dbi_pipe_disable()
413 	if (dbidev->backlight)  in mipi_dbi_pipe_disable()
414 		backlight_disable(dbidev->backlight);  in mipi_dbi_pipe_disable()
418 	if (dbidev->regulator)  in mipi_dbi_pipe_disable()
419 		regulator_disable(dbidev->regulator);  in mipi_dbi_pipe_disable()
420 	if (dbidev->io_regulator)  in mipi_dbi_pipe_disable()
421 		regulator_disable(dbidev->io_regulator);  in mipi_dbi_pipe_disable()
426  * mipi_dbi_pipe_begin_fb_access - MIPI DBI pipe begin-access helper
441 	return drm_gem_begin_shadow_fb_access(&pipe->plane, plane_state);  in mipi_dbi_pipe_begin_fb_access()
446  * mipi_dbi_pipe_end_fb_access - MIPI DBI pipe end-access helper
457 	drm_gem_end_shadow_fb_access(&pipe->plane, plane_state);  in mipi_dbi_pipe_end_fb_access()
462  * mipi_dbi_pipe_reset_plane - MIPI DBI plane-reset helper
470 	drm_gem_reset_shadow_plane(&pipe->plane);  in mipi_dbi_pipe_reset_plane()
475  * mipi_dbi_pipe_duplicate_plane_state - duplicates MIPI DBI plane state
488 	return drm_gem_duplicate_shadow_plane_state(&pipe->plane);  in mipi_dbi_pipe_duplicate_plane_state()
493  * mipi_dbi_pipe_destroy_plane_state - cleans up MIPI DBI plane state
505 	drm_gem_destroy_shadow_plane_state(&pipe->plane, plane_state);  in mipi_dbi_pipe_destroy_plane_state()
511 	struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(connector->dev);  in mipi_dbi_connector_get_modes()
513 	return drm_connector_helper_get_modes_fixed(connector, &dbidev->mode);  in mipi_dbi_connector_get_modes()
534 		swap(mode->hdisplay, mode->vdisplay);  in mipi_dbi_rotate_mode()
535 		swap(mode->hsync_start, mode->vsync_start);  in mipi_dbi_rotate_mode()
536 		swap(mode->hsync_end, mode->vsync_end);  in mipi_dbi_rotate_mode()
537 		swap(mode->htotal, mode->vtotal);  in mipi_dbi_rotate_mode()
538 		swap(mode->width_mm, mode->height_mm);  in mipi_dbi_rotate_mode()
541 		return -EINVAL;  in mipi_dbi_rotate_mode()
557  * mipi_dbi_dev_init_with_formats - MIPI DBI device initialization with custom formats
563  * @rotation: Initial rotation in degrees Counter Clock Wise
589 	struct drm_device *drm = &dbidev->drm;  in mipi_dbi_dev_init_with_formats()
592 	if (!dbidev->dbi.command)  in mipi_dbi_dev_init_with_formats()
593 		return -EINVAL;  in mipi_dbi_dev_init_with_formats()
599 	dbidev->tx_buf = devm_kmalloc(drm->dev, tx_buf_size, GFP_KERNEL);  in mipi_dbi_dev_init_with_formats()
600 	if (!dbidev->tx_buf)  in mipi_dbi_dev_init_with_formats()
601 		return -ENOMEM;  in mipi_dbi_dev_init_with_formats()
603 	drm_mode_copy(&dbidev->mode, mode);  in mipi_dbi_dev_init_with_formats()
604 	ret = mipi_dbi_rotate_mode(&dbidev->mode, rotation);  in mipi_dbi_dev_init_with_formats()
607 		return -EINVAL;  in mipi_dbi_dev_init_with_formats()
610 	drm_connector_helper_add(&dbidev->connector, &mipi_dbi_connector_hfuncs);  in mipi_dbi_dev_init_with_formats()
611 	ret = drm_connector_init(drm, &dbidev->connector, &mipi_dbi_connector_funcs,  in mipi_dbi_dev_init_with_formats()
616 	ret = drm_simple_display_pipe_init(drm, &dbidev->pipe, funcs, formats, format_count,  in mipi_dbi_dev_init_with_formats()
617 					   modifiers, &dbidev->connector);  in mipi_dbi_dev_init_with_formats()
621 	drm_plane_enable_fb_damage_clips(&dbidev->pipe.plane);  in mipi_dbi_dev_init_with_formats()
623 	drm->mode_config.funcs = &mipi_dbi_mode_config_funcs;  in mipi_dbi_dev_init_with_formats()
624 	drm->mode_config.min_width = dbidev->mode.hdisplay;  in mipi_dbi_dev_init_with_formats()
625 	drm->mode_config.max_width = dbidev->mode.hdisplay;  in mipi_dbi_dev_init_with_formats()
626 	drm->mode_config.min_height = dbidev->mode.vdisplay;  in mipi_dbi_dev_init_with_formats()
627 	drm->mode_config.max_height = dbidev->mode.vdisplay;  in mipi_dbi_dev_init_with_formats()
628 	dbidev->rotation = rotation;  in mipi_dbi_dev_init_with_formats()
637  * mipi_dbi_dev_init - MIPI DBI device initialization
641  * @rotation: Initial rotation in degrees Counter Clock Wise
657 	size_t bufsize = mode->vdisplay * mode->hdisplay * sizeof(u16);  in mipi_dbi_dev_init()
659 	dbidev->drm.mode_config.preferred_depth = 16;  in mipi_dbi_dev_init()
668  * mipi_dbi_hw_reset - Hardware reset of controller
671  * Reset controller if the &mipi_dbi->reset gpio is set.
675 	if (!dbi->reset)  in mipi_dbi_hw_reset()
678 	gpiod_set_value_cansleep(dbi->reset, 0);  in mipi_dbi_hw_reset()
680 	gpiod_set_value_cansleep(dbi->reset, 1);  in mipi_dbi_hw_reset()
686  * mipi_dbi_display_is_on - Check if display is on
719 	struct device *dev = dbidev->drm.dev;  in mipi_dbi_poweron_reset_conditional()
720 	struct mipi_dbi *dbi = &dbidev->dbi;  in mipi_dbi_poweron_reset_conditional()
723 	if (dbidev->regulator) {  in mipi_dbi_poweron_reset_conditional()
724 		ret = regulator_enable(dbidev->regulator);  in mipi_dbi_poweron_reset_conditional()
731 	if (dbidev->io_regulator) {  in mipi_dbi_poweron_reset_conditional()
732 		ret = regulator_enable(dbidev->io_regulator);  in mipi_dbi_poweron_reset_conditional()
735 			if (dbidev->regulator)  in mipi_dbi_poweron_reset_conditional()
736 				regulator_disable(dbidev->regulator);  in mipi_dbi_poweron_reset_conditional()
748 		if (dbidev->regulator)  in mipi_dbi_poweron_reset_conditional()
749 			regulator_disable(dbidev->regulator);  in mipi_dbi_poweron_reset_conditional()
750 		if (dbidev->io_regulator)  in mipi_dbi_poweron_reset_conditional()
751 			regulator_disable(dbidev->io_regulator);  in mipi_dbi_poweron_reset_conditional()
760 	if (dbi->reset)  in mipi_dbi_poweron_reset_conditional()
769  * mipi_dbi_poweron_reset - MIPI DBI poweron and reset
772  * This function enables the regulator if used and does a hardware and software
785  * mipi_dbi_poweron_conditional_reset - MIPI DBI poweron and conditional reset
789  * does a hardware and software reset. If mipi_dbi_display_is_on() determines
805  * mipi_dbi_spi_cmd_max_speed - get the maximum SPI bus speed
818 	return min_t(u32, 10000000, spi->max_speed_hz);  in mipi_dbi_spi_cmd_max_speed()
835  * use blocks of 9 bytes to send 8x 9-bit words using a 8-bit SPI transfer.
854 	size_t chunk, max_chunk = dbi->tx_buf9_len;  in mipi_dbi_spi1e_transfer()
855 	struct spi_device *spi = dbi->spi;  in mipi_dbi_spi1e_transfer()
857 		.tx_buf = dbi->tx_buf9,  in mipi_dbi_spi1e_transfer()
874 			return -EINVAL;  in mipi_dbi_spi1e_transfer()
876 		/* Command: pad no-op's (zeroes) at beginning of block */  in mipi_dbi_spi1e_transfer()
877 		dst = dbi->tx_buf9;  in mipi_dbi_spi1e_transfer()
896 		len -= chunk;  in mipi_dbi_spi1e_transfer()
897 		dst = dbi->tx_buf9;  in mipi_dbi_spi1e_transfer()
902 			/* Data: pad no-op's (zeroes) at end of block */  in mipi_dbi_spi1e_transfer()
908 					*dst++ = carry | BIT(8 - i) | (val >> i);  in mipi_dbi_spi1e_transfer()
909 					carry = val << (8 - i);  in mipi_dbi_spi1e_transfer()
912 					*dst++ = carry | BIT(8 - i) | (val >> i);  in mipi_dbi_spi1e_transfer()
913 					carry = val << (8 - i);  in mipi_dbi_spi1e_transfer()
920 					*dst++ = carry | BIT(8 - i) | (val >> i);  in mipi_dbi_spi1e_transfer()
921 					carry = val << (8 - i);  in mipi_dbi_spi1e_transfer()
971 	struct spi_device *spi = dbi->spi;  in mipi_dbi_spi1_transfer()
986 	max_chunk = dbi->tx_buf9_len;  in mipi_dbi_spi1_transfer()
987 	dst16 = dbi->tx_buf9;  in mipi_dbi_spi1_transfer()
1020 		len -= chunk;  in mipi_dbi_spi1_transfer()
1033 	struct spi_device *spi = dbi->spi;  in mipi_dbi_typec1_command_read()
1035 			     spi->max_speed_hz / 2);  in mipi_dbi_typec1_command_read()
1040 			.tx_buf = dbi->tx_buf9,  in mipi_dbi_typec1_command_read()
1054 		return -EINVAL;  in mipi_dbi_typec1_command_read()
1061 		dev_err(&spi->dev,  in mipi_dbi_typec1_command_read()
1063 		return -EOPNOTSUPP;  in mipi_dbi_typec1_command_read()
1071 	dst16 = dbi->tx_buf9;  in mipi_dbi_typec1_command_read()
1106 	struct spi_device *spi = dbi->spi;  in mipi_dbi_typec3_command_read()
1108 			     spi->max_speed_hz / 2);  in mipi_dbi_typec3_command_read()
1124 		return -EINVAL;  in mipi_dbi_typec3_command_read()
1127 	 * Support non-standard 24-bit and 32-bit Nokia read commands which  in mipi_dbi_typec3_command_read()
1133 			return -EINVAL;  in mipi_dbi_typec3_command_read()
1140 		return -ENOMEM;  in mipi_dbi_typec3_command_read()
1144 	spi_bus_lock(spi->controller);  in mipi_dbi_typec3_command_read()
1145 	gpiod_set_value_cansleep(dbi->dc, 0);  in mipi_dbi_typec3_command_read()
1149 	spi_bus_unlock(spi->controller);  in mipi_dbi_typec3_command_read()
1173 	struct spi_device *spi = dbi->spi;  in mipi_dbi_typec3_command()
1183 	spi_bus_lock(spi->controller);  in mipi_dbi_typec3_command()
1184 	gpiod_set_value_cansleep(dbi->dc, 0);  in mipi_dbi_typec3_command()
1187 	spi_bus_unlock(spi->controller);  in mipi_dbi_typec3_command()
1191 	if (*cmd == MIPI_DCS_WRITE_MEMORY_START && !dbi->swap_bytes)  in mipi_dbi_typec3_command()
1194 	spi_bus_lock(spi->controller);  in mipi_dbi_typec3_command()
1195 	gpiod_set_value_cansleep(dbi->dc, 1);  in mipi_dbi_typec3_command()
1198 	spi_bus_unlock(spi->controller);  in mipi_dbi_typec3_command()
1204  * mipi_dbi_spi_init - Initialize MIPI DBI SPI interface
1209  * This function sets &mipi_dbi->command, enables &mipi_dbi->read_commands for the
1211  * a driver-specific init.
1219  * - 9-bit: reorder buffer as 9x 8-bit words, padded with no-op command.
1220  * - 16-bit: if big endian send as 8-bit, if little endian swap bytes
1228 	struct device *dev = &spi->dev;  in mipi_dbi_spi_init()
1238 	 * re-maps it on the SPI master device using the DMA streaming API  in mipi_dbi_spi_init()
1241 	if (!dev->coherent_dma_mask) {  in mipi_dbi_spi_init()
1249 	dbi->spi = spi;  in mipi_dbi_spi_init()
1250 	dbi->read_commands = mipi_dbi_dcs_read_commands;  in mipi_dbi_spi_init()
1253 		dbi->command = mipi_dbi_typec3_command;  in mipi_dbi_spi_init()
1254 		dbi->dc = dc;  in mipi_dbi_spi_init()
1256 			dbi->swap_bytes = true;  in mipi_dbi_spi_init()
1258 		dbi->command = mipi_dbi_typec1_command;  in mipi_dbi_spi_init()
1259 		dbi->tx_buf9_len = SZ_16K;  in mipi_dbi_spi_init()
1260 		dbi->tx_buf9 = devm_kmalloc(dev, dbi->tx_buf9_len, GFP_KERNEL);  in mipi_dbi_spi_init()
1261 		if (!dbi->tx_buf9)  in mipi_dbi_spi_init()
1262 			return -ENOMEM;  in mipi_dbi_spi_init()
1265 	mutex_init(&dbi->cmdlock);  in mipi_dbi_spi_init()
1267 	DRM_DEBUG_DRIVER("SPI speed: %uMHz\n", spi->max_speed_hz / 1000000);  in mipi_dbi_spi_init()
1274  * mipi_dbi_spi_transfer - SPI transfer helper
1301 	 * are accepted (xfer->len % w_size must be zero).  in mipi_dbi_spi_transfer()
1315 		len -= chunk;  in mipi_dbi_spi_transfer()
1334 	struct seq_file *m = file->private_data;  in mipi_dbi_debugfs_command_write()
1335 	struct mipi_dbi_dev *dbidev = m->private;  in mipi_dbi_debugfs_command_write()
1340 	if (!drm_dev_enter(&dbidev->drm, &idx))  in mipi_dbi_debugfs_command_write()
1341 		return -ENODEV;  in mipi_dbi_debugfs_command_write()
1350 	for (i = count - 1; i > 0; i--)  in mipi_dbi_debugfs_command_write()
1360 			ret = -EINVAL;  in mipi_dbi_debugfs_command_write()
1374 			ret = -E2BIG;  in mipi_dbi_debugfs_command_write()
1379 	ret = mipi_dbi_command_buf(&dbidev->dbi, cmd, parameters, i);  in mipi_dbi_debugfs_command_write()
1391 	struct mipi_dbi_dev *dbidev = m->private;  in mipi_dbi_debugfs_command_show()
1392 	struct mipi_dbi *dbi = &dbidev->dbi;  in mipi_dbi_debugfs_command_show()
1397 	if (!drm_dev_enter(&dbidev->drm, &idx))  in mipi_dbi_debugfs_command_show()
1398 		return -ENODEV;  in mipi_dbi_debugfs_command_show()
1438 			   inode->i_private);  in mipi_dbi_debugfs_command_open()
1451  * mipi_dbi_debugfs_init - Create debugfs entries
1456  * Drivers can use this as their &drm_driver->debugfs_init callback.
1461 	struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(minor->dev);  in mipi_dbi_debugfs_init()
1464 	if (dbidev->dbi.read_commands)  in mipi_dbi_debugfs_init()
1466 	debugfs_create_file("command", mode, minor->debugfs_root, dbidev,  in mipi_dbi_debugfs_init()