metee.h

Go to the documentation of this file.

/* SPDX-License-Identifier: Apache-2.0 */
/*
 * Copyright (C) 2014-2026 Intel Corporation
 */
#ifndef __METEE_H
#define __METEE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
#ifdef _WIN32
    #include <Windows.h>
    #include <initguid.h>
 
    #ifndef METEE_DLL
        #define METEE_DLL_API
    #else /* METEE_DLL */
        #ifdef METEE_DLL_EXPORT
            #define METEE_DLL_API __declspec(dllexport)
        #else
            #define METEE_DLL_API __declspec(dllimport)
        #endif /* METEE_DLL_EXPORT */
    #endif /* METEE_DLL */
    #define TEEAPI METEE_DLL_API __stdcall
    #define TEE_DEVICE_HANDLE HANDLE
    #define TEE_INVALID_DEVICE_HANDLE ((void*)0)
 
#elif defined(EFI)
    #include <Uefi.h>
    #define TEEAPI 
    #define TEE_DEVICE_HANDLE void *
    #define TEE_INVALID_DEVICE_HANDLE ((void*)-1)   
 
    #define DEFINE_GUID(name, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8) \
                const GUID name \
                    = { l, w1, w2, { b1, b2,  b3,  b4,  b5,  b6,  b7,  b8 } }
 
    // when calling TeeInitFull
    // TEE_DEVICE_TYPE_BDF - HECI device Bus Device Function
 
#else /* _WIN32 */
    #ifndef METEE_DLL
        #define METEE_DLL_API
    #else 
        #ifdef METEE_DLL_EXPORT
            #define METEE_DLL_API __attribute__((__visibility__("default")))
        #else
            #define METEE_DLL_API
        #endif /* METEE_DLL_EXPORT */
    #endif /* METEE_DLL */
    #define TEEAPI METEE_DLL_API
 
    #ifndef GUID_DEFINED
        #define GUID_DEFINED 1
        typedef struct _GUID {
            uint32_t l;
            uint16_t w1;
            uint16_t w2;
            uint8_t  b[8];
        } GUID;
        #define DEFINE_GUID(name, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8) \
            const GUID name \
                = { l, w1, w2, { b1, b2,  b3,  b4,  b5,  b6,  b7,  b8 } }
    #endif /* GUID_DEFINED */
 
    #define TEE_DEVICE_HANDLE int
    #define TEE_INVALID_DEVICE_HANDLE (-1)
    #ifndef IN
        #define IN
    #endif
    #ifndef OUT
        #define OUT
    #endif
    #ifndef OPTIONAL
        #define OPTIONAL
    #endif
#endif /* _WIN32 */

enum tee_log_level {
    TEE_LOG_LEVEL_QUIET = 0,   
    TEE_LOG_LEVEL_ERROR = 1,   
    TEE_LOG_LEVEL_VERBOSE = 2, 
    TEE_LOG_LEVEL_MAX = 3,     
};

typedef void(*TeeLogCallback)(bool is_error, const char* fmt, ...);

typedef void(*TeeLogCallback2)(bool is_error, const char* msg);
 
#pragma pack(1)

typedef struct _TEEHANDLE {
 
    void    *handle;          
    size_t  maxMsgLen;        
    uint8_t protcolVer;       
    enum tee_log_level log_level; 
    TeeLogCallback log_callback; 
    TeeLogCallback2 log_callback2; 
} TEEHANDLE;

typedef TEEHANDLE *PTEEHANDLE;

struct tee_device_address {
    enum {
        TEE_DEVICE_TYPE_NONE = 0, 
        TEE_DEVICE_TYPE_PATH = 1, 
        TEE_DEVICE_TYPE_HANDLE = 2, 
        TEE_DEVICE_TYPE_GUID = 3, 
        TEE_DEVICE_TYPE_BDF = 4, 
        TEE_DEVICE_TYPE_MAX = 5, 
    } type;

    union {
        const char* path; 
        const GUID* guid; 
        TEE_DEVICE_HANDLE handle; 
        struct {
            struct {
                uint32_t segment;                     
                uint32_t bus;                         
                uint32_t device;                      
                uint32_t function;                    
            } value;
            enum HECI_HW_TYPE {
                HECI_HW_TYPE_PCH,
                HECI_HW_TYPE_GFX_GSC,
                HECI_HW_TYPE_GFX_CSC,
            } hw_type;                 
        } bdf;
    } data;
};
 
#pragma pack()

#define TEEHANDLE_ZERO {0}
 
typedef uint16_t TEESTATUS; 
#define TEE_ERROR_BASE                    0x0000U
#define TEE_SUCCESS                       (TEE_ERROR_BASE + 0)
#define TEE_INTERNAL_ERROR                (TEE_ERROR_BASE + 1)
#define TEE_DEVICE_NOT_FOUND              (TEE_ERROR_BASE + 2)
#define TEE_DEVICE_NOT_READY              (TEE_ERROR_BASE + 3)
#define TEE_INVALID_PARAMETER             (TEE_ERROR_BASE + 4)
#define TEE_UNABLE_TO_COMPLETE_OPERATION  (TEE_ERROR_BASE + 5)
#define TEE_TIMEOUT                       (TEE_ERROR_BASE + 6)
#define TEE_NOTSUPPORTED                  (TEE_ERROR_BASE + 7)
#define TEE_CLIENT_NOT_FOUND              (TEE_ERROR_BASE + 8)
#define TEE_BUSY                          (TEE_ERROR_BASE + 9)
#define TEE_DISCONNECTED                  (TEE_ERROR_BASE + 10)
#define TEE_INSUFFICIENT_BUFFER           (TEE_ERROR_BASE + 11)
#define TEE_PERMISSION_DENIED             (TEE_ERROR_BASE + 12)

#define TEE_IS_SUCCESS(Status) (((TEESTATUS)(Status)) == TEE_SUCCESS)

TEESTATUS TEEAPI TeeInitFull(IN OUT PTEEHANDLE handle, IN const GUID* guid,
    IN const struct tee_device_address device,
    IN uint32_t log_level, IN OPTIONAL TeeLogCallback log_callback);

TEESTATUS TEEAPI TeeInitFull2(IN OUT PTEEHANDLE handle, IN const GUID* guid,
    IN const struct tee_device_address device,
    IN uint32_t log_level, IN OPTIONAL TeeLogCallback2 log_callback);

TEESTATUS TEEAPI TeeInit(IN OUT PTEEHANDLE handle, IN const GUID *guid,
             IN OPTIONAL const char *device);
 
#ifdef _WIN32
TEESTATUS TEEAPI TeeInitGUID(IN OUT PTEEHANDLE handle, IN const GUID *guid,
                 IN OPTIONAL const GUID *device);
#endif /* _WIN32 */

TEESTATUS TEEAPI TeeInitHandle(IN OUT PTEEHANDLE handle, IN const GUID *guid,
                   IN const TEE_DEVICE_HANDLE device_handle);

TEESTATUS TEEAPI TeeConnect(OUT PTEEHANDLE handle);

TEESTATUS TEEAPI TeeRead(IN PTEEHANDLE handle, IN OUT void *buffer, IN size_t bufferSize,
             OUT OPTIONAL size_t *pNumOfBytesRead, IN OPTIONAL uint32_t timeout);

TEESTATUS TEEAPI TeeWrite(IN PTEEHANDLE handle, IN const void *buffer, IN size_t bufferSize,
              OUT OPTIONAL size_t *numberOfBytesWritten, IN OPTIONAL uint32_t timeout);

TEESTATUS TEEAPI TeeFWStatus(IN PTEEHANDLE handle,
                 IN uint32_t fwStatusNum, OUT uint32_t *fwStatus);

TEESTATUS TEEAPI TeeGetTRC(IN PTEEHANDLE handle, OUT uint32_t* trc_val);

void TEEAPI TeeDisconnect(IN PTEEHANDLE handle);

void TEEAPI TeeCancelIO(IN PTEEHANDLE handle);

TEE_DEVICE_HANDLE TEEAPI TeeGetDeviceHandle(IN PTEEHANDLE handle);

typedef struct {
    uint16_t major;  
    uint16_t minor;  
    uint16_t hotfix; 
    uint16_t build;  
} teeDriverVersion_t;

TEESTATUS TEEAPI GetDriverVersion(IN PTEEHANDLE handle, IN OUT teeDriverVersion_t *driverVersion);

uint32_t TEEAPI TeeSetLogLevel(IN PTEEHANDLE handle, IN uint32_t log_level);

uint32_t TEEAPI TeeGetLogLevel(IN const PTEEHANDLE handle);

TEESTATUS TEEAPI TeeSetLogCallback(IN const PTEEHANDLE handle, TeeLogCallback log_callback);

TEESTATUS TEEAPI TeeSetLogCallback2(IN const PTEEHANDLE handle, TeeLogCallback2 log_callback);

uint32_t TEEAPI TeeGetMaxMsgLen(IN const PTEEHANDLE handle);

uint8_t TEEAPI TeeGetProtocolVer(IN const PTEEHANDLE handle);
 

TEESTATUS TEEAPI TeeGetKind(IN PTEEHANDLE handle, IN OUT char *kind, IN OUT size_t *kindSize);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __METEE_H */