X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fonewire_link%2F__init__.py;h=abd55671416df0ae9fb1985e0c89c8389b717da6;hp=8846bf4e26dfcd228ddc1d65075944a7bc396597;hb=HEAD;hpb=50bd5d259677faf87bb3408e111d0e833d7ba9b4

diff --git a/decoders/onewire_link/__init__.py b/decoders/onewire_link/__init__.py
index 8846bf4..abd5567 100644
--- a/decoders/onewire_link/__init__.py
+++ b/decoders/onewire_link/__init__.py
@@ -2,6 +2,7 @@
 ## This file is part of the libsigrokdecode project.
 ##
 ## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
+## Copyright (C) 2017 Kevin Redon <kingkevin@cuvoodoo.info>
 ##
 ## This program is free software; you can redistribute it and/or modify
 ## it under the terms of the GNU General Public License as published by
@@ -14,12 +15,11 @@
 ## GNU General Public License for more details.
 ##
 ## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+## along with this program; if not, see <http://www.gnu.org/licenses/>.
 ##
 
 '''
-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)
 
-Link layer protocol details:
-
 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
@@ -39,53 +37,20 @@ overdrive communication speed. The following minimal values should be used:
  - overdrive available: 2MHz minimum, 5MHz suggested
  - overdrive not available: 400kHz minimum, 1MHz suggested
 
-Probes:
+Channels:
 1-Wire requires a single signal, but some master implementations might have a
 separate signal used to deliver power to the bus during temperature conversion
-as an example. This power signal is currently not used.
+as an example.
 
  - owr (1-Wire signal line)
- - pwr (optional, dedicated power supply pin)
 
 Options:
-1-Wire is an asynchronous protocol, so the decoder must know the samplerate.
-The timing for sampling bits, presence, and reset is calculated by the decoder,
-but in case the user wishes to use different values, it is possible to
-configure the following timing values (number of samplerate periods):
-
- - overdrive              (if active the decoder will be prepared for overdrive)
- - cnt_normal_bit         (time for normal mode sample bit)
- - cnt_normal_slot        (time for normal mode data slot)
- - cnt_normal_presence    (time for normal mode sample presence)
- - cnt_normal_reset       (time for normal mode reset)
- - cnt_overdrive_bit      (time for overdrive mode sample bit)
- - cnt_overdrive_slot     (time for overdrive mode data slot)
- - cnt_overdrive_presence (time for overdrive mode sample presence)
- - cnt_overdrive_reset    (time for overdrive mode reset)
-
-These options should be configured only on very rare cases and the user should
-read the decoder source code to understand them correctly.
-
-Protocol output format:
-TODO.
+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
+switching speed, but the user can set which to start decoding with:
 
-Annotations:
-
-Link layer annotations show the following events:
-
- - NOTE/WARNING/ERROR
-   Possible samplerate related timing issues are reported.
- - Reset/presence true/false
-   The event is marked from the signal negative edge to the end of the reset
-   high period. It's also reported if there are any devices attached to the bus.
- - Bit 0/1
-   The event is marked from the signal negative edge to the end of the data
-   slot. The value of each received bit is also provided.
-
-TODO:
-- Check for protocol correctness, if events are timed inside prescribed limits.
-- Maybe add support for interrupts, check if this feature is deprecated.
+ - overdrive (to decode starting with overdrive speed)
 '''
 
-from .pd import *
-
+from .pd import Decoder