Add Protomatter and FramebufferDisplay

Author: jepler

.gitmodules

@@ -119,3 +119,6 @@
 [submodule "ports/stm/st_driver"]
 	path = ports/stm/st_driver
 	url = https://github.com/hathach/st_driver.git
+[submodule "lib/protomatter"]
+	path = lib/protomatter
+	url = https://github.com/adafruit/Adafruit_Protomatter

lib/protomatter

@@ -97,6 +97,7 @@ void board_init(void) {
         false, // Pixels in a byte share a row. Only used for depth < 8
         1, // bytes per cell. Only valid for depths < 8
         false, // reverse_pixels_in_byte. Only valid for depths < 8
+        true, // reverse_pixels_in_word
         MIPI_COMMAND_SET_COLUMN_ADDRESS, // Set column command
         MIPI_COMMAND_SET_PAGE_ADDRESS, // Set row command
         MIPI_COMMAND_WRITE_MEMORY_START, // Write memory command

ports/atmel-samd/boards/hallowing_m0_express/board.c

@@ -77,6 +77,7 @@ void board_init(void) {
         false, // Pixels in a byte share a row. Only used for depth < 8
         1, // bytes per cell. Only valid for depths < 8
         false, // reverse_pixels_in_byte. Only valid for depths < 8
+        true, // reverse_pixels_in_word
         MIPI_COMMAND_SET_COLUMN_ADDRESS, // Set column command
         MIPI_COMMAND_SET_PAGE_ADDRESS, // Set row command
         MIPI_COMMAND_WRITE_MEMORY_START, // Write memory command

ports/atmel-samd/boards/hallowing_m4_express/board.c

@@ -11,8 +11,10 @@ LONGINT_IMPL = MPZ
 
 # Not needed.
 CIRCUITPY_AUDIOBUSIO = 0
+CIRCUITPY_FRAMEBUFFERIO = 0
 CIRCUITPY_DISPLAYIO = 0
 CIRCUITPY_NETWORK = 0
+CIRCUITPY_PROTOMATTER = 0
 CIRCUITPY_PS2IO = 0
 CIRCUITPY_AUDIOMP3 = 0
 

ports/atmel-samd/boards/kicksat-sprite/mpconfigboard.mk

@@ -78,6 +78,7 @@ void board_init(void) {
         false, // pixels in a byte share a row. Only valid for depths < 8
         1, // bytes per cell. Only valid for depths < 8
         false, // reverse_pixels_in_byte. Only valid for depths < 8
+        true, // reverse_pixels_in_word
         MIPI_COMMAND_SET_COLUMN_ADDRESS, // Set column command
         MIPI_COMMAND_SET_PAGE_ADDRESS, // Set row command
         MIPI_COMMAND_WRITE_MEMORY_START, // Write memory command

ports/atmel-samd/boards/monster_m4sk/board.c

@@ -128,6 +128,7 @@ void board_init(void) {
         false, // pixels in byte share row. only used for depth < 8
         1, // bytes per cell. Only valid for depths < 8
         false, // reverse_pixels_in_byte. Only valid for depths < 8
+        true, // reverse_pixels_in_word
         MIPI_COMMAND_SET_COLUMN_ADDRESS, // Set column command
         MIPI_COMMAND_SET_PAGE_ADDRESS, // Set row command
         MIPI_COMMAND_WRITE_MEMORY_START, // Write memory command

ports/atmel-samd/boards/pewpew_m4/board.c

@@ -100,6 +100,7 @@ void board_init(void) {
         false, // pixels in byte share row. only used for depth < 8
         1, // bytes per cell. Only valid for depths < 8
         false, // reverse_pixels_in_byte. Only valid for depths < 8
+        true, // reverse_pixels_in_word
         MIPI_COMMAND_SET_COLUMN_ADDRESS, // Set column command
         MIPI_COMMAND_SET_PAGE_ADDRESS, // Set row command
         MIPI_COMMAND_WRITE_MEMORY_START, // Write memory command

ports/atmel-samd/boards/pybadge/board.c

@@ -78,6 +78,7 @@ void board_init(void) {
         false, // pixels in byte share row. Only used for depth < 8
         1, // bytes per cell. Only valid for depths < 8
         false, // reverse_pixels_in_byte. Only valid for depths < 8
+        true, // reverse_pixels_in_word
         MIPI_COMMAND_SET_COLUMN_ADDRESS, // Set column command
         MIPI_COMMAND_SET_PAGE_ADDRESS, // Set row command
         MIPI_COMMAND_WRITE_MEMORY_START, // Write memory command

ports/atmel-samd/boards/pybadge_airlift/board.c

@@ -15,7 +15,9 @@ LONGINT_IMPL = MPZ
 # Not needed.
 CIRCUITPY_AUDIOBUSIO = 0
 CIRCUITPY_DISPLAYIO = 0
+CIRCUITPY_FRAMEBUFFERIO = 0
 CIRCUITPY_GAMEPAD = 0
+CIRCUITPY_PROTOMATTER = 0
 CIRCUITPY_PS2IO = 0
 
 FROZEN_MPY_DIRS += $(TOP)/frozen/Adafruit_CircuitPython_BusDevice

ports/atmel-samd/boards/pycubed/mpconfigboard.mk

@@ -100,6 +100,7 @@ void board_init(void) {
         false, // pixels in a byte share a row. Only valid for depths < 8
         1, // bytes per cell. Only valid for depths < 8
         false, // reverse_pixels_in_byte. Only valid for depths < 8
+        true, // reverse_pixels_in_word
         MIPI_COMMAND_SET_COLUMN_ADDRESS, // Set column command
         MIPI_COMMAND_SET_PAGE_ADDRESS, // Set row command
         MIPI_COMMAND_WRITE_MEMORY_START, // Write memory command

ports/atmel-samd/boards/pygamer/board.c

@@ -78,6 +78,7 @@ void board_init(void) {
         false, // pixels in a byte share a row. Only valid for depths < 8
         1, // bytes per cell. Only valid for depths < 8
         false, // reverse_pixels_in_byte. Only valid for depths < 8
+        true, // reverse_pixels_in_word
         MIPI_COMMAND_SET_COLUMN_ADDRESS, // Set column command
         MIPI_COMMAND_SET_PAGE_ADDRESS, // Set row command
         MIPI_COMMAND_WRITE_MEMORY_START, // Write memory command

ports/atmel-samd/boards/pygamer_advance/board.c

@@ -87,6 +87,7 @@ void board_init(void) {
         false, // pixels_in_byte_share_row (unused for depths > 8)
         1, // bytes per cell. Only valid for depths < 8
         false, // reverse_pixels_in_byte. Only valid for depths < 8
+        true, // reverse_pixels_in_word
         MIPI_COMMAND_SET_COLUMN_ADDRESS, // Set column command
         MIPI_COMMAND_SET_PAGE_ADDRESS, // Set row command
         MIPI_COMMAND_WRITE_MEMORY_START, // Write memory command

ports/atmel-samd/boards/pyportal/board.c

@@ -101,9 +101,10 @@ void board_init(void) {
         0, // rotation
         16, // Color depth
         false, // grayscale
-        false, // pixels_in_byte_share_row (unused for depths > 8)
+        false, // pixels_i|n_byte_share_row (unused for depths > 8)
         1, // bytes per cell. Only valid for depths < 8
         false, // reverse_pixels_in_byte. Only valid for depths < 8
+        true, // reverse_pixels_in_word
         MIPI_COMMAND_SET_COLUMN_ADDRESS, // Set column command
         MIPI_COMMAND_SET_PAGE_ADDRESS, // Set row command
         MIPI_COMMAND_WRITE_MEMORY_START, // Write memory command

ports/atmel-samd/boards/pyportal_titano/board.c

@@ -17,7 +17,9 @@ LONGINT_IMPL = MPZ
 CIRCUITPY_AUDIOBUSIO = 0
 # Make room for more stuff
 CIRCUITPY_DISPLAYIO = 0
+CIRCUITPY_FRAMEBUFFERIO = 0
 CIRCUITPY_FREQUENCYIO = 0
+CIRCUITPY_PROTOMATTER = 0
 
 # Include these Python libraries in firmware.
 #FROZEN_MPY_DIRS += $(TOP)/frozen/Adafruit_CircuitPython_BusDevice

ports/atmel-samd/boards/robohatmm1_m4/mpconfigboard.mk

@@ -97,6 +97,7 @@ void board_init(void) {
         false, // pixels in byte share row. Only used with depth < 8
         1, // bytes per cell. Only valid for depths < 8
         false, // reverse_pixels_in_byte. Only valid for depths < 8
+        true, // reverse_pixels_in_word
         MIPI_COMMAND_SET_COLUMN_ADDRESS, // Set column command
         MIPI_COMMAND_SET_PAGE_ADDRESS, // Set row command
         MIPI_COMMAND_WRITE_MEMORY_START, // Write memory command

ports/atmel-samd/boards/ugame10/board.c

@@ -18,6 +18,7 @@ CIRCUITPY_AUDIOIO = 1
 
 # Disable modules that are unusable on this special-purpose board.
 CIRCUITPY_BITBANGIO = 0
+CIRCUITPY_FRAMEBUFFERIO = 0
 CIRCUITPY_FREQUENCYIO = 0
 CIRCUITPY_I2CSLAVE = 0
 CIRCUITPY_AUDIOBUSIO = 0
@@ -27,6 +28,7 @@ CIRCUITPY_GAMEPAD = 0
 CIRCUITPY_I2CSLAVE = 0
 CIRCUITPY_NETWORK = 0
 CIRCUITPY_TOUCHIO = 0
+CIRCUITPY_PROTOMATTER = 0
 CIRCUITPY_PS2IO = 0
 CIRCUITPY_USB_HID = 0
 CIRCUITPY_RTC = 0

ports/atmel-samd/boards/winterbloom_big_honking_button/mpconfigboard.mk

@@ -21,10 +21,12 @@ CIRCUITPY_AUDIOBUSIO = 0
 CIRCUITPY_AUDIOIO = 0
 CIRCUITPY_BLEIO = 0
 CIRCUITPY_DISPLAYIO = 0
+CIRCUITPY_FRAMEBUFFERIO = 0
 CIRCUITPY_GAMEPAD = 0
 CIRCUITPY_I2CSLAVE = 0
 CIRCUITPY_NETWORK = 0
 CIRCUITPY_TOUCHIO = 0
+CIRCUITPY_PROTOMATTER = 0
 CIRCUITPY_PS2IO = 0
 CIRCUITPY_USB_HID = 0
 

ports/atmel-samd/boards/winterbloom_sol/mpconfigboard.mk

@@ -0,0 +1,77 @@
+/*
+ * 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 <stddef.h>
+
+#include "common-hal/_protomatter/Protomatter.h"
+
+#include "samd/timers.h"
+#include "timer_handler.h"
+
+void *common_hal_protomatter_timer_allocate() {
+    uint8_t timer_index = find_free_timer();
+    if (timer_index == 0xff) {
+        return NULL;
+    }
+    timer_never_reset(timer_index, true);
+    return tc_insts[timer_index];
+}
+
+static uint8_t tc_index_from_ptr(void* ptr) {
+    for (uint8_t i = TC_INST_NUM; i > 0; i--) {
+        if (tc_insts[i] == ptr) {
+            return i;
+        }
+    }
+    return 0xff;
+}
+
+void common_hal_protomatter_timer_enable(void* ptr) {
+    uint8_t timer_index = tc_index_from_ptr(ptr);
+    if (timer_index == 0xff) {
+        return;
+    }
+    set_timer_handler(true, timer_index, TC_HANDLER_PROTOMATTER);
+    turn_on_clocks(true, timer_index, 1);
+}
+
+void common_hal_protomatter_timer_disable(void* ptr) {
+    uint8_t timer_index = tc_index_from_ptr(ptr);
+    if (timer_index == 0xff) {
+        return;
+    }
+    set_timer_handler(true, timer_index, TC_HANDLER_NO_INTERRUPT);
+}
+
+void common_hal_protomatter_timer_free(void* ptr) {
+    uint8_t timer_index = tc_index_from_ptr(ptr);
+    if (timer_index == 0xff) {
+        return;
+    }
+    tc_set_enable(ptr, false);
+    tc_reset(ptr);
+    timer_reset_ok(timer_index, true);
+}

ports/atmel-samd/common-hal/_protomatter/Protomatter.c

@@ -0,0 +1,35 @@
+/*
+ * 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.
+ */
+
+#ifndef MICROPY_INCLUDED_ATMEL_SAMD_COMMON_HAL_PROTOMATTER_PROTOMATTER_H
+#define MICROPY_INCLUDED_ATMEL_SAMD_COMMON_HAL_PROTOMATTER_PROTOMATTER_H
+
+void *common_hal_protomatter_timer_allocate(void);
+void common_hal_protomatter_timer_enable(void*);
+void common_hal_protomatter_timer_disable(void*);
+void common_hal_protomatter_timer_free(void*);
+
+#endif

ports/atmel-samd/common-hal/_protomatter/Protomatter.h

@@ -240,3 +240,15 @@ bool common_hal_mcu_pin_is_free(const mcu_pin_obj_t* pin) {
 
     return pin_number_is_free(pin->number);
 }
+
+uint8_t common_hal_mcu_pin_number(const mcu_pin_obj_t* pin) {
+    return pin->number;
+}
+
+void common_hal_mcu_pin_claim(const mcu_pin_obj_t* pin) {
+    return claim_pin(pin);
+}
+
+void common_hal_mcu_pin_reset_number(uint8_t pin_no) {
+    reset_pin_number(pin_no);
+}

ports/atmel-samd/common-hal/_protomatter/__init__.c

@@ -61,22 +61,31 @@ uint8_t tcc_channels[5];   // Set by pwmout_reset() to {0xc0, 0xf0, 0xf8, 0xfc,
 
 static uint8_t never_reset_tc_or_tcc[TC_INST_NUM + TCC_INST_NUM];
 
-void common_hal_pulseio_pwmout_never_reset(pulseio_pwmout_obj_t *self) {
-    if (self->timer->is_tc) {
-        never_reset_tc_or_tcc[self->timer->index] += 1;
+STATIC void timer_refcount(int index, bool is_tc, int increment) {
+    if (is_tc) {
+        never_reset_tc_or_tcc[index] += increment;
     } else {
-        never_reset_tc_or_tcc[TC_INST_NUM + self->timer->index] += 1;
+        never_reset_tc_or_tcc[TC_INST_NUM + index] += increment;
     }
+}
+
+void timer_never_reset(int index, bool is_tc) {
+    timer_refcount(index, is_tc, 1);
+}
+
+void timer_reset_ok(int index, bool is_tc) {
+    timer_refcount(index, is_tc, -1);
+}
+
+
+void common_hal_pulseio_pwmout_never_reset(pulseio_pwmout_obj_t *self) {
+    timer_never_reset(self->timer->index, self->timer->is_tc);
 
     never_reset_pin_number(self->pin->number);
 }
 
 void common_hal_pulseio_pwmout_reset_ok(pulseio_pwmout_obj_t *self) {
-    if (self->timer->is_tc) {
-        never_reset_tc_or_tcc[self->timer->index] -= 1;
-    } else {
-        never_reset_tc_or_tcc[TC_INST_NUM + self->timer->index] -= 1;
-    }
+    timer_reset_ok(self->timer->index, self->timer->is_tc);
 }
 
 void pwmout_reset(void) {

ports/atmel-samd/common-hal/microcontroller/Pin.c

@@ -70,6 +70,18 @@ CIRCUITPY_ULAB = 1
 endif
 endif
 
+ifndef CIRCUITPY_PROTOMATTER
+ifneq ($(CIRCUITPY_SMALL_BUILD),1)
+CIRCUITPY_PROTOMATTER = 1
+endif
+endif
+
+ifndef CIRCUITPY_FRAMEBUFFERIO
+ifneq ($(CIRCUITPY_SMALL_BUILD),1)
+CIRCUITPY_FRAMEBUFFERIO = 1
+endif
+endif
+
 endif # samd51
 
 INTERNAL_LIBM = 1

ports/atmel-samd/common-hal/pulseio/PWMOut.c

@@ -33,6 +33,8 @@
 #include "shared-module/_pew/PewPew.h"
 #include "common-hal/frequencyio/FrequencyIn.h"
 
+extern void _PM_IRQ_HANDLER(void);
+
 static uint8_t tc_handler[TC_INST_NUM];
 
 void set_timer_handler(bool is_tc, uint8_t index, uint8_t timer_handler) {
@@ -62,6 +64,11 @@ void shared_timer_handler(bool is_tc, uint8_t index) {
                 frequencyin_interrupt_handler(index);
             #endif
                 break;
+            case TC_HANDLER_PROTOMATTER:
+            #if CIRCUITPY_PROTOMATTER
+                _PM_IRQ_HANDLER();
+            #endif
+                break;
             default:
                 break;
         }

ports/atmel-samd/mpconfigport.mk

@@ -30,8 +30,13 @@
 #define TC_HANDLER_PULSEOUT 0x1
 #define TC_HANDLER_PEW 0x2
 #define TC_HANDLER_FREQUENCYIN 0x3
+#define TC_HANDLER_PROTOMATTER 0x4
 
 void set_timer_handler(bool is_tc, uint8_t index, uint8_t timer_handler);
 void shared_timer_handler(bool is_tc, uint8_t index);
 
+// implementation of these functions is in PWMOut.c
+void timer_never_reset(int index, bool is_tc);
+void timer_reset_ok(int index, bool is_tc);
+
 #endif  // MICROPY_INCLUDED_ATMEL_SAMD_TIMER_HANDLER_H

ports/atmel-samd/peripherals

@@ -77,6 +77,7 @@ void board_init(void) {
         false, // Pixels in a byte share a row. Only used for depth < 8
         1, // bytes per cell. Only valid for depths < 8
         false, // reverse_pixels_in_byte. Only valid for depths < 8
+        true, // reverse_pixels_in_word
         MIPI_COMMAND_SET_COLUMN_ADDRESS, // Set column command
         MIPI_COMMAND_SET_PAGE_ADDRESS, // Set row command
         MIPI_COMMAND_WRITE_MEMORY_START, // Write memory command