2021 February 27 Breaking Changes Update (#12040)

7 files changed, 210 insertions, 146 deletions

diff --git a/drivers/avr/apa102.c b/drivers/avr/apa102.c
deleted file mode 100644
index 740acb5739..0000000000
--- a/drivers/avr/apa102.c
+++ /dev/null
@@ -1,96 +0,0 @@
-/*
- * APA102 lib V1.0a
- *
- * Controls APA102 RGB-LEDs
- * Author: Mikkel (Duckle29 on GitHub)
- *
- * Dec 22th, 2017  v1.0a Initial Version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#include "apa102.h"
-#include <avr/interrupt.h>
-#include <avr/io.h>
-#include <util/delay.h>
-#include "debug.h"
-
-// Setleds for standard RGB
-void inline apa102_setleds(LED_TYPE *ledarray, uint16_t leds) { apa102_setleds_pin(ledarray, leds, _BV(RGB_DI_PIN & 0xF), _BV(RGB_CLK_PIN & 0xF)); }
-
-void static inline apa102_setleds_pin(LED_TYPE *ledarray, uint16_t leds, uint8_t pinmask_DI, uint8_t pinmask_CLK) {
-    setPinOutput(RGB_DI_PIN);
-    setPinOutput(RGB_CLK_PIN);
-
-    apa102_send_array((uint8_t *)ledarray, leds)
-}
-
-void apa102_send_array(uint8_t *data, uint16_t leds) {  // Data is struct of 3 bytes. RGB - leds is number of leds in data
-    apa102_start_frame();
-    while (leds--) {
-        apa102_send_frame(0xFF000000 | (data->b << 16) | (data->g << 8) | data->r);
-        data++;
-    }
-    apa102_end_frame(leds);
-}
-
-void apa102_send_frame(uint32_t frame) {
-    for (uint32_t i = 0xFF; i > 0;) {
-        apa102_send_byte(frame & i);
-        i = i << 8;
-    }
-}
-
-void apa102_start_frame() { apa102_send_frame(0); }
-
-void apa102_end_frame(uint16_t leds) {
-    // This function has been taken from: https://github.com/pololu/apa102-arduino/blob/master/APA102.h
-    // and adapted. The code is MIT licensed. I think thats compatible?
-
-    // We need to send some more bytes to ensure that all the LEDs in the
-    // chain see their new color and start displaying it.
-    //
-    // The data stream seen by the last LED in the chain will be delayed by
-    // (count - 1) clock edges, because each LED before it inverts the clock
-    // line and delays the data by one clock edge.  Therefore, to make sure
-    // the last LED actually receives the data we wrote, the number of extra
-    // edges we send at the end of the frame must be at least (count - 1).
-    // For the APA102C, that is sufficient.
-    //
-    // The SK9822 only updates after it sees 32 zero bits followed by one more
-    // rising edge.  To avoid having the update time depend on the color of
-    // the last LED, we send a dummy 0xFF byte.  (Unfortunately, this means
-    // that partial updates of the beginning of an LED strip are not possible;
-    // the LED after the last one you are trying to update will be black.)
-    // After that, to ensure that the last LED in the chain sees 32 zero bits
-    // and a rising edge, we need to send at least 65 + (count - 1) edges.  It
-    // is sufficent and simpler to just send (5 + count/16) bytes of zeros.
-    //
-    // We are ignoring the specification for the end frame in the APA102/SK9822
-    // datasheets because it does not actually ensure that all the LEDs will
-    // start displaying their new colors right away.
-
-    apa102_send_byte(0xFF);
-    for (uint16_t i = 0; i < 5 + leds / 16; i++) {
-        apa102_send_byte(0);
-    }
-}
-
-void apa102_send_byte(uint8_t byte) {
-    uint8_t i;
-    for (i = 0; i < 8; i++) {
-        writePin(RGB_DI_PIN, !!(byte & (1 << (7 - i))));
-        writePinHigh(RGB_CLK_PIN);
-    }
-}
diff --git a/drivers/avr/apa102.h b/drivers/avr/apa102.h
deleted file mode 100644
index d4c1e18ee1..0000000000
--- a/drivers/avr/apa102.h
+++ /dev/null
@@ -1,45 +0,0 @@
-/*
- * light weight WS2812 lib include
- *
- * Version 2.3  - Nev 29th 2015
- * Author: Tim (cpldcpu@gmail.com)
- *
- * Please do not change this file! All configuration is handled in "ws2812_config.h"
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#pragma once
-
-#include <avr/io.h>
-#include <avr/interrupt.h>
-
-#include "color.h"
-
-/* User Interface
- *
- * Input:
- *         ledarray:           An array of GRB data describing the LED colors
- *         number_of_leds:     The number of LEDs to write
- *         pinmask (optional): Bitmask describing the output bin. e.g. _BV(PB0)
- *
- * The functions will perform the following actions:
- *         - Set the data-out pin as output
- *         - Send out the LED data
- *         - Wait 50�s to reset the LEDs
- */
-
-void apa102_setleds(LED_TYPE *ledarray, uint16_t number_of_leds);
-void apa102_setleds_pin(LED_TYPE *ledarray, uint16_t number_of_leds, uint8_t pinmask);
-void apa102_setleds_rgbw(LED_TYPE *ledarray, uint16_t number_of_leds);
diff --git a/drivers/avr/serial.c b/drivers/avr/serial.c
index 526a0946b2..3647bee0d3 100644
--- a/drivers/avr/serial.c
+++ b/drivers/avr/serial.c
@@ -20,7 +20,7 @@
 
 #ifdef SOFT_SERIAL_PIN
 
-#    if !(defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
+#    if !(defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB162__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
 #        error serial.c is not supported for the currently selected MCU
 #    endif
 // if using ATmega32U4/2, AT90USBxxx I2C, can not use PD0 and PD1 in soft serial.
@@ -52,8 +52,8 @@
 #        define EICRx EICRA
 #    endif
 
-// ATmegaxxU2 specific config
-#    if defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__)
+// ATmegaxxU2/AT90USB162 specific config
+#    if defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__) || defined(__AVR_AT90USB162__)
 // PD4(INT5), PD6(INT6), PD7(INT7), PC7(INT4)
 #        if SOFT_SERIAL_PIN == D4
 #            define EIMSK_BIT _BV(INT5)
diff --git a/drivers/avr/spi_master.c b/drivers/avr/spi_master.c
index cbec9f36e1..19ca0ced44 100644
--- a/drivers/avr/spi_master.c
+++ b/drivers/avr/spi_master.c
@@ -20,7 +20,7 @@
 #include "quantum.h"
 #include "timer.h"
 
-#if defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__) || defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__)
+#if defined(__AVR_AT90USB162__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__) || defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__)
 #    define SPI_SCK_PIN B1
 #    define SPI_MOSI_PIN B2
 #    define SPI_MISO_PIN B3
diff --git a/drivers/avr/spi_master.h b/drivers/avr/spi_master.h
index e36a7c21c0..9203698dd5 100644
--- a/drivers/avr/spi_master.h
+++ b/drivers/avr/spi_master.h
@@ -21,7 +21,7 @@
 typedef int16_t spi_status_t;
 
 // Hardware SS pin is defined in the header so that user code can refer to it
-#if defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__) || defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__)
+#if defined(__AVR_AT90USB162__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__) || defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__)
 #    define SPI_SS_PIN B0
 #elif defined(__AVR_ATmega32A__)
 #    define SPI_SS_PIN B4
diff --git a/drivers/avr/uart.c b/drivers/avr/uart.c
new file mode 100644
index 0000000000..c6abcb6fe0
--- /dev/null
+++ b/drivers/avr/uart.c
@@ -0,0 +1,170 @@
+/* UART Example for Teensy USB Development Board
+ * http://www.pjrc.com/teensy/
+ * Copyright (c) 2009 PJRC.COM, LLC
+ *
+ * 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.
+ */
+
+// Version 1.0: Initial Release
+// Version 1.1: Add support for Teensy 2.0, minor optimizations
+
+#include <avr/io.h>
+#include <avr/interrupt.h>
+
+#include "uart.h"
+
+#if defined(__AVR_AT90USB162__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__) || defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__)
+#    define UDRn UDR1
+#    define UBRRnL UBRR1L
+#    define UCSRnA UCSR1A
+#    define UCSRnB UCSR1B
+#    define UCSRnC UCSR1C
+#    define U2Xn U2X1
+#    define RXENn RXEN1
+#    define TXENn TXEN1
+#    define RXCIEn RXCIE1
+#    define UCSZn1 UCSZ11
+#    define UCSZn0 UCSZ10
+#    define UDRIEn UDRIE1
+#    define USARTn_UDRE_vect USART1_UDRE_vect
+#    define USARTn_RX_vect USART1_RX_vect
+#elif defined(__AVR_ATmega32A__)
+#    define UDRn UDR
+#    define UBRRnL UBRRL
+#    define UCSRnA UCSRA
+#    define UCSRnB UCSRB
+#    define UCSRnC UCSRC
+#    define U2Xn U2X
+#    define RXENn RXEN
+#    define TXENn TXEN
+#    define RXCIEn RXCIE
+#    define UCSZn1 UCSZ1
+#    define UCSZn0 UCSZ0
+#    define UDRIEn UDRIE
+#    define USARTn_UDRE_vect USART_UDRE_vect
+#    define USARTn_RX_vect USART_RX_vect
+#elif defined(__AVR_ATmega328__) || defined(__AVR_ATmega328P__)
+#    define UDRn UDR0
+#    define UBRRnL UBRR0L
+#    define UCSRnA UCSR0A
+#    define UCSRnB UCSR0B
+#    define UCSRnC UCSR0C
+#    define U2Xn U2X0
+#    define RXENn RXEN0
+#    define TXENn TXEN0
+#    define RXCIEn RXCIE0
+#    define UCSZn1 UCSZ01
+#    define UCSZn0 UCSZ00
+#    define UDRIEn UDRIE0
+#    define USARTn_UDRE_vect USART_UDRE_vect
+#    define USARTn_RX_vect USART_RX_vect
+#endif
+
+// These buffers may be any size from 2 to 256 bytes.
+#define RX_BUFFER_SIZE 64
+#define TX_BUFFER_SIZE 256
+
+static volatile uint8_t tx_buffer[TX_BUFFER_SIZE];
+static volatile uint8_t tx_buffer_head;
+static volatile uint8_t tx_buffer_tail;
+static volatile uint8_t rx_buffer[RX_BUFFER_SIZE];
+static volatile uint8_t rx_buffer_head;
+static volatile uint8_t rx_buffer_tail;
+
+// Initialize the UART
+void uart_init(uint32_t baud) {
+    cli();
+    UBRRnL         = (F_CPU / 4 / baud - 1) / 2;
+    UCSRnA         = (1 << U2Xn);
+    UCSRnB         = (1 << RXENn) | (1 << TXENn) | (1 << RXCIEn);
+    UCSRnC         = (1 << UCSZn1) | (1 << UCSZn0);
+    tx_buffer_head = tx_buffer_tail = 0;
+    rx_buffer_head = rx_buffer_tail = 0;
+    sei();
+}
+
+// Transmit a byte
+void uart_putchar(uint8_t c) {
+    uint8_t i;
+
+    i = tx_buffer_head + 1;
+    if (i >= TX_BUFFER_SIZE) i = 0;
+    // return immediately to avoid deadlock when interrupt is disabled(called from ISR)
+    if (tx_buffer_tail == i && (SREG & (1 << SREG_I)) == 0) return;
+    while (tx_buffer_tail == i)
+        ;  // wait until space in buffer
+    // cli();
+    tx_buffer[i]   = c;
+    tx_buffer_head = i;
+    UCSRnB         = (1 << RXENn) | (1 << TXENn) | (1 << RXCIEn) | (1 << UDRIEn);
+    // sei();
+}
+
+// Receive a byte
+uint8_t uart_getchar(void) {
+    uint8_t c, i;
+
+    while (rx_buffer_head == rx_buffer_tail)
+        ;  // wait for character
+    i = rx_buffer_tail + 1;
+    if (i >= RX_BUFFER_SIZE) i = 0;
+    c              = rx_buffer[i];
+    rx_buffer_tail = i;
+    return c;
+}
+
+// Return whether the number of bytes waiting in the receive buffer is nonzero.
+// Call this before uart_getchar() to check if it will need
+// to wait for a byte to arrive.
+bool uart_available(void) {
+    uint8_t head, tail;
+
+    head = rx_buffer_head;
+    tail = rx_buffer_tail;
+    if (head >= tail) return (head - tail) > 0;
+    return (RX_BUFFER_SIZE + head - tail) > 0;
+}
+
+// Transmit Interrupt
+ISR(USARTn_UDRE_vect) {
+    uint8_t i;
+
+    if (tx_buffer_head == tx_buffer_tail) {
+        // buffer is empty, disable transmit interrupt
+        UCSRnB = (1 << RXENn) | (1 << TXENn) | (1 << RXCIEn);
+    } else {
+        i = tx_buffer_tail + 1;
+        if (i >= TX_BUFFER_SIZE) i = 0;
+        UDRn           = tx_buffer[i];
+        tx_buffer_tail = i;
+    }
+}
+
+// Receive Interrupt
+ISR(USARTn_RX_vect) {
+    uint8_t c, i;
+
+    c = UDRn;
+    i = rx_buffer_head + 1;
+    if (i >= RX_BUFFER_SIZE) i = 0;
+    if (i != rx_buffer_tail) {
+        rx_buffer[i]   = c;
+        rx_buffer_head = i;
+    }
+}
diff --git a/drivers/avr/uart.h b/drivers/avr/uart.h
new file mode 100644
index 0000000000..602eb3d8b0
--- /dev/null
+++ b/drivers/avr/uart.h
@@ -0,0 +1,35 @@
+/* UART Example for Teensy USB Development Board
+ * http://www.pjrc.com/teensy/
+ * Copyright (c) 2009 PJRC.COM, LLC
+ *
+ * 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.
+ */
+
+#pragma once
+
+#include <stdint.h>
+#include <stdbool.h>
+
+void uart_init(uint32_t baud);
+
+void uart_putchar(uint8_t c);
+
+uint8_t uart_getchar(void);
+
+bool uart_available(void);