Chapter 2. API Reference
struct async_memcpy_config_t
Type of async memcpy configuration.
Public Members
uint32_t backlog
Maximum number of streams that can be handled simultaneously
size_t sram_trans_align
DMA transfer alignment (both in size and address) for SRAM memory
size_t psram_trans_align
DMA transfer alignment (both in size and address) for PSRAM memory
uint32_t flags
Extra flags to control async memcpy feature
Macros
ASYNC_MEMCPY_DEFAULT_CONFIG()
Default configuration for async memcpy.
Type Definitions
typedef struct async_memcpy_context_t *async_memcpy_t
Type of async memcpy handle.
typedef bool (*async_memcpy_isr_cb_t)(async_memcpy_t mcp_hdl, async_memcpy_event_t
*event, void *cb_args)
Type of async memcpy interrupt callback function.
Return Whether a high priority task is woken up by the callback function
Note User can call OS primitives (semaphore, mutex, etc) in the callback function. Keep in mind, if any OS
primitive wakes high priority task up, the callback should return true.
Parameters
• mcp_hdl: Handle of async memcpy
• event: Event object, which contains related data, reserved for future
• cb_args: User defined arguments, passed from esp_async_memcpy function
2.6.4 Console
ESP-IDF provides console component, which includes building blocks needed to develop an interactive console
over serial port. This component includes following facilities:
• Line editing, provided by linenoise library. This includes handling of backspace and arrow keys, scrolling
through command history, command auto-completion, and argument hints.
• Splitting of command line into arguments.
• Argument parsing, provided by argtable3 library. This library includes APIs used for parsing GNU style
command line arguments.
• Functions for registration and dispatching of commands.
• Functions to establish a basic REPL (Read-Evaluate-Print-Loop) environment.
Note: These facilities can be used together or independently. For example, it is possible to use line editing and
command registration features, but use getopt or custom code for argument parsing, instead of argtable3. Likewise,
it is possible to use simpler means of command input (such as fgets) together with the rest of the means for
command splitting and argument parsing.
Espressif Systems 797
Submit Document Feedback
Release v4.4