scp/psci/v0/psci.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 PSCI_H_
#define PSCI_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stddef.h>
#include <kernel/dpl/SemaphoreP.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
/* PSCI function interface */
#define PSCI_BASE_FUNC              (uint32_t) 0x84000000U
#define PSCI_FUNC(n)                (PSCI_BASE_FUNC + (n))
#define PSCI_FUNC_OFF_64BIT         (uint32_t) 0x40000000U
#define PSCI_BASE_FUNC_64BIT            \
                    (PSCI_BASE_FUNC + PSCI_FUNC_OFF_64BIT)
#define PSCI_FUNC_64BIT(n)          (PSCI_BASE_FUNC_64BIT + (n))
 
#define PSCI_FUNC_PSCI_VERSION      PSCI_FUNC(0)
#define PSCI_FUNC_CPU_OFF           PSCI_FUNC(2)
#define PSCI_FUNC_SYSTEM_RESET      PSCI_FUNC(9)
#define PSCI_FUNC_CPU_ON_64BIT      PSCI_FUNC_64BIT(3)
#define PSCI_FUNC_PSCI_FEATURES     PSCI_FUNC(10)
 
/* Decode PSCI versions into Major and Minor Versions */
#define PSCI_MAJOR_VERSION_SHIFT        (16U)
#define PSCI_MINOR_VERSION_MASK         \
        ((1U << PSCI_MAJOR_VERSION_SHIFT) - 1)
#define PSCI_MAJOR_VERSION_MASK         ~PSCI_MINOR_VERSION_MASK
#define PSCI_MAJOR_VERSION(ver)         \
        (((ver) & PSCI_MAJOR_VERSION_MASK) >> PSCI_MAJOR_VERSION_SHIFT)
#define PSCI_MINOR_VERSION(ver)         \
        ((ver) & PSCI_MINOR_VERSION_MASK)
 
/* PSCI return values */
#define PSCI_SUCCESS                (0)
#define PSCI_NOT_SUPPORTED          (-1)
#define PSCI_INVALID_PARAMS         (-2)
#define PSCI_DENIED                 (-3)
#define PSCI_ALREADY_ON             (-4)
#define PSCI_ON_PENDING             (-5)
#define PSCI_INTERNAL_FAILURE       (-6)
#define PSCI_NOT_PRESENT            (-7)
#define PSCI_DISABLED               (-8)
#define PSCI_INVALID_ADDRESS        (-9)
 
/* ========================================================================== */
/*                          Structure Declarations                            */
/* ========================================================================== */
 
typedef struct PSCI_Config_s     *PSCI_Handle;
 
typedef struct  PSCI_Object_s
{
    SemaphoreP_Object           mutex;
    bool                        isOpen;
 
}  PSCI_Object;
 
typedef struct  PSCI_Config_s
{
    PSCI_Object                      *object;
 
}  PSCI_Config;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void PSCI_init(void);
 
void PSCI_deinit(void);
 
PSCI_Handle PSCI_open(uint32_t idx);
 
void PSCI_close(PSCI_Handle handle);
 
PSCI_Handle PSCI_getHandle(uint32_t driverInstanceIndex);
 
uint32_t PSCI_getInitDriverIndex(void);
 
int32_t PSCI_getPSCIVersion(PSCI_Handle handle, uint32_t *psciVer);
 
int32_t PSCI_cpuOff(PSCI_Handle handle);
 
int32_t PSCI_cpuOn(PSCI_Handle handle, uint32_t cpuId, uint32_t entryPoint);
 
int32_t PSCI_systemReset(PSCI_Handle handle);
 
int32_t PSCI_getFeatures(PSCI_Handle handle, uint32_t functionId, uint32_t *feature);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef PSCI_H_ */