Initial commit, untested

This commit is contained in:
elpekenin 2022-12-31 16:39:41 +01:00
parent 590c889537
commit 210a560f01
3 changed files with 191 additions and 0 deletions

View File

@ -0,0 +1,127 @@
// Copyright 2022 Pablo Martinez (@elpekenin)
// SPDX-License-Identifier: GPL-2.0-or-later
#include "qp_internal.h"
#include "qp_comms.h"
#include "qp_ssd1680.h"
#include "qp_ssd1680_opcodes.h"
#include "qp_eink_panel.h"
#include "qp_surface.h"
#ifdef QUANTUM_PAINTER_SSD1680_SPI_ENABLE
# include <qp_comms_spi.h>
#endif // QUANTUM_PAINTER_SSD1680_SPI_ENABLE
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Common
// Driver storage
eink_panel_dc_reset_painter_device_t ssd1680_drivers[SSD1680_NUM_DEVICES] = {0};
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Initialization
bool qp_ssd1680_init(painter_device_t device, painter_rotation_t rotation) {
struct eink_panel_dc_reset_painter_device_t *driver = (struct eink_panel_dc_reset_painter_device_t *)device;
// clang-format off
const uint8_t ssd1680_init_sequence[] = {
// Command, Delay, N, Data[N]
SSD1680_SOFT_RESET, 120, 1, 0x14,
SSD1680_DATA_ENTRY_MODE, 0, 1, 0x01,
SSD1680_BORDER_CONTROL, 0, 1, 0x05,
SSD1680_DISPLAY_UPDATE_CONTROL, 0, 2, 0x00, 0x80,
SSD1680_TEMP_SENSOR, 0, 1, 0x80,
SSD1680_VCOM_VOLTAGE, 0, 1, 0x36,
SSD1680_GATE_VOLTAGE, 0, 1, 0x17,
SSD1680_SOURCE_VOLTAGE, 0, 3, 0x41, 0x00, 0x32,
SSD1680_RAM_X_SIZE, 0, 2, 0x00, (driver->base.panel_height/8 - 1) & 0xFF,
SSD1680_RAM_X_COUNTER, 0, 1, 0x01,
SSD1680_RAM_Y_SIZE, 0, 4, (driver->base.panel_width-1) & 0xFF, ((driver->base.panel_width-1) >> 8) & 0xFF, 0x00, 0x00,
SSD1680_RAM_Y_COUNTER, 0, 2, (driver->base.panel_width-1) & 0xFF, ((driver->base.panel_width-1) >> 8) & 0xFF,
SSD1680_RESOLUTION, 0, 3, (driver->base.panel_width-1) & 0xFF, ((driver->base.panel_width-1) >> 8) & 0xFF, 0x00,
SSD1680_UPDATE_MODE, 0, 1, 0xF4
};
// clang-format on
qp_comms_bulk_command_sequence(device, ssd1680_init_sequence, sizeof(ssd1680_init_sequence));
driver->base.rotation = rotation;
qp_init(driver->black_surface, rotation);
qp_init(driver->red_surface, rotation);
return true;
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Driver vtable
const struct eink_panel_dc_reset_painter_driver_vtable_t ssd1680_driver_vtable = {
.base =
{
.init = qp_ssd1680_init,
.power = qp_eink_panel_power,
.clear = qp_eink_panel_clear,
.flush = qp_eink_panel_flush,
.pixdata = qp_eink_panel_pixdata,
.viewport = qp_eink_panel_viewport,
.palette_convert = qp_eink_panel_palette_convert_eink3,
.append_pixels = qp_eink_panel_append_pixels_eink3,
},
.num_window_bytes = 2,
.swap_window_coords = false,
.opcodes =
{
.display_on = SSD1680_NOP, // Couldnt find a turn-on command
.display_off = SSD1680_NOP, // There is a cmd to go into sleep mode, but requires HW reset in order to wake up
.send_black_data = SSD1680_SEND_BLACK,
.send_red_data = SSD1680_SEND_RED,
.refresh = SSD1680_DISPLAY_REFRESH,
}
};
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// SPI
#ifdef QUANTUM_PAINTER_SSD1680_SPI_ENABLE
// Factory function for creating a handle to the SSD1680 device
painter_device_t qp_ssd1680_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, void *ptr) {
for (uint32_t i = 0; i < SSD1680_NUM_DEVICES; ++i) {
eink_panel_dc_reset_painter_device_t *driver = &ssd1680_drivers[i];
if (!driver->base.driver_vtable) {
driver->base.driver_vtable = (const struct painter_driver_vtable_t *)&ssd1680_driver_vtable;
driver->base.comms_vtable = (const struct painter_comms_vtable_t *)&spi_comms_with_dc_shiftreg_vtable;
driver->base.native_bits_per_pixel = 8; // Black and red channels
driver->base.panel_width = panel_width;
driver->base.panel_height = panel_height;
driver->base.rotation = QP_ROTATION_0;
driver->base.offset_x = 0;
driver->base.offset_y = 0;
driver->black_surface = qp_make_mono1bpp_surface(panel_width, panel_height, ptr);
driver->red_surface = qp_make_mono1bpp_surface(panel_width, panel_height, ptr+SURFACE_REQUIRED_BUFFER_BYTE_SIZE(panel_width, panel_height, 1));
driver->timeout = 3 * 60 * 1000; // 3 minutes just because
driver->can_flush = true;
driver->invert_black = true;
driver->invert_red = false;
// SPI and other pin configuration
driver->base.comms_config = &driver->spi_dc_reset_config;
driver->spi_dc_reset_config.spi_config.chip_select_pin = chip_select_pin;
driver->spi_dc_reset_config.spi_config.divisor = spi_divisor;
driver->spi_dc_reset_config.spi_config.lsb_first = false;
driver->spi_dc_reset_config.spi_config.mode = spi_mode;
driver->spi_dc_reset_config.dc_pin = dc_pin;
driver->spi_dc_reset_config.reset_pin = reset_pin;
return (painter_device_t)driver;
}
}
return NULL;
}
#endif // QUANTUM_PAINTER_SSD1680_SPI_ENABLE
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

View File

@ -0,0 +1,39 @@
// Copyright 2022 Pablo Martinez (@elpekenin)
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "gpio.h"
#include "qp_internal.h"
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Quantum Painter SSD1680_NUM_DEVICES configurables (add to your keyboard's config.h)
#ifndef SSD1680_NUM_DEVICES
/**
* @def This controls the maximum number of SSD1680_NUM_DEVICES devices that Quantum Painter can communicate with at any one time.
* Increasing this number allows for multiple displays to be used.
*/
# define SSD1680_NUM_DEVICES 1
#endif
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Quantum Painter SSD1680_NUM_DEVICES device factories
#ifdef QUANTUM_PAINTER_SSD1680_SPI_ENABLE
/**
* Factory method for an SSD1680 SPI LCD device.
*
* @param panel_width[in] the width of the display panel
* @param panel_height[in] the height of the display panel
* @param chip_select_pin[in] the GPIO pin used for SPI chip select
* @param dc_pin[in] the GPIO pin used for D/C control
* @param reset_pin[in] the GPIO pin used for RST
* @param spi_divisor[in] the SPI divisor to use when communicating with the display
* @param spi_mode[in] the SPI mode to use when communicating with the display
* @param ptr[in] the array in which pixel data is stored
* @return the device handle used with all drawing routines in Quantum Painter
*/
painter_device_t qp_ssd1680_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, void *ptr);
#endif // QUANTUM_PAINTER_SSD1680_SPI_ENABLE

View File

@ -0,0 +1,25 @@
// Copyright 2022 Pablo Martinez (@elpekenin)
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Quantum Painter SSD1680 command opcodes
#define SSD1680_NOP 0x00
#define SSD1680_RESOLUTION 0x01
#define SSD1680_GATE_VOLTAGE 0x03
#define SSD1680_SOURCE_VOLTAGE 0x04
#define SSD1680_DATA_ENTRY_MODE 0x11
#define SSD1680_SOFT_RESET 0x12
#define SSD1680_TEMP_SENSOR 0x18
#define SSD1680_DISPLAY_REFRESH 0x20
#define SSD1680_DISPLAY_UPDATE_CONTROL 0x21
#define SSD1680_UPDATE_MODE 0x22
#define SSD1680_SEND_BLACK 0x24
#define SSD1680_SEND_RED 0x26
#define SSD1680_VCOM_VOLTAGE 0x2C
#define SSD1680_BORDER_CONTROL 0x3C
#define SSD1680_RAM_X_SIZE 0x44
#define SSD1680_RAM_Y_SIZE 0x45
#define SSD1680_RAM_X_COUNTER 0x4E
#define SSD1680_RAM_Y_COUNTER 0x4F