ARTERY AT32F Series User manual
AT-Link Console User Manual
2023.08.10 1Ver 2.08
UM0006
User Manual
AT-Link Console User Manual
Introduction
This user manual gives an overview of AT-Link Console. AT-Link Console is a command-line
application based on AT-Link. With the help of this software, users can configure ARTERY MCU
devices through SWD ports.
List of applicable Artery MCUs:
Part number
AT32F series
AT-Link Console User Manual
2023.08.10 2Ver 2.08
Contents
1Introduction ................................................................................................................5
Environmental requirements.........................................................................................5
Glossary ........................................................................................................................5
2Installation ..................................................................................................................6
3Software operation ....................................................................................................7
Operating mode ............................................................................................................7
3.1.1 Used in Windows..........................................................................................................7
3.1.2 Used in Linux................................................................................................................8
Command line parameters ...........................................................................................9
AT-Link Console return codes ....................................................................................11
Flow chart....................................................................................................................13
4Revision history .......................................................................................................14
AT-Link Console User Manual
2023.08.10 3Ver 2.08
List of tables
Table 1 List of command line parameters............................................................................................9
Table 2 List of return codes................................................................................................................ 11
Table 3. Document revision history....................................................................................................14
AT-Link Console User Manual
2023.08.10 4Ver 2.08
List of figures
Figure- 1 Command line window .........................................................................................................7
Figure- 2 Batch file processing ............................................................................................................7
Figure- 3 Linux OS...............................................................................................................................8
Figure- 4 Shell script file ......................................................................................................................8
Figure- 5 Flow chart ...........................................................................................................................13
AT-Link Console User Manual
2023.08.10 5Ver 2.08
1 Introduction
Environmental requirements
Software resources
Windows OS
Windows 7 and above.
No driver is required when using AT-Link debugger.
Linux OS
Linux OS with x86_64 architecture, such as Ubuntu, Federa, etc.
Hardware resources
AT-Link debugger
USB communication port.
Glossary
AT-Link debugger
AT-Link is a debugger, released by ARTERY, for the sake of MCU development.
AT-Link Console User Manual
2023.08.10 6Ver 2.08
2 Installation
Hardware installation
Step 1: Connect AT-Link debugger to the USB port of PC.
Step 2: Connect AT-Link debugger to the ICE interface of the target evaluation board.
Software installation
This software doesn’t need to be installed, just run the executable program directly.
AT-Link Console User Manual
2023.08.10 7Ver 2.08
3 Software operation
Operating mode
3.1.1 Used in Windows
Mode 1: Input parameters on the command line
Figure- 1 Command line window
Mode 2: Batch file processing (Refer to DFU_download.bat for details on common operations)
Figure- 2 Batch file processing
AT-Link Console User Manual
2023.08.10 8Ver 2.08
3.1.2 Used in Linux
1. The executive program “ATLink_Console” and the script “ATLink_Console.sh” needs an
execution permission.
Command: chmod +x ATLink_Console ATLink_Console.sh
2. Edit the script “download.sh”, add operation steps based on command line parameters shown
in Section 4.2 (Seedownload.sh in the example) and give an execution permission.
Command: chmod +x download.sh
3. To execut the script download.sh in the terminal, a sudo is required, for either a serial interface
or USB device needs a root user authority.
Command: sudo ./download.sh
Figure- 3 Linux OS
Figure- 4 Shell script file
AT-Link Console User Manual
2023.08.10 9Ver 2.08
Command line parameters
Table 1 List of command line parameters
Command
Sub Command
Remarks
-?
Show the help.
-device
Set device, e.g AT32F403ARGT7. Youmust set device when the device
access protection.
-connect
Establish connection.
-e
Erase flash.
--all
Erase all sectors of flash, spim(spim enabled), boot memory(AP mode
enabled).
--flash
Erase all sectors of flash. (--all --flash)
--spim
Erase all sectors of SPIM. (--all --spim)
--bootm
Erase all sectors of boot memory. (--all --bootm)
--sec n-m
Erase selected sectors, begin sector-end sector, e.g 0-20.
-eble
Erase BLE module flash.
--all
Erase all sectors of BLE module flash.
--main
Erase all sectors of mian code space. (--all --main)
--nvr
Erase all sectors of NVR space. (--all --nvr)
--rdn
Erase all sectors of RDN space. (--all --rdn)
--sec n-m
Erase selected sectors of main space, begin sector-end sector, e.g 0-
20.
-u
Upload flash contents to the specified file.
--sec n-m
Upload selected sectors, begin_sector-end_sector, e.g 0-20.
--fn file_name
Full path name (bin, hex file; the file type is recognized by its extension).
-uble
Upload BLE molule mian code space flash contents to the specified file.
--sec n-m
Upload selected sectors, begin_sector-end_sector, e.g 0-20.
--fn file_name
Full path name (bin, hex file; the file type is recognized by its extension).
-d
Download the content of the specified file into flash
--a address(hex)
Start address, default 0x08000000; ignored if the target file is not a
binary file.
AT-Link Console User Manual
2023.08.10 10 Ver 2.08
Command
Sub Command
Remarks
--fn file_name
Full path name (bin/hex file; the file type is recognized by its extension).
--v
Verify after download.
-p
Enable or disable protection.
--efap1
Enable access protection, all options following this one will fail.
--efap2
Enable high level access protection, all options following this one will
fail.
--y
If the MCU is AT32F425/F423/L021/F402/F405, you must enter "--y" for
confirmation.
(--efap2 --y)
--dfap
Disable flash access protection.
--depp
Disable erase and program protection.
--eepp n-m
Enable erase and program protection for sector codes, begin_sector-
end_sector, e.g 0-20.
--ebfap
Enable BLE module access protection.
--dbfap
Disable BLE module access protection.
-usd
Set user system data to MCU.
--get --fn file_name
Get user system data from the device and write it in the specified file,
full path name (bin/hex file, the file type is recognized by its extension).
--set --fn file_name
Load user system data from the specified file and write it to the device,
full path name (bin/hex file, the file type is recognized by its extension).
-enspim
Enable to access SPIM.
--ft type
SPIM flash type, value 1 or 2. Default value 1.
--fs size
SPIM flash size (MB).
--fda FA(hex)
SPIM FLASH_DA, hexadecimal.
--remap 0/1
Remap IO pin used by SPIM.
0: remap0 (Use PA11/PA12 pins)
1: remap1 (Use PB10/PB11 pins)
-bmapm
Set boot memory AP mode.
--key value
Hexadecimal, must be 0xA35F6D24.
-w4
MCU debug mode, write 32-bit data.
addr(hex)
The address of the data to be written, 32 bit address. e.g 20000000.
value(hex)
The value of the data to be written, 32 bit data. e.g 00112233.
Table of contents
Other ARTERY Computer Hardware manuals
ARTERY
ARTERY AT32F425 Series User manual
ARTERY
ARTERY AT32F403A Series User manual
ARTERY
ARTERY AT32F425 Series User manual
ARTERY
ARTERY AT32F435ZDT7 User manual
ARTERY
ARTERY AT-START-F413 User manual
ARTERY
ARTERY AT32F421 Series User manual
ARTERY
ARTERY AT32 MCU CAN User manual
ARTERY
ARTERY AT32F402 Series User manual
ARTERY
ARTERY AT32F403A Series User manual
ARTERY
ARTERY AT32F413 Series User manual
Popular Computer Hardware manuals by other brands
EMC2
EMC2 VNX Series Hardware Information Guide
Panasonic
Panasonic DV0PM20105 Operation manual
Mitsubishi Electric
Mitsubishi Electric Q81BD-J61BT11 user manual
Gigabyte
Gigabyte B660M DS3H AX DDR4 user manual
Raidon
Raidon iT2300 Quick installation guide
National Instruments
National Instruments PXI-8186 user manual
