X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=decoders%2Fspi%2F__init__.py;h=491b319d3338d86b534357031c52d816b1c6ecff;hb=8968f2fe6d561f48608a6f03e43045e10b99a689;hp=1fccbe74dee06292db4ffcd58662b3cce184e134;hpb=24c74fd30fb161837c5f8b01baf3c0fe2dfa4ed5;p=libsigrokdecode.git diff --git a/decoders/spi/__init__.py b/decoders/spi/__init__.py index 1fccbe7..491b319 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 ## @@ -14,35 +14,18 @@ ## 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 . ## ''' -Serial Peripheral Interface protocol decoder. - -Details: -TODO - -Protocol output format: - -SPI packet: -[, , ] - -Commands: - - 'DATA': contains the MISO data, contains the MOSI data. - The data is _usually_ 8 bits (but can also be fewer or more bits). - Both data items are Python numbers, not strings. - - 'CS CHANGE': is the old CS# pin value, is the new value. - Both data items are Python numbers (0/1), not strings. - -Examples: - ['CS-CHANGE', 1, 0] - ['DATA', 0xff, 0x3a] - ['DATA', 0x65, 0x00] - ['CS-CHANGE', 0, 1] - +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 +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 * - +from .pd import Decoder