otz_tee_client_api.h

Go to the documentation of this file.

/* 
 * OpenVirtualization: 
 * For additional details and support contact [email protected].
 * Additional documentation can be found at www.openvirtualization.org
 * 
 * Copyright (C) 2010-2014 SierraWare
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 * 
 */
/* 
 * Header file for global platform TEE client API
 */

#ifndef __OTZ_TEE_CLIENT_API_H_
#define __OTZ_TEE_CLIENT_API_H_

#define MAX_SESSIONS_PER_DEVICE 16
#define MAX_OPERATIONS_PER_SESSION 16
#define MAX_MEMBLOCKS_PER_SESSION 16
#define MAX_MEMBLOCKS_PER_OPERATION 4


#define TEEC_PARAM_TYPES( param0Type, param1Type, param2Type, param3Type) \
    (param3Type << 12 | param2Type << 8 | param1Type << 4 | param0Type)

#define TEEC_VALUE_UNDEF 0xffffffff
#include <sw_list.h>
#include <otz_tee_api.h>



enum TEEC_return_code_origin {
    TEEC_ORIGIN_API = 0x1,
    TEEC_ORIGIN_COMMS = 0x2,
    TEEC_ORIGIN_TEE = 0x3,
    TEEC_ORIGIN_TRUSTED_APP = 0x4,
};


enum TEEC_login_flags {
    TEEC_LOGIN_PUBLIC = 0x0,
    TEEC_LOGIN_USER ,
    TEEC_LOGIN_GROUP ,
    TEEC_LOGIN_APPLICATION = 0x4 ,
    TEEC_LOGIN_USER_APPLICATION = 0x5 ,
    TEEC_LOGIN_GROUP_APPLICATION = 0x6 ,
};

enum TEEC_shared_mem_flags {
    TEEC_MEM_INPUT = 0x1,
    TEEC_MEM_OUTPUT = 0x2,
};

enum TEEC_param_type {
    TEEC_NONE = 0x1,
    TEEC_VALUE_INPUT,
    TEEC_VALUE_OUTPUT,
    TEEC_VALUE_INOUT,
    TEEC_MEMREF_TEMP_INPUT,
    TEEC_MEMREF_TEMP_OUTPUT,
    TEEC_MEMREF_TEMP_INOUT,
    TEEC_MEMREF_WHOLE = 0xc,

    TEEC_MEMREF_PARTIAL_INPUT = 0xd,

    TEEC_MEMREF_PARTIAL_OUTPUT = 0xe,

    TEEC_MEMREF_PARTIAL_INOUT = 0xf
};

typedef struct TEEC_Operation TEEC_Operation;
typedef struct TEEC_Session TEEC_Session;
typedef struct TEEC_Context TEEC_Context;
typedef struct TEEC_SharedMemory TEEC_SharedMemory;
typedef struct TEEC_TempMemoryReference TEEC_TempMemoryReference;
typedef struct TEEC_RegisteredMemoryReference TEEC_RegisteredMemoryReference;
typedef struct TEEC_Value TEEC_Value;

typedef uint32_t TEEC_UUID;

struct TEEC_Session
{
    int operation_cnt;
    int session_id;
    int service_id;
    TEEC_Context* device;
    int s_errno;
};


struct TEEC_Context
{
    uint32_t fd;
    int session_count;
    uint32_t shared_mem_cnt;    
    struct list shared_mem_list;
    int s_errno;
};


struct TEEC_SharedMemory
{
    void*   buffer;

    size_t size;

    uint32_t flags;

    TEEC_Context* context;
    int operation_count;
    uint32_t allocated;
    struct list head_ref;
    int s_errno;
};


struct TEEC_Value
{
   size_t a;
   size_t b;
};


struct TEEC_TempMemoryReference
{
    void            *buffer;
    size_t        size;
};

struct TEEC_RegisteredMemoryReference
{
    TEEC_SharedMemory* parent;

    size_t        size;

    size_t        offset;
};

typedef union
{
    TEEC_TempMemoryReference       tmpref;

    TEEC_RegisteredMemoryReference memref;

    TEEC_Value                     value;
} TEEC_Parameter;

struct TEEC_Operation
{
    uint32_t started;

    uint32_t paramTypes;

    TEEC_Parameter params[4];
};


enum otz_shared_mem_flags {
    OTZ_MEM_SERVICE_RO = 0x0,
    OTZ_MEM_SERVICE_WO ,
    OTZ_MEM_SERVICE_RW,
    OTZ_MEM_SERVICE_UNDEFINED
};


TEEC_Result TEEC_InitializeContext(
    const char*   name,
    TEEC_Context* context);



void TEEC_FinalizeContext(
    TEEC_Context* context);

TEEC_Result TEEC_RegisterSharedMemory(
    TEEC_Context*      context,
    TEEC_SharedMemory* sharedMem);


TEEC_Result TEEC_AllocateSharedMemory(
    TEEC_Context*      context,
    TEEC_SharedMemory* sharedMem);


void TEEC_ReleaseSharedMemory(
    TEEC_SharedMemory* sharedMem);


TEEC_Result TEEC_OpenSession (
    TEEC_Context*    context,
    TEEC_Session*    session,
    const TEEC_UUID* destination,
    uint32_t         connectionMethod,
    const void*      connectionData,
    TEEC_Operation* operation,
    uint32_t*        returnOrigin);


void TEEC_CloseSession (
    TEEC_Session*    session);


TEEC_Result TEEC_InvokeCommand(
    TEEC_Session*     session,
    uint32_t          commandID,
    TEEC_Operation*   operation,
    uint32_t*         returnOrigin);


void TEEC_RequestCancellation(
    TEEC_Operation* operation);

char* TEEC_GetError(int error, int returnOrigin);

#endif