From 0116a6ff62563efe439b1e33b95df50248aead6e Mon Sep 17 00:00:00 2001 From: Jacob Scheiffler <86001820+Jacob-Scheiffler@users.noreply.github.com> Date: Thu, 6 Jul 2023 09:36:06 -0500 Subject: [PATCH] chore(Examples): Test examples on Rev. B production silicon for MAX32655 (#649) --- Examples/MAX32655/ADC/README.md | 14 +++---- Examples/MAX32655/AES/README.md | 8 ++-- Examples/MAX32655/CRC/README.md | 8 ++-- Examples/MAX32655/Coremark/README.md | 8 ++-- Examples/MAX32655/DMA/README.md | 10 ++--- .../Dual_core_sync_arm/README.md | 10 ++--- .../Dual_core_sync_riscv/README.md | 4 +- Examples/MAX32655/EEPROM_Emulator/README.md | 7 ++-- Examples/MAX32655/External_Flash/README.md | 9 +++-- Examples/MAX32655/External_Flash/project.mk | 5 +++ Examples/MAX32655/FTHR_I2C/README.md | 11 +++--- Examples/MAX32655/FTHR_I2C/project.mk | 6 +++ Examples/MAX32655/Flash/README.md | 14 ++----- Examples/MAX32655/Flash/main.c | 3 +- Examples/MAX32655/Flash_CLI/README.md | 8 ++-- Examples/MAX32655/FreeRTOSDemo/README.md | 18 ++++++--- Examples/MAX32655/GPIO/README.md | 18 ++++----- Examples/MAX32655/Hello_World/README.md | 5 +-- Examples/MAX32655/I2C/README.md | 18 ++++----- Examples/MAX32655/I2C/main.c | 2 - Examples/MAX32655/I2C/project.mk | 5 +++ Examples/MAX32655/I2C_MNGR/README.md | 6 ++- Examples/MAX32655/I2C_MNGR/project.mk | 7 ++++ Examples/MAX32655/I2C_SCAN/README.md | 11 ++++-- Examples/MAX32655/I2C_Sensor/README.md | 4 +- Examples/MAX32655/I2C_Sensor/project.mk | 5 +++ Examples/MAX32655/I2S_Playback/README.md | 12 +++++- Examples/MAX32655/I2S_Playback/main.c | 4 ++ Examples/MAX32655/LP/README.md | 18 ++++----- Examples/MAX32655/LP/main.c | 4 +- Examples/MAX32655/LPCMP/README.md | 38 ++++++------------- Examples/MAX32655/Pulse_Train/README.md | 8 ++-- Examples/MAX32655/RTC/README.md | 23 ++++++----- Examples/MAX32655/RTC_Backup/README.md | 10 ++--- Examples/MAX32655/SPI/README.md | 9 ++--- Examples/MAX32655/TFT_Demo/README.md | 15 ++------ Examples/MAX32655/TFT_Demo/src/state.c | 3 -- Examples/MAX32655/TFT_Demo/src/state_home.c | 3 -- Examples/MAX32655/TFT_Demo/src/state_info.c | 3 -- Examples/MAX32655/TFT_Demo/src/state_keypad.c | 3 -- Examples/MAX32655/TFT_Demo/src/utils.c | 11 +++--- Examples/MAX32655/TMR/README.md | 10 ++--- Examples/MAX32655/TRNG/README.md | 11 ++---- Examples/MAX32655/Temp_Monitor/README.md | 4 +- Examples/MAX32655/Temp_Monitor/project.mk | 7 ++++ Examples/MAX32655/UART/README.md | 13 +++---- Examples/MAX32655/UART/project.mk | 5 +++ Examples/MAX32655/WUT/README.md | 15 +++----- Examples/MAX32655/Watchdog/README.md | 10 ++--- 49 files changed, 227 insertions(+), 236 deletions(-) diff --git a/Examples/MAX32655/ADC/README.md b/Examples/MAX32655/ADC/README.md index b050dff7f4c..1d11bee4d28 100644 --- a/Examples/MAX32655/ADC/README.md +++ b/Examples/MAX32655/ADC/README.md @@ -1,6 +1,6 @@ ## Description -Demonstrates the use of the ADC by continuously monitoring ADC input channel 0. Vary the voltage on the AIN0 input (0 to 1.8V) to observe different readings from the ADC. +Demonstrates the use of the ADC by continuously monitoring ADC input channel 0. Vary the voltage on the AIN0 input (0 to 1.22V) to observe different readings from the ADC. The example can be configured to either use a polling or interrupt driven ADC Conversion by commenting or uncommenting the "USE_INTERRUPTS" define respectively. @@ -17,19 +17,17 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit\_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -- Apply an input voltage between 0 and 0.9V to pin labeled 0 of the JH11 (Analog) header. +- Apply an input voltage between 0 and 1.22V to pin labeled "0" of the JH11 (Analog) header. -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -- Apply an input voltage between 0 and 0.9V to pin labeled 0 of the JH11 (Analog) header. +- Apply an input voltage between 0 and 1.22V to pin labeled "AIN0" on header J9. ## Expected Output diff --git a/Examples/MAX32655/AES/README.md b/Examples/MAX32655/AES/README.md index b6c24b6899d..925be036ed7 100644 --- a/Examples/MAX32655/AES/README.md +++ b/Examples/MAX32655/AES/README.md @@ -14,15 +14,13 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the standard EV Kit (EvKit\_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -If using the featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/CRC/README.md b/Examples/MAX32655/CRC/README.md index f1912c9f47c..136ae9fb90d 100644 --- a/Examples/MAX32655/CRC/README.md +++ b/Examples/MAX32655/CRC/README.md @@ -13,15 +13,13 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit\_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/Coremark/README.md b/Examples/MAX32655/Coremark/README.md index 52ef5b1ef42..3601cdaea8c 100644 --- a/Examples/MAX32655/Coremark/README.md +++ b/Examples/MAX32655/Coremark/README.md @@ -14,17 +14,19 @@ Universal instructions on building, flashing, and debugging this project can be ### Project-Specific Build Notes -To comply with the CoreMark rules, the only source files which are included in this example directory are the core_portme.c/.h files, the rest (including main) are located in the [Coremark](../../../Libraries/Coremark/) library. +* To comply with the CoreMark rules, the only source files which are included in this example directory are the core_portme.c/.h files, the rest (including main) are located in the [Coremark](../../../Libraries/Coremark/) library. + +* This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the UG for instructions on changing the target board. ## Required Connections -If using the Standard EV Kit (EvKit\_V1): +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - Close jumper JP2 (LED0 EN). - Close jumper JP3 (LED1 EN). -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/DMA/README.md b/Examples/MAX32655/DMA/README.md index 14b67662629..931cd7d468a 100644 --- a/Examples/MAX32655/DMA/README.md +++ b/Examples/MAX32655/DMA/README.md @@ -2,7 +2,7 @@ A simple DMA transaction is shown that copies a block of memory from one location to another. -A second more complex memory-to-memory DMA transaction is then shown that chains two transfers together. A callback function is used to notify the application once both transfers have completed. +A second more complex DMA transaction is then shown that chains two memory-to-memory transfers together. In the second example a callback function is used to notify the application once both transfers have completed. ## Software @@ -15,15 +15,13 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit\_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -If using the featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/Dual_core_sync/Dual_core_sync_arm/README.md b/Examples/MAX32655/Dual_core_sync/Dual_core_sync_arm/README.md index 428c1b6f07c..019db7b396a 100644 --- a/Examples/MAX32655/Dual_core_sync/Dual_core_sync_arm/README.md +++ b/Examples/MAX32655/Dual_core_sync/Dual_core_sync_arm/README.md @@ -1,6 +1,6 @@ ## Description -Projects Dual_core_sync_arm and Dual_core_sync_riscv demonstrates loading the RISC-V core program from the ARM core and synchronizing these two cores by hardware semaphores. +Projects Dual_core_sync_arm and Dual_core_sync_riscv demonstrate loading the RISC-V core program from the ARM core and synchronizing these two cores by hardware semaphores. Dual_core_sync_arm runs on the ARM core (CM4) to load the RISC-V core (RV32) code space, setup the RISC-V debugger pins, and start the RISC-V core. @@ -19,17 +19,15 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit\_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - Close jumper JP2 (LED0 EN). - Close jumper JP3 (LED1 EN). -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. - diff --git a/Examples/MAX32655/Dual_core_sync/Dual_core_sync_riscv/README.md b/Examples/MAX32655/Dual_core_sync/Dual_core_sync_riscv/README.md index 82f59b9ebee..163b63179cf 100644 --- a/Examples/MAX32655/Dual_core_sync/Dual_core_sync_riscv/README.md +++ b/Examples/MAX32655/Dual_core_sync/Dual_core_sync_riscv/README.md @@ -17,9 +17,7 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections +## Required Connections If using the Standard EV Kit (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. diff --git a/Examples/MAX32655/EEPROM_Emulator/README.md b/Examples/MAX32655/EEPROM_Emulator/README.md index 16276294f75..ec46a26f1d8 100644 --- a/Examples/MAX32655/EEPROM_Emulator/README.md +++ b/Examples/MAX32655/EEPROM_Emulator/README.md @@ -54,9 +54,8 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -If using the Standard EV Kit (EvKit\_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. @@ -66,7 +65,7 @@ If using the Standard EV Kit (EvKit\_V1): - Enabling the pullup jumper by selecting the approriate bus voltage with jumper JP21. - Connect Ready Signal (P0.27) to the pin used for ready signal on your micro. -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. - Connect pins SCL - P0.30 (J7.11) and SDA - P0.31 (J7.12) to the I2C Bus diff --git a/Examples/MAX32655/External_Flash/README.md b/Examples/MAX32655/External_Flash/README.md index d3f1494d28c..77e890470e2 100644 --- a/Examples/MAX32655/External_Flash/README.md +++ b/Examples/MAX32655/External_Flash/README.md @@ -1,7 +1,10 @@ ## Description -This example communicates with the W25 flash on the EvKit. It loads "Analog Devices" array onto it and then reads it back. +This example demonstrates how to use the External_Flash library to communicate with the W25 external flash chip on the EvKit. +In this example, a portion of the external flash memory is erased (and verified), then the string "Analog Devices" is loaded into the flash and then the data string is read back to verify the write was successful. + +The user may select between Quad and Single SPI interface modes by setting the value of the EXT_FLASH_SPIXFC_WIDTH definition at the top of main.c to either Ext_Flash_DataLine_Quad or Ext_Flash_DataLine_Single. ## Software @@ -11,10 +14,10 @@ Universal instructions on building, flashing, and debugging this project can be ### Project-Specific Build Notes -* This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. +* NOTE: This example is only supported by the MAX32655EVKIT. ## Required Connections - +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN2 (USB/PWR) connector. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/External_Flash/project.mk b/Examples/MAX32655/External_Flash/project.mk index f068448db8a..84a00ef404e 100644 --- a/Examples/MAX32655/External_Flash/project.mk +++ b/Examples/MAX32655/External_Flash/project.mk @@ -8,3 +8,8 @@ # ********************************************************** # Add your config here! + +# This example is only compatible with the MAX32655EVKIT +ifneq ($(BOARD),EvKit_V1) +$(error ERR_NOTSUPPORTED: This project is only supported on the MAX32655EVKIT. (see https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages)) +endif diff --git a/Examples/MAX32655/FTHR_I2C/README.md b/Examples/MAX32655/FTHR_I2C/README.md index 437d44c8657..a6125d6086f 100644 --- a/Examples/MAX32655/FTHR_I2C/README.md +++ b/Examples/MAX32655/FTHR_I2C/README.md @@ -2,7 +2,7 @@ This example uses I2C to cycle through the 8 colors of the RGB LED connected to the on-board MAX20303 Power Management IC. -*** NOTE ***: This example is only intended to be run on the MAX32655 Featherboard. +*** NOTE ***: This example is only intended to be run on the MAX32655FTHR. ## Software @@ -13,16 +13,15 @@ Universal instructions on building, flashing, and debugging this project can be ### Project-Specific Build Notes -* This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. +* NOTE: This project is only compatible with the MAX32655FTHR! -## Setup - -##### Required Connections +## Required Connections +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. ## Expected Behavior -The LED should change colors once a second, cycling through the 8 colors (off, blue, red, purple, green, light blue, yellow, white). +The PMIC RGB LED should change colors once a second, cycling through the 8 colors (off, blue, red, purple, green, light blue, yellow, white). The Console UART of the device will output these messages: diff --git a/Examples/MAX32655/FTHR_I2C/project.mk b/Examples/MAX32655/FTHR_I2C/project.mk index f068448db8a..10531df1073 100644 --- a/Examples/MAX32655/FTHR_I2C/project.mk +++ b/Examples/MAX32655/FTHR_I2C/project.mk @@ -8,3 +8,9 @@ # ********************************************************** # Add your config here! +override BOARD=FTHR_Apps_P1 + +# This example is only compatible with the MAX32655FTHR +ifneq ($(BOARD),FTHR_Apps_P1) +$(error ERR_NOTSUPPORTED: This project is only supported on the MAX32655FTHR. (see https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages)) +endif diff --git a/Examples/MAX32655/Flash/README.md b/Examples/MAX32655/Flash/README.md index 7f8d3831727..5405e527126 100644 --- a/Examples/MAX32655/Flash/README.md +++ b/Examples/MAX32655/Flash/README.md @@ -27,25 +27,17 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Hardware Connections - -If using the MAX32655EVKIT: +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect jumpers JP4 (RX_SEL) to RX0 and JP5 (TX_SEL) to TX0 - Open a terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -If using the MAX32655FTHR: - +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Open a terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -## Building and Running - -**See the [MSDK User Guide](https://analog-devices-msdk.github.io/msdk/USERGUIDE/)** for detailed instructions on building and running example projects from supported development environments. - -This example supports all available MAX32655 evaluation platforms but comes _pre-configured_ for the MAX32655EVKIT by default. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) for instructions on how to configure the project for a different board. - ## Expected Output After flashing and launching the example, an LED on the board will blink once every second. This is the application waiting for PushButton 1 (PB1) to be pressed, and gives a window for a serial terminal to be connected. After connecting the serial terminal, the application will output the following contents: diff --git a/Examples/MAX32655/Flash/main.c b/Examples/MAX32655/Flash/main.c index 90fd5ec4d3d..26be49744c1 100644 --- a/Examples/MAX32655/Flash/main.c +++ b/Examples/MAX32655/Flash/main.c @@ -54,6 +54,7 @@ #include "pb.h" /***** Definitions *****/ +#define WORDS_PER_FLASH_PG (MXC_FLASH_PAGE_SIZE / 4) #define TEST_ADDRESS (MXC_FLASH_MEM_BASE + MXC_FLASH_MEM_SIZE) - (1 * MXC_FLASH_PAGE_SIZE) /* ^ Points to last page in flash, which is guaranteed to be unused by this small example. @@ -205,7 +206,7 @@ int erase_magic() Therefore, the entire page must be buffered, erased, then modified. */ int err; - uint32_t buffer[MXC_FLASH_PAGE_SIZE >> 2] = { + uint32_t buffer[WORDS_PER_FLASH_PG] = { 0xFFFFFFFF }; // 8192 bytes per page / 4 bytes = 2048 uint32_t diff --git a/Examples/MAX32655/Flash_CLI/README.md b/Examples/MAX32655/Flash_CLI/README.md index 88d815c1fed..0de5258cc82 100644 --- a/Examples/MAX32655/Flash_CLI/README.md +++ b/Examples/MAX32655/Flash_CLI/README.md @@ -15,17 +15,15 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit\_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - Close jumper JP2 (LED0 EN). - Close jumper JP3 (LED1 EN). -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/FreeRTOSDemo/README.md b/Examples/MAX32655/FreeRTOSDemo/README.md index 80e274d0e32..31295bfecc5 100644 --- a/Examples/MAX32655/FreeRTOSDemo/README.md +++ b/Examples/MAX32655/FreeRTOSDemo/README.md @@ -13,18 +13,26 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit\_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. Also connect JP6 and JP7 for CTS/RTS signals. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. Enable CTS/RTS on PC terminal. - Close jumper JP2 (LED0 EN). - Close jumper JP3 (LED1 EN). -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. Enable CTS/RTS on PC terminal. ## Expected Output + +``` +-=- MAX32655 FreeRTOS (V10.5.1) Demo -=- +SystemCoreClock = 100000000 +Starting scheduler. +Uptime is 0x00000000 (0 seconds), tickless-idle is disabled + +Enter 'help' to view a list of available commands. +cmd> +``` \ No newline at end of file diff --git a/Examples/MAX32655/GPIO/README.md b/Examples/MAX32655/GPIO/README.md index c94d130b5ff..644e8ead3df 100644 --- a/Examples/MAX32655/GPIO/README.md +++ b/Examples/MAX32655/GPIO/README.md @@ -2,19 +2,19 @@ Basic GPIO input, output, and interrupts are demonstrated in this example. -PB1 is continuously scanned and whatever value is read on that pin is then output to LED 1. An interrupt is set up on button 2, LED 2 is toggled each time that button is pressed. +In this example, PB1 is continuously polled and the value read on its pin is output to LED1. As well, an interrupt is set up on PB2; each time PB2 is pressed, LED2 is toggled. On the Standard EV Kit: - PB1: P0.18/SW3 - PB2: P0.19/SW4 -- LED 1: P0.24/LED0 -- LED 2: P0.25/LED1 +- LED1: P0.24/LED0 +- LED2: P0.25/LED1 On the Featherboard: - PB1: P0.2/SW2 - PB2: P0.3/SW3 -- LED 1: P0.18/Red LED -- LED 2: P0.26/Blue LED +- LED1: P0.18/Red LED +- LED2: P0.26/Blue LED ## Software @@ -27,17 +27,15 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit\_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - Close jumper JP2 (LED0 EN). - Close jumper JP3 (LED1 EN). -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/Hello_World/README.md b/Examples/MAX32655/Hello_World/README.md index 53459f019c3..1f8f28cd91e 100644 --- a/Examples/MAX32655/Hello_World/README.md +++ b/Examples/MAX32655/Hello_World/README.md @@ -16,15 +16,14 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. ## Required Connections - -If using the Standard EV Kit (EvKit\_V1): +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - Close jumper JP2 (LED0 EN). - Close jumper JP3 (LED1 EN). -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/I2C/README.md b/Examples/MAX32655/I2C/README.md index d8a1296cc02..62f45ec05bb 100644 --- a/Examples/MAX32655/I2C/README.md +++ b/Examples/MAX32655/I2C/README.md @@ -1,7 +1,12 @@ ## Description -This example uses the I2C Master to read/write from/to the I2C Slave. +This is a basic getting started example for the I2C. +In this example, one I2C block is configured in master mode and another is configured in slave mode. + +The example will proceed as follows. The master and slave will each fill of their transmit buffers with identical data. The master will then transmit all data in it's transmit buffer to the slave. Next, the master will issue a repeated start and read request, and clock out all data bytes from the slave's transmit buffer. Once the entire transaction is complete the data received from the slave is compared against the master's transmit FIFO to ensure the master received the data successfully. + +NOTE: This example is not supported by the MAX32655FTHR kit due to a lack of exposed I2C ports. ## Software @@ -11,21 +16,16 @@ Universal instructions on building, flashing, and debugging this project can be ### Project-Specific Build Notes -* This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. +* NOTE: This project comes pre-configured for the MAX32655EVKIT. It is not supported by the MAX32655FTHR kit. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - You must connect P0.10 to P0.16 (SCL) and P0.11 to P0.17 (SCL). - You must also connect the pull-up jumpers (JP21 and JP22) to the proper I/O voltage. -If using the Featherboard (FTHR\_Apps\_P1): -- Only one I2C instance available. Example not supported. - ## Expected Output The Console UART of the device will output these messages: diff --git a/Examples/MAX32655/I2C/main.c b/Examples/MAX32655/I2C/main.c index 0d00d273862..43ed65e5ab3 100644 --- a/Examples/MAX32655/I2C/main.c +++ b/Examples/MAX32655/I2C/main.c @@ -51,8 +51,6 @@ #include "dma.h" /***** Definitions *****/ -// #define MASTERDMA - #define I2C_MASTER MXC_I2C1 #define I2C_SLAVE MXC_I2C0 diff --git a/Examples/MAX32655/I2C/project.mk b/Examples/MAX32655/I2C/project.mk index f068448db8a..84a00ef404e 100644 --- a/Examples/MAX32655/I2C/project.mk +++ b/Examples/MAX32655/I2C/project.mk @@ -8,3 +8,8 @@ # ********************************************************** # Add your config here! + +# This example is only compatible with the MAX32655EVKIT +ifneq ($(BOARD),EvKit_V1) +$(error ERR_NOTSUPPORTED: This project is only supported on the MAX32655EVKIT. (see https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages)) +endif diff --git a/Examples/MAX32655/I2C_MNGR/README.md b/Examples/MAX32655/I2C_MNGR/README.md index 37c29952b23..6282a90791e 100644 --- a/Examples/MAX32655/I2C_MNGR/README.md +++ b/Examples/MAX32655/I2C_MNGR/README.md @@ -6,6 +6,7 @@ More specifically, in this example the EEPROM0 task attempts to read data from E You may change the configuration of each EEPROM's I2C transaction parameters (slave address, bus frequency, EEPROM read address, transaction interval, I2C timeout) by modifying their definitions at the top of main. +NOTE: This example is not supported by the MAX32655FTHR. ## Software @@ -15,9 +16,10 @@ Universal instructions on building, flashing, and debugging this project can be ### Project-Specific Build Notes -* This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. +* This project comes pre-configured for the MAX32655EVKIT and is not yet supported on the MAX32655FTHR. -## Setup +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/I2C_MNGR/project.mk b/Examples/MAX32655/I2C_MNGR/project.mk index 315928bc48b..9368daff8b2 100644 --- a/Examples/MAX32655/I2C_MNGR/project.mk +++ b/Examples/MAX32655/I2C_MNGR/project.mk @@ -7,6 +7,13 @@ # ********************************************************** +# Add config here + +# This example is only compatible with the MAX32655EVKIT +ifneq ($(BOARD),EvKit_V1) +$(error ERR_NOTSUPPORTED: This project is only supported on the MAX32655EVKIT. (see https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages)) +endif + # Build the FreeRTOS Library LIB_FREERTOS = 1 diff --git a/Examples/MAX32655/I2C_SCAN/README.md b/Examples/MAX32655/I2C_SCAN/README.md index 3e05192511c..23761413a55 100644 --- a/Examples/MAX32655/I2C_SCAN/README.md +++ b/Examples/MAX32655/I2C_SCAN/README.md @@ -1,9 +1,8 @@ ## Description -This example uses the I2C Master to find the addresses of any I2C Slave devices connected to the same bus as I2C1. - -Please check schematic diagram to get more information about the discovered devices +This example uses the I2C Master to find the addresses of any I2C Slave devices connected to the same bus as I2C2 on the MAX32655EVKIT and I2C1 on the MAX32655FTHR. +Please check schematic diagram to get more information about the discovered devices. ## Software @@ -16,10 +15,16 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. ## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - You must also connect the pull-up jumpers (JP21 and JP22) to the proper I/O voltage. +- Connect I2C2 (SCL - P0.30 and SDA - P0.31) to the I2C bus to scan. + +If using the MAX32655FTHR (FTHR\_Apps\_V1): +- Connect a USB cable between the PC and the J4 (USB/PWR) connector. +- Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. ## Expected Output diff --git a/Examples/MAX32655/I2C_Sensor/README.md b/Examples/MAX32655/I2C_Sensor/README.md index d66a00e424b..93c6c5424e0 100644 --- a/Examples/MAX32655/I2C_Sensor/README.md +++ b/Examples/MAX32655/I2C_Sensor/README.md @@ -4,6 +4,7 @@ This example demonstrates how to take temperature readings from the MAX31889 usi After initialization, a new reading is printed to the terminal every second. +NOTE: This example is only supported on the MAX32655EVKIT. ## Software @@ -13,10 +14,11 @@ Universal instructions on building, flashing, and debugging this project can be ### Project-Specific Build Notes -* This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. +* This project comes pre-configured for the MAX32655EVKIT and is not yet supported by the MAX32655FTHR kit. ## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Select RX0 and TX0 on Headers JP1 and JP3 (UART 0). - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/I2C_Sensor/project.mk b/Examples/MAX32655/I2C_Sensor/project.mk index a53675ddcf9..8a7d81bf78a 100644 --- a/Examples/MAX32655/I2C_Sensor/project.mk +++ b/Examples/MAX32655/I2C_Sensor/project.mk @@ -9,7 +9,12 @@ # Add your config here! +# This example is only compatible with the MAX32655EVKIT +ifneq ($(BOARD),EvKit_V1) +$(error ERR_NOTSUPPORTED: This project is only supported on the MAX32655EVKIT. (see https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages)) +endif +# Include temperature sensor driver SRCS+=max31889_driver.c VPATH+=$(LIBS_DIR)/MiscDrivers/TempSensor diff --git a/Examples/MAX32655/I2S_Playback/README.md b/Examples/MAX32655/I2S_Playback/README.md index 48e924577b6..b0541d8943d 100644 --- a/Examples/MAX32655/I2S_Playback/README.md +++ b/Examples/MAX32655/I2S_Playback/README.md @@ -6,7 +6,6 @@ Once the green LED is illiuminated the system is ready to begin recording. Recor After the recording has finished the audio will begin playing after a 3 second delay. - ## Software ### Project Usage @@ -19,10 +18,19 @@ Universal instructions on building, flashing, and debugging this project can be ## Required Connections -- Connect a USB cable between the PC and the CN2 (USB/PWR) connector. +If using the Standard EV Kit (EvKit\_V1): +- Connect a USB cable between the PC and the CN1 (USB/PWR) connector. +- Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. +- Close jumper JP2 (LED0 EN). +- Close jumper JP3 (LED1 EN). - Plug in headphones to the headphone jack (connector J3). +If using the Featherboard (FTHR\_Apps\_P1): +- Connect a USB cable between the PC and the J4 (USB/PWR) connector. +- Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. +- Plug in headphones to the headphone jack (connector J2). + ## Expected Output ``` diff --git a/Examples/MAX32655/I2S_Playback/main.c b/Examples/MAX32655/I2S_Playback/main.c index b18b0397b64..774228b4450 100644 --- a/Examples/MAX32655/I2S_Playback/main.c +++ b/Examples/MAX32655/I2S_Playback/main.c @@ -137,6 +137,8 @@ int ext_flash_init(void) printf("Erase failed with error: %d", err); } + Ext_Flash_Quad(1); + return err; } @@ -265,5 +267,7 @@ int main() playback_audio(eor_addr); // Playback audio recording printf("Playback ended.\n"); + MXC_I2S_Shutdown(); + return E_NO_ERROR; } diff --git a/Examples/MAX32655/LP/README.md b/Examples/MAX32655/LP/README.md index 21a398fc0e3..9da0670deea 100644 --- a/Examples/MAX32655/LP/README.md +++ b/Examples/MAX32655/LP/README.md @@ -1,7 +1,10 @@ ## Description -TBD +This example demonstrates the steps to enter and exit the various low-power modes supported by the MAX32655. +Users may decide which low power modes they wish to enter by setting or clearing the DO_SLEEP, DO_LPM, DO_UPM, DO_BACKUP, and DO_STANDBY macros at the top of main. + +Users may also select whether they want to use a GPIO or RTC wakeup source. To use a GPIO wakeup source set the USE_BUTTON macro to 1; this will configure the GPIO connected to SW3 to send a wakeup signal each time the button is pressed. To use the RTC wakeup source set the USE_ALARM macro to 1; this will configure an RTC alarm to wake the device every DELAY_IN_SEC seconds. ## Software @@ -13,15 +16,13 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. @@ -35,10 +36,9 @@ The Console UART of the device will output these messages: This code cycles through the MAX32655 power modes, using a push button (PB1) to exit from each mode and enter the next. Running in ACTIVE mode. -All unused RAMs shutdown. Entering SLEEP mode. Waking up from SLEEP mode. -Entering DEEPSLEEP mode. -Waking up from DEEPSLEEP mode. +Entering LPM mode. +Waking up from LPM mode. ``` diff --git a/Examples/MAX32655/LP/main.c b/Examples/MAX32655/LP/main.c index 663d4ab765f..0a31a9f080f 100644 --- a/Examples/MAX32655/LP/main.c +++ b/Examples/MAX32655/LP/main.c @@ -82,8 +82,8 @@ #error "You must select either USE_BUTTON or USE_ALARM, not both." #endif -#if (DO_BACKUP && DO_STORAGE) -#error "You must select either DO_BACKUP or DO_STORAGE or neither, not both." +#if (DO_BACKUP && DO_STANDBY) +#error "You must select either DO_BACKUP or DO_STANDBY or neither, not both." #endif #if USE_CONSOLE diff --git a/Examples/MAX32655/LPCMP/README.md b/Examples/MAX32655/LPCMP/README.md index 5fc5e26d0f9..fef877dfd56 100644 --- a/Examples/MAX32655/LPCMP/README.md +++ b/Examples/MAX32655/LPCMP/README.md @@ -1,8 +1,8 @@ ## Description -This example demonstrates the use of the Analog Comparator to wake up the device from sleep mode. +A basic getting started program. -The example is configured to use analog channels 0 and 1 as the negative and positive comparator inputs respectively. A wakeup event is triggered when the comparator output transitions from low to high (analog 1 needs to transition from a voltage lower than analog 0 to voltage higher than analog 0). +This version of Hello_World prints an incrementing count to the console UART and toggles a GPIO (P1.14 - LED1) once every 500 ms. ## Software @@ -15,40 +15,24 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. - -##### Required Connections -If using the Standard EV Kit (EvKit_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -- Apply the negative comparator input to AIN0/AIN0N (JH11). -- Apply the positive comparator input to AIN1/AIN0P (JH11). - -If using the Featherboard (FTHR\_Apps\_P1): -- Connect a USB cable between the PC and the J4 (USB/PWR) connector. -- Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. ## Expected Output The Console UART of the device will output these messages: ``` -********** Comparator Example ********** - -Connect the analog signal used as the positive comparator input 1 (AIN1/AIN0P). -Connect the analog signal used as the negative comparator input 0 (AIN0/AIN0N). - -The device will be placed in sleep mode and requires a rising edge of the -comparator output to wakeup. +***********Hello World!*********** -Press SW3 to begin. +LED1 on P1.14 toggles every 500 ms -Entering sleep mode. -Waking up. - -Entering sleep mode. -Waking up. - -Entering sleep mode. -... +Count = 0 +Count = 1 +Count = 2 +Count = 3 ``` + diff --git a/Examples/MAX32655/Pulse_Train/README.md b/Examples/MAX32655/Pulse_Train/README.md index 32fa35d18e0..233ce5dc322 100644 --- a/Examples/MAX32655/Pulse_Train/README.md +++ b/Examples/MAX32655/Pulse_Train/README.md @@ -25,17 +25,15 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - Connect pin 16 of JH7 (GPIO 0 Port) to pin 1 of JP2 (LED0). - Connect pin 17 of JH7 (GPIO 0 Port) to pin 1 of JP3 (LED1). -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/RTC/README.md b/Examples/MAX32655/RTC/README.md index 5ce79a1dd8e..f5c7a5e90d5 100644 --- a/Examples/MAX32655/RTC/README.md +++ b/Examples/MAX32655/RTC/README.md @@ -2,22 +2,23 @@ This example demonstrates the use of the Real Time Clock (RTC) and its alarm functionality. -The RTC is enabled and the sub-second alarm set to trigger every 250 ms. -(LED 1) is toggled each time the sub-second alarm triggers. The time-of-day alarm is set to 10 seconds. When the time-of-day alarm triggers, the rate of the sub-second alarm is switched to 500 ms. +The RTC sub-second alarm is initially set to trigger every 250ms. Each time the sub-second alarm triggers, LED1 is toggled. + +The RTC time-of-day alarm is also enabled and set to trigger every 10 seconds by default. When the time-of-day alarm triggers, the rate of the sub-second alarm is switched (alternating between 250ms and 500ms), LED2 is toggled and the alarm is re-armed for another 10 seconds. -(LED 2) is toggled each time the time-of-day alarm triggers. The time-of-day alarm is then rearmed for another 10 sec. Pressing PB1 will output the current value of the RTC to the console UART. +Pressing PB1 will output the current value of the RTC to the console UART. On the Standard EV Kit: - PB1: P0.18/SW3 - PB2: P0.19/SW4 -- LED 1: P0.24/LED0 -- LED 2: P0.25/LED1 +- LED1: P0.24/LED0 +- LED2: P0.25/LED1 On the Featherboard: - PB1: P0.2/SW2 - PB2: P0.3/SW3 -- LED 1: P0.18/Red LED -- LED 2: P0.19/Green LED +- LED1: P0.18/Red LED +- LED2: P0.19/Green LED ## Software @@ -30,17 +31,15 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - Close jumper JP2 (LED0 EN). - Close jumper JP3 (LED1 EN). -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/RTC_Backup/README.md b/Examples/MAX32655/RTC_Backup/README.md index da36a40bbf7..95f85b696c0 100644 --- a/Examples/MAX32655/RTC_Backup/README.md +++ b/Examples/MAX32655/RTC_Backup/README.md @@ -4,8 +4,6 @@ This example demonstrates the use of the Real Time Clock (RTC) and its alarm fun The RTC time-of-day alarm is used to wake the device from backup mode every TIME\_OF\_DAY\_SECONDS seconds (defined at the top of main.c). When the device wakes up, it will print the current time of the RTC to the terminal window and return to backup mode while waiting for the next time-of-day alarm to fire. - - ## Software ### Project Usage @@ -16,15 +14,13 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit\_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -If using the featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/SPI/README.md b/Examples/MAX32655/SPI/README.md index bb7e56d599c..eec70e54500 100644 --- a/Examples/MAX32655/SPI/README.md +++ b/Examples/MAX32655/SPI/README.md @@ -18,18 +18,17 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - Connect pins labeled 5 and 6 on JH7 (GPIO PORT 0) together. -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. +- Connect pins P0.21 (J9.12) and P0.22 (J9.13) together. ## Expected Output diff --git a/Examples/MAX32655/TFT_Demo/README.md b/Examples/MAX32655/TFT_Demo/README.md index c62c6979fb5..afe83db8317 100644 --- a/Examples/MAX32655/TFT_Demo/README.md +++ b/Examples/MAX32655/TFT_Demo/README.md @@ -2,7 +2,6 @@ This examples demonstrates the use of the TFT display and the touchscreen controller. - ## Software ### Project Usage @@ -11,24 +10,16 @@ Universal instructions on building, flashing, and debugging this project can be ### Project-Specific Build Notes -* This project comes pre-configured only for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions. - -## Setup +* This project is only supported on the MAX32655EVKIT. -##### Board Selection - -### Required Connections -If using the Standard EV Kit (EvKit\_V1): +## Required Connections +On the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - Close jumper JP2 (LED0 EN). - Close jumper JP3 (LED1 EN). -If using the Featherboard (FTHR\_Apps\_P1): -- Connect a USB cable between the PC and the J4 (USB/PWR) connector. -- Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. - ## Expected Output Output is displayed onto TFT display. diff --git a/Examples/MAX32655/TFT_Demo/src/state.c b/Examples/MAX32655/TFT_Demo/src/state.c index e63cbcfae96..ea1eb7701cf 100644 --- a/Examples/MAX32655/TFT_Demo/src/state.c +++ b/Examples/MAX32655/TFT_Demo/src/state.c @@ -1,6 +1,3 @@ -/* - * @file state.c - * /****************************************************************************** * Copyright (C) 2023 Maxim Integrated Products, Inc., All Rights Reserved. * diff --git a/Examples/MAX32655/TFT_Demo/src/state_home.c b/Examples/MAX32655/TFT_Demo/src/state_home.c index df6dc5e15dc..9460fb2c4d4 100644 --- a/Examples/MAX32655/TFT_Demo/src/state_home.c +++ b/Examples/MAX32655/TFT_Demo/src/state_home.c @@ -1,6 +1,3 @@ -/* - * @file state_home.c - * /****************************************************************************** * Copyright (C) 2023 Maxim Integrated Products, Inc., All Rights Reserved. * diff --git a/Examples/MAX32655/TFT_Demo/src/state_info.c b/Examples/MAX32655/TFT_Demo/src/state_info.c index 95a4ee4c2d7..65bb1a822c2 100644 --- a/Examples/MAX32655/TFT_Demo/src/state_info.c +++ b/Examples/MAX32655/TFT_Demo/src/state_info.c @@ -1,6 +1,3 @@ -/* - * @file state_info.c - * /****************************************************************************** * Copyright (C) 2023 Maxim Integrated Products, Inc., All Rights Reserved. * diff --git a/Examples/MAX32655/TFT_Demo/src/state_keypad.c b/Examples/MAX32655/TFT_Demo/src/state_keypad.c index 10402e79479..3fff56a877f 100644 --- a/Examples/MAX32655/TFT_Demo/src/state_keypad.c +++ b/Examples/MAX32655/TFT_Demo/src/state_keypad.c @@ -1,6 +1,3 @@ -/* - * @file state_home.c - * /****************************************************************************** * Copyright (C) 2023 Maxim Integrated Products, Inc., All Rights Reserved. * diff --git a/Examples/MAX32655/TFT_Demo/src/utils.c b/Examples/MAX32655/TFT_Demo/src/utils.c index b6a56af3e2f..cf6df22dce2 100644 --- a/Examples/MAX32655/TFT_Demo/src/utils.c +++ b/Examples/MAX32655/TFT_Demo/src/utils.c @@ -43,12 +43,13 @@ /************************ PUBLIC FUNCTIONS *******************************/ unsigned int utils_get_time_ms(void) { - uint32_t sec; - uint32_t subsec; - uint32_t ms; + uint32_t sec, ssec; + double subsec; + unsigned int ms; + + MXC_RTC_GetSubSeconds(&ssec); + subsec = ssec / 4096.0; - MXC_RTC_GetSubSeconds(&subsec); - subsec /= 4096; MXC_RTC_GetSeconds(&sec); ms = (sec * 1000) + (subsec * 1000); diff --git a/Examples/MAX32655/TMR/README.md b/Examples/MAX32655/TMR/README.md index 2343b710f72..88e0b69c561 100644 --- a/Examples/MAX32655/TMR/README.md +++ b/Examples/MAX32655/TMR/README.md @@ -31,17 +31,15 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. -- Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. +- Connect pins JP4(RX\_SEL) and JP5(TX\_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - Close jumper JP1 (LED0 EN). - Close jumper JP2 (LED1 EN). -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/TRNG/README.md b/Examples/MAX32655/TRNG/README.md index 6e5980e4fcf..426123d1543 100644 --- a/Examples/MAX32655/TRNG/README.md +++ b/Examples/MAX32655/TRNG/README.md @@ -2,7 +2,6 @@ The true random number generator (TRNG) hardware is exercised in this example. Random values are generated both using the blocking and non-blocking (asynchronous) functions. - ## Software ### Project Usage @@ -13,15 +12,13 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. -- Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. +- Connect pins JP4(RX\_SEL) and JP5(TX\_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/Temp_Monitor/README.md b/Examples/MAX32655/Temp_Monitor/README.md index 5c83425c554..469846087a1 100644 --- a/Examples/MAX32655/Temp_Monitor/README.md +++ b/Examples/MAX32655/Temp_Monitor/README.md @@ -10,6 +10,7 @@ Additionally, pressing push button SW3 will print the last 12 temperature readin The temperature limits, flash storage page, and RTC time-of-day alarm period are defined in [temp_monitor.c](./temp_monitor.c) with the HI/LO\_TEMP\_THRESHOLD, TR\_STORAGE\_PAGE, and TEMP\_CHECK\_PERIOD defines respectively. +NOTE: This example is only supported by the MAX32655EVKIT. ## Software @@ -19,10 +20,11 @@ Universal instructions on building, flashing, and debugging this project can be ### Project-Specific Build Notes -* This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. +* This project comes pre-configured for the MAX32655EVKIT and is not yet supported by the MAX32655FTHR. ## Required Connections +If using the MAX32655EVKIT: - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/Temp_Monitor/project.mk b/Examples/MAX32655/Temp_Monitor/project.mk index 7e3d664eac1..80ad8443fb1 100644 --- a/Examples/MAX32655/Temp_Monitor/project.mk +++ b/Examples/MAX32655/Temp_Monitor/project.mk @@ -7,6 +7,13 @@ # ********************************************************** +# Add config here + +# This example is only compatible with the MAX32655EVKIT +ifneq ($(BOARD),EvKit_V1) +$(error ERR_NOTSUPPORTED: This project is only supported on the MAX32655EVKIT. (see https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages)) +endif + # Include MAX31889 drivers from MiscDrivers library. SRCS+=max31889_driver.c diff --git a/Examples/MAX32655/UART/README.md b/Examples/MAX32655/UART/README.md index 279855ede98..ae29bca3436 100644 --- a/Examples/MAX32655/UART/README.md +++ b/Examples/MAX32655/UART/README.md @@ -2,7 +2,6 @@ This application uses two serial ports to send and receive data. One serial port transmits data while the other receives it. - ## Software ### Project Usage @@ -11,19 +10,17 @@ Universal instructions on building, flashing, and debugging this project can be ### Project-Specific Build Notes -* This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. - -## Setup +* This project comes pre-configured for the MAX32655EVKIT and is not supported by the MAX32655FTHR kit. -### Required Connections -If using the Standard EV Kit (EvKit_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. -- Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. +- Connect pins JP4(RX\_SEL) and JP5(TX\_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. - Connect JH13 (P2.6) to JH8 (P1.1). - Connect JH13 (P2.7) to JH8 (P1.0). -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Only one UART instance available. Example not supported. ## Expected Output diff --git a/Examples/MAX32655/UART/project.mk b/Examples/MAX32655/UART/project.mk index f068448db8a..84a00ef404e 100644 --- a/Examples/MAX32655/UART/project.mk +++ b/Examples/MAX32655/UART/project.mk @@ -8,3 +8,8 @@ # ********************************************************** # Add your config here! + +# This example is only compatible with the MAX32655EVKIT +ifneq ($(BOARD),EvKit_V1) +$(error ERR_NOTSUPPORTED: This project is only supported on the MAX32655EVKIT. (see https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages)) +endif diff --git a/Examples/MAX32655/WUT/README.md b/Examples/MAX32655/WUT/README.md index 78680ac9b05..d166ab4bf5a 100644 --- a/Examples/MAX32655/WUT/README.md +++ b/Examples/MAX32655/WUT/README.md @@ -1,13 +1,12 @@ ## Description -This Example shows how to wake up a device after it is asleep with a wake up timer. After a defined number of seconds it will wake up after going to sleep. +This Example shows how to wake up a device with a wake up timer. Pressing PB0 will enable the wakeup timer and place the device in a low-power mode. After a defined number of seconds (5s by default) the wakeup timer will wake the device. -On the standard EV Kit: +On the MAX32655EVKIT: - PB0: P0.18/SW3 -On the Featherboard: +On the MAX32655FTHR: - PB0: P0.2/SW2 - ## Software ### Project Usage @@ -18,15 +17,13 @@ Universal instructions on building, flashing, and debugging this project can be * This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. diff --git a/Examples/MAX32655/Watchdog/README.md b/Examples/MAX32655/Watchdog/README.md index 6a5de955b78..b701df7cfb7 100644 --- a/Examples/MAX32655/Watchdog/README.md +++ b/Examples/MAX32655/Watchdog/README.md @@ -24,17 +24,15 @@ Universal instructions on building, flashing, and debugging this project can be ### Project-Specific Build Notes -* This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. +* This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analog-devices-msdk.github.io/msdk/USERGUIDE/#board-support-packages) in the UG for instructions on changing the target board. -## Setup - -### Required Connections -If using the Standard EV Kit (EvKit_V1): +## Required Connections +If using the MAX32655EVKIT (EvKit\_V1): - Connect a USB cable between the PC and the CN1 (USB/PWR) connector. - Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. - Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -If using the Featherboard (FTHR\_Apps\_P1): +If using the MAX32655FTHR (FTHR\_Apps\_P1): - Connect a USB cable between the PC and the J4 (USB/PWR) connector. - Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1.