Samsung Internal API reference  2.0
tui.h File Reference

The Trusted User Interface API permits the display of screens to the user and achieves three objectives: More...

Go to the source code of this file.

Data Structures

struct  TEE_TUIImage
 Structure that defines a way to handle an image for label area and buttons. More...
 
struct  TEE_TUIScreenLabel
 Structure that defines the contents of the TA defined label area, which is provided to support TA branding and a TA defined message. More...
 
struct  TEE_TUIButton
 Structure that defines the content of a button. More...
 
struct  TEE_TUIScreenConfiguration
 Structure that enables configuration of a TUI screen. More...
 
struct  TEE_TUIScreenButtonInfo
 Structure that represents button information associated with a TUI screen for a given orientation. More...
 
struct  TEE_TUIScreenInfo
 Structure that represents screen information for a given orientation. More...
 
struct  TEE_TUIEntryField
 Structure that represents an entry field which acquires user inputs. More...
 
union  TEE_TUIImage.__unnamed__
 
struct  TEE_TUIImage.__unnamed__.ref
 
struct  TEE_TUIImage.__unnamed__.object
 

Macros

#define TEE_TUI_NUMBER_BUTTON_TYPES   6
 

Enumerations

enum  TEE_TUIEntryFieldMode { TEE_TUI_HIDDEN_MODE = 0, TEE_TUI_CLEAR_MODE, TEE_TEMPRARY_CLEAR_MODE }
 Entry fields mode. More...
 
enum  TEE_TUIEntryFieldType { TEE_TUI_NUMERICAL = 0, TEE_TUI_ALPHANUMERICAL }
 Entry fields type. More...
 
enum  TEE_TUIScreenOrientation { TEE_TUI_PORTRAIT = 0, TEE_TUI_LANDSCAPE }
 Screen orientation. More...
 
enum  TEE_TUIButtonType {
  TEE_TUI_CORRECTION = 0, TEE_TUI_OK, TEE_TUI_CANCEL, TEE_TUI_VALIDATE,
  TEE_TUI_PREVIOUS, TEE_TUI_NEXT
}
 Button type. More...
 
enum  TEE_TUIImageSource { TEE_TUI_NO_SOURCE = 0, TEE_TUI_REF_SOURCE, TEE_TUI_OBJECT_SOURCE }
 Image source. More...
 

Functions

TEE_Result TEE_TUICheckTextFormat (char *text, uint32_t *width, uint32_t *height, uint32_t *lastIndex)
 Check whether a given text can be rendered and retrieves information. More...
 
TEE_Result TEE_TUIGetScreenInfo (TEE_TUIScreenOrientation screenOrientation, uint32_t nbEntryFields, TEE_TUIScreenInfo *screenInfo)
 Retrieves information about the screen. More...
 
TEE_Result TEE_TUIInitSession (void)
 Claims an exclusive access to TUI resources. More...
 
TEE_Result TEE_TUICloseSession (void)
 Releases TUI resources. More...
 
TEE_Result TEE_TUIDisplayScreen (TEE_TUIScreenConfiguration *screenConfiguration, bool closeTUISession, TEE_TUIEntryField *entryFields, uint32_t entryFieldCount, TEE_TUIButtonType *selectedButton)
 Displays a TUI screen. More...
 

Detailed Description

The Trusted User Interface API permits the display of screens to the user and achieves three objectives:

  • Secure Display – Information displayed to the user cannot be accessed, modified, or obscured by any software within the REE or by an unauthorized application in the TEE.
  • Secure Input – Information entered by the user cannot be derived or modified by any software within the REE or by an unauthorized application in the TEE.
  • Secure Indicator – The user can be confident that the screen displayed is actually a screen displayed by a TA.