QUICK START GUIDE. ARTiGO A820. Linux BSP v

QUICK START GUIDE ARTiGO A820 Linux BSP v3.0.7 1.00-05252016-153500

Copyright Copyright 2016 IA Technologies Incorporated. All rights reserved. No part of this document may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual or otherwise without the prior written permission of IA Technologies, Incorporated. Trademarks All brands, product names, company names, trademarks and service marks are the property of their respective holders. Disclaimer IA Technologies makes no warranties, implied or otherwise, in regard to this document and to the products described in this document. The information provided in this document is believed to be accurate and reliable as of the publication date of this document. However, IA Technologies assumes no responsibility for the use or misuse of the information in this document and for any patent infringements that may arise from the use of this document. The information and product specifications within this document are subject to change at any time, without notice and without obligation to notify any person of such change. IA Technologies, Inc. reserves the right the make changes to the products described in this manual at any time without prior notice.

ARTiGO A820 Linux BSP 3.0.7 Revision History ersion Date Remarks 1.00 2016/5/23 Initial release iii

ARTiGO A820 Linux BSP 3.0.7 Table of Contents 1. Introduction...... 1 1.1. Package Contents... 1 1.1.1. BSP Folder Contents... 1 1.1.2. Document Folder Contents... 1 1.1.3. EK Folder Contents... 2 1.2. ersion Information and Supported Features... 2 2. Image Deployment... 3 2.1. Booting from a Micro SD Card... 3 2.2. Booting from the SPI ROM... 4 2.3. Setting up U-Boot Parameters... 5 2.4. Restoring Default U-Boot Parameters... 7 2.5. Using the OpenEmbedded Console... 7 3. Build Environment Setup 8 3.1. Configuring Ubuntu 8 4. Image Build... 9 4.1. Extracting ARTiGO A820 BSP... 9 4.2. Machine Configuration... 9 4.3. Building an SD Card Image... 9 5. Hardware Functions...... 10 5.1. Setting up COM 1 10 5.1.1. Setting up RS-232 mode... 10 5.1.2. Setting up RS-485 mode... 11 5.2. Configuring Network Settings... 13 5.3. Configuring the EMIO-2550 minipcie Mobile Broadband Module... 14 5.3.1. Connecting to the Internet... 14 5.3.2. Enabling GPS... 14 5.4. Configuring Watchdog Timer... 16 5.5. Setting up GPIO... 17 5.5.1. Setting up DIO connector for GPIO functionality... 17 5.5.2. Setting up GPI mode... 18 5.5.3. Setting up GPO mode... 18 5.6. Configuring RTC... 18 iv

ARTiGO A820 Linux BSP 3.0.7 1. Introduction The purpose of this document is to provide an overview of getting started with the ARTiGO A820 system using Yocto with an OpenEmbedded filesystem. The ARTiGO A820 Linux BSP v3.0.7 is developed based on the NXP fsl-yocto-3.14.28_1.0.0 (Yocto 1.7 Dizzy) and it enables hardware features that are defined on the ARTiGO A820 system. 1.1. Package Contents There are three folders in the package as listed below. BSP folder A820-yocto-bsp-v3.0.7.tar.bz2 Document folder ARTiGO_A820_Linux_BSP_v3.0.7_Quick_Start_Guide _v1.00_20160423.pdf ARTiGO_A820_Linux_EK_v3.0.7_Image_Installation_Guide_v1.00_20160517.pdf EK folder via-image-gui-imx6qvab820.sdcard u-boot.imx zimage zimage-imx6dl-vab820.dtb modules-imx6qvab820.tgz wdt_driver_test.out ARTiGO A820 Linux BSP contents Description Source code Description Image Installation Guide Description SD card image U-Boot boot loader Kernel Device tree All modules drivers Watchdog configuration program 1.1.1. BSP Folder Contents A820 820-yocto yocto-bsp bsp-v3.0.7.tar.bz2: A complete and static Yocto BSP including the ARTiGO A820 meta-files, and all the predownloaded required software packages to enable a complete offline build. 1.1.2. Document Folder Contents ARTiGO_A820_Linux_BSP_v3.0.7_Quick_Start_Guide _v1.00_20160423.pdf.pdf: The Quick Start Guide provides an overview of getting started with the ARTiGO A820 system using Yocto with an OpenEmbedded filesystem. ARTiGO_A820_Linux_EK_v3.0.7_Image_Installation_Guide_v1.00_20160517.pdf: The Image Installation Guide explains how to boot the Linux EK image on the ARTiGO A820 system in order to begin evaluating the platform. 1

1.1.3. EK Folder Contents ARTiGO A820 Linux BSP 3.0.7 via-image image-gui gui-imx6qvab820.sdcard: imx6qvab820.sdcard: is the precompiled image for evaluating the ARTiGO A820 system with an OpenEmbedded filesystem. u-boot.imx boot.imx: is the U-Boot boot loader file which can be flashed to either the onboard SPI ROM or a Micro SD Card. zimage: is a self-extracting compressed Linux kernel image. zimage-imx6dl imx6dl-vab820.dtb vab820.dtb: is the device tree binary. It is a database that represents the hardware components of the ARTiGO A820. modules-imx6qvab820.tgz imx6qvab820.tgz: contains the drivers for the NT9271 USB Wi-Fi dongle, EMIO-1541 minipcie Wi-Fi module and EMIO-2550 minipcie Mobile Broadband module. wdt_driver_test.out: is the Watchdog configuration program. 1.2. ersion Information and Supported Features U-Boot version: 2014.04 Kernel version: 3.14.28 Evaluation image: OpenEmbedded-core built with Yocto 1.7 Dizzy Development based on NXP fsl-yocto-3.14.28_1.0.0 (Yocto 1.7 Dizzy) Supports SPI with emmc or Micro SD boot (default) Supports HDMI Supports HDMI audio output Supports COM 1 (RS232 / RS485), Onboard COM as debug port Supports Gigabit Ethernet (LAN 1) Supports 10/100Mbps Ethernet (LAN 2) Supports NT9271 USB Wi-Fi dongle Supports EMIO-1541 minipcie Wi-Fi module Supports EMIO-2550 minipcie Mobile Broadband module Supports Watchdog, GPIO and RTC 2

2. Image Deployment ARTiGO A820 Linux BSP 3.0.7 This section explains the setup requirements for booting from a Micro SD card or the SPI ROM. A precompiled image is provided in the EK folder of the BSP. 2.1. Booting from a Micro SD Card The via-image image-gui gui-imx6qvab820.sdcard imx6qvab820.sdcard image allows the system to run entirely from the Micro SD card. The first step is to copy this image onto a Micro SD card. Insert a Micro SD card into your host machine and make sure it is not mounted. Copy the SD Card image onto the Micro SD card with the command below, replacing <device name> with the correct value for the card, for example sdb. Important: Make sure you are writing to the correct device or the host system environment could be damaged. $ sudo dd if=via-image-gui-imx6qvab820.sdcard of=/dev/<device name> bs=1m conv=fsync Next, set switch SW2 to the Micro SD position shown below. Micro SD/ SPI boot select switch diagram Insert the prepared Micro SD card into the ARTiGO A820, connect an HDMI display, and power on the device to initiate the boot process. When the boot process is completed, you will see the OpenEmbedded desktop. 3

2.2. Booting from the SPI ROM ARTiGO A820 Linux BSP 3.0.7 The ARTiGO A820 supports booting from the SPI ROM while loading the kernel and root filesystem from emmc. The first step is to prepare a Micro SD card with the default image according to section 2.1. Next copy the u-boot.imx and via-image image-gui gui-imx6qvab820.sdcard imx6qvab820.sdcard files from the BSP onto a mass storage device such as a USB thumb drive. Make sure the SW2 switch is set to Micro SD boot then insert the Micro SD card and the USB thumb drive into the ARTiGO A820. To check that the system has correctly setup the SPI ROM as an MTD block device, use the following command: $ ls /dev/mtdblock* /dev/mtdblock0 Please note that if you have previously saved U-Boot parameters, it is recommended to clear that area of the SPI ROM with the following command: $ sudo dd if=/dev/zero of=/dev/mtdblock0 bs=512 seek=1536 count=16 Flash the U-Boot binary from the mass storage device onto the SPI ROM: $ sudo dd if=u-boot.imx of=/dev/mtdblock0 bs=512 seek=2 Copy the root filesystem image from the mass storage device onto the emmc storage. $ sudo dd if=via-image-gui-imx6qvab820.sdcard of=/dev/mmcblk0 bs=1m In order to boot from the SPI ROM make sure the SW2 switch is set to SPI ROM boot. Micro SD/ SPI boot select switch diagram Next, connect an HDMI display, and power on the device to initiate the boot process. When the boot process is completed, you will see the OpenEmbedded desktop. 4

2.3. Setting up U-Boot Parameters ARTiGO A820 Linux BSP 3.0.7 The first step is to connect the host machine and the ARTiGO A820 through the onboard COM debug port. Use a serial port communication program such as PuTTY, GtkTerm, or Minicom, to configure the serial port setting and connect to the debug console. There you will be able to see the U-Boot boot log and adjust settings in the U-Boot console. +--------------------------------------------------------------+ A - Serial Device : /dev/ttymxc0 B - Lockfile Location : /var/lock C - Callin Program : D - Callout Program : E - Bps/Par/Bits : 115200 8N1 F - Hardware Flow Control : No G - Software Flow Control : No +--------------------------------------------------------------+ Serial port setting of host machine COM Debug connector diagram 5

ARTiGO A820 Linux BSP 3.0.7 Next, power on the ARTiGO A820 to initiate the boot process. When prompted, press any key to stop the boot process, and enter the U-Boot console as illustrated by the screenshot below. U-Boot 2014.04 (Nov 19 2015-18:49:13)AB820 ver:3.0.7 CPU: Freescale i.mx6dl rev1.2 at 996 MHz CPU: Temperature 30 C, calibration data: 0x5894f169 Reset cause: POR Board: MX6DL-AB820 I2C: ready DRAM: 1 GiB MMC: FSL_SDHC: 0, FSL_SDHC: 1 SF: Detected W25Q32B with page size 256 Bytes, erase size 4 KiB, total 4 MiB *** Warning - bad CRC, using default environment No panel detected: default to Hannstar-XGA Display: Hannstar-XGA (1024x768) In: serial Out: serial Err: serial Net: FEC [PRIME] Warning: failed to set MAC address Normal Boot Hit any key to stop autoboot: 0 => Debug console view of boot process To list the current U-Boot parameters, use the following command: => printenv Make sure the printout message includes bootcmd=run bootcmd_auto. The default bootcmd parameter is set to auto detect the system location by first attempting to load the kernel from the Micro SD card. If it is not detected it continues to boot from the emmc. To load the kernel from the specified device, refer to the two examples below. To load the kernel from the Micro SD card: => setenv bootcmd 'run bootcmd_sd' => saveenv => boot To load the kernel from the emmc: => setenv bootcmd 'run bootcmd_mmc' => saveenv => boot 6

2.4. Restoring Default U-Boot Parameters ARTiGO A820 Linux BSP 3.0.7 If the U-Boot parameters have been modified, the destroyenv command in the U-Boot console can restore the factory defaults settings. To restart the device, use the reset command. => destroyenv => reset 2.5. Using the OpenEmbedded Console The first step is to connect the host machine and the ARTiGO A820 through the onboard COM debug port. Use a serial port communication program such as PuTTY, GtkTerm, or Minicom, to connect to the debug console. There you will be able to see the U-Boot boot log and adjust settings in the U-Boot console. Next, power on the ARTiGO A820 to initiate the boot process. When the boot process is completed you will be prompted to login. COM Debug connector diagram The default account is root, with no password set (just press Enter when prompted for password).... Poky (Yocto Project Reference Distro) 1.7 imx6qvab820 /dev/ttymxc1 imx6qvab820 login: root 7

3. Build Environment Setup ARTiGO A820 Linux BSP 3.0.7 This section guides you through setting up the build environment for development. All instructions are based on using Ubuntu 14.04 LTS. To make sure that the build process completes successfully, we recommend at least 120GB of disk space, and 15GB of combined memory and swap space on the host machine. 3.1. Configuring Ubuntu The following packages are required for the Yocto development environment. The required packages can be installed using the bash script below: #/bin/bash # Install dependant packages $ sudo apt-get install gawk wget git-core diffstat unzip texinfo gcc-multilib build-essential chrpath socat $ sudo apt-get install libsdl1.2-dev xterm sed cvs subversion coreutils texi2html docbook-utils pythonpysqlite2 help2man make gcc g++ desktop-file-utils libgl1-mesa-dev libglu1-mesa-dev mercurial autoconf automake groff curl lzop asciidoc The tool to create images for use with the U-Boot boot loader, "mkimage mkimage", is provided by different packages in Ubuntu 12.04 and in newer Ubuntu releases. On Ubuntu 12.04 install it as below. $ sudo apt-get install uboot-mkimage On Ubuntu 14.04 and newer versions install it as below. $ sudo apt-get install u-boot-tools 8

ARTiGO A820 Linux BSP 3.0.7 4. Image Build 4.1. Extracting ARTiGO A820 BSP Use the following command to extract the contents of the BSP. $ tar xvf A820-yocto-bsp-v3.0.7.tar.bz2 4.2. Machine Configuration The via-setup setup-release.sh script creates the build directory with the Yocto configuration files for your target machine. This script has the following optional parameter: -b: set the name of the build directory. For example -b build-a820 in the command below. $ cd a820-yocto-bsp $ MACHINE=imx6qvab820 source via-setup-release.sh -b build-a820 4.3. Building an SD Card Image This BSP provides the via-image-gui Yocto image as default. Use the bitbake command to create an SD Card compatible image. $ a820-yocto-bsp/build-a820$ bitbake via-image-gui After the compilation, the a820-yocto yocto-bsp bsp/build /build-a820 a820/tmp/deploy/images/imx6q /tmp/deploy/images/imx6qvab820 directory will contain the resulting binaries, as shown in the table below. Binary u-boot.imx zimage zimage-imx6dl-vab820.dtb via-image-gui-imx6qvab820.sdcard Description U-Boot boot loader Kernel Device tree SD card image Binary files generated by bitbake 9

5. Hardware Functions ARTiGO A820 Linux BSP 3.0.7 5.1. Setting up COM 1 The ARTiGO A820 COM 1 port supports both RS-232 and RS-485 modes. The default mode is RS- 232. 5.1.1. Setting up RS-232 mode The first step is to connect the host machine and the ARTiGO A820 through the COM 1. Use a serial port communication program such as PuTTY, GtkTerm, or Minicom, to connect to the COM 1. Next, set the COM mode switch to the RS-232 position shown below. COM mode switch diagram Connect the host machine to the ARTiGO A820 COM 1 port with an RS-232 cable. To start the Minicom serial communication program on the ARTiGO A820, use the following command: $ minicom -s 10

ARTiGO A820 Linux BSP 3.0.7 Connect to the /dev/ttymxc0 serial device with the following settings: +--------------------------------------------------------------+ A - Serial Device : /dev/ttymxc0 B - Lockfile Location : /var/lock C - Callin Program : D - Callout Program : E - Bps/Par/Bits : 115200 8N1 F - Hardware Flow Control : No G - Software Flow Control : No +--------------------------------------------------------------+ Serial port setting of RS-232 mode Start a serial communication program on the host machine with the same communication settings using the appropriate serial device. Afterwards the host machine and the ARTiGO A820 should be able to communicate through the programs (for example sending a keypress on one machine should be shown on the other machine). 5.1.2. Setting up RS-485 mode Set up and test RS-485 communication over the COM 1 port as follows. Set the COM mode switch to the RS-485 position. COM mode switch diagram Enable RS-485 on the ARTiGO A820 system with the following command: $ imx_rs485 1 Connect the host machine to the ARTiGO A820 COM 1 port with an RS-485 cable. To start the Minicom serial communication program on the ARTiGO A820, use the following command: $ minicom -s 11

ARTiGO A820 Linux BSP 3.0.7 Connect to the /dev/ttymx0 serial device with the following settings: +--------------------------------------------------------------+ A - Serial Device : /dev/ttymxc0 B - Lockfile Location : /var/lock C - Callin Program : D - Callout Program : E - Bps/Par/Bits : 115200 8N1 F - Hardware Flow Control : No G - Software Flow Control : No +--------------------------------------------------------------+ Serial port setting of RS-485 mode Start a serial communication program on the host machine with the same communication settings using the appropriate serial device. Afterwards the host machine and the ARTiGO A820 should be able to communicate through the programs (for example sending a keypress on one machine should be shown on the other machine). Please note that the software setting for the RS-485 communication is not preserved over reboot. The "imx_rs485" command needs to be run whenever the machine is restarted to set up the COM port correctly for RS-485 communication. To switch the COM port back to RS-232 communication mode from RS-485, adjust the COM mode select switch and use the following command: $ imx_rs485 0 12

5.2. Configuring Network Settings ARTiGO A820 Linux BSP 3.0.7 The ARTiGO A820 supports two LAN ports and the default setting is Gateway mode. In Gateway mode, LAN 1 is a WAN port while LAN 2 is a LAN port. If the system is already connected to the Wi-Fi module, it won t support WLAN. LAN 1 and LAN 2 diagram Open a terminal and configure the network setting with the following command: $ /etc/networkcfg To disable Gateway mode and use the WLAN, select 7 Enable and Disable Gateway and then select 6 Reboot as illustrated by the screenshot below. 1) Ethernet 5) Exit 2) WLAN Config 6) Reboot 3) Reset 7) Enable or Disable Gateway 4) Show Information Enter option: 7 Please reboot 1) Ethernet 2) WLAN Config 3) Reset 4) Show Information 5) Exit 6) Reboot 7) Enable or Disable Gateway Enter option: 6 Reboot selected Network configuration When the boot process is completed, click on the Connection Manager icon to configure LAN 1, LAN 2 and WLAN respectively. Connection Manager icon diagram 13

ARTiGO A820 Linux BSP 3.0.7 5.3. Configuring the EMIO-2550 minipcie Mobile Broadband Module The EMIO-2550 minipcie Mobile Broadband module supports 3G and GPS functions. 5.3.1. Connecting to the Internet The first step is to insert the EMIO-2550 module into the ARTiGO A820, and then remove the LAN cables and Wi-Fi module. Next, power on the ARTiGO A820. Inserting the EMIO-2550 module To check that the system has correctly detected the EMIO-2550 module, use the following command: $ lsusb Make sure the printout message includes Bus 001 Device 004: ID 1545:1102 U-Blox AG. Configure the 3G function by creating a PPP connection with root privilege. $ pppd call Module-ZU200 When the PPP connection is created, connect to the website on the internet using your browser. 5.3.2. Enabling GPS To configure the GPS function and start the Minicom serial communication program on the ARTiGO A820, use the following command: $ minicom -s 14

ARTiGO A820 Linux BSP 3.0.7 Connect to the /dev/ttyusb1 serial device with the following settings: +--------------------------------------------------------------+ A - Serial Device : /dev/ttyusb1 B - Lockfile Location : /var/lock C - Callin Program : D - Callout Program : E - Bps/Par/Bits : 115200 8N1 F - Hardware Flow Control : No G - Software Flow Control : No +--------------------------------------------------------------+ Serial port setting of ARTiGO A820 When the setting is completed, type the following GPS AT commands into Minicom: AT+UGPRF=1, AT+UGRMC=1, AT+UGGS=1, AT+UGZDA=1, and AT+UGPS=1,0 Wait for the "OK" message before sending the next AT command. AT+UGPRF=1 OK AT+UGRMC=1 OK AT+UGGS=1 OK AT+UGZDA=1 OK AT+UGPS=1,0 OK Use the Minicom to set serial device to /dev/ttyusb7 in another terminal and it will output the data received from the GPS module as illustrated in the screenshot below. $GPRMC,142015,00,A,2501.93961,N,12133.66111,E,0.068,,030314,,,A*73 $GPGS,4,1,13,01,34,184,29,03,49,023,47,06,26,042,41,07,44,317,26*75 $GPGS,4,2,13,08,13,323,,11,60,192,,13,29,242,38,16,33,071,16*79 $GPGS,4,3,13,19,65,356,44,23,18,208,12,27,35,034,27,30,37,145,29*7B $GPGS,4,4,13,32,01,154,*4B $GPZDA,142015.00,03,03,2014,00,00*62 GPS NMEA message 15

5.4. Configuring Watchdog Timer ARTiGO A820 Linux BSP 3.0.7 The wdt_driver_test.out provides an application to configure the Watchdog timer. The first step is to copy the wdt_driver_test.out file to /home/unit_tests folder on the ARTiGO A820 system. This file is located in the EK/Tools folder of the BSP. To enable the Watchdog with the default timeout (60 seconds), use the following command: $ /unit_tests/wdt_driver_test.out enable wdt To change the timeout <value> and the system reboot <value> (seconds), use the following command: $ /unit_tests/wdt_driver_test.out set_timeout <value> To send keep-alive requests to the Watchdog <value> (seconds), use the following command: $ /unit_tests/ wdt_driver_test.out set_keep_alive <value> When the value of set_keep_alive is smaller than the value of set_timeout, the system will not reboot. To disable the Watchdog, use the following command: $ /unit_tests/wdt_driver_test.out disable wdt 16

5.5. Setting up GPIO ARTiGO A820 Linux BSP 3.0.7 The DIO connector on the ARTiGO A820 consists of 9 pins. The following section explains setting up these pins for input/output communication. DIO connector diagram 5.5.1. Setting up DIO connector for GPIO functionality The echo value of GPIO pins are listed below: Pin NumberN Pin Definition D GPIO echo value 1 GPIO_7 7 2 GPIO_1 1 3 GPIO_8 8 4 GPIO_2 2 5 GPIO_9 9 6 GPIO_4 4 7 GPIO_16 203 8 GPIO_5 5 9 GND GPIO pin table Set the multifunction pin as a GPIO pin. Here is the example for GPIO pin 1: $ echo 7 > /sys/class/gpio/export 17

5.5.2. Setting up GPI mode ARTiGO A820 Linux BSP 3.0.7 To set a pin to "input" mode (GPI), use the following command (here is the example for GPIO pin 1): $ echo "in" > /sys/class/gpio/gpio7/direction To read the GPI input value, use the following command: $ cat /sys/class/gpio/gpio203/value 5.5.3. Setting up GPO mode To set a pin to "output" mode (GPO), use the following command (here is the example for GPIO pin 1): $ echo "out" > /sys/class/gpio/gpio7/direction To output a "Low" value on the GPO pin, use the following command: $ echo 0 > /sys/class/gpio/gpio7/value To output a "High" value on the GPO pin, use the following command: $ echo 1 > /sys/class/gpio/gpio7/value 5.6. Configuring RTC As the first step, set the system time with the Linux date command, for example as: $ date mmddhhmmyyyy Time mm dd HH MM YYYY alue 2-digit month 2-digit day 2-digit hours in 24h system 2-digit minutes 4-digit year Time value v table For example the value 061110072013 means June 11 2013 10:07. The date command also accepts other time formats, for more info see: $ date --help Write the system time to the RTC with: $ hwclock -w -f /dev/rtc0 To read the RTC time, use: $ hwclock -r 18

TaiwanlHeadquarters 7F0lNk7lZhongMZhenglRoad Xindian0lTaipei0lPk7By Taiwan TEL:lyyDCPCPP7yCNBNP FAX:lyyDCPCPP7yCNBNk Email:lembedded@viaCcomCtw USA JBSlMissionlCourt Fremont0lCAllJBNkJ USA TEL:l7CN7SCDykCkkSS FAX:l7CN7SCDyjCBDNB Email:lembedded@viatechCcom Japan km7nmjlebisulmtlbldgcldf Higashi0lShibuyaMku Tokyol7NSMSS77 Japan TEL:ly7CkCNBDDC7Dkj FAX:ly7CkCNBDDC7Dky Email:lembedded@viatechCcoCjp China TsinghualSciencelParklBldgClj NoCl7lZongguancunlEastlRoad HaidenlDistrict0lBeijing0ll7SSSyB China TEL:lyDC7SCNJyNPPyy FAX:lyDC7SCNJyNPPJJ Email:lembedded@viatechCcomCcn Europe Email:lembedded@viaMtechCeu