Introduction

Data Structures
struct	Mcu_ClockConfigType
	Structure for module clock setting. More...

struct	Mcu_ConfigType
	MCU CONFIG ROOT structure. More...

Variables
const struct Mcu_ConfigType_s	McuModuleConfiguration_0
	MCU Configuration struct declaration. More...

Typedefs
typedef uint8	Mcu_ClockType
	This type specifies the identification (ID) for a ClockType status used by Mcu_InitClock() More...

typedef uint32	Mcu_RawResetType
	This type specifies the identification (ID) for a RAW MCU reset status returned by Mcu_GetResetRawValue() More...

typedef uint8	Mcu_RamSectionType
	This type specifies the identification (ID) for a RAM section used in Mcu_InitRamSection() More...

typedef uint8	Mcu_ModeType
	This type specifies the identification (ID) for a MCU mode used in Mcu_SetMode() More...

typedef const Mcu_ClockConfigType *	Mcu_ClockConfigPtrType
	Pointer to Clock Config structure. More...

Macros
#define	ARRAYSIZE(array)

#define	MCU_E_MODE_FAILURE 0U

MCU Driver Module SW Version Info
Defines for MCU Driver version used for compatibility checks
#define	MCU_SW_MAJOR_VERSION (9U)
	Driver Implementation Major Version. More...

#define	MCU_SW_MINOR_VERSION (1U)
	Driver Implementation Minor Version. More...

#define	MCU_SW_PATCH_VERSION (1U)
	Driver Implementation Patch Version. More...

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

#define	MCU_AR_RELEASE_MINOR_VERSION (3U)
	AUTOSAR Minor version specification implemented by MCU Driver. More...

#define	MCU_AR_RELEASE_REVISION_VERSION (1U)
	AUTOSAR Patch version specification implemented by MCU Driver. More...

MCU Driver ID Info
#define	MCU_VENDOR_ID ((uint16) 44U)
	Texas Instruments Vendor ID. More...

#define	MCU_MODULE_ID ((uint16) 101U)
	MCU Driver Module ID. More...

#define	MCU_INSTANCE_ID ((uint8) 0U)
	MCU Driver Instance ID. More...

MCU Error Codes
Error codes returned by MCU functions
#define	MCU_E_PARAM_CONFIG (0x0AU)
	ERROR Description: API service called with wrong configuration parameter. More...

#define	MCU_E_PARAM_CLOCK (0x0BU)
	ERROR Description: API service used with wrong clock value. More...

#define	MCU_E_PARAM_MODE (0x0CU)
	ERROR Description: API service used with wrong mode. More...

#define	MCU_E_PARAM_RAMSECTION (0x0DU)
	ERROR Description: API service called with invalid/wrong RAM section. More...

#define	MCU_E_PLL_NOT_LOCKED (0x0EU)
	ERROR Description: API service is called while PLL is not locked. More...

#define	MCU_E_UNINIT (0x0FU)
	ERROR Description: Mcu Driver API service is called before initialization of MCU Driver. More...

#define	MCU_E_PARAM_POINTER (0x10U)
	ERROR Description: API service is called with NULL/Wrong pointer. More...

#define	MCU_E_INIT_FAILED (0x11U)
	ERROR Description: Initialization of the MCU Driver Failed. More...

MCU Driver State Values
The MCU Driver State Values
#define	MCU_STATUS_UNINIT ((uint8)(0U))
	MCU driver Status uninitialized. More...

#define	MCU_STATUS_INIT ((uint8)(1U))
	MCU driver Status Initialized. More...

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

#define	MCU_SID_INIT_RAM_SECTION (0x01U)
	Mcu_InitRamSection() API Service ID. More...

#define	MCU_SID_INIT_CLOCK (0x02U)
	Mcu_InitClock() API Service ID. More...

#define	MCU_SID_DISTRIBUTE_PLL_CLOCK (0x03U)
	Mcu_DistributePllClock() API Service ID. More...

#define	MCU_SID_GET_PLL_STATUS (0x04U)
	Mcu_GetPllStatus() API Service ID. More...

#define	MCU_SID_GET_RESET_REASON (0x05U)
	Mcu_GetResetReason() API Service ID. More...

#define	MCU_SID_GET_RESET_RAW_VALUE (0x06U)
	Mcu_GetResetRawValue() API Service ID. More...

#define	MCU_SID_PERFORM_RESET (0x07U)
	Mcu_PerformReset() API Service ID. More...

#define	MCU_SID_SETMODE (0x08U)
	Mcu_SetMode() API Service ID. More...

#define	MCU_SID_GET_VERSION_INFO (0x09U)
	Mcu_GetVersionInfo() API Service ID. More...

#define	MCU_SID_GET_RAM_STATE (0x0AU)
	Mcu_GetRamState() API Service ID. More...

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

#define	MCU_PERFORM_RESET_MODE_WARM ((uint8) 1U)
	Initiate SW WARM RESET sequence. More...

Macro Definition Documentation

◆ ARRAYSIZE

#define ARRAYSIZE ( array )

Value:

((sizeof (array) / \

sizeof ((array)[0])))

◆ MCU_SW_MAJOR_VERSION

#define MCU_SW_MAJOR_VERSION (9U)

Driver Implementation Major Version.

◆ MCU_SW_MINOR_VERSION

#define MCU_SW_MINOR_VERSION (1U)

Driver Implementation Minor Version.

◆ MCU_SW_PATCH_VERSION

#define MCU_SW_PATCH_VERSION (1U)

Driver Implementation Patch Version.

◆ MCU_AR_RELEASE_MAJOR_VERSION

#define MCU_AR_RELEASE_MAJOR_VERSION (4U)

AUTOSAR Major version specification implemented by MCU Driver.

◆ MCU_AR_RELEASE_MINOR_VERSION

#define MCU_AR_RELEASE_MINOR_VERSION (3U)

AUTOSAR Minor version specification implemented by MCU Driver.

◆ MCU_AR_RELEASE_REVISION_VERSION

#define MCU_AR_RELEASE_REVISION_VERSION (1U)

AUTOSAR Patch version specification implemented by MCU Driver.

◆ MCU_VENDOR_ID

#define MCU_VENDOR_ID ((uint16) 44U)

Texas Instruments Vendor ID.

◆ MCU_MODULE_ID

#define MCU_MODULE_ID ((uint16) 101U)

MCU Driver Module ID.

◆ MCU_INSTANCE_ID

#define MCU_INSTANCE_ID ((uint8) 0U)

MCU Driver Instance ID.

◆ MCU_E_PARAM_CONFIG

#define MCU_E_PARAM_CONFIG (0x0AU)

ERROR Description: API service called with wrong configuration parameter.

◆ MCU_E_PARAM_CLOCK

#define MCU_E_PARAM_CLOCK (0x0BU)

ERROR Description: API service used with wrong clock value.

◆ MCU_E_PARAM_MODE

#define MCU_E_PARAM_MODE (0x0CU)

ERROR Description: API service used with wrong mode.

◆ MCU_E_PARAM_RAMSECTION

#define MCU_E_PARAM_RAMSECTION (0x0DU)

ERROR Description: API service called with invalid/wrong RAM section.

◆ MCU_E_PLL_NOT_LOCKED

#define MCU_E_PLL_NOT_LOCKED (0x0EU)

ERROR Description: API service is called while PLL is not locked.

◆ MCU_E_UNINIT

#define MCU_E_UNINIT (0x0FU)

ERROR Description: Mcu Driver API service is called before initialization of MCU Driver.

◆ MCU_E_PARAM_POINTER

#define MCU_E_PARAM_POINTER (0x10U)

ERROR Description: API service is called with NULL/Wrong pointer.

◆ MCU_E_INIT_FAILED

#define MCU_E_INIT_FAILED (0x11U)

ERROR Description: Initialization of the MCU Driver Failed.

◆ MCU_STATUS_UNINIT

#define MCU_STATUS_UNINIT ((uint8)(0U))

MCU driver Status uninitialized.

◆ MCU_STATUS_INIT

#define MCU_STATUS_INIT ((uint8)(1U))

MCU driver Status Initialized.

◆ MCU_SID_INIT

#define MCU_SID_INIT (0x00U)

Mcu_Init() API Service ID.

◆ MCU_SID_INIT_RAM_SECTION

#define MCU_SID_INIT_RAM_SECTION (0x01U)

Mcu_InitRamSection() API Service ID.

◆ MCU_SID_INIT_CLOCK

#define MCU_SID_INIT_CLOCK (0x02U)

Mcu_InitClock() API Service ID.

◆ MCU_SID_DISTRIBUTE_PLL_CLOCK

#define MCU_SID_DISTRIBUTE_PLL_CLOCK (0x03U)

Mcu_DistributePllClock() API Service ID.

◆ MCU_SID_GET_PLL_STATUS

#define MCU_SID_GET_PLL_STATUS (0x04U)

Mcu_GetPllStatus() API Service ID.

◆ MCU_SID_GET_RESET_REASON

#define MCU_SID_GET_RESET_REASON (0x05U)

Mcu_GetResetReason() API Service ID.

◆ MCU_SID_GET_RESET_RAW_VALUE

#define MCU_SID_GET_RESET_RAW_VALUE (0x06U)

Mcu_GetResetRawValue() API Service ID.

◆ MCU_SID_PERFORM_RESET

#define MCU_SID_PERFORM_RESET (0x07U)

Mcu_PerformReset() API Service ID.

◆ MCU_SID_SETMODE

#define MCU_SID_SETMODE (0x08U)

Mcu_SetMode() API Service ID.

◆ MCU_SID_GET_VERSION_INFO

#define MCU_SID_GET_VERSION_INFO (0x09U)

Mcu_GetVersionInfo() API Service ID.

◆ MCU_SID_GET_RAM_STATE

#define MCU_SID_GET_RAM_STATE (0x0AU)

Mcu_GetRamState() API Service ID.

◆ MCU_PERFORM_RESET_MODE_COLD

#define MCU_PERFORM_RESET_MODE_COLD ((uint8) 0U)

Initiate SW COLD RESET sequence.

◆ MCU_PERFORM_RESET_MODE_WARM

#define MCU_PERFORM_RESET_MODE_WARM ((uint8) 1U)

Initiate SW WARM RESET sequence.

◆ MCU_E_MODE_FAILURE

#define MCU_E_MODE_FAILURE 0U

Typedef Documentation

◆ Mcu_ClockType

typedef uint8 Mcu_ClockType

This type specifies the identification (ID) for a ClockType status used by Mcu_InitClock()

◆ Mcu_RawResetType

typedef uint32 Mcu_RawResetType

This type specifies the identification (ID) for a RAW MCU reset status returned by Mcu_GetResetRawValue()

◆ Mcu_RamSectionType

typedef uint8 Mcu_RamSectionType

This type specifies the identification (ID) for a RAM section used in Mcu_InitRamSection()

◆ Mcu_ModeType

typedef uint8 Mcu_ModeType

This type specifies the identification (ID) for a MCU mode used in Mcu_SetMode()

◆ Mcu_ClockConfigPtrType

typedef const Mcu_ClockConfigType* Mcu_ClockConfigPtrType

Pointer to Clock Config structure.

Variable Documentation

◆ McuModuleConfiguration_0

const struct Mcu_ConfigType_s McuModuleConfiguration_0

MCU Configuration struct declaration.