Algorithm run data. More...
Data Fields | |
| union { | |
| struct esp_algorithm_image image | |
| struct { | |
| target_addr_t code_buf_addr | |
| Address of pre-compiled target buffer for stub trampoline. More... | |
| uint32_t code_buf_size | |
| Size of the pre-alocated on-board buffer for stub's code. More... | |
| target_addr_t min_stack_addr | |
| Pre-compiled target buffer's addr for stack. More... | |
| uint32_t min_stack_size | |
| Size of the pre-alocated on-board buffer for stub's stack. More... | |
| } on_board | |
| }; | |
| esp_algorithm_func_t | algo_func |
| Algorithm run function: see algorithm_run_xxx for example. More... | |
| void * | arch_info |
| Algorithm arch-specific info. More... | |
| const struct esp_algorithm_hw * | hw |
| HW specific API. More... | |
| struct esp_algorithm_mem_args | mem_args |
| Algorithm memory arguments. More... | |
| struct esp_algorithm_reg_args | reg_args |
| Algorithm register arguments. More... | |
| int32_t | ret_code |
| Algorithm return code. More... | |
| uint32_t | stack_size |
| Algorithm stack size. More... | |
| struct esp_algorithm_stub | stub |
| Stub. More... | |
| uint32_t | timeout_ms |
| Algorithm completion timeout in ms. More... | |
| esp_algorithm_usr_func_t | usr_func |
| Host side algorithm function. More... | |
| void * | usr_func_arg |
| Host side algorithm function argument. More... | |
| esp_algorithm_usr_func_done_t | usr_func_done |
| Host side algorithm function cleanup routine. More... | |
| esp_algorithm_usr_func_init_t | usr_func_init |
| Host side algorithm function setup routine. More... | |
Detailed Description
Algorithm run data.
Definition at line 256 of file esp_algorithm.h.
Field Documentation
◆
| union { ... } |
◆ algo_func
| esp_algorithm_func_t esp_algorithm_run_data::algo_func |
Algorithm run function: see algorithm_run_xxx for example.
Definition at line 293 of file esp_algorithm.h.
◆ arch_info
| void* esp_algorithm_run_data::arch_info |
Algorithm arch-specific info.
For Xtensa this should point to struct xtensa_algorithm.
Definition at line 266 of file esp_algorithm.h.
Referenced by esp_xtensa_algo_init().
◆ code_buf_addr
| target_addr_t esp_algorithm_run_data::code_buf_addr |
Address of pre-compiled target buffer for stub trampoline.
Definition at line 276 of file esp_algorithm.h.
◆ code_buf_size
| uint32_t esp_algorithm_run_data::code_buf_size |
Size of the pre-alocated on-board buffer for stub's code.
Definition at line 274 of file esp_algorithm.h.
◆ hw
| const struct esp_algorithm_hw* esp_algorithm_run_data::hw |
HW specific API.
Definition at line 295 of file esp_algorithm.h.
Referenced by esp_algorithm_load_func_image(), esp_algorithm_load_onboard_func(), esp_algorithm_run_debug_stub(), and esp_algorithm_run_image().
◆ image
| struct esp_algorithm_image esp_algorithm_run_data::image |
Definition at line 295 of file esp_algorithm.h.
Referenced by esp_algorithm_exec_func_image_va(), esp_algorithm_load_func_image(), and load_section_from_image().
◆ mem_args
| struct esp_algorithm_mem_args esp_algorithm_run_data::mem_args |
Algorithm memory arguments.
Definition at line 260 of file esp_algorithm.h.
Referenced by esp_algorithm_run_debug_stub(), and esp_algorithm_run_image().
◆ min_stack_addr
| target_addr_t esp_algorithm_run_data::min_stack_addr |
Pre-compiled target buffer's addr for stack.
Definition at line 280 of file esp_algorithm.h.
◆ min_stack_size
| uint32_t esp_algorithm_run_data::min_stack_size |
Size of the pre-alocated on-board buffer for stub's stack.
Definition at line 278 of file esp_algorithm.h.
◆
| struct { ... } esp_algorithm_run_data::on_board |
Referenced by esp_algorithm_load_onboard_func().
◆ reg_args
| struct esp_algorithm_reg_args esp_algorithm_run_data::reg_args |
Algorithm register arguments.
Definition at line 260 of file esp_algorithm.h.
Referenced by esp_algorithm_run_debug_stub(), esp_algorithm_run_image(), esp_algorithm_user_arg_set_uint(), esp_xtensa_algo_cleanup(), esp_xtensa_algo_init(), and esp_xtensa_algo_regs_init_start().
◆ ret_code
| int32_t esp_algorithm_run_data::ret_code |
Algorithm return code.
Definition at line 268 of file esp_algorithm.h.
Referenced by esp_algorithm_run_debug_stub(), and esp_algorithm_run_image().
◆ stack_size
| uint32_t esp_algorithm_run_data::stack_size |
Algorithm stack size.
Definition at line 260 of file esp_algorithm.h.
Referenced by esp_algorithm_load_func_image(), esp_algorithm_load_onboard_func(), esp_algorithm_run_debug_stub(), and esp_algorithm_run_image().
◆ stub
| struct esp_algorithm_stub esp_algorithm_run_data::stub |
Stub.
Definition at line 268 of file esp_algorithm.h.
Referenced by esp_algorithm_load_func_image(), esp_algorithm_load_onboard_func(), esp_algorithm_run_debug_stub(), esp_algorithm_run_image(), esp_algorithm_unload_func_image(), esp_xtensa_algo_cleanup(), esp_xtensa_algo_init(), and esp_xtensa_algo_regs_init_start().
◆ timeout_ms
| uint32_t esp_algorithm_run_data::timeout_ms |
Algorithm completion timeout in ms.
If 0, default value will be used
Definition at line 258 of file esp_algorithm.h.
Referenced by esp_algorithm_run_debug_stub(), and esp_algorithm_run_image().
◆ usr_func
| esp_algorithm_usr_func_t esp_algorithm_run_data::usr_func |
Host side algorithm function.
Definition at line 287 of file esp_algorithm.h.
Referenced by esp_algorithm_run_image().
◆ usr_func_arg
| void* esp_algorithm_run_data::usr_func_arg |
Host side algorithm function argument.
Definition at line 285 of file esp_algorithm.h.
Referenced by esp_algorithm_run_image().
◆ usr_func_done
| esp_algorithm_usr_func_done_t esp_algorithm_run_data::usr_func_done |
Host side algorithm function cleanup routine.
Definition at line 291 of file esp_algorithm.h.
Referenced by esp_algorithm_run_image().
◆ usr_func_init
| esp_algorithm_usr_func_init_t esp_algorithm_run_data::usr_func_init |
Host side algorithm function setup routine.
Definition at line 289 of file esp_algorithm.h.
Referenced by esp_algorithm_run_image().
The documentation for this struct was generated from the following file:
