xfstkdldrapi.h

Go to the documentation of this file.

/*
    Copyright (C) 2015  Intel Corporation
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/
#ifndef XFSTKDLDRAPI_H
#define XFSTKDLDRAPI_H
#include "xfstk-dldr-api_global.h"
#include <iostream>
 
#define MOORESTOWN          0x1
#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
#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
 
struct LastError {
    unsigned long error_code;
    char error_message[128];
};
 
#define MAX_USBSN_LENGTH 128
 
struct SoCDevice {
    char usbsn[MAX_USBSN_LENGTH];
    unsigned long root_hub;
    unsigned long port[5];
 
};
 
struct SoCDevices {
    int number_devices;
    SoCDevice soc_device[32];
};
 
#ifdef XFSTK_OS_WIN
typedef struct DevicesCallBack
{
    SoCDevices* device;
    void (*attach)(void* data);
    void (*detach)(void* data);
    void * clientdata;
}DevicesCallBack;
#endif
 
typedef void(*xfstkstatuspfn)(char* status, void *);
class XFSTKDLDRAPISHARED_EXPORT xfstkdldrapi {
public:
 
    xfstkdldrapi();
 
    virtual ~xfstkdldrapi();
        
    virtual bool idrqresponse(unsigned char *buffer, int maxsize);
 
    virtual bool downloadcli(const char *cli, const char* usbsn = NULL);
 
    virtual bool downloadfw(char *fwfile);
 
    virtual bool hashverify(char *hashfile, bool write);
 
    virtual void setResponsebuffer(unsigned char* responseBuffer, int& maxsize);
 
    virtual bool downloadcsdb(char *fwdnx, char *miscbin, char *cmdcode,char *fwimage, bool direct );
 
    virtual bool downloadfw(char *fwdnx, char *fwimage, char *gpflags);
 
    virtual bool downloados(char *osdnx, char *osimage, char *gpflags);
 
    virtual bool downloadfwos(char *fwdnx, char *fwimage, char *osdnx, char* osimage, char* gpflags);
 
    virtual bool downloadfwos(char *fwdnx, char *fwimage, char *osdnx, char* osimage, char* gpflags, char* softfuse);
 
    virtual bool downloadmtfwosasync(char *fwdnx, char *fwimage, char *osdnx, char* osimage, char* gpflags, char* usbsn);
 
    virtual bool downloadmtfwosasync(char *fwdnx, char *fwimage, char *osdnx, char* osimage, char* gpflags, char* usbsn, char* softfuse);
 
    virtual bool registerstatuscallback(xfstkstatuspfn statuspfn, void *clientdata);
 
    virtual void settargetretrycount(int retries);
 
    virtual void setloglevel(unsigned long loglevel);
 
    virtual void setsoftfusepath(bool include, char * softfuse);
 
    virtual void setmiscdnxpath(bool enable, char * miscdnx);
 
    virtual int getavailabletargets();
 
    virtual int getavailabletargets(unsigned long devicetype);
 
    virtual int getavailabletargets(SoCDevices * socdevices);
 
#ifdef XFSTK_OS_WIN
 
    virtual bool registerdevicecallback(DevicesCallBack* callBackStruct, unsigned long ProductId=0);
#endif
 
    virtual void usbdevicemutexlock();
 
    virtual void usbdevicemutexunlock();
 
    virtual void getversion(char* version);
 
    virtual std::string getfullversion(void) const;
 
    virtual bool getlasterror(LastError* er);
 
    virtual void setusbreadwritedelay(unsigned long delayms);
 
    virtual void setwipeifwi(bool enable);
 
private:
    xfstkstatuspfn physstatuspfn;
    void *physclientdata;
    void *xfstkfactoryhandle;
        bool binterfaceavailable;
    bool binterfaceclaimed;
    bool interfaceavailable();
    bool claiminterface();
    void releaseinterface();
    void findusbtargets();
    char* miscdnx;
    bool miscdnxenable;
    char* softfuse;
    bool softfuseinclude;
    int retrycount;
    void xfstklogmessage(char *message, void *clientdata);
    void xfstkmultitargetstatuscallback(char *message, void *clientdata);
    void showversion(void);
 
        xfstkdldrapi( const xfstkdldrapi& );
        xfstkdldrapi& operator=( const xfstkdldrapi& );
};
 
extern "C" {
        XFSTKDLDRAPISHARED_EXPORT xfstkdldrapi* xfstkdldrapi_alloc();
        XFSTKDLDRAPISHARED_EXPORT void  xfstkdldrapi_dealloc(xfstkdldrapi* obj);
}
#endif // XFSTKDLDRAPI_H