circuitpython/shared-module/is31fl3741/IS31FL3741.c

/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2021 Mark Komus
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include <string.h>

#include "py/gc.h"
#include "py/obj.h"
#include "py/objarray.h"
#include "py/objproperty.h"
#include "py/runtime.h"

#include "shared-module/is31fl3741/allocator.h"
#include "shared-bindings/is31fl3741/IS31FL3741.h"
#include "shared-bindings/microcontroller/Pin.h"
#include "shared-bindings/microcontroller/__init__.h"
#include "shared-bindings/util.h"
#include "shared-module/framebufferio/FramebufferDisplay.h"
#include "shared-bindings/busio/I2C.h"

void common_hal_is31fl3741_IS31FL3741_construct(is31fl3741_IS31FL3741_obj_t *self, int width, int height, mp_obj_t framebuffer, busio_i2c_obj_t *i2c, uint8_t addr, mp_obj_t mapping) {
    self->width = width;
    self->height = height;

    self->bufsize = sizeof(uint32_t) * width * height;

    // Probe the bus to see if a device acknowledges the given address.
    if (!common_hal_busio_i2c_probe(i2c, addr)) {
        self->base.type = &mp_type_NoneType;
        mp_raise_ValueError_varg(translate("Unable to find I2C Display at %x"), addr);
    }

    self->i2c = i2c;
    self->device_address = addr;
    common_hal_busio_i2c_never_reset(self->i2c);
    // Our object is statically allocated off the heap so make sure the bus object lives to the end
    // of the heap as well.
    gc_never_free(self->i2c);

    mp_obj_t *items;
    size_t len;
    mp_obj_list_get(mapping, &len, &items);

    if (len != (size_t)(self->scale_width * self->scale_height * 3)) {
        mp_raise_ValueError(translate("LED mappings must match display size"));
    }

    self->mapping = common_hal_is31fl3741_allocator_impl(sizeof(uint16_t) * len);
    for (size_t i = 0; i < len; i++) {
        mp_int_t value = mp_obj_get_int(items[i]);
        // We only store up to 16 bits
        if (value > 0xFFFF) {
            value = 0xFFFF;
        }
        self->mapping[i] = (uint16_t)value;
    }

    common_hal_is31fl3741_IS31FL3741_reconstruct(self, framebuffer);
}

void common_hal_is31fl3741_IS31FL3741_reconstruct(is31fl3741_IS31FL3741_obj_t *self, mp_obj_t framebuffer) {
    self->paused = 1;

    if (framebuffer) {
        self->framebuffer = framebuffer;
        mp_get_buffer_raise(self->framebuffer, &self->bufinfo, MP_BUFFER_READ);
        if (mp_get_buffer(self->framebuffer, &self->bufinfo, MP_BUFFER_RW)) {
            self->bufinfo.typecode = 'H' | MP_OBJ_ARRAY_TYPECODE_FLAG_RW;
        } else {
            self->bufinfo.typecode = 'H';
        }

        // verify that the matrix is big enough
        mp_get_index(mp_obj_get_type(self->framebuffer), self->bufinfo.len, MP_OBJ_NEW_SMALL_INT(self->bufsize - 1), false);
    } else {
        common_hal_is31fl3741_free_impl(self->bufinfo.buf);

        self->framebuffer = NULL;
        self->bufinfo.buf = common_hal_is31fl3741_allocator_impl(self->bufsize);
        self->bufinfo.len = self->bufsize;
        self->bufinfo.typecode = 'H' | MP_OBJ_ARRAY_TYPECODE_FLAG_RW;
    }

    common_hal_displayio_is31fl3741_begin_transaction(self);

    uint8_t command = 0xFC; // device ID
    common_hal_busio_i2c_write(self->i2c, self->device_address, &command, 1, false);
    uint8_t data = 0;
    common_hal_busio_i2c_read(self->i2c, self->device_address, &data, 1);

    is31fl3741_send_reset(self->i2c, self->device_address);
    is31fl3741_send_enable(self->i2c, self->device_address);
    is31fl3741_set_current(self->i2c, self->device_address, 0xFF);

    // set scale (brightness) to max for all LEDs
    for (int i; i < 351; i++) {
        is31fl3741_set_led(self->i2c, self->device_address, i, 0xFF, 2);
    }

    common_hal_displayio_is31fl3741_end_transaction(self);

    self->paused = 0;
}

void common_hal_is31fl3741_IS31FL3741_deinit(is31fl3741_IS31FL3741_obj_t *self) {
    common_hal_displayio_is31fl3741_end_transaction(self); // in case we still had a lock

    if (self->i2c == &self->inline_i2c) {
        common_hal_busio_i2c_deinit(self->i2c);
        self->i2c = NULL;
    }

    if (self->mapping != 0) {
        common_hal_is31fl3741_free_impl(self->mapping);
        self->mapping = 0;
    }

    self->base.type = NULL;

    // If a framebuffer was passed in to the constructor, NULL the reference
    // here so that it will become GC'able
    self->framebuffer = NULL;
}

void common_hal_is31fl3741_IS31FL3741_set_paused(is31fl3741_IS31FL3741_obj_t *self, bool paused) {
    self->paused = paused;
}

bool common_hal_is31fl3741_IS31FL3741_get_paused(is31fl3741_IS31FL3741_obj_t *self) {
    return self->paused;
}

void common_hal_is31fl3741_IS31FL3741_set_global_current(is31fl3741_IS31FL3741_obj_t *self, uint8_t current) {
    common_hal_displayio_is31fl3741_begin_transaction(self);
    is31fl3741_set_current(self->i2c, self->device_address, current);
    common_hal_displayio_is31fl3741_end_transaction(self);
}

uint8_t common_hal_is31fl3741_IS31FL3741_get_global_current(is31fl3741_IS31FL3741_obj_t *self) {
    common_hal_displayio_is31fl3741_begin_transaction(self);
    uint8_t current = is31fl3741_get_current(self->i2c, self->device_address);
    common_hal_displayio_is31fl3741_end_transaction(self);
    return current;
}

void common_hal_is31fl3741_IS31FL3741_refresh(is31fl3741_IS31FL3741_obj_t *self, uint8_t *dirtyrows) {
    common_hal_displayio_is31fl3741_begin_transaction(self);
    if (!self->paused) {
        uint8_t dirty_row_flags = 0xFF; // only supports 8 rows gotta fix

        if (self->scale) {
            // Based on the Arduino IS31FL3741 driver code
            // dirtyrows flag current not implemented for scaled displays
            uint32_t *buffer = self->bufinfo.buf;

            for (int x = 0; x < self->scale_width; x++) {
                uint32_t *ptr = &buffer[x * 3]; // Entry along top scan line w/x offset
                for (int y = 0; y < self->scale_height; y++) {
                    uint16_t rsum = 0, gsum = 0, bsum = 0;
                    // Inner x/y loops are row-major on purpose (less pointer math)
                    for (uint8_t yy = 0; yy < 3; yy++) {
                        for (uint8_t xx = 0; xx < 3; xx++) {
                            uint32_t rgb = ptr[xx];
                            rsum += rgb >> 16 & 0xFF;
                            gsum += (rgb >> 8) & 0xFF;
                            bsum += rgb & 0xFF;
                        }
                        ptr += self->width; // Advance one scan line
                    }
                    rsum = rsum / 9;
                    gsum = gsum / 9;
                    bsum = bsum / 9;
                    uint32_t color = 0;
                    if (self->auto_gamma) {
                        color = (IS31GammaTable[rsum] << 16) +
                            (IS31GammaTable[gsum] << 8) +
                            IS31GammaTable[bsum];
                    } else {
                        color = (rsum << 16) + (gsum << 8) + bsum;
                    }
                    is31fl3741_draw_pixel(self->i2c, self->device_address, x, y, color, self->mapping);
                }
            }
        } else {
            uint32_t *buffer = self->bufinfo.buf;
            for (int y = 0; y < self->height; y++) {
                if ((dirtyrows != 0) && ((y % 8) == 0)) {
                    dirty_row_flags = *dirtyrows++;
                }

                if ((dirty_row_flags >> (y % 8)) & 0x1) {
                    uint32_t color = 0;
                    if (self->auto_gamma) {
                        color = IS31GammaTable[((*buffer) >> 16 & 0xFF)] +
                            IS31GammaTable[((*buffer) >> 8 & 0xFF)] +
                            IS31GammaTable[((*buffer) & 0xFF)];
                    } else {
                        color = *buffer;
                    }

                    for (int x = 0; x < self->width; x++) {
                        is31fl3741_draw_pixel(self->i2c, self->device_address, x, y, color, self->mapping);
                        buffer++;
                    }
                }
            }
        }
    }

    common_hal_displayio_is31fl3741_end_transaction(self);
}

int common_hal_is31fl3741_IS31FL3741_get_width(is31fl3741_IS31FL3741_obj_t *self) {
    return self->width;
}

int common_hal_is31fl3741_IS31FL3741_get_height(is31fl3741_IS31FL3741_obj_t *self) {
    return self->height;
}

void common_hal_displayio_is31fl3741_begin_transaction(is31fl3741_IS31FL3741_obj_t *self) {
    while (!common_hal_busio_i2c_try_lock(self->i2c)) {
        RUN_BACKGROUND_TASKS;
        if (mp_hal_is_interrupted()) {
            break;
        }
    }
}

void common_hal_displayio_is31fl3741_end_transaction(is31fl3741_IS31FL3741_obj_t *self) {
    common_hal_busio_i2c_unlock(self->i2c);
}

void *common_hal_is31fl3741_allocator_impl(size_t sz) {
    supervisor_allocation *allocation = allocate_memory(align32_size(sz), false, true);
    return allocation ? allocation->ptr : NULL;
}

void common_hal_is31fl3741_free_impl(void *ptr_in) {
    free_memory(allocation_from_ptr(ptr_in));
}

void is31fl3741_IS31FL3741_collect_ptrs(is31fl3741_IS31FL3741_obj_t *self) {
    gc_collect_ptr(self->framebuffer);
    gc_collect_ptr(self->mapping);
}

// The following are routines to manipulate the IS31FL3741 chip
// They are not meant to be called by user code but only used
// internally.

uint8_t cur_page = 99; // set to invalid page to start

void is31fl3741_send_unlock(busio_i2c_obj_t *i2c, uint8_t addr) {
    uint8_t unlock[2] = { 0xFE, 0xC5 }; // unlock command
    common_hal_busio_i2c_write(i2c, addr, unlock, 2, true);
}

void is31fl3741_set_page(busio_i2c_obj_t *i2c, uint8_t addr, uint8_t p) {
    if (p == cur_page) {
        return;
    }

    cur_page = p;
    is31fl3741_send_unlock(i2c, addr);

    uint8_t page[2] = { 0xFD, 0x00 }; // page command
    page[1] = p;
    common_hal_busio_i2c_write(i2c, addr, page, 2, true);
}

void is31fl3741_send_enable(busio_i2c_obj_t *i2c, uint8_t addr) {
    is31fl3741_set_page(i2c, addr, 4);
    uint8_t enable[2] = { 0x00, 0x01 }; // enable command
    common_hal_busio_i2c_write(i2c, addr, enable, 2, true);
}

void is31fl3741_send_reset(busio_i2c_obj_t *i2c, uint8_t addr) {
    is31fl3741_set_page(i2c, addr, 4);
    uint8_t rst[2] = { 0x3F, 0xAE }; // reset command
    common_hal_busio_i2c_write(i2c, addr, rst, 2, true);
}

void is31fl3741_set_current(busio_i2c_obj_t *i2c, uint8_t addr, uint8_t current) {
    is31fl3741_set_page(i2c, addr, 4);
    uint8_t gcur[2] = { 0x01, 0x00 }; // global current command
    gcur[1] = current;
    common_hal_busio_i2c_write(i2c, addr, gcur, 2, true);
}

uint8_t is31fl3741_get_current(busio_i2c_obj_t *i2c, uint8_t addr) {
    is31fl3741_set_page(i2c, addr, 4);
    uint8_t gcur = 0x01; // global current command
    common_hal_busio_i2c_write(i2c, addr, &gcur, 1, true);

    uint8_t data = 0;
    common_hal_busio_i2c_read(i2c, addr, &data, 1);
    return data;
}

void is31fl3741_set_led(busio_i2c_obj_t *i2c, uint8_t addr, uint16_t led, uint8_t level, uint8_t page) {
    uint8_t cmd[2] = { 0x00, 0x00 };

    if (led < 180) {
        is31fl3741_set_page(i2c, addr, page);
        cmd[0] = (uint8_t)led;
    } else {
        is31fl3741_set_page(i2c, addr, page + 1);
        cmd[0] = (uint8_t)(led - 180);
    }

    cmd[1] = level;

    common_hal_busio_i2c_write(i2c, addr, cmd, 2, true);
}

void is31fl3741_draw_pixel(busio_i2c_obj_t *i2c, uint8_t addr, int16_t x, int16_t y, uint32_t color, uint16_t *mapping) {
    uint8_t r = color >> 16 & 0xFF;
    uint8_t g = color >> 8 & 0xFF;
    uint8_t b = color & 0xFF;

    int16_t x1 = (x * 5 + y) * 3;
    uint16_t ridx = mapping[x1 + 2];
    if (ridx != 65535) {
        uint16_t gidx = mapping[x1 + 1];
        uint16_t bidx = mapping[x1 + 0];
        is31fl3741_set_led(i2c, addr, ridx, r, 0);
        is31fl3741_set_led(i2c, addr, gidx, g, 0);
        is31fl3741_set_led(i2c, addr, bidx, b, 0);
    }
}