sciserver.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020, 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 SCISERVER_H_
#define SCISERVER_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#include <ti/csl/csl_types.h>
#include <ti/drv/sciclient/sciclient.h>


/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */

#define SCISERVER_CTRL_CMD_HALT         (0xA5)

#define SCISERVER_CTRL_CMD_RUN          (0x5A)

#define SCISERVER_PROCESS_STATE_WAIT    (0x5A)

#define SCISERVER_PROCESS_STATE_RUN     (0xA5U)

#define SCISERVER_FORWARD_MSG           (0x5AU)

#define SCISERVER_NO_FORWARD_MSG        (0xA5U)

#define SCISERVER_INIT_DONE             (0x69U)

#define SCISERVER_INIT_NOT_DONE         (0x96U)

#define SCISERVER_HW_QUEUE_SIZE (52U)

#define SCISERVER_HWI_NUM (5U)

#define SCISERVER_SECPROXY_INSTANCE_COUNT (0x2U)

typedef uint32_t Sciserver_SemaphoreIds;
#define SCISERVER_SEMAPHORE_USER_HI   (uint32_t)0

#define SCISERVER_SEMAPHORE_USER_LO   (uint32_t)1

#define SCISERVER_SEMAPHORE_USER_DM   (uint32_t)2

#define SCISERVER_SEMAPHORE_MAX_CNT   (uint32_t)3

/* @} */

typedef uint32_t Sciserver_TaskIds;
#define SCISERVER_TASK_USER_HI    (uint32_t)0

#define SCISERVER_TASK_USER_LO    (uint32_t)1

#define SCISERVER_TASK_MAX_CNT    (uint32_t)2

/* @} */

/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */

typedef struct {
    void *ptr;
} Sciserver_CfgPrms_t;

typedef struct {
    uint8_t     host;
    int32_t     hwi_id;
    bool        is_pending;
} Sciserver_msgData;

typedef enum
{
    SCISERVER_TASK_PENDING = 0,
    SCISERVER_TASK_PROCESSING_USER_MSG = 1,
    SCISERVER_TASK_PROCESSING_SECURE_MSG = 2,
} Sciserver_taskStateState;

typedef struct {
    Sciserver_taskStateState    state;
    uint8_t                     current_buffer_idx;
    uint8_t                     current_forwarded_buffer_idx;
} Sciserver_taskState;

typedef struct {
    const uint32_t              irq_num;
    uint32_t *const             hw_msg_buffer;
    const uint16_t              hw_msg_queue_id;
    const uint32_t              semaphore_id;
    Sciserver_msgData *const    user_msg_data;
} Sciserver_hwiData;

typedef struct {
    const int32_t               task_id;
    uint32_t *const             *hw_msg_buffer_list;
    const uint8_t               hw_msg_buffer_count;
    const uint32_t              hw_msg_buffer_sz;
    const uint32_t              semaphore_id;
    Sciserver_taskState *const  state;
    Sciserver_msgData *const    *user_msg_data;
    const int32_t               priority;
    uint8_t *const              stack;
} Sciserver_taskData;

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

char * Sciserver_getVersionStr(void);

char * Sciserver_getRmPmHalVersionStr(void);

int32_t Sciserver_init(Sciserver_CfgPrms_t *pPrms);

int32_t Sciserver_deinit(void);

void Sciserver_setCtrlState (uint8_t state);

uint8_t Sciserver_getCtrlState (void);

void Sciserver_setProcessState (uint8_t state);

uint8_t Sciserver_getProcessState (void);

int32_t Sciserver_interruptHandler(Sciserver_hwiData *uhd, bool* soft_error);

int32_t Sciserver_processtask(Sciserver_taskData *utd);

int32_t Sciserver_initPrms_Init(Sciserver_CfgPrms_t *pPrms);

void Sciserver_socInit (void);

/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
/* None */

#endif /* #ifndef SCISERVER_H_ */

/* @} */