Infineon ASCLIN Shell UART 1 User manual

AURIX™ TC2xx Microcontroller Training
V1.0.0
ASCLIN_Shell_UART_1
Shell via UART communication
Please read the Important Notice and Warnings at the end of this document

Scope of work
A Shell is used to parse a command line and call the corresponding
command execution. The ASCLIN module is used to interface with the
Shell through the USB port via UART.
The ASCLIN module is configured for UART communication.
The Shell from iLLDs exploits the ASCLIN module to interpret and manage
commands from the user like “info”, “toggle [x]” or “help”.
2
2019-10-17 Copyright © Infineon Technologies AG 2019. All rights reserved.

Introduction
›The Asynchronous/Synchronous Interface (ASCLIN) module provides
serial communication with external devices. In this example, it is used to
interface with the PC through the USB port via UART communication.
›A Shell is a user interface for parsing commands and accessing services.
3
2019-10-17 Copyright © Infineon Technologies AG 2019. All rights reserved.

Hardware setup
This code example has been
developed for the board
KIT_AURIX_TC297_TFT_BC-Step.
The board should be connected to
the PC through the USB port (1).
1
4
2019-10-17 Copyright © Infineon Technologies AG 2019. All rights reserved.

Implementation
Configure the ASCLIN module
The configuration of the ASCLIN module is done by initializing an instance of the IfxAsclin_Asc_Config
structure, which contains the following fields:
›baudrate –a structure that allows to set
–baudrate –the communication speed in bit/s
–oversampling –the division ratio of the baud rate for reaching higher frequencies to ensure
oversampling
›bitTiming –a structure that allows to set the sampling mode with
–medianFilter –the number of samples per bit
–samplePointPosition –the first sample point position
›interrupt –a structure that allows to set
–txPriority, rxPriority and erPriority –the interrupt priorities for transmission, reception and error
events
–typeOfService –the service provider responsible for handling the interrupt, which can be any of the
available CPUs, or the DMA
›pins –a structure that allows to set which port pins are used for the communication
›rxBuffer, rxBufferSize,txBuffer, txBufferSize –parameters that allow to configure the buffers that will
hold the incoming/outgoing data
The function IfxAsclin_Asc_initModuleConfig() fills the configuration structure with default values and
IfxAsclin_Asc_initModule() function initializes the module with the user configuration.
Both the functions can be found in the iLLD header IfxAsclin_Asc.h.
5
2019-10-17 Copyright © Infineon Technologies AG 2019. All rights reserved.

Implementation
Configure the Shell
To configure the Shell, it is needed to firstly initialize a Standard Interface and a Standard IO from the iLLDs.
This is done by the functions IfxAsclin_Asc_stdIfDPipeInit(), Ifx_Console_init() and
Ifx_Assert_setStandardIo(), that can be found respectively in the iLLDs headers IfxAsclin_Asc.h,
Ifx_Console.h and Assert.h.
Furthermore, it is needed to define the macros IFX_CFG_ASSERT_STDIO,
IFX_CFG_ASSERT_VERBOSE_LEVEL_DEFAULT and IFX_CFG_ASSERT_INCLUDE to configure the
Ifx_Assert.h header.
This is done in the configuration header Ifx_Cfg.h.
The Shell is configured inside the function initShellInterface() by initializing an instance of the
Ifx_Shell_Config structure with default values through the function Ifx_Shell_initConfig(). Then, the
following parameters are modified:
›standardIo –that allows to set the module used for serial communication
›commandList –that allows to set the list of commands supported by the shell
The command list is an array of structures of the type Ifx_Shell_Command, that contains:
–commandLine –the actual command which will be sent to the shell by the user
–help –a small description of the command that is shown when help command is given
–data –a link to the shell
–call –the function called when the command is given
The Ifx_Shell_init() function initializes the shell with the user configuration.
The functions Ifx_Shell_initConfig() and Ifx_Shell_init() can be found in the iLLD header Ifx_Shell.h, while
the function initShellInterface() is defined in the header UART_ASCLIN_Shell.h.
6
2019-10-17 Copyright © Infineon Technologies AG 2019. All rights reserved.

Implementation
Run the Shell
The Shell is continuously run through the function runShellInterface() called inside the infinite while loop in
the Cpu0_Main.c file.
It continuously reads the incoming data and evaluates them when the carriage return character is entered.
Configure and control the LEDs
The LEDs are toggled by controlling the port pins to which they are connected using methods from the iLLD
headers IfxPort.h.
The LED port pins have to be configured to output push-pull mode using the function
IfxPort_setPinMode().
During program execution, the LEDs are switched on and off using the function IfxPort_setPinState().
7
2019-10-17 Copyright © Infineon Technologies AG 2019. All rights reserved.

Implementation
Configure the Interrupt Service Routine (ISR)
The function implementing the ISR needs to be assigned a priority and a core responsible for its execution.
This is done with the macro IFX_INTERRUPT(isr, vectabNum, priority).
Since the Shell uses the ASCLIN module to interface with the user, three ISR are needed to be configured for
transmission, reception and error events.
Each of the ISR should call the handler for the respective operation (transmit, receive or error) by passing the
ASC handle.
8
2019-10-17 Copyright © Infineon Technologies AG 2019. All rights reserved.

Run & Test
In order to use the shell interface, a serial monitor (e.g. PuTTY, HTerm) is
required. The serial monitor must be configured with the following
parameters to enable the communication between the board and the PC:
›Port: COMx (e.g. COM5, COM port number depends on the setup)
›Baud rate: 115200
›Data bits: 8
›Parity: None
›Stop bits: 1
›Handshaking: None
9
2019-10-17 Copyright © Infineon Technologies AG 2019. All rights reserved.

Run and Test
Firstly, the serial monitor should be opened.After code compilation and
flashing the device, perform the following steps:
›Type “help” to see the list of available commands
›Type “toggle [0/1/2/3/4]” to respectively: turn on all LEDs, toggle LED
D107, toggle LED D108, toggle LED D109 or toggle LED D110
›Check command execution.
10
2019-10-17 Copyright © Infineon Technologies AG 2019. All rights reserved.

References
›More code examples can be found on the GIT repository:
›https://github.com/Infineon/AURIX_code_examples
›For additional trainings, visit our webpage:
›https://www.infineon.com/aurix-expert-training
›AURIX™ Development Studio is available online:
›https://www.infineon.com/aurixdevelopmentstudio
›Use the „Import...“ function to get access to more code examples.
›For questions and support, use the AURIX™ Forum:
›https://www.infineonforums.com/forums/13-Aurix-Forum
11
2019-10-17 Copyright © Infineon Technologies AG 2019. All rights reserved.

IMPORTANT NOTICE
The information given in this document shall in no
event be regarded as a guarantee of conditions or
characteristics (“Beschaffenheitsgarantie”).
With respect to any examples, hints or any typical
values stated herein and/or any information
regarding the application of the product, Infineon
Technologies hereby disclaims any and all
warranties and liabilities of any kind, including
without limitation warranties of non-infringement
of intellectual property rights of any third party.
In addition, any information given in this
document is subject to customer’s compliance
with its obligations stated in this document and
any applicable legal requirements, norms and
standards concerning customer’s products and
any use of the product of Infineon Technologies in
customer’s applications.
The data contained in this document is exclusively
intended for technically trained staff. It is the
responsibility of customer’s technical
departments to evaluate the suitability of the
product for the intended application and the
completeness of the product information given in
this document with respect to such application.
For further information on the product,
technology, delivery terms and conditions and
prices please contact your nearest Infineon
Technologies office (www.infineon.com).
WARNINGS
Due to technical requirements products may
contain dangerous substances. For information
on the types in question please contact your
nearest Infineon Technologies office.
Except as otherwise explicitly approved by
Infineon Technologies in a written document
signed by authorized representatives of Infineon
Technologies, Infineon Technologies’ products
may not be used in any applications where a
failure of the product or any consequences of the
use thereof can reasonably be expected to result
in personal injury.
Edition 2019-10
Published by
Infineon Technologies AG
81726 Munich, Germany
© 2019 Infineon Technologies AG.
All Rights Reserved.
Do you have a question about this
document?
Email: [e-mail]
Document reference
ASCLIN_Shell_UART_1
Trademarks
All referenced product or service names and trademarks are the property of their respective owners.