API GUIDE / JPEGE / Middleware

G32S10 JPEGE Middleware 接口

Middleware 层接口:状态字段是 volatile,因为中断上下文会读取它。

1. 公开数据类型

1.1 im_jpege_state_t

状态含义
IM_JPEGE_STATE_UNINITIALIZED没有活动 MID 会话
IM_JPEGE_STATE_INITIALIZEDHAL/IRQ 已初始化,sequence 尚未配置
IM_JPEGE_STATE_CONFIGUREDsequence 已配置,可以启动下一帧
IM_JPEGE_STATE_RUNNING一帧已 arm,等待 frame-end 或异常事件
IM_JPEGE_STATE_ERROR帧异常结束,寄存器块等待复位和重新配置

状态字段是 volatile,因为中断上下文会读取它。im_jpege_get_state() 本身 不加锁,返回的只是读取瞬间的快照。

2. JPEGE MID 会话状态机

STATE  UNINITIALIZED
→
STATE  INITIALIZED
→
STATE  CONFIGURED
→
STATE  RUNNING
→
STATE  ERROR

UNINITIALIZED → INITIALIZED · im_jpege_init()

INITIALIZED / CONFIGURED → CONFIGURED · set_configure / encode

CONFIGURED → RUNNING · start_frame / encode

RUNNING → CONFIGURED · frame done + get_result

RUNNING → ERROR · timeout / overflow / frame-start abnormal

ERROR → INITIALIZED · reset / next encode

INITIALIZED / CONFIGURED / ERROR → UNINITIALIZED · deinit

状态转换表:

当前状态API结果
UNINITIALIZEDim_jpege_init()INITIALIZED
INITIALIZED / CONFIGUREDim_jpege_set_configure()CONFIGURED
CONFIGUREDim_jpege_start_frame()RUNNING;HAL 启动失败则回 CONFIGURED
RUNNINGim_jpege_wait_frame() 成功CONFIGURED
RUNNINGim_jpege_wait_frame() 异常ERROR
ERRORim_jpege_reset()INITIALIZED
ERRORim_jpege_encode()自动 reset 后重新配置
任意非 UNINITIALIZEDim_jpege_deinit()UNINITIALIZED

im_jpege_set_configure()、im_jpege_start_frame() 和im_jpege_wait_frame() 在 ERROR 状态都返回 IM_ERR_NOT_READY。需要先im_jpege_reset(),或者直接使用会自动恢复的 im_jpege_encode()。

3. API 详细说明

3.1 im_jpege_set_configure()

error_code_t im_jpege_set_configure(const im_jpege_job_t *job);

显式配置 sequence。要求:

  • job != NULL

  • 状态不是 UNINITIALIZED

  • 状态不是 RUNNING

  • 状态不是 ERROR

成功后 MID 保存 job 副本并进入 CONFIGURED。该配置一直有效,直到被新的set_configure() / encode() 配置替换,或会话进入 ERROR、reset、deinit。

在 ERROR 状态下该接口返回 IM_ERR_NOT_READY,不会自动复位;自动恢复由im_jpege_encode() 完成。

3.2 im_jpege_reset()

error_code_t im_jpege_reset(void);

在任务上下文执行 HAL 寄存器块复位。

状态行为
UNINITIALIZEDIM_ERR_NOT_READY
RUNNINGIM_ERR_BUSY
INITIALIZED / CONFIGURED / ERROR执行 HAL reset

成功后进入 INITIALIZED,sequence 配置被清空,必须重新配置。复位失败时 状态保持或回到 ERROR。

3.3 im_jpege_get_state()

im_jpege_state_t im_jpege_get_state(void);

无锁返回当前状态快照。需要读取 callable 状态时,应以CONFIGURED 为准;RUNNING 表示还有一帧未完成。

3.4 im_jpege_deinit()

error_code_t im_jpege_deinit(void);

释放 HAL、IRQ、waiter 和 callback 资源,进入 UNINITIALIZED。当前实现无论 是否有活动会话都返回 IM_OK;没有会话时是空操作。