AUTOSAR-like MCU Driver

From ErikaWiki

(Difference between revisions)
Jump to: navigation, search
(enum Mcu_PllStatusType)
(API Specification)
Line 138: Line 138:
The type shall be ''uint8'', ''uint16'' or ''uint32'', depending on μC platform.
The type shall be ''uint8'', ''uint16'' or ''uint32'', depending on μC platform.
 +
 +
==== ''enum Mcu_ResetType'' ====
 +
 +
  #include "Mcu.h"
 +
 +
Reset Type.
 +
 +
This type represents the different reset that a specified MCU can have.
 +
 +
The MCU module shall provide at least the values ''MCU_POWER_ON_RESET'' and ''MCU_RESET_UNDEFINED''.
 +
 +
'''Note''': Additional reset types may be added depending on MCU.
 +
 +
'''Enumerator''':
 +
* ''MCU_POWER_ON_RESET'':  Power On Reset (default)
 +
* ''MCU_WATCHDOG_RESET'':  Internal Watchdog Timer Reset
 +
* ''MCU_SW_RESET'':  Software Reset
 +
* ''MCU_RESET_UNDEFINED'': Reset is undefined
== Examples ==
== Examples ==
Usage examples of the AUTOSAR-like MCU Driver for can be found at [http://svn.tuxfamily.org/viewvc.cgi/erika_erikae/repos/ee/trunk/ee/examples/cortex_mx/lm4f232xxxx/as  examples/cortex_mx/lm4f232xxxx/as]
Usage examples of the AUTOSAR-like MCU Driver for can be found at [http://svn.tuxfamily.org/viewvc.cgi/erika_erikae/repos/ee/trunk/ee/examples/cortex_mx/lm4f232xxxx/as  examples/cortex_mx/lm4f232xxxx/as]

Revision as of 08:09, 16 July 2013

Contents

Synopsis

The MCU driver provides services for basic microcontroller initialization, power down functionality, reset and microcontroller specific functions required by other MCAL [Microcontroller Abstraction Layer] software modules. The initialization services allow a flexible and application related MCU initialization in addition to the start-up code (see figure below). The start-up code is very MCU specific. The start-up code is provided by Evidence Srl within Erika Enterprise.

Startup Code.png

MCU driver Features:

  • Initialization of MCU clock, PLL, clock prescalers and MCU clock distribution
  • Initialization of RAM sections
  • Activation of μC reduced power modes
  • Activation of a μC reset
  • Provides a service to get the reset reason from hardware

The MCU driver accesses the microcontroller hardware directly and is located in the Microcontroller Abstraction Layer.

File Structure

MCU Driver File structure.png

Configuration

Build

To enable AUTOSAR-like MCU Driver in Erika Enterprise compiler toolchain, the following EE_OPT attribute is needed in the OS object of the OSEK/VDX configuration:

 EE_OPT = "__AS_MCU_DRIVER__";

The configuration C header file inclusion is done by CFLAGS attribute in the OS object of the OSEK/VDX configuration:

 CFLAGS = "-I<PATH>";

Where <PATH> is the absolute or relative directory path which configuration C header file is stored.

Instead the configurations C source file is added to the compilation process by APP_SRC attribute in the CPU_DATA object of the OSEK/VDX configuration:

 APP_SRC = "<PATH>/Mcu_Cfg.c";

Where <PATH> is the absolute or relative directory path which configuration C source file is stored.

API Specification

Imported Types

typedef uint8 Std_ReturnType

 #include "Std_Types.h"

Standard Return Type.

This type can be used as standard API return type which is shared between AUTOSAR-like modules.

The Std_ReturnType shall normally be used with value E_OK or E_NOT_OK. If those return values are not sufficient user specific values can be defined by using the 6 least specific bits.

struct Std_VersionInfoType

 #include "Std_Types.h"

Standard Version Informations Type.

This type shall be used to request the version of a AUTOSAR-like module using the <Module Name>_GetVersionInfo() function.

Field Documentation:

 uint16 Std_VersionInfoType::moduleID

Module Identifier.

 uint8 Std_VersionInfoType::sw_major_version

Software Version Major Number.

 uint8 Std_VersionInfoType::sw_minor_version

Software Version Minor Number.

 uint8 Std_VersionInfoType::sw_patch_version

Software Version Patch Number.

 uint16 Std_VersionInfoType::vendorID

Vendor Identifier.

Types Defintions

struct Mcu_ConfigType

 #include "Mcu.h"

MCU Configuration Parameters.

The structure Mcu_ConfigType is an external data structure (i.e. implementation specific) and shall contain the initialization data for the MCU module. It shall contain:

  • MCU dependent properties
  • Reset Configuration
  • Definition of MCU modes
  • Definition of Clock settings
  • Definition of RAM sections

The structure Mcu_ConfigType shall provide a configurable (enable/disable) clock failure notification if the MCU provides an interrupt for such detection. If the clock failure is detected with other HW mechanisms e.g., the generation of a trap, this notification shall be disabled and the failure reporting shall be done outside the MCU driver.

The definitions for each MCU mode within the structure Mcu_ConfigType shall contain: (depending on MCU)

  • MCU specific properties
  • Change of CPU clock
  • Change of Peripheral clock
  • Change of PLL settings
  • Change of MCU power supply

The definitions for each Clock setting within the structure Mcu_ConfigType shall contain:

  • MCU specific properties as, e.g., clock safety features and special clock distribution settings
  • PLL settings /start lock options
  • Internal oscillator setting

The definitions for each RAM section within the structure Mcu_ConfigType shall contain:

  • RAM section base address
  • Section size
  • Data pre-setting to be initialized

Usage of linker symbols instead of scalar values is allowed.

enum Mcu_PllStatusType

 #include "Mcu.h"

PLL Status Type.

The type Mcu_PllStatusType is the type of the return value of the API function Mcu_GetPllStatus().

The type of Mcu_PllStatusType is an enumeration with the following values: MCU_PLL_LOCKED, MCU_PLL_UNLOCKED, MCU_PLL_STATUS_UNDEFINED.

Enumerator:

  • MCU_PLL_LOCKED: PLL is locked.
  • MCU_PLL_UNLOCKED: PLL is unlocked.
  • MCU_PLL_STATUS_UNDEFINED: PLL Status is unknown.

typedef uint Mcu_ClockType

 #include "Mcu.h"

Clock Type.

The type Mcu_ClockType defines the identification (ID) for clock setting configured via the configuration structure.

The type shall be uint8, uint16 or uint32, depending on μC platform.

enum Mcu_ResetType

 #include "Mcu.h"

Reset Type.

This type represents the different reset that a specified MCU can have.

The MCU module shall provide at least the values MCU_POWER_ON_RESET and MCU_RESET_UNDEFINED.

Note: Additional reset types may be added depending on MCU.

Enumerator:

  • MCU_POWER_ON_RESET: Power On Reset (default)
  • MCU_WATCHDOG_RESET: Internal Watchdog Timer Reset
  • MCU_SW_RESET: Software Reset
  • MCU_RESET_UNDEFINED: Reset is undefined

Examples

Usage examples of the AUTOSAR-like MCU Driver for can be found at examples/cortex_mx/lm4f232xxxx/as

Personal tools