aboutsummaryrefslogtreecommitdiff
path: root/drivers/painter/sh1107/qp_sh1107.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/painter/sh1107/qp_sh1107.h')
-rw-r--r--drivers/painter/sh1107/qp_sh1107.h64
1 files changed, 64 insertions, 0 deletions
diff --git a/drivers/painter/sh1107/qp_sh1107.h b/drivers/painter/sh1107/qp_sh1107.h
new file mode 100644
index 0000000000..2b866d7dc8
--- /dev/null
+++ b/drivers/painter/sh1107/qp_sh1107.h
@@ -0,0 +1,64 @@
+#pragma once
+
+#include "gpio.h"
+#include "qp_internal.h"
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// Quantum Painter SH1107 configurables (add to your keyboard's config.h)
+
+#if defined(QUANTUM_PAINTER_SH1107_SPI_ENABLE) && !defined(SH1107_NUM_SPI_DEVICES)
+/**
+ * @def This controls the maximum number of SPI SH1107 devices that Quantum Painter can communicate with at any one time.
+ * Increasing this number allows for multiple displays to be used.
+ */
+# define SH1107_NUM_SPI_DEVICES 1
+#else
+# define SH1107_NUM_SPI_DEVICES 0
+#endif
+
+#if defined(QUANTUM_PAINTER_SH1107_I2C_ENABLE) && !defined(SH1107_NUM_I2C_DEVICES)
+/**
+ * @def This controls the maximum number of I2C SH1107 devices that Quantum Painter can communicate with at any one time.
+ * Increasing this number allows for multiple displays to be used.
+ */
+# define SH1107_NUM_I2C_DEVICES 1
+#else
+# define SH1107_NUM_I2C_DEVICES 0
+#endif
+
+#define SH1107_NUM_DEVICES ((SH1107_NUM_SPI_DEVICES) + (SH1107_NUM_I2C_DEVICES))
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// Quantum Painter SH1107 device factories
+
+#ifdef QUANTUM_PAINTER_SH1107_SPI_ENABLE
+
+/**
+ * Factory method for an SH1107 SPI LCD device.
+ *
+ * @param panel_width[in] the width of the display in pixels (usually 64)
+ * @param panel_height[in] the height of the display in pixels (usually 128)
+ * @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
+ * @return the device handle used with all drawing routines in Quantum Painter
+ */
+painter_device_t qp_sh1107_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);
+
+#endif // QUANTUM_PAINTER_SH1107_SPI_ENABLE
+
+#ifdef QUANTUM_PAINTER_SH1107_I2C_ENABLE
+
+/**
+ * Factory method for an SH1107 I2C LCD device.
+ *
+ * @param panel_width[in] the width of the display in pixels (usually 64)
+ * @param panel_height[in] the height of the display in pixels (usually 128)
+ * @param i2c_address[in] the I2C address to use
+ * @return the device handle used with all drawing routines in Quantum Painter
+ */
+painter_device_t qp_sh1107_make_i2c_device(uint16_t panel_width, uint16_t panel_height, uint8_t i2c_address);
+
+#endif // QUANTUM_PAINTER_SH1107_I2C_ENABLE