X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=decoders%2Fi2c%2Fpd.py;h=6beb251442ef0d7f6b22864bf4b10068175119b3;hb=f1428c4cbd60be07322cc3129eaed716a269648b;hp=2500ae4cc6e036a7620a1dd5e2c0c830a3b05af7;hpb=871b19d2c747c4baf2fcc3fbed6ca51e435a0e4a;p=libsigrokdecode.git

diff --git a/decoders/i2c/pd.py b/decoders/i2c/pd.py
index 2500ae4..6beb251 100644
--- a/decoders/i2c/pd.py
+++ b/decoders/i2c/pd.py
@@ -32,6 +32,29 @@
 
 import sigrokdecode as srd
 
+'''
+Protocol output format:
+
+I2C packet:
+[<cmd>, <data>]
+
+<cmd> is one of:
+ - 'START' (START condition)
+ - 'START REPEAT' (Repeated START condition)
+ - 'ADDRESS READ' (Slave address, read)
+ - 'ADDRESS WRITE' (Slave address, write)
+ - 'DATA READ' (Data, read)
+ - 'DATA WRITE' (Data, write)
+ - 'STOP' (STOP condition)
+ - 'ACK' (ACK bit)
+ - 'NACK' (NACK bit)
+
+<data> is the data or address byte associated with the 'ADDRESS*' and 'DATA*'
+command. Slave addresses do not include bit 0 (the READ/WRITE indication bit).
+For example, a slave address field could be 0x51 (instead of 0xa2).
+For 'START', 'START REPEAT', 'STOP', 'ACK', and 'NACK' <data> is None.
+'''
+
 # CMD: [annotation-type-index, long annotation, short annotation]
 proto = {
     'START':           [0, 'Start',         'S'],