msm: mink: Snapshot of the smcinvoke driver

/* SPDX-License-Identifier: GPL-2.0-only */

/*

 * Copyright (c) 2016-2019, The Linux Foundation. All rights reserved.

 */

#ifndef __SMCINVOKE_OBJECT_H

#define __SMCINVOKE_OBJECT_H

#include <linux/types.h>

/*

 * Method bits are not modified by transport layers.  These describe the

 * method (member function) being requested by the client.

 */

#define OBJECT_OP_METHOD_MASK     (0x0000FFFFu)

#define OBJECT_OP_METHODID(op)    ((op) & OBJECT_OP_METHOD_MASK)

#define OBJECT_OP_RELEASE       (OBJECT_OP_METHOD_MASK - 0)

#define OBJECT_OP_RETAIN        (OBJECT_OP_METHOD_MASK - 1)

#define OBJECT_OP_MAP_REGION    0

#define OBJECT_COUNTS_MAX_BI   0xF

#define OBJECT_COUNTS_MAX_BO   0xF

#define OBJECT_COUNTS_MAX_OI   0xF

#define OBJECT_COUNTS_MAX_OO   0xF

/* unpack counts */

#define OBJECT_COUNTS_NUM_BI(k)  ((size_t) (((k) >> 0) & OBJECT_COUNTS_MAX_BI))

#define OBJECT_COUNTS_NUM_BO(k)  ((size_t) (((k) >> 4) & OBJECT_COUNTS_MAX_BO))

#define OBJECT_COUNTS_NUM_OI(k)  ((size_t) (((k) >> 8) & OBJECT_COUNTS_MAX_OI))

#define OBJECT_COUNTS_NUM_OO(k)  ((size_t) (((k) >> 12) & OBJECT_COUNTS_MAX_OO))

#define OBJECT_COUNTS_NUM_buffers(k)	\

			(OBJECT_COUNTS_NUM_BI(k) + OBJECT_COUNTS_NUM_BO(k))

#define OBJECT_COUNTS_NUM_objects(k)	\

			(OBJECT_COUNTS_NUM_OI(k) + OBJECT_COUNTS_NUM_OO(k))

/* Indices into args[] */

#define OBJECT_COUNTS_INDEX_BI(k)   0

#define OBJECT_COUNTS_INDEX_BO(k)		\

			(OBJECT_COUNTS_INDEX_BI(k) + OBJECT_COUNTS_NUM_BI(k))

#define OBJECT_COUNTS_INDEX_OI(k)		\

			(OBJECT_COUNTS_INDEX_BO(k) + OBJECT_COUNTS_NUM_BO(k))

#define OBJECT_COUNTS_INDEX_OO(k)		\

			(OBJECT_COUNTS_INDEX_OI(k) + OBJECT_COUNTS_NUM_OI(k))

#define OBJECT_COUNTS_TOTAL(k)		\

			(OBJECT_COUNTS_INDEX_OO(k) + OBJECT_COUNTS_NUM_OO(k))

#define OBJECT_COUNTS_PACK(in_bufs, out_bufs, in_objs, out_objs) \

	((uint32_t) ((in_bufs) | ((out_bufs) << 4) | \

			((in_objs) << 8) | ((out_objs) << 12)))

/* Object_invoke return codes */

#define OBJECT_isOK(err)        ((err) == 0)

#define OBJECT_isERROR(err)     ((err) != 0)

/* Generic error codes */

#define OBJECT_OK                  0   /* non-specific success code */

#define OBJECT_ERROR               1   /* non-specific error */

#define OBJECT_ERROR_INVALID       2   /* unsupported/unrecognized request */

#define OBJECT_ERROR_SIZE_IN       3   /* supplied buffer/string too large */

#define OBJECT_ERROR_SIZE_OUT      4   /* supplied output buffer too small */

#define OBJECT_ERROR_USERBASE     10   /* start of user-defined error range */

/* Transport layer error codes */

#define OBJECT_ERROR_DEFUNCT     -90   /* object no longer exists */

#define OBJECT_ERROR_ABORT       -91   /* calling thread must exit */

#define OBJECT_ERROR_BADOBJ      -92   /* invalid object context */

#define OBJECT_ERROR_NOSLOTS     -93   /* caller's object table full */

#define OBJECT_ERROR_MAXARGS     -94   /* too many args */

#define OBJECT_ERROR_MAXDATA     -95   /* buffers too large */

#define OBJECT_ERROR_UNAVAIL     -96   /* the request could not be processed */

#define OBJECT_ERROR_KMEM        -97   /* kernel out of memory */

#define OBJECT_ERROR_REMOTE      -98   /* local method sent to remote object */

#define OBJECT_ERROR_BUSY        -99   /* Object is busy */

#endif /* __SMCINVOKE_OBJECT_H */

/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */

/*

 * Copyright (c) 2017-2019, The Linux Foundation. All rights reserved.

 */

#ifndef _UAPI_SMCINVOKE_H_

#define _UAPI_SMCINVOKE_H_

#include <linux/types.h>

#include <linux/ioctl.h>

#define SMCINVOKE_USERSPACE_OBJ_NULL	-1

struct smcinvoke_buf {

	uint64_t addr;

	uint64_t size;

};

struct smcinvoke_obj {

	int64_t fd;

	int32_t cb_server_fd;

	int32_t reserved;

};

union smcinvoke_arg {

	struct smcinvoke_buf b;

	struct smcinvoke_obj o;

};

/*

 * struct smcinvoke_cmd_req: This structure is transparently sent to TEE

 * @op - Operation to be performed

 * @counts - number of aruments passed

 * @result - result of invoke operation

 * @argsize - size of each of arguments

 * @args - args is pointer to buffer having all arguments

 */

struct smcinvoke_cmd_req {

	uint32_t op;

	uint32_t counts;

	int32_t result;

	uint32_t argsize;

	uint64_t args;

};

/*

 * struct smcinvoke_accept: structure to process CB req from TEE

 * @has_resp: IN: Whether IOCTL is carrying response data

 * @txn_id: OUT: An id that should be passed as it is for response

 * @result: IN: Outcome of operation op

 * @cbobj_id: OUT: Callback object which is target of operation op

 * @op: OUT: Operation to be performed on target object

 * @counts: OUT: Number of arguments, embedded in buffer pointed by

 *               buf_addr, to complete operation

 * @reserved: IN/OUT: Usage is not defined but should be set to 0.

 * @argsize: IN: Size of any argument, all of equal size, embedded

 *               in buffer pointed by buf_addr

 * @buf_len: IN: Len of buffer pointed by buf_addr

 * @buf_addr: IN: Buffer containing all arguments which are needed

 *                to complete operation op

 */

struct smcinvoke_accept {

	uint32_t has_resp;

	uint32_t txn_id;

	int32_t result;

	int32_t cbobj_id;

	uint32_t op;

	uint32_t counts;

	int32_t reserved;

	uint32_t argsize;

	uint64_t buf_len;

	uint64_t buf_addr;

};

/*

 * @cb_buf_size: IN: Max buffer size for any callback obj implemented by client

 */

struct smcinvoke_server {

	uint32_t cb_buf_size;

};

#define SMCINVOKE_IOC_MAGIC    0x98

#define SMCINVOKE_IOCTL_INVOKE_REQ \

	_IOWR(SMCINVOKE_IOC_MAGIC, 1, struct smcinvoke_cmd_req)

#define SMCINVOKE_IOCTL_ACCEPT_REQ \

	_IOWR(SMCINVOKE_IOC_MAGIC, 2, struct smcinvoke_accept)

#define SMCINVOKE_IOCTL_SERVER_REQ \

	_IOWR(SMCINVOKE_IOC_MAGIC, 3, struct smcinvoke_server)

#define SMCINVOKE_IOCTL_ACK_LOCAL_OBJ \

	_IOWR(SMCINVOKE_IOC_MAGIC, 4, int32_t)

#endif /* _UAPI_SMCINVOKE_H_ */