decoders/i2c/__init__.py

   1 ##
   2 ## This file is part of the libsigrokdecode 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
  21 '''
  22 I2C protocol decoder.
  23
  24 The Inter-Integrated Circuit (I2C) bus is a bidirectional, multi-master
  25 bus using two signals (SCL = serial clock line, SDA = serial data line).
  26
  27 Protocol output format:
  28
  29 I2C packet:
  30 [<cmd>, <data>]
  31
  32 <cmd> is one of:
  33  - 'START' (START condition)
  34  - 'START REPEAT' (Repeated START condition)
  35  - 'ADDRESS READ' (Slave address, read)
  36  - 'ADDRESS WRITE' (Slave address, write)
  37  - 'DATA READ' (Data, read)
  38  - 'DATA WRITE' (Data, write)
  39  - 'STOP' (STOP condition)
  40  - 'ACK' (ACK bit)
  41  - 'NACK' (NACK bit)
  42
  43 <data> is the data or address byte associated with the 'ADDRESS*' and 'DATA*'
  44 command. Slave addresses do not include bit 0 (the READ/WRITE indication bit).
  45 For example, a slave address field could be 0x51 (instead of 0xa2).
  46 For 'START', 'START REPEAT', 'STOP', 'ACK', and 'NACK' <data> is None.
  47
  48 '''
  49
  50 from .pd import *
  51