#ifndef __EVE_BASE_H__
#define __EVE_BASE_H__
//============================================================================
//
// Low-Level routines for FTDI / BridgeTek EVE graphic accelerators.
//
// 2020-08-05 Brent A. Crosby / Crystalfontz America, Inc.
// https://www.crystalfontz.com/products/eve-accelerated-tft-displays.php
//===========================================================================
//This is free and unencumbered software released into the public domain.
//
//Anyone is free to copy, modify, publish, use, compile, sell, or
//distribute this software, either in source code form or as a compiled
//binary, for any purpose, commercial or non-commercial, and by any
//means.
//
//In jurisdictions that recognize copyright laws, the author or authors
//of this software dedicate any and all copyright interest in the
//software to the public domain. We make this dedication for the benefit
//of the public at large and to the detriment of our heirs and
//successors. We intend this dedication to be an overt act of
//relinquishment in perpetuity of all present and future rights to this
//software under copyright law.
//
//THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
//EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
//MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
//IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
//OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
//ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
//OTHER DEALINGS IN THE SOFTWARE.
//
//For more information, please refer to <http://unlicense.org/>
//============================================================================
void _EVE_Select_and_Address(uint32_t Address, uint8_t Operation);
void _EVE_send_32(uint32_t Data);
void EVE_REG_Write_8(uint32_t REG_Address, uint8_t ftData8);
void EVE_REG_Write_16(uint32_t REG_Address, uint16_t ftData16);
void EVE_REG_Write_32(uint32_t REG_Address, uint32_t ftData32);
uint16_t EVE_Cmd_Dat_0(uint16_t FWol,
                       uint32_t command);
uint16_t EVE_Cmd_Dat_1(uint16_t FWol,
                       uint32_t command,uint32_t data0);
uint16_t EVE_Cmd_Dat_2(uint16_t FWol,
                       uint32_t command,uint32_t data0, uint32_t data1);
uint8_t EVE_REG_Read_8(uint32_t REG_Address);
uint16_t EVE_REG_Read_16(uint32_t REG_Address);
uint32_t EVE_REG_Read_32(uint32_t REG_Address);
void EVE_Read_Array(uint32_t EVE_Address, uint16_t length, uint8_t *destination);
#define ROBUST_EXECUTION_COMPLETE (1)
#if (0 == ROBUST_EXECUTION_COMPLETE)
#define Wait_for_EVE_Execution_Complete(SW_write_offset) while(EVE_REG_Read_16(EVE_REG_CMD_READ) != SW_write_offset)
#else
uint16_t Wait_for_EVE_Execution_Complete(uint16_t SW_write_offset);
#endif
uint16_t Get_Free_CMD_Space(uint16_t FWol);
uint16_t Get_RAM_G_Pointer_After_INFLATE(uint16_t FWol,
                                         uint32_t *RAM_G_First_Available);
uint16_t Get_RAM_G_Properties_After_LOADIMAGE(uint16_t FWol,
                                              uint32_t *RAM_G_First_Available,
                                              uint32_t *Width,
                                              uint32_t *Height);
#if TOUCH_TYPE==TOUCH_RESISTIVE
uint8_t Read_Touch(int16_t x_points[1], int16_t y_points[1]);
#endif // TOUCH_TYPE==TOUCH_RESISTIVE
#if TOUCH_TYPE==TOUCH_CAPACITIVE
uint8_t Read_Touch(int16_t x_points[5], int16_t y_points[5]);
#endif // TOUCH_TYPE==TOUCH_CAPACITIVE
uint8_t Read_Touch(int16_t x_points[5], int16_t y_points[5]);
uint8_t quiet_backlight_128(uint8_t portion_of_128);
uint8_t quiet_backlight_percent(uint8_t percent);
uint8_t EVE_Initialize(void);
//============================================================================
//Don't call SerPrintFF() directly, use DBG_STAT() or DBG_GEEK() macros.
void SerPrintFF(const __FlashStringHelper *fmt, ... );
//============================================================================
//Conditional debugging "printf()" style debug message examples, string
//stored in flash. You can't spell "GEEK" without a "double E".
//
// DBG_STAT("Printed if DEBUG_LEVEL is DEBUG_STATUS or DEBUG_GEEK. Some int= %3d\n",9600);
// DBG_GEEK("Printed if DEBUG_LEVEL is DEBUG_GEEK. Some int= %3d\n",6900);
//
// Use DBG_STAT() for normal messages that a normal user might be interested in.
// Use DBG_GEEK() for geeky messages like pointer values, etc.
// ref: https://www.youtube.com/watch?v=5wcN8W8GgeE&feature=youtu.be&t=14
//
// DEBUG_NONE will print nothing and not use the serial console.
//
// Don't change these
#define DEBUG_NONE   (0)
#define DEBUG_STATUS (1)
#define DEBUG_GEEK   (2)
//
//Set the debug level in CFA10099_defines.h
//
//These macros conditionally expand to a SerPrintFF() call.
//ref: https://stackoverflow.com/questions/5765175/macro-to-turn-off-printf-statements
#if (DEBUG_LEVEL == DEBUG_NONE)
    #define    DBG_STAT(f,...)
    #define    DBG_GEEK(f,...)
    #define    DBG_GEEK_READ_AND_DUMP_TOUCH_MATRIX(m)
#endif

#if (DEBUG_LEVEL == DEBUG_STATUS)
    #define    DBG_STAT(f,...)    SerPrintFF(F(f),##__VA_ARGS__)
    #define    DBG_GEEK(f,...)
    #define    DBG_GEEK_READ_AND_DUMP_TOUCH_MATRIX(m)
#endif

#if (DEBUG_LEVEL == DEBUG_GEEK)
    #define    DBG_STAT(f,...)    SerPrintFF(F(f),##__VA_ARGS__)
    #define    DBG_GEEK(f,...)    SerPrintFF(F(f),##__VA_ARGS__)
    #define    DBG_GEEK_READ_AND_DUMP_TOUCH_MATRIX(m) Read_and_Dump_Touch_Matrix(F(m))
#endif
//============================================================================
#endif // __EVE_BASE_H__