faV3/faV3FirmwareTools.h at master · JeffersonLab/faV3 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
#pragma once

#include <stdint.h>
#include "jvme.h"

/* FAV3DC Firmware Tools Prototypes */
int32_t faV3FirmwareWaitForReady(int32_t id, int32_t nwait, int32_t pflag);
uint32_t faV3FirmwareRomID(int32_t id);
uint32_t faV3FirmwareRomStatus1(int32_t id);
uint32_t faV3FirmwareSetMemoryWrite(int32_t id, int32_t enable);
int32_t  faV3FirmwareRomErase(int32_t id, int32_t waitforWIP);
int32_t  faV3FirmwareReadRomAdr(int32_t id, uint32_t romadr, int32_t last);
int32_t  faV3FirmwareWriteRomAdr(int32_t id, uint32_t romadr, uint32_t romdata, int32_t last);
int32_t  faV3FirmwareDownloadRom(int32_t id, int32_t size);
int32_t  faV3FirmwareProgramRom(int32_t id);
int32_t  faV3FirmwareVerifyDownload();

int32_t faV3FirmwareReboot(int32_t id);
int32_t faV3FirmwareWaitForReboot(int32_t id, int32_t nwait, int32_t pflag);

int32_t faV3FirmwarePassedMask();
int32_t faV3FirmwareLoad(int32_t id, int32_t pFlag);
int32_t faV3FirmwareDownload(int32_t id, int32_t pFlag);
int32_t faV3FirmwareVerify(int32_t id, int32_t pFlag);
int32_t faV3FirmwareDone(int32_t pFlag);
int32_t faV3FirmwareGLoad(int32_t pFlag, int32_t force);
int32_t faV3FirmwareReadFile(char *filename);
int32_t faV3FirmwareWriteFile(char *filename);
int32_t faV3FirmwareReadMcsFile(char *filename);

enum faV3Args_enum
  {
    FAV3_ARGS_SHOW_ID,
    FAV3_ARGS_SHOW_PROGRESS,
    FAV3_ARGS_SHOW_DONE,
    FAV3_ARGS_SHOW_STRING,
    FAV3_ARGS_LAST
  };

enum faV3UpdateSteps_enum
  {
    FAV3_UPDATE_STEP_INIT,
    FAV3_UPDATE_STEP_ERASE,
    FAV3_UPDATE_STEP_PROGRAM,
    FAV3_UPDATE_STEP_DOWNLOAD,
    FAV3_UPDATE_STEP_VERIFY,
    FAV3_UPDATE_STEP_REBOOT,
    FAV3_UPDATE_STEP_LAST
  };

typedef struct faV3UpdateWatcherArgs_struct
{
  int32_t step;			/* 0: init
				   1: erase rom
				   2: program rom
				   3: download data from rom
				   4: verify data with file
				   5: reboot fpga */
  int show; /* 0: show id,
	       1: show progress,
	       2: show complete
	    */
  int32_t id;			/* slot id */
  char title[80];
} faV3UpdateWatcherArgs_t;
int32_t faV3FirmwareAttachUpdateWatcher(VOIDFUNCPTR routine,
				    faV3UpdateWatcherArgs_t arg);
void faV3FirmwareUpdateWatcher(faV3UpdateWatcherArgs_t arg);