Tolerate extra SYN bytes in preamble - #29
Open
brocci wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As reported in issue #28:
[BUG] A third SYN byte desyncs the preamble and drops the frame
PREAMBLE_2,PREAMBLE_3).PREAMBLE_3, any byte other than STX — including another 0xFF — resets toPREAMBLE_1. So the sequenceFF FF FF 02 ...is rejected: the third 0xFF falls to theelsebranch, and the following STX is then discarded inPREAMBLE_1. The spec specifies exactly two SYNs, so a strictly conforming host (JMRI) works, but SYN is explicitly a synchronization/idle character; hosts or converters that pad with extra 0xFF (or line idle reading as 0xFF after a break) make every frame invisible to this node. The v1.7.0 test suite's resync test (test/test_cmri/test_main.cpp:180-195) covers a lone 0xFF in garbage but not the triple-SYN case, so this remains untested upstream.PREAMBLE_3,if (c == 0xFF) stay in PREAMBLE_3;before the STX/else tests.This PR implements the required fix and adds corresponding tests.