Add BSPs for Microchip PIC32MZ MCUs

Two boards from Olimex are added:
olimex_hmz144  with PIC32MZ2048EFM144
olimex_emz64.c with PIC32MZ2048EFH064

Both can be programmed with Segger JLINK probe using ICSP
interface. (JTAG not tested but could also work but header
is not mounted).

hw/bsp/pic32mz/boards/olimex_emz64/board.mk

@@ -0,0 +1,5 @@
+JLINK_DEVICE=PIC32MZ2048EFH064
+JLINK_IF=ICSP
+
+CFLAGS += \
+  -mprocessor=32MZ2048EFH064 \

hw/bsp/pic32mz/boards/olimex_emz64/olimex_emz64.c

@@ -0,0 +1,144 @@
+/* 
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022 Jerzy Kasenberg
+ *
+ * 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.
+ *
+ * This file is part of the TinyUSB stack.
+ */
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <xc.h>
+#include "tusb.h"
+
+/* JTAG on, WDT off */
+#pragma config FDMTEN=0, FSOSCEN=0, DMTCNT=1
+#pragma config DEBUG=ON
+#pragma config JTAGEN=ON
+#pragma config FSLEEP=OFF
+#pragma config TRCEN=OFF
+#pragma config ICESEL=ICS_PGx2
+
+#pragma config POSCMOD = EC
+#pragma config FNOSC = SPLL
+/* 24MHz posc input to pll, div by 3, multiply by 50, div by 2 -> 200mhz*/
+#pragma config FPLLICLK=0, FPLLIDIV=DIV_3, FPLLRNG=RANGE_5_10_MHZ, FPLLMULT=MUL_50, FPLLODIV=DIV_2
+#pragma config FUSBIDIO=1
+#pragma config WINDIS=NORMAL
+#pragma config WDTSPGM=1
+#pragma config WDTPS=15
+#pragma config FWDTEN=OFF
+
+void button_init(void)
+{
+  // RB12 - button
+  // ANSELB B12 not analog
+  ANSELBCLR = TU_BIT(12);
+  // TRISB B12 input
+  TRISBSET = TU_BIT(12);
+  // Pull-up
+  CNPUBSET = TU_BIT(12);
+}
+
+void led_init(void)
+{
+  // RB8 - LED
+  // ANASELB RB8 not analog
+  ANSELBCLR = TU_BIT(8);
+  // TRISH RH2 input
+  TRISBCLR = TU_BIT(8);
+  // Initial value 0, LED off
+  LATBCLR = TU_BIT(8);
+}
+
+void uart_init(void)
+{
+  // RD4/RD0 Uart4 TX/RX
+  // ANSELD - not present on 64 pin device
+
+  /* Unlock system for PPS configuration */
+  SYSKEY = 0x00000000;
+  SYSKEY = 0xAA996655;
+  SYSKEY = 0x556699AA;
+  CFGCONbits.IOLOCK = 0;
+
+  // PPS Input Remapping
+  // U4RX -> RD0
+  U4RXR = 3;
+
+  // PPS Output Remapping
+  // RD4 -> U4TX
+  RPD4R = 2;
+
+  // Lock back the system after PPS configuration
+  CFGCONbits.IOLOCK = 1;
+  SYSKEY = 0x00000000;
+
+  // UART4
+  // High speed mode
+  // 8 bits, no parity, no RTS/CTS, no flow control
+  U4MODE = 0x0;
+
+  // Enable UART2 Receiver and Transmitter
+  U4STASET = (_U4STA_UTXEN_MASK | _U4STA_URXEN_MASK | _U4STA_UTXISEL1_MASK);
+
+  // BAUD Rate register Setup
+  U4BRG = 100000000 / (16 * 115200) + 1;
+
+  // Disable Interrupts
+  IEC4CLR = _IEC5_U4EIE_MASK | _IEC5_U4RXIE_MASK | _IEC5_U4TXIE_MASK;
+
+  // Turn ON UART2
+  U4MODESET = _U4MODE_ON_MASK;
+}
+
+//--------------------------------------------------------------------+
+// Board porting API
+//--------------------------------------------------------------------+
+
+void board_led_write(bool state)
+{
+  if (state)
+  {
+    LATBSET = TU_BIT(8);
+  }
+  else
+  {
+    LATBCLR = TU_BIT(8);
+  }
+}
+
+uint32_t board_button_read(void)
+{
+  return (PORTB >> 12) & 1;
+}
+
+int board_uart_write(void const * buf, int len)
+{
+  int i = len;
+  uint8_t const * data = buf;
+  while (i--)
+  {
+    while (U4STAbits.UTXBF) ;
+    U4TXREG = *data++;
+  }
+  return len;
+}

hw/bsp/pic32mz/boards/olimex_hmz144/board.mk

@@ -0,0 +1,5 @@
+JLINK_DEVICE=PIC32MZ2048EFM144
+JLINK_IF=ICSP
+
+CFLAGS += \
+  -mprocessor=32MZ2048EFM144 \

hw/bsp/pic32mz/boards/olimex_hmz144/olimex_hmz144.c

@@ -0,0 +1,142 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022 Jerzy Kasenberg
+ *
+ * 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.
+ *
+ * This file is part of the TinyUSB stack.
+ */
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <xc.h>
+#include "tusb.h"
+
+/* JTAG on, WDT off */
+#pragma config FDMTEN=0, FSOSCEN=0, DMTCNT=1
+#pragma config DEBUG=ON
+#pragma config JTAGEN=ON
+#pragma config FSLEEP=OFF
+#pragma config TRCEN=OFF
+#pragma config ICESEL=ICS_PGx2
+
+#pragma config POSCMOD = HS
+#pragma config FNOSC = SPLL
+/* 24MHz posc input to pll, div by 3, multiply by 50, div by 2 -> 200mhz*/
+#pragma config FPLLICLK=0, FPLLIDIV=DIV_3, FPLLRNG=RANGE_5_10_MHZ, FPLLMULT=MUL_50, FPLLODIV=DIV_2
+#pragma config FUSBIDIO=1
+#pragma config WINDIS=NORMAL
+#pragma config WDTSPGM=1
+#pragma config WDTPS=15
+#pragma config FWDTEN=OFF
+
+void button_init(void)
+{
+  // RB12 - button
+  // ANSELB B12 not analog
+  ANSELBCLR = TU_BIT(12);
+  // TRISB B12 input
+  TRISBSET = TU_BIT(12);
+}
+
+void led_init(void)
+{
+  // RH2 - LED
+  // ANASELH no analog function on RH2
+  // TRISH RH2 input
+  TRISHCLR = TU_BIT(2);
+  // Initial value 0, LED off
+  LATHCLR = TU_BIT(2);
+}
+
+void uart_init(void)
+{
+  // RE8/RE9 Uart2 TX/RX
+  // ANSELE - TX/RX not analog
+  ANSELECLR = TU_BIT(8) | TU_BIT(9);
+
+  /* Unlock system for PPS configuration */
+  SYSKEY = 0x00000000;
+  SYSKEY = 0xAA996655;
+  SYSKEY = 0x556699AA;
+  CFGCONbits.IOLOCK = 0;
+
+  // PPS Input Remapping
+  // U2RX -> RE9
+  U2RXR = 13;
+
+  // PPS Output Remapping
+  // RE8 -> U2TX
+  RPE8R = 2;
+
+  // Lock back the system after PPS configuration
+  CFGCONbits.IOLOCK = 1;
+  SYSKEY = 0x00000000;
+
+  // UART2
+  // High speed mode
+  // 8 bits, no parity, no RTS/CTS, no flow control
+  U2MODE = 0x0;
+
+  // Enable UART2 Receiver and Transmitter
+  U2STASET = (_U2STA_UTXEN_MASK | _U2STA_URXEN_MASK | _U2STA_UTXISEL1_MASK);
+
+  // BAUD Rate register Setup
+  U2BRG = 100000000 / (16 * 115200) + 1;
+
+  // Disable Interrupts
+  IEC4CLR = _IEC4_U2EIE_MASK | _IEC4_U2RXIE_MASK | _IEC4_U2TXIE_MASK;
+
+  // Turn ON UART2
+  U2MODESET = _U2MODE_ON_MASK;
+}
+
+//--------------------------------------------------------------------+
+// Board porting API
+//--------------------------------------------------------------------+
+
+void board_led_write(bool state)
+{
+  if (state)
+  {
+    LATHSET = TU_BIT(2);
+  }
+  else
+  {
+    LATHCLR = TU_BIT(2);
+  }
+}
+
+uint32_t board_button_read(void)
+{
+  return (PORTB >> 12) & 1;
+}
+
+int board_uart_write(void const * buf, int len)
+{
+  int i = len;
+  uint8_t const * data = buf;
+  while (i--)
+  {
+    while (U2STAbits.UTXBF) ;
+    U2TXREG = *data++;
+  }
+  return len;
+}

hw/bsp/pic32mz/family.c

@@ -0,0 +1,110 @@
+/* 
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022 Jerzy Kasenberg
+ *
+ * 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.
+ *
+ * This file is part of the TinyUSB stack.
+ */
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <xc.h>
+#include "tusb.h"
+
+void __attribute__((interrupt(IPL2AUTO), vector(_USB_VECTOR), no_fpu))
+USBD_IRQHandler(void)
+{
+  IFS4CLR = _IFS4_USBIF_MASK;
+  tud_int_handler(0);
+}
+
+TU_ATTR_WEAK void button_init(void)
+{
+}
+
+TU_ATTR_WEAK void led_init(void)
+{
+}
+
+TU_ATTR_WEAK void uart_init(void)
+{
+}
+
+void board_init(void)
+{
+  button_init();
+  led_init();
+  uart_init();
+
+  // Force device mode by overriding USB ID and settings it to 1
+  USBCRCONbits.PHYIDEN = 0;
+  USBCRCONbits.USBIDVAL = 1;
+  USBCRCONbits.USBIDOVEN = 1;
+
+  // set interrupt priority (must much IPL2AUTO)
+  IPC33CLR = _IPC33_USBIP_MASK;
+  IPC33SET = (2 << _IPC33_USBIP_POSITION);
+  // set interrupt subpriority
+  IPC33CLR = _IPC33_USBIS_MASK;
+  IPC33SET = (0 << _IPC33_USBIS_POSITION);
+
+  USBCRCONbits.USBIE = 0;
+  IFS4CLR = _IFS4_USBIF_MASK;
+  IEC4SET = _IEC4_USBIE_MASK;
+
+  __builtin_enable_interrupts();
+}
+
+//--------------------------------------------------------------------+
+// Board porting API
+//--------------------------------------------------------------------+
+
+TU_ATTR_WEAK void board_led_write(bool state)
+{
+  (void) state;
+}
+
+TU_ATTR_WEAK uint32_t board_button_read(void)
+{
+  return 0;
+}
+
+TU_ATTR_WEAK int board_uart_read(uint8_t * buf, int len)
+{
+  (void) buf;
+  (void) len;
+
+  return 0;
+}
+
+TU_ATTR_WEAK int board_uart_write(void const * buf, int len)
+{
+  (void) buf;
+  return len;
+}
+
+#if CFG_TUSB_OS  == OPT_OS_NONE
+uint32_t board_millis(void)
+{
+  // COUNTER is system clock (200MHz / 2 = 100MHz) convert to ms)
+  return _CP0_GET_COUNT() / (100000000 / 1000);
+}
+#endif

hw/bsp/pic32mz/family.mk

@@ -0,0 +1,20 @@
+CROSS_COMPILE = xc32-
+CFLAGS_OPTIMIZED = -O2
+LIBS_GCC = -lgcc -lm
+SKIP_NANOLIB = 1
+
+CFLAGS = \
+  -std=c99 \
+  -DCFG_TUSB_MCU=OPT_MCU_PIC32MZ
+
+include $(TOP)/$(BOARD_PATH)/board.mk
+
+SRC_C += \
+	src/portable/microchip/pic32mz/dcd_pic32mz.c \
+
+INC += \
+	$(TOP)/hw/mcu/microchip/pic32mz \
+	$(TOP)/$(BOARD_PATH) \
+
+# flash target using jlink
+flash: flash-jlink