EVE_Cmd.h File Reference

EVE's command read/write. More...

#include "EVE_HalDefs.h"

Go to the source code of this file.

Macros
#define	EVE_CMD_STRING_MAX   511

Functions
EVE_HAL_EXPORT uint16_t	EVE_Cmd_rp (EVE_HalContext *phost)
	Read from Coprocessor.
EVE_HAL_EXPORT uint16_t	EVE_Cmd_wp (EVE_HalContext *phost)
	Write to Coprocessor.
EVE_HAL_EXPORT uint16_t	EVE_Cmd_space (EVE_HalContext *phost)
	Get free space of Coprocessor's command buffer.
EVE_HAL_EXPORT void	EVE_Cmd_startFunc (EVE_HalContext *phost)
	Begin writing a function, keeps the transfer open.
EVE_HAL_EXPORT void	EVE_Cmd_endFunc (EVE_HalContext *phost)
	End writing a function, closes the transfer.
EVE_HAL_EXPORT bool	EVE_Cmd_wrMem (EVE_HalContext *phost, const uint8_t *buffer, uint32_t size)
	Write buffer to Coprocessor's comand fifo.
EVE_HAL_EXPORT bool	EVE_Cmd_wrProgMem (EVE_HalContext *phost, eve_progmem_const uint8_t *buffer, uint32_t size)
	Write buffer in ProgMem to Coprocessor's comand fifo.
EVE_HAL_EXPORT uint32_t	EVE_Cmd_wrString (EVE_HalContext *phost, const char *str, uint32_t maxLength)
	Write a string into Coprocessor's command fifo.
EVE_HAL_EXPORT bool	EVE_Cmd_wr8 (EVE_HalContext *phost, uint8_t value)
	Write a byte to Coprocessor's command fifo.
EVE_HAL_EXPORT bool	EVE_Cmd_wr16 (EVE_HalContext *phost, uint16_t value)
	Write 2 bytes to Coprocessor's command fifo.
EVE_HAL_EXPORT bool	EVE_Cmd_wr32 (EVE_HalContext *phost, uint32_t value)
	Write 4 bytes to Coprocessor's command fifo.
EVE_HAL_EXPORT uint16_t	EVE_Cmd_moveWp (EVE_HalContext *phost, uint16_t bytes)
	Move the write pointer forward by the specified number of bytes. Returns the previous write pointer.
EVE_HAL_EXPORT bool	EVE_Cmd_waitFlush (EVE_HalContext *phost)
	Wait till Command FIFO buffer empty.
EVE_HAL_EXPORT uint32_t	EVE_Cmd_waitSpace (EVE_HalContext *phost, uint32_t size)
EVE_HAL_EXPORT bool	EVE_Cmd_waitLogo (EVE_HalContext *phost)
	Wait until Coprocessor finished logo animation.
EVE_HAL_EXPORT bool	EVE_Cmd_waitRead32 (EVE_HalContext *phost, uint32_t ptr, uint32_t value)
EVE_HAL_EXPORT void	EVE_Cmd_restore (EVE_HalContext *phost)

Detailed Description

EVE's command read/write.

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_Cmd.h.

Macro Definition Documentation

EVE_CMD_STRING_MAX

#define EVE_CMD_STRING_MAX   511

Definition at line 44 of file EVE_Cmd.h.

Function Documentation

EVE_Cmd_endFunc()

EVE_HAL_EXPORT void EVE_Cmd_endFunc

(

EVE_HalContext *

phost

)

End writing a function, closes the transfer.

Parameters

phost

Pointer to Hal context

Definition at line 274 of file EVE_Cmd.c.

{
    eve_assert(!phost->CmdWaiting);
    eve_assert(phost->CmdBufferIndex == 0);
    endFunc(phost);
    phost->CmdFunc = false;
}

EVE_Cmd_moveWp()

EVE_HAL_EXPORT uint16_t EVE_Cmd_moveWp	(	EVE_HalContext *	phost,
		uint16_t	bytes
	)

Move the write pointer forward by the specified number of bytes. Returns the previous write pointer.

Parameters

phost	Pointer to Hal context
bytes	Number of bytes to move

Returns

uint16_t Previous write pointer

Definition at line 446 of file EVE_Cmd.c.

{
    uint16_t wp;
    uint16_t prevWp;
    eve_assert(!phost->CmdWaiting);
    eve_assert(phost->CmdBufferIndex == 0);
 
    if (!EVE_Cmd_waitSpace(phost, bytes))
        return -1;
 
    prevWp = EVE_Cmd_wp(phost);
    wp = (prevWp + bytes) & EVE_CMD_FIFO_MASK;
#if !defined(EVE_SUPPORT_CMDB) || defined(EVE_MULTI_GRAPHICS_TARGET)
    if (!EVE_Hal_supportCmdB(phost))
    {
        phost->CmdWp = wp;
    }
#endif
    EVE_Hal_wr16(phost, REG_CMD_WRITE, wp);
 
    return prevWp;
}

EVE_Cmd_restore()

EVE_HAL_EXPORT void EVE_Cmd_restore

(

EVE_HalContext *

phost

)

Restore the internal state of EVE_Cmd. Call this after manually writing to the coprocessor buffer

Definition at line 682 of file EVE_Cmd.c.

{
    EVE_Cmd_rp(phost);
    EVE_Cmd_wp(phost);
    EVE_Cmd_space(phost);
}

EVE_Cmd_rp()

EVE_HAL_EXPORT uint16_t EVE_Cmd_rp

(

EVE_HalContext *

phost

)

Read from Coprocessor.

Get the current read pointer. Safe to use during ongoing command transaction

Parameters

phost

Pointer to Hal context

Returns

uint16_t Read pointer

Definition at line 64 of file EVE_Cmd.c.

{
    uint16_t rp;
    endFunc(phost);
    rp = EVE_Hal_rd16(phost, REG_CMD_READ) & EVE_CMD_FIFO_MASK;
    if (EVE_CMD_FAULT(rp))
        phost->CmdFault = true;
    return rp;
}

EVE_Cmd_space()

EVE_HAL_EXPORT uint16_t EVE_Cmd_space

(

EVE_HalContext *

phost

)

Get free space of Coprocessor's command buffer.

Get the currently available space. Updates cached available space. Safe to use during ongoing command transaction

Parameters

phost

Pointer to Hal context

Returns

uint16_t Free space in Bytes

Definition at line 105 of file EVE_Cmd.c.

{
    uint16_t space;
    uint16_t wp;
    uint16_t rp;
    endFunc(phost);
    if (EVE_Hal_supportCmdB(phost))
    {
        space = EVE_Hal_rd16(phost, REG_CMDB_SPACE) & EVE_CMD_FIFO_MASK;
        if (EVE_CMD_FAULT(space))
            phost->CmdFault = true;
        phost->CmdSpace = space;
        return space;
    }
    else
    {
        wp = EVE_Cmd_wp(phost);
        rp = EVE_Cmd_rp(phost);
        space = (rp - wp - 4) & EVE_CMD_FIFO_MASK;
        phost->CmdSpace = space;
        return space;
    }
}

EVE_Cmd_startFunc()

EVE_HAL_EXPORT void EVE_Cmd_startFunc

(

EVE_HalContext *

phost

)

Begin writing a function, keeps the transfer open.

Note

While a command transaction is ongoing, HAL functions outside of EVE_Cmd_* must not be used.

Parameters

phost

Pointer to Hal context

Definition at line 262 of file EVE_Cmd.c.

{
    eve_assert(!phost->CmdWaiting);
    eve_assert(phost->CmdBufferIndex == 0);
    phost->CmdFunc = true;
}

EVE_Cmd_waitFlush()

EVE_HAL_EXPORT bool EVE_Cmd_waitFlush

(

EVE_HalContext *

phost

)

Wait till Command FIFO buffer empty.

Wait for the command buffer to fully empty. Returns false in case a coprocessor fault occurred

Parameters

phost

Pointer to Hal context

Returns

true True if ok

false False if error

Definition at line 775 of file Gpu_Hal.cpp.

{
    while(Gpu_Hal_Rd16(host,REG_CMD_READ) != Gpu_Hal_Rd16(host,REG_CMD_WRITE));
 
    host->cmd_fifo_wp = Gpu_Hal_Rd16(host,REG_CMD_WRITE);
}

EVE_Cmd_waitLogo()

EVE_HAL_EXPORT bool EVE_Cmd_waitLogo

(

EVE_HalContext *

phost

)

Wait until Coprocessor finished logo animation.

Wait for logo to finish displaying. (Waits for both the read and write pointer to go to 0)

Parameters

phost

Pointer to Hal context

Returns

true True if ok

false False if error

Definition at line 625 of file EVE_Cmd.c.

{
    uint16_t rp;
    uint16_t wp;
 
    eve_assert(!phost->CmdWaiting);
    phost->CmdWaiting = true;
 
    do
    {
        rp = EVE_Cmd_rp(phost);
        wp = EVE_Cmd_wp(phost);
        if (!handleWait(phost, rp))
            return false;
 
    } while ((wp != 0) || (rp != 0));
 
    phost->CmdWaiting = false;
    return true;
}

EVE_Cmd_waitRead32()

EVE_HAL_EXPORT bool EVE_Cmd_waitRead32	(	EVE_HalContext *	phost,
		uint32_t	ptr,
		uint32_t	value
	)

Wait for a 32-bit value that was set by EVE_CoCmd_memWrite32(phost, ptr, value).

Returns

true when the value is found.

false otherwise when the coprocessor has flushed, or a coprocessor fault occured.

Definition at line 651 of file EVE_Cmd.c.

{
    uint16_t rp;
    uint16_t wp;
 
    eve_assert(!phost->CmdWaiting);
    phost->CmdWaiting = true;
    while ((rp = EVE_Cmd_rp(phost)) != (wp = EVE_Cmd_wp(phost)))
    {
        if (EVE_Hal_rd32(phost, ptr) == value)
        {
            /* Expected value has been read */
            phost->CmdWaiting = false;
            return true;
        }
        if (!handleWait(phost, rp))
        {
            phost->CmdSpace = (rp - wp - 4) & EVE_CMD_FIFO_MASK;
            return false;
        }
    }
 
    /* Command buffer empty */
    phost->CmdSpace = EVE_CMD_FIFO_SIZE - 4;
    phost->CmdWaiting = false;
    return EVE_Hal_rd32(phost, ptr) == value;
}

EVE_Cmd_waitSpace()

EVE_HAL_EXPORT uint32_t EVE_Cmd_waitSpace	(	EVE_HalContext *	phost,
		uint32_t	size
	)

Wait for the command buffer to have at least the requested amount of free space.

Returns

0 in case a coprocessor fault occurred

Definition at line 580 of file EVE_Cmd.c.

{
    uint16_t space;
 
    if (size > (EVE_CMD_FIFO_SIZE - 4))
    {
        eve_printf_debug("Requested free space exceeds coprocessor FIFO\n");
        return 0;
    }
 
    eve_assert(!phost->CmdWaiting);
    phost->CmdWaiting = true;
 
    space = phost->CmdSpace;
 
#if 1
    /* Optimization. 
    Only update space if more space is needed than already known available, 
    or when not actually waiting for any space */
    if (space < size || !size)
        space = EVE_Cmd_space(phost);
    if (!checkWait(phost, space))
        return 0;
#endif
 
    /* Wait until there's sufficient space */
    while (space < size)
    {
        space = EVE_Cmd_space(phost);
        if (!handleWait(phost, space))
            return 0;
    }
 
    /* Sufficient space */
    phost->CmdWaiting = false;
    return space;
}

EVE_Cmd_wp()

EVE_HAL_EXPORT uint16_t EVE_Cmd_wp

(

EVE_HalContext *

phost

)

Write to Coprocessor.

Get the current write pointer. Updates cached write pointer when CMDB is not supported. Safe to use during ongoing command transaction

Parameters

phost

Pointer to Hal context

Returns

uint16_t Write pointer

Definition at line 80 of file EVE_Cmd.c.

{
    endFunc(phost);
    if (EVE_Hal_supportCmdB(phost))
    {
        return EVE_Hal_rd16(phost, REG_CMD_WRITE) & EVE_CMD_FIFO_MASK;
    }
    else
    {
#if !defined(EVE_SUPPORT_CMDB) || defined(EVE_MULTI_GRAPHICS_TARGET)
        phost->CmdWp = EVE_Hal_rd16(phost, REG_CMD_WRITE) & EVE_CMD_FIFO_MASK;
        return phost->CmdWp;
#else
        eve_assert(false);
        return 0xffff;
#endif
    }
}

EVE_Cmd_wr16()

EVE_HAL_EXPORT bool EVE_Cmd_wr16	(	EVE_HalContext *	phost,
		uint16_t	value
	)

Write 2 bytes to Coprocessor's command fifo.

Write a 16-bit value to the command buffer. Uses a cache to write 4 bytes at once. Wire endianness is handled by the transfer. Waits if there is not enough space in the command buffer. Returns false in case a coprocessor fault occurred

Parameters

phost	Pointer to Hal context
value	Data to write

Returns

true True if ok

false False if error

Definition at line 366 of file EVE_Cmd.c.

{
    eve_assert(!phost->CmdWaiting);
    eve_assert(phost->CmdBufferIndex < 3);
 
    if (phost->CmdBufferIndex < 3)
    {
        phost->CmdBuffer[phost->CmdBufferIndex++] = value & 0xFF;
        phost->CmdBuffer[phost->CmdBufferIndex++] = value >> 8;
    }
 
    if (phost->CmdBufferIndex == 4)
    {
        phost->CmdBufferIndex = 0;
        return EVE_Cmd_wrMem(phost, phost->CmdBuffer, 4);
    }
 
    return true;
}

EVE_Cmd_wr32()

EVE_HAL_EXPORT bool EVE_Cmd_wr32	(	EVE_HalContext *	phost,
		uint32_t	value
	)

Write 4 bytes to Coprocessor's command fifo.

Write a value to the command buffer. Wire endianness is handled by the transfer. Waits if there is not enough space in the command buffer. Returns false in case a coprocessor fault occurred

Parameters

phost	Pointer to Hal context
value	Data to write

Returns

true True if ok

false False if error

Definition at line 394 of file EVE_Cmd.c.

{
    eve_assert(!phost->CmdWaiting);
    eve_assert(phost->CmdBufferIndex == 0);
 
    if (phost->CmdSpace < 4 && !EVE_Cmd_waitSpace(phost, 4))
        return false;
 
    if (phost->Status != EVE_STATUS_WRITING)
    {
        if (EVE_Hal_supportCmdB(phost))
        {
            EVE_Hal_startTransfer(phost, EVE_TRANSFER_WRITE, REG_CMDB_WRITE);
        }
        else
        {
#if !defined(EVE_SUPPORT_CMDB) || defined(EVE_MULTI_GRAPHICS_TARGET)
            EVE_Hal_startTransfer(phost, EVE_TRANSFER_WRITE, RAM_CMD + phost->CmdWp);
#else
            eve_assert(false);
#endif
        }
    }
    EVE_Hal_transfer32(phost, value);
    if (!phost->CmdFunc) /* Keep alive while writing function */
    {
        EVE_Hal_endTransfer(phost);
    }
    eve_assert(phost->CmdSpace >= 4);
    phost->CmdSpace -= 4;
#if !defined(EVE_SUPPORT_CMDB) || defined(EVE_MULTI_GRAPHICS_TARGET)
    if (!EVE_Hal_supportCmdB(phost))
    {
        phost->CmdWp += 4;
        phost->CmdWp &= EVE_CMD_FIFO_MASK;
        if (!phost->CmdFunc) /* Defer write pointer */
        {
            EVE_Hal_wr16(phost, REG_CMD_WRITE, phost->CmdWp);
        }
    }
#endif
 
    return true;
}

EVE_Cmd_wr8()

EVE_HAL_EXPORT bool EVE_Cmd_wr8	(	EVE_HalContext *	phost,
		uint8_t	value
	)

Write a byte to Coprocessor's command fifo.

Write a 8-bit value to the command buffer. Uses a cache to write 4 bytes at once. Waits if there is not enough space in the command buffer. Returns false in case a coprocessor fault occurred

Parameters

phost	Pointer to Hal context
value	Byte to write

Returns

true True if ok

false False if error

Definition at line 339 of file EVE_Cmd.c.

{
    eve_assert(!phost->CmdWaiting);
    eve_assert(phost->CmdBufferIndex < 4);
 
    if (phost->CmdBufferIndex < 4)
    {
        phost->CmdBuffer[phost->CmdBufferIndex++] = value;
    }
 
    if (phost->CmdBufferIndex == 4)
    {
        phost->CmdBufferIndex = 0;
        return EVE_Cmd_wrMem(phost, phost->CmdBuffer, 4);
    }
 
    return true;
}

EVE_Cmd_wrMem()

EVE_HAL_EXPORT bool EVE_Cmd_wrMem	(	EVE_HalContext *	phost,
		const uint8_t *	buffer,
		uint32_t	size
	)

Write buffer to Coprocessor's comand fifo.

Write a buffer to the command buffer. Waits if there is not enough space in the command buffer. Returns false in case a coprocessor fault occurred

Parameters

phost	Pointer to Hal context
buffer	Data pointer
size	Size to write

Returns

true Write ok

false Write error

Definition at line 291 of file EVE_Cmd.c.

{
    eve_assert(!phost->CmdWaiting);
    eve_assert(phost->CmdBufferIndex == 0);
    return wrBuffer(phost, buffer, size, false, false) == size;
}

EVE_Cmd_wrProgMem()

EVE_HAL_EXPORT bool EVE_Cmd_wrProgMem	(	EVE_HalContext *	phost,
		eve_progmem_const uint8_t *	buffer,
		uint32_t	size
	)

Write buffer in ProgMem to Coprocessor's comand fifo.

Write a progmem buffer to the command buffer. Waits if there is not enough space in the command buffer. Returns false in case a coprocessor fault occurred

Parameters

phost	Pointer to Hal context
buffer	Data buffer
size	Size to write

Returns

true True if ok

false False if error

Definition at line 307 of file EVE_Cmd.c.

{
    eve_assert(!phost->CmdWaiting);
    eve_assert(phost->CmdBufferIndex == 0);
    return wrBuffer(phost, (void *)(uintptr_t)buffer, size, true, false) == size;
}

EVE_Cmd_wrString()

EVE_HAL_EXPORT uint32_t EVE_Cmd_wrString	(	EVE_HalContext *	phost,
		const char *	str,
		uint32_t	maxLength
	)

Write a string into Coprocessor's command fifo.

Write a string to the command buffer, padded to 4 bytes. Waits if there is not enough space in the command buffer. Parameter maxLength can be set up to EVE_CMD_STRING_MAX. Returns false in case a coprocessor fault occurred

Parameters

phost	Pointer to Hal context
str	String to write
maxLength	Length to write, up to EVE_CMD_STRING_MAX

Returns

uint32_t Number of bytes transfered

Definition at line 322 of file EVE_Cmd.c.

{
    uint32_t transfered;
    eve_assert(!phost->CmdWaiting);
    eve_assert(phost->CmdBufferIndex == 0);
    transfered = wrBuffer(phost, str, maxLength, false, true);
    return transfered;
}