Skip to content
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

GH-47: Add fail safe to tx queue #47

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

GH-47: Add fail safe to tx queue #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
853ef58
GH-47: Add fail safe to tx queue
silabs-borisl Sep 19, 2024
9745901
Update applications/zpc/components/zwave/zwave_tx/src/zwave_tx.cpp
silabs-borisl Sep 19, 2024
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
10 changes: 10 additions & 0 deletions applications/zpc/components/zwave/zwave_tx/src/zwave_tx.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,16 @@ sl_status_t

sl_log_error(LOG_TAG, "Tx Queue rejected new frame request.");
tx_queue.log(true);
// Add a failsafe in case the queue is getting blocked
// This prevent one faulty device to block the whole queue
// The subsequent frames will most likely discarded since they timed out by now
if (tx_queue.size() >= ZWAVE_TX_QUEUE_BUFFER_SIZE) {
sl_log_info(
LOG_TAG,
"Abort transmission of first frame in queue due to full Tx Queue.");
zwave_tx_process_abort_transmission(
tx_queue.first_in_queue()->zwave_tx_session_id);
}
return SL_STATUS_FAIL;
}

Expand Down
85 changes: 79 additions & 6 deletions applications/zpc/components/zwave/zwave_tx/test/zwave_tx_test.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2064,6 +2064,8 @@ void test_full_zwave_tx_queue()
&test_tx_session_id_2));
contiki_test_helper_run(0);



for (int i = 1; i < ZWAVE_TX_QUEUE_BUFFER_SIZE; ++i) {
TEST_ASSERT_EQUAL(SL_STATUS_OK,
zwave_tx_send_data(&test_connection_1,
Expand All @@ -2074,9 +2076,14 @@ void test_full_zwave_tx_queue()
(void *)&my_user_pointer,
&test_tx_session_id));
}
zwave_tx_session_id_t second_message_id = test_tx_session_id;

TEST_ASSERT_EQUAL(ZWAVE_TX_QUEUE_BUFFER_SIZE, zwave_tx_get_queue_size());

zwave_controller_transport_abort_send_data_ExpectAndReturn(
test_tx_session_id_2,
SL_STATUS_FAIL);

// Now there is no more queue space:
TEST_ASSERT_EQUAL(SL_STATUS_FAIL,
zwave_tx_send_data(&test_connection_1,
Expand All @@ -2087,14 +2094,11 @@ void test_full_zwave_tx_queue()
(void *)&my_user_pointer,
&test_tx_session_id));

// Get one free slot
on_zwave_transport_send_data_complete(TRANSMIT_COMPLETE_OK,
NULL,
test_tx_session_id_2);

// Process events
contiki_test_helper_run(0);
TEST_ASSERT_EQUAL(1, send_done_count);
TEST_ASSERT_EQUAL(TRANSMIT_COMPLETE_OK, send_done_status);
TEST_ASSERT_EQUAL(TRANSMIT_COMPLETE_FAIL, send_done_status);


// Now queueing should work again:
TEST_ASSERT_EQUAL(SL_STATUS_OK,
Expand All @@ -2106,6 +2110,9 @@ void test_full_zwave_tx_queue()
(void *)&my_user_pointer,
&test_tx_session_id));

zwave_controller_transport_abort_send_data_ExpectAndReturn(
second_message_id,
SL_STATUS_FAIL);
// And now we are full again:
TEST_ASSERT_EQUAL(SL_STATUS_FAIL,
zwave_tx_send_data(&test_connection_1,
Expand All @@ -2117,6 +2124,72 @@ void test_full_zwave_tx_queue()
&test_tx_session_id));
}

void test_full_zwave_tx_queue_with_timeouts()
{
// We do not care about interactions with the transports for this test.
zwave_controller_transport_send_data_IgnoreAndReturn(SL_STATUS_OK);

// Queue a first element:
TEST_ASSERT_EQUAL(SL_STATUS_OK,
zwave_tx_send_data(&test_connection_2,
sizeof(test_expected_frame_data_2),
test_expected_frame_data_2,
&test_tx_options_2,
send_data_callback,
(void *)&my_user_pointer,
&test_tx_session_id_2));
contiki_test_helper_run(0);



for (int i = 1; i < ZWAVE_TX_QUEUE_BUFFER_SIZE; ++i) {
TEST_ASSERT_EQUAL(SL_STATUS_OK,
zwave_tx_send_data(&test_connection_2,
sizeof(test_expected_frame_data_2),
test_expected_frame_data_2,
&test_tx_options_2,
send_data_callback,
(void *)&my_user_pointer,
&test_tx_session_id));
}
//zwave_tx_session_id_t second_message_id = test_tx_session_id;

TEST_ASSERT_EQUAL(ZWAVE_TX_QUEUE_BUFFER_SIZE, zwave_tx_get_queue_size());

zwave_controller_transport_abort_send_data_ExpectAndReturn(
test_tx_session_id_2,
SL_STATUS_FAIL);

// Now there is no more queue space:
TEST_ASSERT_EQUAL(SL_STATUS_FAIL,
zwave_tx_send_data(&test_connection_1,
sizeof(test_expected_frame_data_1),
test_expected_frame_data_1,
&test_tx_options_1,
send_data_callback,
(void *)&my_user_pointer,
&test_tx_session_id));

// Process events
contiki_test_helper_run(1000);
TEST_ASSERT_EQUAL(ZWAVE_TX_QUEUE_BUFFER_SIZE, send_done_count);
TEST_ASSERT_EQUAL(TRANSMIT_COMPLETE_FAIL, send_done_status);


// Now queueing should work again:
for (int i = 1; i < ZWAVE_TX_QUEUE_BUFFER_SIZE; ++i) {
TEST_ASSERT_EQUAL(SL_STATUS_OK,
zwave_tx_send_data(&test_connection_2,
sizeof(test_expected_frame_data_2),
test_expected_frame_data_2,
&test_tx_options_2,
send_data_callback,
(void *)&my_user_pointer,
&test_tx_session_id));
}
}


void test_additional_back_off()
{
zwave_node_id_t chatty_node_id = 23;
Expand Down