cfn_sal_utl_at_parser.h File Reference

Abstract AT Command Parser service interface. More...

#include "cfn_sal.h"

Go to the source code of this file.

Data Structures
struct	cfn_sal_utl_at_parser_config_t
struct	cfn_sal_utl_at_parser_api_s
	AT Parser Virtual Method Table (VMT). More...

Macros
#define	CFN_SAL_UTL_TYPE_AT_PARSER   CFN_SAL_TYPE('A', 'T', 'P')

Typedefs
typedef struct cfn_sal_utl_at_parser_s	cfn_sal_utl_at_parser_t
typedef struct cfn_sal_utl_at_parser_api_s	cfn_sal_utl_at_parser_api_t
typedef void(*	cfn_sal_utl_at_parser_urc_callback_t) (cfn_sal_utl_at_parser_t *driver, const char *urc_line, void *user_arg)

Enumerations
enum	cfn_sal_utl_at_parser_event_t { CFN_SAL_UTL_AT_PARSER_EVENT_NONE = 0 , CFN_SAL_UTL_AT_PARSER_EVENT_URC_RECEIVED = CFN_HAL_BIT(0) }

Functions
	CFN_HAL_VMT_CHECK (struct cfn_sal_utl_at_parser_api_s)
	CFN_SAL_CREATE_DRIVER_TYPE (sal_utl_at_parser, cfn_sal_utl_at_parser_config_t, cfn_sal_utl_at_parser_api_t, cfn_sal_phy_t, cfn_hal_callback_t)
CFN_HAL_INLINE void	cfn_sal_utl_at_parser_populate (cfn_sal_utl_at_parser_t *driver, uint32_t peripheral_id, void *dependency, const cfn_sal_utl_at_parser_api_t *api, const cfn_sal_phy_t *phy, const cfn_sal_utl_at_parser_config_t *config, cfn_hal_callback_t callback, void *user_arg)
cfn_hal_error_code_t	cfn_sal_utl_at_parser_construct (cfn_sal_utl_at_parser_t *driver, const cfn_sal_utl_at_parser_config_t *config, const cfn_sal_phy_t *phy, void *dependency, cfn_hal_callback_t callback, void *user_arg)
cfn_hal_error_code_t	cfn_sal_utl_at_parser_destruct (cfn_sal_utl_at_parser_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_init (cfn_sal_utl_at_parser_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_deinit (cfn_sal_utl_at_parser_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_config_set (cfn_sal_utl_at_parser_t *driver, const cfn_sal_utl_at_parser_config_t *config)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_config_get (cfn_sal_utl_at_parser_t *driver, cfn_sal_utl_at_parser_config_t *config)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_callback_register (cfn_sal_utl_at_parser_t *driver, cfn_hal_callback_t callback, void *user_arg)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_power_state_set (cfn_sal_utl_at_parser_t *driver, cfn_hal_power_state_t state)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_event_enable (cfn_sal_utl_at_parser_t *driver, uint32_t event_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_event_disable (cfn_sal_utl_at_parser_t *driver, uint32_t event_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_event_get (cfn_sal_utl_at_parser_t *driver, uint32_t *event_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_error_enable (cfn_sal_utl_at_parser_t *driver, uint32_t error_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_error_disable (cfn_sal_utl_at_parser_t *driver, uint32_t error_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_error_get (cfn_sal_utl_at_parser_t *driver, uint32_t *error_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_send_command (cfn_sal_utl_at_parser_t *driver, const char *cmd)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_send_data (cfn_sal_utl_at_parser_t *driver, const uint8_t *data, size_t len)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_read_response (cfn_sal_utl_at_parser_t *driver, char *buffer, size_t max_len, uint32_t timeout_ms)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_register_urc (cfn_sal_utl_at_parser_t *driver, const char *prefix, cfn_sal_utl_at_parser_urc_callback_t cb, void *user_arg)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_unregister_urc (cfn_sal_utl_at_parser_t *driver, const char *prefix)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_set_echo (cfn_sal_utl_at_parser_t *driver, bool enabled)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_flush_rx (cfn_sal_utl_at_parser_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_send_command_wait_resp (cfn_sal_utl_at_parser_t *driver, const char *cmd, const char *expected_resp, uint32_t timeout_ms)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_register_urc_simple (cfn_sal_utl_at_parser_t *driver, const char *urc_string, void *callback)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_at_parser_set_timeout (cfn_sal_utl_at_parser_t *driver, uint32_t timeout_ms)

Detailed Description

Abstract AT Command Parser service interface.

Macro Definition Documentation

CFN_SAL_UTL_TYPE_AT_PARSER

#define CFN_SAL_UTL_TYPE_AT_PARSER   CFN_SAL_TYPE('A', 'T', 'P')

Typedef Documentation

cfn_sal_utl_at_parser_api_t

typedef struct cfn_sal_utl_at_parser_api_s cfn_sal_utl_at_parser_api_t

cfn_sal_utl_at_parser_t

typedef struct cfn_sal_utl_at_parser_s cfn_sal_utl_at_parser_t

cfn_sal_utl_at_parser_urc_callback_t

typedef void(* cfn_sal_utl_at_parser_urc_callback_t) (cfn_sal_utl_at_parser_t *driver, const char *urc_line, void *user_arg)

Enumeration Type Documentation

cfn_sal_utl_at_parser_event_t

enum cfn_sal_utl_at_parser_event_t

Enumerator
CFN_SAL_UTL_AT_PARSER_EVENT_NONE
CFN_SAL_UTL_AT_PARSER_EVENT_URC_RECEIVED	Unsolicited Result Code detected

Function Documentation

CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK

(

struct cfn_sal_utl_at_parser_api_s

)

CFN_SAL_CREATE_DRIVER_TYPE()

CFN_SAL_CREATE_DRIVER_TYPE	(	sal_utl_at_parser	,
		cfn_sal_utl_at_parser_config_t	,
		cfn_sal_utl_at_parser_api_t	,
		cfn_sal_phy_t	,
		cfn_hal_callback_t
	)

cfn_sal_utl_at_parser_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_callback_register	(	cfn_sal_utl_at_parser_t *	driver,
		cfn_hal_callback_t	callback,
		void *	user_arg
	)

cfn_sal_utl_at_parser_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_config_get	(	cfn_sal_utl_at_parser_t *	driver,
		cfn_sal_utl_at_parser_config_t *	config
	)

cfn_sal_utl_at_parser_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_config_set	(	cfn_sal_utl_at_parser_t *	driver,
		const cfn_sal_utl_at_parser_config_t *	config
	)

cfn_sal_utl_at_parser_construct()

cfn_hal_error_code_t cfn_sal_utl_at_parser_construct	(	cfn_sal_utl_at_parser_t *	driver,
		const cfn_sal_utl_at_parser_config_t *	config,
		const cfn_sal_phy_t *	phy,
		void *	dependency,
		cfn_hal_callback_t	callback,
		void *	user_arg
	)

cfn_sal_utl_at_parser_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_deinit

(

cfn_sal_utl_at_parser_t *

driver

)

cfn_sal_utl_at_parser_destruct()

cfn_hal_error_code_t cfn_sal_utl_at_parser_destruct

(

cfn_sal_utl_at_parser_t *

driver

)

cfn_sal_utl_at_parser_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_error_disable	(	cfn_sal_utl_at_parser_t *	driver,
		uint32_t	error_mask
	)

cfn_sal_utl_at_parser_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_error_enable	(	cfn_sal_utl_at_parser_t *	driver,
		uint32_t	error_mask
	)

cfn_sal_utl_at_parser_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_error_get	(	cfn_sal_utl_at_parser_t *	driver,
		uint32_t *	error_mask
	)

cfn_sal_utl_at_parser_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_event_disable	(	cfn_sal_utl_at_parser_t *	driver,
		uint32_t	event_mask
	)

cfn_sal_utl_at_parser_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_event_enable	(	cfn_sal_utl_at_parser_t *	driver,
		uint32_t	event_mask
	)

cfn_sal_utl_at_parser_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_event_get	(	cfn_sal_utl_at_parser_t *	driver,
		uint32_t *	event_mask
	)

cfn_sal_utl_at_parser_flush_rx()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_flush_rx

(

cfn_sal_utl_at_parser_t *

driver

)

cfn_sal_utl_at_parser_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_init

(

cfn_sal_utl_at_parser_t *

driver

)

cfn_sal_utl_at_parser_populate()

CFN_HAL_INLINE void cfn_sal_utl_at_parser_populate	(	cfn_sal_utl_at_parser_t *	driver,
		uint32_t	peripheral_id,
		void *	dependency,
		const cfn_sal_utl_at_parser_api_t *	api,
		const cfn_sal_phy_t *	phy,
		const cfn_sal_utl_at_parser_config_t *	config,
		cfn_hal_callback_t	callback,
		void *	user_arg
	)

cfn_sal_utl_at_parser_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_power_state_set	(	cfn_sal_utl_at_parser_t *	driver,
		cfn_hal_power_state_t	state
	)

cfn_sal_utl_at_parser_read_response()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_read_response	(	cfn_sal_utl_at_parser_t *	driver,
		char *	buffer,
		size_t	max_len,
		uint32_t	timeout_ms
	)

cfn_sal_utl_at_parser_register_urc()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_register_urc	(	cfn_sal_utl_at_parser_t *	driver,
		const char *	prefix,
		cfn_sal_utl_at_parser_urc_callback_t	cb,
		void *	user_arg
	)

cfn_sal_utl_at_parser_register_urc_simple()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_register_urc_simple	(	cfn_sal_utl_at_parser_t *	driver,
		const char *	urc_string,
		void *	callback
	)

cfn_sal_utl_at_parser_send_command()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_send_command	(	cfn_sal_utl_at_parser_t *	driver,
		const char *	cmd
	)

cfn_sal_utl_at_parser_send_command_wait_resp()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_send_command_wait_resp	(	cfn_sal_utl_at_parser_t *	driver,
		const char *	cmd,
		const char *	expected_resp,
		uint32_t	timeout_ms
	)

cfn_sal_utl_at_parser_send_data()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_send_data	(	cfn_sal_utl_at_parser_t *	driver,
		const uint8_t *	data,
		size_t	len
	)

cfn_sal_utl_at_parser_set_echo()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_set_echo	(	cfn_sal_utl_at_parser_t *	driver,
		bool	enabled
	)

cfn_sal_utl_at_parser_set_timeout()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_set_timeout	(	cfn_sal_utl_at_parser_t *	driver,
		uint32_t	timeout_ms
	)

cfn_sal_utl_at_parser_unregister_urc()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_at_parser_unregister_urc	(	cfn_sal_utl_at_parser_t *	driver,
		const char *	prefix
	)