1b2ef9f5aSRalph Campbell /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2b2ef9f5aSRalph Campbell /* 3b2ef9f5aSRalph Campbell * This is a module to test the HMM (Heterogeneous Memory Management) API 4b2ef9f5aSRalph Campbell * of the kernel. It allows a userspace program to expose its entire address 5b2ef9f5aSRalph Campbell * space through the HMM test module device file. 6b2ef9f5aSRalph Campbell */ 7b2ef9f5aSRalph Campbell #ifndef _LIB_TEST_HMM_UAPI_H 8b2ef9f5aSRalph Campbell #define _LIB_TEST_HMM_UAPI_H 9b2ef9f5aSRalph Campbell 10b2ef9f5aSRalph Campbell #include <linux/types.h> 11b2ef9f5aSRalph Campbell #include <linux/ioctl.h> 12b2ef9f5aSRalph Campbell 13b2ef9f5aSRalph Campbell /* 14b2ef9f5aSRalph Campbell * Structure to pass to the HMM test driver to mimic a device accessing 15b2ef9f5aSRalph Campbell * system memory and ZONE_DEVICE private memory through device page tables. 16b2ef9f5aSRalph Campbell * 17b2ef9f5aSRalph Campbell * @addr: (in) user address the device will read/write 18b2ef9f5aSRalph Campbell * @ptr: (in) user address where device data is copied to/from 19b2ef9f5aSRalph Campbell * @npages: (in) number of pages to read/write 20b2ef9f5aSRalph Campbell * @cpages: (out) number of pages copied 21b2ef9f5aSRalph Campbell * @faults: (out) number of device page faults seen 22b2ef9f5aSRalph Campbell */ 23b2ef9f5aSRalph Campbell struct hmm_dmirror_cmd { 24b2ef9f5aSRalph Campbell __u64 addr; 25b2ef9f5aSRalph Campbell __u64 ptr; 26b2ef9f5aSRalph Campbell __u64 npages; 27b2ef9f5aSRalph Campbell __u64 cpages; 28b2ef9f5aSRalph Campbell __u64 faults; 29b2ef9f5aSRalph Campbell }; 30b2ef9f5aSRalph Campbell 31b2ef9f5aSRalph Campbell /* Expose the address space of the calling process through hmm device file */ 32b2ef9f5aSRalph Campbell #define HMM_DMIRROR_READ _IOWR('H', 0x00, struct hmm_dmirror_cmd) 33b2ef9f5aSRalph Campbell #define HMM_DMIRROR_WRITE _IOWR('H', 0x01, struct hmm_dmirror_cmd) 34*188f4826SAlex Sierra #define HMM_DMIRROR_MIGRATE_TO_DEV _IOWR('H', 0x02, struct hmm_dmirror_cmd) 35*188f4826SAlex Sierra #define HMM_DMIRROR_MIGRATE_TO_SYS _IOWR('H', 0x03, struct hmm_dmirror_cmd) 36*188f4826SAlex Sierra #define HMM_DMIRROR_SNAPSHOT _IOWR('H', 0x04, struct hmm_dmirror_cmd) 37*188f4826SAlex Sierra #define HMM_DMIRROR_EXCLUSIVE _IOWR('H', 0x05, struct hmm_dmirror_cmd) 38*188f4826SAlex Sierra #define HMM_DMIRROR_CHECK_EXCLUSIVE _IOWR('H', 0x06, struct hmm_dmirror_cmd) 39b2ef9f5aSRalph Campbell 40b2ef9f5aSRalph Campbell /* 41b2ef9f5aSRalph Campbell * Values returned in hmm_dmirror_cmd.ptr for HMM_DMIRROR_SNAPSHOT. 42b2ef9f5aSRalph Campbell * HMM_DMIRROR_PROT_ERROR: no valid mirror PTE for this page 43b2ef9f5aSRalph Campbell * HMM_DMIRROR_PROT_NONE: unpopulated PTE or PTE with no access 44b2ef9f5aSRalph Campbell * HMM_DMIRROR_PROT_READ: read-only PTE 45b2ef9f5aSRalph Campbell * HMM_DMIRROR_PROT_WRITE: read/write PTE 46e478425bSRalph Campbell * HMM_DMIRROR_PROT_PMD: PMD sized page is fully mapped by same permissions 47e478425bSRalph Campbell * HMM_DMIRROR_PROT_PUD: PUD sized page is fully mapped by same permissions 48b2ef9f5aSRalph Campbell * HMM_DMIRROR_PROT_ZERO: special read-only zero page 49b2ef9f5aSRalph Campbell * HMM_DMIRROR_PROT_DEV_PRIVATE_LOCAL: Migrated device private page on the 50b2ef9f5aSRalph Campbell * device the ioctl() is made 51b2ef9f5aSRalph Campbell * HMM_DMIRROR_PROT_DEV_PRIVATE_REMOTE: Migrated device private page on some 52b2ef9f5aSRalph Campbell * other device 53b2ef9f5aSRalph Campbell */ 54b2ef9f5aSRalph Campbell enum { 55b2ef9f5aSRalph Campbell HMM_DMIRROR_PROT_ERROR = 0xFF, 56b2ef9f5aSRalph Campbell HMM_DMIRROR_PROT_NONE = 0x00, 57b2ef9f5aSRalph Campbell HMM_DMIRROR_PROT_READ = 0x01, 58b2ef9f5aSRalph Campbell HMM_DMIRROR_PROT_WRITE = 0x02, 59e478425bSRalph Campbell HMM_DMIRROR_PROT_PMD = 0x04, 60e478425bSRalph Campbell HMM_DMIRROR_PROT_PUD = 0x08, 61b2ef9f5aSRalph Campbell HMM_DMIRROR_PROT_ZERO = 0x10, 62b2ef9f5aSRalph Campbell HMM_DMIRROR_PROT_DEV_PRIVATE_LOCAL = 0x20, 63b2ef9f5aSRalph Campbell HMM_DMIRROR_PROT_DEV_PRIVATE_REMOTE = 0x30, 64b2ef9f5aSRalph Campbell }; 65b2ef9f5aSRalph Campbell 66*188f4826SAlex Sierra enum { 67*188f4826SAlex Sierra /* 0 is reserved to catch uninitialized type fields */ 68*188f4826SAlex Sierra HMM_DMIRROR_MEMORY_DEVICE_PRIVATE = 1, 69*188f4826SAlex Sierra }; 70*188f4826SAlex Sierra 71b2ef9f5aSRalph Campbell #endif /* _LIB_TEST_HMM_UAPI_H */ 72