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

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2017 Kevin Redon <kingkevin@cuvoodoo.info>
##
## 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/>.
##

'''
Microwire is a 3-wire half-duplex synchronous serial communication protocol.

Originally from National Semiconductor, it is often used in EEPROM chips with
device specific commands on top of the bit stream.

Channels:

 - CS: chip select, active high
 - SK: clock line, for the synchronous communication (idle low)
 - SI: slave data input, output by the master and parsed by the selected slave
       on rising edge of clock line (idle low)
 - SO: slave data output, output by the selected slave and changed on rising
       edge of clock line, or goes from low to high when ready during status
       check (idle high impedance)

The channel names might vary from chip to chip but the underlying function is
the same.
'''

from .pd import Decoder
Commit	Line	Data
bf014116 KR	1	##
	2	## This file is part of the libsigrokdecode project.
	3	##
	4	## Copyright (C) 2017 Kevin Redon <kingkevin@cuvoodoo.info>
	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, see <http://www.gnu.org/licenses/>.
	18	##
	19
	20	'''
	21	Microwire is a 3-wire half-duplex synchronous serial communication protocol.
2787cf2a	22
bf014116 KR	23	Originally from National Semiconductor, it is often used in EEPROM chips with
	24	device specific commands on top of the bit stream.
	25
	26	Channels:
	27
	28	- CS: chip select, active high
	29	- SK: clock line, for the synchronous communication (idle low)
	30	- SI: slave data input, output by the master and parsed by the selected slave
	31	on rising edge of clock line (idle low)
	32	- SO: slave data output, output by the selected slave and changed on rising
	33	edge of clock line, or goes from low to high when ready during status
	34	check (idle high impedance)
	35
	36	The channel names might vary from chip to chip but the underlying function is
	37	the same.
	38	'''
	39
	40	from .pd import Decoder