X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fspi%2F__init__.py;h=dc5cbc0596a8d753c6f67b8d7404babe3351055f;hp=c1b5889fdc28c8c0affc7e4035b2668f8b550114;hb=2787cf2abc0187679e87d3735ca3e64c2a1a91c8;hpb=1541976fcac03a780b5d27046f5f8884973c08ae

diff --git a/decoders/spi/__init__.py b/decoders/spi/__init__.py
index c1b5889..dc5cbc0 100644
--- a/decoders/spi/__init__.py
+++ b/decoders/spi/__init__.py
@@ -1,5 +1,5 @@
 ##
-## This file is part of the sigrok project.
+## This file is part of the libsigrokdecode project.
 ##
 ## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
 ##
@@ -14,16 +14,19 @@
 ## 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/>.
 ##
 
 '''
-Serial Peripheral Interface protocol decoder.
+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.
 
-Details:
-TODO
-'''
+Either MISO or MOSI (but not both) can be optional.
 
-from .spi import *
+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,
+data is decoded on every clock transition (depending on SPI mode).
+'''
 
+from .pd import Decoder