Embedded Wireless Framework
Functions
Modem adapter network service API

The modem network servicefunctions. More...

Functions

ewf_result ewf_adapter_modem_subscriber_number_read (ewf_adapter *adapter_ptr, char *alphax_str, uint32_t *alphax_buffer_len_ptr, char *numberx_str, uint32_t *numberx_len_ptr, uint32_t *typex_ptr, uint8_t *service_ptr)
 Read subscriber number (+cnum) More...
 
ewf_result ewf_adapter_modem_network_registration_urc_set (ewf_adapter *adapter_ptr, const char *n_str)
 Set Network Registration URC (+creg) More...
 
ewf_result ewf_adapter_modem_network_registration_read (ewf_adapter *adapter_ptr, ewf_adapter_modem_cmd_query_network_reg reg_cmd, uint32_t *n_ptr, ewf_adapter_modem_network_status *RegistrationStatus_ptr, ewf_adapter_modem_act *act_ptr, uint32_t *tac_ptr, uint32_t *ci_ptr, uint8_t *cause_type_ptr, uint8_t *reject_cause_ptr)
 Read Network Registration (+creg?, +cgreg?, +cereg?) More...
 
ewf_result ewf_adapter_modem_network_registration_check (ewf_adapter *adapter_ptr, ewf_adapter_modem_cmd_query_network_reg reg_cmd, uint32_t timeout)
 Check if modem is registered to network. More...
 
ewf_result ewf_adapter_modem_operator_select (ewf_adapter *adapter_ptr, ewf_adapter_modem_operator_sel_register_mode registration_mode, ewf_afapter_modem_operator_name_format operator_name_format, const char *operator_name_str, ewf_adapter_modem_act act)
 Operator selection (+cops) More...
 
ewf_result ewf_adapter_modem_operator_select_read (ewf_adapter *adapter_ptr, ewf_adapter_modem_operator_sel_register_mode *registration_mode_ptr, ewf_afapter_modem_operator_name_format *operator_name_format_ptr, char *operator_name_str, uint32_t *operator_name_len_ptr, ewf_adapter_modem_act *act_ptr)
 Read Operator selection (+cops?) More...
 
ewf_result ewf_adapter_modem_operator_list_edit (ewf_adapter *adapter_ptr, uint32_t index, ewf_afapter_modem_operator_name_format format, const char *operator_name_str, uint8_t gsm, uint8_t gsm_compact, uint8_t utran, uint8_t etran, uint8_t ngran)
 This function is used to edit the PLMN selector with Access Technology lists (+cpol) More...
 
ewf_result ewf_adapter_modem_operator_list_read (ewf_adapter *adapter_ptr, uint32_t *index_ptr, ewf_afapter_modem_operator_name_format *format_ptr, char *operator_name_str, uint32_t *operator_name_len_ptr, uint8_t *gsm_ptr, uint8_t *gsm_compact_ptr, uint8_t *utran_ptr, uint8_t *etran_ptr, uint8_t *ngran_ptr)
 Prefered PLMN list read (+cpol?) More...
 
ewf_result ewf_adapter_modem_operator_list_select (ewf_adapter *adapter_ptr, uint8_t list)
 Preferred PLMN selector with Access Technology list set (+cpls) More...
 
ewf_result ewf_adapter_modem_operator_option_list_read (ewf_adapter *adapter_ptr, uint8_t *list_ptr)
 Preferred PLMN with Access Technology list read (+cpls) More...
 
ewf_result ewf_adapter_modem_dynamic_parameters_read (ewf_adapter *adapter_ptr, ewf_adapter_modem_edrx_act *act_type_ptr, uint8_t *requested_edrx_ptr, uint8_t *nw_provided_edrx_ptr, uint8_t *paging_time_window_ptr)
 Read eDRX dynamic parameters (+cedrxrdp) More...
 
ewf_result ewf_adapter_modem_dynamic_parameters_set (ewf_adapter *adapter_ptr, uint8_t mode, ewf_adapter_modem_edrx_act act_type, uint8_t requested_edrx, uint8_t nw_provided_edrx, uint8_t paging_time_window)
 Set eDRX dynamic parameters (+cedrxs) More...
 
ewf_result ewf_adapter_modem_power_saving_mode_set (ewf_adapter *adapter_ptr, uint32_t mode, const char *periodic_rau_str, const char *gprs_ready_timer_str, const char *periodic_tau_str, const char *active_time_str)
 Set Power saving mode setting (+cpsms) More...
 
ewf_result ewf_adapter_modem_power_saving_mode_read (ewf_adapter *adapter_ptr, uint32_t *mode, char *periodic_rau_str, uint8_t *periodic_rau_len_ptr, char *gprs_Ready_timer_str, uint8_t *gprs_ready_timer_len_ptr, char *periodic_tau_str, uint8_t *periodic_tau_len_ptr, char *active_time_str, uint8_t *active_time_len_ptr)
 Read Power saving mode setting (+?) More...
 
ewf_result ewf_adapter_modem_signal_strength_read (ewf_adapter *adapter_ptr, int32_t *rssi_ptr, int32_t *ber_ptr)
 Read signal strength information (+csq) More...
 
ewf_result ewf_adapter_modem_signal_strength_extended_read (ewf_adapter *adapter_ptr, int32_t *rxlev_ptr, int32_t *ber_ptr, int32_t *rscp_ptr, int32_t *ecno_ptr, int32_t *rsrq_ptr, int32_t *rsrp_ptr)
 Read extended signal strength information (+cesq) More...
 
ewf_result ewf_adapter_modem_timezone_reporting_set (ewf_adapter *adapter_ptr, uint32_t reporting)
 Time zone reporting set (+ctzr) More...
 
ewf_result ewf_adapter_modem_timezone_reporting_read (ewf_adapter *adapter_ptr, uint32_t *reporting_ptr)
 Read Time zone reporting (+ctzr?) More...
 
ewf_result ewf_adapter_modem_timezone_autoupdate_set (ewf_adapter *adapter_ptr, uint32_t option)
 Automatic Time zone update set (+ctzu) More...
 
ewf_result ewf_adapter_modem_timezone_autoupdate_read (ewf_adapter *adapter_ptr, uint32_t *option_ptr)
 Read automatic Time zone update (+ctzu?) More...
 

Detailed Description

The modem network servicefunctions.

Function Documentation

◆ ewf_adapter_modem_dynamic_parameters_read()

ewf_result ewf_adapter_modem_dynamic_parameters_read ( ewf_adapter adapter_ptr,
ewf_adapter_modem_edrx_act *  act_type_ptr,
uint8_t *  requested_edrx_ptr,
uint8_t *  nw_provided_edrx_ptr,
uint8_t *  paging_time_window_ptr 
)

Read eDRX dynamic parameters (+cedrxrdp)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[out]act_type_typeAccess technology type
[out]requested_edrx_ptrRequested eDRX value
[out]nw_provided_edrx_ptrNetwork provided eDRX value
[out]paging_time_window_ptrPaging time window
Note
Refer Table Table 10.5.5.32/3GPP TS 24.008 for more details on the values for eDRX paramter values
Returns
ewf_result status code

◆ ewf_adapter_modem_dynamic_parameters_set()

ewf_result ewf_adapter_modem_dynamic_parameters_set ( ewf_adapter adapter_ptr,
uint8_t  mode,
ewf_adapter_modem_edrx_act  act_type,
uint8_t  requested_edrx,
uint8_t  nw_provided_edrx,
uint8_t  paging_time_window 
)

Set eDRX dynamic parameters (+cedrxs)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[in]act_typeAccess technology type
[in]requested_edrxRequested eDRX value
[in]nw_provided_edrxNetwork provided eDRX value
[in]paging_time_windowPaging time window
Note
Refer Table Table 10.5.5.32/3GPP TS 24.008 for more details on the values for eDRX paramter values
Returns
ewf_result status code

◆ ewf_adapter_modem_network_registration_check()

ewf_result ewf_adapter_modem_network_registration_check ( ewf_adapter adapter_ptr,
ewf_adapter_modem_cmd_query_network_reg  reg_cmd,
uint32_t  timeout 
)

Check if modem is registered to network.

Parameters
[in]adapter_ptrA pointer to the adapter structure
[in]reg_cmdInteger indicating the type of command to be queried
[in]timeouta integer indicating timeout in seconds
Returns
ewf_result status code

◆ ewf_adapter_modem_network_registration_read()

ewf_result ewf_adapter_modem_network_registration_read ( ewf_adapter adapter_ptr,
ewf_adapter_modem_cmd_query_network_reg  reg_cmd,
uint32_t *  n_ptr,
ewf_adapter_modem_network_status *  RegistrationStatus_ptr,
ewf_adapter_modem_act *  act_ptr,
uint32_t *  tac_ptr,
uint32_t *  ci_ptr,
uint8_t *  cause_type_ptr,
uint8_t *  reject_cause_ptr 
)

Read Network Registration (+creg?, +cgreg?, +cereg?)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[in]reg_cmdInteger indicating the type of command to be queried
[out]n_ptrPointer to integer value for network registration URC options
[out]cmnRegistrationStatus_ptrPointer circuit mode network registration status
[out]act_ptrAccess technology integer
[out]cause_type_ptrPointer to integer value for cause type for registration rejection
[out]tac_ptrPointer to integer value for tracking area code in hex format
[out]ci_ptrPointer to integer value for cell If in hex format
[out]reject_cause_ptrPointer to integer value for reject cause for registration
Returns
ewf_result status code

◆ ewf_adapter_modem_network_registration_urc_set()

ewf_result ewf_adapter_modem_network_registration_urc_set ( ewf_adapter adapter_ptr,
const char *  n_str 
)

Set Network Registration URC (+creg)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[in]n_strString indicating network registration URC options
Returns
ewf_result status code

◆ ewf_adapter_modem_operator_list_edit()

ewf_result ewf_adapter_modem_operator_list_edit ( ewf_adapter adapter_ptr,
uint32_t  index,
ewf_afapter_modem_operator_name_format  format,
const char *  operator_name_str,
uint8_t  gsm,
uint8_t  gsm_compact,
uint8_t  utran,
uint8_t  etran,
uint8_t  ngran 
)

This function is used to edit the PLMN selector with Access Technology lists (+cpol)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[in]indexthe index of operator in the SIM preferred operator list
[in]operator_name_formatInteger indicating operator name format
[in]operator_name_strPointer to string for operator name
[in]gsmGSM access technology option
[in]gsm_compactGSM compact access technology option
[in]utranUTRAN access technology option
[in]etranE-TRAN access technology option
[in]ngranNG-RAN access technology option
Returns
ewf_result status code

◆ ewf_adapter_modem_operator_list_read()

ewf_result ewf_adapter_modem_operator_list_read ( ewf_adapter adapter_ptr,
uint32_t *  index_ptr,
ewf_afapter_modem_operator_name_format *  format_ptr,
char *  operator_name_str,
uint32_t *  operator_name_len_ptr,
uint8_t *  gsm_ptr,
uint8_t *  gsm_compact_ptr,
uint8_t *  utran_ptr,
uint8_t *  etran_ptr,
uint8_t *  ngran_ptr 
)

Prefered PLMN list read (+cpol?)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[in,out]index_ptrthe index of operator in the SIM preferred operator list
[out]operator_name_format_ptrInteger indicating operator name format
[out]operator_name_strPointer to string for operator name
[out]operator_name_len_ptrLength of operator name
[out]gsm_ptrGSM access technology option
[out]gsm_compact_ptrGSM compact access technology option
[out]utran_ptrUTRAN access technology option
[out]etran_ptrE-TRAN access technology option
[out]ngran_ptrNG-RAN access technology option
Returns
ewf_result status code

◆ ewf_adapter_modem_operator_list_select()

ewf_result ewf_adapter_modem_operator_list_select ( ewf_adapter adapter_ptr,
uint8_t  list 
)

Preferred PLMN selector with Access Technology list set (+cpls)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[in]listInteger indicating list options (0: default, 1: opertor controlled, 2: HPLMN selector)
Returns
ewf_result status code

◆ ewf_adapter_modem_operator_option_list_read()

ewf_result ewf_adapter_modem_operator_option_list_read ( ewf_adapter adapter_ptr,
uint8_t *  list_ptr 
)

Preferred PLMN with Access Technology list read (+cpls)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[out]list_ptrPointer to integer indicating list options (0: default, 1: opertor controlled, 2: HPLMN selector)
Returns
ewf_result status code

◆ ewf_adapter_modem_operator_select()

ewf_result ewf_adapter_modem_operator_select ( ewf_adapter adapter_ptr,
ewf_adapter_modem_operator_sel_register_mode  registration_mode,
ewf_afapter_modem_operator_name_format  operator_name_format,
const char *  operator_name_str,
ewf_adapter_modem_act  act 
)

Operator selection (+cops)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[in]registration_modeInteger, registration mode
[in]operator_name_formatInteger indicating operator name format
[in]operator_name_strPointer to string for operator name
[in]actAccess technology
Returns
ewf_result status code

◆ ewf_adapter_modem_operator_select_read()

ewf_result ewf_adapter_modem_operator_select_read ( ewf_adapter adapter_ptr,
ewf_adapter_modem_operator_sel_register_mode *  registration_mode_ptr,
ewf_afapter_modem_operator_name_format *  operator_name_format_ptr,
char *  operator_name_str,
uint32_t *  operator_name_len_ptr,
ewf_adapter_modem_act *  act_ptr 
)

Read Operator selection (+cops?)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[out]registration_mode_ptrPointer to integer, operator select and registration mode
[out]operator_name_format_ptrPointer to integer indicating operator name format
[out]operator_name_ptrPointer to string for operator name
[out]operator_name_len_ptrPointer to length of operator name
[out]act_ptrAccess technology
Returns
ewf_result status code

◆ ewf_adapter_modem_power_saving_mode_read()

ewf_result ewf_adapter_modem_power_saving_mode_read ( ewf_adapter adapter_ptr,
uint32_t *  mode,
char *  periodic_rau_str,
uint8_t *  periodic_rau_len_ptr,
char *  gprs_Ready_timer_str,
uint8_t *  gprs_ready_timer_len_ptr,
char *  periodic_tau_str,
uint8_t *  periodic_tau_len_ptr,
char *  active_time_str,
uint8_t *  active_time_len_ptr 
)

Read Power saving mode setting (+?)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[out]mode_ptrInteger, Disable or enable the use of PSM in the UE
[out]periodic_rau_strString holding requested extended periodic RAU value (e.g. "01000111" equals 70 hours) For the coding and the value range, see the GPRS Timer 3 IE in 3GPP TS 24.008 [8] Table 10.5.163a/3GPP TS 24.008. See also 3GPP TS 23.682 [149] and 3GPP TS 23.060 [47]. The default value, if available, is manufacturer specific.
[out]periodic_rau_len_ptrLength of periodic-rau string
[out]gprs_Ready_timer_strString holding requested GPRS READY timer value (e.g. "01000011" equals 3 decihours or 18 minutes) For the coding and the value range, see the GPRS Timer IE in 3GPP TS 24.008 [8] Table 10.5.172/3GPP TS 24.008. See also 3GPP TS 23.060 [47]. The default value, if available, is manufacturer specific.
[out]gprs_ready_timer_len_ptrLength of gprs ready timer string
[out]periodic_tau_strString holding requested extended periodic TAU value (e.g. "00001010" equals to 100 minutes) For the coding and the value range, see the GPRS Timer 3 IE in 3GPP TS 24.008 [8] Table 10.5.163a/3GPP TS 24.008. See also 3GPP TS 23.682 [149] and 3GPP TS 23.401 [82]. The default value, if available, is manufacturer specific.
[out]periodic_tau_len_ptrLength of periodic-tau string
[out]active_time_strString holding requested active time value (e.g. "00001111" equals to 30 seconds) For the coding and the value range, see the GPRS Timer 2 IE in 3GPP TS 24.008 [8] Table 10.5.163/3GPP TS 24.008. See also 3GPP TS 23.682 [149], 3GPP TS 23.060 [47] and 3GPP TS 23.401 [82]. The default value, if available, is manufacturer specific.
[out]active_time_len_ptrLength of active time string
Returns
ewf_result status code

◆ ewf_adapter_modem_power_saving_mode_set()

ewf_result ewf_adapter_modem_power_saving_mode_set ( ewf_adapter adapter_ptr,
uint32_t  mode,
const char *  periodic_rau_str,
const char *  gprs_ready_timer_str,
const char *  periodic_tau_str,
const char *  active_time_str 
)

Set Power saving mode setting (+cpsms)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[in]modeInteger, Disable or enable the use of PSM in the UE
[in]periodic_rau_strString holding requested extended periodic RAU value (e.g. "01000111" equals 70 hours) For the coding and the value range, see the GPRS Timer 3 IE in 3GPP TS 24.008 [8] Table 10.5.163a/3GPP TS 24.008. See also 3GPP TS 23.682 [149] and 3GPP TS 23.060 [47]. The default value, if available, is manufacturer specific.
[in]gprs_ready_timer_strString holding requested GPRS READY timer value (e.g. "01000011" equals 3 decihours or 18 minutes) For the coding and the value range, see the GPRS Timer IE in 3GPP TS 24.008 [8] Table 10.5.172/3GPP TS 24.008. See also 3GPP TS 23.060 [47]. The default value, if available, is manufacturer specific.
[in]periodic_tau_strString holding requested extended periodic TAU value (e.g. "00001010" equals to 100 minutes) For the coding and the value range, see the GPRS Timer 3 IE in 3GPP TS 24.008 [8] Table 10.5.163a/3GPP TS 24.008. See also 3GPP TS 23.682 [149] and 3GPP TS 23.401 [82]. The default value, if available, is manufacturer specific.
[in]active_time_strString holding requested active time value (e.g. "00001111" equals to 30 seconds) For the coding and the value range, see the GPRS Timer 2 IE in 3GPP TS 24.008 [8] Table 10.5.163/3GPP TS 24.008. See also 3GPP TS 23.682 [149], 3GPP TS 23.060 [47] and 3GPP TS 23.401 [82]. The default value, if available, is manufacturer specific.
Returns
ewf_result status code

◆ ewf_adapter_modem_signal_strength_extended_read()

ewf_result ewf_adapter_modem_signal_strength_extended_read ( ewf_adapter adapter_ptr,
int32_t *  rxlev_ptr,
int32_t *  ber_ptr,
int32_t *  rscp_ptr,
int32_t *  ecno_ptr,
int32_t *  rsrq_ptr,
int32_t *  rsrp_ptr 
)

Read extended signal strength information (+cesq)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[out]rxlev_ptrRecieved signal strength lebel
[out]ber_ptrChannel bit error rate
[out]rscp_ptrRecieved signal code power
[out]ecno_ptrRatio of the received energy per PN chip to the total received power spectral density
[out]rsrq_ptrReference signal recieved quality
[out]rsrp_ptrReference signal recieved power
Returns
ewf_result status code

◆ ewf_adapter_modem_signal_strength_read()

ewf_result ewf_adapter_modem_signal_strength_read ( ewf_adapter adapter_ptr,
int32_t *  rssi_ptr,
int32_t *  ber_ptr 
)

Read signal strength information (+csq)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[out]rssi_ptrRecieved signal strength
[out]ber_ptrChannel bit error rate
Returns
ewf_result status code

◆ ewf_adapter_modem_subscriber_number_read()

ewf_result ewf_adapter_modem_subscriber_number_read ( ewf_adapter adapter_ptr,
char *  alphax_str,
uint32_t *  alphax_buffer_len_ptr,
char *  numberx_str,
uint32_t *  numberx_len_ptr,
uint32_t *  typex_ptr,
uint8_t *  service_ptr 
)

Read subscriber number (+cnum)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[out]alphax_strA pointer to a string assosciated with numberx
[out]alphax_buffer_len_ptrA pointer to lenght of the alphax string
[out]numberx_ptrA pointer to a string phone number
[out]numberx_len_ptrA pointer to lenght of the phone number
[out]typex_ptrA pointer to integer indicating type of address octet
[out]service_ptrA pointer to to integer indicating type service related to phone numbers
Returns
ewf_result status code

◆ ewf_adapter_modem_timezone_autoupdate_read()

ewf_result ewf_adapter_modem_timezone_autoupdate_read ( ewf_adapter adapter_ptr,
uint32_t *  option_ptr 
)

Read automatic Time zone update (+ctzu?)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[out]option_ptrEnable/disable indicator
Returns
ewf_result status code

◆ ewf_adapter_modem_timezone_autoupdate_set()

ewf_result ewf_adapter_modem_timezone_autoupdate_set ( ewf_adapter adapter_ptr,
uint32_t  option 
)

Automatic Time zone update set (+ctzu)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[in]optionEnable/disable indicator
Returns
ewf_result status code
Note
Some adapter modules will require reboot for this update to take effect. Refer module documents for more information

◆ ewf_adapter_modem_timezone_reporting_read()

ewf_result ewf_adapter_modem_timezone_reporting_read ( ewf_adapter adapter_ptr,
uint32_t *  reporting_ptr 
)

Read Time zone reporting (+ctzr?)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[out]reporting_ptrReporting status
Returns
ewf_result status code

◆ ewf_adapter_modem_timezone_reporting_set()

ewf_result ewf_adapter_modem_timezone_reporting_set ( ewf_adapter adapter_ptr,
uint32_t  reporting 
)

Time zone reporting set (+ctzr)

Parameters
[in]adapter_ptrA pointer to the adapter structure
[in]Reportingstatus
Returns
ewf_result status code TODO: +CTZV and +CTZE URC