diff options
Diffstat (limited to 'pcilib/memcpy.h')
| -rw-r--r-- | pcilib/memcpy.h | 52 |
1 files changed, 51 insertions, 1 deletions
diff --git a/pcilib/memcpy.h b/pcilib/memcpy.h index dbfae36..99317bf 100644 --- a/pcilib/memcpy.h +++ b/pcilib/memcpy.h @@ -9,10 +9,60 @@ extern "C" { #endif +/** + * The collection of slow memcpy functions to move the data between BAR and system memory. + * + * The hardware may restrict access width or expose different behavior depending on the + * access width. These functions access memory using the specified word width only. + * 8-, 16-, 32-, and 64-bit wide access is supported. + * + * @param[out] dst - the destination memory region + * @param[in] src - the source memory region + * @param[in] access - the size of word (a single memory access) in bytes + * @param[in] n - the number of words to copy (\p n * \p access bytes are copied). + * @return - `dst` or NULL on error + */ +void *pcilib_memcpy(void * dst, void const * src, uint8_t access, size_t n); + +/** + * The collection of slow memcpy functions to move the data between BAR and system memory. + * + * The hardware may restrict access width or expose different behavior depending on the + * access width. This function only perform 8-bit memory accesses. + * + * @param[out] dst - the destination memory region + * @param[in] src - the source memory region + * @param[in] len - the number of bytes to copy + * @return - `dst` or NULL on error + */ void *pcilib_memcpy8(void * dst, void const * src, size_t len); + +/** + * The collection of slow memcpy functions to move the data between BAR and system memory. + * + * The hardware may restrict access width or expose different behavior depending on the + * access width. This function only perform 32-bit memory accesses. + * + * @param[out] dst - the destination memory region + * @param[in] src - the source memory region + * @param[in] len - the number of bytes to copy + * @return - `dst` or NULL on error + */ void *pcilib_memcpy32(void * dst, void const * src, size_t len); + + +/** + * The collection of slow memcpy functions to move the data between BAR and system memory. + * + * The hardware may restrict access width or expose different behavior depending on the + * access width. This function only perform 64-bit memory accesses. + * + * @param[out] dst - the destination memory region + * @param[in] src - the source memory region + * @param[in] len - the number of bytes to copy + * @return - `dst` or NULL on error + */ void *pcilib_memcpy64(void * dst, void const * src, size_t len); -void *pcilib_memcpy(void * dst, void const * src, uint8_t access, size_t n); #ifdef __cplusplus } |