logo

qmk_firmware

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

qp_sh1106.c (9504B)

    

  1. // Copyright 2023 Nick Brassel (@tzarc)
  2. // SPDX-License-Identifier: GPL-2.0-or-later
  4. #include "qp_internal.h"
  5. #include "qp_comms.h"
  6. #include "qp_oled_panel.h"
  7. #include "qp_sh1106.h"
  8. #include "qp_sh1106_opcodes.h"
  9. #include "qp_surface.h"
  10. #include "qp_surface_internal.h"
  12. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  13. // Driver storage
  14. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  16. typedef struct sh1106_device_t {
  17.     oled_panel_painter_device_t oled;
  19.     uint8_t framebuffer[SURFACE_REQUIRED_BUFFER_BYTE_SIZE(128, 64, 1)];
  20. } sh1106_device_t;
  22. static sh1106_device_t sh1106_drivers[SH1106_NUM_DEVICES] = {0};
  24. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  25. // Quantum Painter API implementations
  27. // Initialisation
  28. __attribute__((weak)) bool qp_sh1106_init(painter_device_t device, painter_rotation_t rotation) {
  29.     sh1106_device_t *driver = (sh1106_device_t *)device;
  31.     // Change the surface geometry based on the panel rotation
  32.     if (rotation == QP_ROTATION_90 || rotation == QP_ROTATION_270) {
  33.         driver->oled.surface.base.panel_width  = driver->oled.base.panel_height;
  34.         driver->oled.surface.base.panel_height = driver->oled.base.panel_width;
  35.     } else {
  36.         driver->oled.surface.base.panel_width  = driver->oled.base.panel_width;
  37.         driver->oled.surface.base.panel_height = driver->oled.base.panel_height;
  38.     }
  40.     // Init the internal surface
  41.     if (!qp_init(&driver->oled.surface.base, QP_ROTATION_0)) {
  42.         qp_dprintf("Failed to init internal surface in qp_sh1106_init\n");
  43.         return false;
  44.     }
  46.     // clang-format off
  47.     uint8_t sh1106_init_sequence[] = {
  48.         // Command,                 Delay,  N, Data[N]
  49.         SH1106_SET_MUX_RATIO,           0,  1, 0x3F,
  50.         SH1106_DISPLAY_OFFSET,          0,  1, 0x00,
  51.         SH1106_DISPLAY_START_LINE,      0,  0,
  52.         SH1106_SET_SEGMENT_REMAP_INV,   0,  0,
  53.         SH1106_COM_SCAN_DIR_DEC,        0,  0,
  54.         SH1106_COM_PADS_HW_CFG,         0,  1, 0x12,
  55.         SH1106_SET_CONTRAST,            0,  1, 0x7F,
  56.         SH1106_ALL_ON_RESUME,           0,  0,
  57.         SH1106_NON_INVERTING_DISPLAY,   0,  0,
  58.         SH1106_SET_OSC_DIVFREQ,         0,  1, 0x80,
  59.         SH1106_SET_CHARGE_PUMP,         0,  1, 0x14,
  60.         SH1106_DISPLAY_ON,              0,  0,
  61.     };
  62.     // clang-format on
  64.     // If the display height is anything other than the default 64 pixels, change SH1106_SET_MUX_RATIO data byte to the correct value
  65.     if (driver->oled.base.panel_height != 64) {
  66.         sh1106_init_sequence[3] = driver->oled.base.panel_height - 1;
  67.     }
  69.     // For 128x32 or 96x16 displays, change SH1106_COM_PADS_HW_CFG data byte from alternative (0x12) to sequential (0x02) configuration
  70.     if (driver->oled.base.panel_height <= 32) {
  71.         sh1106_init_sequence[20] = 0x02;
  72.     }
  74.     qp_comms_bulk_command_sequence(device, sh1106_init_sequence, sizeof(sh1106_init_sequence));
  75.     return true;
  76. }
  78. // Screen flush
  79. bool qp_sh1106_flush(painter_device_t device) {
  80.     sh1106_device_t *driver = (sh1106_device_t *)device;
  82.     if (!driver->oled.surface.dirty.is_dirty) {
  83.         return true;
  84.     }
  86.     switch (driver->oled.base.rotation) {
  87.         default:
  88.         case QP_ROTATION_0:
  89.             qp_oled_panel_page_column_flush_rot0(device, &driver->oled.surface.dirty, driver->framebuffer);
  90.             break;
  91.         case QP_ROTATION_90:
  92.             qp_oled_panel_page_column_flush_rot90(device, &driver->oled.surface.dirty, driver->framebuffer);
  93.             break;
  94.         case QP_ROTATION_180:
  95.             qp_oled_panel_page_column_flush_rot180(device, &driver->oled.surface.dirty, driver->framebuffer);
  96.             break;
  97.         case QP_ROTATION_270:
  98.             qp_oled_panel_page_column_flush_rot270(device, &driver->oled.surface.dirty, driver->framebuffer);
  99.             break;
  100.     }
  102.     // Clear the dirty area
  103.     qp_flush(&driver->oled.surface);
  105.     return true;
  106. }
  108. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  109. // Driver vtable
  110. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  112. const oled_panel_painter_driver_vtable_t sh1106_driver_vtable = {
  113.     .base =
  114.         {
  115.             .init            = qp_sh1106_init,
  116.             .power           = qp_oled_panel_power,
  117.             .clear           = qp_oled_panel_clear,
  118.             .flush           = qp_sh1106_flush,
  119.             .pixdata         = qp_oled_panel_passthru_pixdata,
  120.             .viewport        = qp_oled_panel_passthru_viewport,
  121.             .palette_convert = qp_oled_panel_passthru_palette_convert,
  122.             .append_pixels   = qp_oled_panel_passthru_append_pixels,
  123.             .append_pixdata  = qp_oled_panel_passthru_append_pixdata,
  124.         },
  125.     .opcodes =
  126.         {
  127.             .display_on     = SH1106_DISPLAY_ON,
  128.             .display_off    = SH1106_DISPLAY_OFF,
  129.             .set_page       = SH1106_PAGE_ADDR,
  130.             .set_column_lsb = SH1106_SETCOLUMN_LSB,
  131.             .set_column_msb = SH1106_SETCOLUMN_MSB,
  132.         },
  133. };
  135. #ifdef QUANTUM_PAINTER_SH1106_SPI_ENABLE
  136. // Factory function for creating a handle to the SH1106 device
  137. painter_device_t qp_sh1106_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) {
  138.     for (uint32_t i = 0; i < SH1106_NUM_DEVICES; ++i) {
  139.         sh1106_device_t *driver = &sh1106_drivers[i];
  140.         if (!driver->oled.base.driver_vtable) {
  141.             painter_device_t surface = qp_make_mono1bpp_surface_advanced(&driver->oled.surface, 1, panel_width, panel_height, driver->framebuffer);
  142.             if (!surface) {
  143.                 return NULL;
  144.             }
  146.             // Setup the OLED device
  147.             driver->oled.base.driver_vtable         = (const painter_driver_vtable_t *)&sh1106_driver_vtable;
  148.             driver->oled.base.comms_vtable          = (const painter_comms_vtable_t *)&spi_comms_with_dc_vtable;
  149.             driver->oled.base.native_bits_per_pixel = 1; // 1bpp mono
  150.             driver->oled.base.panel_width           = panel_width;
  151.             driver->oled.base.panel_height          = panel_height;
  152.             driver->oled.base.rotation              = QP_ROTATION_0;
  153.             driver->oled.base.offset_x              = 0;
  154.             driver->oled.base.offset_y              = 0;
  156.             // SPI and other pin configuration
  157.             driver->oled.base.comms_config                                   = &driver->oled.spi_dc_reset_config;
  158.             driver->oled.spi_dc_reset_config.spi_config.chip_select_pin      = chip_select_pin;
  159.             driver->oled.spi_dc_reset_config.spi_config.divisor              = spi_divisor;
  160.             driver->oled.spi_dc_reset_config.spi_config.lsb_first            = false;
  161.             driver->oled.spi_dc_reset_config.spi_config.mode                 = spi_mode;
  162.             driver->oled.spi_dc_reset_config.dc_pin                          = dc_pin;
  163.             driver->oled.spi_dc_reset_config.reset_pin                       = reset_pin;
  164.             driver->oled.spi_dc_reset_config.command_params_uses_command_pin = true;
  166.             if (!qp_internal_register_device((painter_device_t)driver)) {
  167.                 memset(driver, 0, sizeof(sh1106_device_t));
  168.                 return NULL;
  169.             }
  171.             return (painter_device_t)driver;
  172.         }
  173.     }
  174.     return NULL;
  175. }
  177. #endif // QUANTUM_PAINTER_SH1106_SPI_ENABLE
  179. #ifdef QUANTUM_PAINTER_SH1106_I2C_ENABLE
  180. // Factory function for creating a handle to the SH1106 device
  181. painter_device_t qp_sh1106_make_i2c_device(uint16_t panel_width, uint16_t panel_height, uint8_t i2c_address) {
  182.     for (uint32_t i = 0; i < SH1106_NUM_DEVICES; ++i) {
  183.         sh1106_device_t *driver = &sh1106_drivers[i];
  184.         if (!driver->oled.base.driver_vtable) {
  185.             // Instantiate the surface, intentional swap of width/high due to transpose
  186.             painter_device_t surface = qp_make_mono1bpp_surface_advanced(&driver->oled.surface, 1, panel_width, panel_height, driver->framebuffer);
  187.             if (!surface) {
  188.                 return NULL;
  189.             }
  191.             // Setup the OLED device
  192.             driver->oled.base.driver_vtable         = (const painter_driver_vtable_t *)&sh1106_driver_vtable;
  193.             driver->oled.base.comms_vtable          = (const painter_comms_vtable_t *)&i2c_comms_cmddata_vtable;
  194.             driver->oled.base.native_bits_per_pixel = 1; // 1bpp mono
  195.             driver->oled.base.panel_width           = panel_width;
  196.             driver->oled.base.panel_height          = panel_height;
  197.             driver->oled.base.rotation              = QP_ROTATION_0;
  198.             driver->oled.base.offset_x              = 0;
  199.             driver->oled.base.offset_y              = 0;
  201.             // I2C configuration
  202.             driver->oled.base.comms_config       = &driver->oled.i2c_config;
  203.             driver->oled.i2c_config.chip_address = i2c_address;
  205.             if (!qp_internal_register_device((painter_device_t)driver)) {
  206.                 memset(driver, 0, sizeof(sh1106_device_t));
  207.                 return NULL;
  208.             }
  210.             return (painter_device_t)driver;
  211.         }
  212.     }
  213.     return NULL;
  214. }
  216. #endif // QUANTUM_PAINTER_SH1106_I2C_ENABLE