speer.py

#!/usr/bin/python -u

# speer - Samsung Printer EEprom Reset

from __future__ import print_function

import sys
import os
import time
import argparse
import binascii
import string

try:
    import smbus
except ImportError:
    print('Module smbus not found! It probably needs to be installed with:', file=sys.stderr)
    print('', file=sys.stderr)
    print('apt-get install python-smbus', file=sys.stderr)
    os._exit(1)

# default values
I2C_BUS = 1
I2C_ADDR_PER_COLOR = { 0x50: 'Yellow',
                       0x52: 'Magenta',
                       0x54: 'Cyan',
                       0x56: 'Black' }
I2C_ADDR = 0x56
LEN = 0x100


def read_eeprom():
    bus = smbus.SMBus(I2C_BUS)

    buf = bytearray(LEN)
    for addr in range(0, LEN):
        bus.write_byte(I2C_ADDR, addr)
        x = bus.read_byte(I2C_ADDR)
        buf[addr] = x
    return buf

def write_eeprom(buf):
    bus = smbus.SMBus(I2C_BUS)

    addr = 0
    print('Writing {0} bytes:'.format(len(buf)), file=sys.stderr)
    for b in buf:
        sys.stderr.write('.')
        bus.write_byte_data(I2C_ADDR, addr, b)
        addr = addr + 1
        # wait 5ms or else we would get an error message
        time.sleep(0.001 * 5)
    print('', file=sys.stderr)

def read_eeprom_safe():
    """
    Reads the content of the EEPROM multiple times until three 
    consistent versions have been read. But does not read more 
    then 10 timesi altogether.
    """

    count = 1
    maxcount = 10
    maxconsistent = 3

    bufarray = []
    while count <= maxcount:
        print('Read passage {0} of {1}.'.format(count, maxcount), file=sys.stderr)
        buf = read_eeprom()
        bufarray.append(buf)
        if (bufarray.count(buf) >= maxconsistent):
            print('Data was read consistently for {0} times.'.format(maxconsistent), file=sys.stderr)
            return buf
        count = count + 1
    raise IOError('Read operations did not yield consistent results.')

def write_eeprom_safe(buf):
    """
    Writes the buffer to the EEPROM and verifies the data by reading 
    back the data afterwards and comparing it to the ofiginal 
    data block. The write operation is repeated for up to three 
    times if the data could not be verified successfully.
    """

    maxretry = 3
    retry = maxretry
    ok = False
    while not ok and retry > 0:
        if retry < maxretry:
            print('\nTrying to write data again:', file=sys.stderr)
        write_eeprom(buf)
        print('Verifying data:', file=sys.stderr)
        buf1 = read_eeprom_safe()
        if buf1 != buf:
            print('Verification failed!', file=sys.stderr)
        else:
            ok = True
        retry = retry - 1
    if not ok:
        raise IOError('Write/Verification failed for {0} times'.format(maxretry))
    else:
        print('Written data verified successfully.', file=sys.stderr)
    
def autodetect_i2c_address():
    global I2C_ADDR
    bus = smbus.SMBus(I2C_BUS)

    # we will try to read from every possible i2c address
    for addr in range(0x3, 0x78):
        try:
            bus.read_byte(addr)
            # yeah, it worked.
            col = ""
            if addr in I2C_ADDR_PER_COLOR:
                col = " ({0})".format(I2C_ADDR_PER_COLOR[addr])
            print('Auto-detected i2c-address 0x{0:02x}{1}.'.format(addr, col))
            return addr
        except IOError:
            pass #ignore
        
    print('Could not autodetect the i2c-address of the eeprom. Trying the default value 0x{0:02x}.'.format(I2C_ADDR))
    return I2C_ADDR

def reset_counter():
    buf = read_eeprom_safe()
    
    # verify that it is a Samsung EEPROM
    idstr = 'SAMSUNG'
    idbytes = bytearray(idstr)
    if buf[0:len(idbytes)] != idbytes:
        print('Reset operation aborted. EEPROM data does not start with identifier "{0}".'.format(idstr), file=sys.stderr)
        return

    print('Resetting pager counter.', file=sys.stderr)
    # reset four bytes at 0x88    
    buf[0x88] = 0
    buf[0x89] = 0
    buf[0x8a] = 0
    buf[0x8b] = 0
    # reset four bytes at 0x90
    buf[0x90] = 0
    buf[0x91] = 0
    buf[0x92] = 0
    buf[0x93] = 0

    print('Writing content back to EEPROM.', file=sys.stderr)
    write_eeprom_safe(buf)

def readfile(filename):
    buf = bytearray()
    with open(filename, "rb") as f:
        b = f.read(1)
        while b != b"":
            buf.append(b)
            b = f.read(1)
    return buf

def writefile(filename, buf):
    with open(filename, "wb") as f:
        b = f.write(buf)

def chunks(l, n):
    for i in xrange(0, len(l), n):
        yield l[i:i+n]

def hexline(addr, block):
    hex = binascii.hexlify(block)
    hex = hex + (16 - len(block)) * '  '
    hex = ' '.join(hex[i:i+2] for i in xrange(0,len(hex),2))
    hex = ' '.join(hex[i:i+(3*8)] for i in xrange(0,len(hex),(3*8)))
    p = ''.join((chr(x) if x >= 32 and chr(x) in string.printable and not x in [ 0x0a, 0x0d] else '.') for x in block)
    hex = ('%08x  ' % addr) + hex + '  |' + p + '|'
    return hex

def hexdump(buf):
    addr = 0
    blen = 16
    for block in chunks(buf, blen):
        print(hexline(addr, block))
        addr = addr + blen

def print_wiring():
    print()
    print('Toner cartridge:')
    print()
    print('+--------------------------------------------------------+')
    print('|       / \                                 .            |')
    print('|       \ /               +---------------+            O +')
    print('|                         | [D]  [G]  [C] |             /')
    print('+------------------------------------------------------+')
    print('')
    print('       D = Data    <connect-to>  Raspberry Pi GPIO pin 3')
    print('       G = Ground  <connect-to>  Raspberry Pi GPIO pin 6')
    print('       C = Clock   <connect-to>  Raspberry Pi GPIO pin 5')
    print()


if __name__ == "__main__":
    parser = argparse.ArgumentParser(add_help=False)

    group = parser.add_argument_group('commands')
    group.add_argument('-b', dest='backup', metavar="<filename>", help="backup EEPROM to file")
    group.add_argument('-x', dest='hexdump', action='store_true', help="output hex dump of EEPROM")
    group.add_argument('-r', dest='restore', metavar="<filename>", help="restore EEPROM from file")
    group.add_argument('-z', dest='zero', action='store_true', help="auto-zero page counter in EEPROM")
    group.add_argument('-w', action='store_true', help="print wiring information")

    group2 = parser.add_argument_group('optional arguments')
    group2.add_argument('-h', '--help', action='store_true', help="show this help message and exit")
    group2.add_argument('--bus', type=int, metavar="<bus>", default=I2C_BUS, help="i2c-bus (default: {0})".format(I2C_BUS))
    group2.add_argument('--addr', metavar="<addr>", help="i2c-address (auto-detection is attempted if not given)")

    args = parser.parse_args()

    cmd = 0
    if args.backup is not None:
        cmd = cmd + 1
    if args.restore is not None:
        cmd = cmd + 1
    if args.zero:
        cmd = cmd + 1
    if cmd > 1:
        parser.error('only one of -b, -r or -z is allowed')

    if cmd == 0:
        if args.hexdump:
            pass
        elif args.w:
            print_wiring()
            os._exit(0)
        else:
            parser.print_help()
            os._exit(0)

    # set optional values    
    I2C_BUS = args.bus

    if args.addr is None:
        # try to auto-detect the i2c-address
        I2C_ADDR = autodetect_i2c_address()
    else:
        try:
            I2C_ADDR = int(args.addr, 0)
        except ValueError:
            I2C_ADDR = -1

    if I2C_ADDR < 3 or I2C_ADDR > 0x77:
        parser.error("invalid number '{0}' for i2c-address (must be between 0x03 and 0x77)".format(args.addr))

    
    if args.restore is not None:
        print('Restoring EEPROM from file {0}.'.format(args.restore), file=sys.stderr)
        buf = readfile(args.restore)
        write_eeprom_safe(buf)

    elif args.zero:
        reset_counter()

    elif args.backup is not None or args.hexdump:
        buf = read_eeprom_safe()
        if args.hexdump:
            hexdump(buf)
        if args.backup is not None:
            print('Backing up EEPROM to file {0}.'.format(args.backup), file=sys.stderr)
            writefile(args.backup, buf)