3.6.8 Icicle Kit Setup Instructions

Windows Users

On Windows, To open the HSS Serial Terminal:

1. Open Start > Device Manager. Select View > Show hidden devices. Under Ports (COM & LPT), and look for “Silicon Labs Quad CP2108 USB to UART Bridge: Interface 0 as shown below. Take note of the serial line number in parenthesis. In this case, Interface 0 is COM3. The digit could be different on your machine.

   

   If you encounter an issue configuring the serial connection to the board try the following:

   • If you can’t find the serial port with the correct name, you may have to install CP210x Windows Drivers from SiLabs.
   • You should be able to see the UART interfaces in StartDevice Manager. If you can’t, try selecting ViewShow hidden devices,
   • If you still can’t see the serial ports, then your USB socket could be broken, which is usually indicated if Windows makes no sound when disconnecting/reconnecting the USB cable.
2. With the Icicle Kit on and connected, open a new PuTTY terminal. Change the settings on the left navigation panel, under ConnectionSerial to:
   • Serial line to connect to: <Serial line number>
   • Baud Rate: 115200
   • Data Bits: 8
   • Stop Bits: 1
   • Parity: None
   • Flow Control: None
   Below is an image of how the settings look in PuTTY:

   

3. Go back to Session on the left navigation panel, Change Connection Type to Serial as shown below, then click Open:

   

Linux Users

On Linux, to open the HSS Serial Terminal:

• The UART channel that we will connect to is channel 0. To do this in GTKTerm, the command is:

  sudo gtkterm -p /dev/ttyUSB0 -s 115200

• Note that if you have other ttyUSB devices connected to your host PC, the number after /dev/ttyUSb may need to change. To out find which devices are associated with the Icicle Kit’s UART channels, you can run ls /dev/ttyUSB* with and without the USB cable connected to the board. Any new devices (there should be four) that appear when plugging in the board are the UART channels. For this step, we want to use the /dev/ttyUSB device with the lowest number.

Embedded Linux Serial Terminal

To open the Embedded Linux Serial Terminal follow the same instructions as the previous Step 4 - Open Serial UART Terminals section. Except this time use interface 1 (/dev/ttyUSB1 on a Linux host PC, and Interface 1 on a Windows host PC).

In the example below, Interface 1 is on the COM4 serial line.

Expose Board’s eMMC Flash Memory to Host PC as USB flash storage

1. Reset the Icicle Kit by pressing push button SW4 (top left push button). In the HSS Serial terminal, when prompted to Press a key to enter CLI, press any key aside from ESC. If you don’t press a key within 1 second then the board will continue to boot Linux and you will have to reset the board again. Double check in the Linux Serial Terminal to verify that you don’t see any output from Linux booting.

   

   You should now see a prompt for the HSS command-line interface:

   

2. In the HSS Serial Terminal, enter the command mmc to select the eMMC flash memory (only needed for newer HSS versions). Then enter the command usbdmsc.

   

   Important: If you see “FLASH_DRIVE_init() returned false” (below), then you forgot to run the mmc command before running usbdmsc.

   

3. If the board is properly connected to your host computer, you should see data being read as shown on the last line of the following image:

   

4. On a Linux host PC, you can run again ls /dev/sd* and compare against what we saw inin the earlier step. Note which new device shows up. In our example, /dev/sda and /dev/sdc were present before, but /dev/sdb is new. Therefore, the eMMC flash memory on the board is represented on our host machine as: /dev/sdb. We can now flash the Linux image to the board.

   

   Alternatively, you can check the exact device using the lshw command and it will show the device for the PolarFireSoC:

   $> sudo lshw -class disk -short
   H/W path                 Device     Class          Description==============================================================
   /0/100/14/0/6/0.0.0      /dev/sdb   disk           7820MB PolarFireSoC_msd
   /0/100/14/0/6/0.0.0/0    /dev/sdb   disk           7820MB
   /0/1/0.0.0               /dev/sda   disk           1TB Samsung SSD 860

   On a Windows host PC, you can use the Windows File Explorer -> This PC to see the Icicle Kit’s eMMC flash memory as a media drive. In this case, shown as “boot (D:)”:

   

Flash the Embedded Linux Image to the Board

Using Balena Etcher

For either Linux or Windows, you can easily flash the Embedded Linux image (*.wic.gz file) using Balena Etcher software, which can be downloaded here: etcher.balena.io.

Open Balena's Etcher and click on Flash from file. This will open a window to select the file you want to flash. Choose the *.wic.gz file (Embedde Linux Image file) then click on Select target button and choose the board's flash memory drive as described in the previous section. The drive should have been detected by Windows or Linux when you issued the usbdmmc command. Once you have set the target and file, click on theFlash! button and wait for the image file to be flashed to the board.

After the flashing command completes, you should disconnect the mounted drive, by typing Ctrl+C in the HSS Serial Terminal. The embedded Linux image on the board is now updated.

Using command line (Linux-only).

Alternateively, when using Linux you can use the bmap tool. Assuming the board flash storage device is /dev/sdb you can flash the image like this:

$> bmaptool copy <linux image>.wic.gz /dev/sdb

Note that to use bmap you need the *.wic.bmap file that was downloaded earlier.

Yet anoter alternative in Linux is to use the dd command as follows:

$> sudo umount /dev/sdb
$> zcat <linux image>.wic.gz | sudo dd of=/dev/sdb bs=4096iflag=fullblock oflag=direct conv=fsync status=progress

dd flashing command should take several minutes to complete. DO NOT power cycle the Icicle board at this point.