sciclient.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2024, 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>
#include <kernel/dpl/SystemP.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
/* 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
 
#define MAX_NUM_DEVGRPS (8U)
 
#include <drivers/hw_include/cslr_soc.h>
#include <drivers/sciclient/include/tisci/tisci_protocol.h>
#include <drivers/sciclient/include/tisci/tisci_boardcfg_macros.h>
#include <drivers/sciclient/include/tisci/tisci_boardcfg.h>
#include <drivers/sciclient/include/tisci/tisci_boardcfg_rm.h>
#include <drivers/sciclient/include/tisci/tisci_core.h>
#if defined (SOC_AM64X) || defined (SOC_AM243X)
#include <drivers/sciclient/include/tisci/am64x_am243x/tisci_resasg_types.h>
#include <drivers/sciclient/include/tisci/am64x_am243x/tisci_hosts.h>
#include <drivers/sciclient/include/tisci/am64x_am243x/tisci_sec_proxy.h>
#include <drivers/sciclient/include/tisci/am64x_am243x/tisci_boardcfg_constraints.h>
#include <drivers/sciclient/include/tisci/am64x_am243x/tisci_devices.h>
#include <drivers/sciclient/include/tisci/am64x_am243x/tisci_clocks.h>
#include <drivers/sciclient/include/tisci/am64x_am243x/tisci_hosts.h>
#include <drivers/sciclient/include/am64x_am243x/sciclient_fmwMsgParams.h>
#endif
#if defined (SOC_AM62X)
#include <drivers/sciclient/include/tisci/am62x/tisci_resasg_types.h>
#include <drivers/sciclient/include/tisci/am62x/tisci_hosts.h>
#include <drivers/sciclient/include/tisci/am62x/tisci_sec_proxy.h>
#include <drivers/sciclient/include/tisci/am62x/tisci_boardcfg_constraints.h>
#include <drivers/sciclient/include/tisci/am62x/tisci_devices.h>
#include <drivers/sciclient/include/tisci/am62x/tisci_clocks.h>
#include <drivers/sciclient/include/tisci/am62x/tisci_hosts.h>
#include <drivers/sciclient/include/am62x/sciclient_fmwMsgParams.h>
#endif
#if defined (SOC_AM62AX)
#include <drivers/sciclient/include/tisci/am62ax/tisci_resasg_types.h>
#include <drivers/sciclient/include/tisci/am62ax/tisci_hosts.h>
#include <drivers/sciclient/include/tisci/am62ax/tisci_sec_proxy.h>
#include <drivers/sciclient/include/tisci/am62ax/tisci_boardcfg_constraints.h>
#include <drivers/sciclient/include/tisci/am62ax/tisci_devices.h>
#include <drivers/sciclient/include/tisci/am62ax/tisci_clocks.h>
#include <drivers/sciclient/include/tisci/am62ax/tisci_hosts.h>
#include <drivers/sciclient/include/am62ax/sciclient_fmwMsgParams.h>
#endif
#if defined (SOC_AM62DX)
#include <drivers/sciclient/include/tisci/am62dx/tisci_resasg_types.h>
#include <drivers/sciclient/include/tisci/am62dx/tisci_hosts.h>
#include <drivers/sciclient/include/tisci/am62dx/tisci_sec_proxy.h>
#include <drivers/sciclient/include/tisci/am62dx/tisci_boardcfg_constraints.h>
#include <drivers/sciclient/include/tisci/am62dx/tisci_devices.h>
#include <drivers/sciclient/include/tisci/am62dx/tisci_clocks.h>
#include <drivers/sciclient/include/tisci/am62dx/tisci_hosts.h>
#include <drivers/sciclient/include/am62dx/sciclient_fmwMsgParams.h>
#endif
#if defined (SOC_AM62PX)
#include <drivers/sciclient/include/tisci/am62px/tisci_resasg_types.h>
#include <drivers/sciclient/include/tisci/am62px/tisci_hosts.h>
#include <drivers/sciclient/include/tisci/am62px/tisci_sec_proxy.h>
#include <drivers/sciclient/include/tisci/am62px/tisci_boardcfg_constraints.h>
#include <drivers/sciclient/include/tisci/am62px/tisci_devices.h>
#include <drivers/sciclient/include/tisci/am62px/tisci_clocks.h>
#include <drivers/sciclient/include/tisci/am62px/tisci_hosts.h>
#include <drivers/sciclient/include/am62px/sciclient_fmwMsgParams.h>
#endif
#include <drivers/sciclient/include/tisci/security/tisci_sec_macros.h>
#include <drivers/sciclient/include/tisci/security/tisci_firewall.h>
#include <drivers/sciclient/include/tisci/security/tisci_procboot.h>
#include <drivers/sciclient/include/tisci/security/tisci_keystore.h>
#include <drivers/sciclient/include/tisci/security/tisci_dkek.h>
#include <drivers/sciclient/include/tisci/security/tisci_keywriter.h>
#include <drivers/sciclient/include/tisci/lpm/tisci_lpm.h>
#include <drivers/sciclient/include/tisci/pm/tisci_pm_clock.h>
#include <drivers/sciclient/include/tisci/pm/tisci_pm_device.h>
#include <drivers/sciclient/include/tisci/pm/tisci_pm_core.h>
#include <drivers/sciclient/include/tisci/rm/tisci_rm_ra.h>
#include <drivers/sciclient/include/tisci/rm/tisci_rm_irq.h>
#include <drivers/sciclient/include/tisci/rm/tisci_rm_udmap.h>
#include <drivers/sciclient/include/tisci/rm/tisci_rm_psil.h>
#include <drivers/sciclient/include/tisci/rm/tisci_rm_shared.h>
#include <drivers/sciclient/include/tisci/rm/tisci_rm_core.h>
#include <drivers/sciclient/include/tisci/rm/tisci_rm_proxy.h>
#include <drivers/sciclient/include/tisci/security/tisci_sec_handover.h>
#include <drivers/sciclient/include/tisci/security/tisci_secure_jtag.h>
#include <drivers/sciclient/include/tisci/security/tisci_soc_uid.h>
#include <drivers/sciclient/include/sciclient_lpm.h>
#include <drivers/sciclient/include/sciclient_pm.h>
#include <drivers/sciclient/include/sciclient_rm.h>
#include <drivers/sciclient/include/sciclient_firewall.h>
#include <drivers/sciclient/include/sciclient_dkek.h>
#include <drivers/sciclient/include/sciclient_procboot.h>
#include <drivers/sciclient/include/sciclient_boardcfg.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint16_t       messageType;
    uint32_t       flags;
    const uint8_t *pReqPayload;
    uint32_t       reqPayloadSize;
    uint32_t       timeout;
} Sciclient_ReqPrm_t;
 
typedef struct
{
    uint32_t flags;
    uint8_t *pRespPayload;
    uint32_t respPayloadSize;
} Sciclient_RespPrm_t;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t Sciclient_loadFirmware(const uint32_t *pSciclient_firmware);
 
int32_t Sciclient_init(uint32_t coreId);
 
int32_t Sciclient_service(const Sciclient_ReqPrm_t *pReqPrm,
                          Sciclient_RespPrm_t      *pRespPrm);
 
int32_t Sciclient_deinit(void);
 
int32_t Sciclient_abiCheck(void);
 
int32_t Sciclient_triggerSecHandover(void);
 
int32_t Sciclient_getVersionCheck(uint32_t doLog);
 
uint32_t Sciclient_getSelfDevIdCore(void);
 
int32_t Sciclient_waitForBootNotification(void);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef SCICLIENT_H_ */