Difference between revisions of "Protocol decoders"

From sigrok
Jump to navigation Jump to search
(Start a list of specific protocol decoders we (or our users) might want to write later. This list is nowhere near complete.)
m (→‎Protocol decoders: Use a table.)
Line 35: Line 35:
=== Low-level decoders ===
=== Low-level decoders ===


Standard protocols that have raw signals/samples as input:
'''Standard protocols that have raw signals/samples as input:'''


* SPI
{| border="0" style="font-size: smaller"
* I2C
|- bgcolor="#6699ff"
* USART / RS232
!Protocol
* CAN
!Status
* USB
!Comments
* JTAG
 
* LPC
|- bgcolor="#6699ff"
* FWH
| colspan="3" | '''Basic / microcontrollers / embedded'''
* ISA
 
* PCI
|- bgcolor="#eeeeee"
* SMBus
| SPI
* [http://en.wikipedia.org/wiki/Consumer_IR Consumer IR]:
| bgcolor="red" | 0%
** Nokia NRC17
|
** Sony SIRC
|- bgcolor="#eeeeee"
** Philips RC-5
| I2C
** Philips RC-6
| bgcolor="red" | 0%
** Philips RC-MM
|
** Philips RECS80
|- bgcolor="#eeeeee"
** ...
| USART/RS232
* [http://en.wikipedia.org/wiki/Infrared_Data_Association IrDA]
| bgcolor="red" | 0%
* ...
|
 
|- bgcolor="#6699ff"
| colspan="3" | '''Automotive / industrial / embedded'''
 
|- bgcolor="#eeeeee"
| CAN
| bgcolor="red" | 0%
|
 
|- bgcolor="#6699ff"
| colspan="3" | '''Embedded'''
 
|- bgcolor="#eeeeee"
| JTAG
| bgcolor="red" | 0%
|
 
|- bgcolor="#6699ff"
| colspan="3" | '''PC'''
 
|- bgcolor="#eeeeee"
| USB 1.1
| bgcolor="red" | 0%
|
|- bgcolor="#eeeeee"
| USB 2.0
| bgcolor="red" | 0%
|
|- bgcolor="#eeeeee"
| USB 3
| bgcolor="red" | 0%
|
|- bgcolor="#eeeeee"
| LPC
| bgcolor="red" | 0%
|
|- bgcolor="#eeeeee"
| FWH
| bgcolor="red" | 0%
|
|- bgcolor="#eeeeee"
| ISA
| bgcolor="red" | 0%
|
|- bgcolor="#eeeeee"
| PCI
| bgcolor="red" | 0%
|
|- bgcolor="#eeeeee"
| SMBus
| bgcolor="red" | 0%
|
 
|- bgcolor="#6699ff"
| colspan="3" | '''[http://en.wikipedia.org/wiki/Consumer_IR Consumer IR]'''
 
|- bgcolor="#eeeeee"
| Nokia NRC17
| bgcolor="red" | 0%
|
|- bgcolor="#eeeeee"
| Sony SIRC
| bgcolor="red" | 0%
|
|- bgcolor="#eeeeee"
| Philips RC-5
| bgcolor="red" | 0%
|
|- bgcolor="#eeeeee"
| Philips RC-6
| bgcolor="red" | 0%
|
|- bgcolor="#eeeeee"
| Philips RC-MM
| bgcolor="red" | 0%
|
|- bgcolor="#eeeeee"
| Philips RECS80
| bgcolor="red" | 0%
|
 
|- bgcolor="#6699ff"
| colspan="3" | '''Miscellaneous'''
 
|- bgcolor="#eeeeee"
| [http://en.wikipedia.org/wiki/Infrared_Data_Association IrDA]
| bgcolor="red" | 0%
|
 
|}
 
... and many, many more.


Custom / application-specific protocols that have raw signals/samples as input:
'''Custom / application-specific protocols that have raw signals/samples as input:'''


* Atmel AT93C46 serial EEPROM protocols
* Atmel AT93C46 serial EEPROM protocols
Line 65: Line 157:
* ...
* ...


Non-protocol data analysis decoders / analyzers that have raw signals/samples as input:
'''Non-protocol data analysis decoders / analyzers that have raw signals/samples as input:'''


* Number of clock cycles / rising-edges / falling-edges / transitions / etc. (total or per-signal)
* Number of clock cycles / rising-edges / falling-edges / transitions / etc. (total or per-signal)
Line 73: Line 165:
=== High-level decoders ===
=== High-level decoders ===


Protocols that do not have raw signals/samples as input, but rather an already-preprocessed bytestream generated by one of the low-level decoders.
'''Protocols that do not have raw signals/samples as input, but rather an already-preprocessed bytestream generated by one of the low-level decoders:'''


* LCD display protocols over I2C (e.g. [http://www.lcd-module.de/pdf/grafik/ediptft43-a.pdf EA eDIPTFT43-A])
* LCD display protocols over I2C (e.g. [http://www.lcd-module.de/pdf/grafik/ediptft43-a.pdf EA eDIPTFT43-A])
Line 82: Line 174:
* ...
* ...


Non-protocol data analysis decoders / analyzers:
'''Non-protocol data analysis decoders / analyzers:'''


* How many data bytes are in the data stream?
* How many data bytes are in the data stream?
* What's the min/max/avg data value?
* What's the min/max/avg data value?
* ...
* ...

Revision as of 17:04, 31 March 2010

Ideas

  • Plugin system for protocol decoding:
    • Should support SPI, I2C, RS232/UART and many many more protocols, see below.
    • Should be easy to add support for additional/custom protocols, e.g. AT93C46:
      • CS (chip select)
      • SK (clock)
      • DI (data from chip to outside)
      • DO (data from outside into chip)
      • Has start bit, opcodes, data following transmission
    • A protocol as simple as this should be doable to implement without code, only the description of the meaning of the various pins.
  • PD plugins must be GUI-independent: they must always work on any GUI present in sigrok. The plugin interface must therefore provide hooks for:
    • Providing data from core to plugin - stream or dump.
    • Sending analysis results back from the plugin, e.g. timestamps or sample IDs with structured results:
      • Type:
        • Protocol overhead e.g. start bits
        • Commands e.g. opcodes
        • Command parameters e.g. address following a READ command
        • Extracted data
        • String to display over the data ("opcode READ")
        • Data (e.g. 10) + length in bits (e.g. 2)
        • Results can overlap, as in e.g. "READ address 0x08" and "opcode 10"
  • This also opens up the possibility of producing e.g. a protocol analysis report from the main code.
  • All PD plugins are written in Python.
    • We embed a scripting language (Python) for very simple transforms and/or additional display; e.g. 4-bit interface to HD44780 LCD, take two nibbles in sequence, based on clock line, and assemble them into a whole byte. Scripted plugin could do this, then pass the data back to the UI for display.

PD plugin infrastructure

The core backend takes a streaming feed from a live aquisition source (or from a saved session). If any PA plugins are configured to act on this source, a pipe is set up to feed this raw data to the embedded Python plugin dispatcher. The dispatcher configures the PD plugins, in order, to write to/read from each other's input and output queues. The dispatcher then starts feeding raw data into the bottom plugin's input queue, and takes output from the top plugin's output queue, which it feeds back to the backend.

Protocol decoders

This is a list of ideas for specific protocol decoders we might want to write in the future (or users might want to contribute).

Low-level decoders

Standard protocols that have raw signals/samples as input:

Protocol Status Comments
Basic / microcontrollers / embedded
SPI 0%
I2C 0%
USART/RS232 0%
Automotive / industrial / embedded
CAN 0%
Embedded
JTAG 0%
PC
USB 1.1 0%
USB 2.0 0%
USB 3 0%
LPC 0%
FWH 0%
ISA 0%
PCI 0%
SMBus 0%
Consumer IR
Nokia NRC17 0%
Sony SIRC 0%
Philips RC-5 0%
Philips RC-6 0%
Philips RC-MM 0%
Philips RECS80 0%
Miscellaneous
IrDA 0%

... and many, many more.

Custom / application-specific protocols that have raw signals/samples as input:

Non-protocol data analysis decoders / analyzers that have raw signals/samples as input:

  • Number of clock cycles / rising-edges / falling-edges / transitions / etc. (total or per-signal)
  • Min/Max/Avg distance between two events (rising edge, falling edge, signal lenths, etc.)
  • ...

High-level decoders

Protocols that do not have raw signals/samples as input, but rather an already-preprocessed bytestream generated by one of the low-level decoders:

  • LCD display protocols over I2C (e.g. EA eDIPTFT43-A)
  • LCD display protocols over SPI (e.g. Sames SA8807A)
  • LCD display protocols over RS232/USART (e.g. TODO)
  • I2C-attached ADC control protocol (Analog Devices AD7291)
  • SPI-attached serial EEPROMs
  • ...

Non-protocol data analysis decoders / analyzers:

  • How many data bytes are in the data stream?
  • What's the min/max/avg data value?
  • ...
Retrieved from "https://sigrok.org/w/index.php?title=Protocol_decoders&oldid=237"