_ewf_interface Struct Reference

The interface structure definition. More...

#include <ewf_interface.h>

Data Fields
volatile bool	command_mode
volatile bool	sync_urc_processing
struct _ewf_adapter *	adapter_ptr
void *	implementation_ptr
ewf_interface_message	current_message
ewf_interface_response_callback	response_callback
ewf_interface_urc_callback	urc_callback
ewf_interface_urc_callback	user_urc_callback
ewf_allocator *	message_allocator_ptr
ewf_allocator *	data_allocator_ptr
ewf_platform_queue *	response_queue_ptr
ewf_platform_queue *	urc_queue_ptr
volatile uint32_t	default_timeout
ewf_interface_tokenizer_pattern *	message_tokenizer_pattern_ptr
ewf_interface_tokenizer_pattern *	command_response_end_tokenizer_pattern_ptr
ewf_interface_tokenizer_pattern *	command_response_tokenizer_pattern_ptr
ewf_interface_tokenizer_pattern *	urc_tokenizer_pattern_ptr
ewf_result(*	hardware_start )(ewf_interface *interface_ptr)
ewf_result(*	hardware_stop )(ewf_interface *interface_ptr)
ewf_result(*	hardware_send )(ewf_interface *interface_ptr, const uint8_t *buffer_ptr, uint32_t buffer_length)
ewf_result(*	hardware_receive )(ewf_interface *interface_ptr, uint8_t *buffer_ptr, uint32_t *buffer_length_ptr, bool wait)

Detailed Description

The interface structure definition.

Field Documentation

adapter_ptr

struct _ewf_adapter* _ewf_interface::adapter_ptr

< The pointer to the adapter The pointer to the implementation data

command_mode

volatile bool _ewf_interface::command_mode

< Internal reception mode: command or URC URC processing policy: synchronous or asynchronous

command_response_end_tokenizer_pattern_ptr

ewf_interface_tokenizer_pattern* _ewf_interface::command_response_end_tokenizer_pattern_ptr

A pointer to the first on a list of tokenizer patterns for tokenizing command responses, they do not complete commands and end the command mode

command_response_tokenizer_pattern_ptr

ewf_interface_tokenizer_pattern* _ewf_interface::command_response_tokenizer_pattern_ptr

A pointer to the first on a list of tokenizer patterns set by the user for tokenizing URCs

default_timeout

volatile uint32_t _ewf_interface::default_timeout

< The default timeout for all operations

hardware_send

ewf_result(* _ewf_interface::hardware_send) (ewf_interface *interface_ptr, const uint8_t *buffer_ptr, uint32_t buffer_length)

A pointer to the hardware receive function

hardware_start

ewf_result(* _ewf_interface::hardware_start) (ewf_interface *interface_ptr)

< A pointer to the hardware start function A pointer to the hardware stop function

hardware_stop

ewf_result(* _ewf_interface::hardware_stop) (ewf_interface *interface_ptr)

A pointer to the hardware send function

implementation_ptr

void* _ewf_interface::implementation_ptr

The current message being received This is a serial interface, only one message at a time is being received. There is no interleaving of message types (command or data).

message_allocator_ptr

ewf_allocator* _ewf_interface::message_allocator_ptr

< The message allocator, it might be NULL The data allocator, it might be NULL

message_tokenizer_pattern_ptr

ewf_interface_tokenizer_pattern* _ewf_interface::message_tokenizer_pattern_ptr

< A pointer to the first on a list of tokenizer patterns for tokenizing messages A pointer to the first on a list of tokenizer patterns for tokenizing command responses, they complete commands and end the command mode

response_callback

ewf_interface_response_callback _ewf_interface::response_callback

< Pointer to the response callback Pointer to the URC callback

response_queue_ptr

ewf_platform_queue* _ewf_interface::response_queue_ptr

< The command response queue The urc queue

urc_callback

ewf_interface_urc_callback _ewf_interface::urc_callback

Pointers to the user URC callbacks

---

The documentation for this struct was generated from the following file:

• G:/src/ewf_interface.h