GS2K OV SDK User Guide 1VV0301470 Rev. 1.1 2017-04-11
SPECIFICATIONS ARE SUBJECT TO CHANGE WITHOUT NOTICE NOTICE While reasonable efforts have been made to assure the accuracy of this document, Telit assumes no liability resulting from any inaccuracies or omissions in this document, or from use of the information obtained herein. The information in this document has been carefully checked and is believed to be reliable. However, no responsibility is assumed for inaccuracies or omissions. Telit reserves the right to make changes to any products described herein and reserves the right to revise this document and to make changes from time to time in content hereof with no obligation to notify any person of revisions or changes. Telit does not assume any liability arising out of the application or use of any product, software, or circuit described herein; neither does it convey license under its patent rights or the rights of others. It is possible that this publication may contain references to, or information about Telit products (machines and programs), programming, or services that are not announced in your country. Such references or information must not be construed to mean that Telit intends to announce such Telit products, programming, or services in your country. COPYRIGHTS This instruction manual and the Telit products described in this instruction manual may be, include or describe copyrighted Telit material, such as computer programs stored in semiconductor memories or other media. Laws in the Italy and other countries preserve for Telit and its licensors certain exclusive rights for copyrighted material, including the exclusive right to copy, reproduce in any form, distribute and make derivative works of the copyrighted material. Accordingly, any copyrighted material of Telit and its licensors contained herein or in the Telit products described in this instruction manual may not be copied, reproduced, distributed, merged or modified in any manner without the express written permission of Telit. Furthermore, the purchase of Telit products shall not be deemed to grant either directly or by implication, estoppel, or otherwise, any license under the copyrights, patents or patent applications of Telit, as arises by operation of law in the sale of a product. COMPUTER SOFTWARE COPYRIGHTS The Telit and 3rd Party supplied Software (SW) products described in this instruction manual may include copyrighted Telit and other 3rd Party supplied computer programs stored in semiconductor memories or other media. Laws in the Italy and other countries preserve for Telit and other 3rd Party supplied SW certain exclusive rights for copyrighted computer programs, including the exclusive right to copy or reproduce in any form the copyrighted computer program. Accordingly, any copyrighted Telit or other 3rd Party supplied SW computer programs contained in the Telit products described in this instruction manual may not be copied (reverse engineered) or reproduced in any manner without the express written permission of Telit or the 3rd Party SW supplier. Furthermore, the purchase of Telit products shall not be deemed to grant either directly or by implication, estoppel, or otherwise, any license under the copyrights, patents or patent applications of Telit or other 3rd Party supplied SW, except for the normal non-exclusive, royalty free license to use that arises by operation of law in the sale of a product. 1VV0301470 Rev. 1.1 Page 2 of 16 2017-04-11
USAGE AND DISCLOSURE RESTRICTIONS I. License Agreements The software described in this document is the property of Telit and its licensors. It is furnished by express license agreement only and may be used only in accordance with the terms of such an agreement. II. Copyrighted Materials Software and documentation are copyrighted materials. Making unauthorized copies is prohibited by law. No part of the software or documentation may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language or computer language, in any form or by any means, without prior written permission of Telit III. High Risk Materials Components, units, or third-party products used in the product described herein are NOT faulttolerant and are NOT designed, manufactured, or intended for use as on-line control equipment in the following hazardous environments requiring fail-safe controls: the operation of Nuclear Facilities, Aircraft Navigation or Aircraft Communication Systems, Air Traffic Control, Life Support, or Weapons Systems (High Risk Activities"). Telit and its supplier(s) specifically disclaim any expressed or implied warranty of fitness for such High Risk Activities. IV. Trademarks TELIT and the Stylized T Logo are registered in Trademark Office. All other product or service names are the property of their respective owners. V. Third Party Rights The software may include Third Party Right software. In this case you agree to comply with all terms and conditions imposed on you in respect of such separate software. In addition to Third Party Terms, the disclaimer of warranty and limitation of liability provisions in this License shall apply to the Third Party Right software. TELIT HEREBY DISCLAIMS ANY AND ALL WARRANTIES EXPRESS OR IMPLIED FROM ANY THIRD PARTIES REGARDING ANY SEPARATE FILES, ANY THIRD PARTY MATERIALS INCLUDED IN THE SOFTWARE, ANY THIRD PARTY MATERIALS FROM WHICH THE SOFTWARE IS DERIVED (COLLECTIVELY OTHER CODE ), AND THE USE OF ANY OR ALL THE OTHER CODE IN CONNECTION WITH THE SOFTWARE, INCLUDING (WITHOUT LIMITATION) ANY WARRANTIES OF SATISFACTORY QUALITY OR FITNESS FOR A PARTICULAR PURPOSE. NO THIRD PARTY LICENSORS OF OTHER CODE SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND WHETHER MADE UNDER CONTRACT, TORT OR OTHER LEGAL THEORY, ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE OTHER CODE OR THE EXERCISE OF ANY RIGHTS GRANTED UNDER EITHER OR BOTH THIS LICENSE AND THE LEGAL TERMS APPLICABLE TO ANY SEPARATE FILES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 1VV0301470 Rev. 1.1 Page 3 of 16 2017-04-11
APPLICABILITY TABLE PRODUCT GS2011 Mxx and GS2100 Mxx Note: The features described in the present document are provided by the products equipped with the software versions equal or higher than the versions shown in the table. See also the Revision History chapter. 1VV0301470 Rev. 1.1 Page 4 of 16 2017-04-11
Revision History Version Date Remarks 1.0 July 2015 Initial Release 1.1 April 2017 Updated section 1 and 2 of Chapter3 Steps to Build SDK to Appendix. Added a note under 3.3OTAFU Supported OV Image 1VV0301470 Rev. 1.1 Page 5 of 16 2017-04-11
Table of Contents NOTICE... 2 COPYRIGHTS.... 2 COMPUTER SOFTWARE COPYRIGHTS... 2 USAGE AND DISCLOSURE RESTRICTIONS... 3 APPLICABILITY TABLE... 4 CHAPTER 1. INTRODUCTION... 9 1.1 SCOPE & PURPOSE... 9 1.2 TERMINOLOGY... 9 CHAPTER 2. PREREQUISITES & TOOL CHAIN INSTALLATION... 10 2.1 PREREQUISITES... 10 2.2 INSTALLING TOOL CHAIN... 10 CHAPTER 3. STEPS TO BUILD SDK... 11 3.1 COMPILATION STEPS... 11 3.2 OV IMAGE CREATION... 12 3.3 OTAFU SUPPORTED OV IMAGE... 13 CHAPTER 4. FIRMWARE UPDATE... 14 4.1 FIRMWARE UPDATE PROCESS... 14 APPENDIX... 15 A.1 AUDIO CODEC SELECTION... 15 A.2 CONFIGURATION... 15 1VV0301470 Rev. 1.1 Page 6 of 16 2017-04-11
List of Figures Figure 1: OTAFU... 14 1VV0301470 Rev. 1.1 Page 7 of 16 2017-04-11
List of Tables Table 1: Glossary of Terms... 9 1VV0301470 Rev. 1.1 Page 8 of 16 2017-04-11
Chapter 1. Introduction 1.1 SCOPE & PURPOSE This document provides detailed steps for compiling OV SDK and OV image creation. 1.2 TERMINOLOGY Following table lists different terminologies used in this document. Table 1: Glossary of Terms Term OTAFU FWRCFG CFGREC Explanation Over the Air Firmware Update Firmware Configuration Configuration Record 1VV0301470 Rev. 1.1 Page 9 of 16 2017-04-11
Chapter 2. Prerequisites and Tool Chain Installation This chapter lists prerequisites and steps for installing tool chain for compiling OV SDK. 2.1 PRE-REQUISITES OV_SDK_V2.16.0.49165_1 OV78x_toolchain_V10201.bin Linux PC Windows PC 2.2 INSTALLING TOOL CHAIN Please follow the below set of commands: 1. Add executable permission to the bin file sudo chmod 777 OV78x_toolchain_V10201.bin 2. Run/Execute the binary./ov78x_toolchain_v10201.bin 3. After reading Terms and Conditions, type y to accept and press Enter to install the toolchain. Do you accept and install it (y n)? [n] y 4. Select the directory path to install the toolchain. In the below example, toolchain_ov directory is used. which directory do you want to install the toolchain [/home/user/trunk/ov/ov788_sdk] :/home/user/toolchain_ov/ 5. After installation is completed, a message will display as below: Install success. ***************************************************** add "/home/user/toolchain_ov/ba-elf/bin/" to $PATH to use the toolchain ***************************************************** 6. Add toolchain path to environmental variable PATH as shown below: $export PATH=$PATH:/home/user/toolchain_ov/ba-elf/bin/ 1VV0301470 Rev. 1.1 Page 10 of 16 2017-04-11
Chapter 3. Steps to Build SDK This chapter provides steps for compiling OV SDK to generate bootloader and dsif slave binaries. 3.1 COMPILATION STEPS Extract the OV SDK package to some directory and provide execution permissions to the OV SDK directory chmod 777 -R /ov788_jan2017 Change the build directory before proceeding to build binaries. autobuild_r2mp.sh file is available in build directory. 1. Change to Build directory path cd ov788_jan2017/ 2. Command to build dsif slave binary./autobuild_r2mp.sh SerialIF_Video_gs_SPI dsif_slave NOTE: After successful build, dsif slave binary is generated as dsif_slave.bin at build_r2/serialif_video_gs_spi/ 3. Command to build dsif boot loader binary./autobuild_r2mp.sh SerialIF_Video_gs_SPI dsif_boot_loader NOTE: After successful build, dsif bootloader binary is generated as dsif_boot_loader.bin at build_r2/serialif_video_gs_spi/ 1VV0301470 Rev. 1.1 Page 11 of 16 2017-04-11
3.2 OV IMAGE CREATION OV Image is created using dsif slave and dsif bootloader binaries generated. 1. Copy binaries build_r2/serialif_video_gs_spi//dsif_boot_loader.bin at build_r2/serialif_video_gs_spi/dsif_slave.bin to Gainspan Video ADK. GAINSPAN VIDEO ADK PATH: ADK\video_fd_audio\Tools\GS_Extflash_FS_create_tool\FILEDIR\ GS SDK PATH: SDK/Embedded/tools/OV_788_1MB_filesystem/FILEDIR/ 2. From directory FILEDIR, rename dsif_boot_loader.bin as dsif_bt.bin and dsif_slave.bin as dsif_sl.bin. 3. Open command prompt and issue following command: safe-imager.exe gs_extflash.ffs. 4. OV image (video.bin) will be created with 1MB file system and this should be loaded into external flash. NOTE: OV firmware can be loaded into external flash using UART. For updating OV firmware using OATFU, please refer to 3.3OTAFU Supported OV Image 1VV0301470 Rev. 1.1 Page 12 of 16 2017-04-11
3.3 OTAFU SUPPORTED OV IMAGE For updating OV firmware using OTAFU, it is required to create a OTAFU supported OV image. This image will have a controlblock attached to it. Control Block holds the address location for the OV Image. At this address location, OV Image is appended to the Control block. 1. Control block is to be added to the OV image(ov_av.bin) generated from safeimager.exe. 2. Start cygwin terminal and goto "ADK\video_fd_audio\Tools\GS_Extflash_FS_create_tool" where video.bin was generated. And execute following command: Command:./extflash_otafu.exe video.bin video_otafu.bin./extflash_otafu.exe video.bin video_otafu.bin 3. video_otafu.bin is generated which can be updated into external flash using OTAFU. NOTE: - "extflash_otafu.exe" is compiled on cygwin platform. video_otafu.bin is the image used for OTAFU into external flash. This is of 1028KB. - Controlblock is added at address 0x0 (contains filesystem information and start of image i.e, at 0x1000) - video image is appended from address 0x1000 1VV0301470 Rev. 1.1 Page 13 of 16 2017-04-11
Chapter 4. Firmware Update OV firmware is updated by using HTTP Push method. In HTTP PUSH method, GS2011M acts as an HTTP server and clients such as PC is used to POST the latest firmware images to the GS2011M. 4.1 FIRMWARE UPDATE PROCESS Figure 1: OTAFU 1. OV Image is updated using the URL http://<your device IP>/extotafu.html. 2. User should open the browser and enter the URL 3. http://<your device IP>/extotafu.html. 4. Browse the valid firmware image (video_otafu.bin), and click on upload. 5. Once the update is successfull, board reboots with new OV Image. NOTE: The client PC should also be in the same network as that of the device. 1VV0301470 Rev. 1.1 Page 14 of 16 2017-04-11
Appendix A.1 AUDIO CODEC SELECTION SDK_V2.16.0.49165_1 is the updated OV SDK with ZL38051 audio codec support.the audio codec zl38051 can be selected by using dsif_slave.config file. 1. Update dsif slave configuration in "prj/r2/serialif_video_gs_spi/dsif_slave.config". 2. Select zl380xx audio codec: CONFIG_AUDIO_CODEC_DAC_EN=y CONFIG_AUDIO_DAC_EN_zl380xx=y A.2 CONFIGURATION The Audio codec can be loaded in two methods, they are: SD card Static methods. Current design uses static method where audio codec ZL38051 uses static method to load firmware and configuration record. ZL38051 Configuration record Select dsif_slave.config file to load ZL38051 configuration record from OV Firmware 1. Update dsif slave configuration in prj/r2/serialif_video_gs_spi/dsif_slave.config. 2. Set load configuration record and load configuration record static. CONFIG_ZL380XX_HBI_LOAD_FWRCFG=y CONFIG_ZL380XX_HBI_LOAD_CFGREC=y CONFIG_ZL380XX_HBI_LOAD_CFGREC_STATIC=y ZL38051 Firmware Select dsif_boot_loader.config file. to load ZL38051 Firmware from OV Boot Loader 1. Update dsif bootloader configuration in prj/r2/serialif_video_gs_spi/dsif_boot_loader.config CONFIG_ZL380XX_HBI_LOAD_FWRCFG=y CONFIG_ZL380XX_HBI_BOOT=y CONFIG_ZL380XX_HBI_BOOT_STATIC=y 1VV0301470 Rev. 1.1 Page 15 of 16 2017-04-11