black/white e-Paper/e-Ink display driver by silkeh · Pull Request #12509 · RIOT-OS/RIOT

silkeh · 2019-10-19T14:45:06Z

Contribution description

This PR adds a driver for black/white e-paper/e-ink SPI display drivers/controllers, including:

Default parameters for the IL3829 (tested)
Default parameters for the SSD1673 (see boards: add support for Phytec 'reel board' #11096, untested)
Header files containing RIOT logos. These were generated using png2c.
Some questions:
- Should I move these to a generally available directory?
- What should the copyright notice be?
Tests for the display driver. A video with the full test can be found here.

With the right parameters, this driver should work with most black and white e-paper display drivers. This has only been tested with the IL3829, which is commonly used in 1.54 inch black and white e-Paper displays like this one.

This PR is based on #11078 with some major rework to get it all in a more generic package.

Testing procedure

A test program is included (tests/driver_il3829).
Modify the makefile for a microcontroller/display combination you have and go for it.

Issues/PRs references

This is a complete rework based on the feedback from #11078.

drivers/epd_bw_spi/epd_bw_spi.c

silkeh · 2020-02-01T16:00:52Z

@bergzand ping!

bergzand · 2020-02-01T17:07:14Z

@aabadie You have a proposal on a unified display driver API right? Would it be possible for you to give this driver a review at some point?

Citrullin · 2020-02-02T00:21:38Z

@bergzand Where is the proposal for the driver? I would like to know, if this also fits into my needs :)

bergzand · 2020-02-02T09:09:21Z

@Citrullin There is a start of it in #13124 but I don't think there is a dedicated PR or issue yet

aabadie · 2020-02-02T14:17:31Z

Where is the proposal for the driver?

It's in e3fb86e and e7cbd70 from #13124 but it's still very minimal (only one map function exposed by the generic API). I'm planning to add getter/setter functions to be able to control/access internal states/parameters of the display drivers from higher level functions (like lvgl for example).
If you think the API is useful, I can split it out from #13124 and open a dedicated PR.

silkeh · 2020-04-01T14:03:36Z

I have updated the PR with an implementation of disp_dev, some minor fixes and a rebase on master.

Citrullin · 2020-05-08T19:16:41Z

@silkeh I started working on it as well. I need to split up your code in order to make it work with the IL0373. For example the variable values in epd_bw_spi_internal.h are different for the IL0373. There are some fixed values, which needs to get variables.

Where is the proposal for the driver?

It's in e3fb86e and e7cbd70 from #13124 but it's still very minimal (only one map function exposed by the generic API). I'm planning to add getter/setter functions to be able to control/access internal states/parameters of the display drivers from higher level functions (like lvgl for example).
If you think the API is useful, I can split it out from #13124 and open a dedicated PR.

Looks similar to SAUL. I think that is something we can work on.

silkeh · 2020-10-19T11:34:55Z

@aabadie, @bergzand: ping! 🎂

drivers/epd_bw_spi/include/epd_bw_spi_params.h

drivers/epd_bw_spi/epd_bw_spi.c

tests/driver_epd_bw_spi_disp_dev/Makefile

tests/driver_epd_bw_spi/Makefile

drivers/epd_bw_spi/epd_bw_spi.c

jeandudey · 2020-11-02T10:20:54Z

Finally made it work on an esp32-wroom-32 board with the following patch (with a previous git rebase master):

0001-fixup-epd_bw_spi-add-generic-black-and-white-SPI-e-P.patch

From d7a2b5f36b52b13970758371017d6d6f559d451c Mon Sep 17 00:00:00 2001
From: Jean Pierre Dudey <[email protected]>
Date: Mon, 2 Nov 2020 11:14:47 +0100
Subject: [PATCH] fixup! epd_bw_spi: add generic black and white SPI e-Paper
 display driver

---
 drivers/epd_bw_spi/epd_bw_spi.c               | 23 +++++++++++-------
 .../epd_bw_spi/include/epd_bw_spi_params.h    | 24 ++++++++++++++++++-
 drivers/include/epd_bw_spi.h                  |  7 ++++++
 3 files changed, 45 insertions(+), 9 deletions(-)

diff --git a/drivers/epd_bw_spi/epd_bw_spi.c b/drivers/epd_bw_spi/epd_bw_spi.c
index c1c407a40..6f76537a3 100644
--- a/drivers/epd_bw_spi/epd_bw_spi.c
+++ b/drivers/epd_bw_spi/epd_bw_spi.c
@@ -64,7 +64,7 @@ void epd_bw_spi_wait(epd_bw_spi_params_t *p, uint32_t usec)
         while (gpio_read(p->busy_pin)) {}
     }
     else {
-        DEBUG("[epd_bw_spi] wait: for %lu microseconds\n", usec);
+        DEBUG("[epd_bw_spi] wait: for %"PRIu32"microseconds\n", usec);
         xtimer_usleep(usec);
     }
 }
@@ -114,9 +114,10 @@ int epd_bw_spi_init(epd_bw_spi_t *dev,
 
 void epd_bw_spi_display_init(epd_bw_spi_t *dev)
 {
+    epd_bw_spi_hwreset(dev);
+
     le_uint16_t y_data[2] = { 0 };
     uint8_t y_size;
-
     if (dev->controller.size_y <= 255) {
         y_data[0].u8[0] = dev->size_y - 1;
         y_size = 2;
@@ -179,7 +180,7 @@ void epd_bw_spi_deactivate(epd_bw_spi_t *dev)
 void epd_bw_spi_init_full(epd_bw_spi_t *dev)
 {
     epd_bw_spi_display_init(dev);
-    epd_bw_spi_set_area(dev, 0, 200, 0, 200);
+    epd_bw_spi_set_area(dev, 0, dev->size_x, 0, dev->size_y);
     epd_bw_spi_write_cmd(&dev->params, EPD_BW_SPI_CMD_WRITE_LUT_REGISTER,
                          dev->controller.lut_full, dev->controller.lut_size);
 }
@@ -301,18 +302,24 @@ void epd_bw_spi_sleep(epd_bw_spi_t *dev)
 }
 
 void epd_bw_spi_wake(epd_bw_spi_t *dev)
+{
+    epd_bw_spi_hwreset(dev);
+
+    /* Turn off sleep mode */
+    uint8_t data[] = { 0x00 };
+    epd_bw_spi_write_cmd(&dev->params, EPD_BW_SPI_CMD_DEEP_SLEEP_MODE, data, 1);
+    epd_bw_spi_wait(&dev->params, EPD_BW_SPI_WAIT_RESET);
+}
+
+void epd_bw_spi_hwreset(epd_bw_spi_t *dev)
 {
     /* Give a low pulse on the reset pin */
     if (dev->params.rst_pin != GPIO_UNDEF) {
         gpio_clear(dev->params.rst_pin);
         xtimer_usleep(EPD_BW_SPI_WAIT_RESET);
         gpio_set(dev->params.rst_pin);
+        xtimer_usleep(EPD_BW_SPI_WAIT_RESET);
     }
-
-    /* Turn off sleep mode */
-    uint8_t data[] = { 0x00 };
-    epd_bw_spi_write_cmd(&dev->params, EPD_BW_SPI_CMD_DEEP_SLEEP_MODE, data, 1);
-    epd_bw_spi_wait(&dev->params, EPD_BW_SPI_WAIT_RESET);
 }
 
 void epd_bw_spi_swreset(epd_bw_spi_t *dev)
diff --git a/drivers/epd_bw_spi/include/epd_bw_spi_params.h b/drivers/epd_bw_spi/include/epd_bw_spi_params.h
index a0590ff40..544ad0a27 100644
--- a/drivers/epd_bw_spi/include/epd_bw_spi_params.h
+++ b/drivers/epd_bw_spi/include/epd_bw_spi_params.h
@@ -37,7 +37,7 @@ extern "C" {
 #define EPD_BW_SPI_PARAM_SPI_CLK    (SPI_CLK_5MHZ)
 #endif
 #ifndef EPD_BW_SPI_PARAM_CS
-#define EPD_BW_SPI_PARAM_CS         (GPIO_UNDEF)
+#define EPD_BW_SPI_PARAM_CS         (SPI_CS_UNDEF)
 #endif
 #ifndef EPD_BW_SPI_PARAM_DC
 #define EPD_BW_SPI_PARAM_DC         (GPIO_UNDEF)
@@ -84,6 +84,15 @@ static const uint8_t epd_bw_spi_il3829_lut_default_part[] = {
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x13, 0x14, 0x44, 0x12, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
 
+/**
+ * @brief   Waveform lookup table for a full display refresh for SSD1608
+ *          (HINK-E0154A05 e-Paper).
+ */
+static const uint8_t epd_bw_spi_ssd1608_hink_e0154a05_lut_default_full[] = {
+    0x02, 0x02, 0x01, 0x11, 0x12, 0x12, 0x22, 0x22, 0x66, 0x69,
+    0x69, 0x59, 0x58, 0x99, 0x99, 0x88, 0x00, 0x00, 0x00, 0x00,
+    0xF8, 0xB4, 0x13, 0x51, 0x35, 0x51, 0x51, 0x19, 0x01, 0x00 };
+
 /**
  * @brief    Configuration for IL3829 e-paper display controller
  */
@@ -108,6 +117,19 @@ static const uint8_t epd_bw_spi_il3829_lut_default_part[] = {
         .lut_part = epd_bw_spi_il3829_lut_default_part, \
 }
 
+/**
+ * @brief   Configuration for SSD1608 (HINK-E0154A05) e-paper display controller
+ */
+#define EPD_BW_SPI_CONTROLLER_SSD1608_HINK_E0154A05 { \
+        .vcom = 0xA8, \
+        .size_x = 240, \
+        .size_y = 320, \
+        .lut_size = sizeof epd_bw_spi_ssd1608_hink_e0154a05_lut_default_full, \
+        .lut_full = epd_bw_spi_ssd1608_hink_e0154a05_lut_default_full, \
+        /* NOTE: uses this one of IL3829 for partial updates */ \
+        .lut_part = epd_bw_spi_il3829_lut_default_part, \
+}
+
 /**
  * @brief    Default controller definition
  */
diff --git a/drivers/include/epd_bw_spi.h b/drivers/include/epd_bw_spi.h
index a64165771..8f6767ed3 100644
--- a/drivers/include/epd_bw_spi.h
+++ b/drivers/include/epd_bw_spi.h
@@ -233,6 +233,13 @@ void epd_bw_spi_sleep(epd_bw_spi_t *dev);
  */
 void epd_bw_spi_wake(epd_bw_spi_t *dev);
 
+/**
+ * @brief   Perform a hardware reset of the device.
+ *
+ * This will make the IC registers to be on POR values.
+ */
+void epd_bw_spi_hwreset(epd_bw_spi_t *dev);
+
 /**
  * @brief   Perform a soft reset of the device.
  *
-- 
2.17.1

With the example code of tests/driver_epd_bw_spi:

include ../Makefile.tests_common

BOARD ?= nucleo-f411re

USEMODULE += xtimer
USEMODULE += epd_bw_spi

CFLAGS += -DDISPLAY_X=200
CFLAGS += -DDISPLAY_Y=200
CFLAGS += -DEPD_BW_SPI_CONTROLLER=EPD_BW_SPI_CONTROLLER_SSD1608_HINK_E0154A05
CFLAGS += -DEPD_BW_SPI_PARAM_CS=GPIO23
CFLAGS += -DEPD_BW_SPI_PARAM_DC=GPIO16
CFLAGS += -DEPD_BW_SPI_PARAM_RST=GPIO17
CFLAGS += -DEPD_BW_SPI_PARAM_BUSY=GPIO21

CFLAGS += -DSPI0_MOSI=GPIO18
CFLAGS += -DSPI0_SCK=GPIO5
CFLAGS += -DSPI0_CS=GPIO23

include $(RIOTBASE)/Makefile.include

Citrullin · 2020-11-02T10:56:57Z

@jeandudey This is still an open topic, because it makes more sense to have an unified display API for this. It would be great to get some input on it: #14054, #14051 and #13787

outdated

bergzand

Ack, thank you for the contribution and your patience with this PR!

bors merge

12509: black/white e-Paper/e-Ink display driver r=bergzand a=silkeh Co-authored-by: Silke Hofstra <[email protected]>

bors · 2023-02-02T09:12:12Z

Build failed:

Murdock

bergzand · 2023-02-02T12:51:04Z

Both test applications need a file called Makefile.ci with the following content:

BOARD_INSUFFICIENT_MEMORY := \
    arduino-duemilanove \
    arduino-nano \
    arduino-uno \
    atmega328p-xplained-mini \
    atmega328 \
    #

Feel free to force push these changes

bergzand · 2023-02-02T21:52:04Z

Lets try this again

bors merge

12509: black/white e-Paper/e-Ink display driver r=bergzand a=silkeh Co-authored-by: Silke Hofstra <[email protected]>

bors · 2023-02-02T23:12:37Z

Build failed:

Murdock

benpicco · 2023-02-02T23:38:14Z

tests/driver_epd_bw_spi/Makefile.ci

@@ -0,0 +1,7 @@
+BOARD_INSUFFICIENT_MEMORY := \


You can generate this with

make create-Makefile.ci

tests/driver_epd_bw_spi/Makefile.ci

tests/driver_epd_bw_spi_disp_dev/Makefile.ci

bergzand

Thanks,

Bors merge

bors · 2023-02-03T21:57:50Z

🕐 Waiting for PR status (GitHub check) to be set, probably by CI. Bors will automatically try to run when all required PR statuses are set.

bergzand · 2023-02-04T09:57:00Z

Bors merge

bors · 2023-02-04T12:11:08Z

Build succeeded:

bergzand · 2023-02-04T13:41:11Z

Thanks for the effort you put into this @silkeh

silkeh mentioned this pull request Oct 19, 2019

WIP: IL3829 e-Paper/e-Ink display driver #11078

Closed

silkeh commented Oct 19, 2019

View reviewed changes

drivers/epd_bw_spi/epd_bw_spi.c Show resolved Hide resolved

silkeh commented Oct 19, 2019

View reviewed changes

drivers/epd_bw_spi/epd_bw_spi.c Outdated Show resolved Hide resolved

benpicco added Area: drivers Area: Device drivers Type: new feature The issue requests / The PR implemements a new feature for RIOT labels Oct 21, 2019

aabadie mentioned this pull request Feb 2, 2020

sys/disp_dev: add generic interface for display drivers #13262

Merged

silkeh force-pushed the pr/epd-il3829 branch from d4f2781 to a00ad63 Compare April 1, 2020 14:00

silkeh requested review from MichelRottleuthner, aabadie, fjmolinas, leandrolanzieri and smlng as code owners April 1, 2020 14:00

silkeh force-pushed the pr/epd-il3829 branch from a00ad63 to 5cdfea9 Compare April 1, 2020 14:03

silkeh mentioned this pull request Apr 1, 2020

disp_dev: color depth and coordinate system #13787

Open

silkeh force-pushed the pr/epd-il3829 branch 2 times, most recently from dc4401b to 2a02586 Compare April 1, 2020 15:21

jeandudey reviewed Oct 31, 2020

View reviewed changes

drivers/epd_bw_spi/include/epd_bw_spi_params.h Outdated Show resolved Hide resolved

jeandudey reviewed Oct 31, 2020

View reviewed changes

drivers/epd_bw_spi/epd_bw_spi.c Outdated Show resolved Hide resolved

jeandudey reviewed Nov 1, 2020

View reviewed changes

drivers/epd_bw_spi/epd_bw_spi.c Outdated Show resolved Hide resolved

jeandudey approved these changes Nov 2, 2020

View reviewed changes

tests/driver_epd_bw_spi_disp_dev/Makefile Outdated Show resolved Hide resolved

tests/driver_epd_bw_spi/Makefile Outdated Show resolved Hide resolved

drivers/epd_bw_spi/epd_bw_spi.c Show resolved Hide resolved

bergzand removed CI: no fast fail don't abort PR build after first error State: waiting for maintainer State: Action by a maintainer is required labels Feb 2, 2023

bergzand approved these changes Feb 2, 2023

View reviewed changes

bors bot added a commit that referenced this pull request Feb 2, 2023

Merge #12509

dc383a4

12509: black/white e-Paper/e-Ink display driver r=bergzand a=silkeh Co-authored-by: Silke Hofstra <[email protected]>

silkeh force-pushed the pr/epd-il3829 branch from c14efa4 to cab9ac6 Compare February 2, 2023 19:14

bors bot added a commit that referenced this pull request Feb 2, 2023

Merge #12509

43388f1

12509: black/white e-Paper/e-Ink display driver r=bergzand a=silkeh Co-authored-by: Silke Hofstra <[email protected]>

benpicco reviewed Feb 2, 2023

View reviewed changes

bergzand requested changes Feb 3, 2023

View reviewed changes

tests/driver_epd_bw_spi/Makefile.ci Show resolved Hide resolved

tests/driver_epd_bw_spi_disp_dev/Makefile.ci Show resolved Hide resolved

silkeh added 2 commits February 3, 2023 22:55

tests: add epd_bw_spi test

d066588

tests: add epd_bw_spi_disp_dev test

081a69b

silkeh force-pushed the pr/epd-il3829 branch from cab9ac6 to 081a69b Compare February 3, 2023 21:55

bergzand approved these changes Feb 3, 2023

View reviewed changes

bors bot merged commit f3a487b into RIOT-OS:master Feb 4, 2023

jia200x modified the milestones: Release 2022.04, Release 2023.04 Apr 25, 2023

Conversation

silkeh commented Oct 19, 2019

Contribution description

Testing procedure

Issues/PRs references

Uh oh!

Uh oh!

Uh oh!

silkeh commented Feb 1, 2020

Uh oh!

bergzand commented Feb 1, 2020

Uh oh!

Citrullin commented Feb 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bergzand commented Feb 2, 2020

Uh oh!

aabadie commented Feb 2, 2020

Uh oh!

silkeh commented Apr 1, 2020

Uh oh!

Citrullin commented May 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

silkeh commented Oct 19, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeandudey commented Nov 2, 2020

Uh oh!

Citrullin commented Nov 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bergzand left a comment

Choose a reason for hiding this comment

Uh oh!

bors bot commented Feb 2, 2023

Uh oh!

bergzand commented Feb 2, 2023

Uh oh!

bergzand commented Feb 2, 2023

Uh oh!

bors bot commented Feb 2, 2023

Uh oh!

benpicco Feb 2, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bergzand left a comment

Choose a reason for hiding this comment

Uh oh!

bors bot commented Feb 3, 2023

Uh oh!

bergzand commented Feb 4, 2023

Uh oh!

bors bot commented Feb 4, 2023

Uh oh!

bergzand commented Feb 4, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

Citrullin commented Feb 2, 2020 •

edited

Loading

Citrullin commented May 8, 2020 •

edited

Loading

Citrullin commented Nov 2, 2020 •

edited

Loading