]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/spi/__init__.py
license: remove FSF postal address from boiler plate license text
[libsigrokdecode.git] / decoders / spi / __init__.py
index 3276fed93f6f95499f2a769ab3896085b6824e7b..491b319d3338d86b534357031c52d816b1c6ecff 100644 (file)
@@ -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>
 ##
 ## 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/>.
 ##
 
-from .spi import *
+'''
+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 Decoder