diff options
| author | Uwe Hermann <uwe@hermann-uwe.de> | 2012-01-15 12:50:07 +0100 |
|---|---|---|
| committer | Uwe Hermann <uwe@hermann-uwe.de> | 2012-01-15 12:59:59 +0100 |
| commit | 9e587cc9d4db0da9bdfffbc023d848dd59df74b4 (patch) | |
| tree | fe5c27ad0500832ae16ee6184314700dda16c6e3 | |
| parent | 876f83fd3396ce581e700741e58414c2f4f6277e (diff) | |
| download | libsigrokdecode-9e587cc9d4db0da9bdfffbc023d848dd59df74b4.tar.gz libsigrokdecode-9e587cc9d4db0da9bdfffbc023d848dd59df74b4.zip | |
srd: Bring back small stuff lost in the merge.
Also, use ''' for docstrings to be consistent with the rest.
| -rw-r--r-- | decoders/ddc.py | 5 | ||||
| -rw-r--r-- | decoders/i2c.py | 31 |
2 files changed, 18 insertions, 18 deletions
diff --git a/decoders/ddc.py b/decoders/ddc.py index 2336159..53244c3 100644 --- a/decoders/ddc.py +++ b/decoders/ddc.py @@ -16,13 +16,14 @@ ## You should have received a copy of the GNU General Public License ## along with this program; if not, If not, see <http://www.gnu.org/licenses/>. ## -""" + +''' This decoder extracts a DDC stream from an I2C session between a computer and a display device. The stream is output as plain bytes. Details: https://en.wikipedia.org/wiki/Display_Data_Channel -""" +''' import sigrokdecode as srd diff --git a/decoders/i2c.py b/decoders/i2c.py index e63ab85..f28b158 100644 --- a/decoders/i2c.py +++ b/decoders/i2c.py @@ -22,6 +22,7 @@ # I2C protocol decoder # +# # The Inter-Integrated Circuit (I2C) bus is a bidirectional, multi-master # bus using two signals (SCL = serial clock line, SDA = serial data line). # @@ -68,28 +69,26 @@ # TODO: Handle multiple different I2C devices on same bus # -> we need to decode multiple protocols at the same time. -""" -I2C protocol output format: - -The protocol output consists of a (Python) list of I2C "packets", each of -which is of the form +''' +Protocol output format: - [ _i2c_command_, _data_, _ack_bit_ ] +I2C packet: +[<i2c_command>, <data>, <ack_bit>] -_i2c_command_ is one of: +<i2c_command> is one of: - 'START' (START condition) - - 'START_REPEAT' (Repeated START) - - 'ADDRESS_READ' (Address, read) - - 'ADDRESS_WRITE' (Address, write) - - 'DATA_READ' (Data, read) - - 'DATA_WRITE' (Data, write) + - 'START REPEAT' (Repeated START) + - 'ADDRESS READ' (Address, read) + - 'ADDRESS WRITE' (Address, write) + - 'DATA READ' (Data, read) + - 'DATA WRITE' (Data, write) - 'STOP' (STOP condition) -_data_ is the data or address byte associated with the ADDRESS_* and DATA_* -command. For START, START_REPEAT and STOP, this is None. +<data> is the data or address byte associated with the 'ADDRESS*' and 'DATA*' +command. For 'START', 'START REPEAT' and 'STOP', this is None. -_ack_bit_ is either 'ACK' or 'NACK', but may also be None. -""" +<ack_bit> is either 'ACK' or 'NACK', but may also be None. +''' import sigrokdecode as srd |