summaryrefslogtreecommitdiffstats
path: root/pcilib/views.h
blob: 33bcf4c10fc6d6fbec62de01e410cb69b5f77891 (plain)
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
#ifndef _PCILIB_VIEWS_H
#define _PCILIB_VIEWS_H

#include "pcilib.h"
#include "unit.h"

typedef struct pcilib_view_enum_s pcilib_view_enum_t;

typedef struct pcilib_view_formula_s pcilib_view_formula_t;

typedef struct pcilib_view_enum2_s pcilib_view_enum2_t;

/**
 * new type to define an enum view
 */
struct pcilib_view_enum_s {
  const char *name; /**<corresponding string to value*/
  pcilib_register_value_t value, min, max; 
};


/**
 * complete type for an enum view : name will be changed after with the previous one
 */
struct pcilib_view_enum2_s {
  const char* name;
  pcilib_view_enum_t* enums_list;
  const char* description;
};


/**
 * new type to define a formula view
 */
struct pcilib_view_formula_s {
  const char *name; /**<name of the view*/
  const char *read_formula; /**< formula to parse to read from a register*/
  const char *write_formula; /**<formula to parse to write to a register*/
	// **see it later**        const char *unit; (?)
  const char *description;
  pcilib_unit_t base_unit;
};

/**
 * function to read a register using a view
 */
int pcilib_read_view(pcilib_t *ctx, const char *bank, const char *regname, const char *unit, size_t value_size, void *value);

/**
 * function to write to a register using a view
 */
int pcilib_write_view(pcilib_t *ctx, const char *bank, const char *regname, const char *unit, size_t value_size, void *value);

int pcilib_add_views_enum(pcilib_t* ctx,size_t n, const pcilib_view_enum2_t* views);

int pcilib_add_views_formula(pcilib_t* ctx, size_t n, const pcilib_view_formula_t* views);

char* pcilib_view_str_sub(const char* s, unsigned int start, unsigned int end);

#endif