Network Connection

PC and BBG is connected by Ethernet.

[Router]
  |
[ Ethernet Hub ]
  |       |
[PC]     [BBG]

Router offers IP addresses to PC and BBG by DHCP.

Please look the router configuration for the IP address of BBG.

BBG connections

Here is a figure of BBG.

Top View of BeagleBone Green (BBG):

  /-[=================]----\
  |                       +-+ USB cable +----------+
  |                       +-+===========| FST-01SZ |
  []     BeagleBone        |            +----------+
  |         Green        +--+
  []                     |  |=============> Ethernet
  |                      +--+
  |                        |==============> USB Power
  \-[=================]----/
             | | | |
             | | | |
  GREEN (RST)V | | |
               V | | Wires to FST-01SZ SWD port
  BLACK (SWD-IO) | |
                 V |
   WHITE (SWD-CLK) V
                   BLUE (GND)

Power is supplied by USB to BBG (USB Power).

USB cable is connected from BBG to FST-01SZ.

Four wires are connected from BBG GPIO port to FST-01SZ SWD port.

Pins for SWD access

We use four lines from BBG for SWD control.

Booting

Put the microSD to BBG, connect ethernet cable and USB power cable. By power, BBG starts running. It takes 30 seconds to 60 seconds to boot up.

SSH login to BBG

Log into BBG from PC by SSH. The username is "debian". Since the password is displayed when you connect to BBG, use the password.

It's like:

$ ssh debian@192.168.2.108

Firmware ELF file

There is a file, neug-fst-01sz-20181121.elf.

OpenOCD patched for BBG-SWD

OpenOCD is installed in /usr/local.

Check if SWD port is ready

1. Execute the following command to check the port is ready to use:

   $ cat /sys/devices/platform/bone_capemgr/slots
   

2. Expected output of the command

   When it is ready to use, output is something like:

   0: PF----  -1
   1: PF----  -1
   2: PF----  -1
   3: PF----  -1
   4: P-O-L-   0 Override Board Name,00A0,Override Manuf,uio_pruss_enable
   

It should show the string of "uio_pruss_enable" at the last line.

You only need to run this command only at the first time.

Execution of OpenOCD to flash and test the board

1. Execute the openocd command:

   $ openocd -f bbg-fst-01sz.cfg -f fst-01sz-flash-write.tcl
   

2. Expected behavior of the board and expected output of the command

   Successfully done, output is something like:

   Open On-Chip Debugger 0.10.0-snapshot (2018-11-21-09:42)
   Licensed under GNU GPL v2
   For bug reports, read
       http://openocd.org/doc/doxygen/bugs.html
   Info : only one transport option; autoselect 'swd'
   adapter speed: 1000 kHz
   adapter_nsrst_delay: 100
   none separate
   cortex_m reset_config sysresetreq
   srst_only separate srst_nogate srst_open_drain connect_assert_srst
   Info : Connecting under reset
   Info : BBG-SWD: Interface ready
   Info : clock speed 1000 kHz
   Info : SWD DPIDR 0x1ba01477
   Info : stm32f1x.cpu: hardware has 6 breakpoints, 4 watchpoints
   Info : SWD DPIDR 0x1ba01477
   target halted due to debug-request, current mode: Thread
   xPSR: 0x01000000 pc: 0xfffffffe msp: 0xfffffffc
   Info : device id = 0x13030410
   Info : flash size = 128kbytes
   Option Byte: 0x3fffffc
   Readout Protection Off
   Software Watchdog
   Stop: No reset generated
   Standby: No reset generated
   User Option0: 0xff
   User Option1: 0xff
   Info : SWD DPIDR 0x1ba01477
   target halted due to debug-request, current mode: Thread
   xPSR: 0x01000000 pc: 0xfffffffe msp: 0xfffffffc
   ** Programming Started **
   auto erase enabled
   wrote 84992 bytes from file neug-fst-01sz-20181121.elf in 10.300669s (8.058 KiB/s)
   ** Programming Finished **
   ** Verify Started **
   verified 84004 bytes in 2.132703s (38.465 KiB/s)
   ** Verified OK **
   ** Resetting Target **
   shutdown command invoked
   

   The line "wrote 84992 bytes from file neug-fst-01sz-20181121.elf" means success. When failure, you won't be able to see this line.

   After successful programming of flash, the LED on FST-01SZ emits light continuously.

3. Execute the checking script:

   $ ./check-fst-01sz.sh
   

   After checking files on FST-01SZ, it prompts you to put a magnet to the hall sensor closely and to remove. You should do that within ten seconds.

4. Expected behavior of the board and expected output of the script

   Successfully done, output is:

   /mnt/COPYING: OK
   /mnt/INDEX.HTM: OK
   /mnt/README: OK
   Please put a magnet close to the hall sensor, then, remove it
   Waiting (up to 10 seconds): .......
   SUCCESS
   

   This means that these files on FST-01SZ are correct.

   LED blinks after this command.

To repeat writing and checking for another board of FST-01SZ, you can use command line history of BASH; You can use arrow key UP (↑) to repeat same command line.

check-fst-01sz.sh

The content is:

#! /bin/bash

if ! mount /mnt; then
   echo "FAILURE (USB Mass Storage mount)"
   exit 1
fi
if sha256sum -c <<EOF; then
8ceb4b9ee5adedde47b31e975c1d90c73ad27b6b165a1dcd80c7c545eb65b903  /mnt/COPYING
fda879e88be4a66495bc4390e98fdd30b1e3fb03ecd8f75c134845748cbba242  /mnt/INDEX.HTM
11098e530e7b789cde7c641c0cec8b4ae90c866aa0ed5b81e7bdf3f2db04f09b  /mnt/README
EOF
  echo "Please put a magnet close to the hall sensor, then, remove it"
  echo -n "Waiting (up to 10 seconds): "
  for i in $(seq 10); do
    if test -f /mnt/README; then
    echo -n "."
    sleep 1
    else
    break
    fi
  done
  echo
  if test -f /mnt/README; then
      echo "FAILURE (hall sensor)"
  else
      echo SUCCESS
  fi
else
  echo "FAILURE (USB Mass Storage files)"
  exit 1
fi

bbg-fst-01sz.cfg

The content is:

interface bbg-swd
source [find target/stm32f1x.cfg]
reset_config srst_only srst_nogate connect_assert_srst

fst-01sz-flash-write.tcl

The content is:

init
reset halt

stm32f1x options_read 0

program neug-fst-01sz-20181121.elf verify reset exit

/etc/fstab

For this test procedure, I added following line into /etc/fstab:

/dev/sda /mnt vfat user,noauto,ro 0 0

So that the USB Mass Storage can be mounted without root privilege.

/etc/network/interfaces

In the configuration file of /etc/network/interfaces, I configured the ethernet as:

auto eth0
iface eth0 inet dhcp

If static address configuration is preferred, you can change this like:

iface eth0 inet static
    address 192.168.8.2
    netmask 255.255.255.0
    network 192.168.8.0
    gateway 192.168.8.1

And modify /etc/resolv.conf to specify correct nameserver.

/opt/scripts/boot/am335x_evm.sh

Under /opt/scripts/, I modify the boot/am335x_evm.sh script. Most importantly, I added following like:

/usr/bin/config-pin overlay uio_pruss_enable

So that we cau use PRUSS feature of BBG for SWD access.

You can see the change by git diff command in /opt/scripts.

FST-01SZ flashed with NeuG 1.0.9

Note that the flash ROM is not protected by this test plan, so that an enduser can check the content of the flash ROM.

Resetting FST-01SZ

In the test procedure, at the check script step, it may be possible to encounter a failure when it takes more than ten seconds to move a magnet.

In this case, please type following command to reset FST-01SZ:

$ openocd -f bbg-fst-01sz.cfg -c "init" -c "reset run" -c "shutdown"

and then, try again with the check script.

Erase flash of FST-01SZ

In the test procedure, at the flashing FST-01SZ step, it might be possible to flash wrong image to FST-01SZ accidentally.

In this case, please type following commands to erase flash of FST-01SZ:

$ openocd -f bbg-fst-01sz.cfg -c "init" -c "reset halt" -c "flash erase_address 0x801000 0x10000" -c "shutdown"
$ openocd -f bbg-fst-01sz.cfg -c "init" -c "reset halt" -c "flash erase_address 0x800000 0x10000" -c "shutdown"

And then, try flashing with correct image.

We do by these two commands, because of GD32F103 while we can do that for STM32F103 in a single step. It's the difference of flash ROM implementation between GD32F103 and STM32F103. Future version of OpenOCD may support GD32F103 better, hopefully.

Locking flash access by SWD

In the test procedure, flash is not protected. If you need, you can do by following command.

$ openocd -f bbg-fst-01sz.cfg -c "init" -c "reset halt" -c "stm32f1x lock 0" -c "shutdown"

Unocking flash access by SWD

When GD32F103 is shipped from a factory, it should have empty unlocked flash. If it is accidentaly locked for some reason, you can unlock it by following command.

$ openocd -f bbg-fst-01sz.cfg -c "init" -c "reset halt" -c "stm32f1x unlock 0" -c "shutdown"

And then, remove off the FST-01SZ from the USB connector and then insert it the USB connector again, to power off -> power on GD32F103.