scp/scmi/v0/scmi.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2025 Texas Instruments Incorporated
 *
 *  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 SCMI_H
#define SCMI_H
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <stddef.h>
#include <kernel/dpl/SemaphoreP.h>
#include <drivers/scp/scmi/v0/scmi_protocol.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
#define SCMI_MAX_POSSIBLE_PARENTS             (16U)
 
typedef void* SCMI_Handle;
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint8_t *buf;
    uint32_t size;
} SCMI_SharedMemory;
 
typedef struct
{
    uint8_t id;
    uint8_t protocol_id;
    uint8_t type;
    uint16_t seq;
    /* The token to identify the message. When a message returns, the
     * platform returns the whole message header unmodified including the
     * token.
     */
    uint32_t status;
} SCMI_messageHeader;
 
typedef struct
{
    SCMI_messageHeader  header;
    uint8_t             *inputMessage;
    uint32_t            inputMessageSize;
    uint8_t             *outputMessage;
    uint32_t            outputMessageSize;
} SCMI_MessageData;
 
typedef struct
{
    uint32_t version;
    uint32_t numAgents;
    uint32_t numProtocols;
    uint32_t implementationVersion;
    uint8_t protocols[SCMI_BASE_MAX_NUM_PROTOCOLS];
    uint8_t vendor[SCMI_BASE_NAME_LENGTH_MAX];
    uint8_t subVendor[SCMI_BASE_NAME_LENGTH_MAX];
} SCMI_AgentDataInfo;
 
typedef struct
{
    uint32_t version;
    uint32_t numPowerDomains;
    uint32_t statsLen;
    uint64_t statsAddr;
} SCMI_PowerDomainProtocol;
 
typedef struct
{
    uint32_t version;
    uint32_t numClocks;
} SCMI_ClockProtocol;
 
typedef struct
{
    uint32_t                requiredProtoCount;
    uint8_t                 *requiredProtoList;
    void                    *transferObject;
    SCMI_SharedMemory       *sharedMem;
    SemaphoreP_Object       lockSem;
} SCMI_Object;
 
typedef struct SCMI_Config_s
{
    uint32_t                    isOpen;
    SCMI_Object                 *object;
    SCMI_AgentDataInfo          agentInfo;
    SCMI_PowerDomainProtocol    powerDomainProto;
    SCMI_ClockProtocol          clockProto;
} SCMI_Config;
 
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void SCMI_init(void);
 
void SCMI_deinit(void);
 
SCMI_Handle SCMI_open(uint32_t instanceIndex);
 
void SCMI_close(SCMI_Handle handle);
 
SCMI_Handle SCMI_getHandle(uint32_t driverInstanceIndex);
 
int32_t SCMI_getSCMIProtocolErrorMapped(int32_t errorCode);
 
void SCMI_getProtocolVersionLog(uint32_t instanceIndex);
 
uint32_t SCMI_getInitDriverIndex(void);
 
/* ========================================================================== */
/*                          Internal Declarations                             */
/* ========================================================================== */
static inline void SCMI_initSCMIMessageData(SCMI_MessageData *msg);
 
/* ========================================================================== */
/*                          Internal Definitions                              */
/* ========================================================================== */
static inline void SCMI_initSCMIMessageData(SCMI_MessageData *msg)
{
    msg->header.id = 0xFFU;
    msg->header.protocol_id = 0xFFU;
    msg->header.seq = 0xFFU;
    msg->header.status = 0xFFU;
    msg->header.type = 0xFFU;
    msg->inputMessage = NULL;
    msg->inputMessageSize = 0U;
    msg->outputMessage = NULL;
    msg->outputMessageSize = 0U;
}
 
#endif