linux-imx

/* SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) */

/*

 * Copyright (c) 2015-2019, Linaro Limited

 */

#ifndef _OPTEE_MSG_H

#define _OPTEE_MSG_H

​

#include <linux/bitops.h>

#include <linux/types.h>

​

/*

 * This file defines the OP-TEE message protocol used to communicate

 * with an instance of OP-TEE running in secure world.

 *

 * This file is divided into three sections.

 * 1. Formatting of messages.

 * 2. Requests from normal world

 * 3. Requests from secure world, Remote Procedure Call (RPC), handled by

 *    tee-supplicant.

 */

​

/*****************************************************************************

 * Part 1 - formatting of messages

 *****************************************************************************/

​

#define OPTEE_MSG_ATTR_TYPE_NONE        0x0

#define OPTEE_MSG_ATTR_TYPE_VALUE_INPUT     0x1

#define OPTEE_MSG_ATTR_TYPE_VALUE_OUTPUT    0x2

#define OPTEE_MSG_ATTR_TYPE_VALUE_INOUT     0x3

#define OPTEE_MSG_ATTR_TYPE_RMEM_INPUT      0x5

#define OPTEE_MSG_ATTR_TYPE_RMEM_OUTPUT     0x6

#define OPTEE_MSG_ATTR_TYPE_RMEM_INOUT      0x7

#define OPTEE_MSG_ATTR_TYPE_TMEM_INPUT      0x9

#define OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT     0xa

#define OPTEE_MSG_ATTR_TYPE_TMEM_INOUT      0xb

​

#define OPTEE_MSG_ATTR_TYPE_MASK        GENMASK(7, 0)

​

/*

 * Meta parameter to be absorbed by the Secure OS and not passed

 * to the Trusted Application.

 *

 * Currently only used with OPTEE_MSG_CMD_OPEN_SESSION.

 */

#define OPTEE_MSG_ATTR_META         BIT(8)

​

/*

 * Pointer to a list of pages used to register user-defined SHM buffer.

 * Used with OPTEE_MSG_ATTR_TYPE_TMEM_*.

 * buf_ptr should point to the beginning of the buffer. Buffer will contain

 * list of page addresses. OP-TEE core can reconstruct contiguous buffer from

 * that page addresses list. Page addresses are stored as 64 bit values.

 * Last entry on a page should point to the next page of buffer.

 * Every entry in buffer should point to a 4k page beginning (12 least

 * significant bits must be equal to zero).

 *

 * 12 least significant bints of optee_msg_param.u.tmem.buf_ptr should hold page

 * offset of the user buffer.

 *

 * So, entries should be placed like members of this structure:

 *

 * struct page_data {

 *   uint64_t pages_array[OPTEE_MSG_NONCONTIG_PAGE_SIZE/sizeof(uint64_t) - 1];

 *   uint64_t next_page_data;

 * };

 *

 * Structure is designed to exactly fit into the page size

 * OPTEE_MSG_NONCONTIG_PAGE_SIZE which is a standard 4KB page.

 *

 * The size of 4KB is chosen because this is the smallest page size for ARM

 * architectures. If REE uses larger pages, it should divide them to 4KB ones.

 */

#define OPTEE_MSG_ATTR_NONCONTIG        BIT(9)

​

/*

 * Memory attributes for caching passed with temp memrefs. The actual value

 * used is defined outside the message protocol with the exception of

 * OPTEE_MSG_ATTR_CACHE_PREDEFINED which means the attributes already

 * defined for the memory range should be used. If optee_smc.h is used as

 * bearer of this protocol OPTEE_SMC_SHM_* is used for values.

 */

#define OPTEE_MSG_ATTR_CACHE_SHIFT      16

#define OPTEE_MSG_ATTR_CACHE_MASK       GENMASK(2, 0)

#define OPTEE_MSG_ATTR_CACHE_PREDEFINED     0

​

/*

 * Same values as TEE_LOGIN_* from TEE Internal API

 */

#define OPTEE_MSG_LOGIN_PUBLIC          0x00000000

#define OPTEE_MSG_LOGIN_USER            0x00000001

#define OPTEE_MSG_LOGIN_GROUP           0x00000002

#define OPTEE_MSG_LOGIN_APPLICATION     0x00000004