NEWS

   1 0.3.1 (2015-07-12)
   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 (backported from git):
  10
  11    - adns5020       Bidirectional command and data over an SPI-like protocol
  12    - am230x         Aosong AM230x/DHTxx/RHTxx humidity/temperature sensor
  13    - arm_etmv3      Decode ETM instruction trace packets
  14    - arm_itm        Trace data from Cortex-M / ARMv7m ITM module
  15    - arm_tpiu       Filter TPIU formatted trace data into separate streams
  16    - eeprom24xx     24xx series I²C EEPROM protocol
  17    - jitter         Retrieves the timing jitter between two digital signals
  18    - mdio           Half-duplex sync serial bus for MII management between MAC and PHY
  19    - mrf24j40       IEEE 802.15.4 2.4 GHz RF tranceiver chip
  20    - nrf24l01       2.4GHz transceiver chip
  21    - pwm            Analog level encoded in duty cycle percentage
  22    - rfm12          HopeRF RFM12 wireless transceiver control protocol
  23    - spdif          Serial bus for connecting digital audio devices
  24    - stepper_motor  Absolute position and movement speed from step/dir
  25    - swd            Two-wire protocol for debug access to ARM CPUs
  26    - tca6408a       Texas Instruments TCA6408A 8-bit I²C I/O expander
  27    - timing         Calculate time between edges
  28  * The 'mx25lxx05d' decoder was renamed to 'spiflash' and made more generic.
  29  * ds1307:
  30    - Emit per-bit annotations for registers.
  31    - Add more annotation classes (and annotation rows).
  32    - Handle register 0x07 (control register).
  33    - Handle SRAM register accesses.
  34    - Correctly handle address wrap-around.
  35    - Warn about (and ignore) non-DS1307 traffic.
  36  * edid:
  37    - Handle more EDID structure sections.
  38    - Add annotation rows.
  39  * midi:
  40    - Fix two incorrect sample numbers.
  41    - Update for a change (emit databyte/bits at the same time) in the uart PD.
  42  * pan1321:
  43    - Update for a change (emit databyte/bits at the same time) in the uart PD.
  44  * onewire_link:
  45    - Fix a bug when the samplerate is too low for the PD (bug #357).
  46  * parallel:
  47    - Enforce that at least one pin must be provided.
  48  * spi:
  49    - OUT_PYTHON docs: Fix order of MISO/MOSI data items.
  50    - Tell stacked decoders about missing CS# signal.
  51    - Add binary output facilities for MISO/MOSI (bug #424).
  52    - Don't decode data lines if CS# isn't asserted (bug #559).
  53  * spiflash:
  54    - Implement FAST READ command.
  55    - Add a 'chip' option in preparation for supporting more devices.
  56  * uart:
  57    - Add signal inversion options 'invert_tx' and 'invert_rx'.
  58    - Emit databyte and bits list at the same time to simplify stacked PDs.
  59    - Improve sample positions at high data rates.
  60  * Drop the PD testing framework. It's in the 'sigrok-test' repository now
  61    (and is not meant for "end users" or distro packages anyway; it's a pure
  62    developer tool/system). This also fixes some PD test related build issues.
  63  * Makefile.am: Use libtool's -no-undefined option (fixes MinGW shared build).
  64  * Support loading decoders stored in ZIP files.
  65  * README:
  66    - Drop obsolete (optional) dependencies: python3-coverage, libsigrok.
  67    - Use clearer descriptions for the dependencies.
  68  * Remove all references to the obsolete sigrok-commits mailing list.
  69  * Fix incorrect doxygen comment for srd_decoder_list() function (bug #378).
  70  * configure.ac:
  71    - Fix a shell portability issue ("==" vs. "=").
  72    - Use AM_CFLAGS instead of CFLAGS.
  73    - Only link the 'check' library into the unit tests (not the lib).
  74  * Unit tests:
  75    - Fix out-of-tree build.
  76  * libsigrokdecode.pc (pkg-config) file:
  77    - Fix an issue related to the Python lib dependencies.
  78
  79 0.3.0 (2014-05-06)
  80 ------------------
  81
  82 Note: This release DOES change the libsigrokdecode public C API. This
  83 means it is NOT backwards-compatible and frontends will need updates.
  84
  85  * New supported protocol decoders:
  86    - guess_bitrate  Guess the bitrate/baudrate of a signal
  87    - ir_nec         NEC infrared remote control protocol
  88    - ir_rc5         RC-5 infrared remote control protocol
  89    - midi           Musical Instrument Digital Interface
  90    - parallel       Parallel synchronous bus decoder
  91    - rgb_led_spi    RGB LED string decoder (SPI)
  92    - xfp            10 Gigabit Small Form Factor Pluggable Module
  93    - z80            Zilog Z80 microprocessor disassembly
  94  * Add support for annotation rows, i.e. groups of annotation classes that
  95    are supposed to be displayed on the same GUI "row" together.
  96  * Add support for the new OUTPUT_BINARY feature, which allows PDs to output
  97    decoded data in various file formats (for loading and further processing
  98    in other tools, or for direct live piping into other tools).
  99  * Add support for the OUTPUT_META output type. This is used by PDs for
 100    reporting various data points to the frontends, allowing them to perform
 101    various post-processing and statistics tasks on them (e.g. simple counts,
 102    average/mean values, min/max values, and so on).
 103  * The OUTPUT_PROTO output type is now called OUTPUT_PYTHON.
 104  * All protocol decoders:
 105    - Bump the 'api_version' field of all decoders to 2. They are no longer
 106      compatible (and cannot be used with) older libsigrokdecode versions.
 107    - Updates to emit proper annotation classes, annotation sample numbers,
 108      and annotation rows for GUI usage (bugs #146, #148, #150, #151, #154,
 109      #155, #162, #147, #163, #168, #156, #309, and #344).
 110    - Longer and shorter annotations are now supplied for GUI usage (frontends
 111      can for example always show the longest annotation per zoom-level).
 112    - Extensive protocol information has been moved from the PDs to the wiki.
 113      Example: http://sigrok.org/wiki/Protocol_decoder:Uart
 114    - Use correct I²C / I²S names in user-visible texts (not I2C/I2S).
 115  * dcf77:
 116    - Fix a bug in the handling of DCF77 bit 0.
 117    - Drop handling of the 'PON' pin, this is not DCF77 related (bug #153).
 118    - Fix the data parity check (bug #157).
 119  * i2c:
 120    - Fix corner case that can yield issues when using triggers on LAs.
 121    - Drop unneeded 'addressing' option.
 122    - Output bit-exact annotations and data for use by stacked PDs.
 123  * i2s:
 124    - Add OUTPUT_BINARY support for dumping the decoded data in WAV format.
 125  * lpc:
 126    - Various fixes to make the PD work better (or at all).
 127    - Fix the handling of optional channels.
 128    - Make the RESET# pin optional.
 129  * onewire_link:
 130    - Split 'reset' and 'presence' annotations.
 131  * pan1321:
 132    - Support the JSEC, JPRO, JAAC, and JSDA commands.
 133    - Various internal fixes and improvements.
 134  * parallel:
 135    - Fix internal use of the obsolete 'metadata' parameter (bug #202).
 136  * rtc8564:
 137    - Properly handle register 0x06 (weekday) and the 'century' bit.
 138  * sdcard_spi:
 139    - Emit bit-exact annotations for the register fields that need them.
 140    - Fix a Python issue with duplicate keys in a dict (bug #191).
 141  * spi:
 142    - Either MISO or MOSI can be optional now, but not both (bug #175).
 143    - The CS# pin is optional now. If the pin is supplied, it is honored
 144      (decoding only happens when the pin is asserted). Otherwise decoding will
 145      use every CLK edge, regardless of CS# state or CS# existance (bug #152).
 146    - Rename the 'SCK' pin to the more common 'CLK'.
 147    - Output bit-exact annotations and data for use by stacked PDs.
 148    - Fix a bug occuring when only MOSI (but not MISO) was supplied.
 149  * transitioncounter:
 150    - Drop the obsolete 'transitioncounter' dummy protocol decoder.
 151  * uart:
 152    - Fix corner case that can yield issues when using triggers on LAs.
 153    - Use 'T' for stop bits and 'P' for parity bits (shortest annotations).
 154    - Add a data format selection option.
 155    - Annotations for RX and TX are now emitted in different annotation rows.
 156    - Either the RX or TX signal can be optional now (but not both).
 157    - Fix incorrectly displayed characters (bug #201).
 158    - Add support for OUTPUT_BINARY output for RX, TX, or both.
 159    - Output bit-exact annotations and data for use by stacked PDs.
 160  * uart_dump:
 161    - Drop the obsolete 'uart_dump' decoder (the feature is now included
 162      in the 'uart' protocol decoder itself via OUTPUT_BINARY).
 163  * usb_packet:
 164    - The 'usb_protocol' decoder has been renamed to 'usb_packet'.
 165    - Various bugfixes and decoding improvements.
 166  * usb_signalling:
 167    - Fix decoding of individual bits, sample in the middle of bits (bug #158).
 168  * libsigrokdecode API changes overview:
 169    - Add srd_session_new(), srd_session_destroy(), and a session context.
 170    - Add srd_session_metadata_set().
 171    - The name 'probe' has been renamed to 'channel' everywhere.
 172    - The lib no longer defineѕ names with _t suffix (POSIX reserved).
 173    - Drop the obsolete SRD_MAX_NUM_PROBES.
 174    - Add the SRD_CONF_SAMPLERATE config key.
 175    - Please see the Doxygen API documentation for further details.
 176  * Protocol decoder API:
 177    - Metadata is passed to PDs at runtime now (not at decoder start).
 178      PDs now have a new optional metadata() method to receive it.
 179    - Output types are now registered via Decoder.register(), not Decoder.add().
 180    - The report() method is now obsolete. This kind of information will be
 181      passed to the frontends via the OUTPUT_META output type, allowing the
 182      frontends to perform various post-processing and statistics tasks.
 183    - PDs can now define BINARY_OUTPUT types via the 'binary' tuple.
 184    - PDs can now define annotation rows via the 'annotation_rows' tuple.
 185    - PD options are now a tuple of dicts. Each option is a dict containing
 186      the keys 'id', 'desc', 'def', and 'values'. Valid option types are
 187      UTF-8 strings, integers, and floats (bugs #254, #306, #317, #165).
 188    - Channels, optional channels, and annotations are now tuples (not lists).
 189    - Only load PDs of API version 2, all other versions are incompatible.
 190  * srd_inst_channel_set_all(): Report an error if not all channels required
 191    by the respective protocol decoder have been supplied.
 192  * Remove some internal limitations to max. 64 channels (bug #120).
 193  * Add a unit test suite framework for libsigrokdecode ('make check').
 194  * Add a protocol decoder test-suite framework for developers (tests/pdtest).
 195  * Various bugfixes:
 196    - srd_inst_option_set(): Properly return an error on exceptions.
 197    - srd_inst_option_set(): Fix setting of instance options, caused by class
 198      variable clobbering or releasing borrowed references (bugs #170, #174).
 199    - srd_decoder_load(): Error out upon invalid module names (bug #176).
 200    - srd_decoder_load(): Don't try to load an already loaded PD twice.
 201    - srd_decoder_load_all(): Avoid issues without prior srd_init() (bug #178).
 202    - srd_decoder_doc_get(): Fix an issue in the unit test suite (bug #179).
 203    - srd_pd_output_callback_add(): Honor cb_data value (bug #143).
 204    - Fix issues with PDs not getting the samplerate (bugs #97, #132, #166).
 205    - Don't incorrectly decrease a borrowed reference (bug #177).
 206    - Fix various memory leaks and segfault conditions.
 207  * Build system:
 208     - Use pkg-config (not python3-config) to check for Python libs.
 209       This enables (better) libsigrokdecode cross-compile support.
 210     - PDs no longer have an extra Makefile.am, and 'make install' now
 211       happens via a Python script.
 212     - configure: Clearly mark required and optional libs.
 213     - Fix an issue with DESTDIR support (bug #215).
 214     - Add the HACKING file to the tarball.
 215  * Updated or new build-time and runtime requirements:
 216    - Python >= 3.2 (required)
 217    - check >= 0.9.4 (optional, only needed for the libsigrokdecode testsuite)
 218    - libsigrok >= 0.3.0 (optional, only needed for the developer PD testsuite)
 219    - python3-coverage (optional, only needed for the developer PD testsuite)
 220  * New 'make install'-time requirement:
 221    - Python >= 3.2 (required)
 222
 223 0.2.0 (2013-05-04)
 224 ------------------
 225
 226 Note: This release DOES change the libsigrokdecode public C API. This
 227 means it is NOT backwards-compatible and frontends will need updates.
 228
 229  * New supported protocol decoders:
 230    - Dallas DS1307 RTC
 231  * Library: Decoders now expose their options via the GSList *options field
 232    in struct srd_decoder.
 233  * API related changes:
 234    - Various API documentation fixes.
 235    - srd_decoder_list() now returns 'const GSList *' instead of 'GSList *'.
 236    - Added new srd_strerror() and srd_strerror_name() API calls.
 237  * Added support for optional probes for PDs.
 238
 239 0.1.1 (2013-01-27)
 240 ------------------
 241
 242 Note: This release does NOT change the libsigrokdecode public C API. This
 243 means existing libsigrokdecode frontends should not require any changes.
 244 However, individual PDs and their output changed, which may require
 245 some adaptations on the user's side in some cases.
 246
 247  * New supported protocol decoders:
 248    - avr_isp              AVR In-System Programming
 249    - can                  Controller Area Network
 250    - jtag                 Joint Test Action Group (IEEE 1149.1)
 251    - jtag_stm32           Joint Test Action Group / ST STM32
 252    - lm75                 National LM75
 253    - lpc                  Low-Pin-Count
 254    - maxim_ds28ea00       Maxim DS28EA00 1-Wire digital thermometer
 255    - onewire_link         1-Wire serial communication bus (link layer)
 256    - onewire_network      1-Wire serial communication bus (network layer)
 257    - sdcard_spi           Secure Digital card (SPI mode)
 258    - tlc5620              Texas Instruments TLC5620
 259    - uart_dump            UART dump
 260  * i2cfilter: Now outputs 'i2c' packets instead of just data bytes, so
 261    other PDs can stack on top of it. It filters by I2C slave address.
 262  * edid: Now takes 'i2c' packets as input.
 263  * pan1321:
 264    - Various bugfixes to make the PD actually work.
 265    - Now features 'Text (short)' and 'Text (verbose)' outputs.
 266  * usb:
 267    - The PD is split into 'usb_signalling' and 'usb_protocol' (stacked on top).
 268    - Various bugfixes to make the PD work (better).
 269    - The DP/DM probes were swapped, this is now fixed.
 270    - Preliminary support for USB low-speed (in addition to full-speed).
 271  * mlx90614: Minor bugfixes.
 272  * dcf77:
 273     - Major bugfix, this PD was not working correctly at all.
 274     - Handle PON signal.
 275  * nunchuk: Complete rewrite, works (better) now.
 276  * spi: Update docs, send CS# change packets, change output API slightly.
 277    If you have a PD which stacks on top of SPI, it'll need to be adapted.
 278    The PDs that ship with libsigrokdecode are updated already.
 279  * mx25lxx05d:
 280    - Implement support for the READ, RDSR, and PP commands.
 281    - Decode status register bits.
 282    - Fix SE command handling.
 283    - Fix inverted SRWD bit handling.
 284  * Various smaller style and consistency changes in code and PD descriptions.
 285  * Fix the build with Homebrew on Mac OS X.
 286  * Performance improvements in some PDs.
 287  * Documentation: Update website and git URLs.
 288  * pkg-config file: Small fix to improve behaviour on Windows with cmake.
 289  * All PD implementation files are now named 'pd.py' consistently.
 290  * configure script:
 291    - Also check for python3.3-config in addition to python-config and others.
 292    - Add missing -fvisibility=hidden to default CFLAGS.
 293    - Fix CFLAGS handling (configure.ac amends CFLAGS, doesn't overwrite now).
 294  * The minimum required glib version is 2.24.0 now.
 295  * We now ship a standard INSTALL file which documents the 'configure' options.
 296
 297 0.1.0 (2012-04-17)
 298 ------------------
 299
 300  * Initial release.
 301