NEWS: Add list of user-visible changes so far.
[libsigrokdecode.git] / NEWS
1 0.4.1 (2016-12-27)
2 ------------------
3
4 Note: This release does NOT change the libsigrokdecode public C API. This
5 means existing libsigrokdecode frontends should not require any changes.
6 However, individual PDs and their output changed, which may require
7 some adaptations on the user's side in some cases.
8
9  * New supported protocol decoders:
10    - aud              Renesas/Hitachi Advanced User Debugger (AUD) protocol
11    - avr_pdi          Atmel proprietary interface for the ATxmega MCU
12    - dmx512           Professional lighting control protocol
13    - em4305           EM4205/EM4305 100-150kHz RFID protocol
14    - gpib             IEEE-488 GPIB / HPIB protocol
15    - ps2              PS/2 keyboard/mouse interface
16    - rgb_led_ws281x   RGB LED string protocol (WS281x)
17    - ssi32            Synchronous Serial Interface (32bit) protocol
18    - t55xx            T55xx 100-150kHz RFID protocol
19    - wiegand          Wiegand interface for electronic entry systems
20  * Introduce a decoders/common facility for code shared between PDs (bug #804).
21  * Supply metadata to all stacked decoders, not just low-level ones (bug #664).
22  * Various Doxygen/documentation improvements.
23  * Factor out a srd_decoder_apiver() internal helper function.
24  * srd_inst_decode(): Return SRD_ERR_ARG if unitsize is 0.
25  * Print error messages when decoders fail load time checks (bug #704).
26  * Fix multiple valgrind warnings (memory leaks and such).
27  * Build system: Sort PD list alphabetically in "make install".
28  * mdio:
29    - Replace PD with a new implementation that also supports Clause 22 and 45.
30    - Improve annotations slightly.
31  * xfp:
32    - Move various constants to common/plugtrx for reusability purposes.
33  * sdcard_{sd,spi}:
34    - Move various constants to common/sdcard for reusability purposes.
35  * usb_request:
36    - Drop hardcoded samplerate (workaround for the fixed bug #664).
37  * spiflash:
38    - Handle CS# transitions, allow variable-length transfers.
39    - Handle "Fast Read Dual I/O" commands.
40    - Add a "format" decoder option.
41    - Implement Release Power-down / Device ID (0xAB) command (bug #845).
42    - Remove hardcoded Macronix references.
43    - Add initial FIDELIX FM25Q32 metadata/support.
44    - Implement WRSR, RDSR2 commands.
45    - Various annotation improvements.
46  * timing:
47    - Add frequency and averaging support.
48  * midi:
49    - Decode note names and percussion names (e.g. 'G2', 'Tambourine').
50    - Decode instrument names and drum_kit names (e.g. 'GS Orchestra Kit').
51    - Handle Polyphonic Pressure / Aftertouch (message 0xAn).
52    - Handle Program Change (message 0xCn).
53    - Handle Channel Pressure / Aftertouch (message 0xDn).
54    - Handle Channel Mode (message 0xBn mm where mm is 120 through 127).
55    - Handle System Common messages (message 0xF1 through 0xF6), including
56      full time code decoding.
57    - SysEx decoding now decodes the 1-3 byte manufacturer field, payload
58      is now displayed as hex.
59    - 'undefined' fields now display the value (e.g. 'undefined 0xf4').
60    - Add 'MSB' and 'LSB' to many control_functions entries.
61    - Fix "trapped in state X" bug with handle_channel_msg_generic(),
62      though this might be dead code.
63    - Fix bug in sysex_manufacturer_ids; 1-byte manufacturers were not
64      tuples due to missing comma.
65    - Fix bug in SysEx state machine; 0xF7 now sent to handle_sysex_msg().
66    - Annotations: Provide multiple string versions (shorter and longer ones).
67    - chromatic_notes in list.py was off by 1 octave.
68    - Handle "Running Status" where status byte can be omitted.
69    - SysEx message can be terminated by status byte, not just EOX.
70    - Handle SysReal messages that interrupt in-progress message transmission.
71    - Identify and print garbage / truncated data.
72    - Add 2 new annotations: text-sysreal-verbose and text-error.
73  * usb_power_delivery:
74    - Drop problematic exception in us2samples() function (bug #758).
75  * uart:
76    - Fix a bug in the output for stacked PDs (when there's RX/TX overlap).
77    - Various output formatting improvements (e.g. for ASCII and octal).
78    - Skip frames with invalid start bits.
79    - Emit 2 bytes for 9-bit UART binary output (bug #708).
80    - Default to hex format datavalue annotations.
81  * spi:
82    - Fix binary output for wordsizes > 8 (bug #686).
83  * Various decoders:
84    - Fix some incorrect PD license metadata fields.
85    - Fix typos, whitespace issues and random other cosmetics in some PDs.
86    - Use consistent __init__() format across all PDs.
87    - Move some duplicated code snippets/lists to decoders/common.
88
89 0.4.0 (2016-01-29)
90 ------------------
91
92 Note: This release DOES change the libsigrokdecode public C API. This
93 means it is NOT backwards-compatible and frontends will need updates.
94
95  * New supported protocol decoders:
96    - adns5020       Bidirectional command and data over an SPI-like protocol
97    - am230x         Aosong AM230x/DHTxx/RHTxx humidity/temperature sensor
98    - arm_etmv3      Decode ETM instruction trace packets
99    - arm_itm        Trace data from Cortex-M / ARMv7m ITM module
100    - arm_tpiu       Filter TPIU formatted trace data into separate streams
101    - eeprom24xx     24xx series I²C EEPROM protocol
102    - em4100         EM4100 100-150kHz RFID protocol
103    - jitter         Retrieves the timing jitter between two digital signals
104    - max7219        8-digit LED display driver
105    - mdio           Half-duplex sync serial bus for MII management (MAC/PHY)
106    - modbus         Modbus RTU protocol for industrial applications
107    - mrf24j40       IEEE 802.15.4 2.4 GHz RF tranceiver chip
108    - nrf24l01       2.4GHz transceiver chip
109    - pwm            Analog level encoded in duty cycle percentage
110    - qi             Async serial protocol for Qi charger receivers
111    - rfm12          HopeRF RFM12 wireless transceiver control protocol
112    - sdcard_sd      Secure Digital card (SD mode) low-level protocol
113    - spdif          Serial bus for connecting digital audio devices
114    - stepper_motor  Absolute position and movement speed from step/dir
115    - swd            Two-wire protocol for debug access to ARM CPUs
116    - tca6408a       Texas Instruments TCA6408A 8-bit I²C I/O expander
117    - timing         Calculate time between edges
118    - usb_power_delivery USB Power Delivery protocol
119    - usb_request    USB (low-speed and full-speed) transaction/request protocol
120  * The 'mx25lxx05d' decoder was renamed to 'spiflash' and made more generic.
121  * arm_itm:
122    - Use objdump instead of addr2line (bug #564).
123  * can:
124    - Emit bit value annotations.
125    - Improve stuff bit annotation placement.
126  * ds1307:
127    - Emit per-bit annotations for registers.
128    - Add more annotation classes (and annotation rows).
129    - Handle register 0x07 (control register).
130    - Handle SRAM register accesses.
131    - Correctly handle address wrap-around.
132    - Warn about (and ignore) non-DS1307 traffic.
133  * edid:
134    - Handle more EDID structure sections.
135    - Add annotation rows.
136  * jitter:
137    - Avoid Unicode string literals (bug #569).
138  * jtag:
139    - Fix/enable OUT_PYTHON output.
140    - Add more annotations, fix a SHIFT-IR/-DR issue.
141  * jtag_stm32:
142    - Fix incorrect handling of registers.
143    - Decode more fields, improve IDCODE handling.
144    - Decode IDCODE contents as strings (not just hex values).
145  * midi:
146    - Fix two incorrect sample numbers.
147    - Update for a change (emit databyte/bits at the same time) in the uart PD.
148  * mrf24j40:
149    - Fix a register address typo.
150  * nunchuk:
151    - Fix inverted button press logic.
152  * pan1321:
153    - Update for a change (emit databyte/bits at the same time) in the uart PD.
154  * onewire_link:
155    - Fix a bug when the samplerate is too low for the PD (bug #357).
156  * parallel:
157    - Enforce that at least one pin must be provided.
158  * pwm:
159    - Avoid Unicode string literals (bug #569).
160  * spi:
161    - OUT_PYTHON docs: Fix order of MISO/MOSI data items.
162    - Tell stacked decoders about missing CS# signal.
163    - Add binary output facilities for MISO/MOSI (bug #424).
164    - Don't decode data lines if CS# isn't asserted (bug #559).
165    - Add a 'TRANSFER' output type.
166  * spiflash:
167    - Implement FAST READ command.
168    - Add a 'chip' option in preparation for supporting more devices.
169    - Fix incorrect 'inputs' field.
170  * tlc5620:
171    - Fix incorrect DAC selection decode, add more annotations.
172    - Only decode the last 11 bits, ignore the rest.
173    - Properly handle LOAD and LDAC based operations.
174    - Handle the case of less than 11 bits in a command.
175    - Add options for per-DAC Vref, show voltages.
176  * uart:
177    - Add signal inversion options 'invert_tx' and 'invert_rx'.
178    - Emit databyte and bits list at the same time to simplify stacked PDs.
179    - Improve sample positions at high data rates.
180    - Handle framing errors better.
181    - Performance-optimize handling of samples when TX and RX are both idle.
182  * usb_packet:
183    - Fix incorrect DATA*/MDATA handling (bug #623).
184    - Handle invalid packets more gracefully (bug #186).
185    - Calculate and check CRC5/CRC16.
186    - Handle errors from usb_signalling.
187    - Handle PREamble transmissions.
188  * usb_request:
189    - Handle transmission timeouts.
190    - Handle PREamble transmissions.
191  * usb_signalling:
192    - Track USB symbol width to compensate frequency errors.
193    - Detect bit stuffing errors.
194    - Handle symbol errors in EOP state.
195    - Use explicit positions for packet start/end (avoids glitches).
196    - Decode RESET and Keep-Alive signalling conditions.
197    - Add option to automatically set signalling speed.
198    - Fix SOP detection after an error condition.
199    - Add signalling states needed after LS PREamble PID.
200    - Detect PREamble PID.
201  * Drop the PD testing framework. It's in the 'sigrok-test' repository now
202    (and is not meant for "end users" or distro packages anyway; it's a pure
203    developer tool/system). This also fixes some PD test related build issues.
204  * Makefile.am: Use libtool's -no-undefined option (fixes MinGW shared build).
205  * Support loading decoders stored in ZIP files.
206  * Updated build requirements:
207    - libglib >= 2.28.0
208    - Drop obsolete (optional) dependencies: python3-coverage, libsigrok.
209  * README: Use clearer descriptions for the dependencies.
210  * Remove all references to the obsolete sigrok-commits mailing list.
211  * Fix incorrect doxygen comment for srd_decoder_list() function (bug #378).
212  * configure.ac:
213    - Fix a shell portability issue ("==" vs. "=").
214    - Use AM_CFLAGS instead of CFLAGS.
215    - Only link the 'check' library into the unit tests (not the lib).
216  * Unit tests:
217    - Fix out-of-tree build.
218  * libsigrokdecode.pc (pkg-config) file:
219    - Fix an issue related to the Python lib dependencies.
220    - Publish decodersdir variable.
221  * Add "-git-<hash>" suffix to development version numbers.
222  * Pass unitsize per sample chunk (bug #352).
223  * Modernize the whole autotools setup.
224  * Build with _POSIX_C_SOURCE=200112L per default.
225  * Build: Show CC and CFLAGS in configuration summary.
226  * Also look for decoders in XDG data directories.
227  * Restrict Python code to stable ABI subset (PEP 384).
228  * Fix various memory leaks.
229  * Fix an issue with PDs not being properly removed upon unload.
230  * Don't let Python override signal handlers (bug #461).
231  * configure: Also check for Python 3.5 (bug #739).
232
233 0.3.0 (2014-05-06)
234 ------------------
235
236 Note: This release DOES change the libsigrokdecode public C API. This
237 means it is NOT backwards-compatible and frontends will need updates.
238
239  * New supported protocol decoders:
240    - guess_bitrate  Guess the bitrate/baudrate of a signal
241    - ir_nec         NEC infrared remote control protocol
242    - ir_rc5         RC-5 infrared remote control protocol
243    - midi           Musical Instrument Digital Interface
244    - parallel       Parallel synchronous bus decoder
245    - rgb_led_spi    RGB LED string decoder (SPI)
246    - xfp            10 Gigabit Small Form Factor Pluggable Module
247    - z80            Zilog Z80 microprocessor disassembly
248  * Add support for annotation rows, i.e. groups of annotation classes that
249    are supposed to be displayed on the same GUI "row" together.
250  * Add support for the new OUTPUT_BINARY feature, which allows PDs to output
251    decoded data in various file formats (for loading and further processing
252    in other tools, or for direct live piping into other tools).
253  * Add support for the OUTPUT_META output type. This is used by PDs for
254    reporting various data points to the frontends, allowing them to perform
255    various post-processing and statistics tasks on them (e.g. simple counts,
256    average/mean values, min/max values, and so on).
257  * The OUTPUT_PROTO output type is now called OUTPUT_PYTHON.
258  * All protocol decoders:
259    - Bump the 'api_version' field of all decoders to 2. They are no longer
260      compatible (and cannot be used with) older libsigrokdecode versions.
261    - Updates to emit proper annotation classes, annotation sample numbers,
262      and annotation rows for GUI usage (bugs #146, #148, #150, #151, #154,
263      #155, #162, #147, #163, #168, #156, #309, and #344).
264    - Longer and shorter annotations are now supplied for GUI usage (frontends
265      can for example always show the longest annotation per zoom-level).
266    - Extensive protocol information has been moved from the PDs to the wiki.
267      Example: http://sigrok.org/wiki/Protocol_decoder:Uart
268    - Use correct I²C / I²S names in user-visible texts (not I2C/I2S).
269  * dcf77:
270    - Fix a bug in the handling of DCF77 bit 0.
271    - Drop handling of the 'PON' pin, this is not DCF77 related (bug #153).
272    - Fix the data parity check (bug #157).
273  * i2c:
274    - Fix corner case that can yield issues when using triggers on LAs.
275    - Drop unneeded 'addressing' option.
276    - Output bit-exact annotations and data for use by stacked PDs.
277  * i2s:
278    - Add OUTPUT_BINARY support for dumping the decoded data in WAV format.
279  * lpc:
280    - Various fixes to make the PD work better (or at all).
281    - Fix the handling of optional channels.
282    - Make the RESET# pin optional.
283  * onewire_link:
284    - Split 'reset' and 'presence' annotations.
285  * pan1321:
286    - Support the JSEC, JPRO, JAAC, and JSDA commands.
287    - Various internal fixes and improvements.
288  * parallel:
289    - Fix internal use of the obsolete 'metadata' parameter (bug #202).
290  * rtc8564:
291    - Properly handle register 0x06 (weekday) and the 'century' bit.
292  * sdcard_spi:
293    - Emit bit-exact annotations for the register fields that need them.
294    - Fix a Python issue with duplicate keys in a dict (bug #191).
295  * spi:
296    - Either MISO or MOSI can be optional now, but not both (bug #175).
297    - The CS# pin is optional now. If the pin is supplied, it is honored
298      (decoding only happens when the pin is asserted). Otherwise decoding will
299      use every CLK edge, regardless of CS# state or CS# existence (bug #152).
300    - Rename the 'SCK' pin to the more common 'CLK'.
301    - Output bit-exact annotations and data for use by stacked PDs.
302    - Fix a bug occurring when only MOSI (but not MISO) was supplied.
303  * transitioncounter:
304    - Drop the obsolete 'transitioncounter' dummy protocol decoder.
305  * uart:
306    - Fix corner case that can yield issues when using triggers on LAs.
307    - Use 'T' for stop bits and 'P' for parity bits (shortest annotations).
308    - Add a data format selection option.
309    - Annotations for RX and TX are now emitted in different annotation rows.
310    - Either the RX or TX signal can be optional now (but not both).
311    - Fix incorrectly displayed characters (bug #201).
312    - Add support for OUTPUT_BINARY output for RX, TX, or both.
313    - Output bit-exact annotations and data for use by stacked PDs.
314  * uart_dump:
315    - Drop the obsolete 'uart_dump' decoder (the feature is now included
316      in the 'uart' protocol decoder itself via OUTPUT_BINARY).
317  * usb_packet:
318    - The 'usb_protocol' decoder has been renamed to 'usb_packet'.
319    - Various bugfixes and decoding improvements.
320  * usb_signalling:
321    - Fix decoding of individual bits, sample in the middle of bits (bug #158).
322  * libsigrokdecode API changes overview:
323    - Add srd_session_new(), srd_session_destroy(), and a session context.
324    - Add srd_session_metadata_set().
325    - The name 'probe' has been renamed to 'channel' everywhere.
326    - The lib no longer defineѕ names with _t suffix (POSIX reserved).
327    - Drop the obsolete SRD_MAX_NUM_PROBES.
328    - Add the SRD_CONF_SAMPLERATE config key.
329    - Please see the Doxygen API documentation for further details.
330  * Protocol decoder API:
331    - Metadata is passed to PDs at runtime now (not at decoder start).
332      PDs now have a new optional metadata() method to receive it.
333    - Output types are now registered via Decoder.register(), not Decoder.add().
334    - The report() method is now obsolete. This kind of information will be
335      passed to the frontends via the OUTPUT_META output type, allowing the
336      frontends to perform various post-processing and statistics tasks.
337    - PDs can now define BINARY_OUTPUT types via the 'binary' tuple.
338    - PDs can now define annotation rows via the 'annotation_rows' tuple.
339    - PD options are now a tuple of dicts. Each option is a dict containing
340      the keys 'id', 'desc', 'def', and 'values'. Valid option types are
341      UTF-8 strings, integers, and floats (bugs #254, #306, #317, #165).
342    - Channels, optional channels, and annotations are now tuples (not lists).
343    - Only load PDs of API version 2, all other versions are incompatible.
344  * srd_inst_channel_set_all(): Report an error if not all channels required
345    by the respective protocol decoder have been supplied.
346  * Remove some internal limitations to max. 64 channels (bug #120).
347  * Add a unit test suite framework for libsigrokdecode ('make check').
348  * Add a protocol decoder test-suite framework for developers (tests/pdtest).
349  * Various bugfixes:
350    - srd_inst_option_set(): Properly return an error on exceptions.
351    - srd_inst_option_set(): Fix setting of instance options, caused by class
352      variable clobbering or releasing borrowed references (bugs #170, #174).
353    - srd_decoder_load(): Error out upon invalid module names (bug #176).
354    - srd_decoder_load(): Don't try to load an already loaded PD twice.
355    - srd_decoder_load_all(): Avoid issues without prior srd_init() (bug #178).
356    - srd_decoder_doc_get(): Fix an issue in the unit test suite (bug #179).
357    - srd_pd_output_callback_add(): Honor cb_data value (bug #143).
358    - Fix issues with PDs not getting the samplerate (bugs #97, #132, #166).
359    - Don't incorrectly decrease a borrowed reference (bug #177).
360    - Fix various memory leaks and segfault conditions.
361  * Build system:
362     - Use pkg-config (not python3-config) to check for Python libs.
363       This enables (better) libsigrokdecode cross-compile support.
364     - PDs no longer have an extra Makefile.am, and 'make install' now
365       happens via a Python script.
366     - configure: Clearly mark required and optional libs.
367     - Fix an issue with DESTDIR support (bug #215).
368     - Add the HACKING file to the tarball.
369  * Updated or new build-time and runtime requirements:
370    - Python >= 3.2 (required)
371    - check >= 0.9.4 (optional, only needed for the libsigrokdecode testsuite)
372    - libsigrok >= 0.3.0 (optional, only needed for the developer PD testsuite)
373    - python3-coverage (optional, only needed for the developer PD testsuite)
374  * New 'make install'-time requirement:
375    - Python >= 3.2 (required)
376
377 0.2.0 (2013-05-04)
378 ------------------
379
380 Note: This release DOES change the libsigrokdecode public C API. This
381 means it is NOT backwards-compatible and frontends will need updates.
382
383  * New supported protocol decoders:
384    - Dallas DS1307 RTC
385  * Library: Decoders now expose their options via the GSList *options field
386    in struct srd_decoder.
387  * API related changes:
388    - Various API documentation fixes.
389    - srd_decoder_list() now returns 'const GSList *' instead of 'GSList *'.
390    - Added new srd_strerror() and srd_strerror_name() API calls.
391  * Added support for optional probes for PDs.
392
393 0.1.1 (2013-01-27)
394 ------------------
395
396 Note: This release does NOT change the libsigrokdecode public C API. This
397 means existing libsigrokdecode frontends should not require any changes.
398 However, individual PDs and their output changed, which may require
399 some adaptations on the user's side in some cases.
400
401  * New supported protocol decoders:
402    - avr_isp              AVR In-System Programming
403    - can                  Controller Area Network
404    - jtag                 Joint Test Action Group (IEEE 1149.1)
405    - jtag_stm32           Joint Test Action Group / ST STM32
406    - lm75                 National LM75
407    - lpc                  Low-Pin-Count
408    - maxim_ds28ea00       Maxim DS28EA00 1-Wire digital thermometer
409    - onewire_link         1-Wire serial communication bus (link layer)
410    - onewire_network      1-Wire serial communication bus (network layer)
411    - sdcard_spi           Secure Digital card (SPI mode)
412    - tlc5620              Texas Instruments TLC5620
413    - uart_dump            UART dump
414  * i2cfilter: Now outputs 'i2c' packets instead of just data bytes, so
415    other PDs can stack on top of it. It filters by I2C slave address.
416  * edid: Now takes 'i2c' packets as input.
417  * pan1321:
418    - Various bugfixes to make the PD actually work.
419    - Now features 'Text (short)' and 'Text (verbose)' outputs.
420  * usb:
421    - The PD is split into 'usb_signalling' and 'usb_protocol' (stacked on top).
422    - Various bugfixes to make the PD work (better).
423    - The DP/DM probes were swapped, this is now fixed.
424    - Preliminary support for USB low-speed (in addition to full-speed).
425  * mlx90614: Minor bugfixes.
426  * dcf77:
427     - Major bugfix, this PD was not working correctly at all.
428     - Handle PON signal.
429  * nunchuk: Complete rewrite, works (better) now.
430  * spi: Update docs, send CS# change packets, change output API slightly.
431    If you have a PD which stacks on top of SPI, it'll need to be adapted.
432    The PDs that ship with libsigrokdecode are updated already.
433  * mx25lxx05d:
434    - Implement support for the READ, RDSR, and PP commands.
435    - Decode status register bits.
436    - Fix SE command handling.
437    - Fix inverted SRWD bit handling.
438  * Various smaller style and consistency changes in code and PD descriptions.
439  * Fix the build with Homebrew on Mac OS X.
440  * Performance improvements in some PDs.
441  * Documentation: Update website and git URLs.
442  * pkg-config file: Small fix to improve behaviour on Windows with cmake.
443  * All PD implementation files are now named 'pd.py' consistently.
444  * configure script:
445    - Also check for python3.3-config in addition to python-config and others.
446    - Add missing -fvisibility=hidden to default CFLAGS.
447    - Fix CFLAGS handling (configure.ac amends CFLAGS, doesn't overwrite now).
448  * The minimum required glib version is 2.24.0 now.
449  * We now ship a standard INSTALL file which documents the 'configure' options.
450
451 0.1.0 (2012-04-17)
452 ------------------
453
454  * Initial release.
455