Device AM62x fall under the K3 SoC family and has a concept of centralized Power, Resource and Security management to allow mitigating the challenges of the traditional approach to system control. System Firmware (hereafter referred to as SYSFW) is the collective name for the TI foundational security(TIFS) and device management firmware (DM firmware) which offers these centralized services. In this concept a processing unit (for example an M4F) can request the DM firmware to control power, grant resources or provide secure services. This is done via a special messaging channel called a secure proxy. The messages are sent obeying a proprietary protocol called TISCI (TI System Controller Interface) protocol. For more information on TISCI protocol you can refer to the TISCI Public Documentation.

Sciclient as a software block has multiple functional sub-blocks inside it, as shown in the below image:

Sciclient Sub-blocks

More details on the APIs provided on these layers can be found in the API section, linked towards the end of this page.

Generally speaking, the Sciclient driver provides API to communicate with the SYSFW using the TISCI protocol. As mentioned above, this would be for system level tasks like resource allocation, peripheral power on/off, peripheral clock setting, secure services and so on. The sciclient will be part of the application code running on each core.

Typical Sciclient Operation

The above image shows the operation for only one core, but the same thing happens for all the cores. SYSFW deals with all the requests coming from each of the cores.

Sciclient is mostly used by other drivers, like DMA, GPIO etc. Sciclient acts as an interface to the SYSFW for these drivers when they need say a resource like DMA channel, or configure an interrupt route. Below are the high level features supported by the driver:

Features Supported

Abstracted APIs for Power and Resource Management
APIs for Processor Boot including secure boot
APIs for configuring firewalls
Ability to change and re-build the board configuration data
Ability to sign the board configuration blobs for HS devices

SysConfig Features

Note: It is strongly recommend to use SysConfig where it is available instead of using direct SW API calls. This will help simplify the SW application and also catch common mistakes early in the development cycle.

There are no user programmable features for Sciclient SysConfig. However, adding any module makes the PowerClock_init() initialize the module power and clock. This is indirectly done using Sciclient APIs.

Features NOT Supported

NA

Important Usage Guidelines

Sciclient is mostly used by other peripheral drivers, and mostly not directly by an application. From an application point of view, major usage of Sciclient APIs would be to power on/off a module, set/get the clock of a module, etc.

Board Configuration Overview

SYSFW Board Config files in the sciclient driver is a SOC specific configuration data regarding the various system attributes controlled by the SYSFW. These include resources, power and clock, security etc. This configuration is sent to SYSFW during boot time. The default configuration is stored in source/drivers/sciclient/sciclient_defaultBoardCfg/am62dx/

Default Boardcfg - sciclient_defaultBoardcfg.c
Resource Management BoardCfg - sciclient_defaultBoardCfg_rm.c
Power Management BoardCfg - sciclient_defaultBoardCfg_pm.c
Security BoardCfg - sciclient_defaultBoardCfg_security.c

The user can change the board configuration data based on their requirement and rebuild the board configuration by following the steps in SYSFW Board Config Generation.

Refer SYSFW board config documentation

Enforcing Processor Access Control List

The Access Control List(ACL) for a processor can be set using the Security Boardcfg data. There can be one primary host and three secondary hosts that can control a processor.
For example, set the WKUP-R5 core as primary host and A53 core as secondary host for ACL of MCU-R5 processor in the source/drivers/sciclient/sciclient_defaultBoardCfg/am62dx/sciclient_defaultBoardCfg_security.c file.

.proc_acl_entries = {
    {
        .processor_id = SCICLIENT_PROC_ID_MCU_R5FSS0_CORE0,
        .proc_access_master = TISCI_HOST_ID_MAIN_0_R5_0,
        .proc_access_secondary = {TISCI_HOST_ID_A53_0, TISCI_HOST_ID_TIFS, TISCI_HOST_ID_TIFS},
    },
    /* set the remaining entries to zero */
    {
        0,
    },
    .
    .
    .
    {
        0,
    },
},

Then rebuild the board config blobs using the steps in SYSFW Board Config Generation.
Check on SYSFW documentation for more info.

Example Usage

Include the below file to access the APIs

#include <stdio.h>

#include <drivers/sciclient.h>

Module Power ON Example

    int32_t  status = SystemP_SUCCESS;
    uint32_t moduleId = TISCI_DEV_TIMER0;
    uint32_t moduleState, resetState, contextLossState;
 
    /* Check the module status. Need not do power on if it's already ON */
    status = Sciclient_pmGetModuleState(moduleId,
                                        &moduleState,
                                        &resetState,
                                        &contextLossState,
                                        SystemP_WAIT_FOREVER);
    DebugP_assert(SystemP_SUCCESS == status);
    if(moduleState == TISCI_MSG_VALUE_DEVICE_HW_STATE_OFF)
    {
        status = Sciclient_pmSetModuleState(moduleId,
                                            TISCI_MSG_VALUE_DEVICE_SW_STATE_ON,
                                            (TISCI_MSG_FLAG_AOP |
                                             TISCI_MSG_FLAG_DEVICE_EXCLUSIVE |
                                             TISCI_MSG_FLAG_DEVICE_RESET_ISO),
                                             SystemP_WAIT_FOREVER);
        DebugP_assert(status == SystemP_SUCCESS);
 
        status = Sciclient_pmSetModuleRst (moduleId,
                                               0x0U,
                                               SystemP_WAIT_FOREVER);
        DebugP_assert(status == SystemP_SUCCESS);
    }

Interrupt configuration Example

Since interrupt router outputs are shared resources, we need Sciclient to configure interrupt routers for certain peripherals like GPIO. Here is a snippet explaining this with an example of configuring a GPIO interrupt. For more details on the ideas used below, refer AM62Ax TRM Chapter 9 on interrupts.

    struct tisci_msg_rm_irq_set_req     rmIrqReq;
    struct tisci_msg_rm_irq_set_resp    rmIrqResp;
 
    /* Here we specify the core specific interrupt router number which we want to tie to the GPIO peripheral interrupt.
     * In this example we are considering the MAIN GPIO instance, which 54 interrupt router outputs, out of which first 16
     * are routed to all the R5 cores. Since these are shared resources, we will need to decide before hand which outputs will
     * be used by which core, and specify this in the sciclient_defaultBoardCfg_rm.c file. In the current configuration,
     * outputs 8 and 9 are allocated to R50-0 core, we can choose either of these to configure the interrupt configuration
     */
    uint32_t gpioIntrNumber = CSLR_R5FSS0_CORE0_INTR_MAIN_GPIOMUX_INTROUTER0_OUTP_8;
 
    /* Among the GPIOMUX_INTRRTR0 input pins, 0:86 comes from GPIO0 and 90:177 from GPIO1. We are configuring GPIO1 pin in this example, so
     * we define a base interrupt number to be used later.
     */
    uint32_t gpioIntrRtrInputGpio1_Base = 90;
 
    /* The user interrupt button SW5 is tied to interrupt num 54 among the 88 GPIO interrupt lines of GPIO1 instance */
    uint32_t gpioPushButtonPinNum = 54;
 
    /* For setting the IRQ for GPIO using sciclient APIs, we need to populate
     * a structure, tisci_msg_rm_irq_set_req instantiated above. The definition
     * of this struct and details regarding the struct members can be found in
     * the tisci_rm_irq.h.
     */
    /* Initialize all flags to zero since we'll be setting only a few */
    rmIrqReq.valid_params           = 0U;
    /* Our request has a destination id, so enable the flag for DST ID */
    rmIrqReq.valid_params          |= TISCI_MSG_VALUE_RM_DST_ID_VALID;
    /* DST HOST IRQ is the output index of the interrupt router. We need to make sure this is also enabled as a valid param */
    rmIrqReq.valid_params          |= TISCI_MSG_VALUE_RM_DST_HOST_IRQ_VALID;
    /* This is not a global event */
    rmIrqReq.global_event           = 0U;
    /* Our interrupt source would be the GPIO peripheral. The source id has to be a device id recognizable by the SYSFW.
     * The list of device IDs can be found in tisci_devices.h file under source/drivers/sciclient/include/tisci/am64x_am243x/.
     * In GPIO case there are 3 possible options - TISCI_DEV_GPIO0, TISCI_DEV_GPIO1, TISCI_DEV_MCU_GPIO0. For input interrupt,
     * we need to choose the TISCI_DEV_GPIO1
     */
    rmIrqReq.src_id                 = TISCI_DEV_GPIO1;
    /* This is the interrupt source index within the GPIO peripheral */
    rmIrqReq.src_index              = gpioIntrRtrInputGpio1_Base + GPIO_GET_BANK_INDEX(gpioPushButtonPinNum);
    /* This is the destination of the interrupt, usually a CPU core. Here we choose the TISCI device ID for R5F0-0 core.
     * For a different core, the corresponding TISCI device id has to be provided */
    rmIrqReq.dst_id                 = TISCI_DEV_R5FSS0_CORE0;
    /* This is the output index of the interrupt router. This depends on the core and board configuration */
    rmIrqReq.dst_host_irq           = gpioIntrNumber;
    /* Rest of the struct members are unused for GPIO interrupt */
    rmIrqReq.ia_id                  = 0U;
    rmIrqReq.vint                   = 0U;
    rmIrqReq.vint_status_bit_index  = 0U;
    rmIrqReq.secondary_host         = TISCI_MSG_VALUE_RM_UNUSED_SECONDARY_HOST;
 
    /* To set the interrupt we now invoke the Sciclient_rmIrqSet function which
     * will find out the route to configure the interrupt and request SYSFW to
     * grant the resource
     */
    if(0 != Sciclient_rmIrqSet(&rmIrqReq, &rmIrqResp, SystemP_WAIT_FOREVER))
    {
        DebugP_log("[Error] Sciclient event config failed!!!\r\n");
        DebugP_assert(FALSE);
    }

Configuring the Flag Field in TISCI Messages

To receive a response message, TISCI_MSG_FLAG_AOP is used in the flag field of the outgoing message. But, if a response is not needed, then the flag field can be set to 0 instead. That being said, setting the flag field to 0 means no response will be returned, even if the message fails.

When sending TISCI messages, it is recommended to avoid directly writing to the generic header in the payload (request.hdr.flags). Instead, we use the Sciclient_service API and pass the field value to the Sciclient request parameter (reqParam.flags).

To utilize the Sciclient_service API, the following components must be defined:

TISCI Request - Define an empty TISCI request structure for the TISCI message type and specify the various required fields in it. We can leave the fields of tisci_header structure as empty.
TISCI Response - Define an empty TISCI response structure for the TISCI message type.
Request Parameters - Define the structure of the Sciclient request message, and specify the following fields in it -
- Message Type - Specify the type of message being transmitted.
- Flags - Determine the custom flag options, selecting either TISCI_MSG_FLAG_AOP for messages requiring a response or 0 for messages that do not require a response.
- Request Payload - Pass the TISCI Request structure.
- Request Payload Size - Pass the size of the TISCI Request structure.
- Timeout - Specify the timeout value for the message.
Response Parameters - Define the expected structure of the Sciclient response message, and specify the following fields in it -
- Response Payload - Pass the TISCI Response structure.
- Response Payload Size - Pass the size of the TISCI Response structure.

The Sciclient_service call will then copy the message type and the flag value specified in the Sciclient request structure (reqParam.flags) into the TISCI Generic Messaging Header (request.hdr.flags) of the TISCI Request message. This enables users to send messages with AOP or empty flag settings without directly manipulating the TISCI Generic Header.

To learn more about the TISCI Generic Messaging Header, refer to the TISCI Generic Messaging Header documentation. And for more information on supported message types and required parameters, refer to the APIs for SCI Client or SYSFW documentation.

Example -

int32_t retVal = SystemP_SUCCESS;
struct tisci_msg_get_device_req request = {0};
struct tisci_msg_get_device_resp response = {0};
Sciclient_ReqPrm_t reqParam = {0};
 
Sciclient_RespPrm_t respParam = {0};
 
request.id = (uint32_t) TISCI_DEV_A53SS0;
 
reqParam.messageType    = (uint16_t) TISCI_MSG_GET_DEVICE;
reqParam.flags          = (uint32_t) 0;    /* We can set this value to either 0 or `TISCI_MSG_FLAG_AOP` */
reqParam.pReqPayload    = (const uint8_t *) &request;
reqParam.reqPayloadSize = (uint32_t) sizeof (request);
reqParam.timeout        = (uint32_t) timeout;
 
respParam.flags           = (uint32_t) 0;    /* Populated by the API when `TISCI_MSG_FLAG_AOP` flag is set in the request */
respParam.pRespPayload    = (uint8_t *) &response;
respParam.respPayloadSize = (uint32_t) sizeof (response);
 
retVal = Sciclient_service(&reqParam, &respParam);
if(retVal != SystemP_SUCCESS)
{
    retVal = SystemP_FAILURE;
}

Note: Setting the flags value to 0 in the request parameter structure using the Sciclient_service API may cause the message to fail.

API

APIs for SCI Client or SYSFW

Table of Contents