Skip to content

lib: lte_link_control: Cleanup version notes for legacy MFWs #24887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

lib: lte_link_control: Cleanup version notes for legacy MFWs #24887

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 0 additions & 46 deletions include/modem/lte_lc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,11 +508,6 @@ struct lte_lc_cell {
* Timing advance measurement time in milliseconds, calculated from modem boot time.
*
* Range 0 - 18 446 744 073 709 551 614 ms.
*
* @note This is only supported by the following modem firmware:
* - mfw_nrf9160 >= v1.3.1
* - mfw_nrf91x1
* - mfw_nrf9151-ntn
*/
uint64_t timing_advance_meas_time;

Expand Down Expand Up @@ -1060,33 +1055,18 @@ enum lte_lc_neighbor_search_type {
* networks might be deployed, in other words, a light search. The search is limited to
* bands that are valid for the area of the current ITU-T region. If RPLMN is not found
* based on previous cell history, the modem accepts any found PLMN.
*
* @note This is only supported by the following modem firmware:
* - mfw_nrf9160 >= v1.3.1
* - mfw_nrf91x1
* - mfw_nrf9151-ntn
*/
LTE_LC_NEIGHBOR_SEARCH_TYPE_EXTENDED_LIGHT = 2,

/**
* The modem follows the same procedure as for
* @ref LTE_LC_NEIGHBOR_SEARCH_TYPE_EXTENDED_LIGHT, but will continue to perform a complete
* search instead of a light search, and the search is performed for all supported bands.
*
* @note This is only supported by the following modem firmware:
* - mfw_nrf9160 >= v1.3.1
* - mfw_nrf91x1
* - mfw_nrf9151-ntn
*/
LTE_LC_NEIGHBOR_SEARCH_TYPE_EXTENDED_COMPLETE = 3,

/**
* GCI search, option 1. Modem searches EARFCNs based on previous cell history.
*
* @note This is only supported by the following modem firmware:
* - mfw_nrf9160 >= v1.3.4
* - mfw_nrf91x1
* - mfw_nrf9151-ntn
*/
LTE_LC_NEIGHBOR_SEARCH_TYPE_GCI_DEFAULT = 4,

Expand All @@ -1095,23 +1075,13 @@ enum lte_lc_neighbor_search_type {
* @ref LTE_LC_NEIGHBOR_SEARCH_TYPE_GCI_DEFAULT. If less than gci_count cells were found,
* the modem performs a light search on bands that are valid for the area of the current
* ITU-T region.
*
* @note This is only supported by the following modem firmware:
* - mfw_nrf9160 >= v1.3.4
* - mfw_nrf91x1
* - mfw_nrf9151-ntn
*/
LTE_LC_NEIGHBOR_SEARCH_TYPE_GCI_EXTENDED_LIGHT = 5,

/**
* GCI search, option 3. Modem starts with the same search method as in
* @ref LTE_LC_NEIGHBOR_SEARCH_TYPE_GCI_DEFAULT. If less than gci_count cells were found,
* the modem performs a complete search on all supported bands.
*
* @note This is only supported by the following modem firmware:
* - mfw_nrf9160 >= v1.3.4
* - mfw_nrf91x1
* - mfw_nrf9151-ntn
*/
LTE_LC_NEIGHBOR_SEARCH_TYPE_GCI_EXTENDED_COMPLETE = 6,
};
Expand All @@ -1126,11 +1096,6 @@ struct lte_lc_ncellmeas_params {
*
* Current cell is counted as one cell. Mandatory with the GCI search types, ignored with
* other search types.
*
* @note This is only supported by the following modem firmware:
* - mfw_nrf9160 >= v1.3.4
* - mfw_nrf91x1
* - mfw_nrf9151-ntn
*/
uint8_t gci_count;
};
Expand Down Expand Up @@ -1865,12 +1830,6 @@ int lte_lc_lte_mode_get(enum lte_lc_lte_mode *mode);
* selection before calling this function. This can be determined from the
* @ref LTE_LC_EVT_MODEM_EVENT event with modem event @ref LTE_LC_MODEM_EVT_SEARCH_DONE.
*
* @note In @ref LTE_LC_FUNC_MODE_NORMAL and @ref LTE_LC_FUNC_MODE_ACTIVATE_LTE functional modes,
* this is only supported by the following modem firmware:
* - mfw_nrf9160 >= v1.3.0
* - mfw_nrf91x1
* - mfw_nrf9151-ntn
*
* @note In @ref LTE_LC_FUNC_MODE_RX_ONLY functional mode, this is only supported by the following
* modem firmware:
* - mfw_nrf91x1 >= v2.0.3
Expand Down Expand Up @@ -1981,11 +1940,6 @@ int lte_lc_env_eval_cancel(void);
* See @ref lte_lc_modem_evt for more information on which events may be received.
* An event handler must be registered to receive events.
*
* @note This is only supported by the following modem firmware:
* - mfw_nrf9160 >= v1.3.0
* - mfw_nrf91x1
* - mfw_nrf9151-ntn
*
* @retval 0 if successful.
* @retval -EFAULT if AT command failed.
*/
Expand Down