f090258a21
Add new smci headers that support snake case APIs, structures and macros. Tests Done: scipp_test Change-Id: Ie0e9529929722529ffe112f9ceadc667e58a0dd0 Signed-off-by: Ujjawal Sankhwar <quic_usankhwa@quicinc.com>
152 خطوط
5.3 KiB
C
152 خطوط
5.3 KiB
C
/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
|
|
/*
|
|
* Copyright (c) 2024 Qualcomm Innovation Center, Inc. All rights reserved.
|
|
*/
|
|
|
|
#ifndef __SMCI_OBJECT_H
|
|
#define __SMCI_OBJECT_H
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/firmware.h>
|
|
#include <linux/qtee_shmbridge.h>
|
|
#include "smcinvoke.h"
|
|
#include "smcinvoke_object.h"
|
|
|
|
/*
|
|
* Method bits are not modified by transport layers. These describe the
|
|
* method (member function) being requested by the client.
|
|
*/
|
|
|
|
#define SMCI_OBJECT_OP_METHOD_MASK (0x0000FFFFu)
|
|
#define SMCI_OBJECT_OP_METHODID(op) ((op) & SMCI_OBJECT_OP_METHOD_MASK)
|
|
#define SMCI_OBJECT_OP_RELEASE (SMCI_OBJECT_OP_METHOD_MASK - 0)
|
|
#define SMCI_OBJECT_OP_RETAIN (SMCI_OBJECT_OP_METHOD_MASK - 1)
|
|
#define SMCI_OBJECT_OP_MAP_REGION 0
|
|
#define SMCI_OBJECT_OP_YIELD 1
|
|
#define SMCI_OBJECT_OP_SLEEP 2
|
|
|
|
#define SMCI_OBJECT_COUNTS_MAX_BI 0xF
|
|
#define SMCI_OBJECT_COUNTS_MAX_BO 0xF
|
|
#define SMCI_OBJECT_COUNTS_MAX_OI 0xF
|
|
#define SMCI_OBJECT_COUNTS_MAX_OO 0xF
|
|
|
|
/* unpack counts */
|
|
|
|
#define SMCI_OBJECT_COUNTS_NUM_BI(k) ((size_t) (((k) >> 0) & SMCI_OBJECT_COUNTS_MAX_BI))
|
|
#define SMCI_OBJECT_COUNTS_NUM_BO(k) ((size_t) (((k) >> 4) & SMCI_OBJECT_COUNTS_MAX_BO))
|
|
#define SMCI_OBJECT_COUNTS_NUM_OI(k) ((size_t) (((k) >> 8) & SMCI_OBJECT_COUNTS_MAX_OI))
|
|
#define SMCI_OBJECT_COUNTS_NUM_OO(k) ((size_t) (((k) >> 12) & SMCI_OBJECT_COUNTS_MAX_OO))
|
|
#define SMCI_OBJECT_COUNTS_NUM_BUFFERS(k) \
|
|
(SMCI_OBJECT_COUNTS_NUM_BI(k) + SMCI_OBJECT_COUNTS_NUM_BO(k))
|
|
|
|
#define SMCI_OBJECT_COUNTS_NUM_OBJECTS(k) \
|
|
(SMCI_OBJECT_COUNTS_NUM_OI(k) + SMCI_OBJECT_COUNTS_NUM_OO(k))
|
|
|
|
/* Indices into args[] */
|
|
|
|
#define SMCI_OBJECT_COUNTS_INDEX_BI(k) 0
|
|
#define SMCI_OBJECT_COUNTS_INDEX_BO(k) \
|
|
(SMCI_OBJECT_COUNTS_INDEX_BI(k) + SMCI_OBJECT_COUNTS_NUM_BI(k))
|
|
#define SMCI_OBJECT_COUNTS_INDEX_OI(k) \
|
|
(SMCI_OBJECT_COUNTS_INDEX_BO(k) + SMCI_OBJECT_COUNTS_NUM_BO(k))
|
|
#define SMCI_OBJECT_COUNTS_INDEX_OO(k) \
|
|
(SMCI_OBJECT_COUNTS_INDEX_OI(k) + SMCI_OBJECT_COUNTS_NUM_OI(k))
|
|
#define SMCI_OBJECT_COUNTS_TOTAL(k) \
|
|
(SMCI_OBJECT_COUNTS_INDEX_OO(k) + SMCI_OBJECT_COUNTS_NUM_OO(k))
|
|
|
|
#define SMCI_OBJECT_COUNTS_PACK(in_bufs, out_bufs, in_objs, out_objs) \
|
|
((uint32_t) ((in_bufs) | ((out_bufs) << 4) | \
|
|
((in_objs) << 8) | ((out_objs) << 12)))
|
|
|
|
#define SMCI_OBJECT_COUNTS_INDEX_BUFFERS(k) SMCI_OBJECT_COUNTS_INDEX_BI(k)
|
|
|
|
/* Object_invoke return codes */
|
|
|
|
#define SMCI_OBJECT_IS_OK(err) ((err) == 0)
|
|
#define SMCI_OBJECT_IS_ERROR(err) ((err) != 0)
|
|
|
|
/* Generic error codes */
|
|
|
|
#define SMCI_OBJECT_OK 0 /* non-specific success code */
|
|
#define SMCI_OBJECT_ERROR 1 /* non-specific error */
|
|
#define SMCI_OBJECT_ERROR_INVALID 2 /* unsupported/unrecognized request */
|
|
#define SMCI_OBJECT_ERROR_SIZE_IN 3 /* supplied buffer/string too large */
|
|
#define SMCI_OBJECT_ERROR_SIZE_OUT 4 /* supplied output buffer too small */
|
|
|
|
#define SMCI_OBJECT_ERROR_USERBASE 10 /* start of user-defined error range */
|
|
|
|
/* Transport layer error codes */
|
|
|
|
#define SMCI_OBJECT_ERROR_DEFUNCT -90 /* smci_object no longer exists */
|
|
#define SMCI_OBJECT_ERROR_ABORT -91 /* calling thread must exit */
|
|
#define SMCI_OBJECT_ERROR_BADOBJ -92 /* invalid smci_object context */
|
|
#define SMCI_OBJECT_ERROR_NOSLOTS -93 /* caller's smci_object table full */
|
|
#define SMCI_OBJECT_ERROR_MAXARGS -94 /* too many args */
|
|
#define SMCI_OBJECT_ERROR_MAXDATA -95 /* buffers too large */
|
|
#define SMCI_OBJECT_ERROR_UNAVAIL -96 /* the request could not be processed */
|
|
#define SMCI_OBJECT_ERROR_KMEM -97 /* kernel out of memory */
|
|
#define SMCI_OBJECT_ERROR_REMOTE -98 /* local method sent to remote smci_object */
|
|
#define SMCI_OBJECT_ERROR_BUSY -99 /* smci_object is busy */
|
|
#define SMCI_OBJECT_ERROR_TIMEOUT -103 /* Call Back smci_object invocation timed out. */
|
|
|
|
/* smci_objectop */
|
|
|
|
#define SMCI_OBJECT_OP_LOCAL ((uint32_t) 0x00008000U)
|
|
|
|
#define SMCI_OBJECT_OP_IS_LOCAL(op) (((op) & SMCI_OBJECT_OP_LOCAL) != 0)
|
|
|
|
|
|
/* smci_object */
|
|
|
|
#define SMCI_OBJECTCOUNTS_PACK(nbuffersin, nbuffersout, nobjectsin, nobjectsout) \
|
|
((uint32_t) ((nbuffersin) | \
|
|
((nbuffersout) << 4) | \
|
|
((nobjectsin) << 8) | \
|
|
((nobjectsout) << 12)))
|
|
|
|
#define smci_object_arg ObjectArg
|
|
#define smci_objectinvoke ObjectInvoke
|
|
#define smci_object Object
|
|
#define smci_object_buf ObjectBuf
|
|
#define smci_object_buf_in ObjectBufIn
|
|
|
|
static inline int32_t smci_object_invoke(struct smci_object o, uint32_t op,
|
|
union smci_object_arg *args, uint32_t k)
|
|
{
|
|
return Object_invoke(o, op, args, k);
|
|
}
|
|
|
|
#define SMCI_OBJECT_NULL ((struct smci_object){NULL, NULL})
|
|
|
|
|
|
#define SMCI_OBJECT_NOT_RETAINED
|
|
|
|
#define SMCI_OBJECT_CONSUMED
|
|
|
|
static inline int32_t smci_object_release(SMCI_OBJECT_CONSUMED struct smci_object o)
|
|
{
|
|
return Object_release(o);
|
|
}
|
|
static inline int32_t smci_object_retain(struct smci_object o)
|
|
{
|
|
return Object_retain(o);
|
|
}
|
|
|
|
#define SMCI_OBJECT_IS_NULL(o) ((o).invoke == NULL)
|
|
|
|
#define SMCI_OBJECT_RELEASE_IF(o) \
|
|
do { \
|
|
struct smci_object o_ = (o); \
|
|
if (!SMCI_OBJECT_IS_NULL(o_)) \
|
|
(void) smci_object_release(o_); \
|
|
} while (0)
|
|
|
|
static inline void smci_object_replace(struct smci_object *loc, struct smci_object obj_new)
|
|
{
|
|
Object_replace(loc, obj_new);
|
|
}
|
|
|
|
#define SMCI_OBJECT_ASSIGN_NULL(loc) smci_object_replace(&(loc), SMCI_OBJECT_NULL)
|
|
|
|
#endif /* __SMCI_OBJECT_H */
|