PDK API Guide for J721E
sciclient.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2020, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
151 /* @} */
152 
211 #ifndef SCICLIENT_H_
212 #define SCICLIENT_H_
213 
214 /* ========================================================================== */
215 /* Include Files */
216 /* ========================================================================== */
217 
218 #include <stdint.h>
219 #include <stddef.h>
220 
221 /* Windows Visual Studio build doesn't __attribute__ indentifier, so forcing it be to dummy for getting build working */
222 #ifdef _MSC_VER
223  #ifndef __attribute__
224  #define __attribute__()
225  #endif
226 #endif
227 
228 /* TISCI Include */
229 #define TISCI_BIT(n) (1UL << (n))
230 
235 typedef uint8_t domgrp_t;
236 
237 #ifndef SYSFW_DEVGRPS_H
238 
242 typedef uint8_t devgrp_t;
243 
244 /* External definitions */
245 
250 #define DEVGRP_ALL (0x00U)
251 
253 #define DEVGRP_00 ((0x01U) << 0U)
254 
255 #define DEVGRP_01 ((0x01U) << 1U)
256 
257 #define DEVGRP_02 ((0x01U) << 2U)
258 
259 #define DEVGRP_03 ((0x01U) << 3U)
260 
261 #define DEVGRP_04 ((0x01U) << 4U)
262 
263 #define DEVGRP_05 ((0x01U) << 5U)
264 
265 #define DEVGRP_06 ((0x01U) << 6U)
266 
270 #define DEVGRP_DMSC ((0x01U) << 7U)
271 
272 #define DEVGRP_DMSC_ALL (0xFFU)
273 
274 #endif
275 
277 #if defined(SOC_J721E) || defined(SOC_J7200)
278 #define SCICLIENT_COMMON_X509_HEADER_ADDR (0x41cffb00)
279 #elif defined(SOC_J721S2)
280 #define SCICLIENT_COMMON_X509_HEADER_ADDR (0x41cfdb00)
281 #else
282 #define SCICLIENT_COMMON_X509_HEADER_ADDR (0x41cffb00)
283 #endif
284 
285 #define SCISERVER_COMMON_X509_HEADER_ADDR \
286  SCICLIENT_COMMON_X509_HEADER_ADDR
287 
292 #define MAX_NUM_DEVGRPS (8U)
293 
299 #if defined (SOC_AM65XX)
300 #include <ti/drv/sciclient/soc/sysfw/include/am65x/tisci_resasg_types.h>
301 #include <ti/drv/sciclient/soc/sysfw/include/am65x/tisci_hosts.h>
302 #include <ti/drv/sciclient/soc/sysfw/include/am65x/tisci_sec_proxy.h>
303 #include <ti/drv/sciclient/soc/sysfw/include/am65x/tisci_boardcfg_constraints.h>
304 #include <ti/drv/sciclient/soc/sysfw/include/am65x/tisci_clocks.h>
305 #include <ti/drv/sciclient/soc/sysfw/include/am65x_sr2/tisci_clocks.h>
306 #endif
307 #if defined (SOC_J721E)
308 #include <ti/drv/sciclient/soc/sysfw/include/j721e/tisci_resasg_types.h>
309 #include <ti/drv/sciclient/soc/sysfw/include/j721e/tisci_hosts.h>
310 #include <ti/drv/sciclient/soc/sysfw/include/j721e/tisci_sec_proxy.h>
311 #include <ti/drv/sciclient/soc/sysfw/include/j721e/tisci_boardcfg_constraints.h>
312 #endif
313 #if defined (SOC_J7200)
314 #include <ti/drv/sciclient/soc/sysfw/include/j7200/tisci_resasg_types.h>
315 #include <ti/drv/sciclient/soc/sysfw/include/j7200/tisci_hosts.h>
316 #include <ti/drv/sciclient/soc/sysfw/include/j7200/tisci_sec_proxy.h>
317 #include <ti/drv/sciclient/soc/sysfw/include/j7200/tisci_boardcfg_constraints.h>
318 #endif
319 #if defined (SOC_AM64X)
320 #include <ti/drv/sciclient/soc/sysfw/include/am64x/tisci_resasg_types.h>
321 #include <ti/drv/sciclient/soc/sysfw/include/am64x/tisci_hosts.h>
322 #include <ti/drv/sciclient/soc/sysfw/include/am64x/tisci_sec_proxy.h>
323 #include <ti/drv/sciclient/soc/sysfw/include/am64x/tisci_boardcfg_constraints.h>
324 #endif
325 #if defined (SOC_J721S2)
326 #include <ti/drv/sciclient/soc/sysfw/include/j721s2/tisci_resasg_types.h>
327 #include <ti/drv/sciclient/soc/sysfw/include/j721s2/tisci_hosts.h>
328 #include <ti/drv/sciclient/soc/sysfw/include/j721s2/tisci_sec_proxy.h>
329 #include <ti/drv/sciclient/soc/sysfw/include/j721s2/tisci_boardcfg_constraints.h>
330 
331 /* Translate "DM2TIFS" to "DM2DMSC" related macros for existing sources */
332 #define TISCI_HOST_ID_DMSC2DM TISCI_HOST_ID_TIFS2DM
333 
334 #define TISCI_SEC_PROXY_DM2DMSC_WRITE_NOTIFY_RESP_THREAD_ID \
335  TISCI_SEC_PROXY_DM2TIFS_WRITE_NOTIFY_RESP_THREAD_ID
336 #define TISCI_SEC_PROXY_DM2DMSC_READ_RESPONSE_THREAD_ID \
337  TISCI_SEC_PROXY_DM2TIFS_READ_RESPONSE_THREAD_ID
338 #endif
339 
362 #include <ti/drv/sciclient/soc/sciclient_soc_priv.h>
372 
373 #ifdef __cplusplus
374 extern "C" {
375 #endif
376 
377 /* ========================================================================== */
378 /* Macros & Typedefs */
379 /* ========================================================================== */
380 
393 #define SCICLIENT_SERVICE_OPERATION_MODE_POLLED (0U)
394 #define SCICLIENT_SERVICE_OPERATION_MODE_INTERRUPT (1U)
395 /* @} */
396 
406 #define SCICLIENT_SERVICE_WAIT_FOREVER (0xFFFFFFFFU)
407 #define SCICLIENT_SERVICE_NO_WAIT (0x0U)
408 /* @} */
409 
411 #define SCICLIENT_FT_PASS (0xA5A5U)
412 
413 #define SCICLIENT_FT_FAIL (0x5A5AU)
414 
415 
416 /* ========================================================================== */
417 /* Structure Declarations */
418 /* ========================================================================== */
419 
424 typedef struct
425 {
426  uint32_t opModeFlag;
434  uint32_t isSecureMode;
438  uint32_t c66xRatRegion;
448 
452 typedef struct
453 {
454  uint16_t messageType;
456  uint32_t flags;
460  const uint8_t *pReqPayload;
462  uint32_t reqPayloadSize;
464  uint32_t timeout;
467  uint8_t forwardStatus;
472 
476 typedef struct
477 {
478  uint32_t flags;
480  uint8_t *pRespPayload;
486  uint32_t respPayloadSize;
489 
493 typedef struct
494 {
495  const uint32_t *boardCfgLow;
497  const uint32_t *boardCfgLowRm;
499  const uint32_t *boardCfgLowSec;
501  const uint32_t *boardCfgLowPm;
503  uint32_t boardCfgLowSize;
512 
513 /* ========================================================================== */
514 /* Function Declarations */
515 /* ========================================================================== */
516 
528 int32_t Sciclient_loadFirmware(const uint32_t *pSciclient_firmware);
529 
550 int32_t Sciclient_init(const Sciclient_ConfigPrms_t *pCfgPrms);
551 
585 int32_t Sciclient_service(const Sciclient_ReqPrm_t *pReqPrm,
586  Sciclient_RespPrm_t *pRespPrm);
587 
588 #ifdef QNX_OS
589 
622 int32_t Sciclient_service_rsmgr(const Sciclient_ReqPrm_t *pReqPrm,
623  Sciclient_RespPrm_t *pRespPrm);
624 #endif
625 
638 int32_t Sciclient_deinit(void);
639 
645 int32_t Sciclient_abiCheck(void);
646 
653 
654 /*
655  * Structure Init functions
656  *
657  * Requirement: DOX_REQ_TAG(PDK-2936)
658  */
666 
675 
684 
704  uint8_t * pCommonHeader, uint8_t * pBoardCfgHeader,
705  const Sciclient_BoardCfgPrms_t * pInPmPrms,
706  const Sciclient_BoardCfgPrms_t * pInRmPrms);
707 
720  uint8_t * pCommonHeader,
721  Sciclient_BoardCfgPrms_t * pInPmPrms,
722  Sciclient_BoardCfgPrms_t * pInRmPrms);
723 
724 /* ========================================================================== */
725 /* Static Function Definitions */
726 /* ========================================================================== */
727 
728 #ifdef __cplusplus
729 }
730 #endif
731 
732 #endif /* #ifndef SCICLIENT_H_ */
733 
734 /* @} */
735 
771 /* @} */
772 
uint32_t boardCfgLowSize
Definition: sciclient.h:503
int32_t Sciclient_init(const Sciclient_ConfigPrms_t *pCfgPrms)
This API is called once for registering interrupts and creating semaphore handles to be able to talk ...
int32_t Sciclient_getDefaultBoardCfgInfo(Sciclient_DefaultBoardCfgInfo_t *pBoardCfgInfo)
API to get the default board config info.
This file contains the definition of all the shim layer functions which request DMSC for generic serv...
This file contains the definition of all the message IDs, message formats to be able to interact with...
Input parameters for Sciclient_service function.
Definition: sciclient.h:493
struct tisci_header hdr
Definition: tisci_core.h:438
int32_t Sciclient_boardCfgPrepHeader(uint8_t *pCommonHeader, uint8_t *pBoardCfgHeader, const Sciclient_BoardCfgPrms_t *pInPmPrms, const Sciclient_BoardCfgPrms_t *pInRmPrms)
Prepare the header for the board configuration. This API is typically only used by SBL where it will ...
Output parameters for Sciclient_service function.
Definition: sciclient.h:476
This file contains the definition of all the message IDs, message formats to be able to interact with...
const uint8_t * pReqPayload
Definition: sciclient.h:460
const uint32_t * boardCfgLowSec
Definition: sciclient.h:499
int32_t Sciclient_abiCheck(void)
void Sciclient_TisciMsgSetAckResp(struct tisci_header *hdr)
Send the Response in Ack. Used only with Sciserver or Sciclient Direct.
const uint32_t * boardCfgLowPm
Definition: sciclient.h:501
uint32_t timeout
Definition: sciclient.h:464
SCICLIENT Low Level Driver SOC specific file.
This file contains the definition of all the message IDs, message formats to be able to interact with...
uint8_t domgrp_t
Defines the sysfw DOMGRP type. This is meant to be used in code or data structures that require disti...
Definition: sciclient.h:235
uint8_t devgrp_t
Defines the sysfw DEVGRP type. This is meant to be used in code or data structures that require disti...
Definition: sciclient.h:242
uint32_t opModeFlag
Definition: sciclient.h:426
Sciclient_BoardCfgPrms_t inRmPrms
Definition: sciclient.h:445
uint32_t flags
Definition: sciclient.h:478
int32_t Sciclient_deinit(void)
De-initialization of sciclient. This de-initialization is specific to the application....
This file contains the definition of all the message IDs, message formats to be able to interact with...
uint8_t * pRespPayload
Definition: sciclient.h:480
uint16_t messageType
Definition: sciclient.h:454
uint32_t reqPayloadSize
Definition: sciclient.h:462
void Sciclient_TisciMsgSetNakResp(struct tisci_header *hdr)
Send the Response in NAK. Used only with Sciserver or Sciclient Direct.
Wrapper function to send the board configuration message to DMSC.
uint32_t c66xRatRegion
Definition: sciclient.h:438
uint32_t boardCfgLowRmSize
Definition: sciclient.h:505
uint32_t isSecureMode
Definition: sciclient.h:434
This file contains the definition of all the message IDs, message formats to be able to interact with...
int32_t Sciclient_boardCfgParseHeader(uint8_t *pCommonHeader, Sciclient_BoardCfgPrms_t *pInPmPrms, Sciclient_BoardCfgPrms_t *pInRmPrms)
Parse the header left behind by the SBL in the SCISERVER. This is used in the SCISERVER App to read t...
const uint32_t * boardCfgLow
Definition: sciclient.h:495
uint8_t skipLocalBoardCfgProcess
Definition: sciclient.h:440
uint8_t forwardStatus
Definition: sciclient.h:467
Initialization parameters for sciclient. Pointer to this is passed to Sciclient_init.
Definition: sciclient.h:424
int32_t Sciclient_service(const Sciclient_ReqPrm_t *pReqPrm, Sciclient_RespPrm_t *pRespPrm)
This API allows communicating with the System firmware which can be called to perform various functio...
Sciclient_BoardCfgPrms_t inPmPrms
Definition: sciclient.h:443
Parameters for Sciclient_boardCfg Pointer to this is passed to Sciclient_boardCfg.
Definition: sciclient_boardcfg.h:58
uint32_t boardCfgLowSecSize
Definition: sciclient.h:507
uint32_t respPayloadSize
Definition: sciclient.h:486
This file contains the definition of all the message IDs, message formats to be able to interact with...
const uint32_t * boardCfgLowRm
Definition: sciclient.h:497
uint32_t flags
Definition: sciclient.h:456
uint32_t boardCfgLowPmSize
Definition: sciclient.h:509
Sciclient_BoardCfgPrms_t * pBoardCfgPrms
Definition: sciclient.h:430
int32_t Sciclient_loadFirmware(const uint32_t *pSciclient_firmware)
Loads the DMSC firmware. This is typically called by SBL. Load firmware does not require calling the ...
Input parameters for Sciclient_service function.
Definition: sciclient.h:452
Header that prefixes all TISCI messages.
Definition: tisci_protocol.h:89
int32_t Sciclient_configPrmsInit(Sciclient_ConfigPrms_t *pCfgPrms)
Sciclient_ConfigPrms_t structure init function.