EZIP

EZIP HAL module driver. More...

Modules
	EZIPA Color type
	EZIPA Dispose Op type
	EZIPA Blend Op type

Data Structures
struct	EZIP_DecodeConfigTypeDef
struct	__EZIP_HandleTypeDef
struct	EZIP_EZIPAHeaderTypeDef
struct	EZIP_EZIPAFrameInfoTypeDef

Macros
#define	HAL_EZIP_MODE_DATA_TYPE_MASK   (0x7F)
#define	HAL_EZIP_MODE_ADDR_TYPE_MASK   (0x80)
#define	HAL_EZIP_MODE_ADDR_CONT_TYPE   (0x00)
#define	EZIP_PARA_OUT_EPIC   (0UL)
#define	EZIP_PARA_OUT_AHB   (1UL)
#define	EZIP_PARA_MOD_EZIP   (0)
#define	EZIP_PARA_MOD_GZIP   (1)
#define	EZIP_PARA_MOD_LZ4   (2)

Typedefs
typedef struct __FLASH_HandleTypeDef *(*	EZIP_FlashHandleQueryCbTypeDef) (uint32_t addr)
typedef struct __EZIP_HandleTypeDef	EZIP_HandleTypeDef

Enumerations
enum	HAL_EZIP_StateTypeDef {   HAL_EZIP_STATE_RESET = 0x00U,   HAL_EZIP_STATE_READY = 0x01U,   HAL_EZIP_STATE_BUSY = 0x02U,   HAL_EZIP_STATE_TIMEOUT = 0x03U,   HAL_EZIP_STATE_ERROR = 0x04U,   HAL_EZIP_STATE_SUSPEND = 0x05U }
	HAL EZIP State structures definition. More...
enum	EZIP_WorkModeTypeDef {   HAL_EZIP_MODE_EZIP,   HAL_EZIP_MODE_GZIP,   HAL_EZIP_MODE_LZ4,   HAL_EZIP_MODE_DATA_TYPE_NUM }
enum	EZIP_OutputModeTypeDef {   HAL_EZIP_OUTPUT_EPIC,   HAL_EZIP_OUTPUT_AHB }

Functions
HAL_StatusTypeDef	HAL_EZIP_Init (EZIP_HandleTypeDef *ezip)
	EZIP Init. More...
HAL_StatusTypeDef	HAL_EZIP_IRQHandler (EZIP_HandleTypeDef *ezip)
	EZIP IRQ Handler. More...
HAL_StatusTypeDef	HAL_EZIP_Decode (EZIP_HandleTypeDef *ezip, EZIP_DecodeConfigTypeDef *config)
	Start decoding in polling mode. More...
HAL_StatusTypeDef	HAL_EZIP_Decode_IT (EZIP_HandleTypeDef *ezip, EZIP_DecodeConfigTypeDef *config)
	Start decoding in interrupt mode. More...
HAL_StatusTypeDef	HAL_EZIP_DeInit (EZIP_HandleTypeDef *ezip)
	EZIP Deinit. More...
HAL_StatusTypeDef	HAL_EZIP_CheckReady (EZIP_HandleTypeDef *ezip)
	Check if EZIP is idle. More...
HAL_StatusTypeDef	HAL_EZIP_OpenEZIPA (EZIP_HandleTypeDef *ezip, uint8_t *data, EZIP_EZIPAHeaderTypeDef *header, EZIP_EZIPAFrameInfoTypeDef *frame)
HAL_StatusTypeDef	HAL_EZIP_CloseEZIPA (EZIP_HandleTypeDef *ezip)
HAL_StatusTypeDef	HAL_EZIP_GetNextFrameInfo (EZIP_HandleTypeDef *ezip, EZIP_EZIPAFrameInfoTypeDef *frame)
HAL_StatusTypeDef	HAL_EZIP_SuspendEZIPA (EZIP_HandleTypeDef *ezip)
HAL_StatusTypeDef	HAL_EZIP_ResumeEZIPA (EZIP_HandleTypeDef *ezip, const uint8_t *data, uint32_t seq_num, uint32_t play_loop_idx)

Detailed Description

EZIP HAL module driver.

Macro Definition Documentation

HAL_EZIP_MODE_ADDR_CONT_TYPE

#define HAL_EZIP_MODE_ADDR_CONT_TYPE   (0x00)

Continuous Data Addressing Mode

HAL_EZIP_MODE_ADDR_TYPE_MASK

#define HAL_EZIP_MODE_ADDR_TYPE_MASK   (0x80)

bit7 indicates EZIP data addressing type

HAL_EZIP_MODE_DATA_TYPE_MASK

#define HAL_EZIP_MODE_DATA_TYPE_MASK   (0x7F)

low 7bit indicates EZIP data type, EZIP, GZIP or LZ4

Typedef Documentation

EZIP_HandleTypeDef

typedef struct __EZIP_HandleTypeDef EZIP_HandleTypeDef

EZIP handle structure definition

Enumeration Type Documentation

EZIP_OutputModeTypeDef

enum EZIP_OutputModeTypeDef

EZIP Output Mode

Enumerator
HAL_EZIP_OUTPUT_EPIC	output to EPIC
HAL_EZIP_OUTPUT_AHB	output to AHB bus

EZIP_WorkModeTypeDef

enum EZIP_WorkModeTypeDef

EZIP Work Mode

Enumerator
HAL_EZIP_MODE_EZIP	EZIP continuous mode
HAL_EZIP_MODE_GZIP	GZIP mode
HAL_EZIP_MODE_LZ4	LZ4 mode

HAL_EZIP_StateTypeDef

enum HAL_EZIP_StateTypeDef

HAL EZIP State structures definition.

Enumerator
HAL_EZIP_STATE_RESET	EZIP not yet initialized or disabled
HAL_EZIP_STATE_READY	Peripheral Initialized and ready for use
HAL_EZIP_STATE_BUSY	An internal process is ongoing
HAL_EZIP_STATE_TIMEOUT	Timeout state
HAL_EZIP_STATE_ERROR	EZIP state error
HAL_EZIP_STATE_SUSPEND	EZIP process is suspended

Function Documentation

HAL_EZIP_CheckReady()

HAL_StatusTypeDef HAL_EZIP_CheckReady

(

EZIP_HandleTypeDef *

ezip

)

Check if EZIP is idle.

Parameters

[in]

ezip

EZIP handle

Return values

HAL

status

HAL_EZIP_Decode()

HAL_StatusTypeDef HAL_EZIP_Decode	(	EZIP_HandleTypeDef *	ezip,
		EZIP_DecodeConfigTypeDef *	config
	)

Start decoding in polling mode.

Parameters

[in]	ezip	EZIP handle
[in]	config	decoding configuration

Return values

HAL

status

HAL_EZIP_Decode_IT()

HAL_StatusTypeDef HAL_EZIP_Decode_IT	(	EZIP_HandleTypeDef *	ezip,
		EZIP_DecodeConfigTypeDef *	config
	)

Start decoding in interrupt mode.

CpltCallback in handle is used to notify the completion

Parameters

[in]	ezip	EZIP handle
[in]	config	decoding configuration

Return values

HAL

status

HAL_EZIP_DeInit()

HAL_StatusTypeDef HAL_EZIP_DeInit

(

EZIP_HandleTypeDef *

ezip

)

EZIP Deinit.

Parameters

[in]

ezip

EZIP handle

Return values

HAL

status

HAL_EZIP_Init()

HAL_StatusTypeDef HAL_EZIP_Init

(

EZIP_HandleTypeDef *

ezip

)

EZIP Init.

Parameters

[in]

ezip

EZIP handle

Return values

HAL

status

HAL_EZIP_IRQHandler()

HAL_StatusTypeDef HAL_EZIP_IRQHandler

(

EZIP_HandleTypeDef *

ezip

)

EZIP IRQ Handler.

Parameters

ezip	EZIP handle

Return values

None