ipc_modem

Modem Service. More...

Data Structures
struct	a_ipc_dyn_array_enum_modem_rusat_result
	Dynamic-length array of a_ipc_enum_modem_rusat_result. More...
struct	a_ipc_msg_modem_rusat_at_command_req
	Request to send RUSAT AT command to NAD (Network Access Device). More...
struct	a_ipc_msg_modem_rusat_at_command_rsp
	Sent in response to a_ipc_msg_modem_rusat_at_command_req. More...
struct	a_ipc_msg_modem_rusat_sstn_latest_req
	Request latest known SSTN URC value. More...
struct	a_ipc_msg_modem_rusat_sstn_latest_rsp
	Sent in response to a_ipc_msg_modem_rusat_sstn_latest_req. More...
struct	a_ipc_msg_modem_rusat_urc_notification_publish_ind
	RUSAT related URC from NAD (Network Access Device). More...
struct	a_ipc_msg_modem_rusat_urc_notification_subscribe_req
	Subscribe to updates for modem_rusat_urc_notification. More...
struct	a_ipc_msg_modem_rusat_urc_notification_subscribe_rsp
	Sent in response to a_ipc_msg_modem_rusat_urc_notification_subscribe_req. More...
struct	a_ipc_msg_modem_rusat_urc_notification_unsubscribe_req_norsp
	Unsubscribe from updates for modem_rusat_urc_notification. More...

Enumerations
enum	a_ipc_enum_modem_rusat_result {   A_IPC_ENUM_MODEM_RUSAT_RESULT_OK , A_IPC_ENUM_MODEM_RUSAT_RESULT_ERROR , A_IPC_ENUM_MODEM_RUSAT_RESULT_ERROR_NAD_NOT_AVAILABLE , A_IPC_ENUM_MODEM_RUSAT_RESULT_ERROR_INVALID_COMMAND ,   A_IPC_ENUM_MODEM_RUSAT_RESULT_ERROR_FAILED_TO_SEND_AT_COMMAND }
	Result codes. More...

Functions
A_IPC_RESULT	a_ipc_init_modem_rusat_at_command_req (a_ipc_msg *msg, uint32_t command_maxlength)
	Initialize the message buffer to contain a_ipc_msg_modem_rusat_at_command_req. More...
A_IPC_RESULT	a_ipc_init_modem_rusat_at_command_rsp (a_ipc_msg *msg, uint32_t response_maxlength)
	Initialize the message buffer to contain a_ipc_msg_modem_rusat_at_command_rsp. More...
A_IPC_RESULT	a_ipc_init_modem_rusat_sstn_latest_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_modem_rusat_sstn_latest_req. More...
A_IPC_RESULT	a_ipc_init_modem_rusat_sstn_latest_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_modem_rusat_sstn_latest_rsp. More...
A_IPC_RESULT	a_ipc_init_modem_rusat_urc_notification_publish_ind (a_ipc_msg *msg, uint32_t urc_maxlength)
	Initialize the message buffer to contain a_ipc_msg_modem_rusat_urc_notification_publish_ind. More...
A_IPC_RESULT	a_ipc_init_modem_rusat_urc_notification_subscribe_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_modem_rusat_urc_notification_subscribe_req. More...
A_IPC_RESULT	a_ipc_init_modem_rusat_urc_notification_subscribe_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_modem_rusat_urc_notification_subscribe_rsp. More...
A_IPC_RESULT	a_ipc_init_modem_rusat_urc_notification_unsubscribe_req_norsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_modem_rusat_urc_notification_unsubscribe_req_norsp. More...

Detailed Description

Modem Service.

This page contains documentation of the Modem Service API.

---

Data Structure Documentation

a_ipc_dyn_array_enum_modem_rusat_result

struct a_ipc_dyn_array_enum_modem_rusat_result

Dynamic-length array of a_ipc_enum_modem_rusat_result.

Data Fields
uint32_t	length	Length of the array (number of elements)
a_ipc_enum_modem_rusat_result *	value	The contents of the array.

a_ipc_msg_modem_rusat_at_command_req

struct a_ipc_msg_modem_rusat_at_command_req

Request to send RUSAT AT command to NAD (Network Access Device).

Response is delivered in a_ipc_msg_modem_rusat_at_command_rsp.

Create using a_ipc_init_modem_rusat_at_command_req().

Message type is A_IPC_MSG_MODEM_RUSAT_AT_COMMAND_REQ.

Data Fields
a_ipc_dyn_string	command	AT command to send to modem, will only accept one of the following: AT commands below must always be terminated with. ... imply arbitrary trailing characters. AT^SSTA... AT^SSTGI... AT^SSTR... AT^SIND="simstatus",... AT^SIND="simdata",...
uint32_t	timeout	Operation timeout in milliseconds.

a_ipc_msg_modem_rusat_at_command_rsp

struct a_ipc_msg_modem_rusat_at_command_rsp

Sent in response to a_ipc_msg_modem_rusat_at_command_req.

Create using a_ipc_init_modem_rusat_at_command_rsp().

Message type is A_IPC_MSG_MODEM_RUSAT_AT_COMMAND_RSP.

Data Fields
a_ipc_dyn_string	response	Modem response to AT command (one line per response).
a_ipc_enum_modem_rusat_result	result	Operation result.
uint8_t	status	Operation status, if result is 'ERROR' and status is non zero then status is CME ERROR status. Otherwise zero.

a_ipc_msg_modem_rusat_sstn_latest_req

struct a_ipc_msg_modem_rusat_sstn_latest_req

Request latest known SSTN URC value.

Response is delivered in a_ipc_msg_modem_rusat_sstn_latest_rsp.

Create using a_ipc_init_modem_rusat_sstn_latest_req().

Message type is A_IPC_MSG_MODEM_RUSAT_SSTN_LATEST_REQ.

a_ipc_msg_modem_rusat_sstn_latest_rsp

struct a_ipc_msg_modem_rusat_sstn_latest_rsp

Sent in response to a_ipc_msg_modem_rusat_sstn_latest_req.

Create using a_ipc_init_modem_rusat_sstn_latest_rsp().

Message type is A_IPC_MSG_MODEM_RUSAT_SSTN_LATEST_RSP.

Data Fields
uint32_t	sstn	Last SSTN URC seen.

a_ipc_msg_modem_rusat_urc_notification_publish_ind

struct a_ipc_msg_modem_rusat_urc_notification_publish_ind

RUSAT related URC from NAD (Network Access Device).

Subscribe using a_ipc_msg_modem_rusat_urc_notification_subscribe_req and unsubscribe using a_ipc_msg_modem_rusat_urc_notification_unsubscribe_req_norsp.

Create using a_ipc_init_modem_rusat_urc_notification_publish_ind().

Message type is A_IPC_MSG_MODEM_RUSAT_URC_NOTIFICATION_PUBLISH_IND.

Data Fields
a_ipc_dyn_string	urc	URC string, can be one of the following: ... imply arbitrary trailing characters. ^SSTN:... +CIEV: simstatus... +CIEV: simdata...

a_ipc_msg_modem_rusat_urc_notification_subscribe_req

struct a_ipc_msg_modem_rusat_urc_notification_subscribe_req

Subscribe to updates for modem_rusat_urc_notification.

a_ipc_msg_modem_rusat_urc_notification_publish_ind will be received until a_ipc_msg_modem_rusat_urc_notification_unsubscribe_req_norsp is sent.

Response is delivered in a_ipc_msg_modem_rusat_urc_notification_subscribe_rsp.

Create using a_ipc_init_modem_rusat_urc_notification_subscribe_req().

Message type is A_IPC_MSG_MODEM_RUSAT_URC_NOTIFICATION_SUBSCRIBE_REQ.

a_ipc_msg_modem_rusat_urc_notification_subscribe_rsp

struct a_ipc_msg_modem_rusat_urc_notification_subscribe_rsp

Sent in response to a_ipc_msg_modem_rusat_urc_notification_subscribe_req.

Create using a_ipc_init_modem_rusat_urc_notification_subscribe_rsp().

Message type is A_IPC_MSG_MODEM_RUSAT_URC_NOTIFICATION_SUBSCRIBE_RSP.

Data Fields
a_ipc_enum_ipc_subscribe_result	result	The result of the subscription request.

a_ipc_msg_modem_rusat_urc_notification_unsubscribe_req_norsp

struct a_ipc_msg_modem_rusat_urc_notification_unsubscribe_req_norsp

Unsubscribe from updates for modem_rusat_urc_notification.

a_ipc_msg_modem_rusat_urc_notification_publish_ind will no longer be received.

Create using a_ipc_init_modem_rusat_urc_notification_unsubscribe_req_norsp().

Message type is A_IPC_MSG_MODEM_RUSAT_URC_NOTIFICATION_UNSUBSCRIBE_REQ_NORSP.

Enumeration Type Documentation

a_ipc_enum_modem_rusat_result

enum a_ipc_enum_modem_rusat_result

Result codes.

Enumerator
A_IPC_ENUM_MODEM_RUSAT_RESULT_OK	NAD response line (one of possibly several).
A_IPC_ENUM_MODEM_RUSAT_RESULT_ERROR	Any NAD reported error such as ERROR or CME ERROR etc.
A_IPC_ENUM_MODEM_RUSAT_RESULT_ERROR_NAD_NOT_AVAILABLE	Nad is not in a state to process RUSAT AT commands.
A_IPC_ENUM_MODEM_RUSAT_RESULT_ERROR_INVALID_COMMAND	Supplied RUSAT AT command is not qualified.
A_IPC_ENUM_MODEM_RUSAT_RESULT_ERROR_FAILED_TO_SEND_AT_COMMAND	Unspecific error when trying to send command to NAD.

Function Documentation

a_ipc_init_modem_rusat_at_command_req()

A_IPC_RESULT a_ipc_init_modem_rusat_at_command_req	(	a_ipc_msg *	msg,
		uint32_t	command_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_modem_rusat_at_command_req.

msg->info.type will be A_IPC_MSG_MODEM_RUSAT_AT_COMMAND_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize
command_maxlength	The maximum string length for command in the message.

a_ipc_init_modem_rusat_at_command_rsp()

A_IPC_RESULT a_ipc_init_modem_rusat_at_command_rsp	(	a_ipc_msg *	msg,
		uint32_t	response_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_modem_rusat_at_command_rsp.

msg->info.type will be A_IPC_MSG_MODEM_RUSAT_AT_COMMAND_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize
response_maxlength	The maximum string length for response in the message.

a_ipc_init_modem_rusat_sstn_latest_req()

A_IPC_RESULT a_ipc_init_modem_rusat_sstn_latest_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_modem_rusat_sstn_latest_req.

msg->info.type will be A_IPC_MSG_MODEM_RUSAT_SSTN_LATEST_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_modem_rusat_sstn_latest_rsp()

A_IPC_RESULT a_ipc_init_modem_rusat_sstn_latest_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_modem_rusat_sstn_latest_rsp.

msg->info.type will be A_IPC_MSG_MODEM_RUSAT_SSTN_LATEST_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_modem_rusat_urc_notification_publish_ind()

A_IPC_RESULT a_ipc_init_modem_rusat_urc_notification_publish_ind	(	a_ipc_msg *	msg,
		uint32_t	urc_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_modem_rusat_urc_notification_publish_ind.

msg->info.type will be A_IPC_MSG_MODEM_RUSAT_URC_NOTIFICATION_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize
urc_maxlength	The maximum string length for urc in the message.

a_ipc_init_modem_rusat_urc_notification_subscribe_req()

A_IPC_RESULT a_ipc_init_modem_rusat_urc_notification_subscribe_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_modem_rusat_urc_notification_subscribe_req.

msg->info.type will be A_IPC_MSG_MODEM_RUSAT_URC_NOTIFICATION_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_modem_rusat_urc_notification_subscribe_rsp()

A_IPC_RESULT a_ipc_init_modem_rusat_urc_notification_subscribe_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_modem_rusat_urc_notification_subscribe_rsp.

msg->info.type will be A_IPC_MSG_MODEM_RUSAT_URC_NOTIFICATION_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_modem_rusat_urc_notification_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_modem_rusat_urc_notification_unsubscribe_req_norsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_modem_rusat_urc_notification_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_MODEM_RUSAT_URC_NOTIFICATION_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

Variable Documentation

command

a_ipc_dyn_string a_ipc_msg_modem_rusat_at_command_req::command

AT command to send to modem, will only accept one of the following: AT commands below must always be terminated with.

... imply arbitrary trailing characters. AT^SSTA... AT^SSTGI... AT^SSTR... AT^SIND="simstatus",... AT^SIND="simdata",...

response

a_ipc_dyn_string a_ipc_msg_modem_rusat_at_command_rsp::response

Modem response to AT command (one line per response).

result [1/2]

a_ipc_enum_modem_rusat_result a_ipc_msg_modem_rusat_at_command_rsp::result

Operation result.

result [2/2]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_modem_rusat_urc_notification_subscribe_rsp::result

The result of the subscription request.

sstn

uint32_t a_ipc_msg_modem_rusat_sstn_latest_rsp::sstn

Last SSTN URC seen.

status

uint8_t a_ipc_msg_modem_rusat_at_command_rsp::status

Operation status, if result is 'ERROR' and status is non zero then status is CME ERROR status.

Otherwise zero.

timeout

uint32_t a_ipc_msg_modem_rusat_at_command_req::timeout

Operation timeout in milliseconds.

urc

a_ipc_dyn_string a_ipc_msg_modem_rusat_urc_notification_publish_ind::urc

URC string, can be one of the following: ...

imply arbitrary trailing characters. ^SSTN:... +CIEV: simstatus... +CIEV: simdata...