Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[amebad][doc] Add README.md #9

Merged
merged 1 commit into from
Dec 7, 2021
Merged

[amebad][doc] Add README.md #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 123 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@

![Realtek-logo](https://logos-download.com/wp-content/uploads/2016/05/Realtek_logo_logotype.png)

For any questions, please visit our [website](https://www.amebaiot.com/en/) and [forum](https://forum.amebaiot.com/) to get more information.

# Getting Started

## Setup of the GCC Development Environment


> On Windows, you can use ``Cygwin`` as the GCC development environment. ``Cygwin`` is a large collection of GNU and open source tools which provide functionality similar to a Linux distribution on Windows.
Click [http://cygwin.com](http://cygwin.com/) and download the ``Cygwin`` package [setup-x86.exe](http://cygwin.com/setup-x86_64.exe) for your Windows platform.

1. 32-bit ``Cygwin`` is supported both for 32-bit Windows and 64-bit Windows.
2. During the installation of ``Cygwin`` package, include `Devel -> make` and `Math -> bc` utilities on the Select Packages page, as below shows.

![getstart0](https://www.amebaiot.com/wp-content/uploads/2020/02/guide_d_1.png)

![getstart1](https://rtd-debug.readthedocs.io/en/latest/_images/image2.png)

> Note:
For Linux, refer to [AN0400 Ameba-D Application Note v12.pdf](https://www.amebaiot.com/zh/sdk-download-manual-8722dm/) to build the GCC development environment.

## Knowledge about Ameba-D Demo Board

> For Ameba-D, there are many types of chipsets available, such as RTL8720CS, RTL8721CSM, RTL8722CSM, RTL8720DN, RTL8720DM, RTL8721DM, and RTL8722DM.
> In addition, the chipsets can be embedded on Ameba-D DEV demo board, which is extended to various I/O interfaces. The corresponding HDK (Hardware Development Kit) documents are available, please contact RTK for further details.

The hardware block diagram of Ameba-D demo board is shown below.

- USB TO UART: power supply and log print.
- The baudrate is 115200bps
- SWD: SWD interface, used to download images and debug with IAR.
- Reset button: reset Ameba-D to run firmware after IAR completes download.

![image2](https://www.amebaiot.com/wp-content/uploads/2020/02/guide_d_3.png)

## Connection to Log Console

> On Ameba-D board, FTDI Chip and FT232 can be used for the log console and debugger. To view the log console, make use of the terminal tool, such as ``SecureCRT``/``teraterm``/``putty`` and etc. We will take our internal tool as an example.

1) Select the corresponding serial uart configure communicate parameter and then open it.
2) Press the Reset button on Ameba-D board. Some messages can be found in the terminal.

![image3](https://www.amebaiot.com/wp-content/uploads/2020/02/guide_d_4.png)

## Building the First GCC Project on Ameba-D

The following steps are for first-time developer to build GCC project, under existing RTK SDK.

> **Building Code** This section illustrates how to build SDK.
> First, you need to switch to GCC project directory. For Windows, open ``Cygwin`` terminal and use ``$ cd`` command to change directory to KM0 or KM4 project directory of Ameba-D SDK.

> Note:
You need to replace the ``{path}`` to your own SDK location, and add ``cygdrive`` prefix in front of the SDK location, so that Cygwin can access your file system.

```bash
cd /cygdrive/{path}/project/realtek_amebaD_va0_example/GCC-RELEASE/project_lp
cd /cygdrive/{path}/project/realtek_amebaD_va0_example/GCC-RELEASE/project_hp
```

Linux, open its own terminal and use $ cd command to change directory to KM0 or KM4 project directory of Ameba-D SDK.

```bash
cd /{path}/project/realtek_amebaD_va0_example/GCC-RELEASE/project_lp
cd /{path}/project/realtek_amebaD_va0_example/GCC-RELEASE/project_hp
```

To build SDK for normal image, simply use ``$ make all`` command under the corresponding project directories on Cygwin (Windows) or terminal (Linux).
KM0 project For KM0 project, if the terminal contains ``km0_image2_all.bin`` and ``Image manipulating end`` output message, it means that the image has been built successfully, as below shows.

![image4](https://www.amebaiot.com/wp-content/uploads/2020/02/guide_d_5.png)

> If somehow it is built failed, type ``$ make clean`` to clean and then redo the make procedure.
> After successfully built, the image file is located in ``project/realtek_amebaD_va0_example/GCC-RELEASE/project_lp/asdk/image`` , as below shows.

![image5](https://www.amebaiot.com/wp-content/uploads/2020/02/guide_d_6.png)

KM4 project For KM4 project, if the terminal contains ``km0_image2_all.bin`` and ``Image manipulating end`` output message, it means that the image has been built successfully, as below shows.

![image6](https://www.amebaiot.com/wp-content/uploads/2020/02/guide_d_7.png)

> If somehow it built failed, type ``$ make clean`` to clean and then redo the make procedure.
> After built successfully, the image file is located in ``project/realtek_amebaD_va0_example/GCC-RELEASE/project_hp/asdk/image``, as below shows.

![image7](https://www.amebaiot.com/wp-content/uploads/2020/02/guide_d_8.png)

## Downloading Images to Ameba-D

Realtek provides an image tool to download images on windows.

* Environment Requirements: EX. WinXP, Win 7 Above, Microsoft .NET Framework 3.5
* ``ImageTool.exe`` Location: ``SDK\tools\AmebaD\Image_Tool\ImageTool.exe``

![image8](https://www.amebaiot.com/wp-content/uploads/2020/02/guide_d_9.png)]

Assuming that the ImageTool on PC is a server, it sends images files to Ameba (client) through UART. To download image from server to client, the client must enter uart download first.

1) **Enter into UART_DOWNLOAD mode.**

* Push the UART DOWNLOAD button and keep it pressed.
* Re-power on the board or press the Reset button.
* Release the UART DOWNLOAD button.

Now, Ameba board gets into UART_DOWNLOAD mode and is ready to receive data.

2) **Click Chip Select(in red) on UI and select chip (AmebaD or AmebaZ).**

3) **Select the corresponding serial port and transmission baud rate. The default baudrate is 1.5Mbps (recommended).**

4) **Click the Browse button to select the images (km0_boot_all.bin/km4_boot_all.bin/km0_km4_image2.bin) to be programmed and input addresses.**

* The image path is located in:
``{path}\project\realtek_amebaD_va0_example\GCC-RELEASE\project_lp\asdk\image``
and
``{path}\project\realtek_amebaD_va0_example\GCC-RELEASE\project_hp\asdk\image``,
where {path} is the location of the project on your own computer.
* The default target address is the SDK default image address, you can use it directly.

5) **Click Download button to start. The progress bar will show the transmit progress of each image. You can also get the message of operation successfully or errors from the log window.**

![image9](https://www.amebaiot.com/wp-content/uploads/2020/02/guide_d_10.png)