summaryrefslogtreecommitdiff
path: root/docs/quantum_painter.md
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2022-07-02 13:20:45 +1000
committerGitHub <noreply@github.com>2022-07-02 13:20:45 +1000
commitb67ae67687b00ffb11ef9c4652e7f7f77b0c7b6d (patch)
treea2ba13597a00ed95e8b10a2371f08bf65f1e4942 /docs/quantum_painter.md
parentd6c39490df2aa114b4fb0fba00b4c03b5ff3a405 (diff)
downloadqmk_firmware-b67ae67687b00ffb11ef9c4652e7f7f77b0c7b6d.tar.gz
qmk_firmware-b67ae67687b00ffb11ef9c4652e7f7f77b0c7b6d.zip
[QP] Add ILI9488 support. (#17438)
Diffstat (limited to 'docs/quantum_painter.md')
-rw-r--r--docs/quantum_painter.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/quantum_painter.md b/docs/quantum_painter.md
index a3705b62ce..2386a70933 100644
--- a/docs/quantum_painter.md
+++ b/docs/quantum_painter.md
@@ -24,6 +24,7 @@ Hardware supported:
| GC9A01 | RGB LCD (circular) | 240x240 | SPI + D/C + RST | `QUANTUM_PAINTER_DRIVERS = gc9a01_spi` |
| ILI9163 | RGB LCD | 128x128 | SPI + D/C + RST | `QUANTUM_PAINTER_DRIVERS = ili9163_spi` |
| ILI9341 | RGB LCD | 240x320 | SPI + D/C + RST | `QUANTUM_PAINTER_DRIVERS = ili9341_spi` |
+| ILI9488 | RGB LCD | 320x480 | SPI + D/C + RST | `QUANTUM_PAINTER_DRIVERS = ili9488_spi` |
| SSD1351 | RGB OLED | 128x128 | SPI + D/C + RST | `QUANTUM_PAINTER_DRIVERS = ssd1351_spi` |
| ST7789 | RGB LCD | 240x320, 240x240 | SPI + D/C + RST | `QUANTUM_PAINTER_DRIVERS = st7789_spi` |
@@ -654,6 +655,30 @@ The maximum number of displays can be configured by changing the following in yo
#define ILI9341_NUM_DEVICES 3
```
+### ILI9488 :id=qp-driver-ili9488
+
+Enabling support for the ILI9488 in Quantum Painter is done by adding the following to `rules.mk`:
+
+```make
+QUANTUM_PAINTER_ENABLE = yes
+QUANTUM_PAINTER_DRIVERS = ili9488_spi
+```
+
+Creating a ILI9488 device in firmware can then be done with the following API:
+
+```c
+painter_device_t qp_ili9488_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);
+```
+
+The device handle returned from the `qp_ili9488_make_spi_device` function can be used to perform all other drawing operations.
+
+The maximum number of displays can be configured by changing the following in your `config.h` (default is 1):
+
+```c
+// 3 displays:
+#define ILI9488_NUM_DEVICES 3
+```
+
### SSD1351 :id=qp-driver-ssd1351
Enabling support for the SSD1351 in Quantum Painter is done by adding the following to `rules.mk`: