du_mcc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022, NVIDIA Corporation. All Rights Reserved.
 *
 * NVIDIA Corporation and its licensors retain all intellectual property and
 * proprietary rights in and to this software and related documentation. Any
 * use, reproduction, disclosure or distribution of this software and related
 * documentation without an express license agreement from NVIDIA Corporation
 * is strictly prohibited.
 */
#ifndef __DU_MCC_H__
#define __DU_MCC_H__
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
 
/*==================[macros]==================================================*/
 
#define DU_MCC_E_OK                        0x55U
 
#define DU_MCC_E_DATA_OOR                  0xF2U
 
#define DU_MCC_E_INVALID_IF_ID             0xF3U
 
#define DU_MCC_E_INVALID_UPDATE_FW         0xF4U
 
#define DU_MCC_E_COND_NOT_MET              0xF5U
 
#define DU_MCC_E_SIZE_ERR                  0xF6U
 
#define DU_MCC_E_WR_FLASH_LOCK_ERR         0xF7U
 
#define DU_MCC_E_WR_FLASH_BUSY_ERR         0xF8U
 
#define DU_MCC_E_WR_FLASH_ERR              0xF9U
 
#define DU_MCC_E_ERASE_FLASH_LOCK_ERR      0xFAU
 
#define DU_MCC_E_ERASE_FLASH_ERR           0xFBU
 
#define DU_MCC_E_SEQ_ERR                   0xFCU
 
#define DU_MCC_E_CHKSUM_ERR                0xFDU
 
#define DU_MCC_E_INVALID_DATA_ERR          0xFEU
 
#define DU_MCC_E_BLKID_INVALID_ERR         0xFFU
 
#define DU_MCC_E_TIMEOUT                   0x0FU
 
#define DU_MCC_E_INVALID_PARAMS            0x0EU
 
#define DU_MCC_E_NOT_SUPPORTED              0x0DU
 
#define DU_MCC_E_COMM_ERR                  0x0CU
 
#define DU_MCC_E_INCOMPATIBLE_MCU          0x0BU
 
#define DU_MCC_E_INCOMPATIBLE_BOARD        0x0AU
 
#define DU_MCC_E_NOK                       0x09U
 
 
typedef uint8_t         U8;
typedef uint16_t        U16;
typedef uint32_t        U32;
 
 
extern const U32 DU_MCC_version;
 
typedef U8 DU_MCC_Ret_Type;
 
typedef enum  {
    DU_MCC_TEGRA_X1,
    DU_MCC_TEGRA_X2,
    DU_MCC_TEGRA_INVALID_ID
} DU_MCC_Tegra_Device_ID;
 
typedef enum  {
    DU_MCC_BootChain_A,
    DU_MCC_BootChain_B,
    DU_MCC_BootChain_C,
    DU_MCC_BootChain_D,
    DU_MCC_BootChain_INVALID_ID
} DU_MCC_BootChain_ID;
 
//==================================================================================================
// The following section defines the DU MCC library interface. The DU will then call DU_MCC_Init() 
// and then good to call all other APIs to start communicating with the MCU
//
// ...Sample code flow from DU...
// [DU]
//  /* check the du_mcc_version */
//  ASSERT(DU_MCC_LIB_VERSION == DU_MCC_version)
//
//  /* Initialize the MCC lib */
//  void* libHandle = DU_MCC_Init(0, NULL);
//
//  /* Start communicating with MCU and process requests */
//  DU_MCC_SetDefaultBootChain(libHandle, ...);
//
//  /* De init */
//  DU_MCC_DeInit(libHandle);
//==================================================================================================
 
void* DU_MCC_Init(int argc, char *argv[]);
 
DU_MCC_Ret_Type DU_MCC_DeInit(void* handle);
 
DU_MCC_Ret_Type DU_MCC_TegraReboot(
   void* handle,
   DU_MCC_Tegra_Device_ID Tegra_id,
   U8 timeout);
 
DU_MCC_Ret_Type DU_MCC_SystemReset(
    void* handle,
    U8 timeDelay);
 
 
/**********************************************************************/
/* Interface APIs for GPIO based Boot-chain selection for Tegra x1/x2 */
/**********************************************************************/
 
DU_MCC_Ret_Type DU_MCC_SetNextBootChain(
    void* handle,
    DU_MCC_Tegra_Device_ID Tegra_id,
    DU_MCC_BootChain_ID Boot_id);
 
 
DU_MCC_Ret_Type DU_MCC_SetDefaultBootChain(
    void* handle,
    DU_MCC_Tegra_Device_ID Tegra_id,
    DU_MCC_BootChain_ID Boot_id);
 
/**********************************************************************/
/* Interface APIs for getting Boot-chain information for Tegra x1/x2  */
/**********************************************************************/
 
DU_MCC_Ret_Type DU_MCC_GetDefaultBootChain(
    void* handle,
    DU_MCC_Tegra_Device_ID Tegra_id,
    U8 *DefaultBootChain);
 
DU_MCC_Ret_Type DU_MCC_GetActiveBootChain(
    void* handle,
    DU_MCC_Tegra_Device_ID Tegra_id,
    U8 *ActiveBootChain);
 
#ifdef __cplusplus
}
#endif
 
#endif // __DU_MCC_H__