1 /* 2 * CXL Flash Device Driver 3 * 4 * Written by: Manoj N. Kumar <manoj@linux.vnet.ibm.com>, IBM Corporation 5 * Matthew R. Ochs <mrochs@linux.vnet.ibm.com>, IBM Corporation 6 * 7 * Copyright (C) 2015 IBM Corporation 8 * 9 * This program is free software; you can redistribute it and/or 10 * modify it under the terms of the GNU General Public License 11 * as published by the Free Software Foundation; either version 12 * 2 of the License, or (at your option) any later version. 13 */ 14 15 #ifndef _CXLFLASH_IOCTL_H 16 #define _CXLFLASH_IOCTL_H 17 18 #include <linux/types.h> 19 20 /* 21 * Structure and flag definitions CXL Flash superpipe ioctls 22 */ 23 24 #define DK_CXLFLASH_VERSION_0 0 25 26 struct dk_cxlflash_hdr { 27 __u16 version; /* Version data */ 28 __u16 rsvd[3]; /* Reserved for future use */ 29 __u64 flags; /* Input flags */ 30 __u64 return_flags; /* Returned flags */ 31 }; 32 33 /* 34 * Return flag definitions available to all ioctls 35 * 36 * Similar to the input flags, these are grown from the bottom-up with the 37 * intention that ioctl-specific return flag definitions would grow from the 38 * top-down, allowing the two sets to co-exist. While not required/enforced 39 * at this time, this provides future flexibility. 40 */ 41 #define DK_CXLFLASH_ALL_PORTS_ACTIVE 0x0000000000000001ULL 42 43 /* 44 * Notes: 45 * ----- 46 * The 'context_id' field of all ioctl structures contains the context 47 * identifier for a context in the lower 32-bits (upper 32-bits are not 48 * to be used when identifying a context to the AFU). That said, the value 49 * in its entirety (all 64-bits) is to be treated as an opaque cookie and 50 * should be presented as such when issuing ioctls. 51 * 52 * For DK_CXLFLASH_ATTACH ioctl, user specifies read/write access 53 * permissions via the O_RDONLY, O_WRONLY, and O_RDWR flags defined in 54 * the fcntl.h header file. 55 */ 56 #define DK_CXLFLASH_ATTACH_REUSE_CONTEXT 0x8000000000000000ULL 57 58 struct dk_cxlflash_attach { 59 struct dk_cxlflash_hdr hdr; /* Common fields */ 60 __u64 num_interrupts; /* Requested number of interrupts */ 61 __u64 context_id; /* Returned context */ 62 __u64 mmio_size; /* Returned size of MMIO area */ 63 __u64 block_size; /* Returned block size, in bytes */ 64 __u64 adap_fd; /* Returned adapter file descriptor */ 65 __u64 last_lba; /* Returned last LBA on the device */ 66 __u64 max_xfer; /* Returned max transfer size, blocks */ 67 __u64 reserved[8]; /* Reserved for future use */ 68 }; 69 70 struct dk_cxlflash_detach { 71 struct dk_cxlflash_hdr hdr; /* Common fields */ 72 __u64 context_id; /* Context to detach */ 73 __u64 reserved[8]; /* Reserved for future use */ 74 }; 75 76 struct dk_cxlflash_udirect { 77 struct dk_cxlflash_hdr hdr; /* Common fields */ 78 __u64 context_id; /* Context to own physical resources */ 79 __u64 rsrc_handle; /* Returned resource handle */ 80 __u64 last_lba; /* Returned last LBA on the device */ 81 __u64 reserved[8]; /* Reserved for future use */ 82 }; 83 84 #define DK_CXLFLASH_UVIRTUAL_NEED_WRITE_SAME 0x8000000000000000ULL 85 86 struct dk_cxlflash_uvirtual { 87 struct dk_cxlflash_hdr hdr; /* Common fields */ 88 __u64 context_id; /* Context to own virtual resources */ 89 __u64 lun_size; /* Requested size, in 4K blocks */ 90 __u64 rsrc_handle; /* Returned resource handle */ 91 __u64 last_lba; /* Returned last LBA of LUN */ 92 __u64 reserved[8]; /* Reserved for future use */ 93 }; 94 95 struct dk_cxlflash_release { 96 struct dk_cxlflash_hdr hdr; /* Common fields */ 97 __u64 context_id; /* Context owning resources */ 98 __u64 rsrc_handle; /* Resource handle to release */ 99 __u64 reserved[8]; /* Reserved for future use */ 100 }; 101 102 struct dk_cxlflash_resize { 103 struct dk_cxlflash_hdr hdr; /* Common fields */ 104 __u64 context_id; /* Context owning resources */ 105 __u64 rsrc_handle; /* Resource handle of LUN to resize */ 106 __u64 req_size; /* New requested size, in 4K blocks */ 107 __u64 last_lba; /* Returned last LBA of LUN */ 108 __u64 reserved[8]; /* Reserved for future use */ 109 }; 110 111 struct dk_cxlflash_clone { 112 struct dk_cxlflash_hdr hdr; /* Common fields */ 113 __u64 context_id_src; /* Context to clone from */ 114 __u64 context_id_dst; /* Context to clone to */ 115 __u64 adap_fd_src; /* Source context adapter fd */ 116 __u64 reserved[8]; /* Reserved for future use */ 117 }; 118 119 #define DK_CXLFLASH_VERIFY_SENSE_LEN 18 120 #define DK_CXLFLASH_VERIFY_HINT_SENSE 0x8000000000000000ULL 121 122 struct dk_cxlflash_verify { 123 struct dk_cxlflash_hdr hdr; /* Common fields */ 124 __u64 context_id; /* Context owning resources to verify */ 125 __u64 rsrc_handle; /* Resource handle of LUN */ 126 __u64 hint; /* Reasons for verify */ 127 __u64 last_lba; /* Returned last LBA of device */ 128 __u8 sense_data[DK_CXLFLASH_VERIFY_SENSE_LEN]; /* SCSI sense data */ 129 __u8 pad[6]; /* Pad to next 8-byte boundary */ 130 __u64 reserved[8]; /* Reserved for future use */ 131 }; 132 133 #define DK_CXLFLASH_RECOVER_AFU_CONTEXT_RESET 0x8000000000000000ULL 134 135 struct dk_cxlflash_recover_afu { 136 struct dk_cxlflash_hdr hdr; /* Common fields */ 137 __u64 reason; /* Reason for recovery request */ 138 __u64 context_id; /* Context to recover / updated ID */ 139 __u64 mmio_size; /* Returned size of MMIO area */ 140 __u64 adap_fd; /* Returned adapter file descriptor */ 141 __u64 reserved[8]; /* Reserved for future use */ 142 }; 143 144 #define DK_CXLFLASH_MANAGE_LUN_WWID_LEN 16 145 #define DK_CXLFLASH_MANAGE_LUN_ENABLE_SUPERPIPE 0x8000000000000000ULL 146 #define DK_CXLFLASH_MANAGE_LUN_DISABLE_SUPERPIPE 0x4000000000000000ULL 147 #define DK_CXLFLASH_MANAGE_LUN_ALL_PORTS_ACCESSIBLE 0x2000000000000000ULL 148 149 struct dk_cxlflash_manage_lun { 150 struct dk_cxlflash_hdr hdr; /* Common fields */ 151 __u8 wwid[DK_CXLFLASH_MANAGE_LUN_WWID_LEN]; /* Page83 WWID, NAA-6 */ 152 __u64 reserved[8]; /* Rsvd, future use */ 153 }; 154 155 union cxlflash_ioctls { 156 struct dk_cxlflash_attach attach; 157 struct dk_cxlflash_detach detach; 158 struct dk_cxlflash_udirect udirect; 159 struct dk_cxlflash_uvirtual uvirtual; 160 struct dk_cxlflash_release release; 161 struct dk_cxlflash_resize resize; 162 struct dk_cxlflash_clone clone; 163 struct dk_cxlflash_verify verify; 164 struct dk_cxlflash_recover_afu recover_afu; 165 struct dk_cxlflash_manage_lun manage_lun; 166 }; 167 168 #define MAX_CXLFLASH_IOCTL_SZ (sizeof(union cxlflash_ioctls)) 169 170 #define CXL_MAGIC 0xCA 171 #define CXL_IOWR(_n, _s) _IOWR(CXL_MAGIC, _n, struct _s) 172 173 #define DK_CXLFLASH_ATTACH CXL_IOWR(0x80, dk_cxlflash_attach) 174 #define DK_CXLFLASH_USER_DIRECT CXL_IOWR(0x81, dk_cxlflash_udirect) 175 #define DK_CXLFLASH_RELEASE CXL_IOWR(0x82, dk_cxlflash_release) 176 #define DK_CXLFLASH_DETACH CXL_IOWR(0x83, dk_cxlflash_detach) 177 #define DK_CXLFLASH_VERIFY CXL_IOWR(0x84, dk_cxlflash_verify) 178 #define DK_CXLFLASH_RECOVER_AFU CXL_IOWR(0x85, dk_cxlflash_recover_afu) 179 #define DK_CXLFLASH_MANAGE_LUN CXL_IOWR(0x86, dk_cxlflash_manage_lun) 180 #define DK_CXLFLASH_USER_VIRTUAL CXL_IOWR(0x87, dk_cxlflash_uvirtual) 181 #define DK_CXLFLASH_VLUN_RESIZE CXL_IOWR(0x88, dk_cxlflash_resize) 182 #define DK_CXLFLASH_VLUN_CLONE CXL_IOWR(0x89, dk_cxlflash_clone) 183 184 #endif /* ifndef _CXLFLASH_IOCTL_H */ 185