Skip to content

Commit 35684d9

Browse files
tokangasrlubos
tokangas
authored and
rlubos
committed
lib: lte_link_control: Improve Active-Time and periodic TAU reporting
Improved Active-Time and periodic TAU interval descriptions in the API. Improved periodic TAU interval parsing from AT%XMONITOR response. TAU is always reported either using T3412 extended or T3412 (legacy) timer by the network. If the TAU interval is missing, the API returns an error instead of -1, because periodic TAUs can not be disabled. Signed-off-by: Tommi Kangas <tommi.kangas@nordicsemi.no>
1 parent 60d137a commit 35684d9

File tree

6 files changed

+103
-39
lines changed

6 files changed

+103
-39
lines changed

‎include/modem/lte_lc.h

+3-4
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ struct lte_lc_psm_cfg {
329329
/** Periodic Tracking Area Update interval in seconds. */
330330
int tau;
331331

332-
/** Active-time (time from RRC idle to PSM) in seconds. */
332+
/** Active-time (time from RRC idle to PSM) in seconds or @c -1 if PSM is deactivated. */
333333
int active_time;
334334
};
335335

@@ -1466,10 +1466,9 @@ int lte_lc_psm_req(bool enable);
14661466
/**
14671467
* Get the current PSM (Power Saving Mode) configuration.
14681468
*
1469-
* @param[out] tau Periodic TAU interval in seconds. A non-negative integer,
1470-
* or @c -1 if timer is deactivated.
1469+
* @param[out] tau Periodic TAU interval in seconds. A non-negative integer.
14711470
* @param[out] active_time Active time in seconds. A non-negative integer,
1472-
* or @c -1 if timer is deactivated.
1471+
* or @c -1 if PSM is deactivated.
14731472
*
14741473
* @retval 0 if successful.
14751474
* @retval -EINVAL if input argument was invalid.

‎lib/lte_link_control/lte_lc.c

+4-2
Original file line numberDiff line numberDiff line change
@@ -876,7 +876,7 @@ int lte_lc_psm_get(int *tau, int *active_time)
876876
* <phys_cell_id>,<EARFCN>,<rsrp>,<snr>,<NW-provided_eDRX_value>,<Active-Time>,
877877
* <Periodic-TAUext>,<Periodic-TAU>]
878878
* We need to parse the three last parameters, Active-Time, Periodic-TAU-ext and
879-
* Periodic-TAU. N.B. Periodic-TAU will not be present on modem firmwares < 1.2.0.
879+
* Periodic-TAU.
880880
*/
881881

882882
response[0] = '\0';
@@ -928,10 +928,12 @@ int lte_lc_psm_get(int *tau, int *active_time)
928928
return -EBADMSG;
929929
}
930930

931-
/* It's ok not to have legacy Periodic-TAU, older FWs don't provide it. */
932931
comma_ptr = strchr(comma_ptr + 1, ch);
933932
if (comma_ptr) {
934933
strncpy(tau_legacy_str, comma_ptr + 2, 8);
934+
} else {
935+
LOG_ERR("AT command parsing failed");
936+
return -EBADMSG;
935937
}
936938

937939
err = parse_psm(active_time_str, tau_ext_str, tau_legacy_str, &psm_cfg);

‎lib/lte_link_control/lte_lc_helpers.c

+13-9
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,8 @@ int parse_psm(const char *active_time_str, const char *tau_ext_str,
584584
size_t lut_idx;
585585
uint32_t timer_unit, timer_value;
586586

587-
if ((strlen(active_time_str) != 8) || (strlen(tau_ext_str) != 8)) {
587+
if (strlen(active_time_str) != 8 || strlen(tau_ext_str) != 8 ||
588+
strlen(tau_legacy_str) != 8) {
588589
return -EINVAL;
589590
}
590591

@@ -601,11 +602,8 @@ int parse_psm(const char *active_time_str, const char *tau_ext_str,
601602
timer_value = strtoul(tau_ext_str + unit_str_len, NULL, 2);
602603
psm_cfg->tau = timer_unit ? timer_unit * timer_value : -1;
603604

604-
/* If T3412-extended is disabled, there's a chance that the network
605-
* only reports the T3412 (legacy) timer. We therefore need to check
606-
* that as well. The legacy timer is only reported by modem fw >= 1.2.0.
607-
*/
608-
if ((psm_cfg->tau == -1) && tau_legacy_str && (strlen(tau_legacy_str) == 8)) {
605+
/* If T3412-extended is disabled, periodic TAU is reported using the T3412 legacy timer */
606+
if (psm_cfg->tau == -1) {
609607
memcpy(unit_str, tau_legacy_str, unit_str_len);
610608

611609
lut_idx = strtoul(unit_str, NULL, 2);
@@ -615,8 +613,15 @@ int parse_psm(const char *active_time_str, const char *tau_ext_str,
615613
}
616614

617615
timer_unit = t3412_lookup[lut_idx];
616+
if (timer_unit == 0) {
617+
/* TAU must be reported either using T3412-extended or T3412 (legacy)
618+
* timer, so the timer unit is expected to be valid.
619+
*/
620+
LOG_ERR("Expected valid T3412 timer unit");
621+
return -EINVAL;
622+
}
618623
timer_value = strtoul(tau_legacy_str + unit_str_len, NULL, 2);
619-
psm_cfg->tau = timer_unit ? timer_unit * timer_value : -1;
624+
psm_cfg->tau = timer_unit * timer_value;
620625
}
621626

622627
/* Parse active time */
@@ -632,8 +637,7 @@ int parse_psm(const char *active_time_str, const char *tau_ext_str,
632637
timer_value = strtoul(active_time_str + unit_str_len, NULL, 2);
633638
psm_cfg->active_time = timer_unit ? timer_unit * timer_value : -1;
634639

635-
LOG_DBG("TAU: %d sec, active time: %d sec",
636-
psm_cfg->tau, psm_cfg->active_time);
640+
LOG_DBG("TAU: %d sec, active time: %d sec", psm_cfg->tau, psm_cfg->active_time);
637641

638642
return 0;
639643
}

‎lib/lte_link_control/lte_lc_helpers.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ int parse_edrx(const char *at_response, struct lte_lc_edrx_cfg *cfg);
196196
*
197197
* @param active_time_str Pointer to active time string.
198198
* @param tau_ext_str Pointer to TAU (T3412 extended) string.
199-
* @param tau_legacy_str Pointer to TAU (T3412) string. Can be NULL.
199+
* @param tau_legacy_str Pointer to TAU (T3412) string.
200200
* @param psm_cfg Pointer to PSM configuraion struct where the parsed values
201201
* are stored.
202202
*

‎tests/lib/lte_lc/src/main.c

+53-15
Original file line numberDiff line numberDiff line change
@@ -394,79 +394,117 @@ void test_parse_psm(void)
394394
char *tau_ext;
395395
char *tau_legacy;
396396
};
397-
struct psm_strings disabled = {
397+
struct psm_strings psm_disabled_tau_ext = {
398398
.active_time = "11100000",
399-
.tau_ext = "11100000",
399+
.tau_ext = "00001000",
400400
.tau_legacy = "11100000",
401401
};
402+
struct psm_strings psm_disabled_tau_legacy = {
403+
.active_time = "11100000",
404+
.tau_ext = "11100000",
405+
.tau_legacy = "01001010",
406+
};
402407
struct psm_strings tau_legacy = {
403408
.active_time = "00001000",
404409
.tau_ext = "11100000",
405410
.tau_legacy = "00101010",
406411
};
407-
struct psm_strings no_tau_legacy = {
412+
struct psm_strings invalid_no_tau = {
408413
.active_time = "00001000",
409414
.tau_ext = "11100000",
415+
.tau_legacy = "11100000",
410416
};
411417
struct psm_strings invalid_values = {
412418
.active_time = "0001111111",
413419
.tau_ext = "00001",
420+
.tau_legacy = "111",
414421
};
415422
struct psm_strings valid_values_0 = {
416423
.active_time = "01000001",
417424
.tau_ext = "01000010",
425+
.tau_legacy = "11100000",
418426
};
419427
struct psm_strings valid_values_1 = {
420428
.active_time = "00100100",
421429
.tau_ext = "00001000",
430+
.tau_legacy = "11100000",
422431
};
423432
struct psm_strings valid_values_2 = {
424433
.active_time = "00010000",
425434
.tau_ext = "10111011",
435+
.tau_legacy = "11100000",
426436
};
427437

428-
err = parse_psm(disabled.active_time, disabled.tau_ext, disabled.tau_legacy, &psm_cfg);
438+
err = parse_psm(psm_disabled_tau_ext.active_time,
439+
psm_disabled_tau_ext.tau_ext,
440+
psm_disabled_tau_ext.tau_legacy,
441+
&psm_cfg);
429442
TEST_ASSERT_EQUAL(0, err);
430-
TEST_ASSERT_EQUAL(-1, psm_cfg.tau);
443+
TEST_ASSERT_EQUAL(4800, psm_cfg.tau);
431444
TEST_ASSERT_EQUAL(-1, psm_cfg.active_time);
432445

433446
memset(&psm_cfg, 0, sizeof(psm_cfg));
434447

435-
err = parse_psm(tau_legacy.active_time, tau_legacy.tau_ext, tau_legacy.tau_legacy,
436-
&psm_cfg);
448+
err = parse_psm(psm_disabled_tau_legacy.active_time,
449+
psm_disabled_tau_legacy.tau_ext,
450+
psm_disabled_tau_legacy.tau_legacy,
451+
&psm_cfg);
437452
TEST_ASSERT_EQUAL(0, err);
438-
TEST_ASSERT_EQUAL(600, psm_cfg.tau);
439-
TEST_ASSERT_EQUAL(16, psm_cfg.active_time);
453+
TEST_ASSERT_EQUAL(3600, psm_cfg.tau);
454+
TEST_ASSERT_EQUAL(-1, psm_cfg.active_time);
440455

441456
memset(&psm_cfg, 0, sizeof(psm_cfg));
442457

443-
err = parse_psm(no_tau_legacy.active_time, no_tau_legacy.tau_ext, NULL, &psm_cfg);
458+
err = parse_psm(tau_legacy.active_time,
459+
tau_legacy.tau_ext,
460+
tau_legacy.tau_legacy,
461+
&psm_cfg);
444462
TEST_ASSERT_EQUAL(0, err);
445-
TEST_ASSERT_EQUAL(-1, psm_cfg.tau);
463+
TEST_ASSERT_EQUAL(600, psm_cfg.tau);
446464
TEST_ASSERT_EQUAL(16, psm_cfg.active_time);
447465

448466
memset(&psm_cfg, 0, sizeof(psm_cfg));
449467

450-
err = parse_psm(invalid_values.active_time, invalid_values.tau_ext, NULL, &psm_cfg);
468+
err = parse_psm(invalid_no_tau.active_time,
469+
invalid_no_tau.tau_ext,
470+
invalid_no_tau.tau_legacy,
471+
&psm_cfg);
472+
TEST_ASSERT_EQUAL(-EINVAL, err);
473+
474+
memset(&psm_cfg, 0, sizeof(psm_cfg));
475+
476+
err = parse_psm(invalid_values.active_time,
477+
invalid_values.tau_ext,
478+
invalid_values.tau_legacy,
479+
&psm_cfg);
451480
TEST_ASSERT_EQUAL(-EINVAL, err);
452481

453482
memset(&psm_cfg, 0, sizeof(psm_cfg));
454483

455-
err = parse_psm(valid_values_0.active_time, valid_values_0.tau_ext, NULL, &psm_cfg);
484+
err = parse_psm(valid_values_0.active_time,
485+
valid_values_0.tau_ext,
486+
valid_values_0.tau_legacy,
487+
&psm_cfg);
456488
TEST_ASSERT_EQUAL(0, err);
457489
TEST_ASSERT_EQUAL(72000, psm_cfg.tau);
458490
TEST_ASSERT_EQUAL(360, psm_cfg.active_time);
459491

460492
memset(&psm_cfg, 0, sizeof(psm_cfg));
461493

462-
err = parse_psm(valid_values_1.active_time, valid_values_1.tau_ext, NULL, &psm_cfg);
494+
err = parse_psm(valid_values_1.active_time,
495+
valid_values_1.tau_ext,
496+
valid_values_1.tau_legacy,
497+
&psm_cfg);
463498
TEST_ASSERT_EQUAL(0, err);
464499
TEST_ASSERT_EQUAL(4800, psm_cfg.tau);
465500
TEST_ASSERT_EQUAL(240, psm_cfg.active_time);
466501

467502
memset(&psm_cfg, 0, sizeof(psm_cfg));
468503

469-
err = parse_psm(valid_values_2.active_time, valid_values_2.tau_ext, NULL, &psm_cfg);
504+
err = parse_psm(valid_values_2.active_time,
505+
valid_values_2.tau_ext,
506+
valid_values_2.tau_legacy,
507+
&psm_cfg);
470508
TEST_ASSERT_EQUAL(0, err);
471509
TEST_ASSERT_EQUAL(1620, psm_cfg.tau);
472510
TEST_ASSERT_EQUAL(32, psm_cfg.active_time);

‎tests/lib/lte_lc_api/src/lte_lc_api_test.c

+29-8
Original file line numberDiff line numberDiff line change
@@ -720,6 +720,27 @@ void test_lte_lc_psm_param_set_seconds_enable_both_default(void)
720720
TEST_ASSERT_EQUAL(EXIT_SUCCESS, ret);
721721
}
722722

723+
void test_lte_lc_psm_get_badmsg(void)
724+
{
725+
int ret;
726+
int tau;
727+
int active_time;
728+
729+
/* Missing T3412 legacy timer value */
730+
static const char xmonitor_resp[] =
731+
"%XMONITOR: 1,\"Operator\",\"OP\",\"20065\",\"002F\",7,20,\"0012BEEF\","
732+
"334,6200,66,44,\"\","
733+
"\"00000101\",\"00010011\"";
734+
__cmock_nrf_modem_at_cmd_ExpectAndReturn(NULL, 0, "AT%%XMONITOR", 0);
735+
__cmock_nrf_modem_at_cmd_IgnoreArg_buf();
736+
__cmock_nrf_modem_at_cmd_IgnoreArg_len();
737+
__cmock_nrf_modem_at_cmd_ReturnArrayThruPtr_buf(
738+
(char *)xmonitor_resp, sizeof(xmonitor_resp));
739+
740+
ret = lte_lc_psm_get(&tau, &active_time);
741+
TEST_ASSERT_EQUAL(-EBADMSG, ret);
742+
}
743+
723744
void test_lte_lc_edrx_param_set_wrong_mode(void)
724745
{
725746
int ret;
@@ -1645,14 +1666,14 @@ void test_lte_lc_periodic_search_get_success(void)
16451666
__mock_nrf_modem_at_scanf_ReturnVarg_string("0,60,3600,,600"); /* pattern_buf */
16461667

16471668
ret = lte_lc_periodic_search_get(&cfg);
1648-
TEST_ASSERT_EQUAL(cfg.loop, 0);
1649-
TEST_ASSERT_EQUAL(cfg.return_to_pattern, 0);
1650-
TEST_ASSERT_EQUAL(cfg.band_optimization, 10);
1651-
TEST_ASSERT_EQUAL(cfg.patterns[0].type, LTE_LC_PERIODIC_SEARCH_PATTERN_RANGE);
1652-
TEST_ASSERT_EQUAL(cfg.patterns[0].range.initial_sleep, 60);
1653-
TEST_ASSERT_EQUAL(cfg.patterns[0].range.final_sleep, 3600);
1654-
TEST_ASSERT_EQUAL(cfg.patterns[0].range.time_to_final_sleep, -1);
1655-
TEST_ASSERT_EQUAL(cfg.patterns[0].range.pattern_end_point, 600);
1669+
TEST_ASSERT_EQUAL(0, cfg.loop);
1670+
TEST_ASSERT_EQUAL(0, cfg.return_to_pattern);
1671+
TEST_ASSERT_EQUAL(10, cfg.band_optimization);
1672+
TEST_ASSERT_EQUAL(LTE_LC_PERIODIC_SEARCH_PATTERN_RANGE, cfg.patterns[0].type);
1673+
TEST_ASSERT_EQUAL(60, cfg.patterns[0].range.initial_sleep);
1674+
TEST_ASSERT_EQUAL(3600, cfg.patterns[0].range.final_sleep);
1675+
TEST_ASSERT_EQUAL(-1, cfg.patterns[0].range.time_to_final_sleep);
1676+
TEST_ASSERT_EQUAL(600, cfg.patterns[0].range.pattern_end_point);
16561677
TEST_ASSERT_EQUAL(EXIT_SUCCESS, ret);
16571678
}
16581679

0 commit comments

Comments
 (0)