From 09dc46a98480350b157636ffff8b89470f595f6e Mon Sep 17 00:00:00 2001
From: Jeff Epler <jepler@gmail.com>
Date: Tue, 10 Mar 2020 13:12:01 -0500
Subject: Add Protomatter and FramebufferDisplay

---
 shared-bindings/_protomatter/Protomatter.c | 293 +++++++++++++++++++++++++++++
 1 file changed, 293 insertions(+)
 create mode 100644 shared-bindings/_protomatter/Protomatter.c

(limited to 'shared-bindings/_protomatter/Protomatter.c')

diff --git a/shared-bindings/_protomatter/Protomatter.c b/shared-bindings/_protomatter/Protomatter.c
new file mode 100644
index 000000000..8d0d223bb
--- /dev/null
+++ b/shared-bindings/_protomatter/Protomatter.c
@@ -0,0 +1,293 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2020 Jeff Epler for Adafruit Industries
+ *
+ * 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 "py/obj.h"
+#include "py/objproperty.h"
+#include "py/runtime.h"
+#include "py/objarray.h"
+
+#include "common-hal/_protomatter/Protomatter.h"
+#include "shared-bindings/_protomatter/Protomatter.h"
+#include "shared-bindings/microcontroller/Pin.h"
+#include "shared-bindings/microcontroller/__init__.h"
+#include "shared-bindings/util.h"
+#include "shared-module/displayio/__init__.h"
+#include "shared-module/framebufferio/__init__.h"
+#include "shared-module/framebufferio/FramebufferDisplay.h"
+
+//| .. currentmodule:: _protomatter
+//|
+//| :class:`protomatter` --  Driver for HUB75-style RGB LED matrices
+//| ================================================================
+//|
+
+extern Protomatter_core *_PM_protoPtr;
+
+STATIC uint8_t validate_pin(mp_obj_t obj) {
+    mcu_pin_obj_t *result = validate_obj_is_free_pin(obj);
+    return common_hal_mcu_pin_number(result);
+}
+
+STATIC void validate_pins(qstr what, uint8_t* pin_nos, mp_int_t max_pins, mp_obj_t seq, uint8_t *count_out) {
+    mp_int_t len = MP_OBJ_SMALL_INT_VALUE(mp_obj_len(seq));
+    if (len > max_pins) {
+        mp_raise_ValueError_varg(translate("At most %d %q may be specified"), max_pins, what);
+    }
+    *count_out = len;
+    for (mp_int_t i=0; i<len; i++) {
+        pin_nos[i] = validate_pin(mp_obj_subscr(seq, MP_OBJ_NEW_SMALL_INT(i), MP_OBJ_SENTINEL));
+    }
+}
+
+STATIC void claim_pin_nr(mp_obj_t pin) {
+    common_hal_mcu_pin_claim(pin);
+    common_hal_never_reset_pin(pin);
+}
+
+STATIC void claim_pins_nr(mp_obj_t seq) {
+    mp_int_t len = MP_OBJ_SMALL_INT_VALUE(mp_obj_len(seq));
+    for (mp_int_t i=0; i<len; i++) {
+        claim_pin_nr(mp_obj_subscr(seq, MP_OBJ_NEW_SMALL_INT(i), MP_OBJ_SENTINEL));
+    }
+}
+
+//| :class:`~_protomatter.Protomatter` displays an in-memory framebuffer to an LED matrix.
+//|
+//| .. class:: Protomatter(width, bit_depth, rgb_pins, addr_pins, clock_pin, latch_pin, oe_pin, *, doublebuffer=True, framebuffer=None)
+//|
+//|   Create a Protomatter object with the given attributes.  The height of
+//|   the display is determined by the number of rgb and address pins:
+//|   len(rgb_pins)/3 * 2 ** len(address_pins).  With 6 RGB pins and 4
+//|   address lines, the display will be 32 pixels tall.
+//|
+//|   Up to 30 RGB pins and 8 address pins are supported.
+//|
+//|   The RGB pins must be within a single "port" and performance and memory
+//|   usage are best when they are all within "close by" bits of the port.
+//|   The clock pin must also be on the same port as the RGB pins.  See the
+//|   documentation of the underlying protomatter C library for more
+//|   information.  Generally, Adafruit's interface boards are designed so
+//|   that these requirements are met when matched with the intended
+//|   microcontroller board.  For instance, the Feather M4 Express works
+//|   together with the RGB Matrix Feather.
+//|
+//|   When specified as True, double buffering can reduce some flickering of
+//|   the matrix; however, this increases memory usage.
+//|
+//|   The framebuffer is in "RGB565" format.  If a framebuffer is not
+//|   passed in, one is allocated and initialized to all black.  To update
+//|   the content, modify the framebuffer and call swapbuffers.
+//|
+//|   If doublebuffer is False, some memory is saved, but the display may
+//|   flicker during updates.
+//|
+//|   If a framebuffer is not passed in, one is allocated internally.  To
+//|   retrieve it, pass the protomatter object to memoryview().
+//|
+
+STATIC mp_obj_t protomatter_protomatter_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+    enum { ARG_width, ARG_bit_depth, ARG_rgb_list, ARG_addr_list,
+        ARG_clock_pin, ARG_latch_pin, ARG_oe_pin, ARG_doublebuffer, ARG_framebuffer };
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_width, MP_ARG_INT | MP_ARG_REQUIRED },
+        { MP_QSTR_bit_depth, MP_ARG_INT | MP_ARG_REQUIRED },
+        { MP_QSTR_rgb_pins, MP_ARG_OBJ | MP_ARG_REQUIRED },
+        { MP_QSTR_addr_pins, MP_ARG_OBJ | MP_ARG_REQUIRED },
+        { MP_QSTR_clock_pin, MP_ARG_OBJ | MP_ARG_REQUIRED },
+        { MP_QSTR_latch_pin, MP_ARG_OBJ | MP_ARG_REQUIRED },
+        { MP_QSTR_oe_pin, MP_ARG_OBJ | MP_ARG_REQUIRED },
+        { MP_QSTR_doublebuffer, MP_ARG_BOOL, { .u_bool = true } },
+        { MP_QSTR_framebuffer, MP_ARG_OBJ, { .u_obj = mp_const_none } },
+    };
+    mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+    mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+    // Because interrupt handlers point directly at protomatter objects,
+    // it is NOT okay to move them to the long-lived pool later.  Allocate
+    // them there to begin with, since generally they'll be long-lived anyway.
+    protomatter_protomatter_obj_t *self = &allocate_display_bus_or_raise()->protomatter;
+    self->base.type = &protomatter_Protomatter_type;
+
+    uint8_t rgb_count, addr_count;
+    uint8_t rgb_pins[MP_ARRAY_SIZE(self->rgb_pins)];
+    uint8_t addr_pins[MP_ARRAY_SIZE(self->addr_pins)];
+    uint8_t clock_pin = validate_pin(args[ARG_clock_pin].u_obj);
+    uint8_t latch_pin = validate_pin(args[ARG_latch_pin].u_obj);
+    uint8_t oe_pin = validate_pin(args[ARG_oe_pin].u_obj);
+
+    validate_pins(MP_QSTR_rgb_pins, rgb_pins, MP_ARRAY_SIZE(self->rgb_pins), args[ARG_rgb_list].u_obj, &rgb_count);
+    validate_pins(MP_QSTR_addr_pins, addr_pins, MP_ARRAY_SIZE(self->addr_pins), args[ARG_addr_list].u_obj, &addr_count);
+
+    mp_obj_t framebuffer = args[ARG_framebuffer].u_obj;
+    if (framebuffer == mp_const_none) {
+        int width = args[ARG_width].u_int;
+        int bufsize = 2 * width * rgb_count / 3 * (1 << addr_count);
+        framebuffer = mp_obj_new_bytearray_of_zeros(bufsize);
+    }
+
+    common_hal_protomatter_protomatter_construct(self,
+        args[ARG_width].u_int,
+        args[ARG_bit_depth].u_int,
+        rgb_count, rgb_pins,
+        addr_count, addr_pins,
+        clock_pin, latch_pin, oe_pin,
+        args[ARG_doublebuffer].u_bool,
+        framebuffer, NULL);
+
+    claim_pins_nr(args[ARG_rgb_list].u_obj);
+    claim_pins_nr(args[ARG_addr_list].u_obj);
+    claim_pin_nr(args[ARG_clock_pin].u_obj);
+    claim_pin_nr(args[ARG_oe_pin].u_obj);
+    claim_pin_nr(args[ARG_latch_pin].u_obj);
+
+    return MP_OBJ_FROM_PTR(self);
+}
+
+//|   .. method:: deinit
+//|
+//|     Free the resources (pins, timers, etc.) associated with this
+//|     protomatter instance.  After deinitialization, no further operations
+//|     may be performed.
+//|
+STATIC mp_obj_t protomatter_protomatter_deinit(mp_obj_t self_in) {
+    protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
+    common_hal_protomatter_protomatter_deinit(self);
+    return mp_const_none;
+}
+
+STATIC MP_DEFINE_CONST_FUN_OBJ_1(protomatter_protomatter_deinit_obj, protomatter_protomatter_deinit);
+
+static void check_for_deinit(protomatter_protomatter_obj_t *self) {
+    if (!self->core.rgbPins) {
+        raise_deinited_error();
+    }
+}
+
+//|   .. attribute:: paused
+//|
+//|     When paused, the matrix is not driven and all its LEDs are unlit.
+//|
+STATIC mp_obj_t protomatter_protomatter_get_paused(mp_obj_t self_in) {
+    protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
+    check_for_deinit(self);
+    return mp_obj_new_bool(self->paused);
+}
+MP_DEFINE_CONST_FUN_OBJ_1(protomatter_protomatter_get_paused_obj, protomatter_protomatter_get_paused);
+
+STATIC mp_obj_t protomatter_protomatter_set_paused(mp_obj_t self_in, mp_obj_t value_in)  {
+    protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
+    check_for_deinit(self);
+    bool paused = mp_obj_is_true(value_in);
+    if (paused && !self->paused) {
+        _PM_stop(&self->core);
+    } else if (!paused && self->paused) {
+        _PM_resume(&self->core);
+    }
+    self->paused = paused;
+
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_2(protomatter_protomatter_set_paused_obj, protomatter_protomatter_set_paused);
+
+const mp_obj_property_t protomatter_protomatter_paused_obj = {
+    .base.type = &mp_type_property,
+    .proxy = {(mp_obj_t)&protomatter_protomatter_get_paused_obj,
+              (mp_obj_t)&protomatter_protomatter_set_paused_obj,
+              (mp_obj_t)&mp_const_none_obj},
+};
+
+//|   .. method:: write(buf)
+//|
+//|     Transmits the color data in the buffer to the pixels so that they are shown.
+//|
+//|     The data in the buffer must be in "RGB565" format.  This means
+//|     that it is organized as a series of 16-bit numbers where the highest 5
+//|     bits are interpreted as red, the next 6 as green, and the final 5 as
+//|     blue.  The object can be any buffer, but `array.array` and `ulab.array`
+//|     objects are most often useful.
+//|
+STATIC mp_obj_t protomatter_protomatter_swapbuffers(mp_obj_t self_in) {
+    protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
+    check_for_deinit(self);
+
+    _PM_convert_565(&self->core, self->bufinfo.buf, self->width);
+    _PM_swapbuffer_maybe(&self->core);
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_1(protomatter_protomatter_swapbuffers_obj, protomatter_protomatter_swapbuffers);
+
+STATIC const mp_rom_map_elem_t protomatter_protomatter_locals_dict_table[] = {
+    { MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&protomatter_protomatter_deinit_obj) },
+    { MP_ROM_QSTR(MP_QSTR_paused), MP_ROM_PTR(&protomatter_protomatter_paused_obj) },
+    { MP_ROM_QSTR(MP_QSTR_swapbuffers), MP_ROM_PTR(&protomatter_protomatter_swapbuffers_obj) },
+};
+STATIC MP_DEFINE_CONST_DICT(protomatter_protomatter_locals_dict, protomatter_protomatter_locals_dict_table);
+
+STATIC void protomatter_protomatter_get_bufinfo(mp_obj_t self_in, mp_buffer_info_t *bufinfo) {
+    protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
+    check_for_deinit(self);
+    
+    *bufinfo = self->bufinfo;
+}
+
+STATIC void protomatter_protomatter_swapbuffers_void(mp_obj_t self_in) {
+    protomatter_protomatter_swapbuffers(self_in);
+}
+
+STATIC void protomatter_protomatter_deinit_void(mp_obj_t self_in) {
+    protomatter_protomatter_deinit(self_in);
+}
+
+STATIC void protomatter_protomatter_set_brightness(mp_obj_t self_in, mp_float_t value) {
+    protomatter_protomatter_set_paused(self_in, mp_obj_new_bool(value <= 0));
+}
+
+STATIC const framebuffer_p_t protomatter_protomatter_proto = {
+    MP_PROTO_IMPLEMENT(MP_QSTR_protocol_framebuffer)
+    .get_bufinfo = protomatter_protomatter_get_bufinfo,
+    .set_brightness = protomatter_protomatter_set_brightness,
+    .swapbuffers = protomatter_protomatter_swapbuffers_void,
+    .deinit = protomatter_protomatter_deinit_void,
+};
+
+STATIC mp_int_t protomatter_protomatter_get_buffer(mp_obj_t self_in, mp_buffer_info_t *bufinfo, mp_uint_t flags) {
+    protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
+    // a readonly framebuffer would be unusual but not impossible
+    if((flags & MP_BUFFER_WRITE) && !(self->bufinfo.typecode & MP_OBJ_ARRAY_TYPECODE_FLAG_RW)) {
+        return 1;
+    }
+    *bufinfo = self->bufinfo;
+    return 0;
+}
+
+const mp_obj_type_t protomatter_Protomatter_type = {
+    { &mp_type_type },
+    .name = MP_QSTR_Protomatter,
+    .buffer_p = { .get_buffer = protomatter_protomatter_get_buffer, },
+    .make_new = protomatter_protomatter_make_new,
+    .protocol = &protomatter_protomatter_proto,
+    .locals_dict = (mp_obj_dict_t*)&protomatter_protomatter_locals_dict,
+};
-- 
cgit v1.2.3


From 89eb45a13c48509a18ecadaacd983e880e17aa9c Mon Sep 17 00:00:00 2001
From: Jeff Epler <jepler@gmail.com>
Date: Thu, 2 Apr 2020 14:22:08 -0500
Subject: use floor division in docstring

Co-Authored-By: Scott Shawcroft <scott@tannewt.org>
---
 shared-bindings/_protomatter/Protomatter.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'shared-bindings/_protomatter/Protomatter.c')

diff --git a/shared-bindings/_protomatter/Protomatter.c b/shared-bindings/_protomatter/Protomatter.c
index 8d0d223bb..cb3ed7c4f 100644
--- a/shared-bindings/_protomatter/Protomatter.c
+++ b/shared-bindings/_protomatter/Protomatter.c
@@ -80,7 +80,7 @@ STATIC void claim_pins_nr(mp_obj_t seq) {
 //|
 //|   Create a Protomatter object with the given attributes.  The height of
 //|   the display is determined by the number of rgb and address pins:
-//|   len(rgb_pins)/3 * 2 ** len(address_pins).  With 6 RGB pins and 4
+//|   len(rgb_pins) // 3 * 2 ** len(address_pins).  With 6 RGB pins and 4
 //|   address lines, the display will be 32 pixels tall.
 //|
 //|   Up to 30 RGB pins and 8 address pins are supported.
-- 
cgit v1.2.3


From 5fcba97a5185bd69c2213b38f6c8fc580dafde23 Mon Sep 17 00:00:00 2001
From: Jeff Epler <jepler@gmail.com>
Date: Fri, 3 Apr 2020 10:50:12 -0500
Subject: Make function name more descriptive

---
 shared-bindings/_protomatter/Protomatter.c | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

(limited to 'shared-bindings/_protomatter/Protomatter.c')

diff --git a/shared-bindings/_protomatter/Protomatter.c b/shared-bindings/_protomatter/Protomatter.c
index cb3ed7c4f..3c790ff7d 100644
--- a/shared-bindings/_protomatter/Protomatter.c
+++ b/shared-bindings/_protomatter/Protomatter.c
@@ -62,15 +62,15 @@ STATIC void validate_pins(qstr what, uint8_t* pin_nos, mp_int_t max_pins, mp_obj
     }
 }
 
-STATIC void claim_pin_nr(mp_obj_t pin) {
+STATIC void claim_and_never_reset_pin(mp_obj_t pin) {
     common_hal_mcu_pin_claim(pin);
     common_hal_never_reset_pin(pin);
 }
 
-STATIC void claim_pins_nr(mp_obj_t seq) {
+STATIC void claim_and_never_reset_pins(mp_obj_t seq) {
     mp_int_t len = MP_OBJ_SMALL_INT_VALUE(mp_obj_len(seq));
     for (mp_int_t i=0; i<len; i++) {
-        claim_pin_nr(mp_obj_subscr(seq, MP_OBJ_NEW_SMALL_INT(i), MP_OBJ_SENTINEL));
+        claim_and_never_reset_pin(mp_obj_subscr(seq, MP_OBJ_NEW_SMALL_INT(i), MP_OBJ_SENTINEL));
     }
 }
 
@@ -157,11 +157,11 @@ STATIC mp_obj_t protomatter_protomatter_make_new(const mp_obj_type_t *type, size
         args[ARG_doublebuffer].u_bool,
         framebuffer, NULL);
 
-    claim_pins_nr(args[ARG_rgb_list].u_obj);
-    claim_pins_nr(args[ARG_addr_list].u_obj);
-    claim_pin_nr(args[ARG_clock_pin].u_obj);
-    claim_pin_nr(args[ARG_oe_pin].u_obj);
-    claim_pin_nr(args[ARG_latch_pin].u_obj);
+    claim_and_never_reset_pins(args[ARG_rgb_list].u_obj);
+    claim_and_never_reset_pins(args[ARG_addr_list].u_obj);
+    claim_and_never_reset_pin(args[ARG_clock_pin].u_obj);
+    claim_and_never_reset_pin(args[ARG_oe_pin].u_obj);
+    claim_and_never_reset_pin(args[ARG_latch_pin].u_obj);
 
     return MP_OBJ_FROM_PTR(self);
 }
-- 
cgit v1.2.3


From a663a7dd30d2cfed78644dcaa6e5ef25566acd82 Mon Sep 17 00:00:00 2001
From: Jeff Epler <jepler@gmail.com>
Date: Fri, 3 Apr 2020 10:52:50 -0500
Subject: _protomatter: move get/set paused into shared-module

---
 shared-bindings/_protomatter/Protomatter.c | 11 +++--------
 shared-bindings/_protomatter/Protomatter.h |  2 ++
 shared-module/_protomatter/Protomatter.c   | 12 ++++++++++++
 3 files changed, 17 insertions(+), 8 deletions(-)

(limited to 'shared-bindings/_protomatter/Protomatter.c')

diff --git a/shared-bindings/_protomatter/Protomatter.c b/shared-bindings/_protomatter/Protomatter.c
index 3c790ff7d..b7b28630d 100644
--- a/shared-bindings/_protomatter/Protomatter.c
+++ b/shared-bindings/_protomatter/Protomatter.c
@@ -193,7 +193,7 @@ static void check_for_deinit(protomatter_protomatter_obj_t *self) {
 STATIC mp_obj_t protomatter_protomatter_get_paused(mp_obj_t self_in) {
     protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
     check_for_deinit(self);
-    return mp_obj_new_bool(self->paused);
+    return mp_obj_new_bool(common_hal_protomatter_protomatter_get_paused(self));
 }
 MP_DEFINE_CONST_FUN_OBJ_1(protomatter_protomatter_get_paused_obj, protomatter_protomatter_get_paused);
 
@@ -201,12 +201,7 @@ STATIC mp_obj_t protomatter_protomatter_set_paused(mp_obj_t self_in, mp_obj_t va
     protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
     check_for_deinit(self);
     bool paused = mp_obj_is_true(value_in);
-    if (paused && !self->paused) {
-        _PM_stop(&self->core);
-    } else if (!paused && self->paused) {
-        _PM_resume(&self->core);
-    }
-    self->paused = paused;
+    common_hal_protomatter_protomatter_set_paused(self, paused);
 
     return mp_const_none;
 }
@@ -262,7 +257,7 @@ STATIC void protomatter_protomatter_deinit_void(mp_obj_t self_in) {
 }
 
 STATIC void protomatter_protomatter_set_brightness(mp_obj_t self_in, mp_float_t value) {
-    protomatter_protomatter_set_paused(self_in, mp_obj_new_bool(value <= 0));
+    common_hal_protomatter_protomatter_set_paused(self_in, value <= 0);
 }
 
 STATIC const framebuffer_p_t protomatter_protomatter_proto = {
diff --git a/shared-bindings/_protomatter/Protomatter.h b/shared-bindings/_protomatter/Protomatter.h
index cacc39a30..0a52c556f 100644
--- a/shared-bindings/_protomatter/Protomatter.h
+++ b/shared-bindings/_protomatter/Protomatter.h
@@ -52,5 +52,7 @@ void common_hal_protomatter_protomatter_construct(protomatter_protomatter_obj_t*
 void common_hal_protomatter_protomatter_deinit(protomatter_protomatter_obj_t*);
 void protomatter_protomatter_collect_ptrs(protomatter_protomatter_obj_t*);
 void common_hal_protomatter_protomatter_reconstruct(protomatter_protomatter_obj_t* self, mp_obj_t framebuffer);
+void common_hal_protomatter_protomatter_set_paused(protomatter_protomatter_obj_t* self, bool paused);
+bool common_hal_protomatter_protomatter_get_paused(protomatter_protomatter_obj_t* self);
 
 #endif
diff --git a/shared-module/_protomatter/Protomatter.c b/shared-module/_protomatter/Protomatter.c
index 59dac3e6d..9f67bfad3 100644
--- a/shared-module/_protomatter/Protomatter.c
+++ b/shared-module/_protomatter/Protomatter.c
@@ -180,3 +180,15 @@ void protomatter_protomatter_collect_ptrs(protomatter_protomatter_obj_t* self) {
     gc_collect_ptr(self->core.screenData);
 }
 
+void common_hal_protomatter_protomatter_set_paused(protomatter_protomatter_obj_t* self, bool paused) {
+    if (paused && !self->paused) {
+        _PM_stop(&self->core);
+    } else if (!paused && self->paused) {
+        _PM_resume(&self->core);
+    }
+    self->paused = paused;
+}
+
+bool common_hal_protomatter_protomatter_get_paused(protomatter_protomatter_obj_t* self) {
+    return self->paused;
+}
-- 
cgit v1.2.3


From 50219862e13f60aadb0515a01131d7909bb07def Mon Sep 17 00:00:00 2001
From: Jeff Epler <jepler@gmail.com>
Date: Fri, 3 Apr 2020 10:54:15 -0500
Subject: protomatter: make docstring match implementation

---
 shared-bindings/_protomatter/Protomatter.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'shared-bindings/_protomatter/Protomatter.c')

diff --git a/shared-bindings/_protomatter/Protomatter.c b/shared-bindings/_protomatter/Protomatter.c
index b7b28630d..d5f9aa1ae 100644
--- a/shared-bindings/_protomatter/Protomatter.c
+++ b/shared-bindings/_protomatter/Protomatter.c
@@ -214,7 +214,7 @@ const mp_obj_property_t protomatter_protomatter_paused_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. method:: write(buf)
+//|   .. method:: swapbuffers()
 //|
 //|     Transmits the color data in the buffer to the pixels so that they are shown.
 //|
-- 
cgit v1.2.3


From 9019710a1e75d4042d37dd3285d06e3f24aec449 Mon Sep 17 00:00:00 2001
From: Jeff Epler <jepler@gmail.com>
Date: Thu, 9 Apr 2020 09:11:37 -0500
Subject: protomatter: improve an error message

---
 shared-bindings/_protomatter/Protomatter.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'shared-bindings/_protomatter/Protomatter.c')

diff --git a/shared-bindings/_protomatter/Protomatter.c b/shared-bindings/_protomatter/Protomatter.c
index d5f9aa1ae..f3de6a86e 100644
--- a/shared-bindings/_protomatter/Protomatter.c
+++ b/shared-bindings/_protomatter/Protomatter.c
@@ -54,7 +54,7 @@ STATIC uint8_t validate_pin(mp_obj_t obj) {
 STATIC void validate_pins(qstr what, uint8_t* pin_nos, mp_int_t max_pins, mp_obj_t seq, uint8_t *count_out) {
     mp_int_t len = MP_OBJ_SMALL_INT_VALUE(mp_obj_len(seq));
     if (len > max_pins) {
-        mp_raise_ValueError_varg(translate("At most %d %q may be specified"), max_pins, what);
+        mp_raise_ValueError_varg(translate("At most %d %q may be specified (not %d)"), max_pins, what, len);
     }
     *count_out = len;
     for (mp_int_t i=0; i<len; i++) {
-- 
cgit v1.2.3


From 4a05e938ed8bd33f0ec3204d988fa6948e1e11d2 Mon Sep 17 00:00:00 2001
From: Jeff Epler <jepler@gmail.com>
Date: Fri, 10 Apr 2020 08:45:37 -0500
Subject: protomatter: validate pins to give better error message

The numbered error from the underlying library is not helpful for
beginning users
---
 shared-bindings/_protomatter/Protomatter.c | 61 ++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)

(limited to 'shared-bindings/_protomatter/Protomatter.c')

diff --git a/shared-bindings/_protomatter/Protomatter.c b/shared-bindings/_protomatter/Protomatter.c
index f3de6a86e..88974e658 100644
--- a/shared-bindings/_protomatter/Protomatter.c
+++ b/shared-bindings/_protomatter/Protomatter.c
@@ -74,6 +74,65 @@ STATIC void claim_and_never_reset_pins(mp_obj_t seq) {
     }
 }
 
+STATIC void preflight_pins_or_throw(uint8_t clock_pin, uint8_t *rgb_pins, uint8_t rgb_pin_count, bool allow_inefficient) {
+    uint32_t port = clock_pin / 32;
+    uint32_t bit_mask = 1 << (clock_pin % 32);
+
+    for (uint8_t i = 0; i < rgb_pin_count; i++) {
+        uint32_t pin_port = rgb_pins[i] / 32;
+
+        if (pin_port != port) {
+            mp_raise_ValueError_varg(
+                translate("rgb_pins[%d] is not on the same port as clock"), i);
+        }
+
+        uint32_t pin_mask = 1 << (rgb_pins[i] % 32);
+        if (pin_mask & bit_mask) {
+            mp_raise_ValueError_varg(
+                translate("rgb_pins[%d] duplicates another pin assignment"), i);
+        }
+
+        bit_mask |= pin_mask;
+    }
+
+    if (allow_inefficient) {
+        return;
+    }
+
+    uint8_t byte_mask = 0;
+    if (bit_mask & 0x000000FF) byte_mask |= 0b0001;
+    if (bit_mask & 0x0000FF00) byte_mask |= 0b0010;
+    if (bit_mask & 0x00FF0000) byte_mask |= 0b0100;
+    if (bit_mask & 0xFF000000) byte_mask |= 0b1000;
+
+    uint8_t bytes_per_element = 0xff;
+    uint8_t ideal_bytes_per_element = (rgb_pin_count + 7) / 8;
+
+    switch(byte_mask) {
+        case 0b0001:
+        case 0b0010:
+        case 0b0100:
+        case 0b1000:
+            bytes_per_element = 1;
+            break;
+
+        case 0b0011:
+        case 0b1100:
+            bytes_per_element = 2;
+            break;
+
+        default:
+            bytes_per_element = 4;
+            break;
+    }
+
+    if (bytes_per_element != ideal_bytes_per_element) {
+        mp_raise_ValueError_varg(
+            translate("Pinout uses %d bytes per element, which consumes more than the ideal %d bytes.  If this cannot be avoided, pass allow_inefficient=True to the constructor"),
+            bytes_per_element, ideal_bytes_per_element);
+    }
+}
+
 //| :class:`~_protomatter.Protomatter` displays an in-memory framebuffer to an LED matrix.
 //|
 //| .. class:: Protomatter(width, bit_depth, rgb_pins, addr_pins, clock_pin, latch_pin, oe_pin, *, doublebuffer=True, framebuffer=None)
@@ -141,6 +200,8 @@ STATIC mp_obj_t protomatter_protomatter_make_new(const mp_obj_type_t *type, size
     validate_pins(MP_QSTR_rgb_pins, rgb_pins, MP_ARRAY_SIZE(self->rgb_pins), args[ARG_rgb_list].u_obj, &rgb_count);
     validate_pins(MP_QSTR_addr_pins, addr_pins, MP_ARRAY_SIZE(self->addr_pins), args[ARG_addr_list].u_obj, &addr_count);
 
+    preflight_pins_or_throw(clock_pin, rgb_pins, rgb_count, true);
+
     mp_obj_t framebuffer = args[ARG_framebuffer].u_obj;
     if (framebuffer == mp_const_none) {
         int width = args[ARG_width].u_int;
-- 
cgit v1.2.3


From 129c6369cfd510b12e5f8ae1d9c9a51853f1b498 Mon Sep 17 00:00:00 2001
From: Jeff Epler <jepler@gmail.com>
Date: Fri, 10 Apr 2020 08:45:42 -0500
Subject: protomatter: code style

---
 shared-bindings/_protomatter/Protomatter.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'shared-bindings/_protomatter/Protomatter.c')

diff --git a/shared-bindings/_protomatter/Protomatter.c b/shared-bindings/_protomatter/Protomatter.c
index 88974e658..f6ac19188 100644
--- a/shared-bindings/_protomatter/Protomatter.c
+++ b/shared-bindings/_protomatter/Protomatter.c
@@ -332,7 +332,7 @@ STATIC const framebuffer_p_t protomatter_protomatter_proto = {
 STATIC mp_int_t protomatter_protomatter_get_buffer(mp_obj_t self_in, mp_buffer_info_t *bufinfo, mp_uint_t flags) {
     protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
     // a readonly framebuffer would be unusual but not impossible
-    if((flags & MP_BUFFER_WRITE) && !(self->bufinfo.typecode & MP_OBJ_ARRAY_TYPECODE_FLAG_RW)) {
+    if ((flags & MP_BUFFER_WRITE) && !(self->bufinfo.typecode & MP_OBJ_ARRAY_TYPECODE_FLAG_RW)) {
         return 1;
     }
     *bufinfo = self->bufinfo;
-- 
cgit v1.2.3


From ba20bc8b4322373ec9ed55ed9f299675ea2801f8 Mon Sep 17 00:00:00 2001
From: Jeff Epler <jepler@gmail.com>
Date: Fri, 10 Apr 2020 09:07:06 -0500
Subject: framebufferio: move backlight down to the underlying framebuffer

---
 shared-bindings/_protomatter/Protomatter.c         |  3 +-
 shared-bindings/framebufferio/FramebufferDisplay.c | 17 ++----
 shared-bindings/framebufferio/FramebufferDisplay.h |  3 +-
 shared-module/framebufferio/FramebufferDisplay.c   | 65 +++++-----------------
 shared-module/framebufferio/FramebufferDisplay.h   | 15 +++--
 5 files changed, 28 insertions(+), 75 deletions(-)

(limited to 'shared-bindings/_protomatter/Protomatter.c')

diff --git a/shared-bindings/_protomatter/Protomatter.c b/shared-bindings/_protomatter/Protomatter.c
index f6ac19188..50480004c 100644
--- a/shared-bindings/_protomatter/Protomatter.c
+++ b/shared-bindings/_protomatter/Protomatter.c
@@ -317,8 +317,9 @@ STATIC void protomatter_protomatter_deinit_void(mp_obj_t self_in) {
     protomatter_protomatter_deinit(self_in);
 }
 
-STATIC void protomatter_protomatter_set_brightness(mp_obj_t self_in, mp_float_t value) {
+STATIC bool protomatter_protomatter_set_brightness(mp_obj_t self_in, mp_float_t value) {
     common_hal_protomatter_protomatter_set_paused(self_in, value <= 0);
+    return true;
 }
 
 STATIC const framebuffer_p_t protomatter_protomatter_proto = {
diff --git a/shared-bindings/framebufferio/FramebufferDisplay.c b/shared-bindings/framebufferio/FramebufferDisplay.c
index 9b761dd2d..538d3afb4 100644
--- a/shared-bindings/framebufferio/FramebufferDisplay.c
+++ b/shared-bindings/framebufferio/FramebufferDisplay.c
@@ -67,7 +67,7 @@
 //|   :param int native_frames_per_second: Number of display refreshes per second
 //|
 STATIC mp_obj_t framebufferio_framebufferdisplay_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
-    enum { ARG_framebuffer, ARG_width, ARG_height, ARG_rotation, ARG_color_depth, ARG_bytes_per_cell, ARG_backlight_pin, ARG_brightness, ARG_auto_brightness, ARG_auto_refresh, ARG_native_frames_per_second, NUM_ARGS };
+    enum { ARG_framebuffer, ARG_width, ARG_height, ARG_rotation, ARG_color_depth, ARG_bytes_per_cell, ARG_auto_refresh, ARG_native_frames_per_second, NUM_ARGS };
     static const mp_arg_t allowed_args[] = {
         { MP_QSTR_framebuffer, MP_ARG_REQUIRED | MP_ARG_OBJ },
         { MP_QSTR_width, MP_ARG_INT | MP_ARG_KW_ONLY | MP_ARG_REQUIRED, },
@@ -75,9 +75,6 @@ STATIC mp_obj_t framebufferio_framebufferdisplay_make_new(const mp_obj_type_t *t
         { MP_QSTR_rotation, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 0} },
         { MP_QSTR_color_depth, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 16} },
         { MP_QSTR_bytes_per_cell, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 1} },
-        { MP_QSTR_backlight_pin, MP_ARG_OBJ | MP_ARG_KW_ONLY, {.u_obj = mp_const_none} },
-        { MP_QSTR_brightness, MP_ARG_OBJ | MP_ARG_KW_ONLY, {.u_obj = MP_OBJ_NEW_SMALL_INT(1)} },
-        { MP_QSTR_auto_brightness, MP_ARG_BOOL | MP_ARG_KW_ONLY, {.u_bool = false} },
         { MP_QSTR_auto_refresh, MP_ARG_BOOL | MP_ARG_KW_ONLY, {.u_bool = true} },
         { MP_QSTR_native_frames_per_second, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 60} },
     };
@@ -87,10 +84,6 @@ STATIC mp_obj_t framebufferio_framebufferdisplay_make_new(const mp_obj_type_t *t
 
     mp_obj_t framebuffer = args[ARG_framebuffer].u_obj;
 
-    const mcu_pin_obj_t* backlight_pin = validate_obj_is_free_pin_or_none(args[ARG_backlight_pin].u_obj);
-
-    mp_float_t brightness = mp_obj_get_float(args[ARG_brightness].u_obj);
-
     mp_int_t rotation = args[ARG_rotation].u_int;
     if (rotation % 90 != 0) {
         mp_raise_ValueError(translate("Display rotation must be in 90 degree increments"));
@@ -106,9 +99,6 @@ STATIC mp_obj_t framebufferio_framebufferdisplay_make_new(const mp_obj_type_t *t
         rotation,
         args[ARG_color_depth].u_int,
         args[ARG_bytes_per_cell].u_int,
-        MP_OBJ_TO_PTR(backlight_pin),
-        brightness,
-        args[ARG_auto_brightness].u_bool,
         args[ARG_auto_refresh].u_bool,
         args[ARG_native_frames_per_second].u_int
         );
@@ -260,7 +250,10 @@ MP_DEFINE_CONST_FUN_OBJ_1(framebufferio_framebufferdisplay_get_auto_brightness_o
 STATIC mp_obj_t framebufferio_framebufferdisplay_obj_set_auto_brightness(mp_obj_t self_in, mp_obj_t auto_brightness) {
     framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
 
-    common_hal_framebufferio_framebufferdisplay_set_auto_brightness(self, mp_obj_is_true(auto_brightness));
+    bool ok = common_hal_framebufferio_framebufferdisplay_set_auto_brightness(self, mp_obj_is_true(auto_brightness));
+    if (!ok) {
+        mp_raise_RuntimeError(translate("Brightness not adjustable"));
+    }
 
     return mp_const_none;
 }
diff --git a/shared-bindings/framebufferio/FramebufferDisplay.h b/shared-bindings/framebufferio/FramebufferDisplay.h
index b63439e0c..56ef8abc4 100644
--- a/shared-bindings/framebufferio/FramebufferDisplay.h
+++ b/shared-bindings/framebufferio/FramebufferDisplay.h
@@ -42,7 +42,6 @@ void common_hal_framebufferio_framebufferdisplay_construct(framebufferio_framebu
         mp_obj_t framebuffer, uint16_t width, uint16_t height,
         uint16_t rotation, uint16_t color_depth,
         uint8_t bytes_per_cell,
-        const mcu_pin_obj_t* backlight_pin, mp_float_t brightness, bool auto_brightness,
         bool auto_refresh, uint16_t native_frames_per_second);
 
 bool common_hal_framebufferio_framebufferdisplay_show(framebufferio_framebufferdisplay_obj_t* self,
@@ -59,7 +58,7 @@ uint16_t common_hal_framebufferio_framebufferdisplay_get_rotation(framebufferio_
 void common_hal_framebufferio_framebufferdisplay_set_rotation(framebufferio_framebufferdisplay_obj_t* self, int rotation);
 
 bool common_hal_framebufferio_framebufferdisplay_get_auto_brightness(framebufferio_framebufferdisplay_obj_t* self);
-void common_hal_framebufferio_framebufferdisplay_set_auto_brightness(framebufferio_framebufferdisplay_obj_t* self, bool auto_brightness);
+bool common_hal_framebufferio_framebufferdisplay_set_auto_brightness(framebufferio_framebufferdisplay_obj_t* self, bool auto_brightness);
 
 bool common_hal_framebufferio_framebufferdisplay_get_dither(framebufferio_framebufferdisplay_obj_t* self);
 void common_hal_framebufferio_framebufferdisplay_set_dither(framebufferio_framebufferdisplay_obj_t* self, bool dither);
diff --git a/shared-module/framebufferio/FramebufferDisplay.c b/shared-module/framebufferio/FramebufferDisplay.c
index ec2fe7b31..bd0764e8e 100644
--- a/shared-module/framebufferio/FramebufferDisplay.c
+++ b/shared-module/framebufferio/FramebufferDisplay.c
@@ -45,7 +45,6 @@ void common_hal_framebufferio_framebufferdisplay_construct(framebufferio_framebu
         mp_obj_t framebuffer, uint16_t width, uint16_t height,
         uint16_t rotation, uint16_t color_depth,
         uint8_t bytes_per_cell,
-        const mcu_pin_obj_t* backlight_pin, mp_float_t brightness, bool auto_brightness,
         bool auto_refresh, uint16_t native_frames_per_second) {
     // Turn off auto-refresh as we init.
     self->auto_refresh = false;
@@ -58,7 +57,6 @@ void common_hal_framebufferio_framebufferdisplay_construct(framebufferio_framebu
     displayio_display_core_construct(&self->core, NULL, width, height, ram_width, ram_height, 0, 0, rotation,
         color_depth, false, false, bytes_per_cell, false, false);
 
-    self->auto_brightness = auto_brightness;
     self->first_manual_refresh = !auto_refresh;
 
     self->native_frames_per_second = native_frames_per_second;
@@ -66,25 +64,6 @@ void common_hal_framebufferio_framebufferdisplay_construct(framebufferio_framebu
 
     supervisor_start_terminal(width, height);
 
-    // Always set the backlight type in case we're reusing memory.
-    self->backlight_inout.base.type = &mp_type_NoneType;
-    if (backlight_pin != NULL && common_hal_mcu_pin_is_free(backlight_pin)) {
-        pwmout_result_t result = common_hal_pulseio_pwmout_construct(&self->backlight_pwm, backlight_pin, 0, 50000, false);
-        if (result != PWMOUT_OK) {
-            self->backlight_inout.base.type = &digitalio_digitalinout_type;
-            common_hal_digitalio_digitalinout_construct(&self->backlight_inout, backlight_pin);
-            common_hal_never_reset_pin(backlight_pin);
-        } else {
-            self->backlight_pwm.base.type = &pulseio_pwmout_type;
-            common_hal_pulseio_pwmout_never_reset(&self->backlight_pwm);
-        }
-    }
-    if (!self->auto_brightness && (self->framebuffer_protocol->set_brightness != NULL || self->backlight_inout.base.type != &mp_type_NoneType)) {
-        common_hal_framebufferio_framebufferdisplay_set_brightness(self, brightness);
-    } else {
-        self->current_brightness = -1.0;
-    }
-
     // Set the group after initialization otherwise we may send pixels while we delay in
     // initialization.
     common_hal_framebufferio_framebufferdisplay_show(self, &circuitpython_splash);
@@ -104,33 +83,31 @@ uint16_t common_hal_framebufferio_framebufferdisplay_get_height(framebufferio_fr
 }
 
 bool common_hal_framebufferio_framebufferdisplay_get_auto_brightness(framebufferio_framebufferdisplay_obj_t* self) {
-    return self->auto_brightness;
+    if (self->framebuffer_protocol->get_auto_brightness) {
+        return self->framebuffer_protocol->get_auto_brightness(self->framebuffer);
+    }
+    return true;
 }
 
-void common_hal_framebufferio_framebufferdisplay_set_auto_brightness(framebufferio_framebufferdisplay_obj_t* self, bool auto_brightness) {
-    self->auto_brightness = auto_brightness;
+bool common_hal_framebufferio_framebufferdisplay_set_auto_brightness(framebufferio_framebufferdisplay_obj_t* self, bool auto_brightness) {
+    if (self->framebuffer_protocol->set_auto_brightness) {
+        return self->framebuffer_protocol->set_auto_brightness(self->framebuffer, auto_brightness);
+    }
+    return false;
 }
 
 mp_float_t common_hal_framebufferio_framebufferdisplay_get_brightness(framebufferio_framebufferdisplay_obj_t* self) {
-    return self->current_brightness;
+    if (self->framebuffer_protocol->set_brightness) {
+        return self->framebuffer_protocol->get_brightness(self->framebuffer);
+    }
+    return -1;
 }
 
 bool common_hal_framebufferio_framebufferdisplay_set_brightness(framebufferio_framebufferdisplay_obj_t* self, mp_float_t brightness) {
-    self->updating_backlight = true;
     bool ok = false;
     if (self->framebuffer_protocol->set_brightness) {
         self->framebuffer_protocol->set_brightness(self->framebuffer, brightness);
         ok = true;
-    } else if (self->backlight_pwm.base.type == &pulseio_pwmout_type) {
-        common_hal_pulseio_pwmout_set_duty_cycle(&self->backlight_pwm, (uint16_t) (0xffff * brightness));
-        ok = true;
-    } else if (self->backlight_inout.base.type == &digitalio_digitalinout_type) {
-        common_hal_digitalio_digitalinout_set_value(&self->backlight_inout, brightness > 0.99);
-        ok = true;
-    }
-    self->updating_backlight = false;
-    if (ok) {
-        self->current_brightness = brightness;
     }
     return ok;
 }
@@ -295,17 +272,8 @@ void common_hal_framebufferio_framebufferdisplay_set_auto_refresh(framebufferio_
 }
 
 STATIC void _update_backlight(framebufferio_framebufferdisplay_obj_t* self) {
-    if (!self->auto_brightness || self->updating_backlight) {
-        return;
-    }
-    if (supervisor_ticks_ms64() - self->last_backlight_refresh < 100) {
-        return;
-    }
     // TODO(tannewt): Fade the backlight based on it's existing value and a target value. The target
     // should account for ambient light when possible.
-    common_hal_framebufferio_framebufferdisplay_set_brightness(self, 1.0);
-
-    self->last_backlight_refresh = supervisor_ticks_ms64();
 }
 
 void framebufferio_framebufferdisplay_background(framebufferio_framebufferdisplay_obj_t* self) {
@@ -318,18 +286,11 @@ void framebufferio_framebufferdisplay_background(framebufferio_framebufferdispla
 
 void release_framebufferdisplay(framebufferio_framebufferdisplay_obj_t* self) {
     release_display_core(&self->core);
-    if (self->backlight_pwm.base.type == &pulseio_pwmout_type) {
-        common_hal_pulseio_pwmout_reset_ok(&self->backlight_pwm);
-        common_hal_pulseio_pwmout_deinit(&self->backlight_pwm);
-    } else if (self->backlight_inout.base.type == &digitalio_digitalinout_type) {
-        common_hal_digitalio_digitalinout_deinit(&self->backlight_inout);
-    }
     self->framebuffer_protocol->deinit(self->framebuffer);
 }
 
 void reset_framebufferdisplay(framebufferio_framebufferdisplay_obj_t* self) {
     self->auto_refresh = true;
-    self->auto_brightness = true;
     common_hal_framebufferio_framebufferdisplay_show(self, NULL);
 }
 
diff --git a/shared-module/framebufferio/FramebufferDisplay.h b/shared-module/framebufferio/FramebufferDisplay.h
index a5c8607bb..a7b91a522 100644
--- a/shared-module/framebufferio/FramebufferDisplay.h
+++ b/shared-module/framebufferio/FramebufferDisplay.h
@@ -40,22 +40,15 @@
 typedef struct {
     mp_obj_base_t base;
     displayio_display_core_t core;
-    union {
-        digitalio_digitalinout_obj_t backlight_inout;
-        pulseio_pwmout_obj_t backlight_pwm;
-    };
     mp_obj_t framebuffer;
     const struct _framebuffer_p_t *framebuffer_protocol;
     mp_buffer_info_t bufinfo;
     uint64_t last_backlight_refresh;
     uint64_t last_refresh_call;
-    mp_float_t current_brightness;
     uint16_t native_frames_per_second;
     uint16_t native_ms_per_frame;
     bool auto_refresh;
     bool first_manual_refresh;
-    bool auto_brightness;
-    bool updating_backlight;
 } framebufferio_framebufferdisplay_obj_t;
 
 void framebufferio_framebufferdisplay_background(framebufferio_framebufferdisplay_obj_t* self);
@@ -69,14 +62,20 @@ mp_obj_t common_hal_framebufferio_framebufferdisplay_get_framebuffer(framebuffer
 typedef void (*framebuffer_get_bufinfo_fun)(mp_obj_t, mp_buffer_info_t *bufinfo);
 typedef void (*framebuffer_swapbuffers_fun)(mp_obj_t);
 typedef void (*framebuffer_deinit_fun)(mp_obj_t);
-typedef void (*framebuffer_set_brightness_fun)(mp_obj_t, mp_float_t);
+typedef bool (*framebuffer_set_brightness_fun)(mp_obj_t, mp_float_t);
+typedef mp_float_t (*framebuffer_get_brightness_fun)(mp_obj_t);
+typedef bool (*framebuffer_set_auto_brightness_fun)(mp_obj_t, bool);
+typedef bool (*framebuffer_get_auto_brightness_fun)(mp_obj_t);
 
 typedef struct _framebuffer_p_t {
     MP_PROTOCOL_HEAD // MP_QSTR_protocol_framebuffer
     framebuffer_get_bufinfo_fun get_bufinfo;
     framebuffer_swapbuffers_fun swapbuffers;
     framebuffer_deinit_fun deinit;
+    framebuffer_get_brightness_fun get_brightness;
     framebuffer_set_brightness_fun set_brightness;
+    framebuffer_get_auto_brightness_fun get_auto_brightness;
+    framebuffer_set_auto_brightness_fun set_auto_brightness;
 } framebuffer_p_t;
 
 #endif // MICROPY_INCLUDED_SHARED_MODULE_DISPLAYIO_FRAMEBUFFERDISPLAY_H
-- 
cgit v1.2.3


From 5d328c3b449dbd0eaf40c2edc205fb7c5d381589 Mon Sep 17 00:00:00 2001
From: Jeff Epler <jepler@gmail.com>
Date: Fri, 10 Apr 2020 09:07:16 -0500
Subject: protomatter: clarify by comment why these functions exist

---
 shared-bindings/_protomatter/Protomatter.c | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'shared-bindings/_protomatter/Protomatter.c')

diff --git a/shared-bindings/_protomatter/Protomatter.c b/shared-bindings/_protomatter/Protomatter.c
index 50480004c..3b3fdae8c 100644
--- a/shared-bindings/_protomatter/Protomatter.c
+++ b/shared-bindings/_protomatter/Protomatter.c
@@ -309,10 +309,12 @@ STATIC void protomatter_protomatter_get_bufinfo(mp_obj_t self_in, mp_buffer_info
     *bufinfo = self->bufinfo;
 }
 
+// This version exists so that the return value of the function can be none, matching the protocol
 STATIC void protomatter_protomatter_swapbuffers_void(mp_obj_t self_in) {
     protomatter_protomatter_swapbuffers(self_in);
 }
 
+// This version exists so that the return value of the function can be none, matching the protocol
 STATIC void protomatter_protomatter_deinit_void(mp_obj_t self_in) {
     protomatter_protomatter_deinit(self_in);
 }
-- 
cgit v1.2.3


From 880fff80e904ef4b173d551742b7acde56114f0c Mon Sep 17 00:00:00 2001
From: Jeff Epler <jepler@gmail.com>
Date: Mon, 13 Apr 2020 08:51:35 -0500
Subject: protomatter: Respond to review comments

 - rename oe_pin -> output_enable_pin
 - improve and reorganize docstrings
 - rename swapbuffers->refresh
 - rename "paused" -> "brightness", change semantics slightly
 - common_hal several functions
 - clarify why the common_hal routines can't be used directly in the
   protocol's function pointers
 - whitespace cleanups
 - remove prototypes for nonexistent functions
---
 shared-bindings/_protomatter/Protomatter.c         | 108 +++++++++++----------
 shared-bindings/_protomatter/Protomatter.h         |   1 +
 shared-bindings/framebufferio/FramebufferDisplay.c |   2 +-
 shared-bindings/framebufferio/FramebufferDisplay.h |   3 -
 shared-module/_protomatter/Protomatter.c           |  10 +-
 shared-module/_protomatter/allocator.h             |   4 +-
 6 files changed, 71 insertions(+), 57 deletions(-)

(limited to 'shared-bindings/_protomatter/Protomatter.c')

diff --git a/shared-bindings/_protomatter/Protomatter.c b/shared-bindings/_protomatter/Protomatter.c
index 3b3fdae8c..cfc0ba6ed 100644
--- a/shared-bindings/_protomatter/Protomatter.c
+++ b/shared-bindings/_protomatter/Protomatter.c
@@ -135,7 +135,7 @@ STATIC void preflight_pins_or_throw(uint8_t clock_pin, uint8_t *rgb_pins, uint8_
 
 //| :class:`~_protomatter.Protomatter` displays an in-memory framebuffer to an LED matrix.
 //|
-//| .. class:: Protomatter(width, bit_depth, rgb_pins, addr_pins, clock_pin, latch_pin, oe_pin, *, doublebuffer=True, framebuffer=None)
+//| .. class:: Protomatter(width, bit_depth, rgb_pins, addr_pins, clock_pin, latch_pin, output_enable_pin, *, doublebuffer=True, framebuffer=None)
 //|
 //|   Create a Protomatter object with the given attributes.  The height of
 //|   the display is determined by the number of rgb and address pins:
@@ -153,12 +153,17 @@ STATIC void preflight_pins_or_throw(uint8_t clock_pin, uint8_t *rgb_pins, uint8_
 //|   microcontroller board.  For instance, the Feather M4 Express works
 //|   together with the RGB Matrix Feather.
 //|
-//|   When specified as True, double buffering can reduce some flickering of
-//|   the matrix; however, this increases memory usage.
+//|   The framebuffer is in "RGB565" format.
 //|
-//|   The framebuffer is in "RGB565" format.  If a framebuffer is not
-//|   passed in, one is allocated and initialized to all black.  To update
-//|   the content, modify the framebuffer and call swapbuffers.
+//|   "RGB565" means that it is organized as a series of 16-bit numbers
+//|   where the highest 5 bits are interpreted as red, the next 6 as
+//|   green, and the final 5 as blue.  The object can be any buffer, but
+//|   `array.array` and `ulab.array` objects are most often useful.
+//|   To update the content, modify the framebuffer and call refresh.
+//|
+//|   If a framebuffer is not passed in, one is allocated and initialized
+//|   to all black.  In any case, the framebuffer can be retrieved
+//|   by passing the protomatter object to memoryview().
 //|
 //|   If doublebuffer is False, some memory is saved, but the display may
 //|   flicker during updates.
@@ -166,10 +171,13 @@ STATIC void preflight_pins_or_throw(uint8_t clock_pin, uint8_t *rgb_pins, uint8_
 //|   If a framebuffer is not passed in, one is allocated internally.  To
 //|   retrieve it, pass the protomatter object to memoryview().
 //|
+//|   A Protomatter framebuffer is often used in conjunction with a
+//|   `framebufferio.FramebufferDisplay`.
+//|
 
 STATIC mp_obj_t protomatter_protomatter_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_width, ARG_bit_depth, ARG_rgb_list, ARG_addr_list,
-        ARG_clock_pin, ARG_latch_pin, ARG_oe_pin, ARG_doublebuffer, ARG_framebuffer };
+        ARG_clock_pin, ARG_latch_pin, ARG_output_enable_pin, ARG_doublebuffer, ARG_framebuffer };
     static const mp_arg_t allowed_args[] = {
         { MP_QSTR_width, MP_ARG_INT | MP_ARG_REQUIRED },
         { MP_QSTR_bit_depth, MP_ARG_INT | MP_ARG_REQUIRED },
@@ -177,7 +185,7 @@ STATIC mp_obj_t protomatter_protomatter_make_new(const mp_obj_type_t *type, size
         { MP_QSTR_addr_pins, MP_ARG_OBJ | MP_ARG_REQUIRED },
         { MP_QSTR_clock_pin, MP_ARG_OBJ | MP_ARG_REQUIRED },
         { MP_QSTR_latch_pin, MP_ARG_OBJ | MP_ARG_REQUIRED },
-        { MP_QSTR_oe_pin, MP_ARG_OBJ | MP_ARG_REQUIRED },
+        { MP_QSTR_output_enable_pin, MP_ARG_OBJ | MP_ARG_REQUIRED },
         { MP_QSTR_doublebuffer, MP_ARG_BOOL, { .u_bool = true } },
         { MP_QSTR_framebuffer, MP_ARG_OBJ, { .u_obj = mp_const_none } },
     };
@@ -195,7 +203,7 @@ STATIC mp_obj_t protomatter_protomatter_make_new(const mp_obj_type_t *type, size
     uint8_t addr_pins[MP_ARRAY_SIZE(self->addr_pins)];
     uint8_t clock_pin = validate_pin(args[ARG_clock_pin].u_obj);
     uint8_t latch_pin = validate_pin(args[ARG_latch_pin].u_obj);
-    uint8_t oe_pin = validate_pin(args[ARG_oe_pin].u_obj);
+    uint8_t output_enable_pin = validate_pin(args[ARG_output_enable_pin].u_obj);
 
     validate_pins(MP_QSTR_rgb_pins, rgb_pins, MP_ARRAY_SIZE(self->rgb_pins), args[ARG_rgb_list].u_obj, &rgb_count);
     validate_pins(MP_QSTR_addr_pins, addr_pins, MP_ARRAY_SIZE(self->addr_pins), args[ARG_addr_list].u_obj, &addr_count);
@@ -214,14 +222,14 @@ STATIC mp_obj_t protomatter_protomatter_make_new(const mp_obj_type_t *type, size
         args[ARG_bit_depth].u_int,
         rgb_count, rgb_pins,
         addr_count, addr_pins,
-        clock_pin, latch_pin, oe_pin,
+        clock_pin, latch_pin, output_enable_pin,
         args[ARG_doublebuffer].u_bool,
         framebuffer, NULL);
 
     claim_and_never_reset_pins(args[ARG_rgb_list].u_obj);
     claim_and_never_reset_pins(args[ARG_addr_list].u_obj);
     claim_and_never_reset_pin(args[ARG_clock_pin].u_obj);
-    claim_and_never_reset_pin(args[ARG_oe_pin].u_obj);
+    claim_and_never_reset_pin(args[ARG_output_enable_pin].u_obj);
     claim_and_never_reset_pin(args[ARG_latch_pin].u_obj);
 
     return MP_OBJ_FROM_PTR(self);
@@ -247,79 +255,80 @@ static void check_for_deinit(protomatter_protomatter_obj_t *self) {
     }
 }
 
-//|   .. attribute:: paused
+//|   .. attribute:: brightness
 //|
-//|     When paused, the matrix is not driven and all its LEDs are unlit.
+//|     In the current implementation, 0.0 turns the display off entirely
+//|     and any other value up to 1.0 turns the display on fully.
 //|
-STATIC mp_obj_t protomatter_protomatter_get_paused(mp_obj_t self_in) {
+STATIC mp_obj_t protomatter_protomatter_get_brightness(mp_obj_t self_in) {
     protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
     check_for_deinit(self);
-    return mp_obj_new_bool(common_hal_protomatter_protomatter_get_paused(self));
+    return mp_obj_new_float(common_hal_protomatter_protomatter_get_paused(self)? 0.0f : 1.0f);
 }
-MP_DEFINE_CONST_FUN_OBJ_1(protomatter_protomatter_get_paused_obj, protomatter_protomatter_get_paused);
+MP_DEFINE_CONST_FUN_OBJ_1(protomatter_protomatter_get_brightness_obj, protomatter_protomatter_get_brightness);
 
-STATIC mp_obj_t protomatter_protomatter_set_paused(mp_obj_t self_in, mp_obj_t value_in)  {
+STATIC mp_obj_t protomatter_protomatter_set_brightness(mp_obj_t self_in, mp_obj_t value_in)  {
     protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
     check_for_deinit(self);
-    bool paused = mp_obj_is_true(value_in);
-    common_hal_protomatter_protomatter_set_paused(self, paused);
+    mp_float_t brightness = mp_obj_get_float(value_in);
+    if (brightness < 0.0f || brightness > 1.0f) {
+        mp_raise_ValueError(translate("Brightness must be 0-1.0"));
+    }
+    common_hal_protomatter_protomatter_set_paused(self_in, brightness <= 0);
 
     return mp_const_none;
 }
-MP_DEFINE_CONST_FUN_OBJ_2(protomatter_protomatter_set_paused_obj, protomatter_protomatter_set_paused);
+MP_DEFINE_CONST_FUN_OBJ_2(protomatter_protomatter_set_brightness_obj, protomatter_protomatter_set_brightness);
 
-const mp_obj_property_t protomatter_protomatter_paused_obj = {
+const mp_obj_property_t protomatter_protomatter_brightness_obj = {
     .base.type = &mp_type_property,
-    .proxy = {(mp_obj_t)&protomatter_protomatter_get_paused_obj,
-              (mp_obj_t)&protomatter_protomatter_set_paused_obj,
+    .proxy = {(mp_obj_t)&protomatter_protomatter_get_brightness_obj,
+              (mp_obj_t)&protomatter_protomatter_set_brightness_obj,
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. method:: swapbuffers()
-//|
-//|     Transmits the color data in the buffer to the pixels so that they are shown.
+//|   .. method:: refresh()
 //|
-//|     The data in the buffer must be in "RGB565" format.  This means
-//|     that it is organized as a series of 16-bit numbers where the highest 5
-//|     bits are interpreted as red, the next 6 as green, and the final 5 as
-//|     blue.  The object can be any buffer, but `array.array` and `ulab.array`
-//|     objects are most often useful.
+//|     Transmits the color data in the buffer to the pixels so that
+//|     they are shown.
 //|
-STATIC mp_obj_t protomatter_protomatter_swapbuffers(mp_obj_t self_in) {
+STATIC mp_obj_t protomatter_protomatter_refresh(mp_obj_t self_in) {
     protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
     check_for_deinit(self);
-
-    _PM_convert_565(&self->core, self->bufinfo.buf, self->width);
-    _PM_swapbuffer_maybe(&self->core);
+    common_hal_protomatter_protomatter_refresh(self);
     return mp_const_none;
 }
-MP_DEFINE_CONST_FUN_OBJ_1(protomatter_protomatter_swapbuffers_obj, protomatter_protomatter_swapbuffers);
+MP_DEFINE_CONST_FUN_OBJ_1(protomatter_protomatter_refresh_obj, protomatter_protomatter_refresh);
 
 STATIC const mp_rom_map_elem_t protomatter_protomatter_locals_dict_table[] = {
     { MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&protomatter_protomatter_deinit_obj) },
-    { MP_ROM_QSTR(MP_QSTR_paused), MP_ROM_PTR(&protomatter_protomatter_paused_obj) },
-    { MP_ROM_QSTR(MP_QSTR_swapbuffers), MP_ROM_PTR(&protomatter_protomatter_swapbuffers_obj) },
+    { MP_ROM_QSTR(MP_QSTR_brightness), MP_ROM_PTR(&protomatter_protomatter_brightness_obj) },
+    { MP_ROM_QSTR(MP_QSTR_refresh), MP_ROM_PTR(&protomatter_protomatter_refresh_obj) },
 };
 STATIC MP_DEFINE_CONST_DICT(protomatter_protomatter_locals_dict, protomatter_protomatter_locals_dict_table);
 
 STATIC void protomatter_protomatter_get_bufinfo(mp_obj_t self_in, mp_buffer_info_t *bufinfo) {
     protomatter_protomatter_obj_t *self = (protomatter_protomatter_obj_t*)self_in;
     check_for_deinit(self);
-    
+
     *bufinfo = self->bufinfo;
 }
 
-// This version exists so that the return value of the function can be none, matching the protocol
-STATIC void protomatter_protomatter_swapbuffers_void(mp_obj_t self_in) {
-    protomatter_protomatter_swapbuffers(self_in);
+// These version exists so that the prototype matches the protocol,
+// avoiding a type cast that can hide errors
+STATIC void protomatter_protomatter_swapbuffers(mp_obj_t self_in) {
+    common_hal_protomatter_protomatter_refresh(self_in);
+}
+
+STATIC void protomatter_protomatter_deinit_proto(mp_obj_t self_in) {
+    common_hal_protomatter_protomatter_deinit(self_in);
 }
 
-// This version exists so that the return value of the function can be none, matching the protocol
-STATIC void protomatter_protomatter_deinit_void(mp_obj_t self_in) {
-    protomatter_protomatter_deinit(self_in);
+STATIC float protomatter_protomatter_get_brightness_proto(mp_obj_t self_in) {
+    return common_hal_protomatter_protomatter_get_paused(self_in) ? 0.0f : 1.0f;
 }
 
-STATIC bool protomatter_protomatter_set_brightness(mp_obj_t self_in, mp_float_t value) {
+STATIC bool protomatter_protomatter_set_brightness_proto(mp_obj_t self_in, mp_float_t value) {
     common_hal_protomatter_protomatter_set_paused(self_in, value <= 0);
     return true;
 }
@@ -327,9 +336,10 @@ STATIC bool protomatter_protomatter_set_brightness(mp_obj_t self_in, mp_float_t
 STATIC const framebuffer_p_t protomatter_protomatter_proto = {
     MP_PROTO_IMPLEMENT(MP_QSTR_protocol_framebuffer)
     .get_bufinfo = protomatter_protomatter_get_bufinfo,
-    .set_brightness = protomatter_protomatter_set_brightness,
-    .swapbuffers = protomatter_protomatter_swapbuffers_void,
-    .deinit = protomatter_protomatter_deinit_void,
+    .set_brightness = protomatter_protomatter_set_brightness_proto,
+    .get_brightness = protomatter_protomatter_get_brightness_proto,
+    .swapbuffers = protomatter_protomatter_swapbuffers,
+    .deinit = protomatter_protomatter_deinit_proto,
 };
 
 STATIC mp_int_t protomatter_protomatter_get_buffer(mp_obj_t self_in, mp_buffer_info_t *bufinfo, mp_uint_t flags) {
diff --git a/shared-bindings/_protomatter/Protomatter.h b/shared-bindings/_protomatter/Protomatter.h
index 0a52c556f..9499da22c 100644
--- a/shared-bindings/_protomatter/Protomatter.h
+++ b/shared-bindings/_protomatter/Protomatter.h
@@ -54,5 +54,6 @@ void protomatter_protomatter_collect_ptrs(protomatter_protomatter_obj_t*);
 void common_hal_protomatter_protomatter_reconstruct(protomatter_protomatter_obj_t* self, mp_obj_t framebuffer);
 void common_hal_protomatter_protomatter_set_paused(protomatter_protomatter_obj_t* self, bool paused);
 bool common_hal_protomatter_protomatter_get_paused(protomatter_protomatter_obj_t* self);
+void common_hal_protomatter_protomatter_refresh(protomatter_protomatter_obj_t* self);
 
 #endif
diff --git a/shared-bindings/framebufferio/FramebufferDisplay.c b/shared-bindings/framebufferio/FramebufferDisplay.c
index 538d3afb4..aa8fc1a63 100644
--- a/shared-bindings/framebufferio/FramebufferDisplay.c
+++ b/shared-bindings/framebufferio/FramebufferDisplay.c
@@ -216,7 +216,7 @@ STATIC mp_obj_t framebufferio_framebufferdisplay_obj_set_brightness(mp_obj_t sel
     framebufferio_framebufferdisplay_obj_t *self = native_display(self_in);
     common_hal_framebufferio_framebufferdisplay_set_auto_brightness(self, false);
     mp_float_t brightness = mp_obj_get_float(brightness_obj);
-    if (brightness < 0 || brightness > 1.0) {
+    if (brightness < 0.0f || brightness > 1.0f) {
         mp_raise_ValueError(translate("Brightness must be 0-1.0"));
     }
     bool ok = common_hal_framebufferio_framebufferdisplay_set_brightness(self, brightness);
diff --git a/shared-bindings/framebufferio/FramebufferDisplay.h b/shared-bindings/framebufferio/FramebufferDisplay.h
index 56ef8abc4..b472088d2 100644
--- a/shared-bindings/framebufferio/FramebufferDisplay.h
+++ b/shared-bindings/framebufferio/FramebufferDisplay.h
@@ -60,9 +60,6 @@ void common_hal_framebufferio_framebufferdisplay_set_rotation(framebufferio_fram
 bool common_hal_framebufferio_framebufferdisplay_get_auto_brightness(framebufferio_framebufferdisplay_obj_t* self);
 bool common_hal_framebufferio_framebufferdisplay_set_auto_brightness(framebufferio_framebufferdisplay_obj_t* self, bool auto_brightness);
 
-bool common_hal_framebufferio_framebufferdisplay_get_dither(framebufferio_framebufferdisplay_obj_t* self);
-void common_hal_framebufferio_framebufferdisplay_set_dither(framebufferio_framebufferdisplay_obj_t* self, bool dither);
-
 mp_float_t common_hal_framebufferio_framebufferdisplay_get_brightness(framebufferio_framebufferdisplay_obj_t* self);
 bool common_hal_framebufferio_framebufferdisplay_set_brightness(framebufferio_framebufferdisplay_obj_t* self, mp_float_t brightness);
 
diff --git a/shared-module/_protomatter/Protomatter.c b/shared-module/_protomatter/Protomatter.c
index 9f67bfad3..77ca63476 100644
--- a/shared-module/_protomatter/Protomatter.c
+++ b/shared-module/_protomatter/Protomatter.c
@@ -53,7 +53,7 @@ void common_hal_protomatter_protomatter_construct(protomatter_protomatter_obj_t
     self->oe_pin = oe_pin;
     self->latch_pin = latch_pin;
     self->doublebuffer = doublebuffer;
-    
+
     self->timer = timer ? timer : common_hal_protomatter_timer_allocate();
     if (self->timer == NULL) {
         mp_raise_ValueError(translate("No timer available"));
@@ -90,7 +90,7 @@ void common_hal_protomatter_protomatter_reconstruct(protomatter_protomatter_obj_
     }
 
     ProtomatterStatus stat = _PM_init(&self->core,
-        self->width, self->bit_depth, 
+        self->width, self->bit_depth,
         self->rgb_count/6, self->rgb_pins,
         self->addr_count, self->addr_pins,
         self->clock_pin, self->latch_pin, self->oe_pin,
@@ -192,3 +192,9 @@ void common_hal_protomatter_protomatter_set_paused(protomatter_protomatter_obj_t
 bool common_hal_protomatter_protomatter_get_paused(protomatter_protomatter_obj_t* self) {
     return self->paused;
 }
+
+void common_hal_protomatter_protomatter_refresh(protomatter_protomatter_obj_t* self) {
+    _PM_convert_565(&self->core, self->bufinfo.buf, self->width);
+    _PM_swapbuffer_maybe(&self->core);
+}
+
diff --git a/shared-module/_protomatter/allocator.h b/shared-module/_protomatter/allocator.h
index 1ae127de2..b7f517ce5 100644
--- a/shared-module/_protomatter/allocator.h
+++ b/shared-module/_protomatter/allocator.h
@@ -13,14 +13,14 @@ static inline void *_PM_allocator_impl(size_t sz) {
     if (gc_alloc_possible()) {
         return m_malloc(sz + sizeof(void*), true);
     } else {
-        supervisor_allocation *allocation = allocate_memory(align32_size(sz), false);    
+        supervisor_allocation *allocation = allocate_memory(align32_size(sz), false);
         return allocation ? allocation->ptr : NULL;
     }
 }
 
 static inline void _PM_free_impl(void *ptr_in) {
     supervisor_allocation *allocation = allocation_from_ptr(ptr_in);
-    
+
     if (allocation) {
         free_memory(allocation);
     }
-- 
cgit v1.2.3


From 0ce9c008c5d54f59224bda91af36c9c86aa64c09 Mon Sep 17 00:00:00 2001
From: Jeff Epler <jepler@gmail.com>
Date: Tue, 14 Apr 2020 10:02:08 -0500
Subject: Protomatter: Make all arguments kw-only, add rgb count and optional
 height checking

They're not readily distinguishable by type.

I also added the requested height optional parameter; this is checked
against the computed one.  It's not feasible to use this parameter to
artificailly reduce the number of used rows, because changes in the
underlying C protomatter library would be required.

Finally, I added a better error message when the number of RGB pins was
not what was expected.
---
 shared-bindings/_protomatter/Protomatter.c | 34 +++++++++++++++++++++---------
 1 file changed, 24 insertions(+), 10 deletions(-)

(limited to 'shared-bindings/_protomatter/Protomatter.c')

diff --git a/shared-bindings/_protomatter/Protomatter.c b/shared-bindings/_protomatter/Protomatter.c
index cfc0ba6ed..bb4339079 100644
--- a/shared-bindings/_protomatter/Protomatter.c
+++ b/shared-bindings/_protomatter/Protomatter.c
@@ -177,17 +177,18 @@ STATIC void preflight_pins_or_throw(uint8_t clock_pin, uint8_t *rgb_pins, uint8_
 
 STATIC mp_obj_t protomatter_protomatter_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_width, ARG_bit_depth, ARG_rgb_list, ARG_addr_list,
-        ARG_clock_pin, ARG_latch_pin, ARG_output_enable_pin, ARG_doublebuffer, ARG_framebuffer };
+        ARG_clock_pin, ARG_latch_pin, ARG_output_enable_pin, ARG_doublebuffer, ARG_framebuffer, ARG_height };
     static const mp_arg_t allowed_args[] = {
-        { MP_QSTR_width, MP_ARG_INT | MP_ARG_REQUIRED },
-        { MP_QSTR_bit_depth, MP_ARG_INT | MP_ARG_REQUIRED },
-        { MP_QSTR_rgb_pins, MP_ARG_OBJ | MP_ARG_REQUIRED },
-        { MP_QSTR_addr_pins, MP_ARG_OBJ | MP_ARG_REQUIRED },
-        { MP_QSTR_clock_pin, MP_ARG_OBJ | MP_ARG_REQUIRED },
-        { MP_QSTR_latch_pin, MP_ARG_OBJ | MP_ARG_REQUIRED },
-        { MP_QSTR_output_enable_pin, MP_ARG_OBJ | MP_ARG_REQUIRED },
-        { MP_QSTR_doublebuffer, MP_ARG_BOOL, { .u_bool = true } },
-        { MP_QSTR_framebuffer, MP_ARG_OBJ, { .u_obj = mp_const_none } },
+        { MP_QSTR_width, MP_ARG_INT | MP_ARG_REQUIRED | MP_ARG_KW_ONLY },
+        { MP_QSTR_bit_depth, MP_ARG_INT | MP_ARG_REQUIRED | MP_ARG_KW_ONLY },
+        { MP_QSTR_rgb_pins, MP_ARG_OBJ | MP_ARG_REQUIRED | MP_ARG_KW_ONLY },
+        { MP_QSTR_addr_pins, MP_ARG_OBJ | MP_ARG_REQUIRED | MP_ARG_KW_ONLY },
+        { MP_QSTR_clock_pin, MP_ARG_OBJ | MP_ARG_REQUIRED | MP_ARG_KW_ONLY },
+        { MP_QSTR_latch_pin, MP_ARG_OBJ | MP_ARG_REQUIRED | MP_ARG_KW_ONLY },
+        { MP_QSTR_output_enable_pin, MP_ARG_OBJ | MP_ARG_REQUIRED | MP_ARG_KW_ONLY },
+        { MP_QSTR_doublebuffer, MP_ARG_BOOL | MP_ARG_KW_ONLY, { .u_bool = true } },
+        { MP_QSTR_framebuffer, MP_ARG_OBJ | MP_ARG_KW_ONLY, { .u_obj = mp_const_none } },
+        { MP_QSTR_height, MP_ARG_INT | MP_ARG_KW_ONLY, { .u_int = 0 } },
     };
     mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
     mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
@@ -208,6 +209,19 @@ STATIC mp_obj_t protomatter_protomatter_make_new(const mp_obj_type_t *type, size
     validate_pins(MP_QSTR_rgb_pins, rgb_pins, MP_ARRAY_SIZE(self->rgb_pins), args[ARG_rgb_list].u_obj, &rgb_count);
     validate_pins(MP_QSTR_addr_pins, addr_pins, MP_ARRAY_SIZE(self->addr_pins), args[ARG_addr_list].u_obj, &addr_count);
 
+    if (rgb_count % 6) {
+        mp_raise_ValueError_varg(translate("Must use a multiple of 6 rgb pins, not %d"), rgb_count);
+    }
+
+    // TODO(@jepler) Use fewer than all rows of pixels if height < computed_height
+    if (args[ARG_height].u_int != 0) {
+        int computed_height = (rgb_count / 3) << (addr_count);
+        if (computed_height != args[ARG_height].u_int) {
+            mp_raise_ValueError_varg(
+                translate("%d address pins and %d rgb pins indicate a height of %d, not %d"), addr_count, rgb_count, computed_height, args[ARG_height].u_int);
+        }
+    }
+
     preflight_pins_or_throw(clock_pin, rgb_pins, rgb_count, true);
 
     mp_obj_t framebuffer = args[ARG_framebuffer].u_obj;
-- 
cgit v1.2.3