mcuxClSession_Types.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*/
/* Copyright 2020-2026 NXP                                                  */
/*                                                                          */
/* SPDX-License-Identifier: BSD-3-Clause                                    */
/*                                                                          */
/* Redistribution and use in source and binary forms, with or without       */
/* modification, are permitted provided that the following conditions are   */
/* met:                                                                     */
/*                                                                          */
/* 1. Redistributions of source code must retain the above copyright        */
/*    notice, this list of conditions and the following disclaimer.         */
/*                                                                          */
/* 2. 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.  */
/*                                                                          */
/* 3. Neither the name of the copyright holder 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       */
/* HOLDER 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 MCUXCLSESSION_TYPES_H_
#define MCUXCLSESSION_TYPES_H_
 
#include <mcuxClCore_Platform.h>
#include <mcuxClCore_FunctionIdentifiers.h>
#include <mcuxCsslFlowProtection.h>
 
#include <mcuxClRandom_Types.h>
#include <mcuxClResource_Types.h>
 
/**********************************************
 * CONSTANTS
 **********************************************/
 
#define MCUXCLSESSION_STATUS_OK                          ((mcuxClSession_Status_t) 0x0EEE2E03u)  
#define MCUXCLSESSION_STATUS_ERROR                       ((mcuxClSession_Status_t) 0x0EEE5330u)  
#define MCUXCLSESSION_STATUS_ERROR_MEMORY_ALLOCATION     ((mcuxClSession_Status_t) 0x0EEE534Fu)  
#define MCUXCLSESSION_STATUS_FAULT_ATTACK                ((mcuxClSession_Status_t) 0x0EEEF0F0u)  
 
#define MCUXCLSESSION_DMACHANNEL_INVALID  ((mcuxClSession_Channel_t) 0xFFFFu)    
 
 

/* mcuxClSession_Constants */
 
/**********************************************
 * TYPEDEFS
 **********************************************/

typedef uint32_t mcuxClSession_Status_t;

typedef MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClSession_Status_t) mcuxClSession_Status_Protected_t;

typedef struct mcuxClSession_WorkArea
{
  uint32_t * buffer;            
  uint32_t size;                
  uint32_t used;                
  uint32_t dirty;               
} mcuxClSession_WorkArea_t;

typedef uint32_t mcuxClSession_SecurityOptions_t;

struct mcuxClSession_Descriptor;  /* forward declaration */
typedef struct mcuxClSession_Descriptor mcuxClSession_Descriptor_t;

typedef mcuxClSession_Descriptor_t * const mcuxClSession_Handle_t;

typedef uint16_t mcuxClSession_Channel_t;

typedef struct
{
  mcuxClSession_Channel_t input;
  mcuxClSession_Channel_t output;
} mcuxClSession_Channels_t;

typedef void (*mcuxClSession_Callback_t)(uint32_t status, void * data);

MCUX_CSSL_FP_FUNCTION_POINTER(mcuxClSession_HwInterruptHandler_t,
  typedef MCUX_CSSL_FP_PROTECTED_TYPE(void) (*mcuxClSession_HwInterruptHandler_t)(mcuxClSession_Handle_t session)
);

typedef struct mcuxClSession_HwTable mcuxClSession_HwTable_t;

typedef struct
{
  mcuxClSession_Channels_t dmaChannels;
  mcuxClSession_Callback_t pUserCallback;
  void *pUserData;
  mcuxClSession_HwInterruptHandler_t pCallBackDMA;
  uint32_t                          protectionToken_pCallBackDMA;
  mcuxClSession_HwInterruptHandler_t pCallBackCopro;
  uint32_t                          protectionToken_pCallBackCopro;
  void *pClWorkarea; /* Used for non blocking flow to handover cl data to the interrupt */
} mcuxClSession_JobContext_t;

typedef struct mcuxClSession_apiCall mcuxClSession_apiCall_t;

struct mcuxClSession_Descriptor
{
  mcuxClSession_WorkArea_t cpuWa;    
  mcuxClSession_WorkArea_t pkcWa;    
  mcuxClRandom_Config_t randomCfg;   
  mcuxClResource_Context_t * pResourceCtx;  
  mcuxClSession_JobContext_t jobContext;    
  mcuxClSession_apiCall_t * apiCall;  
  uint32_t *pMathUptrt; 
};
 
 /* mcuxClSession_Types */
 
#endif /* MCUXCLSESSION_TYPES_H_ */