ft8xx_reference_api.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Hubert Miś
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_DRIVERS_MISC_FT8XX_FT8XX_REFERENCE_API_H_
#define ZEPHYR_DRIVERS_MISC_FT8XX_FT8XX_REFERENCE_API_H_
 
#include <stdint.h>
 
#include <zephyr/drivers/misc/ft8xx/ft8xx_copro.h>
#include <zephyr/drivers/misc/ft8xx/ft8xx_common.h>
#include <zephyr/drivers/misc/ft8xx/ft8xx_dl.h>
#include <zephyr/drivers/misc/ft8xx/ft8xx_memory.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
static inline void wr8(uint32_t address, uint8_t data)
{
        ft8xx_wr8(address, data);
}
 
static inline void wr16(uint32_t address, uint16_t data)
{
        ft8xx_wr16(address, data);
}
 
static inline void wr32(uint32_t address, uint32_t data)
{
        ft8xx_wr32(address, data);
}
 
static inline uint8_t rd8(uint32_t address)
{
        return ft8xx_rd8(address);
}
 
static inline uint16_t rd16(uint32_t address)
{
        return ft8xx_rd16(address);
}
 
static inline uint32_t rd32(uint32_t address)
{
        return ft8xx_rd32(address);
}
 
 
#define OPT_3D        FT8XX_OPT_3D
#define OPT_RGB565    FT8XX_OPT_RGB565
#define OPT_MONO      FT8XX_OPT_MONO
#define OPT_NODL      FT8XX_OPT_NODL
#define OPT_FLAT      FT8XX_OPT_FLAT
#define OPT_SIGNED    FT8XX_OPT_SIGNED
#define OPT_CENTERX   FT8XX_OPT_CENTERX
#define OPT_CENTERY   FT8XX_OPT_CENTERY
#define OPT_CENTER    FT8XX_OPT_CENTER
#define OPT_RIGHTX    FT8XX_OPT_RIGHTX
#define OPT_NOBACK    FT8XX_OPT_NOBACK
#define OPT_NOTICKS   FT8XX_OPT_NOTICKS
#define OPT_NOHM      FT8XX_OPT_NOHM
#define OPT_NOPOINTER FT8XX_OPT_NOPOINTER
#define OPT_NOSECS    FT8XX_OPT_NOSECS
#define OPT_NOHANDS   FT8XX_OPT_NOHANDS
 
static inline void cmd(uint32_t command)
{
        ft8xx_copro_cmd(command);
}
 
static inline void cmd_dlstart(void)
{
        ft8xx_copro_cmd_dlstart();
}
 
static inline void cmd_swap(void)
{
        ft8xx_copro_cmd_swap();
}
 
static inline void cmd_text(int16_t x,
                           int16_t y,
                           int16_t font,
                           uint16_t options,
                           const char *s)
{
        ft8xx_copro_cmd_text(x, y, font, options, s);
}
 
static inline void cmd_number(int16_t x,
                             int16_t y,
                             int16_t font,
                             uint16_t options,
                             int32_t n)
{
        ft8xx_copro_cmd_number(x, y, font, options, n);
}
 
static inline void cmd_calibrate(uint32_t *result)
{
        ft8xx_copro_cmd_calibrate(result);
}
 
 
#define BITMAPS      FT8XX_BITMAPS
#define POINTS       FT8XX_POINTS
#define LINES        FT8XX_LINES
#define LINE_STRIP   FT8XX_LINE_STRIP
#define EDGE_STRIP_R FT8XX_EDGE_STRIP_R
#define EDGE_STRIP_L FT8XX_EDGE_STRIP_L
#define EDGE_STRIP_A FT8XX_EDGE_STRIP_A
#define EDGE_STRIP_B FT8XX_EDGE_STRIP_B
#define RECTS        FT8XX_RECTS
 
#define BEGIN(prim) FT8XX_BEGIN(prim)
 
#define CLEAR(c, s, t) FT8XX_CLEAR(c, s, t)
 
#define CLEAR_COLOR_RGB(red, green, blue) FT8XX_CLEAR_COLOR_RGB(red, green, blue)
 
#define COLOR_RGB(red, green, blue) FT8XX_COLOR_RGB(red, green, blue)
 
#define DISPLAY() FT8XX_DISPLAY()
 
#define END() FT8XX_END()
 
#define LINE_WIDTH(width) FT8XX_LINE_WIDTH(width)
 
#define TAG(s) FT8XX_TAG(s)
 
#define VERTEX2F(x, y) FT8XX_VERTEX2F(x, y)
 
#define VERTEX2II(x, y, handle, cell) FT8XX_VERTEX2II(x, y, handle, cell)
 
 
#if defined(CONFIG_FT800)
enum ft8xx_memory_map_t {
        RAM_G         = FT800_RAM_G,
        ROM_CHIPID    = FT800_ROM_CHIPID,
        ROM_FONT      = FT800_ROM_FONT,
        ROM_FONT_ADDR = FT800_ROM_FONT_ADDR,
        RAM_DL        = FT800_RAM_DL,
        RAM_PAL       = FT800_RAM_PAL,
        REG_          = FT800_REG_,
        RAM_CMD       = FT800_RAM_CMD
};
#else /* Definition of FT810 memory map */
enum ft8xx_memory_map_t {
        RAM_G         = FT810_RAM_G,
        RAM_DL        = FT810_RAM_DL,
        REG_          = FT810_REG_,
        RAM_CMD       = FT810_RAM_CMD
};
#endif
 
#if defined(CONFIG_FT800)
enum ft8xx_register_address_t {
        REG_ID         = FT800_REG_ID,
        REG_FRAMES     = FT800_REG_FRAMES,
        REG_CLOCK      = FT800_REG_CLOCK,
        REG_FREQUENCY  = FT800_REG_FREQUENCY,
        REG_RENDERMODE = FT800_REG_RENDERMODE,
        REG_SNAPY      = FT800_REG_SNAPY,
        REG_SNAPSHOT   = FT800_REG_SNAPSHOT,
        REG_CPURESET   = FT800_REG_CPURESET,
        REG_TAP_CRC    = FT800_REG_TAP_CRC,
        REG_TAP_MASK   = FT800_REG_TAP_MASK,
        REG_HCYCLE     = FT800_REG_HCYCLE,
        REG_HOFFSET    = FT800_REG_HOFFSET,
        REG_HSIZE      = FT800_REG_HSIZE,
        REG_HSYNC0     = FT800_REG_HSYNC0,
        REG_HSYNC1     = FT800_REG_HSYNC1,
        REG_VCYCLE     = FT800_REG_VCYCLE,
        REG_VOFFSET    = FT800_REG_VOFFSET,
        REG_VSIZE      = FT800_REG_VSIZE,
        REG_VSYNC0     = FT800_REG_VSYNC0,
        REG_VSYNC1     = FT800_REG_VSYNC1,
        REG_DLSWAP     = FT800_REG_DLSWAP,
        REG_ROTATE     = FT800_REG_ROTATE,
        REG_OUTBITS    = FT800_REG_OUTBITS,
        REG_DITHER     = FT800_REG_DITHER,
        REG_SWIZZLE    = FT800_REG_SWIZZLE,
        REG_CSPREAD    = FT800_REG_CSPREAD,
        REG_PCLK_POL   = FT800_REG_PCLK_POL,
        REG_PCLK       = FT800_REG_PCLK,
        REG_TAG_X      = FT800_REG_TAG_X,
        REG_TAG_Y      = FT800_REG_TAG_Y,
        REG_TAG        = FT800_REG_TAG,
        REG_VOL_PB     = FT800_REG_VOL_PB,
        REG_VOL_SOUND  = FT800_REG_VOL_SOUND,
        REG_SOUND      = FT800_REG_SOUND,
        REG_PLAY       = FT800_REG_PLAY,
        REG_GPIO_DIR   = FT800_REG_GPIO_DIR,
        REG_GPIO       = FT800_REG_GPIO,
 
        REG_INT_FLAGS  = FT800_REG_INT_FLAGS,
        REG_INT_EN     = FT800_REG_INT_EN,
        REG_INT_MASK   = FT800_REG_INT_MASK,
        REG_PLAYBACK_START = FT800_REG_PLAYBACK_START,
        REG_PLAYBACK_LENGTH = FT800_REG_PLAYBACK_LENGTH,
        REG_PLAYBACK_READPTR = FT800_REG_PLAYBACK_READPTR,
        REG_PLAYBACK_FREQ = FT800_REG_PLAYBACK_FREQ,
        REG_PLAYBACK_FORMAT = FT800_REG_PLAYBACK_FORMAT,
        REG_PLAYBACK_LOOP = FT800_REG_PLAYBACK_LOOP,
        REG_PLAYBACK_PLAY = FT800_REG_PLAYBACK_PLAY,
        REG_PWM_HZ     = FT800_REG_PWM_HZ,
        REG_PWM_DUTY   = FT800_REG_PWM_DUTY,
        REG_MACRO_0    = FT800_REG_MACRO_0,
        REG_MACRO_1    = FT800_REG_MACRO_1,
 
        REG_CMD_READ   = FT800_REG_CMD_READ,
        REG_CMD_WRITE  = FT800_REG_CMD_WRITE,
        REG_CMD_DL     = FT800_REG_CMD_DL,
        REG_TOUCH_MODE = FT800_REG_TOUCH_MODE,
        REG_TOUCH_ADC_MODE = FT800_REG_TOUCH_ADC_MODE,
        REG_TOUCH_CHARGE = FT800_REG_TOUCH_CHARGE,
        REG_TOUCH_SETTLE = FT800_REG_TOUCH_SETTLE,
        REG_TOUCH_OVERSAMPLE = FT800_REG_TOUCH_OVERSAMPLE,
        REG_TOUCH_RZTHRESH = FT800_REG_TOUCH_RZTHRESH,
        REG_TOUCH_RAW_XY = FT800_REG_TOUCH_RAW_XY,
        REG_TOUCH_RZ   = FT800_REG_TOUCH_RZ,
        REG_TOUCH_SCREEN_XY = FT800_REG_TOUCH_SCREEN_XY,
        REG_TOUCH_TAG_XY = FT800_REG_TOUCH_TAG_XY,
        REG_TOUCH_TAG  = FT800_REG_TOUCH_TAG,
        REG_TOUCH_TRANSFORM_A = FT800_REG_TOUCH_TRANSFORM_A,
        REG_TOUCH_TRANSFORM_B = FT800_REG_TOUCH_TRANSFORM_B,
        REG_TOUCH_TRANSFORM_C = FT800_REG_TOUCH_TRANSFORM_C,
        REG_TOUCH_TRANSFORM_D = FT800_REG_TOUCH_TRANSFORM_D,
        REG_TOUCH_TRANSFORM_E = FT800_REG_TOUCH_TRANSFORM_E,
        REG_TOUCH_TRANSFORM_F = FT800_REG_TOUCH_TRANSFORM_F,
 
        REG_TOUCH_DIRECT_XY = FT800_REG_TOUCH_DIRECT_XY,
        REG_TOUCH_DIRECT_Z1Z2 = FT800_REG_TOUCH_DIRECT_Z1Z2,
 
        REG_TRACKER    = FT800_REG_TRACKER
};
#else /* Definition of FT810 registers */
enum ft8xx_register_address_t {
        REG_TRIM       = FT810_REG_TRIM,
 
        REG_ID         = FT810_REG_ID,
        REG_FRAMES     = FT810_REG_FRAMES,
        REG_CLOCK      = FT810_REG_CLOCK,
        REG_FREQUENCY  = FT810_REG_FREQUENCY,
        REG_RENDERMODE = FT810_REG_RENDERMODE,
        REG_SNAPY      = FT810_REG_SNAPY,
        REG_SNAPSHOT   = FT810_REG_SNAPSHOT,
        REG_CPURESET   = FT810_REG_CPURESET,
        REG_TAP_CRC    = FT810_REG_TAP_CRC,
        REG_TAP_MASK   = FT810_REG_TAP_MASK,
        REG_HCYCLE     = FT810_REG_HCYCLE,
        REG_HOFFSET    = FT810_REG_HOFFSET,
        REG_HSIZE      = FT810_REG_HSIZE,
        REG_HSYNC0     = FT810_REG_HSYNC0,
        REG_HSYNC1     = FT810_REG_HSYNC1,
        REG_VCYCLE     = FT810_REG_VCYCLE,
        REG_VOFFSET    = FT810_REG_VOFFSET,
        REG_VSIZE      = FT810_REG_VSIZE,
        REG_VSYNC0     = FT810_REG_VSYNC0,
        REG_VSYNC1     = FT810_REG_VSYNC1,
        REG_DLSWAP     = FT810_REG_DLSWAP,
        REG_ROTATE     = FT810_REG_ROTATE,
        REG_OUTBITS    = FT810_REG_OUTBITS,
        REG_DITHER     = FT810_REG_DITHER,
        REG_SWIZZLE    = FT810_REG_SWIZZLE,
        REG_CSPREAD    = FT810_REG_CSPREAD,
        REG_PCLK_POL   = FT810_REG_PCLK_POL,
        REG_PCLK       = FT810_REG_PCLK,
        REG_TAG_X      = FT810_REG_TAG_X,
        REG_TAG_Y      = FT810_REG_TAG_Y,
        REG_TAG        = FT810_REG_TAG,
        REG_VOL_PB     = FT810_REG_VOL_PB,
        REG_VOL_SOUND  = FT810_REG_VOL_SOUND,
        REG_SOUND      = FT810_REG_SOUND,
        REG_PLAY       = FT810_REG_PLAY,
        REG_GPIO_DIR   = FT810_REG_GPIO_DIR,
        REG_GPIO       = FT810_REG_GPIO,
        REG_GPIOX_DIR  = FT810_REG_GPIOX_DIR,
        REG_GPIOX      = FT810_REG_GPIOX,
 
        REG_INT_FLAGS  = FT810_REG_INT_FLAGS,
        REG_INT_EN     = FT810_REG_INT_EN,
        REG_INT_MASK   = FT810_REG_INT_MASK,
        REG_PLAYBACK_START = FT810_REG_PLAYBACK_START,
        REG_PLAYBACK_LENGTH = FT810_REG_PLAYBACK_LENGTH,
        REG_PLAYBACK_READPTR = FT810_REG_PLAYBACK_READPTR,
        REG_PLAYBACK_FREQ = FT810_REG_PLAYBACK_FREQ,
        REG_PLAYBACK_FORMAT = FT810_REG_PLAYBACK_FORMAT,
        REG_PLAYBACK_LOOP = FT810_REG_PLAYBACK_LOOP,
        REG_PLAYBACK_PLAY = FT810_REG_PLAYBACK_PLAY,
        REG_PWM_HZ     = FT810_REG_PWM_HZ,
        REG_PWM_DUTY   = FT810_REG_PWM_DUTY,
 
        REG_CMD_READ   = FT810_REG_CMD_READ,
        REG_CMD_WRITE  = FT810_REG_CMD_WRITE,
        REG_CMD_DL     = FT810_REG_CMD_DL,
        REG_TOUCH_MODE = FT810_REG_TOUCH_MODE,
        REG_TOUCH_ADC_MODE = FT810_REG_TOUCH_ADC_MODE,
        REG_TOUCH_CHARGE = FT810_REG_TOUCH_CHARGE,
        REG_TOUCH_SETTLE = FT810_REG_TOUCH_SETTLE,
        REG_TOUCH_OVERSAMPLE = FT810_REG_TOUCH_OVERSAMPLE,
        REG_TOUCH_RZTHRESH = FT810_REG_TOUCH_RZTHRESH,
        REG_TOUCH_RAW_XY = FT810_REG_TOUCH_RAW_XY,
        REG_TOUCH_RZ   = FT810_REG_TOUCH_RZ,
        REG_TOUCH_SCREEN_XY = FT810_REG_TOUCH_SCREEN_XY,
        REG_TOUCH_TAG_XY = FT810_REG_TOUCH_TAG_XY,
        REG_TOUCH_TAG  = FT810_REG_TOUCH_TAG,
        REG_TOUCH_TRANSFORM_A = FT810_REG_TOUCH_TRANSFORM_A,
        REG_TOUCH_TRANSFORM_B = FT810_REG_TOUCH_TRANSFORM_B,
        REG_TOUCH_TRANSFORM_C = FT810_REG_TOUCH_TRANSFORM_C,
        REG_TOUCH_TRANSFORM_D = FT810_REG_TOUCH_TRANSFORM_D,
        REG_TOUCH_TRANSFORM_E = FT810_REG_TOUCH_TRANSFORM_E,
        REG_TOUCH_TRANSFORM_F = FT810_REG_TOUCH_TRANSFORM_F,
        REG_TOUCH_CONFIG = FT810_REG_TOUCH_CONFIG,
 
        REG_SPI_WIDTH  = FT810_REG_SPI_WIDTH,
 
        REG_TOUCH_DIRECT_XY = FT810_REG_TOUCH_DIRECT_XY,
        REG_TOUCH_DIRECT_Z1Z2 = FT810_REG_TOUCH_DIRECT_Z1Z2,
 
        REG_CMDB_SPACE = FT810_REG_CMDB_SPACE,
        REG_CMDB_WRITE = FT810_REG_CMDB_WRITE,
 
        REG_TRACKER    = FT810_REG_TRACKER,
        REG_TRACKER1   = FT810_REG_TRACKER1,
        REG_TRACKER2   = FT810_REG_TRACKER2,
        REG_TRACKER3   = FT810_REG_TRACKER3,
        REG_TRACKER4   = FT810_REG_TRACKER4,
        REG_MEDIAFIFO_READ = FT810_REG_MEDIAFIFO_READ,
        REG_MEDIAFIFO_WRITE = FT810_REG_MEDIAFIFO_WRITE,
};
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_DRIVERS_MISC_FT8XX_FT8XX_REFERENCE_API_H_ */