| blob | bf51365642c0a40c630874b9ae7346b28587f93a |
1
2 # dumper settings ============================================================
3 #
4 # Basic concepts
5 #
6 # - Character encoding of dumper ini files is UTF-8.
7 # - Whitespace characters are generally stripped, e.g. at start and end of
8 # lines, before/after equal signs, commas, etc.
9 # - Comments start with the hash (#) or semicolon (;) character. Leading
10 # whitespace characters are ignored.
11 #
12 # ----------------------------------------------------------------------------
14 # Enable entire dumper (default=off). This option does not affect the option
15 # 'enable-import'.
16 # 0=off, 1=on
19 # Enable import after dumping (default=on). Disabling this option allows
20 # to dump a file without loading it. This option is independent from the
21 # 'enable-dumper' option.
22 # 0=off, 1=on
25 # Maximum size of binary stream dumps (default=infinite).
28 # Maximum size of binary data blocks in content dumps (default=infinite).
31 # Shows unknown trailing data as binary dump (default=on).
32 # 0=off, 1=on
35 # Shows the absolute stream position of records in the record header field
36 # (default=on).
37 # 0=off, 1=on
40 # name lists =================================================================
41 #
42 # Syntax descriptions
43 #
44 # - Optional items are enclosed in brackets [].
45 # - Optional items that may be repeated are marked with an ellipsis (...).
46 # - Items in a set to choose from are separated by vertical lines (|).
47 # - <LISTNAME> denotes the name of a list. List names may consist of any non-
48 # whitespace characters.
49 # - <value>, <firstvalue>, <bitfield>, <bitmask> etc. denote integer values.
50 # Decimal and hexadecimal notation is supported, using C/C++ notation.
51 # - <bool> denotes a boolean value. Possible values are 0|1|false|true.
52 # - <constname> denotes a literal name for a constant or bit.
53 #
54 # ----------------------------------------------------------------------------
55 #
56 # constlist
57 #
58 # Defines names for a list of specific values.
59 #
60 # Syntax:
61 #
62 # constlist = <LISTNAME>
63 # default = <constname>
64 # include = <LISTNAME>[,<LISTNAME>...]
65 # exclude = <value>[,<value>...]
66 # quote-names = <bool>
67 # <value> = <constname>
68 # end
69 #
70 # - default (optional): Declares <constname> as a default name for values not
71 # specified in the name list. <constname> may be the empty string. If not
72 # set, the literal string '?err:no-name' (unquoted) is the default name.
73 # - include (optional): Includes the specified name list(s) into the own list.
74 # - exclude (optional): Removes values from the name lists, useful e.g. after
75 # a name list has been included.
76 # - quote-names (optional): Specifies whether to return the contained names
77 # enclosed in single quote (') characters. Default is false.
78 #
79 # The order of the declarations is important, later declarations may overwrite
80 # names generated from earlier declarations.
81 #
82 # Example:
83 #
84 # constlist = EXAMPLE-CONSTLIST
85 # 1 = my-value
86 # include = OTHER-LIST
87 # exclude = 2,3
88 # 0x0004 = other-value
89 # end
90 #
91 # - Defines the name 'my-value' for the constant 1.
92 # - Includes 'OTHER-LIST' which may overwrite the name of the constant 1.
93 # - Excludes the names of constants 2 and 3, which may have been included from
94 # the name list 'OTHER-LIST'.
95 # - Defines the name 'other-value' for the constant 4, which may overwrite the
96 # name of this constant included from the name list 'OTHER-LIST'.
97 #
98 # ----------------------------------------------------------------------------
99 #
100 # multilist
101 #
102 # Defines names for contiguous ranges of values.
103 #
104 # Syntax:
105 #
106 # multilist = <LISTNAME>
107 # default = <constname>
108 # include = <LISTNAME>[,<LISTNAME>...]
109 # exclude = <value>[,<value>...]
110 # ignore-empty = <bool>
111 # <firstvalue> = <constname>[,<constname>...]
112 # end
113 #
114 # - default (optional): See constlist above.
115 # - include (optional): See constlist above.
116 # - exclude (optional): See constlist above.
117 # - ignore-empty (optional): Specifies whether to skip empty names in a list.
118 # - True = skips an empty entry, the default name will be generated.
119 # - False = creates an empty string for the entry.
120 # Default is true (skip empty entries).
121 #
122 # Examples:
123 #
124 # multilist = EXAMPLE-MULTILIST
125 # 0 = value0,value1,,value3
126 # 8 = value8
127 # end
128 #
129 # - Defines the names 'value0' for the constant 0, 'value1' for the constant
130 # 1, 'value3' for the constant 3, and 'value8' for the constant 8.
131 #
132 # multilist = EXAMPLE-MULTILIST-2
133 # include = EXAMPLE-MULTILIST
134 # ignore-empty = false
135 # default = other
136 # end
137 #
138 # - Same as example above (includes EXAMPLE-MULTILIST), but defines the empty
139 # string for the constant 2. Other constants (less than 0 or greater than 3
140 # and not equal to 8) get the default name 'other'.
141 #
142 # ----------------------------------------------------------------------------
143 #
144 # shortlist
145 #
146 # Defines names for a contiguous range of values. The entire list definition
147 # is given in a single text line.
148 #
149 # Syntax:
150 #
151 # shortlist = <LISTNAME>,<firstvalue>,<constname>[,<constname>...]
152 #
153 # Uses default settings of the multi-list (i.e. skips empty entries).
154 #
155 # ----------------------------------------------------------------------------
156 #
157 # flagslist
158 #
159 # Defines names for single bits in a bit field.
160 #
161 # Syntax:
162 #
163 # flagslist = <LISTNAME>
164 # include = <LISTNAME>[,<LISTNAME>...]
165 # exclude = <bitfield>[,<bitfield>...]
166 # ignore = <bitfield>
167 # <bitmask> = <constname> | !<constname> | !<constname0>!<constname1>
168 # end
169 #
170 # - include (optional): See constlist above.
171 # - exclude (optional): See constlist above.
172 # - ignore (optional): Specifies bits to be ignored. Bits without an explicit
173 # name and not set in this declaration will be shown as unknown. Default is
174 # to not ignore a bit.
175 # - <bitmask>: The bit to be named. Must be a value with a single bit set.
176 # - <constname>: sets a name for the bit that will be shown if it is set.
177 # - !<constname>: sets a name for the bit that will be shown if it is cleared.
178 # - !<constname0>!<constname1>: sets a name for the cleared bit (constname0),
179 # and for the set bit (constname1).
180 #
181 # ----------------------------------------------------------------------------
182 #
183 # combilist
184 #
185 # Defines names for single bits and for embedded values in a bit field. This
186 # is an extension of the flagslist described above.
187 #
188 # Syntax:
189 #
190 # combilist = <LISTNAME>
191 # include = <LISTNAME>[,<LISTNAME>...]
192 # exclude = <bitmask>[,<bitmask>...]
193 # ignore = <bitfield>
194 # <bitmask> = <constname> | !<constname> | !<constname0>!<constname1>
195 # <bitfield> = <datatype>,<dataformat>,<bitfieldname>[,<LISTNAME>[,noshift]]
196 # end
197 #
198 # - include (optional): See constlist above.
199 # - exclude (optional): See constlist above.
200 # - ignore (optional): See flagslist above.
201 # - <bitmask>: See flagslist above.
202 # - <bitfield>: The mask of the embedded bitfield. Must be a value with
203 # exactly one sequence of at least 2 consecutive bits.
204 # - <datatype>: [u]int8 | [u]int16 | [u]int32 | [u]int64 | float | double
205 # - <dataformat>: dec | hex | shorthex | bin | fix | bool
206 # - <bitfieldname>: The name of the embedded bitfield.
207 # - <LISTAME>: Optional name list with names for the values of the embedded
208 # bitfield.
209 # - noshift: If set, the extracted value is not shifted to the right.
210 #
211 # ----------------------------------------------------------------------------
212 #
213 # unitconverter
214 #
215 # Converts values and appends a unit name.
216 #
217 # Syntax:
218 #
219 # unitconverter = <LISTNAME>,[/]<factor>[,<unitname>]
220 #
221 # ----------------------------------------------------------------------------
236 end
242 end
264 end
269 end
274 end
352 end
354 # ============================================================================