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

##
## This file is part of the sigrok 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, write to the Free Software
## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
##

'''
Serial Peripheral Interface protocol decoder.

Details:
TODO

Protocol output format:

SPI packet:
[<cmd>, <data1>, <data2>]

Commands:
 - 'DATA': <data1> contains the MISO data, <data2> 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': <data1> is the old CS# pin value, <data2> 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]

'''

from .spi import *
Commit	Line	Data
64c29e28 UH	1	##
	2	## This file is part of the sigrok project.
	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
	17	## along with this program; if not, write to the Free Software
	18	## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	##
	20
1541976f UH	21	'''
	22	Serial Peripheral Interface protocol decoder.
	23
	24	Details:
	25	TODO
3e3c0330 UH	26
	27	Protocol output format:
	28
	29	SPI packet:
	30	[<cmd>, <data1>, <data2>]
	31
	32	Commands:
	33	- 'DATA': <data1> contains the MISO data, <data2> contains the MOSI data.
	34	The data is _usually_ 8 bits (but can also be fewer or more bits).
	35	Both data items are Python numbers, not strings.
	36	- 'CS CHANGE': <data1> is the old CS# pin value, <data2> is the new value.
	37	Both data items are Python numbers (0/1), not strings.
	38
71077f34	39	Examples:
3e3c0330 UH	40	['CS-CHANGE', 1, 0]
	41	['DATA', 0xff, 0x3a]
	42	['DATA', 0x65, 0x00]
	43	['CS-CHANGE', 0, 1]
71077f34	44
1541976f UH	45	'''
1541976f UH	46
64c29e28 UH	47	from .spi import *
64c29e28 UH	48