devmemlib/libdevmem.h at master · pavel-a/devmemlib · 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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/**
* Library for physical memory access like in devmem
* 32-bit physical address version
*
* pa03b 16-may-2016
*/

#ifndef libdevmem_h_
#define libdevmem_h_

#include <stdint.h>
#include <stdio.h> /* for debug prints to FILE */


typedef uint32_t dmem_phys_address_t;
typedef uint32_t dmem_mapping_size_t;

struct dmem_mapping_s {
    unsigned flags;               // in out dmem_mapping_flags
    dmem_phys_address_t map_addr; // in
    dmem_mapping_size_t map_size; // in
    char * const map_ptr;         // out  !use with volatile!
    intptr_t reserved[10];
};

enum dmem_mapping_flags {
    MF_ABSOLUTE = 0x01, // Absolute physical address, not offset
    MF_READONLY = 0x02,
};

typedef struct dmem_mapping_s *dmem_mapping_hnd_t;

#ifdef __cplusplus
extern "C" {
#endif

// Initialize:
// int dmem_init(void);
int dmem__init_(int addrsize, int mapsize, void *reserved);
#define dmem_init() \
        dmem__init_(sizeof(dmem_phys_address_t), sizeof(dmem_mapping_size_t), 0)

// Map:
// @param[in] params - struct dmem_mapping_s, caller fills in required fields
// @return error code
int dmem_mapping_map(struct dmem_mapping_s *params);


// Get mapped virtual address from offset
// @param[in] dp     - dmem_mapping_s, after successfull dmem_mapping_map()
// @param[in] off    - offset from mapped memory base address
// @param[in] size   - size of requested memory area
// @return pointer into the mapped memory, or NULL if offset+size > mapping size
//          or the virtual address in dp is NULL (not mapped yet?)
void *dmem_get_pointer(dmem_mapping_hnd_t dp, dmem_mapping_size_t off, uint32_t size);

// Unmap:
// @param[in] dp - struct dmem_mapping_s, after successfull dmem_mapping_map()
// @return error code
int dmem_mapping_unmap(struct dmem_mapping_s *dp);

// Call this last
int dmem_finalize(void);

// Support stuff...
int dmem_set_debug(int flags, FILE *to);
int dmem_get_version(void);
int dmem_print_version(void); // print library version via debug print

#ifndef LIBDEVMEM_NO_EXTRAS
// I/O ops with validation, using the param struct:

void      dmem_write32(dmem_mapping_hnd_t dp, dmem_mapping_size_t off, uint32_t v);
uint32_t  dmem_read32(dmem_mapping_hnd_t dp,  dmem_mapping_size_t off);
void      dmem_write16(dmem_mapping_hnd_t dp, dmem_mapping_size_t off, uint16_t v);
uint16_t  dmem_read16(dmem_mapping_hnd_t dp,  dmem_mapping_size_t off);
void      dmem_write8(dmem_mapping_hnd_t dp,  dmem_mapping_size_t off, uint8_t v);
uint8_t   dmem_read8(dmem_mapping_hnd_t dp,   dmem_mapping_size_t off);

void      dmem_write_buf32(dmem_mapping_hnd_t dp, const uint32_t *buf, dmem_mapping_size_t off, unsigned cnt);
void      dmem_read_buf32(dmem_mapping_hnd_t dp,        uint32_t *buf, dmem_mapping_size_t off, unsigned cnt);
void      dmem_write_buf16(dmem_mapping_hnd_t dp, const uint16_t *buf, dmem_mapping_size_t off, unsigned cnt);
void      dmem_read_buf16(dmem_mapping_hnd_t dp,        uint16_t *buf, dmem_mapping_size_t off, unsigned cnt);
void      dmem_write_buf8(dmem_mapping_hnd_t dp,  const uint8_t  *buf, dmem_mapping_size_t off, unsigned cnt);
void      dmem_read_buf8(dmem_mapping_hnd_t dp,         uint8_t  *buf, dmem_mapping_size_t off, unsigned cnt);

void      dmem_fill_buf32(dmem_mapping_hnd_t dp, dmem_mapping_size_t off, unsigned cnt, uint32_t v);
void      dmem_fill_buf16(dmem_mapping_hnd_t dp, dmem_mapping_size_t off, unsigned cnt, uint16_t v);
void      dmem_fill_buf8(dmem_mapping_hnd_t dp,  dmem_mapping_size_t off, unsigned cnt, uint8_t v);

// Fast I/O ops via pointer
// Pointers can be obtained from dmem_get_pointer()
void      dmem_write32p(void *mp, uint32_t v);
void      dmem_write16p(void *mp, uint16_t v);
void      dmem_write8p( void *mp, uint8_t v);
uint32_t  dmem_read32p( void *mp);
uint16_t  dmem_read16p( void *mp);
uint8_t   dmem_read8p(  void *mp);

void      dmem_write_buf32p(void *mp, const uint32_t *buf, unsigned cnt);
void      dmem_read_buf32p( void *mp,       uint32_t *buf, unsigned cnt);
void      dmem_write_buf16p(void *mp, const uint16_t *buf, unsigned cnt);
void      dmem_read_buf16p( void *mp,       uint16_t *buf, unsigned cnt);
void      dmem_write_buf8p( void *mp, const uint8_t  *buf, unsigned cnt);
void      dmem_read_buf8p(  void *mp,       uint8_t  *buf, unsigned cnt);

void      dmem_fill_buf32p(void *mp, unsigned cnt, uint32_t v);
void      dmem_fill_buf16p(void *mp, unsigned cnt, uint16_t v);
void      dmem_fill_buf8p(void *mp,  unsigned cnt, uint8_t v);
#endif //LIBDEVMEM_NO_EXTRAS

#ifdef __cplusplus
}
#endif

#endif /* libdevmem_h_ */