Reprogramming the PineTime

2021-04-10T15:38:05Z

Guenter: Typo

= Introduction =

The PineTime Dev Kit comes with the back not glued down to allow it to be easily reprogrammed, however the kit does not include an hardware programmer/debugger.

'''Before you can use your debugger/programmer, you probably have to [[PineTime devkit wiring|wire up your pinetime]]. Heavily recommended you read this first!'''

There is a bewildering variety of different hardware programmers available but whatever programmer you have there are only a few tasks you will have to learn about:

* Unlocking the device '''Note: PineTime watches shipped after 20 Sep 2020 do not require unlocking. They are shipped unlocked.'''
* Uploading new software
* Running a debugger

All of these are described in this article.

Unlocking the device is a one-time action that is needed to enable the debug port and provide full access to the device. Unlocking the device will erase all existing software from the internal flash.

= SWD Pinout =

See [[PineTime devkit wiring|PineTime devkit wiring]]

= nrfjprog (for Segger JLink) =

The following steps have been tested with the Segger JLink embedded in the [https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52-DK NRF52-DK development board].

=== Hookup ===

Connect the Pinetime SWD pins to the debugger (P20 on NRF52-DK)

{| class="wikitable"
!Pinetime
!JLink
|-
|GND
|GND
|-
|SWDCLK
|SWDCLK
|-
|SWDIO
|SWDIO
|-
|VCC (3.3V)
|VTG (target detect)
|}

=== Unlocking the FLASH ===

Unlocking the device and erase the memory.

'''You need to execute this step only once, to remove the read protection on the memory. Note that it will erase the whole flash memory of the MCU!''' :

nrfjprog -f NRF52 --recover

=== Uploading new software ===

1. Program the BLE softdevice (if needed by the firmware). Replace PATH_TO_NRF_SDK by the path where you unzipped the [https://www.nordicsemi.com/Software-and-Tools/Software/nRF5-SDK NRF52 SDK] :

nrfjprog -f NRF52 --program /PATH_TO_NRF_SDK/components/softdevice/s132/hex/s132_nrf52_6.1.1_softdevice.hex --sectorerase

2. Program the firmware (replace firmware.hex by the actual filename of the firmware):

nrfjprog -f NRF52 --program firmware.hex --sectorerase

3. Reset and run the new firmware:

nrfjprog -f NRF52 --reset

= OpenOCD =

OpenOCD, the Open On-Chip Debugger supports multiple different adapters. You can read more about it here: http://openocd.org/

== Adapters ==

These examples allow you to use telnet to issue futher commands to the devkit. Using them you can connect to ''127.0.0.1'' (''localhost'') port ''4444'' using telnet and invoke OpenOCD commands. GDB should also be available on port ''3333''.

You can simplify your life by creating a configuration file that contains the interface, transport, target and speed configuration. Things like CLion also need one to work properly.

If you aren't using the latest version of OpenOCD, you might need to substitute things in these examples with older syntax (e.g. instead of ''adapter speed'' it's ''adapter_khz'').

=== CMSIS-DAP ===

Issue this command to initialize a connection to the devkit:

openocd \
-c 'source [find interface/cmsis-dap.cfg]' \
-c 'transport select swd' \
-c 'source [find target/nrf52.cfg]' \
-c 'adapter speed 8000' \
-c 'init'

=== JLink ===

Start OpenOCD:

openocd \
-c 'source [find interface/jlink.cfg]' \
-c 'transport select swd' \
-c 'source [find target/nrf52.cfg]' \
-c 'adapter speed 8000' \
-c 'init'

=== Raspberry Pi ===

openocd \
-c 'source bcm2835spi' \
-c 'bcm2835spi_speed 31200' \
-c 'source [find target/nrf52.cfg]' \
-c 'init'

=== STLink ===

Connect PineTime SWD Pins to ST-Link v2 as follows:

{| class="wikitable"
!PineTime
!ST-Link
|-
|GND
|GND
|-
|SWDCLK
|SWDCLK
|-
|SWDIO
|SWDIO
|-
|VCC (3.3V)
|3.3V
|}

[[File:pinetime-stlink.jpg|400px]]

Note that only the bottom row of pins on ST-Link are used.

To flash PineTime with ST-Link on Linux and macOS, use [https://github.com/lupyuen/pinetime-updater/blob/master/README.md PineTime Updater]

[[PineTime FAQ|'''ST-Link can't be used to remove nRF52 flash protection''']]

== Unlocking the device ==

If you need to disable access port protection then you can do this using the following commands below.

This can be done in two ways:

Appending this to OpenOCD command line:

-c 'nrf52.dap apreg 1 0x04' -c 'nrf52.dap apreg 1 0x04 0x01' -c 'nrf52.dap apreg 1 0x04'

Or by using the telnet connection, just type in ''telnet localhost 4444'' and then you can issue commands to OpenOCD:

Note: ''Unlocking the device to remove access port protection will erase the contents of flash.''

telnet localhost 4444
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
Open On-Chip Debugger
> nrf52.dap apreg 1 0x04
0x00000000
> nrf52.dap apreg 1 0x04 0x01
> nrf52.dap apreg 1 0x04
0x00000001

(If the ''nrf52.dap'' command cannot be found, try just ''dap'' instead.)

== Uploading new software ==

Just issue this command, replace ''code.hex'' with your own (and cmsis-dap.cfg with an appropriate adapter).

openocd \
-c 'source [find interface/cmsis-dap.cfg]' \
-c 'transport select swd' \
-c 'source [find target/nrf52.cfg]' \
-c 'init' \
-c 'nrf5 mass_erase' \
-c 'program code.hex verify' \
-c 'reset' \
-c 'exit'

= Black Magic Probe =

BlackMagic Probe is an JTAG/SWD adapter with open-source firmware, allowing for it to be ported to a multitude of different boards. One of it's defining features is lack of need for intermediate software such as OpenOCD - one would just need to connect to the GDB server running on the chip and proceed with debugging. For more information, refer to [https://github.com/blacksphere/blackmagic/wiki wiki].

=== Native adapters ===

The native adapters are the official Black Magic family of debug adapters, including the original Black Magic Probe and the Black Magic Probe Mini. By buying the official hardware you are supporting the continued development of the Black Magic Probe software.

Providing your native adapter is running up-to-date firmware then it can be used to program your PineTime.

=== STM32 (Blue Pill) ===

It is possible to flash a popular development board based on STM32F103C8T6 microcontroller, known as Blue Pill, to make a BlackMagic Probe device. For example, one may follow instructions in [https://forum.pine64.org/showthread.php?tid=8816&pid=57095#pid57095 forum post] or [https://gist.github.com/darnel/dac1370d057e176386ca4026418abc2b gist] (mac os). Also, it is possible to use SWD pins on the board to flash other devices, instead using arbitrary pins on the board itself. See [https://buger.dread.cz/black-magic-probe-bmp-on-bluepill-stm32f103c8-minimum-system-development-board.html this link] for more detals.

=== Other hardware ===

The Black Magic Probe firmware can be run on a variety of host devices. See [https://github.com/blacksphere/blackmagic/wiki/Debugger-Hardware BMP Debugger Hardware] for more information.

=== Using the BMP to flash the PineTime ===

Refer to the BMP [https://github.com/blacksphere/blackmagic/wiki/Useful-GDB-commands wiki] for the full description of commands.
Overall, the process on Linux is like following. (/dev/ttyBmpGdb is a symlink created by the udev rule). It's useful to create a gdb script file (or .gdbinit) with following commands:

target extended-remote /dev/ttyBmpGdb
monitor swdp_scan
attach 1
file %firmware file%

Then one may use '''load''' command to flash the firmware, '''compare-sections''' to verify the upload, or '''monitor erase_mass''' to erase the firmware.

Then, proceed with debugging as normal.

= External links and additional tutorials =

* https://github.com/jlukanc1/pinetime-boot-flasher
* https://blog.aegrel.ee/absniffer-cmsis-dap-sniffer.html
* https://blog.dbrgn.ch/2020/5/16/nrf52-unprotect-flash-jlink-openocd/
* https://medium.com/@ly.lee/openocd-on-raspberry-pi-better-with-swd-on-spi-7dea9caeb590
* https://medium.com/@ly.lee/build-and-flash-rust-mynewt-firmware-for-pinetime-smart-watch-5e14259c55

[[Category:PineTime]]

InfiniTime

2020-11-05T10:24:08Z

Guenter: Typo

== InfiniTime ==
InfiniTime (also known as JF's project, FreeRTOS firmware or Pinetime-JF) is an open source (GPLv3) firmware written in C++ and based on FreeRTOS, LVGL and NimBLE. This firmware (version 0.7.1) is preloaded at the factory since the new batch of PineTime devkits and sealed PineTimes of end of September 2020.

* Github repo : https://github.com/JF002/Pinetime
* Official website : https://infinitime.io/

== Read this first! ==
* PineTime is still considered as a development device. InfiniTime and the bootloader are still in heavy development, and some features might not work as expected.
* OTA is a critical feature which is still considered as risky on sealed devices. There is no known way to recover a sealed device from a failed OTA upgrade.
* There is currently no way to upgrade the bootloader on a sealed device.
* Do not use a sealed PineTime as a development device, there is a lot of chances that you'll brick it.

== Known issues ==
{{warning|1=Please read this section carefully before upgrading the firmware on your PineTime, especially if you are using a sealed device!}}
=== Black screen after a reset in sleep mode ===
==== Description ====
This issue occurs if you are using the original bootloader (from InfiniTime 0.7.1), upgraded from InfiniTime 0.7.1 to 0.8.2 and the watch resets while the display is OFF : the watch is stuck on a black screen and does not respond to touch, button press or BLE.

The reset can be triggered by the watchdog or manually by long pressing the button.

This issue is caused by InfiniTime 0.8.2 that put the external SPI flash memory to sleep before switching the display off and by the bootloader that cannot wake the memory chip up. The bootloader is stuck in an infinite loop.

More info : https://github.com/lupyuen/pinetime-rust-mynewt/issues/24 and https://github.com/JF002/Pinetime/issues/60

==== Workaround ====
On a development kit, a simple reset via SWD is needed to unlock the bootloader.

On a sealed device, the only way to work around this issue is to wait for the battery to drain completely before trying again.

This issue can be avoided by ensuring that the display is ON when manually resetting the device (long push on the button).

==== Fixed version ====
This issues is fixed in [https://github.com/JF002/Pinetime/releases/tag/0.8.3 InfiniTime 0.8.3]

== Releases ==
=== [https://github.com/JF002/Pinetime/releases/tag/0.7.1 Version 0.7.1] ===
This is the version that ships with PineTime devkits and sealed PineTime as of September 2020.
* Time synchronization over BLE
* Display brightness setting
* Notifications over BLE
* Integration with AmazFish (SailFishOS) and Gadgetbridge (Android)
* OTA using NRFConnect

Bootloader : https://github.com/lupyuen/pinetime-rust-mynewt/releases/tag/v4.1.7

=== [https://github.com/JF002/Pinetime/releases/tag/0.8.2 Version 0.8.2] ===
* Music control app
* Paint app
* Manual image validation after OTA

Bootloader : https://github.com/lupyuen/pinetime-rust-mynewt/releases/tag/v5.0.4.

This new version of the bootloader fixes [[#Black_screen_after_a_reset_in_sleep_mode]] and enables the watchdog before launching the firmware.

PINE64 - User contributions [en]

Reprogramming the PineTime

InfiniTime