13constexpr static const char *
const TAG =
"display.mipi_spi";
16static constexpr size_t MIPI_SPI_MAX_CMD_LOG_BYTES = 64;
19static constexpr uint8_t NORON = 0x13;
22static constexpr uint8_t ALL_ON = 0x23;
23static constexpr uint8_t WRAM = 0x24;
24static constexpr uint8_t MIPI = 0x26;
26static constexpr uint8_t RASET = 0x2B;
27static constexpr uint8_t CASET = 0x2A;
28static constexpr uint8_t WDATA = 0x2C;
29static constexpr uint8_t TEON = 0x35;
31static constexpr uint8_t PIXFMT = 0x3A;
32static constexpr uint8_t BRIGHTNESS = 0x51;
33static constexpr uint8_t SWIRE1 = 0x5A;
34static constexpr uint8_t SWIRE2 = 0x5B;
35static constexpr uint8_t PAGESEL = 0xFE;
40static constexpr uint8_t MADCTL_RGB = 0x00;
44static constexpr uint16_t MADCTL_FLIP_FLAG = 0x100;
48static inline void put16_be(uint8_t *buf, uint16_t value) {
68void internal_dump_config(
const char *model,
int width,
int height,
int offset_width,
int offset_height, uint8_t madctl,
69 bool invert_colors,
int display_bits,
bool is_big_endian,
const optional<uint8_t> &brightness,
71 bool has_hardware_rotation);
88 int WIDTH,
int HEIGHT,
int OFFSET_WIDTH,
int OFFSET_HEIGHT, uint16_t MADCTL,
bool HAS_HARDWARE_ROTATION>
90 public spi::SPIDevice<spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING,
91 spi::DATA_RATE_1MHZ> {
110 if constexpr (HAS_HARDWARE_ROTATION) {
132 if constexpr (HAS_HARDWARE_ROTATION)
137 if constexpr (HAS_HARDWARE_ROTATION)
146 if (this->
dc_pin_ !=
nullptr) {
152 pin->digital_write(
true);
164 auto when =
millis() + 120;
168 while (index != vec.size()) {
169 if (vec.size() - index < 2) {
170 esph_log_e(TAG,
"Malformed init sequence");
174 uint8_t cmd = vec[index++];
175 uint8_t
x = vec[index++];
176 if (
x == DELAY_FLAG) {
177 esph_log_d(TAG,
"Delay %dms", cmd);
180 uint8_t num_args =
x & 0x7F;
181 if (vec.size() - index < num_args) {
182 esph_log_e(TAG,
"Malformed init sequence");
186 auto arg_byte = vec[index];
192 esph_log_d(TAG,
"Sleep %dms",
duration);
207 const auto *ptr = vec.data() + index;
210 if (cmd == SLEEP_OUT)
225 if (w <= 0 ||
h <= 0)
227 if (
get_pixel_mode(bitness) != BUFFERPIXEL || big_endian != IS_BIG_ENDIAN) {
229 esph_log_e(TAG,
"Unsupported color depth or bit order");
232 this->
write_to_display_(x_start, y_start, w,
h,
reinterpret_cast<const BUFFERTYPE *
>(ptr), x_offset, y_offset,
240 HAS_HARDWARE_ROTATION);
290 for (
size_t i = 0; i !=
len; i++) {
308 uint8_t madctl = (uint8_t) MADCTL;
309 constexpr bool use_flips = (MADCTL & MADCTL_FLIP_FLAG) != 0;
310 constexpr uint8_t x_mask = use_flips ? MADCTL_XFLIP : MADCTL_MX;
311 constexpr uint8_t y_mask = use_flips ? MADCTL_YFLIP : MADCTL_MY;
312 if constexpr (HAS_HARDWARE_ROTATION) {
330 esph_log_d(TAG,
"Setting MADCTL for rotation %d, value %X", this->
rotation_, madctl);
335 if constexpr (HAS_HARDWARE_ROTATION) {
338 return OFFSET_HEIGHT;
344 if constexpr (HAS_HARDWARE_ROTATION) {
349 return OFFSET_HEIGHT;
354 esph_log_v(TAG,
"Set addr %d/%d, %d/%d", x1, y1, x2, y2);
361 put16_be(buf + 2, y2);
364 put16_be(buf + 2, x2);
400 for (
size_t y = 0;
y !=
static_cast<size_t>(
h);
y++) {
419 void write_to_display_(
int x_start,
int y_start,
int w,
int h,
const BUFFERTYPE *ptr,
int x_offset,
int y_offset,
423 ptr += y_offset * (x_offset + w + x_pad) + x_offset;
424 if constexpr (BUFFERPIXEL == DISPLAYPIXEL) {
426 x_pad *
sizeof(BUFFERTYPE));
429 uint8_t dbuffer[DISPLAYPIXEL * 48];
430 uint8_t *dptr = dbuffer;
431 auto stride = x_offset + w + x_pad;
432 for (
size_t y = 0;
y !=
static_cast<size_t>(
h);
y++) {
433 for (
size_t x = 0;
x !=
static_cast<size_t>(w);
x++) {
434 auto color_val = ptr[
y * stride +
x];
437 if constexpr (IS_BIG_ENDIAN) {
438 *dptr++ = color_val & 0xF8;
439 *dptr++ = ((color_val & 0x7) << 5) | (color_val & 0xE000) >> 11;
440 *dptr++ = (color_val >> 5) & 0xF8;
442 *dptr++ = (color_val >> 8) & 0xF8;
443 *dptr++ = (color_val & 0x7E0) >> 3;
444 *dptr++ = color_val << 3;
448 *dptr++ = color_val << 6;
449 *dptr++ = (color_val & 0x1C) << 3;
450 *dptr++ = (color_val & 0xE0);
452 if constexpr (IS_BIG_ENDIAN) {
453 *dptr++ = (color_val & 0xE0) | ((color_val & 0x1C) >> 2);
454 *dptr++ = (color_val & 3) << 3;
456 *dptr++ = (color_val & 3) << 3;
457 *dptr++ = (color_val & 0xE0) | ((color_val & 0x1C) >> 2);
461 if (dptr == dbuffer +
sizeof(dbuffer)) {
468 if (dptr != dbuffer) {
505 uint16_t WIDTH, uint16_t HEIGHT,
int OFFSET_WIDTH,
int OFFSET_HEIGHT, uint16_t MADCTL,
506 bool HAS_HARDWARE_ROTATION,
int FRACTION,
unsigned ROUNDING>
507class MipiSpiBuffer :
public MipiSpi<BUFFERTYPE, BUFFERPIXEL, IS_BIG_ENDIAN, DISPLAYPIXEL, BUS_TYPE, WIDTH, HEIGHT,
508 OFFSET_WIDTH, OFFSET_HEIGHT, MADCTL, HAS_HARDWARE_ROTATION> {
518 MipiSpi<BUFFERTYPE, BUFFERPIXEL, IS_BIG_ENDIAN, DISPLAYPIXEL, BUS_TYPE, WIDTH, HEIGHT, OFFSET_WIDTH, OFFSET_HEIGHT,
522 " Buffer pixels: %d bits\n"
523 " Buffer fraction: 1/%d\n"
524 " Buffer bytes: %zu\n"
525 " Draw rounding: %u",
526 this->
rotation_, BUFFERPIXEL * 8, FRACTION,
531 MipiSpi<BUFFERTYPE, BUFFERPIXEL, IS_BIG_ENDIAN, DISPLAYPIXEL, BUS_TYPE, WIDTH, HEIGHT, OFFSET_WIDTH, OFFSET_HEIGHT,
532 MADCTL, HAS_HARDWARE_ROTATION>
::setup();
535 if (this->
buffer_ ==
nullptr) {
536 this->
mark_failed(LOG_STR(
"Buffer allocation failed"));
541#if ESPHOME_LOG_LEVEL == ESPHOME_LOG_LEVEL_VERBOSE
551#if ESPHOME_LOG_LEVEL == ESPHOME_LOG_LEVEL_VERBOSE
558 if (this->
page_ !=
nullptr) {
565#if ESPHOME_LOG_LEVEL == ESPHOME_LOG_LEVEL_VERBOSE
566 esph_log_v(TAG,
"Drawing from line %d took %dms", this->
start_line_,
millis() - lap);
571 esph_log_v(TAG,
"x_low %d, y_low %d, x_high %d, y_high %d", this->
x_low_, this->
y_low_, this->
x_high_,
588#if ESPHOME_LOG_LEVEL == ESPHOME_LOG_LEVEL_VERBOSE
589 esph_log_v(TAG,
"Write to display took %dms",
millis() - lap);
593#if ESPHOME_LOG_LEVEL == ESPHOME_LOG_LEVEL_VERBOSE
594 esph_log_v(TAG,
"Total update took %dms",
millis() - now);
602 if constexpr (not HAS_HARDWARE_ROTATION) {
655 return (color.
red & 0xE0) | (color.
g & 0xE0) >> 3 | color.
b >> 6;
657 if constexpr (IS_BIG_ENDIAN) {
658 return (color.
r & 0xF8) | color.
g >> 5 | (color.
g & 0x1C) << 11 | (color.
b & 0xF8) << 5;
660 return (color.
r & 0xF8) << 8 | (color.
g & 0xFC) << 3 | color.
b >> 3;
663 return static_cast<BUFFERTYPE
>(0);
void mark_failed()
Mark this component as failed.
virtual void digital_write(bool value)=0
An STL allocator that uses SPI or internal RAM.
virtual void clear()
Clear the entire screen by filling it with OFF pixels.
virtual void fill(Color color)
Fill the entire screen with the given color.
Rect get_clipping() const
Get the current the clipping rectangle.
DisplayRotation rotation_
const display_writer_t & get_writer() const
Class for MIPI SPI displays with a buffer.
void fill(Color color) override
void draw_pixel_at(int x, int y, Color color) override
static constexpr size_t round_buffer(size_t size)
void dump_config() override
static BUFFERTYPE convert_color(const Color &color)
Base class for MIPI SPI displays.
void set_brightness(uint8_t brightness)
void set_rotation(display::DisplayRotation rotation) override
void dump_config() override
void set_reset_pin(GPIOPin *reset_pin)
optional< uint8_t > brightness_
void draw_pixels_at(int x_start, int y_start, int w, int h, const uint8_t *ptr, display::ColorOrder order, display::ColorBitness bitness, bool big_endian, int x_offset, int y_offset, int x_pad) override
void write_to_display_(int x_start, int y_start, int w, int h, const BUFFERTYPE *ptr, int x_offset, int y_offset, int x_pad)
Writes a buffer to the display.
int get_height_internal() override
int get_height() override
void set_invert_colors(bool invert_colors)
void draw_pixel_at(int x, int y, Color color) override
void set_model(const char *model)
static PixelMode get_pixel_mode(display::ColorBitness bitness)
int get_width_internal() override
std::vector< uint8_t > init_sequence_
uint16_t get_offset_width_()
void set_enable_pins(std::vector< GPIOPin * > enable_pins)
void write_display_data_(const uint8_t *ptr, size_t w, size_t h, size_t pad)
Writes a buffer to the display.
void write_command_(uint8_t cmd)
uint16_t get_offset_height_()
std::vector< GPIOPin * > enable_pins_
display::DisplayType get_display_type() override
void set_init_sequence(const std::vector< uint8_t > &sequence)
void write_command_(uint8_t cmd, uint8_t data)
void set_addr_window_(uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2)
void set_dc_pin(GPIOPin *dc_pin)
void write_command_(uint8_t cmd, const uint8_t *bytes, size_t len)
The SPIDevice is what components using the SPI will create.
void spi_setup() override
void write_byte(uint8_t data)
void write_array(const uint8_t *data, size_t length)
void write_cmd_addr_data(size_t cmd_bits, uint32_t cmd, size_t addr_bits, uint32_t address, const uint8_t *data, size_t length, uint8_t bus_width=1)
@ DISPLAY_ROTATION_270_DEGREES
@ DISPLAY_ROTATION_180_DEGREES
@ DISPLAY_ROTATION_90_DEGREES
const uint8_t MADCTL_YFLIP
const uint8_t MADCTL_XFLIP
const uint8_t SW_RESET_CMD
void internal_dump_config(const char *model, int width, int height, int offset_width, int offset_height, uint8_t madctl, bool invert_colors, int display_bits, bool is_big_endian, const optional< uint8_t > &brightness, GPIOPin *cs, GPIOPin *reset, GPIOPin *dc, int spi_mode, uint32_t data_rate, int bus_width, bool has_hardware_rotation)
Providing packet encoding functions for exchanging data with a remote host.
T clamp_at_most(T value, U max)
char * format_hex_pretty_to(char *buffer, size_t buffer_size, const uint8_t *data, size_t length, char separator)
Format byte array as uppercase hex to buffer (base implementation).
constexpr size_t format_hex_pretty_size(size_t byte_count)
Calculate buffer size needed for format_hex_pretty_to with separator: "XX:XX:...:XX\0".
void HOT delay(uint32_t ms)
uint32_t IRAM_ATTR HOT millis()