AT-Link Console User Manual

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.

Applicable products:
AT32F403

AT32F413

AT32F415

AT32F403A

AT32F407

MCU series AT32F421

AT32F435

AT32F437

AT32F425

AT32WB415

AT32L021

2022.08.12 1 Ver 2.05

 AT-Link Console User Manual

Contents

1 Introduction ............................................................................................................ 5

Environmental requirements ..................................................................................... 5

Glossary ................................................................................................................... 5

2 Installation .............................................................................................................. 6

3 Software operation ................................................................................................ 7

Operating mode ........................................................................................................ 7

Command line parameters ....................................................................................... 8
AT-Link Console return cods................................................................................... 10
Flow chart ............................................................................................................... 12

4 Revision history ................................................................................................... 13

2022.08.12 2 Ver 2.05

 AT-Link Console User Manual

List of tables
Table 1 List of command line parameters ............................................................................................ 8
Table 2 List of return codes................................................................................................................ 10
Table 3. Document revision history.................................................................................................... 13

2022.08.12 3 Ver 2.05

 AT-Link Console User Manual

List of figures
Figure- 1 Command line window ......................................................................................................... 7
Figure- 2 Batch file processing ............................................................................................................ 7
Figure- 3 Flow chart ........................................................................................................................... 12

2022.08.12 4 Ver 2.05

 AT-Link Console User Manual

1 Introduction
Environmental requirements
 Software resources
Windows 7 and above.
Software version below 3.0.00, .Net framework 4.0 is required.
Software version 3.0.00 and above, .Net framework 4.6 is required.
No driver is required when using AT-Link debugger.

 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.

2022.08.12 5 Ver 2.05

 AT-Link Console User Manual

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.

2022.08.12 6 Ver 2.05

 AT-Link Console User Manual

3 Software operation
Operating mode
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

2022.08.12 7 Ver 2.05

 AT-Link Console User Manual
Command line parameters
Table 1 List of command line parameters

Command Sub Command Remarks

-? Show the help.

Set device, e.g AT32F403ARGT7. You must set device when the
-device
device access protection.

-connect Establish connection.

-e Erase flash.

Erase all sectors of flash, spim(spim enabled), boot memory(AP mode

--all
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)

Erase selected sectors of main space, begin sector-end sector, e.g 0-

--sec n-m
20.

-u Upload flash contents to the specified file.

--sec n-m Upload selected sectors, begin_sector-end_sector, e.g 0-20.

Full path name (bin, hex file; the file type is recognized by its
--fn file_name
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.

Full path name (bin, hex file; the file type is recognized by its
--fn file_name
extension).

-d Download the content of the specified file into flash

Start address, default 0x08000000; ignored if the target file is not a

--a address(hex)
binary file.

2022.08.12 8 Ver 2.05

 AT-Link Console User Manual

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.

Enable high level access protection, all options following this one will
--efap2
fail.
If the MCU is AT32F425/L021, you must enter "--y" for confirmation.
--y
(--efap2 --y)

--dfap Disable flash access protection.

--depp Disable erase and program protection.

Enable erase and program protection for sector codes, begin_sector-

--eepp n-m
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 user system data from the device and write it in the specified file,
--get --fn file_name
full path name (bin/hex file, the file type is recognized by its extension).
Load user system data from the specified file and write it to the device,
--set --fn file_name
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 IO pin used by SPIM.

--remap 0/1 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.

2022.08.12 9 Ver 2.05

 AT-Link Console User Manual

Command Sub Command Remarks

-w2 MCU debug mode, write 16-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, 16 bit data. e.g 0011.

-mem32 MCU debug mode, read 32-bit data.

addr(hex) The address of the data to be read, 32 bit address. e.g 08000000.

-mem16 MCU debug mode, read 16-bit data.

addr(hex) The address of the data to be read, 32 bit address. e.g 08000000.

-r Reset and run. When MCU access protection, this command is invalid.

AT-Link Console return codes

In case fo error, while executing AT-Link Console commands, the return code (Errrolevel) is greater
than 0.

Table 2 List of return codes

Return
Command Error
code

0x00 All Finished successfully

0x01 All Command arguments error.

0x02 All Connection problem.

0x03 -d Flash memory programming/verification error.

0x04 -u Failed to upload Flash memory contents

0x05 -uble Failed to upload BLE module main code space Flash contents.

0x06 -usd Failed to get user system data from the device.

0x07 -usd Failed to write user system data to the device.

0x08 -enspim Failed to enable SPIM.

0x09 -bmapm Failed to set boot memory AP mode

0x0A -w4/-w2 Error occurred while writing data to the specified flash address

0x0B -mem32/-mem16 Error occurred while reading data from the specified flash address

0x0C -r Reset and run error.

2022.08.12 10 Ver 2.05

 AT-Link Console User Manual
Return
Command Error
code
0x20 -p --efap1 Failed to enable access protection.

0x21 -p --efap2 Failed to enable high level access protection.

0x22 -p --dfap Failed to disable flash access protection.

0x23 -p --depp Failed to disable erase and program protection.

0x24 -p --eepp Failed to enable erase and program protection.

0x25 -p --ebfap Failed to enable BLE module access protection.

0x26 -p --dbfap Failed to disable BLE module access protection.

0x30 -e --all --flash Failed to erase all sectors of Flash.

0x31 -e --all --spim Failed to erase all sectors of SPIM.

0x32 -e --all --bootm Failed to erase all sectors of boot memory.

0x33 -e --sec Failed to erase selected sectors.

0x34 -eble --all Failed to erase all sectors of BLE module Flash.

0x35 -eble –all --main Failed to erase all sectors of BLE main code space.

0x36 -eble --all --nvr Failed to erase all sectors of BLE NVR space.

0x37 -eble --all --rdn Failed to erase all sectors of BLE RDN space.

0x38 -eble --sec Failed to erase selected sectors of BLE main code space.

2022.08.12 11 Ver 2.05

 AT-Link Console User Manual
Flow chart
Figure- 3 Flow chart

Start

When MCU acce ss

protected or e rase a nd
Disa ble access p rote ction or prog ram p rote cted
erase and pro gram
protection

When a SPIM is
nee ded
Ena ble SPIM

Era se Flash

Download
Per form
verifica tion
according to the
nee ds
Upload an d V erify

Pro gram u ser system

data

Ena ble protection

End

2022.08.12 12 Ver 2.05

 AT-Link Console User Manual

4 Revision history
Table 3. Document revision history
Date Revision Changes
2022/08/12 V2.05 1. Added return codes.
2022/07/15 V2.04 1. Added AT32L021 series.
2022/04/27 V2.03 1. Support reset and run.
2022/01/26 V2.02 1. Added AT32WB415CCU7-7
2022/01/04 V2.01 1． Added SPIM support.
2. Support disable/enable of the advanced access protection.
3. Support disable/enable of the programming protection.
4. Support upload feature.
5. Support direct read/write feature.
2021/11/26 V2.00 1. Initial release Support AT32F403/F413/F415/F421/F403A/F407/F435/F437.
2. Added AT32F425 series.

2022.08.12 13 Ver 2.05

 AT-Link Console User Manual

IMPORTANT NOTICE – PLEASE READ CAREFULLY

Purchasers understand and agree that purchasers are solely responsible for the selection and use of Artery’s products and services.

Artery’s products and services are provided “AS IS” and Artery provides no warranties express, implied or statutory, including, without
limitation, any implied warranties of merchantability, satisfactory quality, non-infringement, or fitness for a particular purpose with respect to
the Artery’s products and services.

Notwithstanding anything to the contrary, purchasers acquires no right, title or interest in any Artery’s products and services or any
intellectual property rights embodied therein. In no event shall Artery’s products and services provided be construed as (a) granting
purchasers, expressly or by implication, estoppel or otherwise, a license to use third party’s products and services; or (b) licensing the third
parties’ intellectual property rights; or (c) warranting the third party’s products and services and its intellectual property rights.

Purchasers hereby agrees that Artery’s products are not authorized for use as, and purchasers shall not integrate, promote, sell or
otherwise transfer any Artery’s product to any customer or end user for use as critical components in (a) any medical, life saving or life
support device or system, or (b) any safety device or system in any automotive application and mechanism (including but not limited to
automotive brake or airbag systems), or (c) any nuclear facilities, or (d) any air traffic control device, application or system, or (e) any
weapons device, application or system, or (f) any other device, application or system where it is reasonably foreseeable that failure of the
Artery’s products as used in such device, application or system would lead to death, bodily injury or catastrophic property damage.

© 2022 ARTERY Technology – All rights reserved

2022.08.12 14 Ver 2.05