EVE_Util.h

Go to the documentation of this file.

 
#ifndef EVE_UTIL__H
#define EVE_UTIL__H
#include "EVE_HalDefs.h"
 
/***************
** PARAMETERS **
***************/
 
typedef struct EVE_BootupParameters
{
    EVE_81X_PLL_FREQ_T SystemClock;
 
    bool ExternalOsc;
 
#if (EVE_SUPPORT_CHIPID >= EVE_FT810) || defined(EVE_MULTI_GRAPHICS_TARGET)
    EVE_SPI_CHANNELS_T SpiChannels; 
    uint8_t SpiDummyBytes; 
#endif
 
} EVE_BootupParameters;
 
typedef struct EVE_ConfigParameters
{
    int16_t Width; 
    int16_t Height; 
    int16_t HCycle;
    int16_t HOffset;
    int16_t HSync0;
    int16_t HSync1;
    int16_t VCycle;
    int16_t VOffset;
    int16_t VSync0;
    int16_t VSync1;
    uint8_t PCLK;
    int8_t Swizzle;
    int8_t PCLKPol;
    int8_t CSpread;
    uint8_t OutBitsR;
    uint8_t OutBitsG;
    uint8_t OutBitsB;
    bool Dither;
 
#if (EVE_SUPPORT_CHIPID >= EVE_BT815)
    bool AdaptiveFramerate;
#endif
 
#if (EVE_SUPPORT_CHIPID >= EVE_BT817)
    bool PClk2X;
    uint16_t PClkFreq;
    int16_t AhHCycleMax;
#endif
 
#ifdef EVE_SUPPORT_HSF
    int16_t HsfWidth; 
#endif
 
} EVE_ConfigParameters;
 
typedef enum EVE_DISPLAY_T
{
    EVE_DISPLAY_DEFAULT = 0, 
    EVE_DISPLAY_QVGA_320x240_56Hz,
    EVE_DISPLAY_WQVGA_480x272_60Hz, 
    EVE_DISPLAY_WVGA_800x480_74Hz, 
    EVE_DISPLAY_WSVGA_1024x600_59Hz, 
    EVE_DISPLAY_HDTV_1280x720_58Hz, 
    EVE_DISPLAY_WXGA_1280x800_57Hz, 
    EVE_DISPLAY_HVGA_320x480_60Hz,
 
    EVE_DISPLAY_WVGA_800x480_W860_60Hz,
 
    EVE_DISPLAY_RIVERDI_IPS35_62Hz,
    EVE_DISPLAY_RIVERDI_IPS43_58Hz, 
    EVE_DISPLAY_RIVERDI_IPS50_63Hz, 
    EVE_DISPLAY_RIVERDI_IPS70_59Hz, 
    EVE_DISPLAY_RIVERDI_IPS101_59Hz, 
    EVE_DISPLAY_NB,
 
} EVE_DISPLAY_T;
 
/**********************
** INIT AND SHUTDOWN **
**********************/
 
 
EVE_HAL_EXPORT void EVE_Util_bootupDefaults(EVE_HalContext *phost, EVE_BootupParameters *bootup);
 
EVE_HAL_EXPORT bool EVE_Util_bootup(EVE_HalContext *phost, EVE_BootupParameters *bootup);
 
EVE_HAL_EXPORT void EVE_Util_configDefaults(EVE_HalContext *phost, EVE_ConfigParameters *config, EVE_DISPLAY_T display);
 
EVE_HAL_EXPORT bool EVE_Util_configDefaultsEx(EVE_HalContext *phost, EVE_ConfigParameters *config, uint32_t width, uint32_t height, uint32_t refreshRate, uint32_t hsfWidth);
 
EVE_HAL_EXPORT bool EVE_Util_config(EVE_HalContext *phost, EVE_ConfigParameters *config);
 
EVE_HAL_EXPORT void EVE_Util_shutdown(EVE_HalContext *phost);
 
EVE_HAL_EXPORT void EVE_Util_clearScreen(EVE_HalContext *phost);
 
EVE_HAL_EXPORT bool EVE_Util_resetCoprocessor(EVE_HalContext *phost);
 
EVE_HAL_EXPORT bool EVE_Util_bootupConfig(EVE_HalContext *phost);
 
/**********************
** INTERACTIVE SETUP **
**********************/
 
 
#if defined(_WIN32)
EVE_HAL_EXPORT void EVE_Util_selectDeviceInteractive(EVE_CHIPID_T *chipId, size_t *deviceIdx);
#else
static inline void EVE_Util_selectDeviceInteractive(EVE_CHIPID_T *chipId, size_t *deviceIdx)
{
    *chipId = EVE_SUPPORT_CHIPID;
    *deviceIdx = -1;
}
#endif
 
#if defined(_WIN32) && defined(EVE_MULTI_GRAPHICS_TARGET)
EVE_HAL_EXPORT void EVE_Util_selectDisplayInteractive(EVE_DISPLAY_T *display);
#else
static inline void EVE_Util_selectDisplayInteractive(EVE_DISPLAY_T *display)
{
    *display = EVE_DISPLAY_DEFAULT;
}
#endif
 
#if defined(_WIN32) && defined(EVE_FLASH_AVAILABLE)
EVE_HAL_EXPORT void EVE_Util_selectFlashFileInteractive(eve_tchar_t *flashPath, size_t flashPathSize, bool *updateFlash, bool *updateFlashFirmware, const EVE_HalParameters *params, const eve_tchar_t *flashFile);
#else
static inline void EVE_Util_selectFlashFileInteractive(eve_tchar_t *flashPath, size_t flashPathSize, bool *updateFlash, bool *updateFlashFirmware, const EVE_HalParameters *params, const eve_tchar_t *flashFile)
{
    flashPath[0] = '\0';
    *updateFlash = false;
    *updateFlashFirmware = false;
}
#endif
 
#if defined(_WIN32) && defined(EVE_FLASH_AVAILABLE)
EVE_HAL_EXPORT void EVE_Util_uploadFlashFileInteractive(EVE_HalContext *phost, const eve_tchar_t *flashPath, bool updateFlashFirmware);
#else
static inline void EVE_Util_uploadFlashFileInteractive(EVE_HalContext *phost, const eve_tchar_t *flashPath, bool updateFlashFirmware)
{
    /* no-op */
}
#endif
 
#if defined(BT8XXEMU_PLATFORM)
EVE_HAL_EXPORT void EVE_Util_emulatorDefaults(EVE_HalParameters *params, void *emulatorParams, EVE_CHIPID_T chipId);
#if defined(EVE_FLASH_AVAILABLE)
EVE_HAL_EXPORT void EVE_Util_emulatorFlashDefaults(EVE_HalParameters *params, const void *emulatorParams, void *flashParams, const eve_tchar_t *flashPath);
#endif
#endif
 
EVE_HAL_EXPORT bool EVE_Util_openDeviceInteractive(EVE_HalContext *phost, const wchar_t *flashFile);
 
EVE_HAL_EXPORT bool EVE_Util_bootupConfigInteractive(EVE_HalContext *phost, EVE_DISPLAY_T display);
 
EVE_HAL_EXPORT void EVE_Util_forceFault(EVE_HalContext *phost, const char *err);
 
#endif /* #ifndef EVE_HAL_INCL__H */
 
/* end of file */