Kontron Global Software Center
Windows Embedded Standard 7 SP1 64-bit BSP for Kontron KBOX A-103
Readme for BSP R10
Page: 1/17 Revision: 01.00
Kontron Global Software Center Revision History
Revision Date Author Reviewed and Description approved 01.00 June 16, Denis Gennady Initial version. 2016 Kononov Kuznetsov
Page: 2/17 Revision: 01.00
Kontron Global Software Center Table of Contents
Revision History ...... 2 Table of Contents ...... 3 Introduction ...... 4 Glossary ...... 4 BSP contents ...... 5 5.1 Third-party drivers description ...... 6 5.2 RTC synchronization service ...... 9 5.3 WIM image ...... 9 Tested BIOS versions ...... 10 BIOS Setup ...... 10 Supported features ...... 11 Not supported features ...... 12 Not tested features ...... 12 Known issues and limitations ...... 13 Change log ...... 13 WES7 Image Building ...... 14 13.1 WES7 image building environment requirements ...... 14 13.2 WES7 Image deployment ...... 14 13.2.1 Preparation of the boot drive ...... 14 13.2.2 Install from Image Builder Wizard Image generated with ICE ...... 15 13.2.3 Install from WIM image ...... 16 13.2.3.1 Preparation of the Windows PE image ...... 16 13.2.3.2 Deploying of WIM image ...... 17
Page: 3/17 Revision: 01.00
Kontron Global Software Center Introduction
This document describes Microsoft Windows Embedded Standard 7 SP1 64-bit Board Support Package R10 for Kontron KBOX A-103. This document provides: 1. Summary of BSP features; 2. Lists of the release package contents; 3. WES7 Image building method.
Glossary
BSP Board Support Package. ICE Image Configuration Editor. KEAPI Kontron Embedded Application Program Interface – a software library that enables programmers to easily create their applications for monitoring and control hardware resources of Kontron boards, modules, systems and platforms. RTC Real Time Clock. SDK Software Development Kit. WES7 SP1 Windows Embedded Standard 7 Service Pack 1.
Windows PE Windows Preinstallation Environment. WIM Windows Imaging Format. UFD USB Flash Drive.
Page: 4/17 Revision: 01.00 Kontron Global Software Center BSP contents
The WES7_64_BSP_KBOX_A103_R10.zip file contains the following items.
1. ProjectFiles: This folder contains the ICE (Image Configuration Editor) project files for KBOX A-103. These files can be loaded into ICE to generate WES7 images that can then be deployed to the target device: ProjectFiles\KBOX_A-103_Setup.xml – contains inbox drivers (added by importing the KBOX_A-103.pmq file), necessary modules from BasicModules_64bit.xml template and third-party drivers from the KBOX_A- 103_drivers.xml template. ProjectFiles\KBOX_A-103_Test.xml – is KBOX_A-103_Setup.xml project with additional components from the TestImageSP1_64bit.xml template. ProjectFiles\KBOX_A-103_Test_Resolved.xml – is KBOX_A-103_Test.xml project with resolved dependencies. Notes: With these xml files you can build an evaluation version image. Lifetime: 30 days; You can’t upgrade this eval to a full version after image deployment; You can get licensed version by enter product key during deploy process.
2. Tapfiles: This folder contains the TAP file for KBOX_A-103 board. TapFiles\KBOX_A-103.pmq
3. Templates: This folder contains the ICE template files. To load these files into ICE, click the File menu, then click Import, and then click Import Template… Select .xml file that you want to import and then click the Open button. Templates\KBOX_A-103_drivers.xml – contains components and settings for third-party drivers installation. Templates\BasicModules_64bit.xml – contains basic modules necessary for proper functioning. Templates\TestImageSP1_64bit.xml – contains inbox components that you must add to the test image (KBOX_A-103_Test.xml project).
4. Out-of-Box Drivers: This folder contains drivers not natively supported by the WES7 SP1 64-bit Distribution Share (DS64SP1). Contents of the subfolders: KBOX_A-103\Chipset – Intel(R) Chipset Device Software. KBOX_A-103\cifX– Hilscher GmbH cifX Device Driver. KBOX_A-103\DisplayAudio – Intel(R) Display Audio. KBOX_A-103\Ethernet - Intel(R) I210 Gigabit Network Connection. KBOX_A-103\Graphics – Intel(R) Atom(TM) Processor E3800 Series graphics. KBOX_A-103\IO – Intel(R) Serial IO. KBOX_A-103\USB– Intel(R) USB 3.0. KBOX_A-103\WLAN – Qualcomm Atheros Wireless Network Adapter.
Page: 5/17 Revision: 01.00 Kontron Global Software Center 5. $OEM$ Folders: This folder contains KEAPI files, Exar Uart software and RTC synchronization service. KBOX_A-103\$OEM$\$$ – KEApi library and KEApi driver files. KBOX_A-103\$OEM$\$1\BSP drivers\ExarUart – XR21V1410 USB UART driver and sample test application. KBOX_A-103\$OEM$\$1\Program Files\Kontron\KEAPI – KEAPI SDK and documents. KBOX_A-103\$OEM$\$1\Program Files\Kontron\KEAPI Tools – ktool and kshell (.NET required) with sources, KEApi Samples. KBOX_A-103\$OEM$\$1\Program Files\Kontron\KEAPI\KeapiSvc – RTC synchronization service (via KEApi I2C bus). KBOX_A-103\$OEM$\$1\ProgramData\Microsoft\Windows\Start Menu\Programs\Kontron – KEAPI start menu shortcuts.
6. Packages: this folder contains updates needed for WES7 image. Hotfix\amd64~package_for_kb2732471~~~~6.1.2.0~1.0\Windows6.1- KB2732471-v2-x64.cab – hotfix needed for eMMC support. SecurityUpdate\amd64~package_for_kb3033929~~~~6.1.1.1~1.0\Windows6.1- KB3033929-x64.cab – security update needed for KEApi driver.
5.1 Third-party drivers description
1. Intel(R) Chipset Device Software.
Driver version 10.1.1.14 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\Chipset
2. Intel(R) Display Audio.
Driver version 6.16.0.3145 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\DisplayAudio
3. Intel(R) I210 Gigabit Network Connection.
Driver version 12.13.27.0 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\Ethernet
4. Intel(R) Atom(TM) Processor E3800 Series/Intel(R) Celeron(R) Processor N2920/J1900 graphics.
Driver version 37.15.0.1091 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\Graphics
Page: 6/17 Revision: 01.00 Kontron Global Software Center 5. Intel(R) Atom(TM) Processor GPIO Controller.
Driver version 1.1.7.1032 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\IO\iaiogpio
6. Intel(R) Atom(TM) Processor I2C Controller.
Driver version 1.1.7.1032 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\IO\iaioi2c
7. Intel(R) Atom(TM) Processor Low Power Subsystem DMA Device.
Driver version 1.1.8.1034 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\IO\ialpssdma
8. Intel(R) Atom(TM) Processor UART Host Controller.
Driver version 1.1.8.1034 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\IO\iaiouart
9. Intel(R) Atom(TM) Processor eMMC Host Controller.
Driver version 1.1.8.1034 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\IO\iaiosd
10. Intel(R) Atom(TM) Processor SD Host Controller.
Driver version 1.1.8.1034 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\IO\iaiosd
11. Intel(R) Atom(TM) Processor SPI Controller.
Driver version 1.1.7.1032 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\IO\iaiospi
Page: 7/17 Revision: 01.00 Kontron Global Software Center 12. Qualcomm Atheros AR946x Wireless Network Adapter.
Driver version 10.0.0.299 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\WLAN
13. XR21V1410 USB UART.
Driver version 2.2.0.0 Installation None. Need to install after WES7 installation. pass Path %distributionshareroot%\$OEM$ Folders\ KBOX_A-103\$OEM$\$1\BSP drivers\ExarUart
14. cifX PCI/PCIe Device.
Driver version 1.2.3.0 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\cifX
15. Intel(R) USB 3.0.
Driver version 4.0.4.51 Installation Offline Servicing pass Path %distributionshareroot%\Out-of-Box Drivers\ KBOX_A-103\USB
16. KEApi System Driver
Driver version 3.0.2.15 Installation OOBE System pass Path %distributionshareroot%\$OEM$ Folders\ KBOX_A- 103\$OEM$\$$\System32 Synchronous %WINDIR%\System32\devcon.exe install Command %WINDIR%\System32\KEApiDrv.inf *drvr0
Page: 8/17 Revision: 01.00 Kontron Global Software Center 5.2 RTC synchronization service
The KBox A-103 comprises a chipset external RTC. This RTC is connected to the I2C bus of the processor module. A RTC of type RV-8564 or compatible is used. To provide a valid date and time when no power is connected to the KBox A-103, the RTC is equipped with a goldcap buffer. During startup, the uEFI performs a comparison of chipset clock and external RTC and sets the chipset clock accordingly if the RTC time is valid.
'KeapiRtc' - service, that tracks Windows local time changes and stores them in RTC chip. RTC time will be restored as Windows local time on boot.
Service exe-file: svc.exe in 'C:\Program Files\Kontron\KEAPI\KeapiSvc'
Сommand-line arguments:
'Inst' - installation (must be done by WES7 BSP setup) 'Uninst' - service uninstall '-service' - start as a service; shouldn't be used manually, this entry is for Service Control Manager(SCM).
'Event Viewer' logging is supported:
'Event Viewer' -> 'Windows Logs' -> Log Name: 'Application', Source: 'KeapiRtc' For instance: 'KeapiRtc service successfully started' 'Date and Time 3/3/2003 8:09:22 PM from Rtc installed successfully' 'Current time 5/6/2007 7:14:32 PM is stored in Rtc successfully' 'The Win32 error: ErrCode 8007007E The specified module could not be found.'
Console:
>net start KeapiRtc - start KeapiRtc service; error will be shown if service is started already. >net stop KeapiRtc - stop KeapiRtc service; error will be shown if service is not started yet.
5.3 WIM image
WES7_64_IMG_KBOX_A103_R10.wim is the evaluation image of the KBOX_A- 103_Test_Resolved.xml project. It was pre-deployed, generalized by using the following command:
sysprep /generalize /oobe /shutdown and captured with ImageX.
Page: 9/17 Revision: 01.00 Kontron Global Software Center Tested BIOS versions
Target: KBOX A-103.
Module Information: CPLD Rev P305.0008 Release Processor Type Intel(R) Atom(TM) CPU E3815 1.46GHz Total Memory 1024 MB
BIOS Information: BIOS Version SVV1A004.020.A103.R00.E38 X64 Build Time 09/14/2015
BIOS Setup
1. For Windows 7 and WES7 LPSS & SCC Devices Mode must be set to PCI mode in BIOS (PCI mode is set by default BIOS settings).
Advanced -> South Cluster Configuration -> LPSS and SCC Configuration -> LPSS & SCC Devices mode -> PCI mode
2. GPIO's must be set to enabled state in BIOS before using in KEApi:
Advanced -> Kontron Board -> GPIO Mux Enable/Disable
BIOS GPIO <-> KBOX A-103 GPIO
GPIO 00 <-> GPIO 0 GPIO 01 <-> GPIO 1 GPIO 02 <-> GPIO 2 GPIO 03 <-> GPIO 3 GPIO 04 <-> GPIO 4 GPIO 05 <-> GPIO 5 GPIO 06 <-> GPIO 6 GPIO 07 <-> GPIO 7
3. To install USB 3.0 drivers you need to select USB Smart Auto mode in BIOS.
Advanced -> South Cluster Configuration -> USB Configuration -> xHCI Mode -> Smart Auto
Page: 10/17 Revision: 01.00 Kontron Global Software Center Supported features
1x SATA connector (AHCI, IDE); 1x mSATA in mPCIe socket full/ half size; 1x Display Port; 1x VGA; 2x USB 2.0; 1x USB 3.0; 2x Gigabit Ethernet Intel(R) I210IT; 2x mPCIe (one for FIELDBUS expansion (J27 slot) and the second one for WLAN expansion (J37 slot) or 1x SIM card socket (J40) only with the corresponding mPCIe card installed in the onboard J37 slot; WLAN; eMMC; 1x RS232 (COM1); 2x RS422/485 (COM2 and COM3); Kontron EAPI 3.0, including: o CPU; o Disk; o Board Information; o System up time; o 8 GPIO (input/output); o 2 I2C bus 0: I2C_PM_BUS; 1: I2C_GP_BUS; o Memory; o Network; o PCI; o 4 Temperature sensors + core temperature for every processor core; 0: ADC128 HW Monitor temperature sensor; 1: LM75 temperature sensor; 2: NCT7802Y HW Monitor temperature sensor (RTD1); 3: NCT7802Y HW Monitor temperature sensor (LTD); 4+: processor core temperature; o 9 Voltage sensors; 0: NCT7802Y HW Monitor voltage sensor (VCC); 1: NCT7802Y HW Monitor voltage sensor (Vcore); 2: NCT7802Y HW Monitor voltage sensor (VSEN2); 3: NCT7802Y HW Monitor voltage sensor (VSEN3); 4: ADC128 HW Monitor voltage sensor (IN0); 5: ADC128 HW Monitor voltage sensor (IN1); 6: ADC128 HW Monitor voltage sensor (IN2); 7: ADC128 HW Monitor voltage sensor (IN3); 8: ADC128 HW Monitor voltage sensor (IN4); o Watchdog timer (3 stages, RESET and DELAY modes). RTC synchronization (via KEApi I2C bus).
Page: 11/17 Revision: 01.00 Kontron Global Software Center Not supported features
Kontron EAPI 3.0 features: o Battery; o KeapiGetCpuFreq TURBO_FREQUENCY; o Display; o Fan sensors; o Intruder detection; o PBIT functions; o Performance; o SMBus; o SPI; o Watchdog timer INTERRUPT mode; o KEApiWatchdogWaitUntilExpired.
Not tested features
Following features were not tested due to lack of equipment: Fieldbus; SIM; eMMC; eMMC boot; Kontron EAPI 3.0 features: o Boot counter (Kontron system EEPROM is not filled); o EEPROM (Kontron system EEPROM is not filled).
Page: 12/17 Revision: 01.00 Kontron Global Software Center Known issues and limitations
1. You need to install Exar USB to UART driver after WES7 installation to use COM ports. Driver can be found here: C:\BSP drivers\ExarUart.
2. KEApi I2C, EEPROM, Watchdog functions and Extension H/W Monitor sensors (temperature and voltage) don't work as part of 32-bit applications in 64-bit OS. Use these functions in 64-bit applications in 64-bit OS. Problem related to Intel I2C driver.
3. Dos-like 'mode' command does not work with Exar UART com ports. It does not affect ports functionality.
4. Windows doesn't boot with mPCI 3G modem (Ericsson F5521gw) in USB Smart Auto and xHCI mode. Windows boots correctly in USB EHCI mode.
5. WES7 installation may return an error if you install system from UFD in USB 3.0. port. Use USB 2.0 port for WES7 installation.
Change log
Initial release.
Page: 13/17 Revision: 01.00 Kontron Global Software Center WES7 Image Building
This chapter describes how to work with Microsoft Windows Embedded Standard 7 (WES7) Board Support Package (BSP) for Kontron boards. This chapter provides: WES7 image building environment requirements; WES7 image deployment description.
13.1 WES7 image building environment requirements
Host requirements: Windows 7/8.1/10 installed on host; Windows Embedded Standard 7 Image Configuration Editor installed on host.
13.2 WES7 Image deployment
13.2.1 Preparation of the boot drive
Run the DiskPart tool. At the command prompt type the following:
DISKPART
Use the DiskPart tool to determine the disk number and device size to be used for the next step by typing the following at the DiskPart command prompt:
LIST DISK
Use the DiskPart tool to partition and format the target disk and make it bootable. For example, type the following at the DiskPart command prompt:
SELECT DISK
Page: 14/17 Revision: 01.00 Kontron Global Software Center 13.2.2 Install from Image Builder Wizard Image generated with ICE
Copy the Out-of-Box Drivers directory from the BSP to Windows Embedded Standard 7 SP1 Distribution Share. Default path: 64bit: C:\Program Files\Windows Embedded Standard 7\DS64SP1\ Copy the $OEM$ Folders directory from the BSP to the Distribution Share; Copy the Packages directory from the BSP to the Distribution Share. If Distribution Share already contains these updates, skip it; Run Image Configuration Editor; Select Distribution Share in ICE (click Select Distribution Share… in Distribution Share window and browse to corresponding Distribution Share folder); Select File->Open Answer File… and choose
Installation to HDD:
1. Create bootable USB Flash drive (UFD) as describe at “Preparation of the boot drive”; 2. Copy all files from the folder that contains created image to the UFD root; 3. Boot from UFD; 4. Follow the steps of the Image Builder Wizard.
Installation to eMMC:
You need to update created IBW image before installation to eMMC. Create folders c:\hotfix, c:\wim and c:\mount in your development system. Copy \Packages\Hotfix\amd64~package_for_kb2732471~~~~6.1.2.0~1.0 \Windows6.1-KB2732471-v2-x64.cab file from BSP to c:\hotfix folder. Copy sources\boot.wim file from IBW image to c:\wim folder. Open a Command Prompt as an administrator and browse to c:\wim folder. run dism /Get-WimInfo /WimFile:boot.wim to get information about the images within the WIM. Mount boot.wim file (index 1): dism /Mount-Wim /WimFile:boot.wim /index:1 /Mountdir:c:\mount Inject the Hotfix into the mounted image: dism /image:c:\mount /add-package /PackagePath:c:\hotfix Save and un-mount the image: dism /Unmount-wim /mountdir:c:\mount /commit Mount boot.wim file (index 2): dism /Mount-Wim /WimFile:boot.wim /index:2 /Mountdir:c:\mount Inject the Hotfix into the mounted image: dism /image:c:\mount /add-package /PackagePath:c:\hotfix
Page: 15/17 Revision: 01.00 Kontron Global Software Center Save and un-mount the image: dism /Unmount-wim /mountdir:c:\mount /commit Copy updated boot.wim to your IBW image. Create bootable USB Flash drive (UFD) as describe at “Preparation of the boot drive”. Copy all files from the folder that contains created image to the UFD root. Boot from UFD. Follow the steps of the Image Builder Wizard. In the menu "Where do you want to install Windows?" choose "Load Driver" and browse to eMMC driver: AutoUnattend_Files->offlineServicing->Out-of-Box Drivers-> KBOX_A-103->IO->iaiosd Choose eMMC Host Controller driver. Continue installation as usual.
13.2.3 Install from WIM image
13.2.3.1 Preparation of the Windows PE image
1. Run Image Configuration Editor. 2. Select Tools->Create Media->Create Windows PE Image…. 3. Select folder for the Windows PE image. 4. For 32-bit Windows choose x86 architecture, for 64-bit Windows choose x64 architecture. Click “OK” button and image creation will start.
Installation to HDD:
1. Create bootable USB Flash drive (UFD) as describe at “Preparation of the boot drive”. 2. Copy all files from the folder that contains Windows PE image to the UFD root.
Installation to eMMC:
You need to update created Windows PE image before installation to eMMC. Create folders c:\hotfix, c:\sd, c:\wim and c:\mount in your development system. Copy \Packages\Hotfix\amd64~package_for_kb2732471~~~~6.1.2.0~1.0 \Windows6.1-KB2732471-v2-x64.cab file from BSP to c:\hotfix folder. Copy content of Out-of-Box Drivers\KBOX_A-103\IO\iaiosd folder to c:\sd folder. Copy sources\boot.wim file from Windows PE image to c:\wim folder. Open a Command Prompt as an administrator and browse to c:\wim folder. run dism /Get-WimInfo /WimFile:boot.wim to get information about the images within the WIM. Mount boot.wim file (index 1): dism /Mount-Wim /WimFile:boot.wim /index:1 /Mountdir:c:\mount Inject the Hotfix into the mounted image: dism /image:c:\mount /add-package /PackagePath:c:\hotfix
Page: 16/17 Revision: 01.00 Kontron Global Software Center Add eMMC driver to the mounted image: dism /image:c:\mount /add-driver:c:\sd Save and un-mount the image: dism /Unmount-wim /mountdir:c:\mount /commit Copy updated boot.wim to your Windows PE image. Copy all files from the folder that contains Windows PE image to the UFD root.
13.2.3.2 Deploying of WIM image
1. Create bootable UFD with Windows PE as described in the chapter “ Install from WIM image 2. Preparation of the Windows PE image”. 3. Copy WIM image file to the USB Flash Drive (UFD). 4. Boot the device to Windows PE. 5. Prepare target disk for WIM image as described in the chapter “Preparation of the boot drive”. 6. Browse to UFD with WIM image, for example:
D:
WHERE:
D – UFD with WIM image;
7. Apply WIM image to a specified drive, for example:
IMAGEX /APPLY
WHERE:
C – disk with created primary partition;
8. Shut down the device by typing the following at the command prompt:
WPEUTIL SHUTDOWN
9. Boot from target disk.
Page: 17/17 Revision: 01.00