logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

qp_ili9486.c (12893B)

    

  1. // Copyright 2021 Nick Brassel (@tzarc)
  2. // Copyright 2023 Pablo Martinez (@elpekenin) <elpekenin@elpekenin.dev>
  3. // SPDX-License-Identifier: GPL-2.0-or-later
  5. #include "qp_internal.h"
  6. #include "qp_comms.h"
  7. #include "qp_ili9486.h"
  8. #include "qp_ili9xxx_opcodes.h"
  9. #include "qp_tft_panel.h"
  11. #ifdef QUANTUM_PAINTER_ILI9486_SPI_ENABLE
  12. #    include "spi_master.h"
  13. #    include <qp_comms_spi.h>
  14. #endif // QUANTUM_PAINTER_ILI9486_SPI_ENABLE
  16. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  17. // Common
  19. // Driver storage
  20. tft_panel_dc_reset_painter_device_t ili9486_drivers[ILI9486_NUM_DEVICES] = {0};
  22. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  23. // Initialization
  25. bool qp_ili9486_init(painter_device_t device, painter_rotation_t rotation) {
  26.     // clang-format off
  27.     const uint8_t ili9486_init_sequence[] = {
  28.         // Command,                 Delay,  N, Data[N]
  29.         ILI9XXX_CMD_RESET,            120,  0,
  30.         ILI9XXX_SET_PIX_FMT,            0,  1, 0x55,
  31.         ILI9XXX_SET_PGAMMA,             0, 15, 0x0F, 0x1F, 0x1C, 0x0C, 0x0F, 0x08, 0x48, 0x98, 0x37, 0x0A, 0x13, 0x04, 0x11, 0x0D, 0x00,
  32.         ILI9XXX_SET_NGAMMA,             0, 15, 0x0F, 0x32, 0x2E, 0x0B, 0x0D, 0x05, 0x47, 0x75, 0x37, 0x06, 0x10, 0x03, 0x24, 0x20, 0x00,
  33.         ILI9XXX_SET_POWER_CTL_1,        0,  2, 0x0D, 0x0D,
  34.         ILI9XXX_SET_POWER_CTL_2,        0,  2, 0x43, 0x00,
  35.         ILI9XXX_SET_POWER_CTL_3,        0,  1, 0x00,
  36.         ILI9XXX_SET_VCOM_CTL_1,         0,  4, 0x00, 0x48, 0x00, 0x48,
  37.         ILI9XXX_SET_INVERSION_CTL,      0,  1, 0x02,
  38.     };
  39.     // clang-format on
  40.     qp_comms_bulk_command_sequence(device, ili9486_init_sequence, sizeof(ili9486_init_sequence));
  42.     // Configure the rotation (i.e. the ordering and direction of memory writes in GRAM)
  43.     const uint8_t madctl[] = {
  44.         [QP_ROTATION_0]   = ILI9XXX_MADCTL_BGR,
  45.         [QP_ROTATION_90]  = ILI9XXX_MADCTL_BGR | ILI9XXX_MADCTL_MV,
  46.         [QP_ROTATION_180] = ILI9XXX_MADCTL_BGR,
  47.         [QP_ROTATION_270] = ILI9XXX_MADCTL_BGR | ILI9XXX_MADCTL_MV,
  48.     };
  49.     const uint8_t functl[] = {
  50.         [QP_ROTATION_0]   = 0x42,
  51.         [QP_ROTATION_90]  = 0x62,
  52.         [QP_ROTATION_180] = 0x22,
  53.         [QP_ROTATION_270] = 0x02,
  54.     };
  56.     // clang-format off
  57.     uint8_t rotation_sequence[] = {
  58.         // Command,                 Delay,  N, Data[N]
  59.         ILI9XXX_SET_MEM_ACS_CTL,        0,  1, madctl[rotation],
  60.         ILI9XXX_SET_FUNCTION_CTL,       0,  2, 0x00, functl[rotation],
  61.         ILI9XXX_CMD_SLEEP_OFF,          5,  0,
  62.         ILI9XXX_CMD_DISPLAY_ON,         5,  0,
  63.     };
  64.     // clang-format on
  65.     qp_comms_bulk_command_sequence(device, rotation_sequence, sizeof(rotation_sequence));
  67.     return true;
  68. }
  70. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  71. // Driver vtable
  73. // waveshare variant needs some tweaks due to shift registers
  74. static void qp_comms_spi_dc_reset_send_command_odd_cs_pulse(painter_device_t device, uint8_t cmd) {
  75.     painter_driver_t *              driver       = (painter_driver_t *)device;
  76.     qp_comms_spi_dc_reset_config_t *comms_config = (qp_comms_spi_dc_reset_config_t *)driver->comms_config;
  78.     gpio_write_pin_low(comms_config->spi_config.chip_select_pin);
  79.     qp_comms_spi_dc_reset_send_command(device, cmd);
  80.     gpio_write_pin_high(comms_config->spi_config.chip_select_pin);
  81. }
  83. static uint32_t qp_comms_spi_send_data_odd_cs_pulse(painter_device_t device, const void *data, uint32_t byte_count) {
  84.     painter_driver_t *              driver       = (painter_driver_t *)device;
  85.     qp_comms_spi_dc_reset_config_t *comms_config = (qp_comms_spi_dc_reset_config_t *)driver->comms_config;
  87.     uint32_t       bytes_remaining = byte_count;
  88.     const uint8_t *p               = (const uint8_t *)data;
  89.     uint32_t       max_msg_length  = 1024;
  91.     gpio_write_pin_high(comms_config->dc_pin);
  92.     while (bytes_remaining > 0) {
  93.         uint32_t bytes_this_loop = QP_MIN(bytes_remaining, max_msg_length);
  94.         bool     odd_bytes       = bytes_this_loop & 1;
  96.         // send data
  97.         gpio_write_pin_low(comms_config->spi_config.chip_select_pin);
  98.         spi_transmit(p, bytes_this_loop);
  99.         p += bytes_this_loop;
  101.         // extra CS toggle, for alignment
  102.         if (odd_bytes) {
  103.             gpio_write_pin_high(comms_config->spi_config.chip_select_pin);
  104.             gpio_write_pin_low(comms_config->spi_config.chip_select_pin);
  105.         }
  107.         bytes_remaining -= bytes_this_loop;
  108.     }
  110.     return byte_count - bytes_remaining;
  111. }
  113. static uint32_t qp_ili9486_send_data_toggling(painter_device_t device, const uint8_t *data, uint32_t byte_count) {
  114.     painter_driver_t *              driver       = (painter_driver_t *)device;
  115.     qp_comms_spi_dc_reset_config_t *comms_config = (qp_comms_spi_dc_reset_config_t *)driver->comms_config;
  117.     uint32_t ret;
  118.     for (uint8_t j = 0; j < byte_count; ++j) {
  119.         gpio_write_pin_low(comms_config->spi_config.chip_select_pin);
  120.         ret = qp_comms_spi_dc_reset_send_data(device, &data[j], 1);
  121.         gpio_write_pin_high(comms_config->spi_config.chip_select_pin);
  122.     }
  124.     return ret;
  125. }
  127. static void qp_comms_spi_send_command_sequence_odd_cs_pulse(painter_device_t device, const uint8_t *sequence, size_t sequence_len) {
  128.     for (size_t i = 0; i < sequence_len;) {
  129.         uint8_t command   = sequence[i];
  130.         uint8_t delay     = sequence[i + 1];
  131.         uint8_t num_bytes = sequence[i + 2];
  133.         qp_comms_spi_dc_reset_send_command_odd_cs_pulse(device, command);
  134.         if (num_bytes > 0) {
  135.             qp_ili9486_send_data_toggling(device, &sequence[i + 3], num_bytes);
  136.         }
  138.         if (delay > 0) {
  139.             wait_ms(delay);
  140.         }
  141.         i += (3 + num_bytes);
  142.     }
  143. }
  145. static bool qp_ili9486_viewport(painter_device_t device, uint16_t left, uint16_t top, uint16_t right, uint16_t bottom) {
  146.     painter_driver_t *                          driver = (painter_driver_t *)device;
  147.     tft_panel_dc_reset_painter_driver_vtable_t *vtable = (tft_panel_dc_reset_painter_driver_vtable_t *)driver->driver_vtable;
  149.     // Fix up the drawing location if required
  150.     left += driver->offset_x;
  151.     right += driver->offset_x;
  152.     top += driver->offset_y;
  153.     bottom += driver->offset_y;
  155.     // Check if we need to manually swap the window coordinates based on whether or not we're in a sideways rotation
  156.     if (vtable->swap_window_coords && (driver->rotation == QP_ROTATION_90 || driver->rotation == QP_ROTATION_270)) {
  157.         uint16_t temp;
  159.         temp = left;
  160.         left = top;
  161.         top  = temp;
  163.         temp   = right;
  164.         right  = bottom;
  165.         bottom = temp;
  166.     }
  168.     // Set up the x-window
  169.     uint8_t xbuf[4] = {left >> 8, left & 0xFF, right >> 8, right & 0xFF};
  170.     qp_comms_spi_dc_reset_send_command_odd_cs_pulse(device, vtable->opcodes.set_column_address);
  171.     qp_ili9486_send_data_toggling(device, xbuf, 4);
  173.     // Set up the y-window
  174.     uint8_t ybuf[4] = {top >> 8, top & 0xFF, bottom >> 8, bottom & 0xFF};
  175.     qp_comms_spi_dc_reset_send_command_odd_cs_pulse(device, vtable->opcodes.set_row_address);
  176.     qp_ili9486_send_data_toggling(device, ybuf, 4);
  178.     // Lock in the window
  179.     qp_comms_spi_dc_reset_send_command_odd_cs_pulse(device, vtable->opcodes.enable_writes);
  180.     return true;
  181. }
  183. // Regular
  184. const tft_panel_dc_reset_painter_driver_vtable_t ili9486_driver_vtable = {
  185.     .base =
  186.         {
  187.             .init            = qp_ili9486_init,
  188.             .power           = qp_tft_panel_power,
  189.             .clear           = qp_tft_panel_clear,
  190.             .flush           = qp_tft_panel_flush,
  191.             .pixdata         = qp_tft_panel_pixdata,
  192.             .viewport        = qp_tft_panel_viewport,
  193.             .palette_convert = qp_tft_panel_palette_convert_rgb565_swapped,
  194.             .append_pixels   = qp_tft_panel_append_pixels_rgb565,
  195.             .append_pixdata  = qp_tft_panel_append_pixdata,
  196.         },
  197.     .num_window_bytes   = 2,
  198.     .swap_window_coords = false,
  199.     .opcodes =
  200.         {
  201.             .display_on         = ILI9XXX_CMD_DISPLAY_ON,
  202.             .display_off        = ILI9XXX_CMD_DISPLAY_OFF,
  203.             .set_column_address = ILI9XXX_SET_COL_ADDR,
  204.             .set_row_address    = ILI9XXX_SET_PAGE_ADDR,
  205.             .enable_writes      = ILI9XXX_SET_MEM,
  206.         },
  207. };
  209. // Waveshare tweaks
  210. const tft_panel_dc_reset_painter_driver_vtable_t ili9486_waveshare_driver_vtable = {
  211.     .base =
  212.         {
  213.             .init            = qp_ili9486_init,
  214.             .power           = qp_tft_panel_power,
  215.             .clear           = qp_tft_panel_clear,
  216.             .flush           = qp_tft_panel_flush,
  217.             .pixdata         = qp_tft_panel_pixdata,
  218.             .viewport        = qp_ili9486_viewport,
  219.             .palette_convert = qp_tft_panel_palette_convert_rgb565_swapped,
  220.             .append_pixels   = qp_tft_panel_append_pixels_rgb565,
  221.             .append_pixdata  = qp_tft_panel_append_pixdata,
  222.         },
  223.     .num_window_bytes   = 2,
  224.     .swap_window_coords = false,
  225.     .opcodes =
  226.         {
  227.             .display_on         = ILI9XXX_CMD_DISPLAY_ON,
  228.             .display_off        = ILI9XXX_CMD_DISPLAY_OFF,
  229.             .set_column_address = ILI9XXX_SET_COL_ADDR,
  230.             .set_row_address    = ILI9XXX_SET_PAGE_ADDR,
  231.             .enable_writes      = ILI9XXX_SET_MEM,
  232.         },
  233. };
  235. static const painter_comms_with_command_vtable_t spi_comms_odd_cs_pulse_vtable = {
  236.     .base =
  237.         {
  238.             .comms_init  = qp_comms_spi_dc_reset_init,
  239.             .comms_start = qp_comms_spi_start,
  240.             .comms_send  = qp_comms_spi_send_data_odd_cs_pulse,
  241.             .comms_stop  = qp_comms_spi_stop,
  242.         },
  243.     .send_command          = qp_comms_spi_dc_reset_send_command_odd_cs_pulse,
  244.     .bulk_command_sequence = qp_comms_spi_send_command_sequence_odd_cs_pulse,
  245. };
  247. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  248. // SPI
  250. #ifdef QUANTUM_PAINTER_ILI9486_SPI_ENABLE
  252. // Factory function for creating a handle to the ILI9486 device
  253. painter_device_t qp_ili9486_make_spi_device(uint16_t panel_width, uint16_t panel_height, pin_t chip_select_pin, pin_t dc_pin, pin_t reset_pin, uint16_t spi_divisor, int spi_mode) {
  254.     for (uint32_t i = 0; i < ILI9486_NUM_DEVICES; ++i) {
  255.         tft_panel_dc_reset_painter_device_t *driver = &ili9486_drivers[i];
  256.         if (!driver->base.driver_vtable) {
  257.             driver->base.driver_vtable         = (const painter_driver_vtable_t *)&ili9486_driver_vtable;
  258.             driver->base.comms_vtable          = (const painter_comms_vtable_t *)&spi_comms_with_dc_vtable;
  259.             driver->base.native_bits_per_pixel = 16; // RGB565
  260.             driver->base.panel_width           = panel_width;
  261.             driver->base.panel_height          = panel_height;
  262.             driver->base.rotation              = QP_ROTATION_0;
  263.             driver->base.offset_x              = 0;
  264.             driver->base.offset_y              = 0;
  266.             // SPI and other pin configuration
  267.             driver->base.comms_config                              = &driver->spi_dc_reset_config;
  268.             driver->spi_dc_reset_config.spi_config.chip_select_pin = chip_select_pin;
  269.             driver->spi_dc_reset_config.spi_config.divisor         = spi_divisor;
  270.             driver->spi_dc_reset_config.spi_config.lsb_first       = false;
  271.             driver->spi_dc_reset_config.spi_config.mode            = spi_mode;
  272.             driver->spi_dc_reset_config.dc_pin                     = dc_pin;
  273.             driver->spi_dc_reset_config.reset_pin                  = reset_pin;
  275.             if (!qp_internal_register_device((painter_device_t)driver)) {
  276.                 memset(driver, 0, sizeof(tft_panel_dc_reset_painter_device_t));
  277.                 return NULL;
  278.             }
  280.             return (painter_device_t)driver;
  281.         }
  282.     }
  283.     return NULL;
  284. }
  286. painter_device_t qp_ili9486_make_spi_waveshare_device(uint16_t panel_width, uint16_t panel_height, pin_t chip_select_pin, pin_t dc_pin, pin_t reset_pin, uint16_t spi_divisor, int spi_mode) {
  287.     painter_device_t device = qp_ili9486_make_spi_device(panel_width, panel_height, chip_select_pin, dc_pin, reset_pin, spi_divisor, spi_mode);
  288.     if (device) {
  289.         tft_panel_dc_reset_painter_device_t *driver = (tft_panel_dc_reset_painter_device_t *)device;
  290.         driver->base.driver_vtable                  = (const painter_driver_vtable_t *)&ili9486_waveshare_driver_vtable;
  291.         driver->base.comms_vtable                   = (const painter_comms_vtable_t *)&spi_comms_odd_cs_pulse_vtable;
  292.     }
  293.     return device;
  294. }
  296. #endif // QUANTUM_PAINTER_ILI9486_SPI_ENABLE
  298. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////