Mcu.h File Reference

Introduction

This file contains interface header for MCU MCAL driver.

Go to the source code of this file.

MCU Reset Modes
Reset mode enum which can be used in Mcu_PerformReset()
#define	MCU_PERFORM_RESET_MODE_COLD   ((uint8) 0U)
	Initiate SW COLD RESET sequence.
#define	MCU_PERFORM_RESET_MODE_WARM   ((uint8) 1U)
	Initiate SW WARM RESET sequence.
#define	MCU_E_MODE_FAILURE   0U
typedef uint8	Mcu_ClockType
	This type specifies the identification (ID) for a ClockType status used by Mcu_InitClock()
typedef uint32	Mcu_RawResetType
	This type specifies the identification (ID) for a RAW MCU reset status returned by Mcu_GetResetRawValue()
typedef uint8	Mcu_RamSectionType
	This type specifies the identification (ID) for a RAM section used in Mcu_InitRamSection()
typedef uint8	Mcu_ModeType
	This type specifies the identification (ID) for a MCU mode used in Mcu_SetMode()
typedef const Mcu_ClockConfigType *	Mcu_ClockConfigPtrType
	Pointer to Clock Config structure.
const struct Mcu_ConfigType_s	McuModuleConfiguration_0
	MCU Configuration struct declaration.
void	Mcu_Init (const Mcu_ConfigType *ConfigPtr)
	This service initializes the MCU driver.
Std_ReturnType	Mcu_InitClock (Mcu_ClockType ClockSetting)
	This service initializes the PLL and other MCU specific clock options.
Std_ReturnType	Mcu_DistributePllClock (void)
	This service activates the PLL clock to the MCU clock distribution.
void	Mcu_PerformReset (void)
	The service performs a microcontroller reset.
Std_ReturnType	Mcu_InitRamSection (Mcu_RamSectionType RamSection)
	This service initializes the RAM section wise.
Mcu_PllStatusType	Mcu_GetPllStatus (void)
	This service provides the lock status of the PLL.
Mcu_ResetType	Mcu_GetResetReason (void)
	The service reads the reset type from the hardware, if supported.
Mcu_RawResetType	Mcu_GetResetRawValue (void)
	The service reads the reset type from the hardware register, if supported.
void	Mcu_ClearResetReason (void)
	Clear the Mcu Reset reason by clearing the reset reason register.
Mcu_RamStateType	Mcu_GetRamState (void)
	This service provides the actual status of the microcontroller Ram. (if supported)
void	Mcu_GetVersionInfo (Std_VersionInfoType *versioninfo)
	This service returns the version information of this module.
void	Mcu_SetMode (Mcu_ModeType McuMode)
	This service activates the MCU power modes.

Data Structures
struct	Mcu_ClockConfigType
	Structure for module clock setting. More...
struct	Mcu_ConfigType
	MCU CONFIG ROOT structure. More...

Macros
#define	ARRAYSIZE(array)
MCU Driver Module SW Version Info
Defines for MCU Driver version used for compatibility checks
#define	MCU_SW_MAJOR_VERSION   (10U)
	Driver Implementation Major Version.
#define	MCU_SW_MINOR_VERSION   (1U)
	Driver Implementation Minor Version.
#define	MCU_SW_PATCH_VERSION   (0U)
	Driver Implementation Patch Version.
MCU Driver Module AUTOSAR Version Info
Defines for MCU Driver AUTOSAR version used for compatibility checks
#define	MCU_AR_RELEASE_MAJOR_VERSION   (4U)
	AUTOSAR Major version specification implemented by MCU Driver.
#define	MCU_AR_RELEASE_MINOR_VERSION   (3U)
	AUTOSAR Minor version specification implemented by MCU Driver.
#define	MCU_AR_RELEASE_REVISION_VERSION   (1U)
	AUTOSAR Patch version specification implemented by MCU Driver.
MCU Driver ID Info
#define	MCU_VENDOR_ID   ((uint16) 44U)
	Texas Instruments Vendor ID.
#define	MCU_MODULE_ID   ((uint16) 101U)
	MCU Driver Module ID.
#define	MCU_INSTANCE_ID   ((uint8) 0U)
	MCU Driver Instance ID.
MCU Error Codes
Error codes returned by MCU functions
#define	MCU_E_PARAM_CONFIG   (0x0AU)
	ERROR Description: API service called with wrong configuration parameter.
#define	MCU_E_PARAM_CLOCK   (0x0BU)
	ERROR Description: API service used with wrong clock value.
#define	MCU_E_PARAM_MODE   (0x0CU)
	ERROR Description: API service used with wrong mode.
#define	MCU_E_PARAM_RAMSECTION   (0x0DU)
	ERROR Description: API service called with invalid/wrong RAM section.
#define	MCU_E_PLL_NOT_LOCKED   (0x0EU)
	ERROR Description: API service is called while PLL is not locked.
#define	MCU_E_UNINIT   (0x0FU)
	ERROR Description: Mcu Driver API service is called before initialization of MCU Driver.
#define	MCU_E_PARAM_POINTER   (0x10U)
	ERROR Description: API service is called with NULL/Wrong pointer.
#define	MCU_E_INIT_FAILED   (0x11U)
	ERROR Description: Initialization of the MCU Driver Failed.
MCU Driver State Values
The MCU Driver State Values
#define	MCU_STATUS_UNINIT   ((uint8)(0U))
	MCU driver Status uninitialized.
#define	MCU_STATUS_INIT   ((uint8)(1U))
	MCU driver Status Initialized.
MCU Service Ids
The Service Id is one of the argument to Det_ReportError function and is used to identify the source of the error
#define	MCU_SID_INIT   (0x00U)
	Mcu_Init() API Service ID.
#define	MCU_SID_INIT_RAM_SECTION   (0x01U)
	Mcu_InitRamSection() API Service ID.
#define	MCU_SID_INIT_CLOCK   (0x02U)
	Mcu_InitClock() API Service ID.
#define	MCU_SID_DISTRIBUTE_PLL_CLOCK   (0x03U)
	Mcu_DistributePllClock() API Service ID.
#define	MCU_SID_GET_PLL_STATUS   (0x04U)
	Mcu_GetPllStatus() API Service ID.
#define	MCU_SID_GET_RESET_REASON   (0x05U)
	Mcu_GetResetReason() API Service ID.
#define	MCU_SID_GET_RESET_RAW_VALUE   (0x06U)
	Mcu_GetResetRawValue() API Service ID.
#define	MCU_SID_PERFORM_RESET   (0x07U)
	Mcu_PerformReset() API Service ID.
#define	MCU_SID_SETMODE   (0x08U)
	Mcu_SetMode() API Service ID.
#define	MCU_SID_GET_VERSION_INFO   (0x09U)
	Mcu_GetVersionInfo() API Service ID.
#define	MCU_SID_GET_RAM_STATE   (0x0AU)
	Mcu_GetRamState() API Service ID.