path: root/peripheral/keystore/chaabi/libcc54/include/dx_driver_abi.h

/*******************************************************************
* (c) Copyright 2011-2012 Discretix Technologies Ltd.              *
* This file is licensed under the terms provided in the file       *
* libcc54/LICENSE in this directory or a parent directory          *
********************************************************************/

#ifndef __SEP_DRIVER_ABI_H__
#define __SEP_DRIVER_ABI_H__

#ifdef __KERNEL__
#include <linux/types.h>
#ifndef INT32_MAX
#define INT32_MAX 0x7FFFFFFFL
#endif
#else
/* For inclusion in user space library */
#include <stdint.h>
#endif

#include <linux/ioctl.h>
#include <linux/errno.h>
#include "sep_rpc.h"

/* Proprietary error code for unexpected internal errors */
#define EBUG 999

/****************************/
/**** IOCTL return codes ****/
/*****************************************************************************
 ENOTTY  : Unknown IOCTL command					     *
 ENOSYS  : Unsupported/not-implemented (known) operation		     *
 EINVAL  : Invalid parameters                                                *
 EFAULT  : Bad pointers for given user memory space                          *
 EPERM   : Not enough permissions for given command                          *
 ENOMEM,EAGAIN: when not enough resources available for given op.            *
 EIO     : SeP HW error or another internal error (probably operation timed  *
	   out or unexpected behavior)                                       *
 EBUG    : Driver bug found ("assertion") - see system log                   *
*****************************************************************************/

/****** IOCTL commands ********/
/* The magic number appears free in Documentation/ioctl/ioctl-number.txt */
#define DXDI_IOC_MAGIC 0xD1

/* IOCTL ordinal numbers */
/*(for backward compatibility, add new ones only at end of list!) */
enum dxdi_ioc_nr {
	/* Version info. commands */
	DXDI_IOC_NR_GET_VER_MAJOR             = 0,
	DXDI_IOC_NR_GET_VER_MINOR             = 1,
	/* Context size queries */
	DXDI_IOC_NR_GET_SYMCIPHER_CTX_SIZE    = 2,
	DXDI_IOC_NR_GET_AUTH_ENC_CTX_SIZE     = 3,
	DXDI_IOC_NR_GET_MAC_CTX_SIZE          = 4,
	DXDI_IOC_NR_GET_HASH_CTX_SIZE         = 5,
	/* Init context commands */
	DXDI_IOC_NR_SYMCIPHER_INIT            = 7,
	DXDI_IOC_NR_AUTH_ENC_INIT             = 8,
	DXDI_IOC_NR_MAC_INIT                  = 9,
	DXDI_IOC_NR_HASH_INIT                 = 10,
	/* Processing commands */
	DXDI_IOC_NR_PROC_DBLK                 = 12,
	DXDI_IOC_NR_FIN_PROC                  = 13,
	/* "Integrated" processing operations */
	DXDI_IOC_NR_SYMCIPHER_PROC            = 14,
	DXDI_IOC_NR_AUTH_ENC_PROC             = 15,
	DXDI_IOC_NR_MAC_PROC                  = 16,
	DXDI_IOC_NR_HASH_PROC                 = 17,
	/* SeP RPC */
	DXDI_IOC_NR_SEP_RPC                   = 19,
	/* Memory registration */
	DXDI_IOC_NR_REGISTER_MEM4DMA          = 20,
	DXDI_IOC_NR_ALLOC_MEM4DMA             = 21,
	DXDI_IOC_NR_FREE_MEM4DMA              = 22,
	/* SeP Applets API */
	DXDI_IOC_NR_SEPAPP_SESSION_OPEN       = 23,
	DXDI_IOC_NR_SEPAPP_SESSION_CLOSE      = 24,
	DXDI_IOC_NR_SEPAPP_COMMAND_INVOKE     = 25,
	/* Combined mode */
	DXDI_IOC_NR_COMBINED_INIT             = 26,
	DXDI_IOC_NR_COMBINED_PROC_DBLK        = 27,
	DXDI_IOC_NR_COMBINED_PROC_FIN         = 28,
	DXDI_IOC_NR_COMBINED_PROC             = 29,

	/* AES IV set/get API */
	DXDI_IOC_NR_SET_IV                    = 30,
	DXDI_IOC_NR_GET_IV                    = 31,
	DXDI_IOC_NR_MAX = DXDI_IOC_NR_GET_IV
};

/* In case error is not DXDI_RET_ESEP these are the
*  errors embedded in the error info field "error_info" */
enum dxdi_error_info {
	DXDI_ERROR_NULL = 0,
	DXDI_ERROR_BAD_CTX = 1,
	DXDI_ERROR_UNSUP = 2,
	DXDI_ERROR_INVAL_MODE = 3,
	DXDI_ERROR_INVAL_DIRECTION = 4,
	DXDI_ERROR_INVAL_KEY_SIZE = 5,
	DXDI_ERROR_INVAL_NONCE_SIZE = 6,
	DXDI_ERROR_INVAL_TAG_SIZE = 7,
	DXDI_ERROR_INVAL_DIN_PTR = 8,
	DXDI_ERROR_INVAL_DOUT_PTR = 9,
	DXDI_ERROR_INVAL_DATA_SIZE = 10,
	DXDI_ERROR_DIN_DOUT_OVERLAP = 11,
	DXDI_ERROR_INTERNAL = 12,
	DXDI_ERROR_NO_RESOURCE = 13,
	DXDI_ERROR_FATAL = 14,
	DXDI_ERROR_INFO_RESERVE32B = INT32_MAX
};

/* ABI Version info. */
#define DXDI_VER_MAJOR 1
#define DXDI_VER_MINOR DXDI_IOC_NR_MAX

/******************************/
/* IOCTL commands definitions */
/******************************/
/* Version info. commands */
#define DXDI_IOC_GET_VER_MAJOR _IOR(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_GET_VER_MAJOR, uint32_t)
#define DXDI_IOC_GET_VER_MINOR _IOR(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_GET_VER_MINOR, uint32_t)
/* Context size queries */
#define DXDI_IOC_GET_SYMCIPHER_CTX_SIZE _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_GET_SYMCIPHER_CTX_SIZE,\
		struct dxdi_get_sym_cipher_ctx_size_params)
#define DXDI_IOC_GET_AUTH_ENC_CTX_SIZE _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_GET_AUTH_ENC_CTX_SIZE,\
		struct dxdi_get_auth_enc_ctx_size_params)
#define DXDI_IOC_GET_MAC_CTX_SIZE _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_GET_MAC_CTX_SIZE,\
		struct dxdi_get_mac_ctx_size_params)
#define DXDI_IOC_GET_HASH_CTX_SIZE _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_GET_HASH_CTX_SIZE,\
		struct dxdi_get_hash_ctx_size_params)
/* Init. Sym. Crypto. */
#define DXDI_IOC_SYMCIPHER_INIT _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_SYMCIPHER_INIT, struct dxdi_sym_cipher_init_params)
#define DXDI_IOC_AUTH_ENC_INIT _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_AUTH_ENC_INIT, struct dxdi_auth_enc_init_params)
#define DXDI_IOC_MAC_INIT _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_MAC_INIT, struct dxdi_mac_init_params)
#define DXDI_IOC_HASH_INIT _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_HASH_INIT, struct dxdi_hash_init_params)

/* Sym. Crypto. Processing commands */
#define DXDI_IOC_PROC_DBLK _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_PROC_DBLK, struct dxdi_process_dblk_params)
#define DXDI_IOC_FIN_PROC _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_FIN_PROC, struct dxdi_fin_process_params)

/* Integrated Sym. Crypto. */
#define DXDI_IOC_SYMCIPHER_PROC _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_SYMCIPHER_PROC, struct dxdi_sym_cipher_proc_params)
#define DXDI_IOC_AUTH_ENC_PROC _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_AUTH_ENC_PROC, struct dxdi_auth_enc_proc_params)
#define DXDI_IOC_MAC_PROC _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_MAC_PROC, struct dxdi_mac_proc_params)
#define DXDI_IOC_HASH_PROC _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_HASH_PROC, struct dxdi_hash_proc_params)

/* AES Initial Vector set/get */
#define DXDI_IOC_SET_IV _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_SET_IV, struct dxdi_aes_iv_params)
#define DXDI_IOC_GET_IV _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_GET_IV, struct dxdi_aes_iv_params)

/* Combined mode  */
#define DXDI_IOC_COMBINED_INIT _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_COMBINED_INIT,\
		struct dxdi_combined_init_params)
#define DXDI_IOC_COMBINED_PROC_DBLK _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_COMBINED_PROC_DBLK,\
		struct dxdi_combined_proc_dblk_params)
#define DXDI_IOC_COMBINED_PROC_FIN _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_COMBINED_PROC_FIN,\
		struct dxdi_combined_proc_params)
#define DXDI_IOC_COMBINED_PROC _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_COMBINED_PROC,\
		struct dxdi_combined_proc_params)

/* SeP RPC */
#define DXDI_IOC_SEP_RPC _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_SEP_RPC, struct dxdi_sep_rpc_params)
/* Memory registration */
#define DXDI_IOC_REGISTER_MEM4DMA _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_REGISTER_MEM4DMA, \
		struct dxdi_register_mem4dma_params)
#define DXDI_IOC_ALLOC_MEM4DMA _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_ALLOC_MEM4DMA, \
		struct dxdi_alloc_mem4dma_params)
#define DXDI_IOC_FREE_MEM4DMA _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_FREE_MEM4DMA, \
		struct dxdi_free_mem4dma_params)
/* SeP Applets API */
#define DXDI_IOC_SEPAPP_SESSION_OPEN _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_SEPAPP_SESSION_OPEN, \
		struct dxdi_sepapp_session_open_params)
#define DXDI_IOC_SEPAPP_SESSION_CLOSE _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_SEPAPP_SESSION_CLOSE, \
		struct dxdi_sepapp_session_close_params)
#define DXDI_IOC_SEPAPP_COMMAND_INVOKE _IORW(DXDI_IOC_MAGIC,\
		DXDI_IOC_NR_SEPAPP_COMMAND_INVOKE, \
		struct dxdi_sepapp_command_invoke_params)


/*** ABI constants ***/
/* Max. symmetric crypto key size (512b) */
#define DXDI_SYM_KEY_SIZE_MAX 64 /*octets*/
/* Max. MAC key size (applicable to HMAC-SHA512) */
#define DXDI_MAC_KEY_SIZE_MAX 128 /*octets*/
/* AES IV/Counter size (128b) */
#define DXDI_AES_BLOCK_SIZE 16 /*octets*/
/* DES IV size (64b) */
#define DXDI_DES_BLOCK_SIZE 8 /*octets*/
/* Max. Nonce size */
#define DXDI_NONCE_SIZE_MAX 16 /*octets*/
/* Max. digest size */
#define DXDI_DIGEST_SIZE_MAX 64 /*octets*/
/* Max. nodes */
#define DXDI_COMBINED_NODES_MAX 4
#define DXDI_AES_IV_SIZE DXDI_AES_BLOCK_SIZE

/*** ABI data types ***/

enum dxdi_cipher_direction {
	DXDI_CDIR_ENC = 0,
	DXDI_CDIR_DEC = 1,
	DXDI_CDIR_MAX = DXDI_CDIR_DEC,
	DXDI_CDIR_RESERVE32B = INT32_MAX
};

enum dxdi_sym_cipher_type {
	DXDI_SYMCIPHER_NONE = 0,
	_DXDI_SYMCIPHER_AES_FIRST = 1,
	DXDI_SYMCIPHER_AES_XXX  = _DXDI_SYMCIPHER_AES_FIRST,
	DXDI_SYMCIPHER_AES_ECB  = _DXDI_SYMCIPHER_AES_FIRST + 1,
	DXDI_SYMCIPHER_AES_CBC  = _DXDI_SYMCIPHER_AES_FIRST + 2,
	DXDI_SYMCIPHER_AES_CTR  = _DXDI_SYMCIPHER_AES_FIRST + 3,
	DXDI_SYMCIPHER_AES_XTS  = _DXDI_SYMCIPHER_AES_FIRST + 4,
	_DXDI_SYMCIPHER_AES_LAST = DXDI_SYMCIPHER_AES_XTS,
	_DXDI_SYMCIPHER_DES_FIRST = 0x11,
	DXDI_SYMCIPHER_DES_ECB  = _DXDI_SYMCIPHER_DES_FIRST,
	DXDI_SYMCIPHER_DES_CBC  = _DXDI_SYMCIPHER_DES_FIRST + 1,
	_DXDI_SYMCIPHER_DES_LAST = DXDI_SYMCIPHER_DES_CBC,
	_DXDI_SYMCIPHER_C2_FIRST = 0x21,
	DXDI_SYMCIPHER_C2_ECB   = _DXDI_SYMCIPHER_C2_FIRST,
	DXDI_SYMCIPHER_C2_CBC   = _DXDI_SYMCIPHER_C2_FIRST + 1,
	_DXDI_SYMCIPHER_C2_LAST = DXDI_SYMCIPHER_C2_CBC,
	DXDI_SYMCIPHER_RC4  = 0x31, /* Supported in message API only */
	DXDI_SYMCIPHER_RESERVE32B = INT32_MAX
};


enum dxdi_auth_enc_type {
	DXDI_AUTHENC_NONE = 0,
	DXDI_AUTHENC_AES_CCM = 1,
	DXDI_AUTHENC_AES_GCM = 2,
	DXDI_AUTHENC_MAX = DXDI_AUTHENC_AES_GCM,
	DXDI_AUTHENC_RESERVE32B = INT32_MAX
};

enum dxdi_mac_type {
	DXDI_MAC_NONE     = 0,
	DXDI_MAC_HMAC     = 1,
	DXDI_MAC_AES_MAC  = 2,
	DXDI_MAC_AES_CMAC = 3,
	DXDI_MAC_AES_XCBC_MAC = 4,
	DXDI_MAC_MAX = DXDI_MAC_AES_XCBC_MAC,
	DXDI_MAC_RESERVE32B = INT32_MAX
};

enum dxdi_hash_type {
	DXDI_HASH_NONE = 0,
	DXDI_HASH_MD5  = 1,
	DXDI_HASH_SHA1 = 2,
	DXDI_HASH_SHA224 = 3,
	DXDI_HASH_SHA256 = 4,
	DXDI_HASH_SHA384 = 5,
	DXDI_HASH_SHA512 = 6,
	DXDI_HASH_MAX = DXDI_HASH_SHA512,
	DXDI_HASH_RESERVE32B = INT32_MAX
};

enum dxdi_data_block_type {
	DXDI_DATA_TYPE_NULL = 0,
	DXDI_DATA_TYPE_TEXT = 1,  /* Plain/cipher text */
	DXDI_DATA_TYPE_ADATA = 2, /* Additional/Associated data for AEAD */
	DXDI_DATA_TYPE_MAX = DXDI_DATA_TYPE_ADATA,
	DXDI_DATA_TYPE_RESERVE32B = INT32_MAX
};

enum dxdi_input_engine_type {
	DXDI_INPUT_NULL = 0,     /* no input */
	DXDI_INPUT_ENGINE_1 = 1,
	DXID_INPUT_ENGINE_2 = 2,
	DXDI_INPUT_DIN = 15,     /* input from DIN */
	DXDI_INPUT_ENGINE_RESERVE32B = INT32_MAX,
};

/* Properties of specific ciphers */
/* (for use in alg_specific union of dxdi_cipher_props) */
struct dxdi_des_cbc_props {
	uint8_t iv[DXDI_DES_BLOCK_SIZE];
};
struct dxdi_aes_cbc_props {
	uint8_t iv[DXDI_AES_BLOCK_SIZE];
};
struct dxdi_aes_ctr_props {
	uint8_t cntr[DXDI_AES_BLOCK_SIZE];
};
struct dxdi_aes_xts_props {
	uint8_t init_tweak[DXDI_AES_BLOCK_SIZE];
	unsigned long data_unit_size;
};
struct dxdi_c2_cbc_props {
	uint32_t reset_interval;
};

struct dxdi_sym_cipher_props {
	enum dxdi_sym_cipher_type cipher_type;
	enum dxdi_cipher_direction direction;
	uint8_t key_size; /* In octets */
	uint8_t key[DXDI_SYM_KEY_SIZE_MAX];
	union { /* cipher specific properties */
		struct dxdi_des_cbc_props des_cbc;
		struct dxdi_aes_cbc_props aes_cbc;
		struct dxdi_aes_ctr_props aes_ctr;
		struct dxdi_aes_xts_props aes_xts;
		struct dxdi_c2_cbc_props c2_cbc;
		uint32_t __assure_32b_union_alignment;
		/* Reserve space for future extension?*/
	} alg_specific;
};

struct dxdi_auth_enc_props {
	enum dxdi_auth_enc_type ae_type;
	enum dxdi_cipher_direction direction;
	uint32_t adata_size; /* In octets */
	uint32_t text_size; /* In octets */
	uint8_t key_size; /* In octets */
	uint8_t nonce_size; /* In octets */
	uint8_t tag_size; /* In octets */
	uint8_t key[DXDI_SYM_KEY_SIZE_MAX];
	uint8_t nonce[DXDI_NONCE_SIZE_MAX];
};

/* Properties specific for HMAC */
/* (for use in properties union of dxdi_mac_props) */
struct dxdi_hmac_props {
	enum dxdi_hash_type hash_type;
};

struct dxdi_aes_mac_props {
	uint8_t iv[DXDI_AES_BLOCK_SIZE];
};

struct dxdi_mac_props {
	enum dxdi_mac_type mac_type;
	uint32_t key_size; /* In octets */
	uint8_t  key[DXDI_MAC_KEY_SIZE_MAX];
	union { /* Union of algorithm specific properties */
		struct dxdi_hmac_props hmac;
		struct dxdi_aes_mac_props aes_mac;
		uint32_t __assure_32b_union_alignment;
		/* Reserve space for future extension?*/
	} alg_specific;
};

/* Combined mode props */
struct dxdi_combined_node_props {
	uint32_t *context;
	enum dxdi_input_engine_type eng_input;
};

struct dxdi_combined_props {
	struct dxdi_combined_node_props node_props[DXDI_COMBINED_NODES_MAX];
};

/*** IOCTL commands parameters structures ***/

struct dxdi_get_sym_cipher_ctx_size_params {
	enum dxdi_sym_cipher_type sym_cipher_type; /*[in]*/
	uint32_t ctx_size; /*[out]*/
};

struct dxdi_get_auth_enc_ctx_size_params {
	enum dxdi_auth_enc_type ae_type; /*[in]*/
	uint32_t ctx_size; /*[out]*/
};

struct dxdi_get_mac_ctx_size_params {
	enum dxdi_mac_type mac_type; /*[in]*/
	uint32_t ctx_size; /*[out]*/
};

struct dxdi_get_hash_ctx_size_params {
	enum dxdi_hash_type hash_type; /*[in]*/
	uint32_t ctx_size; /*[out]*/
};

/* Init params */
struct dxdi_sym_cipher_init_params {
	uint32_t *context_buf; /*[in]*/
	struct dxdi_sym_cipher_props props; /*[in]*/
	uint32_t error_info; /*[out]*/
};

struct dxdi_auth_enc_init_params {
	uint32_t *context_buf; /*[in]*/
	struct dxdi_auth_enc_props props; /*[in]*/
	uint32_t error_info; /*[out]*/
};

struct dxdi_mac_init_params {
	uint32_t *context_buf; /*[in]*/
	struct dxdi_mac_props props; /*[in]*/
	uint32_t error_info; /*[out]*/
};

struct dxdi_hash_init_params {
	uint32_t *context_buf; /*[in]*/
	enum dxdi_hash_type hash_type; /*[in]*/
	uint32_t error_info; /*[out]*/
};

/* Processing params */
struct dxdi_process_dblk_params {
	uint32_t *context_buf; /*[in]*/
	uint8_t *data_in; /*[in]*/
	uint8_t *data_out; /*[in]*/
	enum dxdi_data_block_type data_block_type; /*[in]*/
	uint32_t data_in_size; /*[in]*/
	uint32_t error_info; /*[out]*/
};

struct dxdi_fin_process_params {
	uint32_t *context_buf; /*[in]*/
	uint8_t *data_in; /*[in]*/
	uint8_t *data_out; /*[in]*/
	uint32_t data_in_size; /*[in] (octets)*/
	uint8_t digest_or_mac[DXDI_DIGEST_SIZE_MAX]; /*[out]*/
	uint8_t digest_or_mac_size; /*[out] (octets)*/
	uint32_t error_info; /*[out]*/
};

struct dxdi_sym_cipher_proc_params {
	uint32_t *context_buf; /*[in]*/
	struct dxdi_sym_cipher_props props; /*[in]*/
	uint8_t *data_in; /*[in]*/
	uint8_t *data_out; /*[in]*/
	uint32_t data_in_size; /*[in] (octets)*/
	uint32_t error_info; /*[out]*/
};

struct dxdi_auth_enc_proc_params {
	uint32_t *context_buf; /*[in]*/
	struct dxdi_auth_enc_props props; /*[in]*/
	uint8_t *adata; /*[in]*/
	uint8_t *text_data; /*[in]*/
	uint8_t *data_out; /*[in] */
	uint8_t tag[DXDI_DIGEST_SIZE_MAX]; /*[out]*/
	uint32_t error_info; /*[out]*/
};

struct dxdi_mac_proc_params {
	uint32_t *context_buf; /*[in]*/
	struct dxdi_mac_props props; /*[in]*/
	uint8_t *data_in; /*[in]*/
	uint32_t data_in_size; /*[in] (octets)*/
	uint8_t mac[DXDI_DIGEST_SIZE_MAX]; /*[out]*/
	uint8_t mac_size; /*[out] (octets)*/
	uint32_t error_info; /*[out]*/
};

struct dxdi_hash_proc_params {
	uint32_t *context_buf; /*[in]*/
	enum dxdi_hash_type hash_type; /*[in]*/
	uint8_t *data_in; /*[in]*/
	uint32_t data_in_size; /*[in] (octets)*/
	uint8_t digest[DXDI_DIGEST_SIZE_MAX]; /*[out]*/
	uint8_t digest_size; /*[out] (octets)*/
	uint32_t error_info; /*[out]*/
};

struct dxdi_aes_iv_params {
	uint32_t *context_buf; /*[in]*/
	uint8_t iv_ptr[DXDI_AES_IV_SIZE]; /*[in]/[out]*/
};

/* Combined params */
struct dxdi_combined_init_params {
	struct dxdi_combined_props props; /*[in]*/
	uint32_t error_info; /*[out]*/
};

struct dxdi_combined_proc_dblk_params {
	struct dxdi_combined_props props; /*[in]*/
	uint8_t *data_in; /*[in]*/
	uint8_t *data_out; /*[out]*/
	uint32_t data_in_size; /*[in] (octets)*/
	uint32_t error_info; /*[out]*/
};

/* the structure used in finalize and integrated processing */
struct dxdi_combined_proc_params {
	struct dxdi_combined_props props; /*[in]*/
	uint8_t *data_in; /*[in]*/
	uint8_t *data_out; /*[out]*/
	uint32_t data_in_size; /*[in] (octets)*/
	uint8_t auth_data[DXDI_DIGEST_SIZE_MAX]; /*[out]*/
	uint8_t auth_data_size; /*[out] (octets)*/
	uint32_t error_info; /*[out]*/
};

/**************************************/
/* Memory references and registration */
/**************************************/

enum dxdi_data_direction {
	DXDI_DATA_NULL = 0,
	DXDI_DATA_TO_DEVICE = 1,
	DXDI_DATA_FROM_DEVICE = (1<<1),
	DXDI_DATA_BIDIR = (DXDI_DATA_TO_DEVICE |  DXDI_DATA_FROM_DEVICE)
};

/* Reference to pre-registered memory */
typedef int dxdi_memref_id_t;
#define DXDI_MEMREF_ID_NULL -1

struct dxdi_memref {
	enum dxdi_data_direction dma_direction;
	/* Memory reference ID - DXDI_MEMREF_ID_NULL if not registered */
	dxdi_memref_id_t ref_id;
	/* Start address of a non-registered memory or offset within a
	   registered memory */
	unsigned long start_or_offset;
	/* Size in bytes of non-registered buffer or size of chunk within a
	   registered buffer */
	unsigned long size;
};

struct dxdi_register_mem4dma_params {
	struct dxdi_memref memref; /*[in]*/
	dxdi_memref_id_t memref_id; /*[out]*/
};

struct dxdi_alloc_mem4dma_params {
	unsigned long size; /*[in]*/
	dxdi_memref_id_t memref_id; /*[out]*/
};

struct dxdi_free_mem4dma_params {
	dxdi_memref_id_t memref_id; /*[in]*/
};

/***********/
/* SeP-RPC */
/***********/
struct dxdi_sep_rpc_params {
	seprpc_agent_id_t agent_id; /*[in]*/
	seprpc_func_id_t func_id; /*[in]*/
	struct dxdi_memref mem_refs[SEP_RPC_MAX_MEMREF_PER_FUNC]; /*[in]*/
	unsigned long rpc_params_size; /*[in]*/
	struct seprpc_params *rpc_params; /*[in]*/
	/* rpc_params to be copied into kernel DMA buffer */
	seprpc_retcode_t error_info; /*[out]*/
};

/***************/
/* SeP Applets */
/***************/

enum dxdi_sepapp_param_type {
	DXDI_SEPAPP_PARAM_NULL = 0,
	DXDI_SEPAPP_PARAM_VAL = 1,
	DXDI_SEPAPP_PARAM_MEMREF = 2,
	DXDI_SEPAPP_PARAM_RESERVE32B = 0x7FFFFFFF
};

struct dxdi_val_param {
	enum dxdi_data_direction copy_dir; /* Copy direction */
	uint32_t data[2];
};

#define SEP_APP_PARAMS_MAX 4

struct dxdi_sepapp_params {
	enum dxdi_sepapp_param_type params_types[SEP_APP_PARAMS_MAX];
	union {
		struct dxdi_val_param val;
		struct dxdi_memref memref;
	} params[SEP_APP_PARAMS_MAX];
};

/* SeP modules ID for returnOrigin */
enum dxdi_sep_module {
	DXDI_SEP_MODULE_NULL        = 0,
	DXDI_SEP_MODULE_HOST_DRIVER = 1,
	DXDI_SEP_MODULE_SW_QUEUE    = 2, /* SW-queue task: Inc. desc. parsers */
	DXDI_SEP_MODULE_APP_MGR     = 3, /* Applet Manager*/
	DXDI_SEP_MODULE_APP         = 4, /* Applet */
	DXDI_SEP_MODULE_RPC_AGENT   = 5, /* Down to RPC parsers */
	DXDI_SEP_MODULE_SYM_CRYPTO  = 6, /* Symmetric crypto driver */
	DXDI_SEP_MODULE_RESERVE32B  = 0x7FFFFFFF
};

#define DXDI_SEPAPP_UUID_SIZE 16
typedef uint8_t dxdi_sepapp_uuid_t[DXDI_SEPAPP_UUID_SIZE];

typedef int dxdi_sepapp_session_id_t;
#define DXDI_SEPAPP_SESSION_INVALID (-1)

struct dxdi_sepapp_session_open_params {
	dxdi_sepapp_uuid_t app_uuid; /*[in]*/
	uint32_t auth_method; /*[in]*/
	uint32_t auth_data[3]; /*[in]*/
	struct dxdi_sepapp_params app_auth_data; /*[in/out]*/
	dxdi_sepapp_session_id_t session_id; /*[out]*/
	enum dxdi_sep_module sep_ret_origin; /*[out]*/
	uint32_t error_info; /*[out]*/
};

struct dxdi_sepapp_session_close_params {
	dxdi_sepapp_session_id_t session_id; /*[in]*/
};

struct dxdi_sepapp_command_invoke_params {
	dxdi_sepapp_session_id_t session_id; /*[in]*/
	uint32_t command_id; /*[in]*/
	struct dxdi_sepapp_params command_params; /*[in/out]*/
	enum dxdi_sep_module sep_ret_origin; /*[out]*/
	uint32_t error_info; /*[out]*/
};

#endif /*__SEP_DRIVER_ABI_H__*/