C++ class to access CSE/CSME/GSC firmware via a mei interface.
More...
#include <meteepp.h>
C++ class to access CSE/CSME/GSC firmware via a mei interface.
Main interface class
Definition at line 84 of file meteepp.h.
◆ metee() [1/5]
intel::security::metee::metee |
( |
| ) |
|
|
inline |
Default constructor
Definition at line 88 of file meteepp.h.
◆ metee() [2/5]
Constructor
- Parameters
-
guid | GUID of the FW client that want to start a session |
log_level | log level to set (from enum tee_log_level) |
log_callback | pointer to function to run for log write, set NULL to use built-in function |
Definition at line 101 of file meteepp.h.
◆ metee() [3/5]
Constructor
- Parameters
-
guid | GUID of the FW client that want to start a session |
device | device address structure |
log_level | log level to set (from enum tee_log_level) |
log_callback | pointer to function to run for log write, set NULL to use built-in function |
Definition at line 117 of file meteepp.h.
◆ metee() [4/5]
intel::security::metee::metee |
( |
const metee & | other | ) |
|
|
delete |
Copy constructor - disabled
◆ metee() [5/5]
intel::security::metee::metee |
( |
metee && | other | ) |
|
|
inlinenoexcept |
Move constructor
- Parameters
-
Definition at line 132 of file meteepp.h.
◆ ~metee()
virtual intel::security::metee::~metee |
( |
| ) |
|
|
inlinevirtual |
Destructor, disconnects, if connected
Definition at line 152 of file meteepp.h.
◆ connect()
void intel::security::metee::connect |
( |
| ) |
|
|
inline |
Connects to the TEE driver and starts a session
Definition at line 158 of file meteepp.h.
◆ device_handle()
TEE_DEVICE_HANDLE intel::security::metee::device_handle |
( |
| ) |
|
|
inline |
Returns handle of TEE device Obtains HECI device handle on Windows and mei device file descriptor on Linux
- Returns
- the handle of the session.
Definition at line 305 of file meteepp.h.
◆ driver_version()
std::string intel::security::metee::driver_version |
( |
| ) |
|
|
inline |
Obtains version of the TEE device driver Not implemented on Linux
- Returns
- Driver version as dotted string.
Definition at line 314 of file meteepp.h.
◆ fw_status()
uint32_t intel::security::metee::fw_status |
( |
uint32_t | fwStatusNum | ) |
|
|
inline |
Retrieves specified FW status register.
- Parameters
-
fwStatusNum | The FW status register number (0-5). |
- Returns
- obtained FW status.
Definition at line 209 of file meteepp.h.
◆ kind()
std::string intel::security::metee::kind |
( |
| ) |
|
|
inline |
Retrieves device kind.
- Returns
- kind string value.
Definition at line 241 of file meteepp.h.
◆ log_callback()
void intel::security::metee::log_callback |
( |
TeeLogCallback | log_callback | ) |
|
|
inline |
Set log callback
- Parameters
-
log_callback | pointer to function to run for log write, set NULL to use built-in function |
Definition at line 278 of file meteepp.h.
◆ log_level() [1/2]
uint32_t intel::security::metee::log_level |
( |
| ) |
|
|
inline |
Retrieve current log level
- Returns
- current log level
Definition at line 269 of file meteepp.h.
◆ log_level() [2/2]
uint32_t intel::security::metee::log_level |
( |
uint32_t | log_level | ) |
|
|
inline |
Set log level
- Parameters
-
log_level | log level to set |
- Returns
- previous log level
Definition at line 260 of file meteepp.h.
◆ max_msg_len()
uint32_t intel::security::metee::max_msg_len |
( |
| ) |
|
|
inline |
Retrieve client maximum message length (MTU)
- Returns
- client maximum message length.
Definition at line 287 of file meteepp.h.
◆ operator=() [1/2]
metee & intel::security::metee::operator= |
( |
const metee & | other | ) |
|
|
delete |
◆ operator=() [2/2]
metee & intel::security::metee::operator= |
( |
metee && | other | ) |
|
|
inlinenoexcept |
Move operator
- Parameters
-
Definition at line 143 of file meteepp.h.
◆ protocol_ver()
uint8_t intel::security::metee::protocol_ver |
( |
| ) |
|
|
inline |
Retrieve client protocol version
- Returns
- client protocol version.
Definition at line 296 of file meteepp.h.
◆ read()
std::vector< uint8_t > intel::security::metee::read |
( |
uint32_t | timeout | ) |
|
|
inline |
Read data from the TEE device synchronously.
- Parameters
-
timeout | The timeout to complete read in milliseconds, zero for infinite |
- Returns
- vector with data read from the TEE device
Definition at line 172 of file meteepp.h.
◆ trc()
uint32_t intel::security::metee::trc |
( |
| ) |
|
|
inline |
Retrieves TRC register.
- Returns
- TRC value.
Definition at line 225 of file meteepp.h.
◆ write()
size_t intel::security::metee::write |
( |
const std::vector< uint8_t > & | buffer, |
|
|
uint32_t | timeout ) |
|
inline |
Writes the specified buffer to the TEE device synchronously.
- Parameters
-
buffer | vector containing the data to be written to the TEE device. |
timeout | The timeout to complete write in milliseconds, zero for infinite |
- Returns
- the number of bytes written
Definition at line 192 of file meteepp.h.
The documentation for this class was generated from the following file: