tui.h

Go to the documentation of this file.

#ifndef TUI_H_
#define TUI_H_

#include <tee_internal_api.h>

#define TEE_TUI_NUMBER_BUTTON_TYPES 6

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    TEE_TUI_HIDDEN_MODE = 0,  
    TEE_TUI_CLEAR_MODE,       
    TEE_TEMPRARY_CLEAR_MODE,  
} TEE_TUIEntryFieldMode;

typedef enum {
    TEE_TUI_NUMERICAL = 0,   
    TEE_TUI_ALPHANUMERICAL,  
} TEE_TUIEntryFieldType;

typedef enum {
    TEE_TUI_PORTRAIT = 0,  
    TEE_TUI_LANDSCAPE,     
} TEE_TUIScreenOrientation;

typedef enum {
    TEE_TUI_CORRECTION = 0,  
    TEE_TUI_OK,              
    TEE_TUI_CANCEL,          
    TEE_TUI_VALIDATE,        
    TEE_TUI_PREVIOUS,        
    TEE_TUI_NEXT             
} TEE_TUIButtonType;

typedef enum {
    TEE_TUI_NO_SOURCE = 0,  
    TEE_TUI_REF_SOURCE,     
    TEE_TUI_OBJECT_SOURCE,  
} TEE_TUIImageSource;

typedef struct {
    TEE_TUIImageSource source; 
    union {
        struct {
            void *image; 
            size_t imageLength; 
        } ref; 
        struct {
            uint32_t storageID; 
            void *objectID; 
            size_t objectIDLen; 
        } object; 
    }; 
    uint32_t width; 
    uint32_t height; 
} TEE_TUIImage;

typedef struct {
    char *text; 
    uint32_t textXOffset; 
    uint32_t textYOffset; 
    uint8_t  textColor[3]; 
    TEE_TUIImage image; 
    uint32_t imageXOffset; 
    uint32_t imageYOffset; 
} TEE_TUIScreenLabel;

typedef struct {
    char *text; 
    TEE_TUIImage image; 
} TEE_TUIButton;

typedef struct {
    TEE_TUIScreenOrientation screenOrientation; 
    TEE_TUIScreenLabel label; 
    TEE_TUIButton *buttons[6]; 
    bool requestedButtons[6]; 
} TEE_TUIScreenConfiguration;

typedef struct {
    char *buttonText; 
    uint32_t buttonWidth; 
    uint32_t buttonHeight; 
    bool buttonTextCustom; 
    bool buttonImageCustom; 
} TEE_TUIScreenButtonInfo;

typedef struct {
    uint32_t grayscaleBitsDepth; 
    uint32_t redBitsDepth; 
    uint32_t greenBitsDepth; 
    uint32_t blueBitsDepth; 
    uint32_t widthInch; 
    uint32_t heightInch; 
    uint32_t maxEntryFields; 
    uint32_t entryFieldLabelWidth; 
    uint32_t entryFieldLabelHeight; 
    uint32_t maxEntryFieldLength; 
    uint8_t  labelColor[3]; 
    uint32_t labelWidth; 
    uint32_t labelHeight; 
    TEE_TUIScreenButtonInfo buttonInfo[TEE_TUI_NUMBER_BUTTON_TYPES]; 
} TEE_TUIScreenInfo;

typedef struct {
    char *label; 
    TEE_TUIEntryFieldMode mode; 
    TEE_TUIEntryFieldType type; 
    uint32_t minExpectedLength; 
    uint32_t maxExpectedLength; 
    char *buffer; 
    size_t bufferLength; 
} TEE_TUIEntryField;

TEE_Result TEE_TUICheckTextFormat(char *text,
                                  uint32_t *width,
                                  uint32_t *height,
                                  uint32_t *lastIndex);

TEE_Result TEE_TUIGetScreenInfo(TEE_TUIScreenOrientation screenOrientation,
                                uint32_t nbEntryFields,
                                TEE_TUIScreenInfo *screenInfo);

TEE_Result TEE_TUIInitSession(void);

TEE_Result TEE_TUICloseSession(void);

TEE_Result TEE_TUIDisplayScreen(TEE_TUIScreenConfiguration *screenConfiguration,
                                bool closeTUISession,
                                TEE_TUIEntryField *entryFields,
                                uint32_t entryFieldCount,
                                TEE_TUIButtonType *selectedButton);

#ifdef __cplusplus
}
#endif

#endif /* TUI_H_ */