462 lines · c
1// SPDX-License-Identifier: GPL-2.0-or-later2/*3 * DRM driver for Ilitek ILI9225 panels4 *5 * Copyright 2017 David Lechner <david@lechnology.com>6 *7 * Some code copied from mipi-dbi.c8 * Copyright 2016 Noralf Trønnes9 */10 11#include <linux/delay.h>12#include <linux/dma-buf.h>13#include <linux/gpio/consumer.h>14#include <linux/module.h>15#include <linux/property.h>16#include <linux/spi/spi.h>17#include <video/mipi_display.h>18 19#include <drm/drm_atomic_helper.h>20#include <drm/drm_damage_helper.h>21#include <drm/drm_drv.h>22#include <drm/drm_fb_dma_helper.h>23#include <drm/drm_fbdev_dma.h>24#include <drm/drm_fourcc.h>25#include <drm/drm_framebuffer.h>26#include <drm/drm_gem_atomic_helper.h>27#include <drm/drm_gem_dma_helper.h>28#include <drm/drm_gem_framebuffer_helper.h>29#include <drm/drm_managed.h>30#include <drm/drm_mipi_dbi.h>31#include <drm/drm_rect.h>32 33#define ILI9225_DRIVER_READ_CODE 0x0034#define ILI9225_DRIVER_OUTPUT_CONTROL 0x0135#define ILI9225_LCD_AC_DRIVING_CONTROL 0x0236#define ILI9225_ENTRY_MODE 0x0337#define ILI9225_DISPLAY_CONTROL_1 0x0738#define ILI9225_BLANK_PERIOD_CONTROL_1 0x0839#define ILI9225_FRAME_CYCLE_CONTROL 0x0b40#define ILI9225_INTERFACE_CONTROL 0x0c41#define ILI9225_OSCILLATION_CONTROL 0x0f42#define ILI9225_POWER_CONTROL_1 0x1043#define ILI9225_POWER_CONTROL_2 0x1144#define ILI9225_POWER_CONTROL_3 0x1245#define ILI9225_POWER_CONTROL_4 0x1346#define ILI9225_POWER_CONTROL_5 0x1447#define ILI9225_VCI_RECYCLING 0x1548#define ILI9225_RAM_ADDRESS_SET_1 0x2049#define ILI9225_RAM_ADDRESS_SET_2 0x2150#define ILI9225_WRITE_DATA_TO_GRAM 0x2251#define ILI9225_SOFTWARE_RESET 0x2852#define ILI9225_GATE_SCAN_CONTROL 0x3053#define ILI9225_VERTICAL_SCROLL_1 0x3154#define ILI9225_VERTICAL_SCROLL_2 0x3255#define ILI9225_VERTICAL_SCROLL_3 0x3356#define ILI9225_PARTIAL_DRIVING_POS_1 0x3457#define ILI9225_PARTIAL_DRIVING_POS_2 0x3558#define ILI9225_HORIZ_WINDOW_ADDR_1 0x3659#define ILI9225_HORIZ_WINDOW_ADDR_2 0x3760#define ILI9225_VERT_WINDOW_ADDR_1 0x3861#define ILI9225_VERT_WINDOW_ADDR_2 0x3962#define ILI9225_GAMMA_CONTROL_1 0x5063#define ILI9225_GAMMA_CONTROL_2 0x5164#define ILI9225_GAMMA_CONTROL_3 0x5265#define ILI9225_GAMMA_CONTROL_4 0x5366#define ILI9225_GAMMA_CONTROL_5 0x5467#define ILI9225_GAMMA_CONTROL_6 0x5568#define ILI9225_GAMMA_CONTROL_7 0x5669#define ILI9225_GAMMA_CONTROL_8 0x5770#define ILI9225_GAMMA_CONTROL_9 0x5871#define ILI9225_GAMMA_CONTROL_10 0x5972 73static inline int ili9225_command(struct mipi_dbi *dbi, u8 cmd, u16 data)74{75 u8 par[2] = { data >> 8, data & 0xff };76 77 return mipi_dbi_command_buf(dbi, cmd, par, 2);78}79 80static void ili9225_fb_dirty(struct iosys_map *src, struct drm_framebuffer *fb,81 struct drm_rect *rect, struct drm_format_conv_state *fmtcnv_state)82{83 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(fb->dev);84 unsigned int height = rect->y2 - rect->y1;85 unsigned int width = rect->x2 - rect->x1;86 struct mipi_dbi *dbi = &dbidev->dbi;87 bool swap = dbi->swap_bytes;88 u16 x_start, y_start;89 u16 x1, x2, y1, y2;90 int ret = 0;91 bool full;92 void *tr;93 94 full = width == fb->width && height == fb->height;95 96 DRM_DEBUG_KMS("Flushing [FB:%d] " DRM_RECT_FMT "\n", fb->base.id, DRM_RECT_ARG(rect));97 98 if (!dbi->dc || !full || swap ||99 fb->format->format == DRM_FORMAT_XRGB8888) {100 tr = dbidev->tx_buf;101 ret = mipi_dbi_buf_copy(tr, src, fb, rect, swap, fmtcnv_state);102 if (ret)103 goto err_msg;104 } else {105 tr = src->vaddr; /* TODO: Use mapping abstraction properly */106 }107 108 switch (dbidev->rotation) {109 default:110 x1 = rect->x1;111 x2 = rect->x2 - 1;112 y1 = rect->y1;113 y2 = rect->y2 - 1;114 x_start = x1;115 y_start = y1;116 break;117 case 90:118 x1 = rect->y1;119 x2 = rect->y2 - 1;120 y1 = fb->width - rect->x2;121 y2 = fb->width - rect->x1 - 1;122 x_start = x1;123 y_start = y2;124 break;125 case 180:126 x1 = fb->width - rect->x2;127 x2 = fb->width - rect->x1 - 1;128 y1 = fb->height - rect->y2;129 y2 = fb->height - rect->y1 - 1;130 x_start = x2;131 y_start = y2;132 break;133 case 270:134 x1 = fb->height - rect->y2;135 x2 = fb->height - rect->y1 - 1;136 y1 = rect->x1;137 y2 = rect->x2 - 1;138 x_start = x2;139 y_start = y1;140 break;141 }142 143 ili9225_command(dbi, ILI9225_HORIZ_WINDOW_ADDR_1, x2);144 ili9225_command(dbi, ILI9225_HORIZ_WINDOW_ADDR_2, x1);145 ili9225_command(dbi, ILI9225_VERT_WINDOW_ADDR_1, y2);146 ili9225_command(dbi, ILI9225_VERT_WINDOW_ADDR_2, y1);147 148 ili9225_command(dbi, ILI9225_RAM_ADDRESS_SET_1, x_start);149 ili9225_command(dbi, ILI9225_RAM_ADDRESS_SET_2, y_start);150 151 ret = mipi_dbi_command_buf(dbi, ILI9225_WRITE_DATA_TO_GRAM, tr,152 width * height * 2);153err_msg:154 if (ret)155 dev_err_once(fb->dev->dev, "Failed to update display %d\n", ret);156}157 158static void ili9225_pipe_update(struct drm_simple_display_pipe *pipe,159 struct drm_plane_state *old_state)160{161 struct drm_plane_state *state = pipe->plane.state;162 struct drm_shadow_plane_state *shadow_plane_state = to_drm_shadow_plane_state(state);163 struct drm_framebuffer *fb = state->fb;164 struct drm_rect rect;165 int idx;166 167 if (!pipe->crtc.state->active)168 return;169 170 if (!drm_dev_enter(fb->dev, &idx))171 return;172 173 if (drm_atomic_helper_damage_merged(old_state, state, &rect))174 ili9225_fb_dirty(&shadow_plane_state->data[0], fb, &rect,175 &shadow_plane_state->fmtcnv_state);176 177 drm_dev_exit(idx);178}179 180static void ili9225_pipe_enable(struct drm_simple_display_pipe *pipe,181 struct drm_crtc_state *crtc_state,182 struct drm_plane_state *plane_state)183{184 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(pipe->crtc.dev);185 struct drm_shadow_plane_state *shadow_plane_state = to_drm_shadow_plane_state(plane_state);186 struct drm_framebuffer *fb = plane_state->fb;187 struct device *dev = pipe->crtc.dev->dev;188 struct mipi_dbi *dbi = &dbidev->dbi;189 struct drm_rect rect = {190 .x1 = 0,191 .x2 = fb->width,192 .y1 = 0,193 .y2 = fb->height,194 };195 int ret, idx;196 u8 am_id;197 198 if (!drm_dev_enter(pipe->crtc.dev, &idx))199 return;200 201 DRM_DEBUG_KMS("\n");202 203 mipi_dbi_hw_reset(dbi);204 205 /*206 * There don't seem to be two example init sequences that match, so207 * using the one from the popular Arduino library for this display.208 * https://github.com/Nkawu/TFT_22_ILI9225/blob/master/src/TFT_22_ILI9225.cpp209 */210 211 ret = ili9225_command(dbi, ILI9225_POWER_CONTROL_1, 0x0000);212 if (ret) {213 DRM_DEV_ERROR(dev, "Error sending command %d\n", ret);214 goto out_exit;215 }216 ili9225_command(dbi, ILI9225_POWER_CONTROL_2, 0x0000);217 ili9225_command(dbi, ILI9225_POWER_CONTROL_3, 0x0000);218 ili9225_command(dbi, ILI9225_POWER_CONTROL_4, 0x0000);219 ili9225_command(dbi, ILI9225_POWER_CONTROL_5, 0x0000);220 221 msleep(40);222 223 ili9225_command(dbi, ILI9225_POWER_CONTROL_2, 0x0018);224 ili9225_command(dbi, ILI9225_POWER_CONTROL_3, 0x6121);225 ili9225_command(dbi, ILI9225_POWER_CONTROL_4, 0x006f);226 ili9225_command(dbi, ILI9225_POWER_CONTROL_5, 0x495f);227 ili9225_command(dbi, ILI9225_POWER_CONTROL_1, 0x0800);228 229 msleep(10);230 231 ili9225_command(dbi, ILI9225_POWER_CONTROL_2, 0x103b);232 233 msleep(50);234 235 switch (dbidev->rotation) {236 default:237 am_id = 0x30;238 break;239 case 90:240 am_id = 0x18;241 break;242 case 180:243 am_id = 0x00;244 break;245 case 270:246 am_id = 0x28;247 break;248 }249 ili9225_command(dbi, ILI9225_DRIVER_OUTPUT_CONTROL, 0x011c);250 ili9225_command(dbi, ILI9225_LCD_AC_DRIVING_CONTROL, 0x0100);251 ili9225_command(dbi, ILI9225_ENTRY_MODE, 0x1000 | am_id);252 ili9225_command(dbi, ILI9225_DISPLAY_CONTROL_1, 0x0000);253 ili9225_command(dbi, ILI9225_BLANK_PERIOD_CONTROL_1, 0x0808);254 ili9225_command(dbi, ILI9225_FRAME_CYCLE_CONTROL, 0x1100);255 ili9225_command(dbi, ILI9225_INTERFACE_CONTROL, 0x0000);256 ili9225_command(dbi, ILI9225_OSCILLATION_CONTROL, 0x0d01);257 ili9225_command(dbi, ILI9225_VCI_RECYCLING, 0x0020);258 ili9225_command(dbi, ILI9225_RAM_ADDRESS_SET_1, 0x0000);259 ili9225_command(dbi, ILI9225_RAM_ADDRESS_SET_2, 0x0000);260 261 ili9225_command(dbi, ILI9225_GATE_SCAN_CONTROL, 0x0000);262 ili9225_command(dbi, ILI9225_VERTICAL_SCROLL_1, 0x00db);263 ili9225_command(dbi, ILI9225_VERTICAL_SCROLL_2, 0x0000);264 ili9225_command(dbi, ILI9225_VERTICAL_SCROLL_3, 0x0000);265 ili9225_command(dbi, ILI9225_PARTIAL_DRIVING_POS_1, 0x00db);266 ili9225_command(dbi, ILI9225_PARTIAL_DRIVING_POS_2, 0x0000);267 268 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_1, 0x0000);269 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_2, 0x0808);270 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_3, 0x080a);271 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_4, 0x000a);272 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_5, 0x0a08);273 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_6, 0x0808);274 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_7, 0x0000);275 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_8, 0x0a00);276 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_9, 0x0710);277 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_10, 0x0710);278 279 ili9225_command(dbi, ILI9225_DISPLAY_CONTROL_1, 0x0012);280 281 msleep(50);282 283 ili9225_command(dbi, ILI9225_DISPLAY_CONTROL_1, 0x1017);284 285 ili9225_fb_dirty(&shadow_plane_state->data[0], fb, &rect,286 &shadow_plane_state->fmtcnv_state);287 288out_exit:289 drm_dev_exit(idx);290}291 292static void ili9225_pipe_disable(struct drm_simple_display_pipe *pipe)293{294 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(pipe->crtc.dev);295 struct mipi_dbi *dbi = &dbidev->dbi;296 297 DRM_DEBUG_KMS("\n");298 299 /*300 * This callback is not protected by drm_dev_enter/exit since we want to301 * turn off the display on regular driver unload. It's highly unlikely302 * that the underlying SPI controller is gone should this be called after303 * unplug.304 */305 306 ili9225_command(dbi, ILI9225_DISPLAY_CONTROL_1, 0x0000);307 msleep(50);308 ili9225_command(dbi, ILI9225_POWER_CONTROL_2, 0x0007);309 msleep(50);310 ili9225_command(dbi, ILI9225_POWER_CONTROL_1, 0x0a02);311}312 313static int ili9225_dbi_command(struct mipi_dbi *dbi, u8 *cmd, u8 *par,314 size_t num)315{316 struct spi_device *spi = dbi->spi;317 unsigned int bpw = 8;318 u32 speed_hz;319 int ret;320 321 spi_bus_lock(spi->controller);322 gpiod_set_value_cansleep(dbi->dc, 0);323 speed_hz = mipi_dbi_spi_cmd_max_speed(spi, 1);324 ret = mipi_dbi_spi_transfer(spi, speed_hz, 8, cmd, 1);325 spi_bus_unlock(spi->controller);326 if (ret || !num)327 return ret;328 329 if (*cmd == ILI9225_WRITE_DATA_TO_GRAM && !dbi->swap_bytes)330 bpw = 16;331 332 spi_bus_lock(spi->controller);333 gpiod_set_value_cansleep(dbi->dc, 1);334 speed_hz = mipi_dbi_spi_cmd_max_speed(spi, num);335 ret = mipi_dbi_spi_transfer(spi, speed_hz, bpw, par, num);336 spi_bus_unlock(spi->controller);337 338 return ret;339}340 341static const struct drm_simple_display_pipe_funcs ili9225_pipe_funcs = {342 .mode_valid = mipi_dbi_pipe_mode_valid,343 .enable = ili9225_pipe_enable,344 .disable = ili9225_pipe_disable,345 .update = ili9225_pipe_update,346 .begin_fb_access = mipi_dbi_pipe_begin_fb_access,347 .end_fb_access = mipi_dbi_pipe_end_fb_access,348 .reset_plane = mipi_dbi_pipe_reset_plane,349 .duplicate_plane_state = mipi_dbi_pipe_duplicate_plane_state,350 .destroy_plane_state = mipi_dbi_pipe_destroy_plane_state,351};352 353static const struct drm_display_mode ili9225_mode = {354 DRM_SIMPLE_MODE(176, 220, 35, 44),355};356 357DEFINE_DRM_GEM_DMA_FOPS(ili9225_fops);358 359static const struct drm_driver ili9225_driver = {360 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,361 .fops = &ili9225_fops,362 DRM_GEM_DMA_DRIVER_OPS_VMAP,363 .name = "ili9225",364 .desc = "Ilitek ILI9225",365 .date = "20171106",366 .major = 1,367 .minor = 0,368};369 370static const struct of_device_id ili9225_of_match[] = {371 { .compatible = "vot,v220hf01a-t" },372 {},373};374MODULE_DEVICE_TABLE(of, ili9225_of_match);375 376static const struct spi_device_id ili9225_id[] = {377 { "v220hf01a-t", 0 },378 { },379};380MODULE_DEVICE_TABLE(spi, ili9225_id);381 382static int ili9225_probe(struct spi_device *spi)383{384 struct device *dev = &spi->dev;385 struct mipi_dbi_dev *dbidev;386 struct drm_device *drm;387 struct mipi_dbi *dbi;388 struct gpio_desc *rs;389 u32 rotation = 0;390 int ret;391 392 dbidev = devm_drm_dev_alloc(dev, &ili9225_driver,393 struct mipi_dbi_dev, drm);394 if (IS_ERR(dbidev))395 return PTR_ERR(dbidev);396 397 dbi = &dbidev->dbi;398 drm = &dbidev->drm;399 400 dbi->reset = devm_gpiod_get(dev, "reset", GPIOD_OUT_HIGH);401 if (IS_ERR(dbi->reset))402 return dev_err_probe(dev, PTR_ERR(dbi->reset), "Failed to get GPIO 'reset'\n");403 404 rs = devm_gpiod_get(dev, "rs", GPIOD_OUT_LOW);405 if (IS_ERR(rs))406 return dev_err_probe(dev, PTR_ERR(rs), "Failed to get GPIO 'rs'\n");407 408 device_property_read_u32(dev, "rotation", &rotation);409 410 ret = mipi_dbi_spi_init(spi, dbi, rs);411 if (ret)412 return ret;413 414 /* override the command function set in mipi_dbi_spi_init() */415 dbi->command = ili9225_dbi_command;416 417 ret = mipi_dbi_dev_init(dbidev, &ili9225_pipe_funcs, &ili9225_mode, rotation);418 if (ret)419 return ret;420 421 drm_mode_config_reset(drm);422 423 ret = drm_dev_register(drm, 0);424 if (ret)425 return ret;426 427 spi_set_drvdata(spi, drm);428 429 drm_fbdev_dma_setup(drm, 0);430 431 return 0;432}433 434static void ili9225_remove(struct spi_device *spi)435{436 struct drm_device *drm = spi_get_drvdata(spi);437 438 drm_dev_unplug(drm);439 drm_atomic_helper_shutdown(drm);440}441 442static void ili9225_shutdown(struct spi_device *spi)443{444 drm_atomic_helper_shutdown(spi_get_drvdata(spi));445}446 447static struct spi_driver ili9225_spi_driver = {448 .driver = {449 .name = "ili9225",450 .of_match_table = ili9225_of_match,451 },452 .id_table = ili9225_id,453 .probe = ili9225_probe,454 .remove = ili9225_remove,455 .shutdown = ili9225_shutdown,456};457module_spi_driver(ili9225_spi_driver);458 459MODULE_DESCRIPTION("Ilitek ILI9225 DRM driver");460MODULE_AUTHOR("David Lechner <david@lechnology.com>");461MODULE_LICENSE("GPL");462