tools/README.macOS

This Atmosic SDK needs an external toolchain download for building images.

### Arm GNU-RM toolchain ###

Download GNU Arm Embedded Toolchain, Version 10.3-2021.07 from the
following location.

https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads/

At the time of this writing, the direct link below can also be used.

https://developer.arm.com/-/media/Files/downloads/gnu-rm/10.3-2021.07/gcc-arm-none-eabi-10.3-2021.07-mac-10.14.6.tar.bz2

The toolchain download md5sum is 86105798d4bea999e671285a556a7bde.

The following shows how to download and test the toolchain.

% curl --progress-bar -L https://developer.arm.com/-/media/Files/downloads/gnu-rm/10.3-2021.07/gcc-arm-none-eabi-10.3-2021.07-mac-10.14.6.tar.bz2 -o gcc-arm-none-eabi-10.3-2021.07-mac-10.14.6.tar.bz2
% md5 -q gcc-arm-none-eabi-10.3-2021.07-mac-10.14.6.tar.bz2
86105798d4bea999e671285a556a7bde
% tar xf gcc-arm-none-eabi-10.3-2021.07-mac-10.14.6.tar.bz2 -C atmosic_sdk/tools/
% atmosic_sdk/tools/gcc-arm-none-eabi-10.3-2021.07/bin/arm-none-eabi-gcc -dumpmachine
arm-none-eabi
%


Users of macOS 10.15 and newer may experience difficulty running the
toolchain for the first time due to GNU Arm being an unidentified
developer to macOS.  The only known solution to this problem is that
each executable in the toolchain has to be individually unblocked in
"System Preferences > Security & Privacy" as described on the page
linked below.

https://support.apple.com/en-us/HT202491


### Apple-Silicon Compatibility (optional) ###

In order to use the Atmosic SDK the Rosetta Translation Environment is
used to execute the internally built OpenOCD binary. Open Terminal
with the Rosetta Enviorment as described on the page linked below. If
Homebrew was previously installed, uninstall Homebrew before
continuing with next steps.

https://developer.apple.com/documentation/apple-silicon/about-the-rosetta-translation-environment


### Homebrew (Optional) ###

The macOS-related instructions in this SDK use the Homebrew package
manager, which can be downloaded from https://brew.sh, to install
dependencies.  Note, however, that any other method such as using a
different package manager or manual installation, should work as well.


### GNU sed (gsed) ###

Various scripts in this SDK use sed.  While the standard sed in macOS
is vary similar in behavior and syntax to GNU sed, there are subtle
differences.  Using Homebrew, gsed can be installed with:

brew install gnu-sed


### realpath ###

realpath is used by SDK to extract the relative path between two directories.
It isn't included in macOS by default and can be installed with:

brew install coreutils


### OpenOCD ###

This Atmosic SDK requires a version of openocd >= 0.11.0.  Various Mac
package managers provide older versions, so a binary was included with
this SDK.

OpenOCD for macOS (tools/openocd/openocd.out) has the following
dependencies.

1) libusb-0.1
2) libftdi
3) hidapi

Using the Homebrew package manager, the above dependencies can be
satisfied using the following command:

brew install libusb libusb-compat libftdi hidapi

Homebrew's libusb is version 1.0, which is why libusb-compat also
needs to be installed.


### Python 3 and Google Protocol Buffers 3 ###

The Atmosic ISP Tool requires Python 3.  It can be installed using Homebrew:

brew install python3

### USB connectivity(ATM3330) ####

Connect EVK to Mac using Micro-USB port.

Serial console will be on USB port (e.g. /dev/tty.usbmodem[12 serial number char.][1 char.])
Use below command to find port for serial console

bash-2.3$ ls -l /dev/tty* | grep usbmodem
crw-rw-rw-  1 root  wheel   18, 104 Mar 30 08:56 /dev/tty.usbmodem[12 serial number char.][1]
crw-rw-rw-  1 root  wheel   18, 106 Mar 30 08:56 /dev/tty.usbmodem[12 serial number char.][3]

### USB connectivity ####

Connect EVK to Mac using USB1 port.

Serial console will be on USB1 port (e.g. /dev/tty.usbserial-ATRDIxxxUSBx1)
Use below command to find port for serial console

bash-2.3$ ls -l /dev/tty* |grep ATRDI
crw-rw-rw-  1 root  wheel   18, 104 Mar 30 08:56 /dev/tty.usbserial-ATRDI338USB10
crw-rw-rw-  1 root  wheel   18, 106 Mar 30 08:56 /dev/tty.usbserial-ATRDI338USB11