tee.h

/*
 * Copyright (c) 2015-2016, Linaro Limited
 * All rights reserved.
 *
 * 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.
 *
 * 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 __TEE_H
#define __TEE_H

//#include <linux/ioctl.h>
//#include <linux/types.h>

/*
 * This file describes the API provided by a TEE driver to user space.
 *
 * Each TEE driver defines a TEE specific protocol which is used for the
 * data passed back and forth using TEE_IOC_CMD.
 */

/* Helpers to make the ioctl defines */
#define TEE_IOC_MAGIC   0xa4
#define TEE_IOC_BASE  0
#define TEE_IOC_OPEN_SESSION TEE_IOC_BASE + 2
#define TEE_IOC_INVOKE TEE_IOC_BASE + 3
#define TEE_IOC_CLOSE_SESSION TEE_IOC_BASE + 5


/* Flags relating to shared memory */
#define TEE_IOCTL_SHM_MAPPED    0x1 /* memory mapped in normal world */
#define TEE_IOCTL_SHM_DMA_BUF   0x2 /* dma-buf handle on shared memory */

#define TEE_MAX_ARG_SIZE    1024

#define TEE_GEN_CAP_GP      (1 << 0)/* GlobalPlatform compliant TEE */
#define TEE_GEN_CAP_REG_MEM (1 << 2)/* Supports registering shared memory */

/*
 * TEE Implementation ID
 */
#define TEE_IMPL_ID_OPTEE   1

/*
 * OP-TEE specific capabilities
 */
#define TEE_OPTEE_CAP_TZ    (1 << 0)

struct tee_ioctl_version_data {
    uint32_t impl_id;
    uint32_t impl_caps;
    uint32_t gen_caps;
};

#define TEE_IOC_VERSION     _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 0, \
                     struct tee_ioctl_version_data)

struct tee_ioctl_shm_alloc_data {
    uint32_t size;
    uint32_t flags;
    int32_t id;
};

#define TEE_IOC_SHM_ALLOC   _IOWR(TEE_IOC_MAGIC, TEE_IOC_BASE + 1, \
                     struct tee_ioctl_shm_alloc_data)

struct tee_ioctl_shm_register_fd_data {
  uint32_t fd;
    uint32_t size;
    uint32_t flags;
    int32_t id;
} __aligned(4);

#define TEE_IOC_SHM_REGISTER_FD _IOWR(TEE_IOC_MAGIC, TEE_IOC_BASE + 8, \
                     struct tee_ioctl_shm_register_fd_data)

struct tee_ioctl_shm_register_data {
  uint32_t addr;
  uint32_t length;
    uint32_t flags;
    int32_t id;
};

#define TEE_IOC_SHM_REGISTER   _IOWR(TEE_IOC_MAGIC, TEE_IOC_BASE + 9, \
                     struct tee_ioctl_shm_register_data)

struct tee_ioctl_buf_data {
    uint32_t buf_ptr;
    uint32_t buf_len;
};

/*
 * Attributes for struct tee_ioctl_param, selects field in the union
 */
#define TEE_IOCTL_PARAM_ATTR_TYPE_NONE      0   /* parameter not used */

/*
 * These defines value parameters (struct tee_ioctl_param_value)
 */
#define TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT   1
#define TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT  2
#define TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INOUT   3   /* input and output */

/*
 * These defines shared memory reference parameters (struct
 * tee_ioctl_param_memref)
 */
#define TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT  5
#define TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_OUTPUT 6
#define TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INOUT  7   /* input and output */

/*
 * Mask for the type part of the attribute, leaves room for more types
 */
#define TEE_IOCTL_PARAM_ATTR_TYPE_MASK      0xff

/* Meta parameter carrying extra information about the message. */
#define TEE_IOCTL_PARAM_ATTR_META       0x100

/* Mask of all known attr bits */
#define TEE_IOCTL_PARAM_ATTR_MASK \
    (TEE_IOCTL_PARAM_ATTR_TYPE_MASK | TEE_IOCTL_PARAM_ATTR_META)

/*
 * Matches TEEC_LOGIN_* in GP TEE Client API
 * Are only defined for GP compliant TEEs
 */
#define TEE_IOCTL_LOGIN_PUBLIC          0
#define TEE_IOCTL_LOGIN_USER            1
#define TEE_IOCTL_LOGIN_GROUP           2
#define TEE_IOCTL_LOGIN_APPLICATION     4
#define TEE_IOCTL_LOGIN_USER_APPLICATION    5
#define TEE_IOCTL_LOGIN_GROUP_APPLICATION   6

struct tee_ioctl_param_memref {
    uint32_t shm_offs;
    uint32_t size;
    int32_t shm_id;
};

struct tee_ioctl_param_value {
    uint32_t a;
    uint32_t b;
    uint32_t c;
};

struct tee_ioctl_param {
    uint32_t attr;
    union {
        struct tee_ioctl_param_memref memref;
        struct tee_ioctl_param_value value;
    } u;
};

#define TEE_IOCTL_UUID_LEN      16

struct tee_ioctl_open_session_arg {
    uint8_t uuid[TEE_IOCTL_UUID_LEN];
    uint8_t clnt_uuid[TEE_IOCTL_UUID_LEN];
    uint32_t clnt_login;
    uint32_t cancel_id;
    uint32_t session;
    uint32_t ret;
    uint32_t ret_origin;
    uint32_t num_params;
    /*
     * this struct is 8 byte aligned since the 'struct tee_ioctl_param'
     * which follows requires 8 byte alignment.
     *
     * Commented out element used to visualize the layout dynamic part
     * of the struct. This field is not available at all if
     * num_params == 0.
     *
     * struct tee_ioctl_param params[num_params];
     */
} __aligned(4); 

//#define TEE_IOC_OPEN_SESSION  _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 2, \
//                   struct tee_ioctl_buf_data)

struct tee_ioctl_invoke_arg {
    uint32_t func;
    uint32_t session;
    uint32_t cancel_id;
    uint32_t ret;
    uint32_t ret_origin;
    uint32_t num_params;
    /*
     * this struct is 8 byte aligned since the 'struct tee_ioctl_param'
     * which follows requires 8 byte alignment.
     *
     * Commented out element used to visualize the layout dynamic part
     * of the struct. This field is not available at all if
     * num_params == 0.
     *
     * struct tee_ioctl_param params[num_params];
     */
} __aligned(4);

//#define TEE_IOC_INVOKE        _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 3, \
//                   struct tee_ioctl_buf_data)

struct tee_ioctl_cancel_arg {
    uint32_t cancel_id;
    uint32_t session;
};

#define TEE_IOC_CANCEL      _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 4, \
                     struct tee_ioctl_cancel_arg)

struct tee_ioctl_close_session_arg {
    uint32_t session;
};

//#define TEE_IOC_CLOSE_SESSION _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 5, \
//                   struct tee_ioctl_close_session_arg)

struct tee_iocl_supp_recv_arg {
    uint32_t func;
    uint32_t num_params;
    /*
     * this struct is 8 byte aligned since the 'struct tee_ioctl_param'
     * which follows requires 8 byte alignment.
     *
     * Commented out element used to visualize the layout dynamic part
     * of the struct. This field is not available at all if
     * num_params == 0.
     *
     * struct tee_ioctl_param params[num_params];
     */
} __aligned(4);

#define TEE_IOC_SUPPL_RECV  _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 6, \
                     struct tee_ioctl_buf_data)

struct tee_iocl_supp_send_arg {
    uint32_t ret;
    uint32_t num_params;
    /*
     * this struct is 8 byte aligned since the 'struct tee_ioctl_param'
     * which follows requires 8 byte alignment.
     *
     * Commented out element used to visualize the layout dynamic part
     * of the struct. This field is not available at all if
     * num_params == 0.
     *
     * struct tee_ioctl_param params[num_params];
     */
} __aligned(4);
#define TEE_IOC_SUPPL_SEND  _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 7, \
                     struct tee_ioctl_buf_data)

/*
 * Five syscalls are used when communicating with the TEE driver.
 * open(): opens the device associated with the driver
 * ioctl(): as described above operating on the file descriptor from open()
 * close(): two cases
 *   - closes the device file descriptor
 *   - closes a file descriptor connected to allocated shared memory
 * mmap(): maps shared memory into user space using information from struct
 *     tee_ioctl_shm_alloc_data
 * munmap(): unmaps previously shared memory
 */

#endif /*__TEE_H*/