decoders: Various cosmetic/consistency/typo fixes.

diff --git a/decoders/ac97/__init__.py b/decoders/ac97/__init__.py
index 8b96e8aa445d18d537d49e3c97dbc06602728551..c57c8ebaa4aa6a91eec5dc01dc69ed7472b20b74 100644 (file)
--- a/decoders/ac97/__init__.py
+++ b/decoders/ac97/__init__.py
@@ -18,9 +18,8 @@
 ##
 
 '''
 ##
 
 '''

-AC'97 (Audio Codec '97) was specifically designed by Intel for audio and
-modem I/O functionality in mainstream PC systems. See the specification in
-http://download.intel.com/support/motherboards/desktop/sb/ac97_r23.pdf
+AC'97 (Audio Codec '97) is a protocol for audio and modem I/O functionality
+in mainstream PC systems.

 
 AC'97 communicates full duplex data (SDATA_IN, SDATA_OUT), where bits
 are clocked by the BIT_CLK and frames are signalled by the SYNC signals.
 
 AC'97 communicates full duplex data (SDATA_IN, SDATA_OUT), where bits
 are clocked by the BIT_CLK and frames are signalled by the SYNC signals.


@@ -31,6 +30,9 @@ each. One 16bit slot contains management information, twelve 20bit slots
 follow which carry data for three management and nine audio/modem channels.
 Optionally two slots of one frame can get combined for higher resolution
 on fewer channels, or double data rate.
 follow which carry data for three management and nine audio/modem channels.
 Optionally two slots of one frame can get combined for higher resolution
 on fewer channels, or double data rate.

+
+Details:
+http://download.intel.com/support/motherboards/desktop/sb/ac97_r23.pdf

 '''
 
 from .pd import Decoder
 '''
 
 from .pd import Decoder

diff --git a/decoders/adns5020/__init__.py b/decoders/adns5020/__init__.py
index d4c260eb19aedd72009d8d654b56cf39629761a6..e519da4449872ec439abbda06f34e0b33087d59c 100644 (file)
--- a/decoders/adns5020/__init__.py
+++ b/decoders/adns5020/__init__.py
@@ -19,7 +19,9 @@
 
 '''
 This decoder stacks on top of the 'spi' PD and decodes ADNS-5020 optical mouse
 
 '''
 This decoder stacks on top of the 'spi' PD and decodes ADNS-5020 optical mouse

-sensor commands and data. Use MOSI for the SDIO shared line.
+sensor commands and data.
+
+Use MOSI for the SDIO shared line.

 '''
 
 from .pd import Decoder
 '''
 
 from .pd import Decoder

diff --git a/decoders/adns5020/pd.py b/decoders/adns5020/pd.py
index 1703659f0d600f9fabe08520049d02ffb44a5bfc..99fb2245703e79ef7de3cc67975ed9c985a35dae 100644 (file)
--- a/decoders/adns5020/pd.py
+++ b/decoders/adns5020/pd.py
@@ -42,8 +42,8 @@ class Decoder(srd.Decoder):
     api_version = 3
     id = 'adns5020'
     name = 'ADNS-5020'
     api_version = 3
     id = 'adns5020'
     name = 'ADNS-5020'

-    longname = 'Avago ADNS-5020 optical mouse sensor'
-    desc = 'Bidirectional command and data over an SPI-like protocol.'
+    longname = 'Avago ADNS-5020'
+    desc = 'Bidirectional optical mouse sensor protocol.'

     license = 'gplv2+'
     inputs = ['spi']
     outputs = ['adns5020']
     license = 'gplv2+'
     inputs = ['spi']
     outputs = ['adns5020']

diff --git a/decoders/am230x/pd.py b/decoders/am230x/pd.py
index 3d36cbb510dc38d92dbf7616ce1195b64ca7e9aa..814a542bbdc97180eb108d4610d0b9ab4b8b9c49 100644 (file)
--- a/decoders/am230x/pd.py
+++ b/decoders/am230x/pd.py
@@ -36,9 +36,9 @@ class SamplerateError(Exception):
 class Decoder(srd.Decoder):
     api_version = 3
     id = 'am230x'
 class Decoder(srd.Decoder):
     api_version = 3
     id = 'am230x'

-    name = 'AM230x/DHTxx/RHTxx'
+    name = 'AM230x'

     longname = 'Aosong AM230x/DHTxx/RHTxx'
     longname = 'Aosong AM230x/DHTxx/RHTxx'

-    desc = 'Aosong AM230x/DHTxx/RHTxx humidity/temperature sensor protocol.'
+    desc = 'Aosong AM230x/DHTxx/RHTxx humidity/temperature sensor.'

     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['am230x']
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['am230x']

diff --git a/decoders/arm_etmv3/__init__.py b/decoders/arm_etmv3/__init__.py
index 2ce2974c0f9a126576b92262f780d10b4bf7c047..617063ca7825b035253105f58b78a9318c2d6274 100644 (file)
--- a/decoders/arm_etmv3/__init__.py
+++ b/decoders/arm_etmv3/__init__.py
@@ -18,7 +18,7 @@
 ##
 
 '''
 ##
 
 '''

-This decoder stacks on top of the 'uart' decoder and decodes packets of
+This decoder stacks on top of the 'uart' PD and decodes packets of

 the ARMv7m Embedded Trace Macroblock v3.x.
 '''
 
 the ARMv7m Embedded Trace Macroblock v3.x.
 '''
 

diff --git a/decoders/arm_etmv3/pd.py b/decoders/arm_etmv3/pd.py
index 133196a0afefd51dd2a98b2e78b40b45f79fe07b..3608ac69337b7cb5deb82be57b536b40d12f1517 100644 (file)
--- a/decoders/arm_etmv3/pd.py
+++ b/decoders/arm_etmv3/pd.py
@@ -130,8 +130,8 @@ class Decoder(srd.Decoder):
     api_version = 3
     id = 'arm_etmv3'
     name = 'ARM ETMv3'
     api_version = 3
     id = 'arm_etmv3'
     name = 'ARM ETMv3'

-    longname = 'ARM Embedded Trace Macroblock'
-    desc = 'Decode ETM instruction trace packets.'
+    longname = 'ARM Embedded Trace Macroblock v3'
+    desc = 'ARM ETM v3 instruction trace protocol.'

     license = 'gplv2+'
     inputs = ['uart']
     outputs = ['arm_etmv3']
     license = 'gplv2+'
     inputs = ['uart']
     outputs = ['arm_etmv3']

diff --git a/decoders/arm_itm/pd.py b/decoders/arm_itm/pd.py
index 4359bbac9e3e99a7723c225c94d3eacaf7683edc..627612f0d1a06f99a79b403f4557370c24844f71 100644 (file)
--- a/decoders/arm_itm/pd.py
+++ b/decoders/arm_itm/pd.py
@@ -41,7 +41,7 @@ class Decoder(srd.Decoder):
     id = 'arm_itm'
     name = 'ARM ITM'
     longname = 'ARM Instrumentation Trace Macroblock'
     id = 'arm_itm'
     name = 'ARM ITM'
     longname = 'ARM Instrumentation Trace Macroblock'

-    desc = 'Trace data from Cortex-M / ARMv7m ITM module.'
+    desc = 'ARM Cortex-M / ARMv7m ITM trace protocol.'

     license = 'gplv2+'
     inputs = ['uart']
     outputs = ['arm_itm']
     license = 'gplv2+'
     inputs = ['uart']
     outputs = ['arm_itm']

diff --git a/decoders/arm_tpiu/__init__.py b/decoders/arm_tpiu/__init__.py
index 3e9ec0efbeb8e010f115a04f2d14c48349b061fe..ce9c3744efc5ffced5fd54c8362a70fa0c53796a 100644 (file)
--- a/decoders/arm_tpiu/__init__.py
+++ b/decoders/arm_tpiu/__init__.py
@@ -18,10 +18,11 @@
 ##
 
 '''
 ##
 
 '''

-This decoder stacks on top of the 'uart' decoder and decodes the frame format
-of ARMv7m Trace Port Interface Unit. It filters the data coming from various
-trace sources (such as ARMv7m ITM and ETM blocks) into separate streams that
-can be further decoded by other PDs.
+This decoder stacks on top of the 'uart' PD and decodes the frame format
+of ARMv7m Trace Port Interface Unit.
+
+It filters the data coming from various trace sources (such as ARMv7m ITM
+and ETM blocks) into separate streams that can be further decoded by other PDs.

 '''
 
 from .pd import Decoder
 '''
 
 from .pd import Decoder

diff --git a/decoders/atsha204a/__init__.py b/decoders/atsha204a/__init__.py
index fc56bd669ea17d6fec040185e13e637d490f3136..678e4fe678ed69ceb6e407b71ce6b0dae4019068 100644 (file)
--- a/decoders/atsha204a/__init__.py
+++ b/decoders/atsha204a/__init__.py
@@ -19,7 +19,7 @@
 
 '''
 This decoder stacks on top of the 'i2c' PD and decodes the
 
 '''
 This decoder stacks on top of the 'i2c' PD and decodes the

-Microchip ATSHA204A CryptoAuthentication protocol.
+Microchip ATSHA204A crypto authentication protocol.

 '''
 
 from .pd import Decoder
 '''
 
 from .pd import Decoder

diff --git a/decoders/atsha204a/pd.py b/decoders/atsha204a/pd.py
index 56cb75bfb46112f8d463e9531bfc5dee07f3bb22..3f579b134ffdce0b2d8ef5cac3bc60818b400025 100644 (file)
--- a/decoders/atsha204a/pd.py
+++ b/decoders/atsha204a/pd.py
@@ -85,7 +85,7 @@ class Decoder(srd.Decoder):
     id = 'atsha204a'
     name = 'ATSHA204A'
     longname = 'Microchip ATSHA204A'
     id = 'atsha204a'
     name = 'ATSHA204A'
     longname = 'Microchip ATSHA204A'

-    desc = 'Microchip ATSHA204A CryptoAuthentication device.'
+    desc = 'Microchip ATSHA204A crypto authentication protocol.'

     license = 'gplv2+'
     inputs = ['i2c']
     outputs = ['atsha204a']
     license = 'gplv2+'
     inputs = ['i2c']
     outputs = ['atsha204a']

diff --git a/decoders/avr_isp/pd.py b/decoders/avr_isp/pd.py
index 1d2ceae21259cd4c6475cd80dd70922144563f08..2d5ec815c060fbe1450f474ac7e3d0dc1d806fe5 100644 (file)
--- a/decoders/avr_isp/pd.py
+++ b/decoders/avr_isp/pd.py
@@ -27,7 +27,7 @@ class Decoder(srd.Decoder):
     id = 'avr_isp'
     name = 'AVR ISP'
     longname = 'AVR In-System Programming'
     id = 'avr_isp'
     name = 'AVR ISP'
     longname = 'AVR In-System Programming'

-    desc = 'Protocol for in-system programming Atmel AVR MCUs.'
+    desc = 'Atmel AVR In-System Programming (ISP) protocol.'

     license = 'gplv2+'
     inputs = ['spi']
     outputs = ['avr_isp']
     license = 'gplv2+'
     inputs = ['spi']
     outputs = ['avr_isp']

diff --git a/decoders/avr_pdi/__init__.py b/decoders/avr_pdi/__init__.py
index ebe647bdbed754ea620583be6266bcb90ec7b2a9..1c61dea7961e4c86ea2f295c4354129de37831e7 100644 (file)
--- a/decoders/avr_pdi/__init__.py
+++ b/decoders/avr_pdi/__init__.py
@@ -19,9 +19,10 @@
 
 '''
 PDI (Program and Debug Interface) is an Atmel proprietary interface for
 
 '''
 PDI (Program and Debug Interface) is an Atmel proprietary interface for

-external programming and on-chip debugging of the device. See the Atmel
-Application Note AVR1612 "PDI programming driver" and the "Program and
-Debug Interface" section in the Xmega A manual for details.
+external programming and on-chip debugging of the device.
+
+See the Atmel Application Note AVR1612 "PDI programming driver" and the
+"Program and Debug Interface" section in the Xmega A manual for details.

 
 The protocol uses two pins: the RESET pin and one dedicated DATA pin.
 The RESET pin provides a clock, the DATA pin communicates serial frames
 
 The protocol uses two pins: the RESET pin and one dedicated DATA pin.
 The RESET pin provides a clock, the DATA pin communicates serial frames

diff --git a/decoders/avr_pdi/pd.py b/decoders/avr_pdi/pd.py
index 614eb4f17199b9e6c1876754823dcee22bea3561..3a3ab6c05b854d8eb22dadb1e198fba71267c880 100644 (file)
--- a/decoders/avr_pdi/pd.py
+++ b/decoders/avr_pdi/pd.py
@@ -116,7 +116,7 @@ class Decoder(srd.Decoder):
     id = 'avr_pdi'
     name = 'AVR PDI'
     longname = 'Atmel Program and Debug Interface'
     id = 'avr_pdi'
     name = 'AVR PDI'
     longname = 'Atmel Program and Debug Interface'

-    desc = 'Atmel proprietary interface for the ATxmega MCU.'
+    desc = 'Atmel ATxmega Program and Debug Interface (PDI) protocol.'

     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['pdi']
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['pdi']

diff --git a/decoders/cec/__init__.py b/decoders/cec/__init__.py
index db288ab61307edb2ce32b3d233900792c1061e88..4138b62b36bd2f48a125d09f09d38a20343bb10e 100644 (file)
--- a/decoders/cec/__init__.py
+++ b/decoders/cec/__init__.py
@@ -18,7 +18,7 @@
 ##
 
 '''
 ##
 
 '''

-Consumer Electronics Control (CEC) protocol allows users to command and
+The Consumer Electronics Control (CEC) protocol allows users to command and

 control devices connected through HDMI.
 '''
 
 control devices connected through HDMI.
 '''
 

diff --git a/decoders/counter/__init__.py b/decoders/counter/__init__.py
index e731311213e85674c48a0c56a8f93c233e9fb7c2..505148ddf037fcf2d8114aa6c6e20d6ba39633ad 100644 (file)
--- a/decoders/counter/__init__.py
+++ b/decoders/counter/__init__.py
@@ -18,11 +18,11 @@
 ##
 
 '''
 ##
 
 '''

-This PD is a simple counter.
+This decoder is a simple edge counter.

 
 It can count rising and/or falling edges, provides an optional reset
 
 It can count rising and/or falling edges, provides an optional reset

-signal. It can also divide the count to e.g. count the numger of
-fixed length words (where a word corresponds to e.g. 9 clock edges).
+signal. It can also divide the count to e.g. count the number of
+fixed-length words (where a word corresponds to e.g. 9 clock edges).

 '''
 
 from .pd import Decoder
 '''
 
 from .pd import Decoder

diff --git a/decoders/counter/pd.py b/decoders/counter/pd.py
index 93ec105180629368bb546fcfd537c76eed16e0f6..f1134bd14f61cb3b6bba3049608992baf249bc89 100644 (file)
--- a/decoders/counter/pd.py
+++ b/decoders/counter/pd.py
@@ -27,7 +27,7 @@ class Decoder(srd.Decoder):
     id = 'counter'
     name = 'Counter'
     longname = 'Edge counter'
     id = 'counter'
     name = 'Counter'
     longname = 'Edge counter'

-    desc = 'Count number of edges.'
+    desc = 'Count the number of edges in a signal.'

     license = 'gplv2+'
     inputs = ['logic']
     outputs = []
     license = 'gplv2+'
     inputs = ['logic']
     outputs = []

diff --git a/decoders/dali/pd.py b/decoders/dali/pd.py
index 525066d45ecef35053ab6fdeb589f1e42c20345f..9e99b816de87eac7bc401d0e56ffb03710da15a3 100644 (file)
--- a/decoders/dali/pd.py
+++ b/decoders/dali/pd.py
@@ -28,7 +28,7 @@ class Decoder(srd.Decoder):
     id = 'dali'
     name = 'DALI'
     longname = 'Digital Addressable Lighting Interface'
     id = 'dali'
     name = 'DALI'
     longname = 'Digital Addressable Lighting Interface'

-    desc = 'DALI lighting control protocol.'
+    desc = 'Digital Addressable Lighting Interface (DALI) protocol.'

     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['dali']
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['dali']

diff --git a/decoders/dmx512/pd.py b/decoders/dmx512/pd.py
index 9d694d5fac6a88cdc6040560d0da0234a351260c..081758efcc57fee8436fbfc7ae064dadb3e1a77c 100644 (file)
--- a/decoders/dmx512/pd.py
+++ b/decoders/dmx512/pd.py
@@ -24,7 +24,7 @@ class Decoder(srd.Decoder):
     id = 'dmx512'
     name = 'DMX512'
     longname = 'Digital MultipleX 512'
     id = 'dmx512'
     name = 'DMX512'
     longname = 'Digital MultipleX 512'

-    desc = 'Professional lighting control protocol.'
+    desc = 'Digital MultipleX 512 (DMX512) lighting protocol.'

     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['dmx512']
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['dmx512']

diff --git a/decoders/ds1307/pd.py b/decoders/ds1307/pd.py
index 0cd3b9d85534b3b408ca1c6c69fb891f9e74a142..556d5930c30327c9c43f02756049ff63e28f6138 100644 (file)
--- a/decoders/ds1307/pd.py
+++ b/decoders/ds1307/pd.py
@@ -56,7 +56,7 @@ class Decoder(srd.Decoder):
     id = 'ds1307'
     name = 'DS1307'
     longname = 'Dallas DS1307'
     id = 'ds1307'
     name = 'DS1307'
     longname = 'Dallas DS1307'

-    desc = 'Realtime clock module protocol.'
+    desc = 'Dallas DS1307 realtime clock module protocol.'

     license = 'gplv2+'
     inputs = ['i2c']
     outputs = ['ds1307']
     license = 'gplv2+'
     inputs = ['i2c']
     outputs = ['ds1307']

diff --git a/decoders/ds243x/pd.py b/decoders/ds243x/pd.py
index bc2fe35f6fd6c72723aff8cf2ee3af697f630552..b2194e7288d113ccd2d77e4d40c4cf2e783720fe 100644 (file)
--- a/decoders/ds243x/pd.py
+++ b/decoders/ds243x/pd.py
@@ -64,7 +64,7 @@ class Decoder(srd.Decoder):
     api_version = 3
     id = 'ds243x'
     name = 'DS243x'
     api_version = 3
     id = 'ds243x'
     name = 'DS243x'

-    longname = 'Maxim DS2432/2433'
+    longname = 'Maxim DS2432/3'

     desc = 'Maxim DS243x series 1-Wire EEPROM protocol.'
     license = 'gplv2+'
     inputs = ['onewire_network']
     desc = 'Maxim DS243x series 1-Wire EEPROM protocol.'
     license = 'gplv2+'
     inputs = ['onewire_network']

diff --git a/decoders/dsi/pd.py b/decoders/dsi/pd.py
index db1f96695167437387cd10f842da1b68c304bf8b..7be29c3386cd49fb5921cc70706c60d14bbed290 100644 (file)
--- a/decoders/dsi/pd.py
+++ b/decoders/dsi/pd.py
@@ -27,7 +27,7 @@ class Decoder(srd.Decoder):
     id = 'dsi'
     name = 'DSI'
     longname = 'Digital Serial Interface'
     id = 'dsi'
     name = 'DSI'
     longname = 'Digital Serial Interface'

-    desc = 'DSI lighting control protocol.'
+    desc = 'Digital Serial Interface (DSI) lighting protocol.'

     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['dsi']
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['dsi']

diff --git a/decoders/edid/__init__.py b/decoders/edid/__init__.py
index f0331cc89e719e662aa86515804c33630e83b0af..256d839db43196f9366318038c5a0b451df333ed 100644 (file)
--- a/decoders/edid/__init__.py
+++ b/decoders/edid/__init__.py
@@ -18,21 +18,18 @@
 ##
 
 '''
 ##
 
 '''

-EDID 1.3 structure decoder.
+Extended Display Identification Data (EDID) 1.3 structure decoder.

 
 The three-character vendor ID as specified in the EDID standard refers to
 a Plug and Play ID (PNPID). The list of PNPID assignments is done by Microsoft.
 
 The three-character vendor ID as specified in the EDID standard refers to
 a Plug and Play ID (PNPID). The list of PNPID assignments is done by Microsoft.

-More information is available on this page:
-
- http://msdn.microsoft.com/en-us/windows/hardware/gg463195

 
 The 'pnpids.txt' file included with this protocol decoder is derived from
 the list of assignments downloadable from that page. It was retrieved in
 January 2012.
 
 
 The 'pnpids.txt' file included with this protocol decoder is derived from
 the list of assignments downloadable from that page. It was retrieved in
 January 2012.
 

-More information on EDID is available here:
-
- https://en.wikipedia.org/wiki/Extended_display_identification_data
+Details:
+https://en.wikipedia.org/wiki/Extended_display_identification_data
+http://msdn.microsoft.com/en-us/windows/hardware/gg463195

 '''
 
 from .pd import Decoder
 '''
 
 from .pd import Decoder

diff --git a/decoders/gpib/pd.py b/decoders/gpib/pd.py
index dff60a0bbe5cbbcd4a86b048d3bf3472c3b99735..fb9ad00d7dfab3421bf510aca73d75fed78ac914 100644 (file)
--- a/decoders/gpib/pd.py
+++ b/decoders/gpib/pd.py
@@ -24,7 +24,7 @@ class Decoder(srd.Decoder):
     id = 'gpib'
     name = 'GPIB'
     longname = 'General Purpose Interface Bus'
     id = 'gpib'
     name = 'GPIB'
     longname = 'General Purpose Interface Bus'

-    desc = 'IEEE-488 GPIB / HPIB protocol.'
+    desc = 'IEEE-488 General Purpose Interface Bus (GPIB / HPIB).'

     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['gpib']
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['gpib']

diff --git a/decoders/graycode/pd.py b/decoders/graycode/pd.py
index 09f4a0e5e441a48e926289b9d369e0da66dc052d..63014a29dd6366aa44db9221bef11c749ca07751 100644 (file)
--- a/decoders/graycode/pd.py
+++ b/decoders/graycode/pd.py
@@ -77,7 +77,7 @@ class Decoder(srd.Decoder):
     id = 'graycode'
     name = 'Gray code'
     longname = 'Gray code and rotary encoder'
     id = 'graycode'
     name = 'Gray code'
     longname = 'Gray code and rotary encoder'

-    desc = 'Accumulate rotary encoder increments, provide timing statistics.'
+    desc = 'Accumulate rotary encoder increments, provide statistics.'

     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['graycode']
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['graycode']

diff --git a/decoders/guess_bitrate/__init__.py b/decoders/guess_bitrate/__init__.py
index 21f0cb8bbd933ef701170ac01917b8351c029dae..a02bf18324b724bf8d776a6902775acf27792b65 100644 (file)
--- a/decoders/guess_bitrate/__init__.py
+++ b/decoders/guess_bitrate/__init__.py
@@ -19,9 +19,11 @@
 
 '''
 This protocol decoder tries to guess the bitrate / baudrate of the
 
 '''
 This protocol decoder tries to guess the bitrate / baudrate of the

-communication on the specified channel. Typically this will be used to
-guess / detect the baudrate used in a UART communication snippet, but it
-could also be used to guess bitrates of certain other protocols or buses.
+communication on the specified channel.
+
+Typically this will be used to guess / detect the baudrate used in a UART
+communication snippet, but it could also be used to guess bitrates of certain
+other protocols or buses.

 
 It should be noted that this is nothing more than a simple guess / heuristic,
 and that there are various cases in practice where the detection of the
 
 It should be noted that this is nothing more than a simple guess / heuristic,
 and that there are various cases in practice where the detection of the


@@ -31,6 +33,8 @@ The precision of the estimated bitrate / baudrate will also depend on the
 samplerate used to sample the respective channel. For good results it is
 recommended to use a logic analyzer samplerate that is much higher than
 the expected bitrate/baudrate that might be used on the channel.
 samplerate used to sample the respective channel. For good results it is
 recommended to use a logic analyzer samplerate that is much higher than
 the expected bitrate/baudrate that might be used on the channel.

+
+The last annotation emitted by the decoder will be the best bitrate guess.

 '''
 
 from .pd import Decoder
 '''
 
 from .pd import Decoder

diff --git a/decoders/iec/pd.py b/decoders/iec/pd.py
index 957310cefd76b3e2a85893b20d5321b8c0141039..ff39b6b7d4d268b3699ff7aad09113e538629dba 100644 (file)
--- a/decoders/iec/pd.py
+++ b/decoders/iec/pd.py
@@ -30,7 +30,7 @@ class Decoder(srd.Decoder):
     api_version = 3
     id = 'iec'
     name = 'IEC'
     api_version = 3
     id = 'iec'
     name = 'IEC'

-    longname = 'Commodore bus'
+    longname = 'Commodore IEC bus'

     desc = 'Commodore serial IEEE-488 (IEC) bus protocol.'
     license = 'gplv2+'
     inputs = ['logic']
     desc = 'Commodore serial IEEE-488 (IEC) bus protocol.'
     license = 'gplv2+'
     inputs = ['logic']

diff --git a/decoders/jitter/__init__.py b/decoders/jitter/__init__.py
index 63a0fff1c4c87c826e58e1d0cc7ff262029938ad..3394ad759bc2f03dcc1ba5395632da961e854d84 100644 (file)
--- a/decoders/jitter/__init__.py
+++ b/decoders/jitter/__init__.py
@@ -21,6 +21,7 @@
 This protocol decoder retrieves the timing jitter between two digital signals.
 
 It allows to define a clock source channel and a resulting signal channel.
 This protocol decoder retrieves the timing jitter between two digital signals.
 
 It allows to define a clock source channel and a resulting signal channel.

+

 Each time a significant edge is detected in the clock source, we calculate the
 elapsed time before the resulting signal answers and report the timing jitter.
 '''
 Each time a significant edge is detected in the clock source, we calculate the
 elapsed time before the resulting signal answers and report the timing jitter.
 '''

diff --git a/decoders/jtag_ejtag/pd.py b/decoders/jtag_ejtag/pd.py
index 0bffde87bb517ca7884e7c1c54b17ded46a4b39c..a54e5e9ede61cf7232a9c0b45356dd59940d52b5 100644 (file)
--- a/decoders/jtag_ejtag/pd.py
+++ b/decoders/jtag_ejtag/pd.py
@@ -191,7 +191,7 @@ regs_items = {
 class Decoder(srd.Decoder):
     api_version = 3
     id = 'jtag_ejtag'
 class Decoder(srd.Decoder):
     api_version = 3
     id = 'jtag_ejtag'

-    name = 'JTAG / EJTAG (MIPS)'
+    name = 'JTAG / EJTAG'

     longname = 'Joint Test Action Group / EJTAG (MIPS)'
     desc = 'MIPS EJTAG protocol.'
     license = 'gplv2+'
     longname = 'Joint Test Action Group / EJTAG (MIPS)'
     desc = 'MIPS EJTAG protocol.'
     license = 'gplv2+'

diff --git a/decoders/lpc/__init__.py b/decoders/lpc/__init__.py
index 827ea94c435f3be3ee68d2bc1f44bbe66c710f22..5227758723364e9e73150011e578896905d157aa 100644 (file)
--- a/decoders/lpc/__init__.py
+++ b/decoders/lpc/__init__.py
@@ -18,7 +18,7 @@
 ##
 
 '''
 ##
 
 '''

-LPC (Low-Pin Count) is a protocol for low-bandwidth devices used on
+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".
 '''
 
 some PC mainboards, such as the "BIOS chip" or the so-called "Super I/O".
 '''
 

diff --git a/decoders/lpc/pd.py b/decoders/lpc/pd.py
index debb72b99a6023cf4da501b58b8a4b0f5c26e8db..3cfe29e8cec1d7dcf12711ef5954deb8e21dfd9d 100644 (file)
--- a/decoders/lpc/pd.py
+++ b/decoders/lpc/pd.py
@@ -98,7 +98,7 @@ class Decoder(srd.Decoder):
     api_version = 3
     id = 'lpc'
     name = 'LPC'
     api_version = 3
     id = 'lpc'
     name = 'LPC'

-    longname = 'Low-Pin-Count'
+    longname = 'Low Pin Count'

     desc = 'Protocol for low-bandwidth devices on PC mainboards.'
     license = 'gplv2+'
     inputs = ['logic']
     desc = 'Protocol for low-bandwidth devices on PC mainboards.'
     license = 'gplv2+'
     inputs = ['logic']

diff --git a/decoders/max7219/pd.py b/decoders/max7219/pd.py
index 5b32e11cfb4aac5b495cad8aaac702e0d4a98ab4..7484034a75ecac2f20c820d0757d99237af83d05 100644 (file)
--- a/decoders/max7219/pd.py
+++ b/decoders/max7219/pd.py
@@ -45,7 +45,7 @@ class Decoder(srd.Decoder):
     id = 'max7219'
     name = 'MAX7219'
     longname = 'Maxim MAX7219/MAX7221'
     id = 'max7219'
     name = 'MAX7219'
     longname = 'Maxim MAX7219/MAX7221'

-    desc = '8-digit LED display driver.'
+    desc = 'Maxim MAX72xx series 8-digit LED display driver.'

     license = 'gplv2+'
     inputs = ['spi']
     outputs = ['max7219']
     license = 'gplv2+'
     inputs = ['spi']
     outputs = ['max7219']

diff --git a/decoders/mcs48/__init__.py b/decoders/mcs48/__init__.py
index 54c01ccb2f3d17d47b1a90f847d4566191ed04d5..b989a2a8e30457f7aff3173c11d78684f9310597 100644 (file)
--- a/decoders/mcs48/__init__.py
+++ b/decoders/mcs48/__init__.py
@@ -19,8 +19,11 @@
 
 '''
 This protocol decoder de-multiplexes Intel MCS-48 (8039, 8048, etc.) external
 
 '''
 This protocol decoder de-multiplexes Intel MCS-48 (8039, 8048, etc.) external

-program memory accesses. This requires 14 channels: 8 for D0-D7 (data and
-lower 8 bits of address), 4 for A8-A11 (output on port P2), ALE and PSEN.
+program memory accesses.
+
+This requires 14 channels: 8 for D0-D7 (data and lower 8 bits of address),
+4 for A8-A11 (output on port P2), ALE and PSEN.
+

 An optional A12 is supported, which may be an arbitrary I/O pin driven by
 software (use case is dumping ROM of an HP 3478A).
 '''
 An optional A12 is supported, which may be an arbitrary I/O pin driven by
 software (use case is dumping ROM of an HP 3478A).
 '''

diff --git a/decoders/mdio/pd.py b/decoders/mdio/pd.py
index 8e970b1db5d2888cb835ad1b4febe4862a229802..15414e5fac891a2d7aca01f2f438bb4235abc382 100644 (file)
--- a/decoders/mdio/pd.py
+++ b/decoders/mdio/pd.py
@@ -33,7 +33,7 @@ class Decoder(srd.Decoder):
     id = 'mdio'
     name = 'MDIO'
     longname = 'Management Data Input/Output'
     id = 'mdio'
     name = 'MDIO'
     longname = 'Management Data Input/Output'

-    desc = 'Half-duplex sync serial bus for MII management between MAC and PHY.'
+    desc = 'MII management bus between MAC and PHY.'

     license = 'bsd'
     inputs = ['logic']
     outputs = ['mdio']
     license = 'bsd'
     inputs = ['logic']
     outputs = ['mdio']

diff --git a/decoders/microwire/__init__.py b/decoders/microwire/__init__.py
index da2d045e4fc4a8f3993b47c97df5fd7cdce4532f..53f52d092edb88792f7923a0730d8772561b97ef 100644 (file)
--- a/decoders/microwire/__init__.py
+++ b/decoders/microwire/__init__.py
@@ -19,6 +19,7 @@
 
 '''
 Microwire is a 3-wire half-duplex synchronous serial communication protocol.
 
 '''
 Microwire is a 3-wire half-duplex synchronous serial communication protocol.

+

 Originally from National Semiconductor, it is often used in EEPROM chips with
 device specific commands on top of the bit stream.
 
 Originally from National Semiconductor, it is often used in EEPROM chips with
 device specific commands on top of the bit stream.
 

diff --git a/decoders/mlx90614/pd.py b/decoders/mlx90614/pd.py
index 8ae3ab90fa0179cbbfb861b988b090baa05a7f58..f75d2050b6e61c6247393cc27acd9a04962365be 100644 (file)
--- a/decoders/mlx90614/pd.py
+++ b/decoders/mlx90614/pd.py
@@ -24,7 +24,7 @@ class Decoder(srd.Decoder):
     id = 'mlx90614'
     name = 'MLX90614'
     longname = 'Melexis MLX90614'
     id = 'mlx90614'
     name = 'MLX90614'
     longname = 'Melexis MLX90614'

-    desc = 'Infrared Thermometer protocol.'
+    desc = 'Melexis MLX90614 infrared thermometer protocol.'

     license = 'gplv2+'
     inputs = ['i2c']
     outputs = ['mlx90614']
     license = 'gplv2+'
     inputs = ['i2c']
     outputs = ['mlx90614']

diff --git a/decoders/nrf24l01/pd.py b/decoders/nrf24l01/pd.py
index 3781155eb43d84c5d47dd81aa047cb82a5a6bcda..4dd9451e345693c843a93d231c2ab1d57821df46 100644 (file)
--- a/decoders/nrf24l01/pd.py
+++ b/decoders/nrf24l01/pd.py
@@ -62,8 +62,8 @@ class Decoder(srd.Decoder):
     api_version = 3
     id = 'nrf24l01'
     name = 'nRF24L01(+)'
     api_version = 3
     id = 'nrf24l01'
     name = 'nRF24L01(+)'

-    longname = 'Nordic Semiconductor nRF24L01/nRF24L01+'
-    desc = '2.4GHz transceiver chip.'
+    longname = 'Nordic Semiconductor nRF24L01(+)'
+    desc = '2.4GHz RF transceiver chip.'

     license = 'gplv2+'
     inputs = ['spi']
     outputs = ['nrf24l01']
     license = 'gplv2+'
     inputs = ['spi']
     outputs = ['nrf24l01']

diff --git a/decoders/onewire_link/__init__.py b/decoders/onewire_link/__init__.py
index 69b570fc412007b57a70e026ed62190f3d3e8c8b..abd55671416df0ae9fb1985e0c89c8389b717da6 100644 (file)
--- a/decoders/onewire_link/__init__.py
+++ b/decoders/onewire_link/__init__.py
@@ -45,10 +45,10 @@ as an example.
  - owr (1-Wire signal line)
 
 Options:
  - owr (1-Wire signal line)
 
 Options:

-1-Wire is an asynchronous protocol with fixed timing values, so the decoder must
-know the samplerate.
+1-Wire is an asynchronous protocol with fixed timing values, so the decoder
+must know the samplerate.

 Two speeds are available: normal and overdrive. The decoder detects when
 Two speeds are available: normal and overdrive. The decoder detects when

-switching from one to another but the user can set which to start decoding with:
+switching speed, but the user can set which to start decoding with:

 
  - overdrive (to decode starting with overdrive speed)
 '''
 
  - overdrive (to decode starting with overdrive speed)
 '''

diff --git a/decoders/pwm/__init__.py b/decoders/pwm/__init__.py
index b81b141c9cb55bcd62fa80e1d918315838a0007b..8f0397668655e039151d695b2e7fee7512e0a804 100644 (file)
--- a/decoders/pwm/__init__.py
+++ b/decoders/pwm/__init__.py
@@ -18,7 +18,7 @@
 ##
 
 '''
 ##
 
 '''

-Pulse-width modulation (a.k.a pulse-duration modulation, PDM) decoder.
+Pulse-width modulation (PWM) a.k.a pulse-duration modulation (PDM) decoder.

 '''
 
 from .pd import Decoder
 '''
 
 from .pd import Decoder

diff --git a/decoders/rfm12/pd.py b/decoders/rfm12/pd.py
index fe93bfe4f647685034b8364310a6faab1432e8fc..997932a7d9955d03c62f132cfb86488fac670d69 100644 (file)
--- a/decoders/rfm12/pd.py
+++ b/decoders/rfm12/pd.py
@@ -23,7 +23,7 @@ class Decoder(srd.Decoder):
     api_version = 3
     id = 'rfm12'
     name = 'RFM12'
     api_version = 3
     id = 'rfm12'
     name = 'RFM12'

-    longname = 'RFM12 control protocol'
+    longname = 'HopeRF RFM12'

     desc = 'HopeRF RFM12 wireless transceiver control protocol.'
     license = 'gplv2+'
     inputs = ['spi']
     desc = 'HopeRF RFM12 wireless transceiver control protocol.'
     license = 'gplv2+'
     inputs = ['spi']

diff --git a/decoders/rgb_led_ws281x/pd.py b/decoders/rgb_led_ws281x/pd.py
index fc3dbc40fad9b57a439b04084af16f781ff426d4..19db2bf5c3b3188a53f09efd55e8f3aec15f616b 100644 (file)
--- a/decoders/rgb_led_ws281x/pd.py
+++ b/decoders/rgb_led_ws281x/pd.py
@@ -32,7 +32,7 @@ class Decoder(srd.Decoder):
     license = 'gplv3+'
     inputs = ['logic']
     outputs = ['rgb_led_ws281x']
     license = 'gplv3+'
     inputs = ['logic']
     outputs = ['rgb_led_ws281x']

-    tags = ['Display']
+    tags = ['Display', 'IC']

     channels = (
         {'id': 'din', 'name': 'DIN', 'desc': 'DIN data line'},
     )
     channels = (
         {'id': 'din', 'name': 'DIN', 'desc': 'DIN data line'},
     )

diff --git a/decoders/sda2506/__init__.py b/decoders/sda2506/__init__.py
index 4e820efeb8ad4f3ef280b3d6a5fabfad863ec052..bf555109425a01523cbc7200c58663b3da52c2ad 100644 (file)
--- a/decoders/sda2506/__init__.py
+++ b/decoders/sda2506/__init__.py
@@ -18,7 +18,7 @@
 ##
 
 '''
 ##
 
 '''

-Decoder for Siemens EEPROM SDA2506.
+Decoder for Siemens EEPROM SDA 2506-5.

 '''
 
 from .pd import Decoder
 '''
 
 from .pd import Decoder

diff --git a/decoders/spi/__init__.py b/decoders/spi/__init__.py
index 491b319d3338d86b534357031c52d816b1c6ecff..dc5cbc0596a8d753c6f67b8d7404babe3351055f 100644 (file)
--- a/decoders/spi/__init__.py
+++ b/decoders/spi/__init__.py
@@ -21,6 +21,7 @@
 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.
 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.

+

 Either MISO or MOSI (but not both) can be optional.
 
 If CS# is supplied, data is only decoded when CS# is asserted (clock
 Either MISO or MOSI (but not both) can be optional.
 
 If CS# is supplied, data is only decoded when CS# is asserted (clock

diff --git a/decoders/st7735/__init__.py b/decoders/st7735/__init__.py
index e724af6256185fc11ad190ae15feed9ffcc63c19..771578c64924c221e5f1784e6af42948c7927bc1 100644 (file)
--- a/decoders/st7735/__init__.py
+++ b/decoders/st7735/__init__.py
@@ -18,7 +18,7 @@
 ##
 
 '''
 ##
 
 '''

-This decoder decodes the ST7735 TFT controller protocol.
+This decoder decodes the Sitronix ST7735 TFT controller protocol.

 
 Details:
 http://www.displayfuture.com/Display/datasheet/controller/ST7735.pdf
 
 Details:
 http://www.displayfuture.com/Display/datasheet/controller/ST7735.pdf

diff --git a/decoders/swd/__init__.py b/decoders/swd/__init__.py
index c1b5ae593b1c6b59bfa90d8770d3529421be7897..a141239baadac999b7296aa3a66694be361e13ca 100644 (file)
--- a/decoders/swd/__init__.py
+++ b/decoders/swd/__init__.py
@@ -21,14 +21,14 @@
 This PD decodes the ARM SWD (version 1) protocol, as described in the
 "ARM Debug Interface v5.2" Architecture Specification.
 
 This PD decodes the ARM SWD (version 1) protocol, as described in the
 "ARM Debug Interface v5.2" Architecture Specification.
 

-Details:
-http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ihi0031c/index.html
-(Registration required)
-

 Not supported:
  * Turnaround periods other than the default 1, as set in DLCR.TURNROUND
    (should be trivial to add)
  * SWD protocol version 2 (multi-drop support, etc.)
 Not supported:
  * Turnaround periods other than the default 1, as set in DLCR.TURNROUND
    (should be trivial to add)
  * SWD protocol version 2 (multi-drop support, etc.)

+
+Details:
+http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ihi0031c/index.html
+(Registration required)

 '''
 
 from .pd import Decoder
 '''
 
 from .pd import Decoder

diff --git a/decoders/usb_request/pd.py b/decoders/usb_request/pd.py
index 2835bf9036142314adff4d167173b0997b799124..49b0b3501dcc272a315375e9d185a01d4ee60941 100644 (file)
--- a/decoders/usb_request/pd.py
+++ b/decoders/usb_request/pd.py
@@ -116,7 +116,7 @@ class Decoder(srd.Decoder):
     id = 'usb_request'
     name = 'USB request'
     longname = 'Universal Serial Bus (LS/FS) transaction/request'
     id = 'usb_request'
     name = 'USB request'
     longname = 'Universal Serial Bus (LS/FS) transaction/request'

-    desc = 'USB (low-speed and full-speed) transaction/request protocol.'
+    desc = 'USB (low-speed/full-speed) transaction/request protocol.'

     license = 'gplv2+'
     inputs = ['usb_packet']
     outputs = ['usb_request']
     license = 'gplv2+'
     inputs = ['usb_packet']
     outputs = ['usb_request']

diff --git a/decoders/usb_signalling/pd.py b/decoders/usb_signalling/pd.py
index 7b1ce2f57174ba65efd642e6b43bb581d5b4b74b..373103614fadf7538d9351f8da0ff478b372f793 100644 (file)
--- a/decoders/usb_signalling/pd.py
+++ b/decoders/usb_signalling/pd.py
@@ -104,7 +104,7 @@ class Decoder(srd.Decoder):
     id = 'usb_signalling'
     name = 'USB signalling'
     longname = 'Universal Serial Bus (LS/FS) signalling'
     id = 'usb_signalling'
     name = 'USB signalling'
     longname = 'Universal Serial Bus (LS/FS) signalling'

-    desc = 'USB (low-speed and full-speed) signalling protocol.'
+    desc = 'USB (low-speed/full-speed) signalling protocol.'

     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['usb_signalling']
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['usb_signalling']

diff --git a/decoders/xfp/__init__.py b/decoders/xfp/__init__.py
index c4fb008062c56ffa202a60a468d3037cfe57766a..72f359505b1171f1931e6068c367da5edce8327a 100644 (file)
--- a/decoders/xfp/__init__.py
+++ b/decoders/xfp/__init__.py
@@ -31,9 +31,8 @@ module startup. Other table are either reserved for future expansion, or
 available for vendor-specific extensions. This decoder supports both lower
 memory and table 0x01.
 
 available for vendor-specific extensions. This decoder supports both lower
 memory and table 0x01.
 

-The XFP specification is available here:
-
-  ftp://ftp.seagate.com/sff/INF-8077.PDF
+Details:
+ftp://ftp.seagate.com/sff/INF-8077.PDF (XFP specification)

 '''
 
 from .pd import Decoder
 '''
 
 from .pd import Decoder

diff --git a/decoders/xfp/pd.py b/decoders/xfp/pd.py
index 9bca10bc8ac44fe1619cc6b57f7375dc733fe5fc..6b4b7a975773503ea8d01e988383f5e49edd4504 100644 (file)
--- a/decoders/xfp/pd.py
+++ b/decoders/xfp/pd.py
@@ -27,7 +27,7 @@ class Decoder(srd.Decoder):
     id = 'xfp'
     name = 'XFP'
     longname = '10 Gigabit Small Form Factor Pluggable Module (XFP)'
     id = 'xfp'
     name = 'XFP'
     longname = '10 Gigabit Small Form Factor Pluggable Module (XFP)'

-    desc = 'Data structure describing display device capabilities.'
+    desc = 'XFP I²C management interface structures/protocol'

     license = 'gplv3+'
     inputs = ['i2c']
     outputs = ['xfp']
     license = 'gplv3+'
     inputs = ['i2c']
     outputs = ['xfp']

diff --git a/decoders/z80/__init__.py b/decoders/z80/__init__.py
index aaf7c76e76ed3e41e422f86f014d64f4507469b5..52ff9baccf646d0e74f527a8bbb0945aa7e323b5 100644 (file)
--- a/decoders/z80/__init__.py
+++ b/decoders/z80/__init__.py
@@ -28,8 +28,9 @@ sampling clock, if applicable.
 Notes on the Z80 opcode format and descriptions of both documented and
 "undocumented" opcodes are available here:
 
 Notes on the Z80 opcode format and descriptions of both documented and
 "undocumented" opcodes are available here:
 

-  http://www.z80.info/decoding.htm
-  http://clrhome.org/table/
+Details:
+http://www.z80.info/decoding.htm
+http://clrhome.org/table/

 '''
 
 from .pd import Decoder
 '''
 
 from .pd import Decoder