xFSTK  0.0.0
Intel SoC Cross Platform Firmware & Software Tool Kit
Classes | Macros | Typedefs | Functions
xfstkdldrapi.h File Reference
#include "xfstk-dldr-api_global.h"
#include <iostream>
Include dependency graph for xfstkdldrapi.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  LastError
 The last error happened during download. More...
 
struct  SoCDevice
 data struct for port mapping API More...
 
struct  SoCDevices
 data struct for port info for all the devices connected to host More...
 
class  xfstkdldrapi
 This interface enables the development of Intel SoC firmware/operating system provisioning applications. This API is not re-entrant. More...
 

Macros

#define MOORESTOWN   0x1
 device type More...
 
#define MEDFIELD   0x2
 
#define CLOVERVIEW   0x3
 
#define CLOVERVIEWPLUS   0x4
 
#define MERRIFIELD   0x5
 
#define MEDFIELD_EMMC_DUMP   0x6
 
#define HASHVERIFY   0x7
 
#define MOOREFIELD   0x8
 
#define BAYTRAIL   0x9
 
#define CARBONCANYON   0xA
 
#define XFSTK_MAXDEVICE   0xB
 
#define XFSTK_NODEVICE   0x666
 
#define LOG_ACK   0x0001
 Log levels for the callback, set the bit to 1 if you want the API to log the message. More...
 
#define LOG_UPDATE   0x0002
 
#define LOG_OPCODE   0x0004
 
#define LOG_FWUPGRADE   0x0008
 
#define LOG_OS   0x0010
 
#define LOG_USB   0x0020
 
#define LOG_SOCKET   0x0040
 
#define LOG_SERIAL   0x0080
 
#define LOG_UTIL   0x0100
 
#define LOG_DOWNLOADER   0x0200
 
#define LOG_ENTRY   0x0400
 
#define LOG_STATUS   0x0800
 
#define LOG_PROGRESS   0x1000
 
#define DEBUG_ERROR   0xfffffff1
 
#define LOG_ALL   0xffffffff
 
#define MAX_ARGS   32
 
#define MAX_USBSN_LENGTH   128
 

Typedefs

typedef void(* xfstkstatuspfn) (char *status, void *)
 Represents an optional status callback function that can be provided to xfstk API to obtain status information. More...
 

Functions

XFSTKDLDRAPISHARED_EXPORT xfstkdldrapixfstkdldrapi_alloc ()
 
XFSTKDLDRAPISHARED_EXPORT void xfstkdldrapi_dealloc (xfstkdldrapi *obj)
 

Macro Definition Documentation

◆ MOORESTOWN

#define MOORESTOWN   0x1

device type

Intel SOC device type with different PID

Parameters
None
Note
None

◆ MEDFIELD

#define MEDFIELD   0x2

◆ CLOVERVIEW

#define CLOVERVIEW   0x3

◆ CLOVERVIEWPLUS

#define CLOVERVIEWPLUS   0x4

◆ MERRIFIELD

#define MERRIFIELD   0x5

◆ MEDFIELD_EMMC_DUMP

#define MEDFIELD_EMMC_DUMP   0x6

◆ HASHVERIFY

#define HASHVERIFY   0x7

◆ MOOREFIELD

#define MOOREFIELD   0x8

◆ BAYTRAIL

#define BAYTRAIL   0x9

◆ CARBONCANYON

#define CARBONCANYON   0xA

◆ XFSTK_MAXDEVICE

#define XFSTK_MAXDEVICE   0xB

◆ XFSTK_NODEVICE

#define XFSTK_NODEVICE   0x666

◆ LOG_ACK

#define LOG_ACK   0x0001

Log levels for the callback, set the bit to 1 if you want the API to log the message.

recommend at least to include LOG_STATUS and LOG_PROGRESS

Parameters
None
Note
None

◆ LOG_UPDATE

#define LOG_UPDATE   0x0002

◆ LOG_OPCODE

#define LOG_OPCODE   0x0004

◆ LOG_FWUPGRADE

#define LOG_FWUPGRADE   0x0008

◆ LOG_OS

#define LOG_OS   0x0010

◆ LOG_USB

#define LOG_USB   0x0020

◆ LOG_SOCKET

#define LOG_SOCKET   0x0040

◆ LOG_SERIAL

#define LOG_SERIAL   0x0080

◆ LOG_UTIL

#define LOG_UTIL   0x0100

◆ LOG_DOWNLOADER

#define LOG_DOWNLOADER   0x0200

◆ LOG_ENTRY

#define LOG_ENTRY   0x0400

◆ LOG_STATUS

#define LOG_STATUS   0x0800

◆ LOG_PROGRESS

#define LOG_PROGRESS   0x1000

◆ DEBUG_ERROR

#define DEBUG_ERROR   0xfffffff1

◆ LOG_ALL

#define LOG_ALL   0xffffffff

◆ MAX_ARGS

#define MAX_ARGS   32

◆ MAX_USBSN_LENGTH

#define MAX_USBSN_LENGTH   128

Typedef Documentation

◆ xfstkstatuspfn

xfstkstatuspfn

Represents an optional status callback function that can be provided to xfstk API to obtain status information.

Function Documentation

◆ xfstkdldrapi_alloc()

XFSTKDLDRAPISHARED_EXPORT xfstkdldrapi* xfstkdldrapi_alloc ( )

◆ xfstkdldrapi_dealloc()

XFSTKDLDRAPISHARED_EXPORT void xfstkdldrapi_dealloc ( xfstkdldrapi obj)