Mirrors_Framework/c-periphery
1
0
Fork 0
mirror of https://github.com/vsergeev/c-periphery.git synced 2026-02-05 22:52:35 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

mmio: add read64()/write64() apis

Browse Source
This commit is contained in:
Vanya A. Sergeev
2025-10-02 03:50:25 -05:00
parent fdffef6cb8
commit f60ce6b590
3 changed files with 26 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/mmio.md
View File

@@ -12,10 +12,12 @@ mmio_t *mmio_new(void);
int mmio_open(mmio_t *mmio, uintptr_t base, size_t size);
int mmio_open_advanced(mmio_t *mmio, uintptr_t base, size_t size, const char *path);
void *mmio_ptr(mmio_t *mmio);
int mmio_read64(mmio_t *mmio, uintptr_t offset, uint64_t *value);
int mmio_read32(mmio_t *mmio, uintptr_t offset, uint32_t *value);
int mmio_read16(mmio_t *mmio, uintptr_t offset, uint16_t *value);
int mmio_read8(mmio_t *mmio, uintptr_t offset, uint8_t *value);
int mmio_read(mmio_t *mmio, uintptr_t offset, uint8_t *buf, size_t len);
int mmio_write64(mmio_t *mmio, uintptr_t offset, uint64_t value);
int mmio_write32(mmio_t *mmio, uintptr_t offset, uint32_t value);
int mmio_write16(mmio_t *mmio, uintptr_t offset, uint16_t value);
int mmio_write8(mmio_t *mmio, uintptr_t offset, uint8_t value);
@@ -76,12 +78,13 @@ This function is a simple accessor to the MMIO handle structure and always succe
------
``` c
int mmio_read64(mmio_t *mmio, uintptr_t offset, uint64_t *value);
int mmio_read32(mmio_t *mmio, uintptr_t offset, uint32_t *value);
int mmio_read16(mmio_t *mmio, uintptr_t offset, uint16_t *value);
int mmio_read8(mmio_t *mmio, uintptr_t offset, uint8_t *value);
int mmio_read(mmio_t *mmio, uintptr_t offset, uint8_t *buf, size_t len);
```
Read 32-bits, 16-bits, 8-bits, or an array of bytes, respectively, from mapped physical memory, starting at the specified byte offset, relative to the base address the MMIO handle was opened with.
Read 64-bits, 32-bits, 16-bits, 8-bits, or an array of bytes, respectively, from mapped physical memory, starting at the specified byte offset, relative to the base address the MMIO handle was opened with.
`mmio` should be a valid pointer to an MMIO handle opened with one of the `mmio_open*()` functions.
@@ -90,12 +93,13 @@ Returns 0 on success, or a negative [MMIO error code](#return-value) on failure.
------
``` c
int mmio_write32(mmio_t *mmio, uintptr_t offset, uint64_t value);
int mmio_write32(mmio_t *mmio, uintptr_t offset, uint32_t value);
int mmio_write16(mmio_t *mmio, uintptr_t offset, uint16_t value);
int mmio_write8(mmio_t *mmio, uintptr_t offset, uint8_t value);
int mmio_write(mmio_t *mmio, uintptr_t offset, const uint8_t *buf, size_t len);
```
Write 32-bits, 16-bits, 8-bits, or an array of bytes, respectively, to mapped physical memory, starting at the specified byte offset, relative to the base address the MMIO handle was opened with.
Write 64-bits, 32-bits, 16-bits, 8-bits, or an array of bytes, respectively, to mapped physical memory, starting at the specified byte offset, relative to the base address the MMIO handle was opened with.
`mmio` should be a valid pointer to an MMIO handle opened with one of the `mmio_open*()` functions.

18
src/mmio.c
View File

@@ -98,6 +98,15 @@ void *mmio_ptr(mmio_t *mmio) {
/* WARNING: These functions may trigger a bus fault on some CPUs if an
* unaligned address is accessed! */
int mmio_read64(mmio_t *mmio, uintptr_t offset, uint64_t *value) {
offset += (mmio->base - mmio->aligned_base);
if ((offset+8) > mmio->aligned_size)
return _mmio_error(mmio, MMIO_ERROR_ARG, 0, "Offset out of bounds");
*value = *(volatile uint64_t *)(((volatile uint8_t *)mmio->ptr) + offset);
return 0;
}
int mmio_read32(mmio_t *mmio, uintptr_t offset, uint32_t *value) {
offset += (mmio->base - mmio->aligned_base);
if ((offset+4) > mmio->aligned_size)
@@ -134,6 +143,15 @@ int mmio_read(mmio_t *mmio, uintptr_t offset, uint8_t *buf, size_t len) {
return 0;
}
int mmio_write64(mmio_t *mmio, uintptr_t offset, uint64_t value) {
offset += (mmio->base - mmio->aligned_base);
if ((offset+8) > mmio->aligned_size)
return _mmio_error(mmio, MMIO_ERROR_ARG, 0, "Offset out of bounds");
*(volatile uint64_t *)(((volatile uint8_t *)mmio->ptr) + offset) = value;
return 0;
}
int mmio_write32(mmio_t *mmio, uintptr_t offset, uint32_t value) {
offset += (mmio->base - mmio->aligned_base);
if ((offset+4) > mmio->aligned_size)

2
src/mmio.h
View File

@@ -28,10 +28,12 @@ mmio_t *mmio_new(void);
int mmio_open(mmio_t *mmio, uintptr_t base, size_t size);
int mmio_open_advanced(mmio_t *mmio, uintptr_t base, size_t size, const char *path);
void *mmio_ptr(mmio_t *mmio);
int mmio_read64(mmio_t *mmio, uintptr_t offset, uint64_t *value);
int mmio_read32(mmio_t *mmio, uintptr_t offset, uint32_t *value);
int mmio_read16(mmio_t *mmio, uintptr_t offset, uint16_t *value);
int mmio_read8(mmio_t *mmio, uintptr_t offset, uint8_t *value);
int mmio_read(mmio_t *mmio, uintptr_t offset, uint8_t *buf, size_t len);
int mmio_write64(mmio_t *mmio, uintptr_t offset, uint64_t value);
int mmio_write32(mmio_t *mmio, uintptr_t offset, uint32_t value);
int mmio_write16(mmio_t *mmio, uintptr_t offset, uint16_t value);
int mmio_write8(mmio_t *mmio, uintptr_t offset, uint8_t value);