30#include "freertos/FreeRTOS.h"
31#include "freertos/task.h"
37#pragma GCC optimize ("O2")
40#define TFT_UPDATETASK_STACK 1024
41#define TFT_UPDATETASK_PRIORITY 5
43#define TFT_BACKGROUND_PRIMITIVE_TIMEOUT 10000
45#define TFT_SPI_WRITE_FREQUENCY 40000000
47#define TFT_DMACHANNEL 2
60inline uint16_t preparePixel(RGB888
const & px)
62 return ((uint16_t)(px.G & 0xe0) >> 5) |
63 ((uint16_t)(px.R & 0xf8)) |
64 ((uint16_t)(px.B & 0xf8) << 5) |
65 ((uint16_t)(px.G & 0x1c) << 11);
69inline RGB888 nativeToRGB888(uint16_t pattern)
73 ((pattern & 7) << 5) | ((pattern & 0xe000) >> 11),
74 ((pattern & 0x1f00) >> 5)
79inline RGBA8888 nativeToRGBA8888(uint16_t pattern)
83 ((pattern & 7) << 5) | ((pattern & 0xe000) >> 11),
84 ((pattern & 0x1f00) >> 5),
90inline uint16_t RGBA2222toNative(uint8_t rgba2222)
92 return preparePixel(RGB888((rgba2222 & 3) * 85, ((rgba2222 >> 2) & 3) * 85, ((rgba2222 >> 4) & 3) * 85));
96inline uint16_t RGBA8888toNative(RGBA8888
const & rgba8888)
98 return preparePixel(RGB888(rgba8888.R, rgba8888.G, rgba8888.B));
102TFTController::TFTController()
107 m_SPIDevHandle(nullptr),
109 m_controllerWidth(240),
110 m_controllerHeight(320),
113 m_updateTaskHandle(nullptr),
114 m_updateTaskRunning(false),
116 m_reverseHorizontal(false)
121TFTController::~TFTController()
128void TFTController::setupGPIO()
131 configureGPIO(m_DC, GPIO_MODE_OUTPUT);
132 gpio_set_level(m_DC, 1);
135 if (m_RESX != GPIO_UNUSED) {
136 configureGPIO(m_RESX, GPIO_MODE_OUTPUT);
137 gpio_set_level(m_RESX, 1);
141 if (m_CS != GPIO_UNUSED) {
142 configureGPIO(m_CS, GPIO_MODE_OUTPUT);
143 gpio_set_level(m_CS, 1);
151void TFTController::begin(SPIClass * spi, gpio_num_t DC, gpio_num_t RESX, gpio_num_t CS)
169void TFTController::begin(SPIClass * spi,
int DC,
int RESX,
int CS)
171 begin(spi, int2gpio(DC), int2gpio(RESX), int2gpio(CS));
178void TFTController::begin(
int SCK,
int MOSI,
int DC,
int RESX,
int CS,
int host)
180 m_SPIHost = (spi_host_device_t)host;
181 m_SCK = int2gpio(SCK);
182 m_MOSI = int2gpio(MOSI);
184 m_RESX = int2gpio(RESX);
192void TFTController::begin()
194 begin(18, 23, 22, 21, 5, VSPI_HOST);
198void TFTController::end()
200 if (m_updateTaskHandle)
201 vTaskDelete(m_updateTaskHandle);
202 m_updateTaskHandle =
nullptr;
210void TFTController::setResolution(
char const * modeline,
int viewPortWidth,
int viewPortHeight,
bool doubleBuffered)
213 int pos = 0, swidth, sheight;
214 int count = sscanf(modeline,
"\"%[^\"]\" %d %d %n", label, &swidth, &sheight, &pos);
215 if (count != 3 || pos == 0)
218 m_screenWidth = swidth;
219 m_screenHeight = sheight;
224 setScreenSize(m_screenWidth, m_screenHeight);
226 setDoubleBuffered(doubleBuffered);
228 m_viewPortWidth = viewPortWidth < 0 ? m_screenWidth : viewPortWidth;
229 m_viewPortHeight = viewPortHeight < 0 ? m_screenHeight : viewPortHeight;
231 m_rot0ViewPortWidth = m_viewPortWidth;
232 m_rot0ViewPortHeight = m_viewPortHeight;
240 xTaskCreate(&updateTaskFunc,
"", TFT_UPDATETASK_STACK,
this, TFT_UPDATETASK_PRIORITY, &m_updateTaskHandle);
243 m_updateTaskFuncSuspended = 0;
247void TFTController::setScreenCol(
int value)
249 if (value != m_screenCol) {
250 m_screenCol = iclamp(value, 0, m_viewPortWidth - m_screenWidth);
251 Primitive p(PrimitiveCmd::Refresh,
Rect(0, 0, m_viewPortWidth - 1, m_viewPortHeight - 1));
257void TFTController::setScreenRow(
int value)
259 if (value != m_screenRow) {
260 m_screenRow = iclamp(value, 0, m_viewPortHeight - m_screenHeight);
261 Primitive p(PrimitiveCmd::Refresh,
Rect(0, 0, m_viewPortWidth - 1, m_viewPortHeight - 1));
267void TFTController::hardReset()
269 if (m_RESX != GPIO_UNUSED) {
272 configureGPIO(m_RESX, GPIO_MODE_OUTPUT);
273 gpio_set_level(m_RESX, 1);
274 vTaskDelay(5 / portTICK_PERIOD_MS);
275 gpio_set_level(m_RESX, 0);
276 vTaskDelay(20 / portTICK_PERIOD_MS);
277 gpio_set_level(m_RESX, 1);
281 vTaskDelay(150 / portTICK_PERIOD_MS);
286void TFTController::setupOrientation()
289 m_viewPortWidth = m_rot0ViewPortWidth;
290 m_viewPortHeight = m_rot0ViewPortHeight;
293 uint8_t MX = m_reverseHorizontal ? 0x40 : 0;
294 uint8_t madclt = 0x08 | MX;
295 switch (m_orientation) {
296 case TFTOrientation::Rotate90:
297 tswap(m_viewPortWidth, m_viewPortHeight);
301 case TFTOrientation::Rotate180:
304 m_rotOffsetY = m_controllerHeight - m_viewPortHeight;
305 m_rotOffsetX = m_controllerWidth - m_viewPortWidth;
307 case TFTOrientation::Rotate270:
308 tswap(m_viewPortWidth, m_viewPortHeight);
309 madclt |= 0x20 | 0x80;
310 m_rotOffsetX = m_controllerHeight - m_viewPortWidth;
316 writeCommand(TFT_MADCTL);
324 p.cmd = PrimitiveCmd::Reset;
331 if (m_orientation != value || force) {
332 suspendBackgroundPrimitiveExecution();
333 m_orientation = value;
337 resumeBackgroundPrimitiveExecution();
343void TFTController::setReverseHorizontal(
bool value)
345 m_reverseHorizontal = value;
346 setOrientation(m_orientation,
true);
350void TFTController::SPIBegin()
357 spi_bus_config_t busconf;
358 memset(&busconf, 0,
sizeof(busconf));
359 busconf.mosi_io_num = m_MOSI;
360 busconf.miso_io_num = -1;
361 busconf.sclk_io_num = m_SCK;
362 busconf.quadwp_io_num = -1;
363 busconf.quadhd_io_num = -1;
364 busconf.flags = SPICOMMON_BUSFLAG_MASTER;
365 auto r = spi_bus_initialize(m_SPIHost, &busconf, TFT_DMACHANNEL);
366 if (r == ESP_OK || r == ESP_ERR_INVALID_STATE) {
367 spi_device_interface_config_t devconf;
368 memset(&devconf, 0,
sizeof(devconf));
369 devconf.mode = TFT_SPI_MODE;
370 devconf.clock_speed_hz = TFT_SPI_WRITE_FREQUENCY;
371 devconf.spics_io_num = -1;
373 devconf.queue_size = 1;
374 spi_bus_add_device(m_SPIHost, &devconf, &m_SPIDevHandle);
377 if (m_updateTaskFuncSuspended)
378 resumeBackgroundPrimitiveExecution();
382void TFTController::SPIEnd()
389 suspendBackgroundPrimitiveExecution();
391 if (m_SPIDevHandle) {
392 spi_bus_remove_device(m_SPIDevHandle);
393 m_SPIDevHandle =
nullptr;
394 spi_bus_free(m_SPIHost);
399void TFTController::SPIBeginWrite()
403 m_spi->beginTransaction(SPISettings(TFT_SPI_WRITE_FREQUENCY, SPI_MSBFIRST, TFT_SPI_MODE));
407 if (m_SPIDevHandle) {
408 spi_device_acquire_bus(m_SPIDevHandle, portMAX_DELAY);
411 if (m_CS != GPIO_UNUSED) {
412 gpio_set_level(m_CS, 0);
417void TFTController::SPIEndWrite()
419 if (m_CS != GPIO_UNUSED) {
420 gpio_set_level(m_CS, 1);
424 gpio_set_level(m_DC, 1);
428 m_spi->endTransaction();
432 if (m_SPIDevHandle) {
433 spi_device_release_bus(m_SPIDevHandle);
438void TFTController::SPIWriteByte(uint8_t
data)
446 if (m_SPIDevHandle) {
447 spi_transaction_t ta;
448 ta.flags = SPI_TRANS_USE_TXDATA;
451 ta.tx_data[0] =
data;
452 ta.rx_buffer =
nullptr;
453 spi_device_polling_transmit(m_SPIDevHandle, &ta);
458void TFTController::SPIWriteWord(uint16_t
data)
462 m_spi->write(
data >> 8);
463 m_spi->write(
data & 0xff);
467 if (m_SPIDevHandle) {
468 spi_transaction_t ta;
469 ta.flags = SPI_TRANS_USE_TXDATA;
472 ta.tx_data[0] =
data >> 8;
473 ta.tx_data[1] =
data & 0xff;
474 ta.rx_buffer =
nullptr;
475 spi_device_polling_transmit(m_SPIDevHandle, &ta);
480void TFTController::SPIWriteBuffer(
void *
data,
size_t size)
484 m_spi->writeBytes((uint8_t*)
data, size);
488 if (m_SPIDevHandle) {
489 spi_transaction_t ta;
491 ta.length = 8 * size;
494 ta.rx_buffer =
nullptr;
495 spi_device_polling_transmit(m_SPIDevHandle, &ta);
500void TFTController::writeCommand(uint8_t cmd)
502 gpio_set_level(m_DC, 0);
507void TFTController::writeByte(uint8_t
data)
509 gpio_set_level(m_DC, 1);
514void TFTController::writeData(
void *
data,
size_t size)
516 gpio_set_level(m_DC, 1);
517 SPIWriteBuffer(
data, size);
522void TFTController::writeWord(uint16_t
data)
524 gpio_set_level(m_DC, 1);
529void TFTController::sendRefresh()
531 Primitive p(PrimitiveCmd::Refresh, Rect(0, 0, m_viewPortWidth - 1, m_viewPortHeight - 1));
536void TFTController::sendScreenBuffer(Rect updateRect)
540 updateRect = updateRect.intersection(Rect(0, 0, m_viewPortWidth - 1, m_viewPortHeight - 1));
543 writeCommand(TFT_CASET);
544 writeWord(m_rotOffsetX + updateRect.X1);
545 writeWord(m_rotOffsetX + updateRect.X2);
548 writeCommand(TFT_RASET);
549 writeWord(m_rotOffsetY + updateRect.Y1);
550 writeWord(m_rotOffsetY + updateRect.Y2);
552 writeCommand(TFT_RAMWR);
553 const int width = updateRect.width();
554 for (
int row = updateRect.Y1; row <= updateRect.Y2; ++row) {
555 writeData(m_viewPort[row] + updateRect.X1,
sizeof(uint16_t) *
width);
562void TFTController::allocViewPort()
564 m_viewPort = (uint16_t**) heap_caps_malloc(m_viewPortHeight *
sizeof(uint16_t*), MALLOC_CAP_32BIT | MALLOC_CAP_INTERNAL);
565 for (
int i = 0; i < m_viewPortHeight; ++i) {
566 m_viewPort[i] = (uint16_t*) heap_caps_malloc(m_viewPortWidth *
sizeof(uint16_t), MALLOC_CAP_DMA);
567 memset(m_viewPort[i], 0, m_viewPortWidth *
sizeof(uint16_t));
572void TFTController::freeViewPort()
575 for (
int i = 0; i < m_viewPortHeight; ++i)
576 heap_caps_free(m_viewPort[i]);
577 heap_caps_free(m_viewPort);
578 m_viewPort =
nullptr;
583void TFTController::updateTaskFunc(
void * pvParameters)
585 TFTController * ctrl = (TFTController*) pvParameters;
589 ctrl->waitForPrimitives();
592 if (ctrl->m_updateTaskFuncSuspended > 0)
593 ulTaskNotifyTake(
true, portMAX_DELAY);
595 ctrl->m_updateTaskRunning =
true;
597 Rect updateRect = Rect(SHRT_MAX, SHRT_MAX, SHRT_MIN, SHRT_MIN);
599 int64_t startTime = ctrl->backgroundPrimitiveTimeoutEnabled() ? esp_timer_get_time() : 0;
603 if (ctrl->getPrimitive(&prim, TFT_BACKGROUND_PRIMITIVE_TIMEOUT / 1000) ==
false)
606 ctrl->execPrimitive(prim, updateRect,
false);
608 if (ctrl->m_updateTaskFuncSuspended > 0)
611 }
while (!ctrl->backgroundPrimitiveTimeoutEnabled() || (startTime + TFT_BACKGROUND_PRIMITIVE_TIMEOUT > esp_timer_get_time()));
613 ctrl->showSprites(updateRect);
615 ctrl->m_updateTaskRunning =
false;
617 if (!ctrl->isDoubleBuffered())
618 ctrl->sendScreenBuffer(updateRect);
624void TFTController::suspendBackgroundPrimitiveExecution()
626 ++m_updateTaskFuncSuspended;
627 while (m_updateTaskRunning)
632void TFTController::resumeBackgroundPrimitiveExecution()
634 m_updateTaskFuncSuspended = tmax(0, m_updateTaskFuncSuspended - 1);
635 if (m_updateTaskFuncSuspended == 0)
636 xTaskNotifyGive(m_updateTaskHandle);
640void TFTController::setPixelAt(PixelDesc
const & pixelDesc,
Rect & updateRect)
642 genericSetPixelAt(pixelDesc, updateRect,
643 [&] (
RGB888 const & color) {
return preparePixel(color); },
644 [&] (
int X,
int Y, uint16_t pattern) { m_viewPort[
Y][
X] = pattern; }
651void TFTController::absDrawLine(
int X1,
int Y1,
int X2,
int Y2, RGB888 color)
653 genericAbsDrawLine(
X1,
Y1,
X2,
Y2, color,
654 [&] (RGB888
const & color) {
return preparePixel(color); },
655 [&] (
int Y,
int X1,
int X2, uint16_t pattern) { rawFillRow(
Y,
X1,
X2, pattern); },
656 [&] (
int Y,
int X1,
int X2) { rawInvertRow(
Y,
X1,
X2); },
657 [&] (
int X,
int Y, uint16_t pattern) { m_viewPort[
Y][
X] = pattern; },
658 [&] (
int X,
int Y) { m_viewPort[
Y][
X] = ~m_viewPort[
Y][
X]; }
664void TFTController::rawFillRow(
int y,
int x1,
int x2, uint16_t pattern)
666 auto px = m_viewPort[y] + x1;
667 for (
int x = x1; x <= x2; ++x, ++px)
673void TFTController::rawFillRow(
int y,
int x1,
int x2, RGB888 color)
675 rawFillRow(y, x1, x2, preparePixel(color));
681void TFTController::swapRows(
int yA,
int yB,
int x1,
int x2)
683 auto pxA = m_viewPort[yA] + x1;
684 auto pxB = m_viewPort[yB] + x1;
685 for (
int x = x1; x <= x2; ++x, ++pxA, ++pxB)
690void TFTController::rawInvertRow(
int y,
int x1,
int x2)
692 auto px = m_viewPort[y] + x1;
693 for (
int x = x1; x <= x2; ++x, ++px)
698void TFTController::drawEllipse(Size
const & size, Rect & updateRect)
700 genericDrawEllipse(size, updateRect,
701 [&] (RGB888
const & color) {
return preparePixel(color); },
702 [&] (
int X,
int Y, uint16_t pattern) { m_viewPort[
Y][
X] = pattern; }
707void TFTController::clear(Rect & updateRect)
709 hideSprites(updateRect);
710 auto pattern = preparePixel(getActualBrushColor());
711 for (
int y = 0; y < m_viewPortHeight; ++y)
712 rawFillRow(y, 0, m_viewPortWidth - 1, pattern);
716void TFTController::VScroll(
int scroll, Rect & updateRect)
718 genericVScroll(scroll, updateRect,
719 [&] (
int yA,
int yB,
int x1,
int x2) { swapRows(yA, yB, x1, x2); },
720 [&] (
int yA,
int yB) { tswap(m_viewPort[yA], m_viewPort[yB]); },
721 [&] (
int y,
int x1,
int x2, RGB888 pattern) { rawFillRow(y, x1, x2, pattern); }
726void TFTController::HScroll(
int scroll, Rect & updateRect)
728 genericHScroll(scroll, updateRect,
729 [&] (RGB888
const & color) {
return preparePixel(color); },
730 [&] (
int y) {
return m_viewPort[y]; },
731 [&] (uint16_t * row,
int x) {
return row[x]; },
732 [&] (uint16_t * row,
int x,
int pattern) { row[x] = pattern; }
737void TFTController::drawGlyph(Glyph
const & glyph, GlyphOptions glyphOptions, RGB888 penColor, RGB888 brushColor, Rect & updateRect)
739 genericDrawGlyph(glyph, glyphOptions, penColor, brushColor, updateRect,
740 [&] (RGB888
const & color) {
return preparePixel(color); },
741 [&] (
int y) {
return m_viewPort[y]; },
742 [&] (uint16_t * row,
int x, uint16_t pattern) { row[x] = pattern; }
747void TFTController::invertRect(Rect
const & rect, Rect & updateRect)
749 genericInvertRect(rect, updateRect,
750 [&] (
int Y,
int X1,
int X2) { rawInvertRow(
Y,
X1,
X2); }
757 genericSwapFGBG(rect, updateRect,
758 [&] (RGB888
const & color) {
return preparePixel(color); },
759 [&] (
int y) {
return m_viewPort[y]; },
760 [&] (uint16_t * row,
int x) {
return row[x]; },
761 [&] (uint16_t * row,
int x, uint16_t pattern) { row[x] = pattern; }
767void TFTController::copyRect(Rect
const & source, Rect & updateRect)
769 genericCopyRect(source, updateRect,
770 [&] (
int y) {
return m_viewPort[y]; },
771 [&] (uint16_t * row,
int x) {
return row[x]; },
772 [&] (uint16_t * row,
int x, uint16_t pattern) { row[x] = pattern; }
778void TFTController::readScreen(Rect
const & rect, RGB888 * destBuf)
780 for (
int y = rect.Y1; y <= rect.Y2; ++y) {
781 auto row = m_viewPort[y] + rect.X1;
782 for (
int x = rect.X1; x <= rect.X2; ++x, ++destBuf, ++row)
783 *destBuf = nativeToRGB888(*row);
788void TFTController::rawDrawBitmap_Native(
int destX,
int destY, Bitmap
const * bitmap,
int X1,
int Y1,
int XCount,
int YCount)
790 genericRawDrawBitmap_Native(destX, destY, (uint16_t*) bitmap->data, bitmap->width,
X1,
Y1, XCount, YCount,
791 [&] (
int y) { return m_viewPort[y]; },
792 [&] (uint16_t * row,
int x, uint16_t src) { row[x] = src; }
797void TFTController::rawDrawBitmap_Mask(
int destX,
int destY, Bitmap
const * bitmap,
void * saveBackground,
int X1,
int Y1,
int XCount,
int YCount)
799 auto foregroundPattern = preparePixel(bitmap->foregroundColor);
800 genericRawDrawBitmap_Mask(destX, destY, bitmap, (uint16_t*)saveBackground,
X1,
Y1, XCount, YCount,
801 [&] (
int y) {
return m_viewPort[y]; },
802 [&] (uint16_t * row,
int x) {
return row[x]; },
803 [&] (uint16_t * row,
int x) { row[x] = foregroundPattern; }
808void TFTController::rawDrawBitmap_RGBA2222(
int destX,
int destY, Bitmap
const * bitmap,
void * saveBackground,
int X1,
int Y1,
int XCount,
int YCount)
810 genericRawDrawBitmap_RGBA2222(destX, destY, bitmap, (uint16_t*)saveBackground,
X1,
Y1, XCount, YCount,
811 [&] (
int y) {
return m_viewPort[y]; },
812 [&] (uint16_t * row,
int x) {
return row[x]; },
813 [&] (uint16_t * row,
int x, uint8_t src) { row[x] = RGBA2222toNative(src); }
818void TFTController::rawDrawBitmap_RGBA8888(
int destX,
int destY, Bitmap
const * bitmap,
void * saveBackground,
int X1,
int Y1,
int XCount,
int YCount)
820 genericRawDrawBitmap_RGBA8888(destX, destY, bitmap, (uint16_t*)saveBackground,
X1,
Y1, XCount, YCount,
821 [&] (
int y) {
return m_viewPort[y]; },
822 [&] (uint16_t * row,
int x) {
return row[x]; },
823 [&] (uint16_t * row,
int x,
RGBA8888 const & src) { row[x] = RGBA8888toNative(src); }
828void TFTController::swapBuffers()
831 sendScreenBuffer(Rect(0, 0, getViewPortWidth() - 1, getViewPortHeight() - 1));
This file contains fabgl::TFTController definition.
This file contains some utility classes and functions.
TFTOrientation
This enum defines TFT orientation.
Represents a 24 bit RGB color.