### System requirements and toolchain ###

Linux:
Starting from scratch, it is recommended to use Ubuntu 18.04 LTS AMD64 with
this SDK.  However, most relatively up-to-date 64-bit x86 linux distributions
will work just fine.  See tools/README for install instructions.

Windows:
The recommended OS version is Windows 10 (64 bit).  See tools/README.Windows for
install instructions.

macOS:
The recommended OS version is 10.14.5 (Mojave).  See tools/README.macOS for
install instructions.

### Atmosic SDK library and tools ###

Please go to https://atmosic.com/google-tv-sdk-download/ to download the Atmosic
SDK library and tools package, extract and put them into SDK as below:

Put the 'lib' and 'tools' folders in platform/atm2/ATM22xx-x1x/
    platform/atm2/ATM22xx-x1x/lib/lib_plf.a
    platform/atm2/ATM22xx-x1x/lib/lib_plf_dbg.a
    platform/atm2/ATM22xx-x1x/lib/app_lib/HID_remote.a
    platform/atm2/ATM22xx-x1x/lib/app_lib/HID_remote_dbg.a

    platform/atm2/ATM22xx-x1x/tools/bin/Darwin/nvds_tool
    platform/atm2/ATM22xx-x1x/tools/bin/Linux/nvds_tool
    platform/atm2/ATM22xx-x1x/tools/bin/Windows_NT/nvds_tool.exe

Put the 'openocd' folder in tools/:
    tools/openocd/bin/Darwin/openocd
    tools/openocd/bin/Linux/openocd
    tools/openocd/bin/Windows_NT/libusb-1.0.dll
    tools/openocd/bin/Windows_NT/openocd.exe

For Linux/macOS users, use "chmod +x" to change the permission of executables.

### Quick start ###

1) Follow the appropriate instructions mentioned above to install gcc toolchain,
   SDK library and tools.
2) Connect ATM2231 G10 remote board, IO adapater board and interface board
   together and plug in the USB1 of interface board to PC.  See "ATM2231 G10
   Remote Control Application Note" document for more details.
3) Open a terminal and cd into platform/atm2/ATM22xx-x1x/examples/HID_remote
4) Type the command below to build Android TV remote G10 application with NVDS,
   program it via USB, and reset the remote to run it.

   make run_all CFG_ATVRC=1 USE_LIB=1

### Makefile helpers ###

USE_LIB:= Use the application library(HID_remote.a/HID_remote_dbg.a) to compile.

DEBUG:= Debug helper allows application to log debug messages on serial
console output and enabling debug compile option.  By default debug is enabled.

USER_BD_ADDR:= Set user specified 6 byte bluetooth MAC address.  Address is
specified in LSB first order.  e.g. for BD addr of a1:a2:a3:a4:a5:a6 use
USER_BD_ADDR:="a6 a5 a4 a3 a2 a1".

flash_nvds.data := List of NVDS tags required by application

### SDK layout ###

platform/atm2/ATM22xx-x1x
    Atmosic ATM22xx-x1x chip support

platform/atm2/ATM22xx-x1x/driver
    Peripheral driver

platform/atm2/ATM22xx-x1x/examples/HID_remote
    Remote application source code

platform/atm2/ATM22xx-x1x/include
    C header files

platform/atm2/ATM22xx-x1x/lib
    Application framework and libraries

platform/atm2/ATM22xx-x1x/openocd
    Programming and debug scripts

platform/atm2/ATM22xx-x1x/rom
    ROM makefile and linker scripts

platform/atm2/ATM22xx-x1x/tools
    Atmosic ATM22xx-x1x chip-specific tools

platform/atm2/ATM22xx-x1x/user
    Linker scripts and shared source code for ATM22xx-x1x

tools
    SDK toolsets

tools/atm_isp
tools/atm_isp_python
    In-System Programming Tool