EVE_Cmd.h

Go to the documentation of this file.

 
#ifndef EVE_CMD__H
#define EVE_CMD__H
#include "EVE_HalDefs.h"
 
/********************
** COPROCESSOR CMD **
********************/
 
#define EVE_CMD_STRING_MAX 511
 
EVE_HAL_EXPORT uint16_t EVE_Cmd_rp(EVE_HalContext *phost);
 
EVE_HAL_EXPORT uint16_t EVE_Cmd_wp(EVE_HalContext *phost);
 
EVE_HAL_EXPORT uint16_t EVE_Cmd_space(EVE_HalContext *phost);
 
/* Begin writing a function, keeps the transfer open. */
EVE_HAL_EXPORT void EVE_Cmd_startFunc(EVE_HalContext *phost);
 
/* End writing a function, closes the transfer */
EVE_HAL_EXPORT void EVE_Cmd_endFunc(EVE_HalContext *phost);
 
EVE_HAL_EXPORT bool EVE_Cmd_wrMem(EVE_HalContext *phost, const uint8_t *buffer, uint32_t size);
 
EVE_HAL_EXPORT bool EVE_Cmd_wrProgMem(EVE_HalContext *phost, eve_progmem_const uint8_t *buffer, uint32_t size);
 
EVE_HAL_EXPORT uint32_t EVE_Cmd_wrString(EVE_HalContext *phost, const char *str, uint32_t maxLength);
 
EVE_HAL_EXPORT bool EVE_Cmd_wr8(EVE_HalContext *phost, uint8_t value);
 
EVE_HAL_EXPORT bool EVE_Cmd_wr16(EVE_HalContext *phost, uint16_t value);
 
EVE_HAL_EXPORT bool EVE_Cmd_wr32(EVE_HalContext *phost, uint32_t value);
 
/* Move the write pointer forward by the specified number of bytes. 
Returns the previous write pointer */
EVE_HAL_EXPORT uint16_t EVE_Cmd_moveWp(EVE_HalContext *phost, uint16_t bytes);
 
EVE_HAL_EXPORT bool EVE_Cmd_waitFlush(EVE_HalContext *phost);
 
/* Wait for the command buffer to have at least the requested amount of free space.
Returns 0 in case a coprocessor fault occurred */
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 for a 32-bit value that was set by `EVE_CoCmd_memWrite32(phost, ptr, value)`.
Returns true when the value is found. Returns false otherwise
when the coprocessor has flushed, or a coprocessor fault occured. */
EVE_HAL_EXPORT bool EVE_Cmd_waitRead32(EVE_HalContext *phost, uint32_t ptr, uint32_t value);
 
/* Restore the internal state of EVE_Cmd.
Call this after manually writing the the coprocessor buffer */
EVE_HAL_EXPORT void EVE_Cmd_restore(EVE_HalContext *phost);
 
#endif /* #ifndef EVE_HAL_INCL__H */
 
/* end of file */