Difference between revisions of "AVR8"

From ERIKA WIKI
Jump to: navigation, search
(Compiler Path)
(BOARD)
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Synopsys =
+
= introduction =
This manual describes the porting details of the ERIKA Enterprise v3 kernel(s) for the Atmel (now Microchip) families of microcontrollers which supports 8/16-bit RISC AVR cores (aka AVR8).
+
This manual describes the porting details of the ERIKA Enterprise v3 kernel(s) for the Atmel (now Microchip) families of microcontrollers which support 8/16-bit RISC AVR cores (aka AVR8).
  
* AVR8 integration features
+
= AVR8 Features Supported =
** Support for AVR8 GCC compiler;
+
 
** Support for the following families Atmel (now Microchip) MCUs:
+
The following are the main features of the currently implemented support:
*** [http://www.atmel.com/products/microcontrollers/avr/megaAVR.aspx megaAVR]
+
 
** Support for following boards
+
* Development tools
*** [https://store.arduino.cc/arduino-uno-rev3 Arduino Uno Board] (ATmega328p)
+
** Support for AVR GCC compiler [http://winavr.sourceforge.net/download.html WinAVR]
** List of functions:
+
* Microcontrollers
*** Full support for [https://www.arduino.cc/en/Main/Software Arduino SDK 1.8.5];
+
** [http://www.microchip.com/design-centers/8-bit/avr-mcus Microchip AVR MCUs] Families
 +
*** [https://www.microchip.com/wwwproducts/en/ATmega328P Microchip ATmega328P] Specific MCU.
 +
* Evaluation Boards
 +
** [https://store.arduino.cc/arduino-uno-rev3 Arduino Uno Board] (ATmega328p)
 +
* External Libraries
 +
** Full support for [https://www.arduino.cc/en/Main/Software Arduino SDK 1.8.5];
 +
 
 +
== Tutorials ==
 +
 
 +
The following tutorials are available for this architecture:
 +
* [[AVR8_-_Arduino_application_build_on_Windows|AVR8: Arduino application build on Windows]]
  
 
= Configuration and Programming =
 
= Configuration and Programming =
  
ERIKA Enterprise is configured through [[Tutorial: RT-Druid and OIL basics | RT-Druid and an OIL file]]. Here are listed, after the information to set compiler path, the OIL fields customized for Atmel (now Microchip) AVR8 architecture.
+
ERIKA Enterprise is configured through [[Tutorial: RT-Druid and OIL basics | RT-Druid and an OIL file]] and some other properties.
 +
 
 +
The following sections describe the properties and OIL fields customized for Atmel (now Microchip) AVR8 architecture.
  
 
== Compiler Path ==
 
== Compiler Path ==
Line 19: Line 31:
 
It is possible to choose the path of the compiler in three different ways:
 
It is possible to choose the path of the compiler in three different ways:
  
* ''PATH enviornment variable'': You can put compilers bin directories in PATH and the environmet can use them from here.
+
* ''Compiler specific environment variables'': '''AVR_TOOLS'''
* ''Compiler specific environment variables'':
+
** E.g.: AVR_TOOLS=C:\WinAVR
** '''AVR8 GCC toolchain''': You can specify the compiler path for AVR8 GCC with the '''AVR_TOOLS'''.
+
* ''RT-Druid Eclipse IDE Property''.
* ''RT-Druid configuration file'' see [[RT-Druid configuration#Generator_properties_paths]]:
+
* ''RT-Druid Configuration File Entry'': '''preference_avr8__path_for_gcc_compiler'''
** '''preference_avr8__path_for_gcc_compiler''' set GCC compiler path for AVR8
+
** E.g.: preference_avr8__path_for_gcc_compiler=C:\WinAVR
 +
 
 +
Here is an [[Common oil.pref example|example of RT-Druid configuration file]].
 +
 
 +
== Arduino SDK Path ==
 +
 
 +
It is possible to choose the path in three different ways:
 +
 
 +
* ''Specific environment variables'': '''ARDUINO_SDK_FILES'''
 +
** E.g.: ARDUINO_SDK_FILES=C:\Program Files (x86)\Arduino
 +
* ''RT-Druid Eclipse IDE Property''.
 +
* ''RT-Druid Configuration File Entry'': '''preference_avr8__path_for_arduino_sdk'''
 +
** E.g.: preference_avr8__path_for_arduino_sdk=C:\Program Files (x86)\Arduino
 +
 
 +
Here is an [[Common oil.pref example|example of RT-Druid configuration file]].
 +
 
 +
== Arduino Serial Port ==
 +
 
 +
It is possible to choose the Serial Port for Arduino in two different ways:
 +
 
 +
* ''RT-Druid Eclipse IDE Property''.
 +
* ''RT-Druid Configuration File Entry'': '''preference_avr8__serial_port_for_arduino'''
 +
** E.g.: preference_avr8__serial_port_for_arduino=COM5
 +
 
 +
Here is an [[Common oil.pref example|example of RT-Druid configuration file]].
 +
 
 +
== Arduino Serial Baudrate ==
 +
 
 +
It is possible to choose the Serial Baudrate for Arduino in two different ways:
 +
 
 +
* ''RT-Druid Eclipse IDE Property''.
 +
* ''RT-Druid Configuration File Entry'': '''preference_avr8__serial_baudrate_for_arduino'''
 +
** E.g.: preference_avr8__serial_baudrate_for_arduino=115200
  
 
Here is an [[Common oil.pref example|example of RT-Druid configuration file]].
 
Here is an [[Common oil.pref example|example of RT-Druid configuration file]].
Line 30: Line 74:
  
 
'''CPU_DATA''' must be set to  '''AVR8'''.
 
'''CPU_DATA''' must be set to  '''AVR8'''.
 +
 +
The available <tt>COMPILER</tt> is <tt>GCC</tt>.
  
 
Example of a CPU_DATA section:
 
Example of a CPU_DATA section:
  
 
     CPU_DATA = AVR8 {
 
     CPU_DATA = AVR8 {
 +
      COMPILER = GCC;
 
       ...
 
       ...
 
     };
 
     };
Line 39: Line 86:
 
== MCU ==
 
== MCU ==
  
'''MCU_DATA''' supports for now the '''MEGA''' value only.
+
'''MCU_DATA''' object supports for now the '''MEGA''' value only.
 +
 
 +
Example of a MCU_DATA section:
 +
 
 +
    MCU_DATA = MEGA {
 +
      ...
 +
    };
 +
 
 +
=== MODEL ===
  
 
'''MODEL''' attribute of '''MCU_DATA''' supports for now the '''MEGA_328p''' value only.
 
'''MODEL''' attribute of '''MCU_DATA''' supports for now the '''MEGA_328p''' value only.
 +
Default value is '''MEGA_328p'''.
 +
 +
Example of MODEL attribute of a MCU_DATA section:
  
 
   MCU_DATA = MEGA {
 
   MCU_DATA = MEGA {
Line 49: Line 107:
 
== BOARD ==
 
== BOARD ==
  
For now there is no NATIVE board support for AVR8 Architecture. The ONLY supported board is [[Arduino]] by [https://www.arduino.cc/en/Main/Software Arduino SDK 1.8.5].
+
For now, there is no NATIVE board support for AVR8 Architecture. The ONLY supported board is [[Arduino]] by [https://www.arduino.cc/en/Main/Software Arduino SDK 1.8.5].
 +
 
 +
'''NOTE:''' To support a custom board, it's mandatory to install the Arduino SDK software package and correctly set the related RT-Druid properties.
 +
 
 +
Moreover it's mandatory to set the ''F_CPU'' macro according to the ''CLOCK FREQUENCY'' set by custom AVR8 MCU Driver (e.g. 16MHz in the following example).
 +
 
 +
  ...
 +
  OS myOs {
 +
    ...
 +
    CFLAGS = "-DF_CPU=16000000L";
 +
    ...
 +
  };
 +
  ...
 +
 
 +
== LIB ==
 +
 
 +
'''LIB''' object supports for now the '''ARDUINO''' value only.
 +
 
 +
Example of a LIB section:
 +
 
 +
    LIB = ARDUINO {
 +
      ...
 +
    };
 +
 
 +
=== ARDUINO ===
 +
 
 +
The following sections describe the OIL fields of the '''LIB''' object customized for the official '''ARDUINO''' SDK supports.
 +
 
 +
==== SDK_BOARD ====
 +
 
 +
'''SDK_BOARD''' attribute of '''ARDUINO''' supports for now the '''UNO''' value only.
 +
Default value is '''UNO'''.
 +
 
 +
Example of SDK_BOARD attribute of ARDUINO:
 +
 
 +
    LIB = ARDUINO {
 +
      SDK_BOARD = UNO;
 +
      ...
 +
    };
 +
 
 +
==== VARIANT ====
 +
 
 +
'''VARIANT''' attribute of '''ARDUINO''' supports for now the '''CC''' value only.
 +
Default value is '''CC'''.
 +
 
 +
Example of VARIANT attribute of ARDUINO:
 +
 
 +
    LIB = ARDUINO {
 +
      SDK_BOARD = UNO;
 +
      VARIANT = CC;
 +
      ...
 +
    };
 +
 
 +
===== VERSION =====
 +
 
 +
'''VERSION''' attribute of '''ARDUINO CC VARIANT''' supports for now the '''"1.8.5"''' value only.
 +
Default value is '''"1.8.5"'''.
 +
 
 +
Example of VERSION attribute of ARDUINO CC VARIANT:
 +
 
 +
    LIB = ARDUINO {
 +
      SDK_BOARD = UNO;
 +
      VARIANT = CC {
 +
        VERSION = "1.8.5";
 +
      };
 +
      ...
 +
    };
 +
 
 +
==== STAND_ALONE ====
 +
 
 +
'''STAND_ALONE''' boolean attribute of '''ARDUINO''' configures the build system to generate or not '''libarduinosdk.a''' stand-alone binary library. The default value is set to '''TRUE'''.
 +
Default value is '''TRUE'''.
 +
 
 +
Example of STAND_ALONE attribute of ARDUINO:
 +
 
 +
    LIB = ARDUINO {
 +
      SDK_BOARD = UNO;
 +
      VARIANT = CC {
 +
        VERSION = "1.8.5";
 +
      };
 +
      STAND_ALONE = TRUE;
 +
    };
  
 
== Interrupt Handling ==
 
== Interrupt Handling ==
Line 57: Line 196:
 
=== MEGA Family ===
 
=== MEGA Family ===
  
The '''MEGA''' family of '''AVR8''' microcontrollers has an interrupt vector table which is stored in the flash memory. The lowest addresses of the interrupt vector table is allocated to the RESET and to the interrupt vectors. Interrupt handlers placed at lower addresses have higher hardware priorities than interrupt handlers placed at higher addresses so the '''PRIORITY''' attribute of the '''ISR''' object in the OIL is USELESS. The complete list of '''SOURCE''' entries is shown below.
+
The '''MEGA''' family of '''AVR8''' microcontrollers has an interrupt vector table which is stored in the flash memory. The lowest addresses of the interrupt vector table are allocated to the RESET and to the interrupt vectors. Interrupt handlers placed at lower addresses have higher hardware priorities than interrupt handlers placed at higher addresses so the '''PRIORITY''' attribute of the '''ISR''' object in the OIL is USELESS. The complete list of '''SOURCE''' entries is shown below.
  
 
* <code>RESET</code>: External Pin, Power-on Reset, Brown-out Reset and Watchdog System Reset
 
* <code>RESET</code>: External Pin, Power-on Reset, Brown-out Reset and Watchdog System Reset
Line 95: Line 234:
 
This Section contains information about the OSEK/VDX Extensions (or optional features) that have been implemented for the AVR8 support.
 
This Section contains information about the OSEK/VDX Extensions (or optional features) that have been implemented for the AVR8 support.
  
=== System Timer ===
+
== System Timer ==
  
 
System Timer is microcontroller dependent so for each supported Atmel (now Microchip) AVR8 microcontroller family, the System Timer configuration of ERIKA Enterprise v3 is shown below.
 
System Timer is microcontroller dependent so for each supported Atmel (now Microchip) AVR8 microcontroller family, the System Timer configuration of ERIKA Enterprise v3 is shown below.
Line 102: Line 241:
  
 
For the '''MEGA''' family of '''AVR8''' microcontrollers the System Timer is linked to TIMER1 so the '''DEVICE''' attribute MUST be se to '''TIMER1_COMPA''' as shown below.
 
For the '''MEGA''' family of '''AVR8''' microcontrollers the System Timer is linked to TIMER1 so the '''DEVICE''' attribute MUST be se to '''TIMER1_COMPA''' as shown below.
 
  
 
   COUNTER SystemTimer {
 
   COUNTER SystemTimer {

Latest revision as of 09:27, 26 September 2018

introduction

This manual describes the porting details of the ERIKA Enterprise v3 kernel(s) for the Atmel (now Microchip) families of microcontrollers which support 8/16-bit RISC AVR cores (aka AVR8).

AVR8 Features Supported

The following are the main features of the currently implemented support:

Tutorials

The following tutorials are available for this architecture:

Configuration and Programming

ERIKA Enterprise is configured through RT-Druid and an OIL file and some other properties.

The following sections describe the properties and OIL fields customized for Atmel (now Microchip) AVR8 architecture.

Compiler Path

It is possible to choose the path of the compiler in three different ways:

  • Compiler specific environment variables: AVR_TOOLS
    • E.g.: AVR_TOOLS=C:\WinAVR
  • RT-Druid Eclipse IDE Property.
  • RT-Druid Configuration File Entry: preference_avr8__path_for_gcc_compiler
    • E.g.: preference_avr8__path_for_gcc_compiler=C:\WinAVR

Here is an example of RT-Druid configuration file.

Arduino SDK Path

It is possible to choose the path in three different ways:

  • Specific environment variables: ARDUINO_SDK_FILES
    • E.g.: ARDUINO_SDK_FILES=C:\Program Files (x86)\Arduino
  • RT-Druid Eclipse IDE Property.
  • RT-Druid Configuration File Entry: preference_avr8__path_for_arduino_sdk
    • E.g.: preference_avr8__path_for_arduino_sdk=C:\Program Files (x86)\Arduino

Here is an example of RT-Druid configuration file.

Arduino Serial Port

It is possible to choose the Serial Port for Arduino in two different ways:

  • RT-Druid Eclipse IDE Property.
  • RT-Druid Configuration File Entry: preference_avr8__serial_port_for_arduino
    • E.g.: preference_avr8__serial_port_for_arduino=COM5

Here is an example of RT-Druid configuration file.

Arduino Serial Baudrate

It is possible to choose the Serial Baudrate for Arduino in two different ways:

  • RT-Druid Eclipse IDE Property.
  • RT-Druid Configuration File Entry: preference_avr8__serial_baudrate_for_arduino
    • E.g.: preference_avr8__serial_baudrate_for_arduino=115200

Here is an example of RT-Druid configuration file.

CPU

CPU_DATA must be set to AVR8.

The available COMPILER is GCC.

Example of a CPU_DATA section:

   CPU_DATA = AVR8 {
     COMPILER = GCC;
     ...
   };

MCU

MCU_DATA object supports for now the MEGA value only.

Example of a MCU_DATA section:

   MCU_DATA = MEGA {
     ...
   };

MODEL

MODEL attribute of MCU_DATA supports for now the MEGA_328p value only. Default value is MEGA_328p.

Example of MODEL attribute of a MCU_DATA section:

 MCU_DATA = MEGA {
   MODEL = MEGA_328p;
 };

BOARD

For now, there is no NATIVE board support for AVR8 Architecture. The ONLY supported board is Arduino by Arduino SDK 1.8.5.

NOTE: To support a custom board, it's mandatory to install the Arduino SDK software package and correctly set the related RT-Druid properties.

Moreover it's mandatory to set the F_CPU macro according to the CLOCK FREQUENCY set by custom AVR8 MCU Driver (e.g. 16MHz in the following example).

 ...
 OS myOs {
   ...
   CFLAGS = "-DF_CPU=16000000L";
   ...
 };
 ...

LIB

LIB object supports for now the ARDUINO value only.

Example of a LIB section:

   LIB = ARDUINO {
     ...
   };

ARDUINO

The following sections describe the OIL fields of the LIB object customized for the official ARDUINO SDK supports.

SDK_BOARD

SDK_BOARD attribute of ARDUINO supports for now the UNO value only. Default value is UNO.

Example of SDK_BOARD attribute of ARDUINO:

   LIB = ARDUINO {
     SDK_BOARD = UNO;
     ...
   };

VARIANT

VARIANT attribute of ARDUINO supports for now the CC value only. Default value is CC.

Example of VARIANT attribute of ARDUINO:

   LIB = ARDUINO {
     SDK_BOARD = UNO;
     VARIANT = CC;
     ...
   };
VERSION

VERSION attribute of ARDUINO CC VARIANT supports for now the "1.8.5" value only. Default value is "1.8.5".

Example of VERSION attribute of ARDUINO CC VARIANT:

   LIB = ARDUINO {
     SDK_BOARD = UNO;
     VARIANT = CC {
       VERSION = "1.8.5";
     };
     ...
   };

STAND_ALONE

STAND_ALONE boolean attribute of ARDUINO configures the build system to generate or not libarduinosdk.a stand-alone binary library. The default value is set to TRUE. Default value is TRUE.

Example of STAND_ALONE attribute of ARDUINO:

   LIB = ARDUINO {
     SDK_BOARD = UNO;
     VARIANT = CC {
       VERSION = "1.8.5";
     };
     STAND_ALONE = TRUE;
   };

Interrupt Handling

Interrupt Handling is microcontroller dependent so for each supported Atmel (now Microchip) AVR8 microcontroller family, the ISRs configuration of ERIKA Enterprise v3 is shown below.

MEGA Family

The MEGA family of AVR8 microcontrollers has an interrupt vector table which is stored in the flash memory. The lowest addresses of the interrupt vector table are allocated to the RESET and to the interrupt vectors. Interrupt handlers placed at lower addresses have higher hardware priorities than interrupt handlers placed at higher addresses so the PRIORITY attribute of the ISR object in the OIL is USELESS. The complete list of SOURCE entries is shown below.

  • RESET: External Pin, Power-on Reset, Brown-out Reset and Watchdog System Reset
  • INT0: External Interrupt Request 0
  • INT1: External Interrupt Request 1
  • PCINT0: Pin Change Interrupt Request 0
  • PCINT1: Pin Change Interrupt Request 1
  • PCINT2: Pin Change Interrupt Request 2
  • WDT: Watchdog Time-out Interrupt
  • TIMER2_COMPA: Timer/Counter2 Compare Match A
  • TIMER2_COMPB: Timer/Counter2 Compare Match B
  • TIMER2_OVF: Timer/Counter2 Overflow
  • TIMER1_CAPT: Timer/Counter1 Capture Event
  • TIMER1_COMPA: Timer/Counter1 Compare Match A
  • TIMER1_COMPB: Timer/Coutner1 Compare Match B
  • TIMER1_OVF: Timer/Counter1 Overflow
  • TIMER0_COMPA: Timer/Counter0 Compare Match A
  • TIMER0_COMPB: Timer/Counter0 Compare Match B
  • TIMER0_OVF: Timer/Counter0 Overflow
  • SPI_STC: SPI Serial Transfer Complete
  • USART_RX: USART Rx Complete
  • USART_UDRE: USART, Data Register Empty
  • USART_TX: USART, Tx Complete
  • ADC_ADC: Conversion Complete
  • EE_READY: EEPROM Ready
  • ANALOG_COMP: Analog Comparator
  • TWI: 2-wire Serial Interface
  • SPM_READY: Store Program Memory Ready

EEOPT

The following EEOPTs are specific of AVR8 Architecture:

  • __AVR8_GCC_C99__: Enables C99 compiler option.

OSEK/VDX Extensions

This Section contains information about the OSEK/VDX Extensions (or optional features) that have been implemented for the AVR8 support.

System Timer

System Timer is microcontroller dependent so for each supported Atmel (now Microchip) AVR8 microcontroller family, the System Timer configuration of ERIKA Enterprise v3 is shown below.

MEGA Family

For the MEGA family of AVR8 microcontrollers the System Timer is linked to TIMER1 so the DEVICE attribute MUST be se to TIMER1_COMPA as shown below.

 COUNTER SystemTimer {
   MINCYCLE = 1;
   MAXALLOWEDVALUE = 65535;
   TICKSPERBASE = 1;
   TYPE = HARDWARE {
     DEVICE = "TIMER1_COMPA";
     SYSTEM_TIMER = TRUE;
   };
   SECONDSPERTICK = 0.001;
 };

Additional Notes

T.B.D.