lte_api.h

Go to the documentation of this file.

/****************************************************************************
 * apps/include/lte/lte_api.h
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 ****************************************************************************/
 
#ifndef __APPS_INCLUDE_LTE_LTE_API_H
#define __APPS_INCLUDE_LTE_LTE_API_H
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <nuttx/config.h>
 
#include <stdbool.h>
#include <stdint.h>
#include <nuttx/wireless/lte/lte.h>
 
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/
 
int lte_initialize(void);
 
int lte_finalize(void);
 
int lte_set_report_restart(restart_report_cb_t restart_callback);
 
int lte_power_on(void);
 
int lte_power_off(void);
 
int lte_radio_on_sync(void);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_radio_on(radio_on_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_radio_off_sync(void);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_radio_off(radio_off_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_get_netinfo_sync(uint8_t pdn_num, FAR lte_netinfo_t *info);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_netinfo(get_netinfo_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_activate_pdn_sync(FAR lte_apn_setting_t *apn, FAR lte_pdn_t *pdn);
 
int lte_activate_pdn(FAR lte_apn_setting_t *apn, activate_pdn_cb_t callback);
 
int lte_activate_pdn_cancel(void);
 
int lte_deactivate_pdn_sync(uint8_t session_id);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_deactivate_pdn(uint8_t session_id, deactivate_pdn_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_data_allow_sync(uint8_t session_id, uint8_t allow,
                        uint8_t roaming_allow);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_data_allow(uint8_t session_id, uint8_t allow,
                   uint8_t roaming_allow, data_allow_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_get_imscap_sync(FAR bool *imscap);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_imscap(get_imscap_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_get_version_sync(FAR lte_version_t *version);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_version(get_ver_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
#ifdef CONFIG_LTE_LAPI_KEEP_COMPATIBILITY
int lte_get_phoneno_sync(FAR char *phoneno);
#else
int lte_get_phoneno_sync(FAR char *phoneno, size_t len);
#endif
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_phoneno(get_phoneno_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
#ifdef CONFIG_LTE_LAPI_KEEP_COMPATIBILITY
int lte_get_imsi_sync(FAR char *imsi);
#else
int lte_get_imsi_sync(FAR char *imsi, size_t len);
#endif
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_imsi(get_imsi_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
#ifdef CONFIG_LTE_LAPI_KEEP_COMPATIBILITY
int lte_get_imei_sync(FAR char *imei);
#else
int lte_get_imei_sync(FAR char *imei, size_t len);
#endif
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_imei(get_imei_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_get_pinset_sync(FAR lte_getpin_t *pinset);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_pinset(get_pinset_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_set_pinenable_sync(bool enable, FAR char *pincode,
                           FAR uint8_t *attemptsleft);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_set_pinenable(bool enable, FAR char *pincode,
                      set_pinenable_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_change_pin_sync(int8_t target_pin, FAR char *pincode,
                        FAR char *new_pincode, FAR uint8_t *attemptsleft);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_change_pin(int8_t target_pin, FAR char *pincode,
                   FAR char *new_pincode, change_pin_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_enter_pin_sync(FAR char *pincode, FAR char *new_pincode,
                       FAR uint8_t *simstat, FAR uint8_t *attemptsleft);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_enter_pin(FAR char *pincode, FAR char *new_pincode,
                  enter_pin_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_get_localtime_sync(FAR lte_localtime_t *localtime);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_localtime(get_localtime_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
#ifdef CONFIG_LTE_LAPI_KEEP_COMPATIBILITY
int lte_get_operator_sync(FAR char *oper);
#else
int lte_get_operator_sync(FAR char *oper, size_t len);
#endif
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_operator(get_operator_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_get_edrx_sync(FAR lte_edrx_setting_t *settings);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_edrx(get_edrx_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_set_edrx_sync(FAR lte_edrx_setting_t *settings);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_set_edrx(FAR lte_edrx_setting_t *settings, set_edrx_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_get_psm_sync(FAR lte_psm_setting_t *settings);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_psm(get_psm_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_set_psm_sync(FAR lte_psm_setting_t *settings);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_set_psm(FAR lte_psm_setting_t *settings, set_psm_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_get_ce_sync(FAR lte_ce_setting_t *settings);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_ce(get_ce_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_set_ce_sync(FAR lte_ce_setting_t *settings);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_set_ce(FAR lte_ce_setting_t *settings, set_ce_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_set_report_simstat(simstat_report_cb_t simstat_callback);
 
int lte_set_report_localtime(localtime_report_cb_t localtime_callback);
 
int lte_set_report_quality(quality_report_cb_t quality_callback,
                           uint32_t period);
 
int lte_set_report_cellinfo(cellinfo_report_cb_t cellinfo_callback,
                            uint32_t period);
 
int lte_set_report_netinfo(netinfo_report_cb_t netinfo_callback);
 
int lte_get_errinfo(FAR lte_errinfo_t *info);
 
int lte_get_siminfo_sync(uint32_t option, FAR lte_siminfo_t *siminfo);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_siminfo(uint32_t option, get_siminfo_cb_t callback);
 
int lte_get_dynamic_edrx_param(get_dynamic_edrx_param_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_get_current_edrx_sync(FAR lte_edrx_setting_t *settings);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_current_edrx(get_current_edrx_cb_t callback);
 
int lte_get_dynamic_psm_param(get_dynamic_psm_param_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_get_current_psm_sync(FAR lte_psm_setting_t *settings);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_current_psm(get_current_psm_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_get_quality_sync(FAR lte_quality_t *quality);
 
#ifdef CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API
 
int lte_get_quality(get_quality_cb_t callback);
 
#endif /* CONFIG_LTE_LAPI_ENABLE_DEPRECATED_API */
 
int lte_get_cellinfo_sync(FAR lte_cellinfo_t *cellinfo);
 
int lte_get_rat_sync(void);
 
int lte_set_rat_sync(uint8_t rat, bool persistent);
 
int lte_get_ratinfo_sync(FAR lte_ratinfo_t *info);
 
int lte_acquire_wakelock(void);
 
int lte_release_wakelock(void);
 
int lte_get_wakelock_count(void);
 
int lte_send_atcmd_sync(FAR const char *cmd, int cmdlen,
                        FAR char *respbuff, int respbufflen,
                        FAR int *resplen);
 
int lte_factory_reset_sync(void);
 
int lte_set_context_save_cb(context_save_cb_t callback);
 
int lte_hibernation_resume(FAR const uint8_t *res_ctx, int len);
 
#undef EXTERN
#ifdef __cplusplus
}
#endif
 
#endif /* __APPS_INCLUDE_LTE_LTE_API_H */