]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/sys/disk.h
xnu-2782.20.48.tar.gz
[apple/xnu.git] / bsd / sys / disk.h
index f7e627b64c73ab9780f2f797ad0cdde1a60c694e..48c1ab9cc773cf97d4a3ecae825acd26b4bccfdc 100644 (file)
@@ -1,31 +1,40 @@
 /*
- * Copyright (c) 1998-2005 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2014 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 
 #ifndef        _SYS_DISK_H_
 #define        _SYS_DISK_H_
 
+#include <stdint.h>
 #include <sys/ioctl.h>
-#include <sys/types.h>
-#include <sys/cdefs.h>
+
+#ifdef XNU_KERNEL_PRIVATE
+#include <mach/boolean.h>
+#endif /* XNU_KERNEL_PRIVATE */
 
 /*
  * Definitions
@@ -45,6 +54,9 @@
  * DKIOCISFORMATTED                      is media formatted?
  * DKIOCISWRITABLE                       is media writable?
  *
+ * DKIOCREQUESTIDLE                      idle media
+ * DKIOCUNMAP                            delete unused data
+ *
  * DKIOCGETMAXBLOCKCOUNTREAD             get maximum block count for reads
  * DKIOCGETMAXBLOCKCOUNTWRITE            get maximum block count for writes
  * DKIOCGETMAXBYTECOUNTREAD              get maximum byte count for reads
  *
  * DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  get minimum segment alignment in bytes
  * DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT get maximum segment width in bits
+ *
+ * DKIOCGETFEATURES                      get device's feature set
+ * DKIOCGETPHYSICALBLOCKSIZE             get device's block size
+ * DKIOCGETCOMMANDPOOLSIZE               get device's queue depth
  */
 
-#pragma pack(4)
+#define DK_FEATURE_PRIORITY                   0x00000004
+#define DK_FEATURE_UNMAP                      0x00000010
 
 typedef struct
 {
-    char path[128];
+    uint64_t               offset;
+    uint64_t               length;
+} dk_extent_t;
+
+typedef struct
+{
+    char                   path[128];
 } dk_firmware_path_t;
 
 typedef struct
 {
-    u_int64_t              blockCount;
-    u_int32_t              blockSize;
+    uint64_t               blockCount;
+    uint32_t               blockSize;
 
-    u_int8_t               reserved0096[4];        /* reserved, clear to zero */
+    uint8_t                reserved0096[4];        /* reserved, clear to zero */
 } dk_format_capacity_t;
 
-/* LP64todo: not 64-bit clean */
 typedef struct
 {
     dk_format_capacity_t * capacities;
-    u_int32_t              capacitiesCount;        /* use zero to probe count */
+    uint32_t               capacitiesCount;        /* use zero to probe count */
 
-    u_int8_t               reserved0064[8];        /* reserved, clear to zero */
+#ifdef __LP64__
+    uint8_t                reserved0096[4];        /* reserved, clear to zero */
+#else /* !__LP64__ */
+    uint8_t                reserved0064[8];        /* reserved, clear to zero */
+#endif /* !__LP64__ */
 } dk_format_capacities_t;
 
-#pragma pack()
+typedef struct
+{
+    dk_extent_t *          extents;
+    uint32_t               extentsCount;
+
+    uint32_t               options;
+
+#ifndef __LP64__
+    uint8_t                reserved0096[4];        /* reserved, clear to zero */
+#endif /* !__LP64__ */
+} dk_unmap_t;
+
+
+#ifdef KERNEL
+#ifdef PRIVATE
+
+/* Definitions of option bits for dk_unmap_t */
+#define _DK_UNMAP_INITIALIZE                   0x00000100
+
+#endif /* PRIVATE */
+#endif /* KERNEL */
 
 #define DKIOCEJECT                            _IO('d', 21)
 #define DKIOCSYNCHRONIZECACHE                 _IO('d', 22)
@@ -91,32 +137,128 @@ typedef struct
 #define DKIOCFORMAT                           _IOW('d', 26, dk_format_capacity_t)
 #define DKIOCGETFORMATCAPACITIES              _IOWR('d', 26, dk_format_capacities_t)
 
-#define DKIOCGETBLOCKSIZE                     _IOR('d', 24, u_int32_t)
-#define DKIOCGETBLOCKCOUNT                    _IOR('d', 25, u_int64_t)
+#define DKIOCGETBLOCKSIZE                     _IOR('d', 24, uint32_t)
+#define DKIOCGETBLOCKCOUNT                    _IOR('d', 25, uint64_t)
 #define DKIOCGETFIRMWAREPATH                  _IOR('d', 28, dk_firmware_path_t)
 
-#define DKIOCISFORMATTED                      _IOR('d', 23, u_int32_t)
-#define DKIOCISWRITABLE                       _IOR('d', 29, u_int32_t)
+#define DKIOCISFORMATTED                      _IOR('d', 23, uint32_t)
+#define DKIOCISWRITABLE                       _IOR('d', 29, uint32_t)
+
+#define DKIOCREQUESTIDLE                      _IO('d', 30)
+#define DKIOCUNMAP                            _IOW('d', 31, dk_unmap_t)
+#define _DKIOCCORESTORAGE                    _IO('d', 32)
+
+#define DKIOCGETMAXBLOCKCOUNTREAD             _IOR('d', 64, uint64_t)
+#define DKIOCGETMAXBLOCKCOUNTWRITE            _IOR('d', 65, uint64_t)
+#define DKIOCGETMAXBYTECOUNTREAD              _IOR('d', 70, uint64_t)
+#define DKIOCGETMAXBYTECOUNTWRITE             _IOR('d', 71, uint64_t)
 
-#define DKIOCGETMAXBLOCKCOUNTREAD             _IOR('d', 64, u_int64_t)
-#define DKIOCGETMAXBLOCKCOUNTWRITE            _IOR('d', 65, u_int64_t)
-#define DKIOCGETMAXBYTECOUNTREAD              _IOR('d', 70, u_int64_t)
-#define DKIOCGETMAXBYTECOUNTWRITE             _IOR('d', 71, u_int64_t)
+#define DKIOCGETMAXSEGMENTCOUNTREAD           _IOR('d', 66, uint64_t)
+#define DKIOCGETMAXSEGMENTCOUNTWRITE          _IOR('d', 67, uint64_t)
+#define DKIOCGETMAXSEGMENTBYTECOUNTREAD       _IOR('d', 68, uint64_t)
+#define DKIOCGETMAXSEGMENTBYTECOUNTWRITE      _IOR('d', 69, uint64_t)
 
-#define DKIOCGETMAXSEGMENTCOUNTREAD           _IOR('d', 66, u_int64_t)
-#define DKIOCGETMAXSEGMENTCOUNTWRITE          _IOR('d', 67, u_int64_t)
-#define DKIOCGETMAXSEGMENTBYTECOUNTREAD       _IOR('d', 68, u_int64_t)
-#define DKIOCGETMAXSEGMENTBYTECOUNTWRITE      _IOR('d', 69, u_int64_t)
+#define DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  _IOR('d', 74, uint64_t)
+#define DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT _IOR('d', 75, uint64_t)
 
-#define DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  _IOR('d', 74, u_int64_t)
-#define DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT _IOR('d', 75, u_int64_t)
+#define DKIOCGETFEATURES                      _IOR('d', 76, uint32_t)
+#define DKIOCGETPHYSICALBLOCKSIZE             _IOR('d', 77, uint32_t)
+#define DKIOCGETCOMMANDPOOLSIZE               _IOR('d', 78, uint32_t)
 
 #ifdef KERNEL
-#define DKIOCGETBLOCKCOUNT32                  _IOR('d', 25, u_int32_t)
-#define DKIOCSETBLOCKSIZE                     _IOW('d', 24, u_int32_t)
-#define DKIOCGETBSDUNIT                       _IOR('d', 27, u_int32_t)
-#define DKIOCISVIRTUAL                        _IOR('d', 72, u_int32_t)
-#define DKIOCGETBASE                          _IOR('d', 73, u_int64_t)
+#define DK_FEATURE_FORCE_UNIT_ACCESS          0x00000001
+
+#define DK_ENCRYPTION_TYPE_AES_CBC            1
+#define DK_ENCRYPTION_TYPE_AES_XEX            2
+#define DK_ENCRYPTION_TYPE_AES_XTS            3
+
+#define DK_TIER_MASK                          0xC0
+#define DK_TIER_SHIFT                         6
+
+#define DK_TIER_TO_PRIORITY(tier)             (((tier) << DK_TIER_SHIFT) | ~DK_TIER_MASK)
+#define DK_PRIORITY_TO_TIER(priority)         ((priority) >> DK_TIER_SHIFT)
+
+typedef struct
+{
+    uint64_t               offset;
+    uint64_t               length;
+
+    uint8_t                reserved0128[12];       /* reserved, clear to zero */
+
+    dev_t                  dev;
+} dk_physical_extent_t;
+
+typedef struct
+{
+    dk_extent_t *          extents;
+    uint32_t               extentsCount;
+
+    uint8_t                tier;
+
+#ifdef __LP64__
+    uint8_t                reserved0104[3];        /* reserved, clear to zero */
+#else /* !__LP64__ */
+    uint8_t                reserved0072[7];        /* reserved, clear to zero */
+#endif /* !__LP64__ */
+} dk_set_tier_t;
+
+#define DKIOCGETBLOCKCOUNT32                  _IOR('d', 25, uint32_t)
+#define DKIOCSETBLOCKSIZE                     _IOW('d', 24, uint32_t)
+#define DKIOCGETBSDUNIT                       _IOR('d', 27, uint32_t)
+#define DKIOCISSOLIDSTATE                     _IOR('d', 79, uint32_t)
+#define DKIOCISVIRTUAL                        _IOR('d', 72, uint32_t)
+#define DKIOCGETBASE                          _IOR('d', 73, uint64_t)
+#define DKIOCGETTHROTTLEMASK                  _IOR('d', 80, uint64_t)
+#define DKIOCLOCKPHYSICALEXTENTS              _IO('d', 81)
+#define DKIOCGETPHYSICALEXTENT                _IOWR('d', 82, dk_physical_extent_t)
+#define DKIOCUNLOCKPHYSICALEXTENTS            _IO('d', 83)
+#define DKIOCSETTIER                          _IOW('d', 85, dk_set_tier_t)
+#define DKIOCGETENCRYPTIONTYPE                _IOR('d', 86, uint32_t)
+#define DKIOCISLOWPOWERMODE                   _IOR('d', 87, uint32_t)
+
+#ifdef XNU_KERNEL_PRIVATE
+typedef struct
+{
+    boolean_t mi_mdev; /* Is this a memdev device? */
+    boolean_t mi_phys; /* Physical memory? */
+    uint32_t mi_base;  /* Base page number of the device? */
+    uint64_t mi_size;  /* Size of the device (in ) */
+} dk_memdev_info_t;
+
+typedef dk_memdev_info_t memdev_info_t;
+
+#define DKIOCGETMEMDEVINFO                    _IOR('d', 90, dk_memdev_info_t)
+#endif /* XNU_KERNEL_PRIVATE */
+#ifdef PRIVATE
+typedef struct _dk_cs_pin {
+       dk_extent_t     cp_extent;
+       int64_t         cp_flags;
+} _dk_cs_pin_t;
+#define _DKIOCCSPINFORHIBERNATION       (1 << 0)
+#define _DKIOCCSPINDISCARDBLACKLIST     (1 << 1)
+#define _DKIOCCSPINEXTENT                     _IOW('d', 199, _dk_cs_pin_t)
+#define _DKIOCCSUNPINEXTENT                   _IOW('d', 200, _dk_cs_pin_t)
+#define _DKIOCGETMIGRATIONUNITBYTESIZE        _IOR('d', 201, uint32_t)
+
+typedef struct _dk_cs_map {
+       dk_extent_t     cm_extent;
+       uint64_t        cm_bytes_mapped;
+} _dk_cs_map_t;
+
+typedef struct _dk_cs_unmap {
+       dk_extent_t                  *extents;
+       uint32_t                     extentsCount;
+       uint32_t                     options;
+} _dk_cs_unmap_t;
+
+#define _DKIOCCSMAP                           _IOWR('d', 202, _dk_cs_map_t)
+#define _DKIOCCSSETFSVNODE                    _IOW('d', 203, vnode_t)
+#define _DKIOCCSGETFREEBYTES                  _IOR('d', 204, uint64_t)
+#define        _DKIOCCSUNMAP                         _IOWR('d', 205, _dk_cs_unmap_t)
+#endif /* PRIVATE */
 #endif /* KERNEL */
 
+#ifdef PRIVATE
+#endif /* PRIVATE */
+
 #endif /* _SYS_DISK_H_ */