core/include/tee/tee_obj.h

   1 /*
   2  * Copyright (c) 2014, STMicroelectronics International N.V.
   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 notice,
  12  * this list of conditions and the following disclaimer in the documentation
  13  * and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25  * POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef TEE_OBJ_H
  29 #define TEE_OBJ_H
  30
  31 #include <tee_api_types.h>
  32 #include <kernel/tee_ta_manager.h>
  33 #include <sys/queue.h>
  34
  35 #define TEE_USAGE_DEFAULT   0xffffffff
  36
  37 struct tee_obj {
  38         TAILQ_ENTRY(tee_obj) link;
  39         TEE_ObjectInfo info;
  40         bool busy;              /* true if used by an operation */
  41         uint32_t have_attrs;    /* bitfield identifying set properties */
  42         void *attr;
  43         struct tee_pobj *pobj;  /* ptr to persistant object */
  44         struct tee_file_handle *fh;
  45         uint32_t ds_size;       /* data stream size */
  46         uint32_t flags;         /* permission flags for persistent objects */
  47 };
  48
  49 void tee_obj_add(struct user_ta_ctx *utc, struct tee_obj *o);
  50
  51 TEE_Result tee_obj_get(struct user_ta_ctx *utc, uint32_t obj_id,
  52                        struct tee_obj **obj);
  53
  54 void tee_obj_close(struct user_ta_ctx *utc, struct tee_obj *o);
  55
  56 void tee_obj_close_all(struct user_ta_ctx *utc);
  57
  58 TEE_Result tee_obj_verify(struct tee_ta_session *sess, struct tee_obj *o);
  59
  60 struct tee_obj *tee_obj_alloc(void);
  61 void tee_obj_free(struct tee_obj *o);
  62
  63 #endif