[libsigrokdecode.git] / decoders / spi / __init__.py

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
##
## 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
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## 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, see <http://www.gnu.org/licenses/>.
##

'''
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
Commit	Line	Data
64c29e28	1	##
50bd5d25	2	## This file is part of the libsigrokdecode project.
64c29e28 UH	3	##
	4	## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
	5	##
	6	## This program is free software; you can redistribute it and/or modify
	7	## it under the terms of the GNU General Public License as published by
	8	## the Free Software Foundation; either version 2 of the License, or
	9	## (at your option) any later version.
	10	##
	11	## This program is distributed in the hope that it will be useful,
	12	## but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	## GNU General Public License for more details.
	15	##
	16	## You should have received a copy of the GNU General Public License
4539e9ca	17	## along with this program; if not, see <http://www.gnu.org/licenses/>.
64c29e28 UH	18	##
64c29e28 UH	19
1541976f	20	'''
4c3b1846 UH	21	The SPI (Serial Peripheral Interface) protocol decoder supports synchronous
	22	SPI(-like) protocols with a clock line, a MISO and MOSI line for data
	23	transfer in two directions, and an optional CS# pin.
cddd11bc	24	Either MISO or MOSI (but not both) can be optional.
71077f34	25
0702e0cf UH	26	If CS# is supplied, data is only decoded when CS# is asserted (clock
	27	transitions where CS# is not asserted are ignored). If CS# is not supplied,
	28	data is decoded on every clock transition (depending on SPI mode).
1541976f UH	29	'''
1541976f UH	30
95d11271	31	from .pd import Decoder