greek64/rtps-fpga
2
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

BUG FIX: Decoder may not read last byte of payload

Browse Source 
The SKIP_PAYLOAD stage of decoders would not read the last word
(last_word_in = '1').
The <NAME>_MEMBER_END stage was removed from encoders/decoders, since it
could happen that the last aggregated member of a last collection entry
could also be the last type member overall, which would miss toggling
the "last_word_out" correctly. The logic was instead put inside the last
member stage (instead of defining a separate MEMEBR_END stage).
This commit is contained in:
John Ring 2022-02-03 15:05:10 +01:00
parent a26faff89a
commit b7fd9bfcfe
11 changed files with 131 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/IDL-VHDL_Ref.txt
View File

@ -145,12 +145,12 @@ AGGREGATED TYPES
STRUCTURE
---------
If a type member is in itself another structure, the generated <NAME> ports,signals,memories.stages,etc
If a type member is in itself another structure, the generated <NAME> ports,signals,memories,stages,etc
are split into <NAME>_<SUB-NAME> signals,ports,memories,stages,etc.
In case the element type of a collection type is an aggregated type, a new decode_stage called
<NAME>_MEMBER_END is generated, which handles the <NAME>_cnt increment and check which
normally be handled in the GET_<NAME> decode_stage. The <NAME>_ready and <NAME>_valid
In case the element type of a collection type is an aggregated type, the stage of the last memebr is
responsible for handling the <NAME>_cnt increment and check which normally be handled in the GET_<NAME>
decode_stage. The <NAME>_ready and <NAME>_valid
port signals are generated by ANDing the respective memory signals of all sub-elements.
UNION

2
src/TEMPLATE_reader_interface.vhd
View File

@ -267,7 +267,7 @@ begin
end if;
end if;
when SKIP_PAYLOAD =>
if (last_word_in_latch = '0' and last_word_in_dds = '0') then
if (last_word_in_latch = '0') then
-- Skip Read
ready_in_dds_sig <= '1';
else

2
src/Tests/Type1_reader_interface.vhd
View File

@ -265,7 +265,7 @@ begin
end if;
end if;
when SKIP_PAYLOAD =>
if (last_word_in_latch = '0' and last_word_in_dds = '0') then
if (last_word_in_latch = '0') then
-- Skip Read
ready_in_dds_sig <= '1';
else

59
src/Tests/Type2_key_holder.vhd
View File

@ -34,8 +34,8 @@ architecture TYPE2 of key_holder is
-- FSM states. Explained below in detail
type STAGE_TYPE is (IDLE,START_KEY_HASH_GENERATION,GET_PAYLOAD_HEADER,FETCH,ALIGN_IN_STREAM,SKIP_PAYLOAD,DECODE_PAYLOAD, WRITE_PAYLOAD_HEADER, PUSH,ALIGN_OUT_STREAM,ENCODE_PAYLOAD,GET_KEY_HASH,PUSH_KEY_HASH);
-- ###GENERATED START###
type DECODE_STAGE_TYPE is (GET_ID,GET_TESTSEQUENCE_LENGTH,GET_TESTSEQUENCE_TESTARRAY,GET_TESTSEQUENCE_TESTCHAR,GET_TESTSEQUENCE_TESTWCHAR,GET_TESTSEQUENCE_TESTLONGLONG,GET_TESTSEQUENCE_TESTLONGDOUBLE,TESTSEQUENCE_MEMBER_END,GET_OPTIONAL_HEADER);
type ENCODE_STAGE_TYPE is (WRITE_ID,WRITE_TESTSEQUENCE_LENGTH,WRITE_TESTSEQUENCE_TESTARRAY,TESTSEQUENCE_MEMBER_END);
type DECODE_STAGE_TYPE is (GET_ID,GET_TESTSEQUENCE_LENGTH,GET_TESTSEQUENCE_TESTARRAY,GET_TESTSEQUENCE_TESTCHAR,GET_TESTSEQUENCE_TESTWCHAR,GET_TESTSEQUENCE_TESTLONGLONG,GET_TESTSEQUENCE_TESTLONGDOUBLE,GET_OPTIONAL_HEADER);
type ENCODE_STAGE_TYPE is (WRITE_ID,WRITE_TESTSEQUENCE_LENGTH,WRITE_TESTSEQUENCE_TESTARRAY);
type TESTSEQUENCE_TESTARRAY_ADDR_TYPE is array (0 to TESTSEQUENCE_MAX_DEPTH-1) of std_logic_vector(TESTSEQUENCE_TESTARRAY_ADDR_WIDTH-1 downto 0);
type TESTSEQUENCE_TESTARRAY_DATA_TYPE is array (0 to TESTSEQUENCE_MAX_DEPTH-1) of std_logic_vector(CDR_OCTET_WIDTH-1 downto 0);
-- ###GENERATED END###
@ -367,7 +367,15 @@ begin
-- DES: The decoding stages are used for both PUSH_DATA and PUSH_SERIALIZED_KEY.
-- We us the latched opcode to differentiate between them.
if (opcode_latch = PUSH_SERIALIZED_KEY) then
decode_stage_next <= TESTSEQUENCE_MEMBER_END;
-- All Elements processed
if (TestSequence_cnt = TestSequence_len_latch-1) then
-- Next Member
stage_next <= SKIP_PAYLOAD;
else
TestSequence_cnt_next <= TestSequence_cnt + 1;
decode_stage_next <= GET_TESTSEQUENCE_TESTARRAY;
TestSequence_TestArray_cnt_next <= 0;
end if;
else
decode_stage_next <= GET_TESTSEQUENCE_TESTCHAR;
end if;
@ -440,7 +448,15 @@ begin
when GET_TESTSEQUENCE_TESTLONGDOUBLE =>
-- Optional Omitted
if (optional = '0') then
decode_stage_next <= TESTSEQUENCE_MEMBER_END;
-- All Elements processed
if (TestSequence_cnt = TestSequence_len_latch-1) then
-- Next Member
stage_next <= SKIP_PAYLOAD;
else
TestSequence_cnt_next <= TestSequence_cnt + 1;
decode_stage_next <= GET_TESTSEQUENCE_TESTARRAY;
TestSequence_TestArray_cnt_next <= 0;
end if;
-- ALIGN GUARD
elsif (not check_align(align_offset, ALIGN_8)) then
target_align_next <= ALIGN_8;
@ -466,13 +482,7 @@ begin
-- Push Quad Word
when 4 =>
align_offset_next <= align_offset + 16;
decode_stage_next <= TESTSEQUENCE_MEMBER_END;
when others =>
null;
end case;
end if;
-- DES: If the elements of an array/sequence are of a complex/nested type, the array/sequence iteration check is done in a seperate *_MEMBER_END stage.
when TESTSEQUENCE_MEMBER_END =>
-- All Elements processed
if (TestSequence_cnt = TestSequence_len_latch-1) then
-- Next Member
@ -482,6 +492,10 @@ begin
decode_stage_next <= GET_TESTSEQUENCE_TESTARRAY;
TestSequence_TestArray_cnt_next <= 0;
end if;
when others =>
null;
end case;
end if;
-- ###GENERATED END###
when GET_OPTIONAL_HEADER =>
-- ALIGN GUARD
@ -693,8 +707,17 @@ begin
-- All Elements processed
if (TestSequence_TestArray_cnt = TESTSEQUENCE_TESTARRAY_MAX_DEPTH-1) then
-- All Elements processed
if (TestSequence_cnt = unsigned(TestSequence_len_latch)-1) then
-- DONE
encode_stage_next <= TESTSEQUENCE_MEMBER_END;
stage_next <= PUSH;
finalize_payload_next <= '1';
else
TestSequence_cnt_next <= TestSequence_cnt + 1;
encode_stage_next <= WRITE_TESTSEQUENCE_TESTARRAY;
TestSequence_TestArray_cnt_next <= 0;
cnt_next <= 0;
end if;
else
TestSequence_TestArray_cnt_next <= TestSequence_TestArray_cnt + 1;
end if;
@ -708,18 +731,6 @@ begin
when others =>
end case;
end if;
when TESTSEQUENCE_MEMBER_END =>
-- All Elements processed
if (TestSequence_cnt = unsigned(TestSequence_len_latch)-1) then
-- DONE
stage_next <= PUSH;
finalize_payload_next <= '1';
else
TestSequence_cnt_next <= TestSequence_cnt + 1;
encode_stage_next <= WRITE_TESTSEQUENCE_TESTARRAY;
TestSequence_TestArray_cnt_next <= 0;
cnt_next <= 0;
end if;
-- ###GENERATED END###
end case;
when GET_KEY_HASH =>

55
src/Tests/Type2_reader_interface.vhd
View File

@ -132,7 +132,7 @@ architecture arch of Type2_reader_interface is
-- FSM states. Explained below in detail
type STAGE_TYPE is (IDLE,GET_PAYLOAD_HEADER,FETCH,ALIGN_STREAM,SKIP_PAYLOAD,DECODE_PAYLOAD);
-- ###GENERATED START###
type DECODE_STAGE_TYPE is (GET_ID,GET_TESTSEQUENCE_LENGTH,GET_TESTSEQUENCE_TESTARRAY,GET_TESTSEQUENCE_TESTCHAR,GET_TESTSEQUENCE_TESTWCHAR,GET_TESTSEQUENCE_TESTLONGLONG,GET_TESTSEQUENCE_TESTLONGDOUBLE,TESTSEQUENCE_MEMBER_END,GET_TESTMAP_LENGTH,GET_TESTMAP_KEY,GET_TESTMAP_VALUE,TESTMAP_MEMBER_END,GET_TESTENUM,GET_TESTUNION_D,GET_TESTUNION_LONGU,GET_TESTUNION_OCTETU,GET_TESTBITMASK,GET_TESTSTRING_LENGTH,GET_TESTSTRING,GET_OPTIONAL_HEADER);
type DECODE_STAGE_TYPE is (GET_ID,GET_TESTSEQUENCE_LENGTH,GET_TESTSEQUENCE_TESTARRAY,GET_TESTSEQUENCE_TESTCHAR,GET_TESTSEQUENCE_TESTWCHAR,GET_TESTSEQUENCE_TESTLONGLONG,GET_TESTSEQUENCE_TESTLONGDOUBLE,GET_TESTMAP_LENGTH,GET_TESTMAP_KEY,GET_TESTMAP_VALUE,GET_TESTENUM,GET_TESTUNION_D,GET_TESTUNION_LONGU,GET_TESTUNION_OCTETU,GET_TESTBITMASK,GET_TESTSTRING_LENGTH,GET_TESTSTRING,GET_OPTIONAL_HEADER);
type TESTSEQUENCE_TESTARRAY_ADDR_TYPE is array (0 to TESTSEQUENCE_MAX_DEPTH-1) of std_logic_vector(TESTSEQUENCE_TESTARRAY_ADDR_WIDTH-1 downto 0);
type TESTSEQUENCE_TESTARRAY_DATA_TYPE is array (0 to TESTSEQUENCE_MAX_DEPTH-1) of std_logic_vector(CDR_OCTET_WIDTH-1 downto 0);
-- ###GENERATED END###
@ -639,7 +639,7 @@ begin
end if;
end if;
when SKIP_PAYLOAD =>
if (last_word_in_latch = '0' and last_word_in_dds = '0') then
if (last_word_in_latch = '0') then
-- Skip Read
ready_in_dds_sig <= '1';
else
@ -774,12 +774,12 @@ begin
case (cnt) is
-- Double Word 1/2
when 0 =>
dw_latch_next(CDR_LONG_LONG_WIDTH-1 downto CDR_LONG_LONG_WIDTH/2) <= data_in_latch;
dw_latch_next <= write_sub_vector(dw_latch_next, data_in_latch, 0, TRUE);
stage_next <= FETCH;
cnt_next <= cnt + 1;
-- Double Word 2/2
when 1 =>
dw_latch_next((CDR_LONG_LONG_WIDTH/2)-1 downto 0) <= data_in_latch;
dw_latch_next <= write_sub_vector(dw_latch_next, data_in_latch, 1, TRUE);
stage_next <= FETCH;
cnt_next <= cnt + 1;
-- Push Double Word
@ -808,7 +808,15 @@ begin
TestSequence_TestLongDouble_mem_valid_in <= '1';
-- Memory Operation Guard
if (TestSequence_TestLongLong_mem_ready_in = '1') then
decode_stage_next <= TESTSEQUENCE_MEMBER_END;
-- All Elements processed
if (TestSequence_cnt = TestSequence_len_latch-1) then
-- Next Member
decode_stage_next <= GET_TESTMAP_LENGTH;
else
TestSequence_cnt_next <= TestSequence_cnt + 1;
decode_stage_next <= GET_TESTSEQUENCE_TESTARRAY;
TestSequence_TestArray_cnt_next <= 0;
end if;
end if;
-- ALIGN GUARD
elsif (not check_align(align_offset, ALIGN_8)) then
@ -818,22 +826,22 @@ begin
case (cnt) is
-- Quad Word 1/4
when 0 =>
qw_latch_next(CDR_LONG_DOUBLE_WIDTH-1 downto CDR_LONG_DOUBLE_WIDTH-WORD_WIDTH) <= data_in_latch;
qw_latch_next <= write_sub_vector(qw_latch_next, data_in_latch, 0, TRUE);
stage_next <= FETCH;
cnt_next <= cnt + 1;
-- Quad Word 2/4
when 1 =>
qw_latch_next(CDR_LONG_DOUBLE_WIDTH-WORD_WIDTH-1 downto CDR_LONG_DOUBLE_WIDTH-(2*WORD_WIDTH)) <= data_in_latch;
qw_latch_next <= write_sub_vector(qw_latch_next, data_in_latch, 1, TRUE);
stage_next <= FETCH;
cnt_next <= cnt + 1;
-- Quad Word 3/4
when 2 =>
qw_latch_next(CDR_LONG_DOUBLE_WIDTH-(2*WORD_WIDTH)-1 downto CDR_LONG_DOUBLE_WIDTH-(3*WORD_WIDTH)) <= data_in_latch;
qw_latch_next <= write_sub_vector(qw_latch_next, data_in_latch, 2, TRUE);
stage_next <= FETCH;
cnt_next <= cnt + 1;
-- Quad Word 4/4
when 3 =>
qw_latch_next(WORD_WIDTH-1 downto 0) <= data_in_latch;
qw_latch_next <= write_sub_vector(qw_latch_next, data_in_latch, 3, TRUE);
stage_next <= FETCH;
cnt_next <= cnt + 1;
-- Push Quad Word
@ -845,14 +853,7 @@ begin
-- Memory Operation Guard
if (TestSequence_TestLongLong_mem_ready_in = '1') then
align_offset_next <= align_offset + 16;
decode_stage_next <= TESTSEQUENCE_MEMBER_END;
end if;
when others =>
null;
end case;
end if;
-- DES: If the elements of an array/sequence are of a complex/nested type, the array/sequence iteration check is done in a seperate *_MEMBER_END stage.
when TESTSEQUENCE_MEMBER_END =>
-- All Elements processed
if (TestSequence_cnt = TestSequence_len_latch-1) then
-- Next Member
@ -862,6 +863,11 @@ begin
decode_stage_next <= GET_TESTSEQUENCE_TESTARRAY;
TestSequence_TestArray_cnt_next <= 0;
end if;
end if;
when others =>
null;
end case;
end if;
when GET_TESTMAP_LENGTH =>
-- ALIGN GUARD
if (not check_align(align_offset, ALIGN_4)) then
@ -920,15 +926,7 @@ begin
-- Memory Operation Guard
if (TestMap_value_mem_ready_in = '1') then
align_offset_next <= align_offset + 2;
decode_stage_next <= TESTMAP_MEMBER_END;
-- Need to fetch next Word
if(align_offset(1 downto 1) = "1") then
stage_next <= FETCH;
end if;
end if;
end if;
when TESTMAP_MEMBER_END =>
-- All Elements processed
if (TestMap_cnt = TestMap_len_latch-1) then
-- Next Member
@ -937,6 +935,13 @@ begin
TestMap_cnt_next <= TestMap_cnt + 1;
decode_stage_next <= GET_TESTMAP_KEY;
end if;
-- Need to fetch next Word
if(align_offset(1 downto 1) = "1") then
stage_next <= FETCH;
end if;
end if;
end if;
when GET_TESTENUM =>
-- ALIGN GUARD
if (not check_align(align_offset, ALIGN_1)) then

46
src/Tests/Type2_writer_interface.vhd
View File

@ -116,7 +116,7 @@ architecture arch of Type2_writer_interface is
-- FSM states. Explained below in detail
type STAGE_TYPE is (IDLE,WRITE_PAYLOAD_HEADER,PUSH,ALIGN_STREAM,ENCODE_PAYLOAD);
-- ###GENERATED START###
type ENCODE_STAGE_TYPE is (WRITE_ID,WRITE_TESTSEQUENCE_LENGTH,WRITE_TESTSEQUENCE_TESTARRAY,WRITE_TESTSEQUENCE_TESTCHAR,WRITE_TESTSEQUENCE_TESTWCHAR,WRITE_TESTSEQUENCE_TESTLONGLONG,WRITE_TESTSEQUENCE_TESTLONGDOUBLE,TESTSEQUENCE_MEMBER_END,WRITE_TESTMAP_LENGTH,WRITE_TESTMAP_KEY,WRITE_TESTMAP_VALUE,TESTMAP_MEMBER_END,WRITE_TESTENUM,WRITE_TESTUNION_D,WRITE_TESTUNION_LONGU,WRITE_TESTUNION_OCTETU,WRITE_TESTBITMASK,WRITE_TESTSTRING_LENGTH,WRITE_TESTSTRING);
type ENCODE_STAGE_TYPE is (WRITE_ID,WRITE_TESTSEQUENCE_LENGTH,WRITE_TESTSEQUENCE_TESTARRAY,WRITE_TESTSEQUENCE_TESTCHAR,WRITE_TESTSEQUENCE_TESTWCHAR,WRITE_TESTSEQUENCE_TESTLONGLONG,WRITE_TESTSEQUENCE_TESTLONGDOUBLE,WRITE_TESTMAP_LENGTH,WRITE_TESTMAP_KEY,WRITE_TESTMAP_VALUE,WRITE_TESTENUM,WRITE_TESTUNION_D,WRITE_TESTUNION_LONGU,WRITE_TESTUNION_OCTETU,WRITE_TESTBITMASK,WRITE_TESTSTRING_LENGTH,WRITE_TESTSTRING);
type TESTSEQUENCE_TESTARRAY_ADDR_TYPE is array (0 to TESTSEQUENCE_MAX_DEPTH-1) of std_logic_vector(TESTSEQUENCE_TESTARRAY_ADDR_WIDTH-1 downto 0);
type TESTSEQUENCE_TESTARRAY_DATA_TYPE is array (0 to TESTSEQUENCE_MAX_DEPTH-1) of std_logic_vector(CDR_OCTET_WIDTH-1 downto 0);
-- ###GENERATED END###
@ -785,7 +785,16 @@ begin
-- Member ID 4, Length 0
data_out_latch_next <= x"0004" & x"0000";
encode_stage_next <= TESTSEQUENCE_MEMBER_END;
-- All Elements processed
if (TestSequence_cnt = unsigned(TestSequence_len)-1) then
-- Next Member
encode_stage_next <= WRITE_TESTMAP_LENGTH;
else
TestSequence_cnt_next <= TestSequence_cnt + 1;
encode_stage_next <= WRITE_TESTSEQUENCE_TESTARRAY;
TestSequence_TestArray_cnt_next <= 0;
cnt_next <= 0;
end if;
-- "Comsume" input word
TestSequence_TestLongDouble_mem_ready_out <= '1';
end if;
@ -825,14 +834,7 @@ begin
data_out_latch_next <= get_sub_vector(endian_swap(LITTLE_ENDIAN, TestSequence_TestLongDouble_mem_data_out(CDR_LONG_DOUBLE_WIDTH-1 downto 0)), 3, WORD_WIDTH, TRUE);
stage_next <= PUSH;
align_offset_next <= align_offset + 16;
encode_stage_next <= TESTSEQUENCE_MEMBER_END;
cnt_next <= 0;
end if;
when others =>
end case;
end if;
-- DES: If the elements of an array/sequence are of a complex/nested type, the array/sequence iteration check is done in a seperate *_MEMBER_END stage.
when TESTSEQUENCE_MEMBER_END =>
-- All Elements processed
if (TestSequence_cnt = unsigned(TestSequence_len)-1) then
-- Next Member
@ -843,6 +845,10 @@ begin
TestSequence_TestArray_cnt_next <= 0;
cnt_next <= 0;
end if;
end if;
when others =>
end case;
end if;
when WRITE_TESTMAP_LENGTH =>
-- ALIGN GUARD
if (not check_align(align_offset, ALIGN_4)) then
@ -923,17 +929,6 @@ begin
data_out_latch_next <= write_sub_vector(data_out_latch, endian_swap(LITTLE_ENDIAN, TestMap_value_mem_data_out), to_integer(align_offset(1 downto 1)), TRUE);
align_offset_next <= align_offset + 2;
encode_stage_next <= TESTMAP_MEMBER_END;
-- Need to fetch next Word
if(align_offset(1 downto 1) = "1") then
stage_next <= PUSH;
end if;
end if;
when others =>
end case;
end if;
when TESTMAP_MEMBER_END =>
-- All Elements processed
if (TestMap_cnt = unsigned(TestMap_len)-1) then
-- Next Member
@ -943,6 +938,15 @@ begin
encode_stage_next <= WRITE_TESTMAP_KEY;
cnt_next <= 0;
end if;
-- Need to fetch next Word
if(align_offset(1 downto 1) = "1") then
stage_next <= PUSH;
end if;
end if;
when others =>
end case;
end if;
when WRITE_TESTENUM =>
-- ALIGN GUARD
if (not check_align(align_offset, ALIGN_1)) then

2
src/ros2/TEMPLATE_srv_client.vhd
View File

@ -463,7 +463,7 @@ begin
null;
end case;
when SKIP_PAYLOAD =>
if (last_word_in_latch = '0' and last_word_in_r = '0') then
if (last_word_in_latch = '0') then
-- Skip Read
ready_in_r_sig <= '1';
else

2
src/ros2/TEMPLATE_srv_server.vhd
View File

@ -458,7 +458,7 @@ begin
null;
end case;
when SKIP_PAYLOAD =>
if (last_word_in_latch = '0' and last_word_in_r = '0') then
if (last_word_in_latch = '0') then
-- Skip Read
ready_in_r_sig <= '1';
else

2
src/ros2/example_interfaces/AddTwoInts_srv_client.vhd
View File

@ -487,7 +487,7 @@ begin
null;
end case;
when SKIP_PAYLOAD =>
if (last_word_in_latch = '0' and last_word_in_r = '0') then
if (last_word_in_latch = '0') then
-- Skip Read
ready_in_r_sig <= '1';
else

2
src/ros2/example_interfaces/AddTwoInts_srv_server.vhd
View File

@ -512,7 +512,7 @@ begin
null;
end case;
when SKIP_PAYLOAD =>
if (last_word_in_latch = '0' and last_word_in_r = '0') then
if (last_word_in_latch = '0') then
-- Skip Read
ready_in_r_sig <= '1';
else

2
src/ros2/example_interfaces/Fibonacci_action_feedback_sub.vhd
View File

@ -510,7 +510,7 @@ begin
null;
end case;
when SKIP_PAYLOAD =>
if (last_word_in_latch = '0' and last_word_in_dds = '0') then
if (last_word_in_latch = '0') then
-- Skip Read
ready_in_dds_sig <= '1';
else