bsd/sys/disk.h

   1 /*
   2  * Copyright (c) 1998-2014 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #ifndef _SYS_DISK_H_
  30 #define _SYS_DISK_H_
  31
  32 #include <stdint.h>
  33 #include <sys/ioctl.h>
  34
  35 #ifdef XNU_KERNEL_PRIVATE
  36 #include <mach/boolean.h>
  37 #endif /* XNU_KERNEL_PRIVATE */
  38
  39 /*
  40  * Definitions
  41  *
  42  * ioctl                                 description
  43  * ------------------------------------- ---------------------------------------
  44  * DKIOCEJECT                            eject media
  45  * DKIOCSYNCHRONIZECACHE                 flush media
  46  *
  47  * DKIOCFORMAT                           format media
  48  * DKIOCGETFORMATCAPACITIES              get media's formattable capacities
  49  *
  50  * DKIOCGETBLOCKSIZE                     get media's block size
  51  * DKIOCGETBLOCKCOUNT                    get media's block count
  52  * DKIOCGETFIRMWAREPATH                  get media's firmware path
  53  *
  54  * DKIOCISFORMATTED                      is media formatted?
  55  * DKIOCISWRITABLE                       is media writable?
  56  *
  57  * DKIOCREQUESTIDLE                      idle media
  58  * DKIOCUNMAP                            delete unused data
  59  *
  60  * DKIOCGETMAXBLOCKCOUNTREAD             get maximum block count for reads
  61  * DKIOCGETMAXBLOCKCOUNTWRITE            get maximum block count for writes
  62  * DKIOCGETMAXBYTECOUNTREAD              get maximum byte count for reads
  63  * DKIOCGETMAXBYTECOUNTWRITE             get maximum byte count for writes
  64  *
  65  * DKIOCGETMAXSEGMENTCOUNTREAD           get maximum segment count for reads
  66  * DKIOCGETMAXSEGMENTCOUNTWRITE          get maximum segment count for writes
  67  * DKIOCGETMAXSEGMENTBYTECOUNTREAD       get maximum segment byte count for reads
  68  * DKIOCGETMAXSEGMENTBYTECOUNTWRITE      get maximum segment byte count for writes
  69  *
  70  * DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  get minimum segment alignment in bytes
  71  * DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT get maximum segment width in bits
  72  *
  73  * DKIOCGETFEATURES                      get device's feature set
  74  * DKIOCGETPHYSICALBLOCKSIZE             get device's block size
  75  * DKIOCGETCOMMANDPOOLSIZE               get device's queue depth
  76  */
  77
  78 #define DK_FEATURE_PRIORITY                   0x00000004
  79 #define DK_FEATURE_UNMAP                      0x00000010
  80
  81 typedef struct
  82 {
  83     uint64_t               offset;
  84     uint64_t               length;
  85 } dk_extent_t;
  86
  87 typedef struct
  88 {
  89     char                   path[128];
  90 } dk_firmware_path_t;
  91
  92 typedef struct
  93 {
  94     uint64_t               blockCount;
  95     uint32_t               blockSize;
  96
  97     uint8_t                reserved0096[4];        /* reserved, clear to zero */
  98 } dk_format_capacity_t;
  99
 100 typedef struct
 101 {
 102     dk_format_capacity_t * capacities;
 103     uint32_t               capacitiesCount;        /* use zero to probe count */
 104
 105 #ifdef __LP64__
 106     uint8_t                reserved0096[4];        /* reserved, clear to zero */
 107 #else /* !__LP64__ */
 108     uint8_t                reserved0064[8];        /* reserved, clear to zero */
 109 #endif /* !__LP64__ */
 110 } dk_format_capacities_t;
 111
 112 typedef struct
 113 {
 114     dk_extent_t *          extents;
 115     uint32_t               extentsCount;
 116
 117     uint32_t               options;
 118
 119 #ifndef __LP64__
 120     uint8_t                reserved0096[4];        /* reserved, clear to zero */
 121 #endif /* !__LP64__ */
 122 } dk_unmap_t;
 123
 124
 125 #ifdef KERNEL
 126 #ifdef PRIVATE
 127
 128 /* Definitions of option bits for dk_unmap_t */
 129 #define _DK_UNMAP_INITIALIZE                   0x00000100
 130
 131 #endif /* PRIVATE */
 132 #endif /* KERNEL */
 133
 134 #define DKIOCEJECT                            _IO('d', 21)
 135 #define DKIOCSYNCHRONIZECACHE                 _IO('d', 22)
 136
 137 #define DKIOCFORMAT                           _IOW('d', 26, dk_format_capacity_t)
 138 #define DKIOCGETFORMATCAPACITIES              _IOWR('d', 26, dk_format_capacities_t)
 139
 140 #define DKIOCGETBLOCKSIZE                     _IOR('d', 24, uint32_t)
 141 #define DKIOCGETBLOCKCOUNT                    _IOR('d', 25, uint64_t)
 142 #define DKIOCGETFIRMWAREPATH                  _IOR('d', 28, dk_firmware_path_t)
 143
 144 #define DKIOCISFORMATTED                      _IOR('d', 23, uint32_t)
 145 #define DKIOCISWRITABLE                       _IOR('d', 29, uint32_t)
 146
 147 #define DKIOCREQUESTIDLE                      _IO('d', 30)
 148 #define DKIOCUNMAP                            _IOW('d', 31, dk_unmap_t)
 149 #define _DKIOCCORESTORAGE                     _IO('d', 32)
 150
 151 #define DKIOCGETMAXBLOCKCOUNTREAD             _IOR('d', 64, uint64_t)
 152 #define DKIOCGETMAXBLOCKCOUNTWRITE            _IOR('d', 65, uint64_t)
 153 #define DKIOCGETMAXBYTECOUNTREAD              _IOR('d', 70, uint64_t)
 154 #define DKIOCGETMAXBYTECOUNTWRITE             _IOR('d', 71, uint64_t)
 155
 156 #define DKIOCGETMAXSEGMENTCOUNTREAD           _IOR('d', 66, uint64_t)
 157 #define DKIOCGETMAXSEGMENTCOUNTWRITE          _IOR('d', 67, uint64_t)
 158 #define DKIOCGETMAXSEGMENTBYTECOUNTREAD       _IOR('d', 68, uint64_t)
 159 #define DKIOCGETMAXSEGMENTBYTECOUNTWRITE      _IOR('d', 69, uint64_t)
 160
 161 #define DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  _IOR('d', 74, uint64_t)
 162 #define DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT _IOR('d', 75, uint64_t)
 163
 164 #define DKIOCGETFEATURES                      _IOR('d', 76, uint32_t)
 165 #define DKIOCGETPHYSICALBLOCKSIZE             _IOR('d', 77, uint32_t)
 166 #define DKIOCGETCOMMANDPOOLSIZE               _IOR('d', 78, uint32_t)
 167
 168 #ifdef KERNEL
 169 #define DK_FEATURE_FORCE_UNIT_ACCESS          0x00000001
 170
 171 #define DK_ENCRYPTION_TYPE_AES_CBC            1
 172 #define DK_ENCRYPTION_TYPE_AES_XEX            2
 173 #define DK_ENCRYPTION_TYPE_AES_XTS            3
 174
 175 #define DK_TIER_MASK                          0xC0
 176 #define DK_TIER_SHIFT                         6
 177
 178 #define DK_TIER_TO_PRIORITY(tier)             (((tier) << DK_TIER_SHIFT) | ~DK_TIER_MASK)
 179 #define DK_PRIORITY_TO_TIER(priority)         ((priority) >> DK_TIER_SHIFT)
 180
 181 typedef struct
 182 {
 183     uint64_t               offset;
 184     uint64_t               length;
 185
 186     uint8_t                reserved0128[12];       /* reserved, clear to zero */
 187
 188     dev_t                  dev;
 189 } dk_physical_extent_t;
 190
 191 typedef struct
 192 {
 193     dk_extent_t *          extents;
 194     uint32_t               extentsCount;
 195
 196     uint8_t                tier;
 197
 198 #ifdef __LP64__
 199     uint8_t                reserved0104[3];        /* reserved, clear to zero */
 200 #else /* !__LP64__ */
 201     uint8_t                reserved0072[7];        /* reserved, clear to zero */
 202 #endif /* !__LP64__ */
 203 } dk_set_tier_t;
 204
 205 #define DKIOCGETBLOCKCOUNT32                  _IOR('d', 25, uint32_t)
 206 #define DKIOCSETBLOCKSIZE                     _IOW('d', 24, uint32_t)
 207 #define DKIOCGETBSDUNIT                       _IOR('d', 27, uint32_t)
 208 #define DKIOCISSOLIDSTATE                     _IOR('d', 79, uint32_t)
 209 #define DKIOCISVIRTUAL                        _IOR('d', 72, uint32_t)
 210 #define DKIOCGETBASE                          _IOR('d', 73, uint64_t)
 211 #define DKIOCGETTHROTTLEMASK                  _IOR('d', 80, uint64_t)
 212 #define DKIOCLOCKPHYSICALEXTENTS              _IO('d', 81)
 213 #define DKIOCGETPHYSICALEXTENT                _IOWR('d', 82, dk_physical_extent_t)
 214 #define DKIOCUNLOCKPHYSICALEXTENTS            _IO('d', 83)
 215 #define DKIOCSETTIER                          _IOW('d', 85, dk_set_tier_t)
 216 #define DKIOCGETENCRYPTIONTYPE                _IOR('d', 86, uint32_t)
 217 #define DKIOCISLOWPOWERMODE                   _IOR('d', 87, uint32_t)
 218
 219 #ifdef XNU_KERNEL_PRIVATE
 220 typedef struct
 221 {
 222     boolean_t mi_mdev; /* Is this a memdev device? */
 223     boolean_t mi_phys; /* Physical memory? */
 224     uint32_t mi_base;  /* Base page number of the device? */
 225     uint64_t mi_size;  /* Size of the device (in ) */
 226 } dk_memdev_info_t;
 227
 228 typedef dk_memdev_info_t memdev_info_t;
 229
 230 #define DKIOCGETMEMDEVINFO                    _IOR('d', 90, dk_memdev_info_t)
 231 #endif /* XNU_KERNEL_PRIVATE */
 232 #ifdef PRIVATE
 233 typedef struct _dk_cs_pin {
 234         dk_extent_t     cp_extent;
 235         int64_t         cp_flags;
 236 } _dk_cs_pin_t;
 237 #define _DKIOCCSPINFORHIBERNATION       (1 << 0)
 238 #define _DKIOCCSPINDISCARDBLACKLIST     (1 << 1)
 239 #define _DKIOCCSPINEXTENT                     _IOW('d', 199, _dk_cs_pin_t)
 240 #define _DKIOCCSUNPINEXTENT                   _IOW('d', 200, _dk_cs_pin_t)
 241 #define _DKIOCGETMIGRATIONUNITBYTESIZE        _IOR('d', 201, uint32_t)
 242
 243 typedef struct _dk_cs_map {
 244         dk_extent_t     cm_extent;
 245         uint64_t        cm_bytes_mapped;
 246 } _dk_cs_map_t;
 247
 248 typedef struct _dk_cs_unmap {
 249         dk_extent_t                  *extents;
 250         uint32_t                     extentsCount;
 251         uint32_t                     options;
 252 } _dk_cs_unmap_t;
 253
 254 #define _DKIOCCSMAP                           _IOWR('d', 202, _dk_cs_map_t)
 255 #define _DKIOCCSSETFSVNODE                    _IOW('d', 203, vnode_t)
 256 #define _DKIOCCSGETFREEBYTES                  _IOR('d', 204, uint64_t)
 257 #define _DKIOCCSUNMAP                         _IOWR('d', 205, _dk_cs_unmap_t)
 258 #endif /* PRIVATE */
 259 #endif /* KERNEL */
 260
 261 #ifdef PRIVATE
 262 #endif /* PRIVATE */
 263
 264 #endif  /* _SYS_DISK_H_ */