EVE_HalImpl.h File Reference

Eve_Hal framework APIs. More...

#include "EVE_HalDefs.h"

Go to the source code of this file.

Functions
INIT
void	EVE_HalImpl_initialize ()
	Initialize HAL platform.
void	EVE_HalImpl_release ()
	Release HAL platform.
bool	EVE_HalImpl_defaults (EVE_HalParameters *parameters, size_t deviceIdx)
	Get the default configuration parameters.
bool	EVE_HalImpl_open (EVE_HalContext *phost, const EVE_HalParameters *parameters)
	Opens a new HAL context using the specified parameters.
void	EVE_HalImpl_close (EVE_HalContext *phost)
	Close a HAL context.
void	EVE_HalImpl_idle (EVE_HalContext *phost)
	Idle. Call regularly to update frequently changing internal state.
TRANSFER
EVE_HAL_EXPORT void	EVE_Hal_startTransfer (EVE_HalContext *phost, EVE_TRANSFER_T rw, uint32_t addr)
	Start data transfer to Coprocessor.
EVE_HAL_EXPORT void	EVE_Hal_endTransfer (EVE_HalContext *phost)
	End data transfer.
EVE_HAL_EXPORT uint8_t	EVE_Hal_transfer8 (EVE_HalContext *phost, uint8_t value)
	Write 8 bits to Coprocessor.
EVE_HAL_EXPORT uint16_t	EVE_Hal_transfer16 (EVE_HalContext *phost, uint16_t value)
	Write 2 bytes to Coprocessor.
EVE_HAL_EXPORT uint32_t	EVE_Hal_transfer32 (EVE_HalContext *phost, uint32_t value)
	Write 4 bytes to Coprocessor.
EVE_HAL_EXPORT void	EVE_Hal_flush (EVE_HalContext *phost)
	Flush data to Coprocessor.
MISC
void	EVE_Mcu_initialize ()
	Init FT9x host MCU.
void	EVE_Mcu_release ()
	Release FT9x host MCU.
void	EVE_Millis_initialize ()
	Init FT9x timer.
void	EVE_Millis_release ()
	Release FT9x timer.
EVE_HAL_EXPORT uint32_t	EVE_millis ()
	Get clock in miliseond.
EVE_HAL_EXPORT uint64_t	EVE_millis64 ()
	Get clock in miliseond.
bool	EVE_UtilImpl_bootupDisplayGpio (EVE_HalContext *phost)
	Display GPIO pins.

Variables
EVE_HalPlatform	g_HalPlatform

Detailed Description

Eve_Hal framework APIs.

This file defines the generic APIs of phost access layer for the FT800 or EVE compatible silicon. Application shall access FT800 or EVE resources over these APIs,regardless of I2C or SPI protocol. In addition, there are some helper functions defined for FT800 coprocessor engine as well as phost commands.

Author

Bridgetek

Date

2018

MIT License

Copyright (c) [2019] [Bridgetek Pte Ltd (BRTChip)]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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 OR COPYRIGHT HOLDERS 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.

Definition in file EVE_HalImpl.h.

Function Documentation

EVE_Hal_endTransfer()

EVE_HAL_EXPORT void EVE_Hal_endTransfer

(

EVE_HalContext *

phost

)

End data transfer.

Parameters

phost

Pointer to Hal context

Definition at line 291 of file EVE_HalImpl_FT9XX.c.

{
    eve_assert(phost->Status == EVE_STATUS_READING || phost->Status == EVE_STATUS_WRITING);
 
    spi_close(SPIM, phost->SpiCsPin);
    phost->Status = EVE_STATUS_OPENED;
}

EVE_Hal_flush()

EVE_HAL_EXPORT void EVE_Hal_flush

(

EVE_HalContext *

phost

)

Flush data to Coprocessor.

Parameters

phost

Pointer to Hal context

Definition at line 304 of file EVE_HalImpl_FT9XX.c.

{
    eve_assert(phost->Status == EVE_STATUS_OPENED);
    /* no-op */
}

EVE_Hal_startTransfer()

EVE_HAL_EXPORT void EVE_Hal_startTransfer	(	EVE_HalContext *	phost,
		EVE_TRANSFER_T	rw,
		uint32_t	addr
	)

Start data transfer to Coprocessor.

Parameters

phost	Pointer to Hal context
rw	Read or Write
addr	Address to read/write

Definition at line 257 of file EVE_HalImpl_FT9XX.c.

{
    eve_assert(phost->Status == EVE_STATUS_OPENED);
 
    if (rw == EVE_TRANSFER_READ)
    {
        eve_assert(3 + phost->SpiDummyBytes <= 5);
        uint8_t spidata[5]; // FIXME: phost->SpiDummyBytes // ?
        spidata[0] = (addr >> 16);
        spidata[1] = (addr >> 8);
        spidata[2] = addr & 0xff;
        spi_open(SPIM, phost->SpiCsPin);
        spi_writen(SPIM, spidata, 3 + phost->SpiDummyBytes);
        phost->Status = EVE_STATUS_READING;
    }
    else
    {
        uint8_t spidata[4];
        spidata[0] = (0x80 | (addr >> 16));
        spidata[1] = (addr >> 8);
        spidata[2] = addr;
 
        spi_open(SPIM, phost->SpiCsPin);
        spi_writen(SPIM, spidata, 3);
 
        phost->Status = EVE_STATUS_WRITING;
    }
}

EVE_Hal_transfer16()

EVE_HAL_EXPORT uint16_t EVE_Hal_transfer16	(	EVE_HalContext *	phost,
		uint16_t	value
	)

Write 2 bytes to Coprocessor.

Parameters

phost	Pointer to Hal context
value	Value to write

Returns

uint16_t Number of bytes transfered

Definition at line 374 of file EVE_HalImpl_FT9XX.c.

{
    uint8_t buffer[2];
    if (phost->Status == EVE_STATUS_READING)
    {
        rdBuffer(phost, buffer, 2);
        return (uint16_t)buffer[0]
            | (uint16_t)buffer[1] << 8;
    }
    else
    {
        buffer[0] = value & 0xFF;
        buffer[1] = value >> 8;
        wrBuffer(phost, buffer, 2);
        return 0;
    }
}

EVE_Hal_transfer32()

EVE_HAL_EXPORT uint32_t EVE_Hal_transfer32	(	EVE_HalContext *	phost,
		uint32_t	value
	)

Write 4 bytes to Coprocessor.

Parameters

phost	Pointer to Hal context
value	Value to write

Returns

uint32_t Number of bytes transfered

Definition at line 399 of file EVE_HalImpl_FT9XX.c.

{
    uint8_t buffer[4];
    if (phost->Status == EVE_STATUS_READING)
    {
        rdBuffer(phost, buffer, 4);
        return (uint32_t)buffer[0]
            | (uint32_t)buffer[1] << 8
            | (uint32_t)buffer[2] << 16
            | (uint32_t)buffer[3] << 24;
    }
    else
    {
        buffer[0] = value & 0xFF;
        buffer[1] = (value >> 8) & 0xFF;
        buffer[2] = (value >> 16) & 0xFF;
        buffer[3] = value >> 24;
        wrBuffer(phost, buffer, 4);
        return 0;
    }
}

EVE_Hal_transfer8()

EVE_HAL_EXPORT uint8_t EVE_Hal_transfer8	(	EVE_HalContext *	phost,
		uint8_t	value
	)

Write 8 bits to Coprocessor.

Parameters

phost	Pointer to Hal context
value	Value to write

Returns

uint8_t Number of bytes transfered

Definition at line 362 of file EVE_HalImpl_FT9XX.c.

{
    return transfer8(phost, value);
}

EVE_HalImpl_close()

void EVE_HalImpl_close

(

EVE_HalContext *

phost

)

Close a HAL context.

Close a HAL context

Parameters

phost

Pointer to Hal context

Definition at line 223 of file EVE_HalImpl_FT9XX.c.

{
    phost->Status = EVE_STATUS_CLOSED;
    --g_HalPlatform.OpenedDevices;
#ifndef PANL_APPLET
    spi_close(SPIM, phost->SpiCsPin);
#endif
}

EVE_HalImpl_defaults()

bool EVE_HalImpl_defaults	(	EVE_HalParameters *	parameters,
		size_t	deviceIdx
	)

Get the default configuration parameters.

Get the default configuration parameters. Use deviceIdx to choose the connected device.

Parameters

parameters	EVE_Hal framework's parameters
deviceIdx

Returns

true True if ok

false False if error

Definition at line 116 of file EVE_HalImpl_FT9XX.c.

{
    parameters->PowerDownPin = GPIO_FT800_PWD;
    parameters->SpiCsPin = deviceIdx < GPIO_SS_NB ? deviceIdx : 0; // SS0-3
    return true;
}

EVE_HalImpl_idle()

void EVE_HalImpl_idle

(

EVE_HalContext *

phost

)

Idle. Call regularly to update frequently changing internal state.

Idle. Call regularly to update frequently changing internal state

Parameters

phost

Pointer to Hal context

Definition at line 237 of file EVE_HalImpl_FT9XX.c.

{
    /* no-op */
}

EVE_HalImpl_initialize()

void EVE_HalImpl_initialize

(

)

Initialize HAL platform.

Initialize HAL platform

Definition at line 57 of file EVE_HalImpl_FT9XX.c.

{
}

EVE_HalImpl_open()

bool EVE_HalImpl_open	(	EVE_HalContext *	phost,
		const EVE_HalParameters *	parameters
	)

Opens a new HAL context using the specified parameters.

Opens a new HAL context using the specified parameters

Parameters

phost	Pointer to Hal context
parameters	EVE_Hal framework's parameters

Returns

true True if ok

false False if error

Definition at line 191 of file EVE_HalImpl_FT9XX.c.

{
    phost->SpiCsPin = parameters->SpiCsPin < GPIO_SS_NB ? parameters->SpiCsPin : 0;
    phost->PowerDownPin = parameters->PowerDownPin;
    eve_printf_debug("EVE open PWD: %d, SS: %d\n",
        (unsigned int)phost->PowerDownPin, (unsigned int)s_SpimGpioSS[phost->SpiCsPin]);
 
#ifdef EVE_MULTI_GRAPHICS_TARGET
    phost->GpuDefs = &EVE_GpuDefs_FT80X;
#endif
 
    gpio_function(phost->PowerDownPin, pad_func_0);
    gpio_dir(phost->PowerDownPin, pad_dir_output);
    gpio_write(phost->PowerDownPin, 0);
 
    /* Initialize single channel */
    setSPI(phost, EVE_SPI_SINGLE_CHANNEL, 1);
 
    gpio_write(phost->PowerDownPin, 1);
 
    /* Initialize the context variables */
    phost->Status = EVE_STATUS_OPENED;
    ++g_HalPlatform.OpenedDevices;
 
    return true;
}

EVE_HalImpl_release()

void EVE_HalImpl_release

(

)

Release HAL platform.

Release HAL platform

Definition at line 65 of file EVE_HalImpl_FT9XX.c.

{
#ifndef PANL_APPLET
    spi_uninit(SPIM);
#endif
}

EVE_Mcu_initialize()

void EVE_Mcu_initialize

(

)

Init FT9x host MCU.

Definition at line 720 of file EVE_HalImpl_FT9XX.c.

{
#ifndef PANL_APPLET
    sys_reset_all();
 
    interrupt_enable_globally();
 
    sys_enable(sys_device_uart0);
    gpio_function(GPIO_UART0_TX, pad_uart0_txd); /* UART0 TXD */
    gpio_function(GPIO_UART0_RX, pad_uart0_rxd); /* UART0 RXD */
    uart_open(UART0, /* Device */
        1, /* Prescaler = 1 */
        UART_DIVIDER_115200_BAUD, /* Divider = 1302 */
        uart_data_bits_8, /* No. Data Bits */
        uart_parity_none, /* Parity */
        uart_stop_bits_1); /* No. Stop Bits */
#endif
 
#if (defined(ENABLE_ILI9488_HVGA_PORTRAIT) || defined(ENABLE_KD2401_HVGA_PORTRAIT))
    /* assign all the respective pins to GPIO and set them to default values */
    gpio_function(GPIO_ILI9488_DCX, pad_ili9488_dcx);
    gpio_dir(GPIO_ILI9488_DCX, pad_dir_output);
    gpio_write(GPIO_ILI9488_DCX, 1);
 
    gpio_function(GPIO_SPIM_CLK, pad_spim_sck);
    gpio_dir(GPIO_SPIM_CLK, pad_dir_output);
    gpio_write(GPIO_SPIM_CLK, 1);
 
    gpio_function(GPIO_SPIM_MOSI, pad_spim_mosi);
    gpio_dir(GPIO_SPIM_MOSI, pad_dir_output);
    gpio_write(GPIO_SPIM_MOSI, 1);
 
    gpio_function(GPIO_ILI9488_CS1, pad_ili9488_cs1);
    gpio_dir(GPIO_ILI9488_CS1, pad_dir_output);
    gpio_write(GPIO_ILI9488_CS1, 1);
 
    gpio_function(GPIO_SPIM_MISO, pad_spim_miso);
    gpio_dir(GPIO_SPIM_MISO, pad_dir_output);
    gpio_write(GPIO_SPIM_MISO, 1);
 
    gpio_function(GPIO_SPIM_SS0, pad_spim_ss0);
    gpio_dir(GPIO_SPIM_SS0, pad_dir_output);
    gpio_write(GPIO_SPIM_SS0, 1);
 
    gpio_function(GPIO_FT800_PWD, pad_func_0); /* FIXME: This needs to be done at open, not init */
    gpio_dir(GPIO_FT800_PWD, pad_dir_output);
    gpio_write(GPIO_FT800_PWD, 1);
 
    gpio_write(GPIO_ILI9488_DCX, 1);
    gpio_write(GPIO_SPIM_SS0, 1);
    gpio_write(GPIO_FT800_PWD, 1);
    gpio_write(GPIO_ILI9488_CS1, 1);
#endif
 
    initSdHost();
}

EVE_Mcu_release()

void EVE_Mcu_release

(

)

Release FT9x host MCU.

Definition at line 781 of file EVE_HalImpl_FT9XX.c.

{
    /* no-op */
}

EVE_millis()

EVE_HAL_EXPORT uint32_t EVE_millis

(

)

Get clock in miliseond.

Need to ensure that below api is called at least once in 6.5 seconds duration for FT900 platform as this module doesnt use timer for context update global counter to loopback after ~49.71 days

Returns

uint32_t Clock number

Definition at line 842 of file EVE_HalImpl_FT9XX.c.

{
#if defined(PANL_APPLET)
    uint32_t ms = panl_timer_get_time();
    if ((uint64_t)ms < s_TotalMilliseconds)
        s_TotalMilliseconds64 += (1 << 32);
    s_TotalMilliseconds = ms;
    s_TotalMilliseconds64 = (s_TotalMilliseconds64 & ~0xFFFFFFFFULL) | (uint64_t)ms;
#endif
    return s_TotalMilliseconds;
}

EVE_millis64()

EVE_HAL_EXPORT uint64_t EVE_millis64

(

)

Get clock in miliseond.

Need to ensure that below api is called at least once in 6.5 seconds duration for FT900 platform as this module doesnt use timer for context update global counter to loopback after ~49.71 days

Returns

uint32_t Clock number

Definition at line 862 of file EVE_HalImpl_FT9XX.c.

{
#if defined(PANL_APPLET)
    uint32_t ms = panl_timer_get_time();
    if ((uint64_t)ms < s_TotalMilliseconds)
        s_TotalMilliseconds64 += (1 << 32);
    s_TotalMilliseconds = ms;
    s_TotalMilliseconds64 = (s_TotalMilliseconds64 & ~0xFFFFFFFFULL) | (uint64_t)ms;
#endif
    return s_TotalMilliseconds64;
}

EVE_Millis_initialize()

void EVE_Millis_initialize

(

)

Init FT9x timer.

Definition at line 802 of file EVE_HalImpl_FT9XX.c.

{
    s_TotalMilliseconds = 0;
#if !defined(PANL_APPLET)
    sys_enable(sys_device_timer_wdt);
#if defined(FT900_PLATFORM)
    timer_prescaler(FT900_TIMER_PRESCALE_VALUE);
#else
    timer_prescaler(FT900_FT_MILLIS_TIMER, FT900_TIMER_PRESCALE_VALUE);
#endif
    timer_init(FT900_FT_MILLIS_TIMER, FT900_TIMER_OVERFLOW_VALUE, timer_direction_up, timer_prescaler_select_on, timer_mode_continuous);
 
    interrupt_attach(interrupt_timers, 17, ticker);
    /* enabling the interrupts for timer */
    timer_enable_interrupt(FT900_FT_MILLIS_TIMER);
 
    timer_start(FT900_FT_MILLIS_TIMER);
#endif
}

EVE_Millis_release()

void EVE_Millis_release

(

)

Release FT9x timer.

Definition at line 826 of file EVE_HalImpl_FT9XX.c.

{
#if !defined(PANL_APPLET)
    timer_stop(FT900_FT_MILLIS_TIMER);
    timer_disable_interrupt(FT900_FT_MILLIS_TIMER);
#endif
}

EVE_UtilImpl_bootupDisplayGpio()

bool EVE_UtilImpl_bootupDisplayGpio

(

EVE_HalContext *

phost

)

Display GPIO pins.

Parameters

phost

Pointer to Hal context

Returns

true True if Ok

false False if error

Definition at line 915 of file EVE_HalImpl_FT9XX.c.

{
    return true;
}

Variable Documentation

g_HalPlatform

EVE_HalPlatform g_HalPlatform

extern

Definition at line 43 of file EVE_Hal.c.