atcmd_transport_w_api_t Struct Reference

#include <rm_atcmd_transport_w_api.h>

Data Fields
fsp_err_t(*	open )(atcmd_transport_w_ctrl_t *p_ctrl, atcmd_transport_w_cfg_t const *const p_cfg, atcmd_w_ctrl_t *p_at_ctrl)
fsp_err_t(*	close )(atcmd_transport_w_ctrl_t *const p_ctrl)
fsp_err_t(*	atCommandSendThreadSafe )(atcmd_transport_w_ctrl_t *const p_ctrl, atcmd_transport_w_data_t *p_at_cmd)
fsp_err_t(*	atCommandSend )(atcmd_transport_w_ctrl_t *const p_ctrl, atcmd_transport_w_data_t *p_at_cmd)
fsp_err_t(*	giveMutex )(atcmd_transport_w_ctrl_t *const p_ctrl, uint32_t mutex_flag)
fsp_err_t(*	takeMutex )(atcmd_transport_w_ctrl_t *const p_ctrl, uint32_t mutex_flag)
fsp_err_t(*	statusGet )(atcmd_transport_w_ctrl_t *const p_ctrl, atcmd_transport_w_status_t *p_status)
size_t(*	bufferRecv )(atcmd_transport_w_ctrl_t *const p_ctrl, const char *p_data, uint32_t length, uint32_t rx_timeout)

Detailed Description

AT Command APIs

Field Documentation

open

fsp_err_t(* atcmd_transport_w_api_t::open) (atcmd_transport_w_ctrl_t *p_ctrl, atcmd_transport_w_cfg_t const *const p_cfg, atcmd_w_ctrl_t *p_at_ctrl)

Open at cmd instance.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_cfg	Pointer to configuration structure.

close

fsp_err_t(* atcmd_transport_w_api_t::close) (atcmd_transport_w_ctrl_t *const p_ctrl)

Close at cmd instance.

Parameters

[in]

p_ctrl

Pointer to control structure.

atCommandSendThreadSafe

fsp_err_t(* atcmd_transport_w_api_t::atCommandSendThreadSafe) (atcmd_transport_w_ctrl_t *const p_ctrl, atcmd_transport_w_data_t *p_at_cmd)

at cmd send thread safe.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_at_cmd	Pointer to AT command data structure.

atCommandSend

fsp_err_t(* atcmd_transport_w_api_t::atCommandSend) (atcmd_transport_w_ctrl_t *const p_ctrl, atcmd_transport_w_data_t *p_at_cmd)

at cmd send.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_at_cmd	Pointer to AT command data structure.

giveMutex

fsp_err_t(* atcmd_transport_w_api_t::giveMutex) (atcmd_transport_w_ctrl_t *const p_ctrl, uint32_t mutex_flag)

Give the mutex.

Parameters

[in]	p_ctrl	Pointer to Transport layer instance control structure.
[in]	mutex_flag	TX/RX Flags for the mutex.

takeMutex

fsp_err_t(* atcmd_transport_w_api_t::takeMutex) (atcmd_transport_w_ctrl_t *const p_ctrl, uint32_t mutex_flag)

Take the mutex .

Parameters

[in]	p_ctrl	Pointer to Transport layer instance control structure.
[in]	mutex_flag	TX/RX Flags for the mutex.

statusGet

fsp_err_t(* atcmd_transport_w_api_t::statusGet) (atcmd_transport_w_ctrl_t *const p_ctrl, atcmd_transport_w_status_t *p_status)

Gets the status of the configured transport.

Parameters

[in]	p_ctrl	Pointer to the to Transport layer instance control structure.
[out]	p_status	Pointer to store current status.

bufferRecv

size_t(* atcmd_transport_w_api_t::bufferRecv) (atcmd_transport_w_ctrl_t *const p_ctrl, const char *p_data, uint32_t length, uint32_t rx_timeout)

Receive data from stream buffer.

Parameters

[in]	p_ctrl	Pointer to Transport layer instance control structure.
[in]	p_data	Pointer to data.
[in]	length	Data length.
[in]	rx_timeout	Timeout for receiving data on the buffer.
[in]	trigger_level	Trigger level for stream buffer.

---

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

• rm_atcmd_transport_w_api.h