essl_get_packet() function

Get a packet from ESSL slave.

Syntax

Show:

Summary

Declaration

Definition

from essl.h:115

esp_err_t essl_get_packet(essl_handle_t handle, void *out_data, size_t size, size_t *out_length, uint32_t wait_ms);

Implemented in essl.c:86

Arguments

Argument

Description

handle

Handle of an ESSL device.

out_data

Data output address

size

The size of the output buffer, if the buffer is smaller than the size of data to receive from slave, the driver returns ``ESP_ERR_NOT_FINISHED``

out_length

Output of length the data actually received from slave.

wait_ms

Millisecond to wait before timeout, will not wait at all if set to 0-9.

Return value

- ESP_OK Success: All the data has been read from the slave. - ESP_ERR_INVALID_ARG: Invalid argument, The handle is not initialized or the other arguments are invalid. - ESP_ERR_NOT_FINISHED: Read was successful, but there is still data remaining. - ESP_ERR_NOT_FOUND: Slave is not ready to send data. - ESP_ERR_NOT_SUPPORTED: This API is not supported in this mode - One of the error codes from SDMMC/SPI host controller.