All PDs: Improve/fix descriptions.
authorUwe Hermann <uwe@hermann-uwe.de>
Wed, 22 Jan 2014 21:43:21 +0000 (22:43 +0100)
committerUwe Hermann <uwe@hermann-uwe.de>
Tue, 28 Jan 2014 21:46:05 +0000 (22:46 +0100)
30 files changed:
decoders/avr_isp/__init__.py
decoders/can/__init__.py
decoders/dcf77/__init__.py
decoders/ds1307/__init__.py
decoders/i2c/__init__.py
decoders/i2cdemux/__init__.py
decoders/i2cfilter/__init__.py
decoders/i2s/__init__.py
decoders/jtag/__init__.py
decoders/jtag/pd.py
decoders/jtag_stm32/__init__.py
decoders/lm75/__init__.py
decoders/lpc/__init__.py
decoders/maxim_ds28ea00/__init__.py
decoders/midi/__init__.py
decoders/mlx90614/__init__.py
decoders/mx25lxx05d/__init__.py
decoders/mxc6225xu/__init__.py
decoders/nunchuk/__init__.py
decoders/onewire_link/__init__.py
decoders/onewire_network/__init__.py
decoders/pan1321/__init__.py
decoders/rtc8564/__init__.py
decoders/sdcard_spi/__init__.py
decoders/spi/__init__.py
decoders/tlc5620/__init__.py
decoders/uart/__init__.py
decoders/usb_packet/__init__.py
decoders/usb_signalling/__init__.py
decoders/xfp/__init__.py

index ff689dfda304aa3ace054454d1ac0b7a91b79a77..4c4a900eebdd4c04042b41e8a92043e441f9ae67 100644 (file)
 ##
 
 '''
-AVR ISP protocol decoder.
-
-TODO: Description.
-
-TODO: SPI is MSB-first.
-
-Details:
-TODO
+This decoder stacks on top of the 'spi' PD and decodes the In-System
+Programming (ISP) protocol of some Atmel AVR 8-bit microcontrollers.
 '''
 
 from .pd import *
index fac4f6ca984d5697761b521a533421fbaa3beae6..38731c269348012161b5840b1a045ebe4cc82e85 100644 (file)
 ##
 
 '''
-CAN protocol decoder.
-
-TODO: Description.
-
-Details:
-TODO
-
-Protocol output format:
-
-TODO.
+CAN (Controller Area Network) is a field bus protocol for distributed
+real-time control.
 
+This decoder assumes that a single CAN_RX line is sampled (e.g. on
+the digital output side of a CAN transceiver IC such as the Microchip
+MCP-2515DM-BM).
 '''
 
 from .pd import *
index 71828e20b1d0f9b720411a74fd44e8835453b341..04805c21d07c993da177831e6bacb78e5cf7d716 100644 (file)
@@ -19,7 +19,8 @@
 ##
 
 '''
-TODO.
+This PD decodes the DCF77 protocol (a European long-wave time signal that
+uses a 77.5kHz carrier frequency).
 
 Details:
 http://en.wikipedia.org/wiki/DCF77
index 04db184a69e81dcb7288b416f0fbf7dacf665a66..5bc28c3782e3f8e2148bf789eef2daf685db7c93 100644 (file)
 ##
 
 '''
-Dallas DS1307 RTC protocol decoder.
-
-Details:
-TODO
+This decoder stacks on top of the 'i2c' PD and decodes the Dallas DS1307
+real-time clock (RTC) specific registers and commands.
 '''
 
 from .pd import *
index 95d9e182b5dd5d20609037afa43a092a81bcd7a1..ba40245ebc6aeb3d44d897789e81b4ff4b27f0b2 100644 (file)
@@ -19,9 +19,7 @@
 ##
 
 '''
-I²C protocol decoder.
-
-The Inter-Integrated Circuit (I²C) bus is a bidirectional, multi-master
+I²C (Inter-Integrated Circuit) is a bidirectional, multi-master
 bus using two signals (SCL = serial clock line, SDA = serial data line).
 '''
 
index 93f6c34f14d8848afd53d4be5d26e0537d2f11fe..c5202c5acc9b7695a5f8f527fd18a3838944da3e 100644 (file)
 ##
 
 '''
-Generic I²C demultiplexing protocol decoder.
+This is a generic I²C demultiplexing protocol decoder.
 
-Takes an I²C stream as input and outputs multiple I²C streams, each stream
-containing only I²C packets for one specific I²C slave.
+It takes an I²C stream as input and outputs multiple I²C streams, each
+stream containing only I²C packets for one specific I²C slave.
 '''
 
 from .pd import *
index 31c3c6b73dc2732cb583de049335009a9db62137..6cbab8a1fe3da1354e3b02bf47589e6bdc38f641 100644 (file)
@@ -18,9 +18,9 @@
 ##
 
 '''
-Generic I²C filtering protocol decoder.
+This is a generic I²C filtering protocol decoder.
 
-Takes input from the I²C protocol decoder and removes all traffic
+It takes input from the I²C protocol decoder and removes all traffic
 except that from/to the specified slave address and/or direction.
 
 It then outputs the filtered data again as OUTPUT_PROTO of type/format 'i2c'
index e59ca96368f3901140f2d89060de7c8a0edaa8ec..b9c0ed72fb683e63a13585d97020ecd34694ff35 100644 (file)
 ##
 
 '''
-I²S protocol decoder.
+I²S (Integrated Interchip Sound) is a serial bus for connecting digital
+audio devices (usually on the same device/board).
 
-Documentation:
+Details:
 http://www.nxp.com/acrobat_download/various/I2SBUS.pdf
 http://en.wikipedia.org/wiki/I2s
 '''
index 16cf6c6d31bffe883858c1e114a720f0edf4bb53..047e54a86530aa19d369cd8692f37ef71b7f8c3e 100644 (file)
 ##
 
 '''
-JTAG protocol decoder.
-
 JTAG (Joint Test Action Group), a.k.a. "IEEE 1149.1: Standard Test Access Port
 and Boundary-Scan Architecture", is a protocol used for testing, debugging,
 and flashing various digital ICs.
 
-TODO: Protocol details.
-
-Protocol output format (WORK IN PROGRESS!):
-
-JTAG packet:
-[<packet-type>, <data>]
-
-<packet-type> is one of:
- - 'NEW STATE': <data> is the new state of the JTAG state machine.
-   Valid values: 'TEST-LOGIC-RESET', 'RUN-TEST/IDLE', 'SELECT-DR-SCAN',
-   'CAPTURE-DR', 'SHIFT-DR', 'EXIT1-DR', 'PAUSE-DR', 'EXIT2-DR', 'UPDATE-DR',
-   'SELECT-IR-SCAN', 'CAPTURE-IR', 'SHIFT-IR', 'EXIT1-IR', 'PAUSE-IR',
-   'EXIT2-IR', 'UPDATE-IR'.
- - 'IR TDI': Bitstring that was clocked into the IR register.
- - 'IR TDO': Bitstring that was clocked out of the IR register.
- - 'DR TDI': Bitstring that was clocked into the DR register.
- - 'DR TDO': Bitstring that was clocked out of the DR register.
- - ...
-
-All bitstrings are a sequence of '1' and '0' characters. The right-most
-character in the bitstring is the LSB. Example: '01110001' (1 is LSB).
-
 Details:
 https://en.wikipedia.org/wiki/Joint_Test_Action_Group
 http://focus.ti.com/lit/an/ssya002c/ssya002c.pdf
index 55a9a1f3498e495dc2d7ad54e63fb9ec0d5f1f6b..ea6887b6023709cbb291c00cb6793fbf3418d693 100644 (file)
 
 import sigrokdecode as srd
 
+'''
+Protocol output format:
+
+JTAG packet:
+[<packet-type>, <data>]
+
+<packet-type> is one of:
+ - 'NEW STATE': <data> is the new state of the JTAG state machine.
+   Valid values: 'TEST-LOGIC-RESET', 'RUN-TEST/IDLE', 'SELECT-DR-SCAN',
+   'CAPTURE-DR', 'SHIFT-DR', 'EXIT1-DR', 'PAUSE-DR', 'EXIT2-DR', 'UPDATE-DR',
+   'SELECT-IR-SCAN', 'CAPTURE-IR', 'SHIFT-IR', 'EXIT1-IR', 'PAUSE-IR',
+   'EXIT2-IR', 'UPDATE-IR'.
+ - 'IR TDI': Bitstring that was clocked into the IR register.
+ - 'IR TDO': Bitstring that was clocked out of the IR register.
+ - 'DR TDI': Bitstring that was clocked into the DR register.
+ - 'DR TDO': Bitstring that was clocked out of the DR register.
+ - ...
+
+All bitstrings are a sequence of '1' and '0' characters. The right-most
+character in the bitstring is the LSB. Example: '01110001' (1 is LSB).
+'''
+
 jtag_states = [
         # Intro "tree"
         'TEST-LOGIC-RESET', 'RUN-TEST/IDLE',
index 76186665ac5726e188b276437626adc12b86fa02..8a28528380afecdf53bc122da1a36c9a2d542db7 100644 (file)
@@ -19,9 +19,8 @@
 ##
 
 '''
-ST STM32 JTAG protocol decoder.
-
-TODO.
+This decoder stacks on top of the 'jtag' PD and decodes JTAG data specific to
+the STM32 microcontroller series.
 
 Details:
 https://en.wikipedia.org/wiki/STM32
index 213e0ec02dac959c70769604890224ab2a36a3e9..d0964184bfd87dc31499d60d5715c247ca397f19 100644 (file)
 ##
 
 '''
-National LM75 (and compatibles) temperature sensor protocol decoder.
-
-TODO: Description.
-
-Protocol output format:
-TODO.
-
-Details:
-TODO.
+This decoder stacks on top of the 'i2c' PD and decodes the National LM75
+(and compatibles) temperature sensor protocol.
 '''
 
 from .pd import *
index e03c27e8864ec06abd64828ed36550082e9d6f9c..62a43075a2a524f6c481ac1c11310736264e597b 100644 (file)
@@ -19,7 +19,8 @@
 ##
 
 '''
-Low-Pin Count protocol decoder.
+LPC (Low-Pin Count) is a protocol for low-bandwidth devices used on
+some PC mainboards, such as the "BIOS chip" or the so-called "Super I/O".
 '''
 
 from .pd import *
index c5d3ca5cb6f4d9655a4ff1b85b26ac7c13eef6fd..34d1d088e0ce70cad81f53bd7ef4cc87784afbc1 100644 (file)
 ##
 
 '''
-Maxim DS28EA00 protocol decoder.
-
-The Maxim DS28EA00 is a 1-Wire digital thermometer with Sequence Detect
-and PIO functionality.
-
-Details:
-TODO
+This decoder stacks on top of the 'onewire_network' PD and decodes the
+Maxim DS28EA00 1-Wire digital thermometer protocol.
 '''
 
 from .pd import *
index 029cfc01d88b71cc6360712e08c7f07721e64450..a453346db4700eb3edd27604161e912b2f5518a8 100644 (file)
 ##
 
 '''
-MIDI protocol decoder.
+This decoder stacks on top of the 'uart' PD and decodes the MIDI
+(Musical Instrument Digital Interface) protocol.
 
-The MIDI protocol is layered on top of the UART (async serial) protocol,
-with a fixed baud rate of 31250 baud (+/- 1%) and 8n1 settings. Bytes are
-sent LSB-first.
+MIDI is layered on top of the UART (async serial) protocol, with a fixed
+baud rate of 31250 baud (+/- 1%) and 8n1 settings. Bytes are sent LSB-first.
 '''
 
 from .pd import *
index d0c6293a770fcc948e377b39e39a7a41b5a47223..29cb2a93bcb487c82fbdad90769633c1f62ff190 100644 (file)
 ##
 
 '''
-Melexis MLX90614 protocol decoder.
-
-Details:
-TODO
+This decoder stacks on top of the 'i2c' PD and decodes the Melexis MLX90614
+infrared thermometer protocol.
 '''
 
 from .pd import *
index 047be0e5f928dfe7b8d7947b78f0413cdad97d68..71d7b3c7412aa5990bc85c393f4870480928da8f 100644 (file)
 ##
 
 '''
-Macronix MX25Lxx05D SPI (NOR) flash chip protocol decoder.
+This decoder stacks on top of the 'spi' PD and decodes the Macronix
+MX25Lxx05D SPI (NOR) flash chip protocol.
 
-Works for MX25L1605D/MX25L3205D/MX25L6405D.
-
-TODO: Description.
+It works for the MX25L1605D/MX25L3205D/MX25L6405D.
 
 Details:
 http://www.macronix.com/QuickPlace/hq/PageLibrary4825740B00298A3B.nsf/h_Index/3F21BAC2E121E17848257639003A3146/$File/MX25L1605D-3205D-6405D-1.5.pdf
index 783be199a5a30c42090089915bea9439bdf9f41f..c4209c86dab61d5219e0fe34b49c4e43dd0433ce 100644 (file)
 ##
 
 '''
-MEMSIC MXC6225XU protocol decoder.
-
-The MEMSIC MXC6225XU is a Digital Thermal Orientation Sensor (DTOS).
+This decoder stacks on top of the 'i2c' PD and decodes the MEMSIC MXC6225XU
+digital thermal orientation sensor (DTOS) protocol.
 
 The chip's I²C interface supports standard mode and fast mode (max. 400kHz).
 Its I²C slave address is 0x2a.
-
-Details:
-TODO
 '''
 
 from .pd import *
index 41bc2ea49a3d001543bdc930054ebf4805f9c981..2fdaaeb430c7c1697353846ca5d69af7e49c4e7a 100644 (file)
@@ -19,9 +19,8 @@
 ##
 
 '''
-Nintendo Wii Nunchuk protocol decoder.
-
-TODO: Description.
+This decoder stacks on top of the 'i2c' PD and decodes the Nintendo Wii
+Nunchuk controller protocol.
 
 Details:
 http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Nunchuck
index f55b998aaadeb2b313c31bf216b23c3df2471f64..5bd6c55e6cdfbd623aed50acbfeacde751531fd4 100644 (file)
@@ -19,7 +19,7 @@
 ##
 
 '''
-1-Wire protocol decoder (link layer).
+This protocol decoder handles the 1-Wire link layer.
 
 The 1-Wire protocol enables bidirectional communication over a single wire
 (and ground) between a single master and one or multiple slaves. The protocol
@@ -29,8 +29,6 @@ is layered:
  - Network layer (skip/search/match device ROM addresses)
  - Transport layer (transport data between 1-Wire master and device)
 
-This protocol decoder handles the 1-Wire link layer.
-
 Sample rate:
 A sufficiently high samplerate is required to properly detect all the elements
 of the protocol. A lower samplerate can be used if the master does not use
index f184a3dfde1927beb2357720f2e6d074319b4f93..31e9134fe7d9c11e6adf8ea0e3a11d6b5e14ce95 100644 (file)
@@ -19,7 +19,8 @@
 ##
 
 '''
-1-Wire protocol decoder (network layer).
+This decoder stacks on top of the 'onewire_link' PD and decodes the
+1-Wire protocol (network layer).
 
 The 1-Wire protocol enables bidirectional communication over a single wire
 (and ground) between a single master and one or multiple slaves. The protocol
@@ -31,11 +32,6 @@ is layered:
 
 Network layer:
 
-Protocol output format:
-TODO.
-
-Annotations:
-
 The following link layer annotations are shown:
 
  - RESET/PRESENCE True/False
index 02e2da594f90fe4f6070735f66eb95b1b8a1ddb3..9bda5232ba227f6b42d80607cdc1429e292b4d73 100644 (file)
 ##
 
 '''
-Panasonic PAN1321 protocol decoder.
-
-Details:
-TODO
+This decoder stacks on top of the 'uart' PD and decodes the Panasonic PAN1321
+Bluetooth module Serial Port Profile (SPP) protocol.
 '''
 
 from .pd import *
index 6e67fe9e241d64a403a98551d42dc5624838f766..9a397b1fb3ab057fd14c8a0c7da0c22de647dc3f 100644 (file)
 ##
 
 '''
-Epson RTC-8564 JE/NB protocol decoder.
-
-Details:
-TODO
+This decoder stacks on top of the 'i2c' PD and decodes the Epson
+RTC-8564 JE/NB real-time clock (RTC) protocol.
 '''
 
 from .pd import *
index 18f9c9a6bf0f024867b7cdeb4c97c9b854abf89a..293b654fd033aa13da177b838ac4ace9ab55fab4 100644 (file)
@@ -19,9 +19,8 @@
 ##
 
 '''
-SD card (SPI mode) low-level protocol decoder.
-
-TODO: Description.
+This decoder stacks on top of the 'spi' PD and decodes the SD card
+(SPI mode) low-level protocol.
 
 Most SD cards can be accessed via two different protocols/modes: SD mode
 or SPI mode.
@@ -65,9 +64,6 @@ SPI mode properties (differences to SD mode):
  * In SPI mode cards cannot guarantee their speed class (the host should
    assume class 0, no matter what the card indicates).
  * The RCA register is not accessible in SPI mode.
-
-Details:
-TODO
 '''
 
 from .pd import *
index 582891ac261b1a9d2de5eea7d19d5230c394a74a..a65f167ec4786921fc0c8014c9c9501beb19fa08 100644 (file)
 ##
 
 '''
-Serial Peripheral Interface protocol decoder.
-
-This protocol decoder supports synchronous SPI(-like) protocols with a
-clock line, a MISO and MOSI line for data transfer in two directions,
-and an optional CS# pin.
+The SPI (Serial Peripheral Interface) protocol decoder supports synchronous
+SPI(-like) protocols with a clock line, a MISO and MOSI line for data
+transfer in two directions, and an optional CS# pin.
 
 If CS# is supplied, data is only decoded when CS# is asserted (clock
 transitions where CS# is not asserted are ignored). If CS# is not supplied,
index 6cf340188a14329ef52df3d65a07261daf461429..c6157600db2e46d390df40f5d3f3279144451ba5 100644 (file)
@@ -19,7 +19,7 @@
 ##
 
 '''
-Texas Instruments TLC5620 protocol decoder.
+The Texas Instruments TLC5620 is an 8-bit quad DAC.
 '''
 
 from .pd import *
index a0c9cef0a5cf89e8a00d7f38ba016b4f5a0bc2ac..f3c0693a9923a7e37ea9c1e2cf0a9d717db0d26e 100644 (file)
 ##
 
 '''
-UART protocol decoder.
-
-Universal Asynchronous Receiver Transmitter (UART) is a simple serial
+UART (Universal Asynchronous Receiver Transmitter) is a simple serial
 communication protocol which allows two devices to talk to each other.
 
 This decoder should work on all "UART-like" async protocols with one
-start bit (0), 7-9 databits, an (optional) parity bit, and one or more
+start bit (0), 5-9 databits, an (optional) parity bit, and one or more
 stop bits (1), in this order.
 
 It can be run on one signal line (RX or TX) only, or on two lines (RX + TX).
index 555dc7f90578d16b3cf7fd1e46ab5369c381b8ac..06b67b9ddede960cd3aa51769f3e551e6488d42d 100644 (file)
@@ -19,7 +19,8 @@
 ##
 
 '''
-USB (low-speed and full-speed) packet protocol decoder.
+This decoder stacks on top of the 'usb_signalling' PD and decodes the USB
+(low-speed and full-speed) packet protocol.
 
 Protocol layer (USB spec, chapter 8):
 
@@ -35,9 +36,6 @@ PID: A PID (packet identifier) follows the SYNC field of every packet. A PID
 consists of a 4-bit packet type field, and a 4 bit check field.
 The check field is the one's complement of the packet type field.
 
-Protocol output format:
-TODO
-
 Details:
 https://en.wikipedia.org/wiki/USB
 http://www.usb.org/developers/docs/
index 32902e4561ac4ffdf3b08a993f889c21aa9a1bf8..2311b1f3c5af73376d0dcea41c83a178d3beecbf 100644 (file)
@@ -19,7 +19,7 @@
 ##
 
 '''
-USB (low-speed and full-speed) signalling protocol decoder.
+This PD decodes the USB (low-speed and full-speed) signalling protocol.
 
 Electrical/signalling layer (USB spec, chapter 7):
 
@@ -43,9 +43,6 @@ Data is transferred at a rate of 1.5Mbit/s (low-speed) / 12Mbit/s (full-speed).
 The SE0 transmitted to signal an end-of-packet is two bit intervals long
 (low-speed: 1.25uS - 1.50uS, full-speed: 160ns - 175ns).
 
-Protocol output format:
-TODO
-
 Details:
 https://en.wikipedia.org/wiki/USB
 http://www.usb.org/developers/docs/
index 627f07b927955d0c5882e8115d78c9ecedb6d044..fa4e8a230c06e2452cfe4b092ab84ff8c50cda7d 100644 (file)
@@ -19,7 +19,7 @@
 ##
 
 '''
-XFP I²C management interface structure decoder.
+This PD decodes the XFP I²C management interface structures/protocol.
 
 XFP modules include an I²C interface, used to monitor and control various
 aspects of the module. The specification defines an I²C slave at address