sciclient.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2020, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER OR
 * CONTRIBUTORS 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 SCICLIENT_H_
#define SCICLIENT_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

#include <stdint.h>
#include <stddef.h>

/* Windows Visual Studio build doesn't  __attribute__ indentifier, so forcing it be to dummy for getting build working */
#ifdef _MSC_VER
  #ifndef __attribute__
    #define __attribute__()
  #endif
#endif

/* TISCI Include */
#define TISCI_BIT(n)  (1UL << (n))

typedef uint8_t domgrp_t;

#ifndef SYSFW_DEVGRPS_H

typedef uint8_t devgrp_t;

/* External definitions */

#define DEVGRP_ALL              (0x00U)

#define DEVGRP_00               ((0x01U) << 0U)

#define DEVGRP_01               ((0x01U) << 1U)

#define DEVGRP_02               ((0x01U) << 2U)

#define DEVGRP_03               ((0x01U) << 3U)

#define DEVGRP_04               ((0x01U) << 4U)

#define DEVGRP_05               ((0x01U) << 5U)

#define DEVGRP_06               ((0x01U) << 6U)

#define DEVGRP_DMSC             ((0x01U) << 7U)

#define DEVGRP_DMSC_ALL         (0xFFU)

#endif

#if defined(SOC_J721E) || defined(SOC_J7200)
#define SCICLIENT_COMMON_X509_HEADER_ADDR (0x41cffb00)
#elif defined(SOC_J721S2) || defined(SOC_J784S4)
#define SCICLIENT_COMMON_X509_HEADER_ADDR (0x41cfdb00)
#else
#define SCICLIENT_COMMON_X509_HEADER_ADDR (0x41cffb00)
#endif

#define SCISERVER_COMMON_X509_HEADER_ADDR \
    SCICLIENT_COMMON_X509_HEADER_ADDR

#define MAX_NUM_DEVGRPS (8U)

#include <ti/drv/sciclient/soc/sysfw/include/tisci/tisci_protocol.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/tisci_boardcfg_macros.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/tisci_boardcfg.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/tisci_boardcfg_rm.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/tisci_core.h>
#if defined (SOC_AM65XX)
#include <ti/drv/sciclient/soc/sysfw/include/am65x/tisci_resasg_types.h>
#include <ti/drv/sciclient/soc/sysfw/include/am65x/tisci_hosts.h>
#include <ti/drv/sciclient/soc/sysfw/include/am65x/tisci_sec_proxy.h>
#include <ti/drv/sciclient/soc/sysfw/include/am65x/tisci_boardcfg_constraints.h>
#include <ti/drv/sciclient/soc/sysfw/include/am65x/tisci_clocks.h>
#include <ti/drv/sciclient/soc/sysfw/include/am65x_sr2/tisci_clocks.h>
#endif
#if defined (SOC_J721E)
#include <ti/drv/sciclient/soc/sysfw/include/j721e/tisci_resasg_types.h>
#include <ti/drv/sciclient/soc/sysfw/include/j721e/tisci_hosts.h>
#include <ti/drv/sciclient/soc/sysfw/include/j721e/tisci_sec_proxy.h>
#include <ti/drv/sciclient/soc/sysfw/include/j721e/tisci_boardcfg_constraints.h>
#endif
#if defined (SOC_J7200)
#include <ti/drv/sciclient/soc/sysfw/include/j7200/tisci_resasg_types.h>
#include <ti/drv/sciclient/soc/sysfw/include/j7200/tisci_hosts.h>
#include <ti/drv/sciclient/soc/sysfw/include/j7200/tisci_sec_proxy.h>
#include <ti/drv/sciclient/soc/sysfw/include/j7200/tisci_boardcfg_constraints.h>
#endif
#if defined (SOC_AM64X)
#include <ti/drv/sciclient/soc/sysfw/include/am64x/tisci_resasg_types.h>
#include <ti/drv/sciclient/soc/sysfw/include/am64x/tisci_hosts.h>
#include <ti/drv/sciclient/soc/sysfw/include/am64x/tisci_sec_proxy.h>
#include <ti/drv/sciclient/soc/sysfw/include/am64x/tisci_boardcfg_constraints.h>
#endif
#if defined (SOC_J721S2)
#include <ti/drv/sciclient/soc/sysfw/include/j721s2/tisci_resasg_types.h>
#include <ti/drv/sciclient/soc/sysfw/include/j721s2/tisci_hosts.h>
#include <ti/drv/sciclient/soc/sysfw/include/j721s2/tisci_sec_proxy.h>
#include <ti/drv/sciclient/soc/sysfw/include/j721s2/tisci_boardcfg_constraints.h>

/* Translate "DM2TIFS" to "DM2DMSC" related macros for existing sources */
#define TISCI_HOST_ID_DMSC2DM TISCI_HOST_ID_TIFS2DM

#define TISCI_SEC_PROXY_DM2DMSC_WRITE_NOTIFY_RESP_THREAD_ID \
    TISCI_SEC_PROXY_DM2TIFS_WRITE_NOTIFY_RESP_THREAD_ID
#define TISCI_SEC_PROXY_DM2DMSC_READ_RESPONSE_THREAD_ID \
    TISCI_SEC_PROXY_DM2TIFS_READ_RESPONSE_THREAD_ID
#endif
#if defined (SOC_J784S4)
#include <ti/drv/sciclient/soc/sysfw/include/j784s4/tisci_resasg_types.h>
#include <ti/drv/sciclient/soc/sysfw/include/j784s4/tisci_hosts.h>
#include <ti/drv/sciclient/soc/sysfw/include/j784s4/tisci_sec_proxy.h>
#include <ti/drv/sciclient/soc/sysfw/include/j784s4/tisci_boardcfg_constraints.h>

/* Translate "DM2TIFS" to "DM2DMSC" related macros for existing sources */
#define TISCI_HOST_ID_DMSC2DM TISCI_HOST_ID_TIFS2DM

#define TISCI_SEC_PROXY_DM2DMSC_WRITE_NOTIFY_RESP_THREAD_ID \
    TISCI_SEC_PROXY_DM2TIFS_WRITE_NOTIFY_RESP_THREAD_ID
#define TISCI_SEC_PROXY_DM2DMSC_READ_RESPONSE_THREAD_ID \
    TISCI_SEC_PROXY_DM2TIFS_READ_RESPONSE_THREAD_ID
#endif

#include <ti/drv/sciclient/soc/sysfw/include/tisci/security/tisci_sec_macros.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/security/tisci_dkek.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/security/tisci_ext_otp.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/security/tisci_firewall.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/security/tisci_keystore.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/security/tisci_procboot.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/security/tisci_sa2ul_rm.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/security/tisci_sec_handover.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/security/tisci_secure_jtag.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/security/tisci_soc_uid.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/security/tisci_keywriter.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/security/tisci_dkek.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/lpm/tisci_lpm.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/pm/tisci_pm_clock.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/pm/tisci_pm_device.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/pm/tisci_pm_core.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/rm/tisci_rm_ra.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/rm/tisci_rm_irq.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/rm/tisci_rm_udmap.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/rm/tisci_rm_psil.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/rm/tisci_rm_shared.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/rm/tisci_rm_core.h>
#include <ti/drv/sciclient/soc/sysfw/include/tisci/rm/tisci_rm_proxy.h>
#include <ti/drv/sciclient/soc/sciclient_soc_priv.h>
#include <ti/drv/sciclient/include/sciclient_soc.h>
#include <ti/drv/sciclient/include/sciclient_pm.h>
#include <ti/drv/sciclient/include/sciclient_rm.h>
#include <ti/drv/sciclient/include/sciclient_firewall.h>
#include <ti/drv/sciclient/include/sciclient_dkek.h>
#include <ti/drv/sciclient/include/sciclient_genericMsgs.h>
#include <ti/drv/sciclient/include/sciclient_procboot.h>
#include <ti/drv/sciclient/include/sciclient_boardcfg.h>
#include <ti/drv/sciclient/include/sciclient_keywriter.h>

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */

#define SCICLIENT_SERVICE_OPERATION_MODE_POLLED           (0U)
#define SCICLIENT_SERVICE_OPERATION_MODE_INTERRUPT        (1U)
/* @} */

#define SCICLIENT_SERVICE_WAIT_FOREVER                    (0xFFFFFFFFU)
#define SCICLIENT_SERVICE_NO_WAIT                         (0x0U)
/* @} */

#define SCICLIENT_FT_PASS (0xA5A5U)

#define SCICLIENT_FT_FAIL (0x5A5AU)


/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */

typedef struct
{
    uint32_t        opModeFlag;
    Sciclient_BoardCfgPrms_t * pBoardCfgPrms;
    uint32_t              isSecureMode;
    uint32_t              c66xRatRegion;
    uint8_t skipLocalBoardCfgProcess;
    Sciclient_BoardCfgPrms_t inPmPrms;
    Sciclient_BoardCfgPrms_t inRmPrms;
} Sciclient_ConfigPrms_t;

typedef struct
{
    uint16_t       messageType;
    uint32_t       flags;
    const uint8_t *pReqPayload;
    uint32_t       reqPayloadSize;
    uint32_t       timeout;
    uint8_t        forwardStatus;
} Sciclient_ReqPrm_t;

typedef struct
{
    uint32_t flags;
    uint8_t *pRespPayload;
    uint32_t respPayloadSize;
} Sciclient_RespPrm_t;

typedef struct
{
    const uint32_t     *boardCfgLow;
    const uint32_t     *boardCfgLowRm;
    const uint32_t     *boardCfgLowSec;
    const uint32_t     *boardCfgLowPm;
    uint32_t            boardCfgLowSize;
    uint32_t            boardCfgLowRmSize;
    uint32_t            boardCfgLowSecSize;
    uint32_t            boardCfgLowPmSize;
} Sciclient_DefaultBoardCfgInfo_t;

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

int32_t Sciclient_loadFirmware(const uint32_t *pSciclient_firmware);

 int32_t Sciclient_bootNotification(void);

int32_t Sciclient_init(const Sciclient_ConfigPrms_t *pCfgPrms);

int32_t Sciclient_service(const Sciclient_ReqPrm_t *pReqPrm,
                          Sciclient_RespPrm_t      *pRespPrm);

#ifdef QNX_OS

int32_t Sciclient_service_rsmgr(const Sciclient_ReqPrm_t *pReqPrm,
                          Sciclient_RespPrm_t      *pRespPrm);
#endif

int32_t Sciclient_deinit(void);

int32_t Sciclient_abiCheck(void);

int32_t Sciclient_getDefaultBoardCfgInfo(Sciclient_DefaultBoardCfgInfo_t *pBoardCfgInfo);

/*
 * Structure Init functions
 *
 * Requirement: DOX_REQ_TAG(PDK-2936)
 */
int32_t Sciclient_configPrmsInit(Sciclient_ConfigPrms_t *pCfgPrms);

void Sciclient_TisciMsgSetAckResp(struct tisci_header *hdr);

void Sciclient_TisciMsgSetNakResp(struct tisci_header *hdr);

int32_t Sciclient_boardCfgPrepHeader (
    uint8_t * pCommonHeader, uint8_t * pBoardCfgHeader,
    const Sciclient_BoardCfgPrms_t * pInPmPrms,
    const Sciclient_BoardCfgPrms_t * pInRmPrms);

int32_t Sciclient_boardCfgParseHeader (
    uint8_t * pCommonHeader,
    Sciclient_BoardCfgPrms_t * pInPmPrms,
    Sciclient_BoardCfgPrms_t * pInRmPrms);

int32_t Sciclient_prepareSleep(void);

int32_t Sciclient_enterSleep(void);

int32_t Sciclient_pmicShutdown(void);

/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */

#ifdef __cplusplus
}
#endif

#endif /* #ifndef SCICLIENT_H_ */

/* @} */

/* @} */