Intel

Developer Zone

Host Interface CSharp

For developing your Windows*-based Intel® Host Interface Service to communicate with your Windows* host application.

Enumerations

enum   JHI_COMMUNICATION_TYPE { JHI_COMMUNICATION_TYPE.JHI_SOCKETS = 0, JHI_COMMUNICATION_TYPE.JHI_HECI = 1 }
  This enum lists the communication types that are used by JHI in order to communicate with the firmware.
 
enum   JHI_ERROR_CODE: uint {
  JHI_ERROR_CODE.JHI_SUCCESS = 0x00, JHI_ERROR_CODE.JHI_INVALID_HANDLE = 0x201, JHI_ERROR_CODE.JHI_INVALID_PARAMS = 0x203, JHI_ERROR_CODE.JHI_INVALID_APPLET_GUID = 0x204,
  JHI_ERROR_CODE.JHI_SERVICE_UNAVAILABLE = 0x301, JHI_ERROR_CODE.JHI_ERROR_REGISTRY = 0x501, JHI_ERROR_CODE.JHI_ERROR_REPOSITORY_NOT_FOUND = 0x1000, JHI_ERROR_CODE.JHI_INTERNAL_ERROR = 0x601,
  JHI_ERROR_CODE.JHI_INVALID_BUFFER_SIZE = 0x1001, JHI_ERROR_CODE.JHI_INVALID_COMM_BUFFER = 0x1002, JHI_ERROR_CODE.JHI_INVALID_INSTALL_FILE = 0x1003, JHI_ERROR_CODE.JHI_READ_FROM_FILE_FAILED = 0x1004,
  JHI_ERROR_CODE.JHI_INVALID_PACKAGE_FORMAT = 0x1005, JHI_ERROR_CODE.JHI_FILE_ERROR_COPY = 0x103, JHI_ERROR_CODE.JHI_INVALID_INIT_BUFFER = 0x1006, JHI_ERROR_CODE.JHI_FILE_NOT_FOUND = 0x101,
  JHI_ERROR_CODE.JHI_INVALID_FILE_EXTENSION = 0x1007, JHI_ERROR_CODE.JHI_MAX_INSTALLED_APPLETS_REACHED = 0x404, JHI_ERROR_CODE.JHI_INSTALL_FAILURE_SESSIONS_EXISTS = 0x1008, JHI_ERROR_CODE.JHI_INSTALL_FAILED = 0x1009,
  JHI_ERROR_CODE.JHI_DELETE_FROM_REPOSITORY_FAILURE = 0x104, JHI_ERROR_CODE.JHI_UNINSTALL_FAILURE_SESSIONS_EXISTS = 0x100A, JHI_ERROR_CODE.JHI_APPLET_NOT_INSTALLED = 0x402, JHI_ERROR_CODE.JHI_MAX_SESSIONS_REACHED = 0x100C,
 JHI_ERROR_CODE.JHI_SHARED_SESSION_NOT_SUPPORTED = 0x100D, JHI_ERROR_CODE.JHI_MAX_SHARED_SESSION_REACHED = 0x100E, JHI_ERROR_CODE.JHI_INVALID_SESSION_HANDLE = 0x100F, JHI_ERROR_CODE.JHI_INSUFFICIENT_BUFFER = 0x200,
  JHI_ERROR_CODE.JHI_APPLET_FATAL = 0x400, JHI_ERROR_CODE.JHI_SESSION_NOT_REGISTERED = 0x1010, JHI_ERROR_CODE.JHI_SESSION_ALREADY_REGSITERED = 0x1011, JHI_ERROR_CODE.JHI_EVENTS_NOT_SUPPORTED = 0x1012,
  JHI_ERROR_CODE.JHI_APPLET_PROPERTY_NOT_SUPPORTED = 0x1013, JHI_ERROR_CODE.JHI_SPOOLER_NOT_FOUND = 0x1014, JHI_ERROR_CODE.JHI_INVALID_SPOOLER = 0x1015, JHI_ERROR_CODE.JHI_NO_CONNECTION_TO_FIRMWARE = 0x300,
  JHI_ERROR_CODE.JHI_VM_DLL_FILE_NOT_FOUND = 0x1016, JHI_ERROR_CODE.JHI_VM_DLL_VERIFY_FAILED = 0x1017
}
  JHI 8.0 return codes
 
enum   JHI_EVENT_DATA_TYPE { JHI_EVENT_DATA_TYPE.JHI_DATA_FROM_APPLET = 0, JHI_EVENT_DATA_TYPE.JHI_DATA_FROM_SERVICE = 1 }
  This enum lists the types of data received by the JHI event.
 
enum   JHI_PLATFROM_ID { JHI_PLATFROM_ID.ME = 0, JHI_PLATFROM_ID.VLV = 1, JHI_PLATFROM_ID.INVALID_PLATFORM_ID = 3 }
  This enum lists the platfom types that are supported by JHI.
 
enum   JHI_SESSION_FLAGS { JHI_SESSION_FLAGS.None = 0, JHI_SESSION_FLAGS.SharedSession = 1 }
  This enum lists the flags used when creating a session.
 
enum   JHI_SESSION_STATE { JHI_SESSION_STATE.JHI_SESSION_STATE_ACTIVE = 0, JHI_SESSION_STATE.JHI_SESSION_STATE_NOT_EXISTS = 1 }
  This enum lists the states of a session.
 

Functions

delegate void  JHI_CallbackFunction (JhiSession SessionHandle, JHI_EVENT_DATA event_data)
  This is the format for a callback function that is used in order to receive session events.
 

Enumeration Type Documentation

 

enum Intel.Dal.JHI_COMMUNICATION_TYPE

This enum lists the communication types that are used by JHI in order to communicate with the firmware.

Enumerator
JHI_SOCKETS

communication by sockets

JHI_HECI

communication by HECI

 

enum Intel.Dal.JHI_ERROR_CODE : uint

JHI 8.0 return codes

Enumerator
JHI_SUCCESS

general success response

JHI_INVALID_HANDLE

invalid JHI handle

JHI_INVALID_PARAMS

passed a null pointer to a required argument / illegal arguments passed to API function

JHI_INVALID_APPLET_GUID

the applet UUID is invalid

JHI_SERVICE_UNAVAILABLE

there is no connection to JHI service

JHI_ERROR_REGISTRY

error for any registry based access or registry corruption

JHI_ERROR_REPOSITORY_NOT_FOUND

cannot find applets repository directory

JHI_INTERNAL_ERROR

an unexpected internal error happened

JHI_INVALID_BUFFER_SIZE

used a buffer that is larger than JHI_BUFFER_MAX

JHI_INVALID_COMM_BUFFER

JVM_COMM_BUFFER passed to function is invalid

JHI_INVALID_INSTALL_FILE

the dalp file path is invalid

JHI_READ_FROM_FILE_FAILED

failed to read DALP file

JHI_INVALID_PACKAGE_FORMAT

dalp file format is not a valid

JHI_FILE_ERROR_COPY

applet file could not be copied to repository

JHI_INVALID_INIT_BUFFER

passed an invalid init buffer to the function

JHI_FILE_NOT_FOUND

could not find the specified dalp file

JHI_INVALID_FILE_EXTENSION

applets package file must end with .dalp extension

JHI_MAX_INSTALLED_APPLETS_REACHED

exceeds max applets allowed, need to uninstall an applet

JHI_INSTALL_FAILURE_SESSIONS_EXISTS

could not install because there are open sessions

JHI_INSTALL_FAILED

no compatible applet was found in the DALP file

JHI_DELETE_FROM_REPOSITORY_FAILURE

unable to delete applet DALP file from repository

JHI_UNINSTALL_FAILURE_SESSIONS_EXISTS

for app uninstallation errors

JHI_APPLET_NOT_INSTALLED

trying to create a session of uninstalled applet

JHI_MAX_SESSIONS_REACHED

exceeds max sessions allowed, need to close a session

JHI_SHARED_SESSION_NOT_SUPPORTED

the applet does not support shared sessions

JHI_MAX_SHARED_SESSION_REACHED

failed to get session handle due to maximun handles limit

JHI_INVALID_SESSION_HANDLE

the session handle is not of an active session

JHI_INSUFFICIENT_BUFFER

buffer overflow - response greater than supplied Rx buffer

JHI_APPLET_FATAL

This may be a result of uncaught exception or unusual applet error that results in applet being terminated by TL VM.

JHI_SESSION_NOT_REGISTERED

trying to unregister a session that is not registered for events

JHI_SESSION_ALREADY_REGSITERED

Registration to an event is done only once

JHI_EVENTS_NOT_SUPPORTED

events are not supported for this type of session

JHI_APPLET_PROPERTY_NOT_SUPPORTED

Rerturned when calling GetAppletProperty with invalid property

JHI_SPOOLER_NOT_FOUND

cannot find the spooler file

JHI_INVALID_SPOOLER

cannot download spooler / create an instance of the spooler

JHI_NO_CONNECTION_TO_FIRMWARE

JHI has no connection to the VM

JHI_VM_DLL_FILE_NOT_FOUND

VM DLL is missing from the exe path

JHI_VM_DLL_VERIFY_FAILED

DLL Signature or Publisher name are not valid

 

enum Intel.Dal.JHI_EVENT_DATA_TYPE>

This enum lists the types of data received by the JHI event.

Enumerator
JHI_DATA_FROM_APPLET

the event raised by an applet session

JHI_DATA_FROM_SERVICE

the event raised by JHI service

 

enum Intel.Dal.JHI_PLATFROM_ID

This enum lists the platfom types that are supported by JHI.

Enumerator
ME

Intel(R) Management Engine (Intel(R) ME)

VLV

VLV

INVALID_PLATFORM_ID

invalid platform

 

enum Intel.Dal.JHI_SESSION_FLAGS

This enum lists the flags used when creating a session.

Enumerator
None

no flags to be used

SharedSession

create a shared session, or receive a handle for an existing shared session

 

enum Intel.Dal.JHI_SESSION_STATE

This enum lists the states of a session.

Enumerator
JHI_SESSION_STATE_ACTIVE

the session is active

JHI_SESSION_STATE_NOT_EXISTS

the session does not exists

Function Documentation

 

delegate void Intel.Dal.JHI_CallbackFunction ( JhiSession  SessionHandle,
    JHI_EVENT_DATA  event_data
  )    

This is the format for a callback function that is used in order to receive session events.

Parameters
SessionHandle a handle for the session raised the event
event_data the event data