Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(Examples): Try to clarify UART capabilities #1171

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Examples/MAX32690/Dual_Core_Sync/Dual_core_sync_arm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,11 @@ Universal instructions on building, flashing, and debugging this project can be

## Required Connections

Connect a MAXPICO or other supported Debug adapter to the SWD Connector.
- Note: Debug adapters other than the MAXPICO may not route the UART signals to the SWD connector. On MAX32690FTHR and AD-APARD32690-SL boards, this may limit your ability to access to serial port.

If using the MAX32690EVKIT:
- Connect a USB cable between the PC and the CN2 (USB/PWR) connector.
- Connect a USB cable between the PC and the CN2 (USB/PWR - UART) connector.
- Install JP7(RX_EN) and JP8(TX_EN) headers.
- Open a terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1.
- Close jumper JP5 (LED1 EN).
Expand All @@ -36,7 +39,6 @@ If using the MAX32690FTHR:

If using the AD-APARD32690-SL:
- Connect a USB cable between the PC and the P10 (USB-C) connector.
- Connect a MAXPICO Debug adapter to P9 (SWD Connector)
- Open a terminal application on the PC and connect to the MAXPICO's console UART at 115200, 8-N-1.

## Expected Output
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,11 @@ Universal instructions on building, flashing, and debugging this project can be

## Required Connections

Connect a MAXPICO or other supported Debug adapter to the SWD Connector.
- Note: Debug adapters other than the MAXPICO may not route the UART signals to the SWD connector. On MAX32690FTHR and AD-APARD32690-SL boards, this may limit your ability to access to serial port.

If using the MAX32690EVKIT:
- Connect a USB cable between the PC and the CN2 (USB/PWR) connector.
- Connect a USB cable between the PC and the CN2 (USB/PWR - UART) connector.
- Install JP7(RX_EN) and JP8(TX_EN) headers.
- Open a terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1.
- Close jumper JP5 (LED1 EN).
Expand All @@ -34,5 +37,4 @@ If using the MAX32690FTHR:

If using the AD-APARD32690-SL:
- Connect a USB cable between the PC and the P10 (USB-C) connector.
- Connect a MAXPICO Debug adapter to P9 (SWD Connector)
- Open a terminal application on the PC and connect to the MAXPICO's console UART at 115200, 8-N-1.
8 changes: 4 additions & 4 deletions Examples/MAX32690/Hello_World/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@ Universal instructions on building, flashing, and debugging this project can be

## Required Connections

Connect a MAXPICO or other supported Debug adapter to the SWD Connector.
- Note: Debug adapters other than the MAXPICO may not route the UART signals to the SWD connector. On MAX32690FTHR and AD-APARD32690-SL boards, this may limit your ability to access to serial port.

If using the MAX32690EVKIT:
- Connect a USB cable between the PC and the CN2 (USB/PWR) connector.
- Connect a USB cable between the PC and the CN2 (USB/PWR - UART) connector.
- Install JP7(RX_EN) and JP8(TX_EN) headers.
- Open a terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1.
- Close jumper JP5 (LED1 EN).
Expand All @@ -29,10 +32,7 @@ If using the MAX32690FTHR:

If using the AD-APARD32690-SL:
- Connect a USB cable between the PC and the P10 (USB-C) connector.
- Connect a MAXPICO Debug adapter to P9 (SWD Connector)
- Open a terminal application on the PC and connect to the MAXPICO's console UART at 115200, 8-N-1.
- Note: Non MAXPICO emulators may not route the UART signals to the SWD
connector, limiting your ability to access to serial port.

## Expected Output

Expand Down
3 changes: 2 additions & 1 deletion Examples/MAX78002/Hello_World/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ 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.
- Connect a MAXPICO or other supported Debug adapter to the SWD Connector.
- Connect a USB cable between the PC and the CN2 (USB/UART) connector.
- Connect the 5V power cable at (5V IN).
- Close jumper (RX - P0.0) and (TX - P0.1) at Headers JP23 (UART 0 EN).
- Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1.
Expand Down
10 changes: 10 additions & 0 deletions Examples/MAX78002/RV_ARM_Loader/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ Universal instructions on building, flashing, and debugging this project can be

* The application to load into the RISC-V core can be selected using the `RISCV_APP` option in [project.mk](project.mk). By default, the `Hello_World` example is used.

## Required Connections

- Connect a MAXPICO or other supported Debug adapter to the SWD Connector.
- Connect a USB cable between the PC and the CN2 (USB/UART) connector.
- Connect the 5V power cable at (5V IN).
- Close jumper (RX - P0.0) and (TX - P0.1) at Headers JP23 (UART 0 EN).
- Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1.
- Close jumper JP1 (LED1 EN).
- Close jumper JP2 (LED2 EN).

## Expected Output

The Console UART of the device will output whatever the expected output for the `RISCV_APP`-selected project is. By default, that's the `Hello_World` output:
Expand Down
Loading