Skip to content

Commit 5e15d4a

Browse files
committed
6.9.1
1 parent 75d8a71 commit 5e15d4a

33 files changed

+918
-2217
lines changed

bin/qclean

-18.7 KB
Binary file not shown.

bin/qfsgen

-17.7 KB
Binary file not shown.

bin/qspy

-121 KB
Binary file not shown.

doxygen/Doxyfile

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Doxyfile 1.8.18
1+
# Doxyfile 1.8.20
22

33
#---------------------------------------------------------------------------
44
# Project related configuration options
55
#---------------------------------------------------------------------------
66
DOXYFILE_ENCODING = UTF-8
77
PROJECT_NAME = "QTools"
8-
PROJECT_NUMBER = "6.9.0"
8+
PROJECT_NUMBER = "6.9.1"
99
PROJECT_BRIEF =
1010
PROJECT_LOGO = images/header_logo_ql.png
1111
OUTPUT_DIRECTORY =
@@ -26,6 +26,7 @@ JAVADOC_AUTOBRIEF = YES
2626
JAVADOC_BANNER = NO
2727
QT_AUTOBRIEF = YES
2828
MULTILINE_CPP_IS_BRIEF = YES
29+
PYTHON_DOCSTRING = YES
2930
INHERIT_DOCS = YES
3031
SEPARATE_MEMBER_PAGES = NO
3132
TAB_SIZE = 4
@@ -58,6 +59,7 @@ INLINE_GROUPED_CLASSES = YES
5859
INLINE_SIMPLE_STRUCTS = YES
5960
TYPEDEF_HIDES_STRUCT = YES
6061
LOOKUP_CACHE_SIZE = 0
62+
NUM_PROC_THREADS = 1
6163
#---------------------------------------------------------------------------
6264
# Build related configuration options
6365
#---------------------------------------------------------------------------

doxygen/Doxyfile-CHM

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Doxyfile 1.8.18
1+
# Doxyfile 1.8.20
22

33
#---------------------------------------------------------------------------
44
# Project related configuration options
55
#---------------------------------------------------------------------------
66
DOXYFILE_ENCODING = UTF-8
77
PROJECT_NAME = "QTools"
8-
PROJECT_NUMBER = "6.9.0"
8+
PROJECT_NUMBER = "6.9.1"
99
PROJECT_BRIEF =
1010
PROJECT_LOGO = images/header_logo_ql.png
1111
OUTPUT_DIRECTORY =
@@ -22,10 +22,11 @@ FULL_PATH_NAMES = NO
2222
STRIP_FROM_PATH =
2323
STRIP_FROM_INC_PATH =
2424
SHORT_NAMES = NO
25-
JAVADOC_AUTOBRIEF = NO
25+
JAVADOC_AUTOBRIEF = YES
2626
JAVADOC_BANNER = NO
2727
QT_AUTOBRIEF = YES
2828
MULTILINE_CPP_IS_BRIEF = YES
29+
PYTHON_DOCSTRING = YES
2930
INHERIT_DOCS = YES
3031
SEPARATE_MEMBER_PAGES = NO
3132
TAB_SIZE = 4
@@ -38,7 +39,7 @@ ALIASES = "next{1}=<hr><b>Next:</b> @ref \1</p>" \
3839
"reqref{1}=@ref \1 \"\1\"" \
3940
"termdef{2}=@anchor term_\1 @par \2" \
4041
"termref{1}=@ref term_\1"
41-
OPTIMIZE_OUTPUT_FOR_C = YES
42+
OPTIMIZE_OUTPUT_FOR_C = NO
4243
OPTIMIZE_OUTPUT_JAVA = NO
4344
OPTIMIZE_FOR_FORTRAN = NO
4445
OPTIMIZE_OUTPUT_VHDL = NO
@@ -58,6 +59,7 @@ INLINE_GROUPED_CLASSES = YES
5859
INLINE_SIMPLE_STRUCTS = YES
5960
TYPEDEF_HIDES_STRUCT = YES
6061
LOOKUP_CACHE_SIZE = 0
62+
NUM_PROC_THREADS = 1
6163
#---------------------------------------------------------------------------
6264
# Build related configuration options
6365
#---------------------------------------------------------------------------
@@ -66,17 +68,17 @@ EXTRACT_PRIVATE = NO
6668
EXTRACT_PRIV_VIRTUAL = NO
6769
EXTRACT_PACKAGE = YES
6870
EXTRACT_STATIC = YES
69-
EXTRACT_LOCAL_CLASSES = YES
71+
EXTRACT_LOCAL_CLASSES = NO
7072
EXTRACT_LOCAL_METHODS = NO
7173
EXTRACT_ANON_NSPACES = NO
72-
HIDE_UNDOC_MEMBERS = NO
73-
HIDE_UNDOC_CLASSES = NO
74+
HIDE_UNDOC_MEMBERS = YES
75+
HIDE_UNDOC_CLASSES = YES
7476
HIDE_FRIEND_COMPOUNDS = NO
7577
HIDE_IN_BODY_DOCS = NO
7678
INTERNAL_DOCS = NO
7779
CASE_SENSE_NAMES = NO
7880
HIDE_SCOPE_NAMES = YES
79-
HIDE_COMPOUND_REFERENCE= NO
81+
HIDE_COMPOUND_REFERENCE= YES
8082
SHOW_INCLUDE_FILES = YES
8183
SHOW_GROUPED_MEMB_INC = NO
8284
FORCE_LOCAL_INCLUDES = NO

doxygen/history.dox

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,38 @@
11
/**
22
@page history Revision History
33

4+
5+
@section qtools_6_9_1 Version 6.9.1, 2020-09-28
6+
7+
The main purpose of this release is to adjust @ref qutest and @ref qview to the new @ref qs_local "QS Local Filter" design implemented in [QP/C](https://www.state-machine.com/qpc) and [QP/C++](https://www.state-machine.com/qpcpp) 6.9.1. Specifically, the loc_filter() and ao_filter() functions in @ref qutest_script "QUTest scripts" and in @ref qview_script "QView scripts" have been re-designed. Additionally, the @ref qview_loc "QView Local Filter menu" have been adjusted accordingly.
8+
9+
@note
10+
The change in the loc_filter() command has implications for the existing @ref qutest_script "QUTest scripts". Specifically, the parameters of loc_filter() are no longer object names but rather "QS-IDs" (see the documentation to loc_filter()).
11+
12+
__Changes in QSPY__
13+
14+
The @ref qspy "QSPY host application" has been updated to handle the redesigned local-filters and the new predefined #QS_QF_NEW_ATTEMPT trace record. Also the default version compatibility with the @ref qs "QS target-resident component" (the `-v` @ref qspy_command "command-line option") has been increased from 6.2 to 6.6.
15+
16+
Additionally, the QS_U64() and QS_I64() data elements have been made available for all types of CPUs, whereas previously they were available only on 64-bit CPUs (see also [feature#181](https://sourceforge.net/p/qpc/feature-requests/181)).
17+
18+
Additionally, QSPY now can format @ref qs_app "application-specific data elements" in hexadecimal. Here are a few examples of QS trace records in the Target and the generated QSPY output:
19+
20+
@code{c}
21+
QS_U8(QS_HEX_FMT, 0xABU); // --> 0xAB
22+
QS_U16(QS_HEX_FMT, 0xDEADU); // --> 0xDEAD
23+
QS_U32(QS_HEX_FMT, 0xDEADBEEFU); // --> 0xDEADBEEF
24+
QS_U64(QS_HEX_FMT, 0xDEADBEEF12345678LL); // --> 0xDEADBEEF12345678
25+
@endcode
26+
27+
28+
__Implemented Feature Requests__
29+
30+
- [feature#181 "use of QS_U64() on 32 bit machine"](https://sourceforge.net/p/qpc/feature-requests/181)
31+
32+
433
@section qtools_6_9_0 Version 6.9.0, 2020-08-21
534

6-
This release represents a major overhaul of QTools. Specifically, this release brings the new @ref qview component, which replaces QSpyView written originally in Tcl/Tk. The new @ref qview "QView" is written in **Python** (3.3.+) and brings much commonality with the @ref qutest, which has also been re-structured and improved.
35+
This release brings the new @ref qview component, which replaces QSpyView written originally in Tcl/Tk. The new @ref qview "QView" is written in **Python** (3.3.+) and brings much commonality with the @ref qutest, which has also been re-structured and improved.
736

837
@note
938
Starting with this version, both @ref qview and @ref qutest require **Python3** (3.3+) and are **no longer compatible** with Python2. The support for Tcl/Tk has been dropped entirely in QTools.
@@ -26,7 +55,7 @@ qtools/
2655
+---qview/ # <== new qview location
2756
+---qwin/
2857
+---Unity/
29-
@endcode
58+
@endcode
3059

3160
@note
3261
The changes in the QTools directory structure have impact on the QUTest testing, because the Makefiles (or any other build tools you might be using) need to be adjusted to the new location of the `qutest.py` script.
@@ -39,7 +68,7 @@ This new feature replaces the previous support for MscGen and is no longer relia
3968

4069
- QSPY now recognizes the new QS trace record #QS_QF_RUN
4170

42-
@note
71+
@note
4372
The #QS_QF_RUN record is now generated in @ref qutest "QUTest", which requires adjustments in the existing @ref qutest_script "test scripts". Specifically, the test scripts that provide their own on_reset() callback must now also call expect_run().
4473

4574

doxygen/images/qspy6.gif

370 Bytes
Loading

doxygen/images/qspy_app.gif

239 Bytes
Loading

doxygen/images/qview_loc_dlg.gif

12.7 KB
Loading

doxygen/qpspy.dox

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ The QS protocol transmits each trace record in an HDLC-like frame. The upper par
110110

111111
1. Each frame starts with the Frame **Sequence-No** byte. The target QS component increments the Frame Sequence Number for every frame inserted into the circular buffer. The Sequence Number naturally rolls-over from 255 to 0. The Frame Sequence Number allows the QSPY host component to detect any data discontinuities.
112112

113-
2. Following the Fame Sequence Number is the **Record-ID** byte, which is one of the predefined QS records, or an application-specific record.
113+
2. Following the Fame Sequence Number is the **Record-Type** byte, which is one of the predefined QS records, or an application-specific record.
114114

115-
3. Following the Record-ID is zero or more **Data** bytes.
115+
3. Following the Record-Type is zero or more **Data** bytes.
116116

117117
4. Following the data is the **Checksum**. The Checksum is computed over the Fame Sequence Number, the Record ID, and all the Data bytes. The next section gives the detailed Checksum computation formula.
118118

@@ -127,11 +127,11 @@ One of the most important characteristics of HDLC-type protocols is establishing
127127

128128
Of course, now the Escape byte itself must also be transparent to avoid interpreting an unintentional Escape byte as the two-byte escape sequence. The procedure of escaping the Escape byte is identical to that of escaping the Flag byte.
129129

130-
The transparency of the Flag and Escape bytes complicates slightly the computation of the Checksum. The transmitter computes the Checksum over the Fame Sequence Number, the Record-ID, and all Data bytes before performing any “byte-stuffing”. The receiver must apply the exact reversed procedure of performing the “byte-un-stuffing” before computing the Checksum.
130+
The transparency of the Flag and Escape bytes complicates slightly the computation of the Checksum. The transmitter computes the Checksum over the Fame Sequence Number, the Record-Type, and all Data bytes before performing any “byte-stuffing”. The receiver must apply the exact reversed procedure of performing the “byte-un-stuffing” before computing the Checksum.
131131

132132
An example may make this clearer. Suppose that the following trace record needs to be inserted to the trace buffer (the transparent bytes are shown in bold):
133133

134-
Record-ID = 0x7D, Record Data = 0x7D 0x08 0x01
134+
Record-Type = 0x7D, Record Data = 0x7D 0x08 0x01
135135

136136
Assuming that the current Fame Sequence Number is, say `0x7E`, the Checksum will be computed over the following bytes:
137137

@@ -141,7 +141,7 @@ and the actual frame inserted into the QS trace buffer will be as follows:
141141

142142
0x7D 0x5E 0x7D 0x5D 0x7D 0x5D 0x08 0x01 0x7D 0x5E 0x7E
143143

144-
Obviously, this is a degenerated example, where the Frame Sequence Number, the Record-ID, a Data byte, and the Checksum itself turned out to be the transparent bytes. Typical overhead of transparency with real trace data is one escape sequence per several trace records.
144+
Obviously, this is a degenerated example, where the Frame Sequence Number, the Record-Type, a Data byte, and the Checksum itself turned out to be the transparent bytes. Typical overhead of transparency with real trace data is one escape sequence per several trace records.
145145

146146

147147

0 commit comments

Comments
 (0)