Mcu.h

Go to the documentation of this file.

/*
*
* Copyright (c) 2024 Texas Instruments Incorporated
*
* All rights reserved not granted herein.
*
* Limited License.
*
* Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
* license under copyrights and patents it now or hereafter owns or controls to make,
* have made, use, import, offer to sell and sell ("Utilize") this software subject to the
* terms herein.  With respect to the foregoing patent license, such license is granted
* solely to the extent that any such patent is necessary to Utilize the software alone.
* The patent license shall not apply to any combinations which include this software,
* other than combinations with devices manufactured by or for TI ("TI Devices").
* No hardware patent is licensed hereunder.
*
* Redistributions must preserve existing copyright notices and reproduce this license
* (including the above copyright notice and the disclaimer and (if applicable) source
* code license limitations below) in the documentation and/or other materials provided
* with the distribution
*
* Redistribution and use in binary form, without modification, are permitted provided
* that the following conditions are met:
*
* *       No reverse engineering, decompilation, or disassembly of this software is
* permitted with respect to any software provided in binary form.
*
* *       any redistribution and use are licensed by TI for use only with TI Devices.
*
* *       Nothing shall obligate TI to provide you with source code for the software
* licensed and provided to you in object code.
*
* If software source code is provided to you, modification and redistribution of the
* source code are permitted provided that the following conditions are met:
*
* *       any redistribution and use of the source code, including any resulting derivative
* works, are licensed by TI for use only with TI Devices.
*
* *       any redistribution and use of any object code compiled from the source code
* and any resulting derivative works, are licensed by TI for use only with TI Devices.
*
* Neither the name of Texas Instruments Incorporated nor the names of its suppliers
*
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* DISCLAIMER.
*
* THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
 
#ifndef MCU_H_
#define MCU_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include "Std_Types.h"
#include "Mcu_Cfg.h"
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define ARRAYSIZE(array)             ((sizeof (array) / \
                                         sizeof ((array)[0])))
 
 
#define MCU_SW_MAJOR_VERSION   (10U)
 
#define MCU_SW_MINOR_VERSION   (1U)
 
#define MCU_SW_PATCH_VERSION   (1U)
/* @} */
 
#define MCU_AR_RELEASE_MAJOR_VERSION    (4U)
 
#define MCU_AR_RELEASE_MINOR_VERSION    (3U)
 
#define MCU_AR_RELEASE_REVISION_VERSION (1U)
/* @} */
 
#define MCU_VENDOR_ID                   ((uint16) 44U)
 
#define MCU_MODULE_ID                   ((uint16) 101U)
 
#define MCU_INSTANCE_ID                 ((uint8) 0U)
/* @} */
 
 /*
  * Design: MCAL-8507,MCAL-8489
  */
 #ifndef MCU_E_PARAM_CONFIG
 
 #define MCU_E_PARAM_CONFIG         (0x0AU)
 #endif
 
 
 /*
  * Design: MCAL-8507
  */
 
#ifndef MCU_E_PARAM_CLOCK
 
#define MCU_E_PARAM_CLOCK           (0x0BU)
#endif
 
/*
 * Design: MCAL-8507
 */
#ifndef MCU_E_PARAM_MODE
 
#define MCU_E_PARAM_MODE            (0x0CU)
#endif
 
/*
 * Design: MCAL-8507
 */
#ifndef MCU_E_PARAM_RAMSECTION
 
#define MCU_E_PARAM_RAMSECTION      (0x0DU)
#endif
 
/*
 * Design: MCAL-8507
 */
#ifndef MCU_E_PLL_NOT_LOCKED
 
#define MCU_E_PLL_NOT_LOCKED        (0x0EU)
#endif
 
/*
 * Design: MCAL-8507
 */
#ifndef MCU_E_UNINIT
 
#define MCU_E_UNINIT                (0x0FU)
#endif
 
/*
 * Design: MCAL-8507
 */
#ifndef MCU_E_PARAM_POINTER
 
#define MCU_E_PARAM_POINTER         (0x10U)
#endif
 
/*
 * Design: MCAL-8507
 */
#ifndef MCU_E_INIT_FAILED
 
#define MCU_E_INIT_FAILED           (0x11U)
#endif
 
 /*
  * Design: MCAL-8507
  */
#define MCU_STATUS_UNINIT                   ((uint8)(0U))
 
#define MCU_STATUS_INIT                     ((uint8)(1U))
 
#define MCU_SID_INIT                 (0x00U)
 
#define MCU_SID_INIT_RAM_SECTION     (0x01U)
 
#define MCU_SID_INIT_CLOCK           (0x02U)
 
#define MCU_SID_DISTRIBUTE_PLL_CLOCK (0x03U)
 
#define MCU_SID_GET_PLL_STATUS       (0x04U)
 
#define MCU_SID_GET_RESET_REASON     (0x05U)
 
#define MCU_SID_GET_RESET_RAW_VALUE  (0x06U)
 
#define MCU_SID_PERFORM_RESET        (0x07U)
 
#define MCU_SID_SETMODE              (0x08U)
 
#define MCU_SID_GET_VERSION_INFO     (0x09U)
 
#define MCU_SID_GET_RAM_STATE        (0x0AU)
/* @} */
 
#if defined (SOC_J721E) || defined (SOC_J7200) || defined (SOC_J721S2) || defined (SOC_J784S4) || defined (SOC_J742S2)
 
#define MCU_PERFORM_RESET_MODE_COLD     ((uint8) 0U)
#endif
 
#define MCU_PERFORM_RESET_MODE_WARM     ((uint8) 1U)
/* @} */
#define MCU_E_MODE_FAILURE             0U
 
 
 
 
/*
 * Design: MCAL-8487,MCAL-8492
 */
typedef uint8 Mcu_ClockType;
 
/*
 * Design: MCAL-8491,MCAL-8471
 */
typedef uint32 Mcu_RawResetType;
 
/*
 * Design: MCAL-8406,MCAL-8421
 */
typedef uint8 Mcu_RamSectionType;
 
/*
 * Design: MCAL-8490,MCAL-8418
 */
typedef uint8 Mcu_ModeType;
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
/*
 * Design: MCAL-8438
 */
 typedef struct
 {
     Mcu_ClkModuleIdType    Mcu_ClockModuleId;
     Mcu_ClkSourceIdType    Mcu_ClockSourceId;
     Mcu_ModuleName       ModuleName;
     Mcu_DomainType       Domain;
     boolean                Mcu_InitCfg;
     uint64                 Mcu_ClockFrequency;
 } Mcu_ClockConfigType;
 
 
 
typedef P2CONST (Mcu_ClockConfigType, AUTOMATIC, MCU_PBCFG)
Mcu_ClockConfigPtrType;
 
/*
* Design: MCAL-8439,MCAL-8424,MCAL-8405,MCAL-8438,MCAL-8457
*/
 typedef struct Mcu_ConfigType_s
 {
     Mcu_ModeType             Mcu_Mode;
     uint8                    Mcu_ResetMode;
     Mcu_ClockConfigPtrType   Mcu_ClockConfig;
     uint8                    Mcu_NumberOfClockConfig;
       Mcu_CBKFunctionPtrType   Mcu_CBK_Function;
#if defined (SOC_J721E) || defined (SOC_J7200) || defined (SOC_J721S2) || defined (SOC_J784S4) || defined (SOC_J742S2)
 
       Mcu_SoftResetCBKFunctionPtrType   Mcu_SoftReset_CBK_Function;
#endif
 
 } Mcu_ConfigType;
 
 
extern const struct Mcu_ConfigType_s McuModuleConfiguration_0;
 
 
 
 
/* @} */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
FUNC(void, MCU_CODE) Mcu_Init(
    P2CONST(Mcu_ConfigType, AUTOMATIC, MCU_PBCFG) ConfigPtr);
 
 
#if (STD_ON == MCU_INIT_CLOCK_API)
 
FUNC(Std_ReturnType, MCU_CODE) Mcu_InitClock(Mcu_ClockType ClockSetting);
#endif /* MCU_INIT_CLOCK_API */
 
#if(STD_OFF == MCU_NO_PLL)
FUNC(Std_ReturnType, MCU_CODE) Mcu_DistributePllClock(void);
 
#endif /* STD_OFF == MCU_NO_PLL */
 
#if (STD_ON == MCU_PERFORM_RESET_API)
 
FUNC(void, MCU_CODE) Mcu_PerformReset(void);
 
#endif  /* MCU_PERFORM_RESET_API */
 
#if (STD_ON == MCU_INIT_RAM_API)
 
FUNC(Std_ReturnType, MCU_CODE) Mcu_InitRamSection(
    Mcu_RamSectionType RamSection);
#endif /* MCU_INIT_RAM_API */
 
 
/* Design: MCAL-8391 */
 
/*    This is a Dummy API     */
 
FUNC(Mcu_PllStatusType, MCU_CODE) Mcu_GetPllStatus(void);
 
FUNC(Mcu_ResetType, MCU_CODE) Mcu_GetResetReason(void);
 
FUNC(Mcu_RawResetType, MCU_CODE) Mcu_GetResetRawValue(void);
 
#if defined (SOC_J721E) || defined (SOC_J7200) || defined (SOC_J721S2) || defined (SOC_J784S4) || defined (SOC_J742S2)
 
FUNC(void, MCU_CODE) Mcu_ClearResetReason(void);
#endif
 
#if (STD_ON == MCU_GET_RAM_STATE_API)
 
/*    This is a Dummy API
*/
FUNC(Mcu_RamStateType, MCU_CODE) Mcu_GetRamState(void);
#endif  /* MCU_GET_RAM_STATE_API */
 
#if (STD_ON == MCU_GET_VERSION_INFO_API)
 
FUNC(void, MCU_CODE) Mcu_GetVersionInfo(
    P2VAR(Std_VersionInfoType, AUTOMATIC, MCU_APPL_DATA) versioninfo);
#endif  /* MCU_GET_VERSION_INFO_API */
 
 
 
 FUNC(void, MCU_CODE) Mcu_SetMode(Mcu_ModeType McuMode);
 
 
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef MCU_H_ */
 
/* @} */