EVE_CoCmd_IO.c File Reference

EVE's co-processor IO commmands. More...

#include "EVE_Platform.h"

Go to the source code of this file.

Functions
EVE_HAL_EXPORT bool	EVE_CoCmd_memCrc (EVE_HalContext *phost, uint32_t ptr, uint32_t num, uint32_t *result)
	Send CMD_MEMCRC.
EVE_HAL_EXPORT bool	EVE_CoCmd_regRead (EVE_HalContext *phost, uint32_t ptr, uint32_t *result)
	Send CMD_REGREAD.
EVE_HAL_EXPORT bool	EVE_CoCmd_inflate_progMem (EVE_HalContext *phost, uint32_t dst, eve_progmem_const uint8_t *src, uint32_t size)
	Inflates data from program memory to RAM_G.
EVE_HAL_EXPORT bool	EVE_CoCmd_getPtr (EVE_HalContext *phost, uint32_t *result)
	Get the end memory address of data inflated by CMD_INFLATE and CMD_INFLATE2 At API level 2, the allocation pointer is also advanced by:
EVE_HAL_EXPORT bool	EVE_CoCmd_loadImage_progMem (EVE_HalContext *phost, uint32_t dst, eve_progmem_const uint8_t *src, uint32_t size, uint32_t *format)
	Load image from program memory.
EVE_HAL_EXPORT bool	EVE_CoCmd_getProps (EVE_HalContext *phost, uint32_t *ptr, uint32_t *w, uint32_t *h)
	Get the image properties decompressed by CMD_LOADIMAGE.
EVE_HAL_EXPORT bool	EVE_CoCmd_flashErase_flush (EVE_HalContext *phost)
	Send CMD_FLASHERASE. Wait for completion.
EVE_HAL_EXPORT bool	EVE_CoCmd_flashRead_flush (EVE_HalContext *phost, uint32_t dest, uint32_t src, uint32_t num)
	Read from Flash to RAM_G.
EVE_HAL_EXPORT uint32_t	EVE_CoCmd_flashAttach (EVE_HalContext *phost)
	Attach flash.
EVE_HAL_EXPORT uint32_t	EVE_CoCmd_flashFast (EVE_HalContext *phost, uint32_t *result)
	Enter fast flash state.
EVE_HAL_EXPORT bool	EVE_CoCmd_loadImage_flash (EVE_HalContext *phost, uint32_t dst, uint32_t src, uint32_t *format)
	Load image from Flash to RAM_G.
EVE_HAL_EXPORT bool	EVE_CoCmd_inflate_flash (EVE_HalContext *phost, uint32_t dst, uint32_t src)
	Inflates data from Flash to RAM_G.

Detailed Description

EVE's co-processor IO commmands.

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_CoCmd_IO.c.

Function Documentation

EVE_CoCmd_flashAttach()

EVE_HAL_EXPORT uint32_t EVE_CoCmd_flashAttach

(

EVE_HalContext *

phost

)

Attach flash.

Parameters

phost

Pointer to Hal context

Returns

uint32_t Returns new FLASH_STATUS

Definition at line 208 of file EVE_CoCmd_IO.c.

{
    uint32_t flashStatus;
    EVE_MULTI_TARGET_CHECK_RETURN(CMD_FLASHATTACH, EVE_CHIPID >= EVE_BT815, 0);
    if (!EVE_Cmd_waitFlush(phost))
        return EVE_Hal_rd32(phost, REG_FLASH_STATUS); // Coprocessor must be ready
    flashStatus = EVE_Hal_rd32(phost, REG_FLASH_STATUS);
    if (flashStatus != FLASH_STATUS_DETACHED)
        return flashStatus; // Only attach when detached
    EVE_CoCmd_d(phost, CMD_FLASHATTACH);
    EVE_Cmd_waitFlush(phost); // Wait for command completion
    return EVE_Hal_rd32(phost, REG_FLASH_STATUS); // Return current status
}

EVE_CoCmd_flashErase_flush()

EVE_HAL_EXPORT bool EVE_CoCmd_flashErase_flush

(

EVE_HalContext *

phost

)

Send CMD_FLASHERASE. Wait for completion.

Parameters

phost

Pointer to Hal context

Returns

bool false on coprocessor fault

Definition at line 181 of file EVE_CoCmd_IO.c.

{
    EVE_MULTI_TARGET_CHECK_RETURN(CMD_FLASHERASE, EVE_CHIPID >= EVE_BT815, false);
 
    if (!EVE_Cmd_waitFlush(phost))
        return false; // Coprocessor must be ready
 
    EVE_CoCmd_d(phost, CMD_FLASHERASE);
 
    return EVE_Cmd_waitFlush(phost);
}

EVE_CoCmd_flashFast()

EVE_HAL_EXPORT uint32_t EVE_CoCmd_flashFast	(	EVE_HalContext *	phost,
		uint32_t *	result
	)

Enter fast flash state.

Parameters

phost	Pointer to Hal context
result

Returns

new FLASH_STATUS

Definition at line 228 of file EVE_CoCmd_IO.c.

{
    uint16_t resAddr;
    uint32_t flashStatus;
 
    EVE_MULTI_TARGET_CHECK_RETURN(CMD_FLASHFAST, EVE_CHIPID >= EVE_BT815, 0);
 
    if (!EVE_Cmd_waitFlush(phost))
    {
        if (result)
            *result = 0xE000;
        return EVE_Hal_rd32(phost, REG_FLASH_STATUS);
    } // Coprocessor must be ready
    flashStatus = EVE_Hal_rd32(phost, REG_FLASH_STATUS);
    if (flashStatus < FLASH_STATUS_BASIC)
    {
        if (result)
            *result = 0xE001;
        return flashStatus;
    }
    if (flashStatus > FLASH_STATUS_BASIC)
    {
        if (result)
            *result = 0;
        return flashStatus;
    } // Only enter fast mode when attached
 
#if EVE_CMD_HOOKS
    if (phost->CoCmdHook && phost->CoCmdHook(phost, CMD_FLASHFAST, 0))
        return flashStatus;
#endif
 
    EVE_Cmd_startFunc(phost);
    EVE_Cmd_wr32(phost, CMD_FLASHFAST);
    resAddr = EVE_Cmd_moveWp(phost, 4); // Get the address where the coprocessor will write the result
    EVE_Cmd_endFunc(phost);
    EVE_Cmd_waitFlush(phost); // Wait for command completion
    if (result)
        *result = EVE_Hal_rd32(phost, RAM_CMD + resAddr); // Fetch result
    return EVE_Hal_rd32(phost, REG_FLASH_STATUS); // Return current status
}

EVE_CoCmd_flashRead_flush()

EVE_HAL_EXPORT bool EVE_CoCmd_flashRead_flush	(	EVE_HalContext *	phost,
		uint32_t	dest,
		uint32_t	src,
		uint32_t	num
	)

Read from Flash to RAM_G.

Parameters

phost	Pointer to Hal context
dest	destination address in main memory. Must be 4-byte aligned
src	source address in flash memory. Must be 64-byte aligned
num	number of bytes to read, must be multiple of 4

Returns

bool false on coprocessor fault

Definition at line 193 of file EVE_CoCmd_IO.c.

{
    EVE_MULTI_TARGET_CHECK_RETURN(CMD_FLASHREAD, EVE_CHIPID >= EVE_BT815, false);
 
    if (!EVE_Cmd_waitFlush(phost))
        return false; // Coprocessor must be ready
 
    EVE_CoCmd_dddd(phost, CMD_FLASHREAD, dest, src, num);
 
    return EVE_Cmd_waitFlush(phost);
}

EVE_CoCmd_getProps()

EVE_HAL_EXPORT bool EVE_CoCmd_getProps	(	EVE_HalContext *	phost,
		uint32_t *	ptr,
		uint32_t *	w,
		uint32_t *	h
	)

Get the image properties decompressed by CMD_LOADIMAGE.

Parameters

phost	Pointer to Hal context
ptr	Source address of bitmap
w	Width of bitmap, in pixels
h	Height of bitmap, in pixels

Returns

bool Returns false on coprocessor fault

Definition at line 150 of file EVE_CoCmd_IO.c.

{
    uint16_t resAddr;
 
#if EVE_CMD_HOOKS
    if (phost->CoCmdHook && phost->CoCmdHook(phost, CMD_GETPROPS, 0))
        return false;
#endif
 
    EVE_Cmd_startFunc(phost);
    EVE_Cmd_wr32(phost, CMD_GETPROPS);
    resAddr = EVE_Cmd_moveWp(phost, 12);
    EVE_Cmd_endFunc(phost);
 
    /* Read result */
    if (ptr || w || h)
    {
        if (!EVE_Cmd_waitFlush(phost))
            return false;
        if (ptr)
            *ptr = EVE_Hal_rd32(phost, RAM_CMD + resAddr);
        if (w)
            *w = EVE_Hal_rd32(phost, RAM_CMD + resAddr + 4);
        if (h)
            *h = EVE_Hal_rd32(phost, RAM_CMD + resAddr + 8);
    }
    return true;
}

EVE_CoCmd_getPtr()

EVE_HAL_EXPORT bool EVE_CoCmd_getPtr	(	EVE_HalContext *	phost,
		uint32_t *	result
	)

Get the end memory address of data inflated by CMD_INFLATE and CMD_INFLATE2 At API level 2, the allocation pointer is also advanced by:

Get the end memory address of data inflated by CMD_INFLATE.

• cmd_loadimage
• cmd_playvideo
• cmd_videoframe
• cmd_endlist

Definition at line 104 of file EVE_CoCmd_IO.c.

{
    uint16_t resAddr;
 
#if EVE_CMD_HOOKS
    if (phost->CoCmdHook && phost->CoCmdHook(phost, CMD_GETPTR, 0))
        return false;
#endif
 
    EVE_Cmd_startFunc(phost);
    EVE_Cmd_wr32(phost, CMD_GETPTR);
    resAddr = EVE_Cmd_moveWp(phost, 4); // move write pointer to result location
    EVE_Cmd_endFunc(phost);
 
    /* Read result */
    if (result)
    {
        if (!EVE_Cmd_waitFlush(phost))
            return false;
        *result = EVE_Hal_rd32(phost, RAM_CMD + resAddr);
    }
    return true;
}

EVE_CoCmd_inflate_flash()

EVE_HAL_EXPORT bool EVE_CoCmd_inflate_flash	(	EVE_HalContext *	phost,
		uint32_t	dst,
		uint32_t	src
	)

Inflates data from Flash to RAM_G.

Parameters

phost	Pointer to Hal context
dst	Image location on flash
src	Destination on RAM_G

Returns

bool Returns false on coprocessor fault

Definition at line 295 of file EVE_CoCmd_IO.c.

{
#if EVE_CMD_HOOKS
    if (phost->CoCmdHook && phost->CoCmdHook(phost, CMD_FLASHSOURCE, src))
        return false;
    if (phost->CoCmdHook && phost->CoCmdHook(phost, CMD_INFLATE2, dst))
        return false;
#endif
 
    if (!EVE_Cmd_waitFlush(phost))
        return false; // Coprocessor must be ready
    EVE_Cmd_startFunc(phost);
    EVE_Cmd_wr32(phost, CMD_FLASHSOURCE);
    EVE_Cmd_wr32(phost, src);
    EVE_Cmd_wr32(phost, CMD_INFLATE2);
    EVE_Cmd_wr32(phost, dst);
    EVE_Cmd_wr32(phost, OPT_FLASH);
    EVE_Cmd_endFunc(phost);
    return EVE_Cmd_waitFlush(phost); // Image failed to load
}

EVE_CoCmd_inflate_progMem()

EVE_HAL_EXPORT bool EVE_CoCmd_inflate_progMem	(	EVE_HalContext *	phost,
		uint32_t	dst,
		eve_progmem_const uint8_t *	src,
		uint32_t	size
	)

Inflates data from program memory to RAM_G.

Parameters

phost	Pointer to Hal context
dst	Image address
src	Desination on RAM_G
size	size of src in bytes

Returns

Returns false on coprocessor fault

Definition at line 85 of file EVE_CoCmd_IO.c.

{
    if (!EVE_Cmd_waitFlush(phost))
        return false; // Coprocessor must be ready
    EVE_Cmd_startFunc(phost);
    EVE_Cmd_wr32(phost, CMD_INFLATE);
    EVE_Cmd_wr32(phost, dst);
    EVE_Cmd_wrProgMem(phost, src, (size + 3) & ~0x3UL);
    EVE_Cmd_endFunc(phost);
    return EVE_Cmd_waitFlush(phost); // Resource failed to load
}

EVE_CoCmd_loadImage_flash()

EVE_HAL_EXPORT bool EVE_CoCmd_loadImage_flash	(	EVE_HalContext *	phost,
		uint32_t	dst,
		uint32_t	src,
		uint32_t *	format
	)

Load image from Flash to RAM_G.

Parameters

phost	Pointer to Hal context
dst	Image location on flash
src	Destination on RAM_G
format	Output parameter format returns loaded bitmap format on success

Returns

bool Returns false on coprocessor fault

Definition at line 270 of file EVE_CoCmd_IO.c.

{
#if EVE_CMD_HOOKS
    if (phost->CoCmdHook && phost->CoCmdHook(phost, CMD_FLASHSOURCE, src))
        return false;
    if (phost->CoCmdHook && phost->CoCmdHook(phost, CMD_LOADIMAGE, dst))
        return false;
#endif
 
    if (!EVE_Cmd_waitFlush(phost))
        return false; // Coprocessor must be ready
    EVE_Cmd_startFunc(phost);
    EVE_Cmd_wr32(phost, CMD_FLASHSOURCE);
    EVE_Cmd_wr32(phost, src);
    EVE_Cmd_wr32(phost, CMD_LOADIMAGE);
    EVE_Cmd_wr32(phost, dst);
    EVE_Cmd_wr32(phost, OPT_FLASH | OPT_NODL);
    EVE_Cmd_endFunc(phost);
    if (!EVE_Cmd_waitFlush(phost))
        return false; // Image failed to load
    if (format)
        *format = EVE_Hal_rd32(phost, 0x3097e8);
    return true;
}

EVE_CoCmd_loadImage_progMem()

EVE_HAL_EXPORT bool EVE_CoCmd_loadImage_progMem	(	EVE_HalContext *	phost,
		uint32_t	dst,
		eve_progmem_const uint8_t *	src,
		uint32_t	size,
		uint32_t *	format
	)

Load image from program memory.

Parameters

phost	Pointer to Hal context
dst	Image address
src	Desination on RAM_G
size	size of src in bytes
format	Output parameter format returns loaded bitmap format on success

Returns

bool Returns false on coprocessor fault

Definition at line 128 of file EVE_CoCmd_IO.c.

{
#if EVE_CMD_HOOKS
    if (phost->CoCmdHook && phost->CoCmdHook(phost, CMD_LOADIMAGE, dst))
        return false;
#endif
 
    if (!EVE_Cmd_waitFlush(phost))
        return false; // Coprocessor must be ready
    EVE_Cmd_startFunc(phost);
    EVE_Cmd_wr32(phost, CMD_LOADIMAGE);
    EVE_Cmd_wr32(phost, dst);
    EVE_Cmd_wr32(phost, OPT_NODL);
    EVE_Cmd_wrProgMem(phost, src, (size + 3) & ~0x3UL);
    EVE_Cmd_endFunc(phost);
    if (!EVE_Cmd_waitFlush(phost))
        return false; // Image failed to load
    if (format)
        *format = EVE_Hal_rd32(phost, 0x3097e8);
    return true;
}

EVE_CoCmd_memCrc()

EVE_HAL_EXPORT bool EVE_CoCmd_memCrc	(	EVE_HalContext *	phost,
		uint32_t	ptr,
		uint32_t	num,
		uint32_t *	result
	)

Send CMD_MEMCRC.

Parameters

phost	Pointer to Hal context
ptr	starting address of the memory block
num	number of bytes in the source memory block
result	output parameter; written with the CRC-32 after command execution

Returns

bool Returns false in case of error

Definition at line 34 of file EVE_CoCmd_IO.c.

{
    uint16_t resAddr;
 
#if EVE_CMD_HOOKS
    if (phost->CoCmdHook && phost->CoCmdHook(phost, CMD_MEMCRC, 0))
        return false;
#endif
 
    EVE_Cmd_startFunc(phost);
    EVE_Cmd_wr32(phost, CMD_MEMCRC);
    EVE_Cmd_wr32(phost, ptr);
    EVE_Cmd_wr32(phost, num);
    resAddr = EVE_Cmd_moveWp(phost, 4);
    EVE_Cmd_endFunc(phost);
 
    /* Read result */
    if (result)
    {
        if (!EVE_Cmd_waitFlush(phost))
            return false;
        *result = EVE_Hal_rd32(phost, RAM_CMD + resAddr);
    }
    return true;
}

EVE_CoCmd_regRead()

EVE_HAL_EXPORT bool EVE_CoCmd_regRead	(	EVE_HalContext *	phost,
		uint32_t	ptr,
		uint32_t *	result
	)

Send CMD_REGREAD.

Parameters

phost	Pointer to Hal context
ptr	address of register to read
result	output parameter; written with the register value

Returns

bool Returns false in case of error

Definition at line 60 of file EVE_CoCmd_IO.c.

{
    uint16_t resAddr;
 
#if EVE_CMD_HOOKS
    if (phost->CoCmdHook && phost->CoCmdHook(phost, CMD_REGREAD, 0))
        return false;
#endif
 
    EVE_Cmd_startFunc(phost);
    EVE_Cmd_wr32(phost, CMD_REGREAD);
    EVE_Cmd_wr32(phost, ptr);
    resAddr = EVE_Cmd_moveWp(phost, 4);
    EVE_Cmd_endFunc(phost);
 
    /* Read result */
    if (result)
    {
        if (!EVE_Cmd_waitFlush(phost))
            return false;
        *result = EVE_Hal_rd32(phost, RAM_CMD + resAddr);
    }
    return true;
}