mobicore/common/MobiCore/inc/McLib/GpTci.h

   1 /*
   2  * Copyright (c) 2013 TRUSTONIC LIMITED
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * 3. Neither the name of the TRUSTONIC LIMITED nor the names of its
  16  *    contributors may be used to endorse or promote products derived from
  17  *    this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  26  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  28  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef _GP_TCI_H_
  33 #define _GP_TCI_H_
  34
  35 typedef struct {
  36     uint32_t   a;
  37     uint32_t   b;
  38 } TEE_Value;
  39
  40 #if defined (TRUSTEDAPP)
  41 typedef struct {
  42     void        *sVirtualAddr;         /**< The virtual address of the Bulk buffer regarding the address space of the Trustlet, already includes a possible offset! */
  43     uint32_t    sVirtualLen;       /**< Length of the mapped Bulk buffer */
  44 } mcBulkMap_t;
  45 #endif
  46
  47 typedef struct {
  48     mcBulkMap_t mapInfo;
  49     uint32_t    outputSize;
  50 } _TEEC_MemoryReferenceInternal;
  51
  52 typedef union {
  53     TEE_Value                      value;
  54     _TEEC_MemoryReferenceInternal   memref;
  55 } _TEEC_ParameterInternal;
  56
  57 typedef enum {
  58     _TA_OPERATION_OPEN_SESSION =    1,
  59     _TA_OPERATION_INVOKE_COMMAND =  2,
  60     _TA_OPERATION_CLOSE_SESSION =   3,
  61 } _TEEC_TCI_type;
  62
  63 typedef struct {
  64     _TEEC_TCI_type          type;
  65     uint32_t                commandId;
  66     uint32_t                paramTypes;
  67     _TEEC_ParameterInternal params[4];
  68     bool                    isCancelled;
  69 } _TEEC_OperationInternal;
  70
  71 typedef struct {
  72     char header[8];// = "TCIGP000"`: version indicator (to support future format changes)
  73     TEEC_UUID destination;
  74     _TEEC_OperationInternal operation; //the data of the ongoing operation (if any)
  75     uint32_t ready;
  76     // The following fields are set by the secure world (in a future version, they may also be set by the normal world communication layer):
  77     uint32_t returnOrigin;
  78     uint32_t returnStatus;
  79 } _TEEC_TCI;
  80
  81 #define TEEC_MEMREF_WHOLE             0xC
  82 #define TEEC_MEMREF_PARTIAL_INPUT     0xD
  83 #define TEEC_MEMREF_PARTIAL_OUTPUT    0xE
  84 #define TEEC_MEMREF_PARTIAL_INOUT     0xF
  85
  86 /**
  87  * Termination codes
  88  */
  89 #define TA_EXIT_CODE_PANIC  (300)
  90 #define TA_EXIT_CODE_TCI    (301)
  91 #define TA_EXIT_CODE_PARAMS (302)
  92 #define TA_EXIT_CODE_FINISHED       (303)
  93 #define TA_EXIT_CODE_SESSIONSTATE   (304)
  94 #define TA_EXIT_CODE_CREATEFAILED   (305)
  95
  96 #endif // _GP_TCI_H_