[apple/xnu.git] / bsd / sys / disk.h

/*
 * Copyright (c) 1998-2014 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * 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.
 * 
 * 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, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

#ifndef	_SYS_DISK_H_
#define	_SYS_DISK_H_

#include <stdint.h>
#include <sys/ioctl.h>

#ifdef XNU_KERNEL_PRIVATE
#include <mach/boolean.h>
#endif /* XNU_KERNEL_PRIVATE */

/*
 * Definitions
 *
 * ioctl                                 description
 * ------------------------------------- ---------------------------------------
 * DKIOCEJECT                            eject media
 * DKIOCSYNCHRONIZE                      flush media
 *
 * DKIOCFORMAT                           format media
 * DKIOCGETFORMATCAPACITIES              get media's formattable capacities
 *
 * DKIOCGETBLOCKSIZE                     get media's block size
 * DKIOCGETBLOCKCOUNT                    get media's block count
 * DKIOCGETFIRMWAREPATH                  get media's firmware path
 *
 * 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
 * DKIOCGETMAXBYTECOUNTWRITE             get maximum byte count for writes
 *
 * DKIOCGETMAXSEGMENTCOUNTREAD           get maximum segment count for reads
 * DKIOCGETMAXSEGMENTCOUNTWRITE          get maximum segment count for writes
 * DKIOCGETMAXSEGMENTBYTECOUNTREAD       get maximum segment byte count for reads
 * DKIOCGETMAXSEGMENTBYTECOUNTWRITE      get maximum segment byte count for writes
 *
 * 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
 *
 * DKIOCGETPROVISIONSTATUS               get device's block provision status
 * DKIOCGETIOMINSATURATIONBYTECOUNT      get minimum byte count to saturate storage bandwidth
 *
 * DKIOCGETERRORDESCRIPTION              get description of any drive error
 */

#define DK_FEATURE_BARRIER                    0x00000002
#define DK_FEATURE_PRIORITY                   0x00000004
#define DK_FEATURE_UNMAP                      0x00000010

#define DK_SYNCHRONIZE_OPTION_BARRIER         0x00000002

typedef struct
{
    uint64_t               offset;
    uint64_t               length;
} dk_extent_t;

typedef struct
{
    char                   path[128];
} dk_firmware_path_t;

typedef struct
{
    uint64_t               blockCount;
    uint32_t               blockSize;

    uint8_t                reserved0096[4];        /* reserved, clear to zero */
} dk_format_capacity_t;

typedef struct
{
    dk_format_capacity_t * capacities;
    uint32_t               capacitiesCount;        /* use zero to probe count */

#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;

typedef struct
{
    uint64_t               offset;
    uint64_t               length;

    uint32_t               options;

    uint8_t                reserved0160[4];        /* reserved, clear to zero */
} dk_synchronize_t;

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;


typedef struct
{
	uint64_t           flags;
	uint64_t           hotfile_size;           /* in bytes */
	uint64_t           hibernate_minsize;
	uint64_t           swapfile_pinning;

	uint64_t           padding[4];
} dk_corestorage_info_t;

#define DK_CORESTORAGE_PIN_YOUR_METADATA        0x00000001
#define DK_CORESTORAGE_ENABLE_HOTFILES          0x00000002
#define DK_CORESTORAGE_PIN_YOUR_SWAPFILE        0x00000004

#define DK_PROVISION_TYPE_MAPPED                0x00
#define DK_PROVISION_TYPE_DEALLOCATED           0x01
#define DK_PROVISION_TYPE_ANCHORED              0x02

typedef struct
{
	uint64_t           offset;
	uint64_t           length;
	uint8_t            provisionType;
	uint8_t            reserved[7];
} dk_provision_extent_t;

typedef struct
{
	uint64_t                offset;         /* input:        logical byte offset */
	uint64_t                length;         /* input:        byte length, 0 for whole length */
	uint64_t                options;        /*               reserved, clear to zero */
	uint32_t                reserved;       /*               not used */
	uint32_t                extentsCount;   /* input/output: count for extents */
	dk_provision_extent_t *	extents;        /* output:       provision extents */
} dk_provision_status_t;

typedef struct
{
	uint64_t               options;        /*               reserved, clear to zero */
	uint64_t               reserved;       /*               reserved, clear to zero */
	uint64_t               description_size;
	char *                 description;
} dk_error_description_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 DKIOCSYNCHRONIZE                      _IOW('d', 22, dk_synchronize_t)

#define DKIOCFORMAT                           _IOW('d', 26, dk_format_capacity_t)
#define DKIOCGETFORMATCAPACITIES              _IOWR('d', 26, dk_format_capacities_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, uint32_t)
#define DKIOCISWRITABLE                       _IOR('d', 29, uint32_t)

#define DKIOCREQUESTIDLE                      _IO('d', 30)
#define DKIOCUNMAP                            _IOW('d', 31, dk_unmap_t)
#define DKIOCCORESTORAGE                      _IOR('d', 32, dk_corestorage_info_t)

#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 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 DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  _IOR('d', 74, uint64_t)
#define DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT _IOR('d', 75, uint64_t)

#define DKIOCGETFEATURES                      _IOR('d', 76, uint32_t)
#define DKIOCGETPHYSICALBLOCKSIZE             _IOR('d', 77, uint32_t)
#define DKIOCGETCOMMANDPOOLSIZE               _IOR('d', 78, uint32_t)

#define DKIOCGETPROVISIONSTATUS               _IOWR('d', 79, dk_provision_status_t)

#define DKIOCGETERRORDESCRIPTION              _IOR('d', 80, dk_error_description_t)

#define DKIOCSYNCHRONIZECACHE                 _IO('d', 22)

#ifdef KERNEL
#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 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)
#define DKIOCGETIOMINSATURATIONBYTECOUNT      _IOR('d', 88, 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;
/* The following are modifiers to _DKIOCCSPINEXTENT/cp_flags operation */
#define _DKIOCCSPINTOFASTMEDIA          (0)			/* Pin extent to the fast (SSD) media             */
#define _DKIOCCSPINFORHIBERNATION       (1 << 0)	/* Pin of hibernation file, content not preserved */
#define _DKIOCCSPINDISCARDBLACKLIST     (1 << 1)	/* Hibernation complete/error, stop blacklisting  */
#define _DKIOCCSPINTOSLOWMEDIA          (1 << 2)	/* Pin extent to the slow (HDD) media             */
#define _DKIOCCSTEMPORARYPIN            (1 << 3)	/* Relocate, but do not pin, to indicated media   */
#define _DKIOCCSHIBERNATEIMGSIZE        (1 << 4)	/* Anticipate/Max size of the upcoming hibernate  */
#define _DKIOCCSPINFORSWAPFILE          (1 << 5)	/* Pin of swap file, content not preserved        */

#define _DKIOCCSSETLVNAME                     _IOW('d', 198, char[256])
#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)
// No longer used: _DKIOCCSSETFSVNODE (203) & _DKIOCCSGETFREEBYTES (204)
#define	_DKIOCCSUNMAP			      _IOWR('d', 205, _dk_cs_unmap_t)

typedef enum {
	DK_APFS_ONE_DEVICE = 1,
	DK_APFS_FUSION
} dk_apfs_flavour_t;

#define DKIOCGETAPFSFLAVOUR	_IOR('d', 91, dk_apfs_flavour_t)

#endif /* PRIVATE */
#endif /* KERNEL */

#ifdef PRIVATE
#if TARGET_OS_EMBEDDED
#define _DKIOCSETSTATIC                       _IO('d', 84)
#endif /* TARGET_OS_EMBEDDED */
#endif /* PRIVATE */

#endif	/* _SYS_DISK_H_ */
Commit	Line	Data
9bccf70c	1	/*
fe8ab488	2	* Copyright (c) 1998-2014 Apple Computer, Inc. All rights reserved.
9bccf70c	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
9bccf70c	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
9bccf70c A	27	*/
	28
	29	#ifndef _SYS_DISK_H_
	30	#define _SYS_DISK_H_
	31
2d21ac55	32	#include <stdint.h>
9bccf70c	33	#include <sys/ioctl.h>
9bccf70c	34
39236c6e A	35	#ifdef XNU_KERNEL_PRIVATE
	36	#include <mach/boolean.h>
	37	#endif /* XNU_KERNEL_PRIVATE */
	38
55e303ae A	39	/*
	40	* Definitions
	41	*
0c530ab8 A	42	* ioctl description
	43	* ------------------------------------- ---------------------------------------
	44	* DKIOCEJECT eject media
3e170ce0	45	* DKIOCSYNCHRONIZE flush media
5d5c5d0d	46	*
0c530ab8 A	47	* DKIOCFORMAT format media
0c530ab8 A	48	* DKIOCGETFORMATCAPACITIES get media's formattable capacities
5d5c5d0d	49	*
0c530ab8 A	50	* DKIOCGETBLOCKSIZE get media's block size
	51	* DKIOCGETBLOCKCOUNT get media's block count
	52	* DKIOCGETFIRMWAREPATH get media's firmware path
4452a7af	53	*
0c530ab8 A	54	* DKIOCISFORMATTED is media formatted?
0c530ab8 A	55	* DKIOCISWRITABLE is media writable?
4452a7af	56	*
c910b4d9	57	* DKIOCREQUESTIDLE idle media
060df5ea	58	* DKIOCUNMAP delete unused data
593a1d5f	59	*
0c530ab8 A	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
593a1d5f	72	*
060df5ea	73	* DKIOCGETFEATURES get device's feature set
593a1d5f	74	* DKIOCGETPHYSICALBLOCKSIZE get device's block size
b0d623f7	75	* DKIOCGETCOMMANDPOOLSIZE get device's queue depth
39037602 A	76	*
	77	* DKIOCGETPROVISIONSTATUS get device's block provision status
	78	* DKIOCGETIOMINSATURATIONBYTECOUNT get minimum byte count to saturate storage bandwidth
d190cdc3 A	79	*
d190cdc3 A	80	* DKIOCGETERRORDESCRIPTION get description of any drive error
55e303ae A	81	*/
55e303ae A	82
3e170ce0	83	#define DK_FEATURE_BARRIER 0x00000002
fe8ab488	84	#define DK_FEATURE_PRIORITY 0x00000004
060df5ea A	85	#define DK_FEATURE_UNMAP 0x00000010
060df5ea A	86
3e170ce0 A	87	#define DK_SYNCHRONIZE_OPTION_BARRIER 0x00000002
3e170ce0 A	88
9bccf70c A	89	typedef struct
9bccf70c A	90	{
593a1d5f A	91	uint64_t offset;
593a1d5f A	92	uint64_t length;
060df5ea	93	} dk_extent_t;
593a1d5f A	94
	95	typedef struct
	96	{
	97	char path[128];
9bccf70c A	98	} dk_firmware_path_t;
9bccf70c A	99
55e303ae A	100	typedef struct
55e303ae A	101	{
2d21ac55 A	102	uint64_t blockCount;
2d21ac55 A	103	uint32_t blockSize;
55e303ae	104
2d21ac55	105	uint8_t reserved0096[4]; /* reserved, clear to zero */
55e303ae A	106	} dk_format_capacity_t;
	107
	108	typedef struct
	109	{
	110	dk_format_capacity_t * capacities;
2d21ac55	111	uint32_t capacitiesCount; /* use zero to probe count */
55e303ae	112
2d21ac55 A	113	#ifdef __LP64__
	114	uint8_t reserved0096[4]; /* reserved, clear to zero */
	115	#else /* !__LP64__ */
	116	uint8_t reserved0064[8]; /* reserved, clear to zero */
	117	#endif /* !__LP64__ */
55e303ae A	118	} dk_format_capacities_t;
55e303ae A	119
3e170ce0 A	120	typedef struct
	121	{
	122	uint64_t offset;
	123	uint64_t length;
	124
	125	uint32_t options;
	126
	127	uint8_t reserved0160[4]; /* reserved, clear to zero */
	128	} dk_synchronize_t;
	129
060df5ea A	130	typedef struct
	131	{
	132	dk_extent_t * extents;
	133	uint32_t extentsCount;
	134
fe8ab488 A	135	uint32_t options;
	136
	137	#ifndef __LP64__
060df5ea	138	uint8_t reserved0096[4]; /* reserved, clear to zero */
060df5ea A	139	#endif /* !__LP64__ */
	140	} dk_unmap_t;
	141
fe8ab488	142
3e170ce0 A	143	typedef struct
	144	{
	145	uint64_t flags;
	146	uint64_t hotfile_size; /* in bytes */
	147	uint64_t hibernate_minsize;
	148	uint64_t swapfile_pinning;
	149
	150	uint64_t padding[4];
	151	} dk_corestorage_info_t;
	152
	153	#define DK_CORESTORAGE_PIN_YOUR_METADATA 0x00000001
	154	#define DK_CORESTORAGE_ENABLE_HOTFILES 0x00000002
	155	#define DK_CORESTORAGE_PIN_YOUR_SWAPFILE 0x00000004
	156
39037602 A	157	#define DK_PROVISION_TYPE_MAPPED 0x00
	158	#define DK_PROVISION_TYPE_DEALLOCATED 0x01
	159	#define DK_PROVISION_TYPE_ANCHORED 0x02
	160
	161	typedef struct
	162	{
	163	uint64_t offset;
	164	uint64_t length;
	165	uint8_t provisionType;
	166	uint8_t reserved[7];
	167	} dk_provision_extent_t;
	168
	169	typedef struct
	170	{
	171	uint64_t offset; /* input: logical byte offset */
	172	uint64_t length; /* input: byte length, 0 for whole length */
	173	uint64_t options; /* reserved, clear to zero */
	174	uint32_t reserved; /* not used */
	175	uint32_t extentsCount; /* input/output: count for extents */
	176	dk_provision_extent_t * extents; /* output: provision extents */
	177	} dk_provision_status_t;
3e170ce0	178
d190cdc3 A	179	typedef struct
	180	{
	181	uint64_t options; /* reserved, clear to zero */
	182	uint64_t reserved; /* reserved, clear to zero */
	183	uint64_t description_size;
	184	char * description;
	185	} dk_error_description_t;
	186
	187
fe8ab488 A	188	#ifdef KERNEL
	189	#ifdef PRIVATE
	190
	191	/* Definitions of option bits for dk_unmap_t */
	192	#define _DK_UNMAP_INITIALIZE 0x00000100
	193
	194	#endif /* PRIVATE */
	195	#endif /* KERNEL */
	196
0c530ab8	197	#define DKIOCEJECT _IO('d', 21)
3e170ce0	198	#define DKIOCSYNCHRONIZE _IOW('d', 22, dk_synchronize_t)
0c530ab8 A	199
	200	#define DKIOCFORMAT _IOW('d', 26, dk_format_capacity_t)
	201	#define DKIOCGETFORMATCAPACITIES _IOWR('d', 26, dk_format_capacities_t)
91447636	202
2d21ac55 A	203	#define DKIOCGETBLOCKSIZE _IOR('d', 24, uint32_t)
2d21ac55 A	204	#define DKIOCGETBLOCKCOUNT _IOR('d', 25, uint64_t)
0c530ab8	205	#define DKIOCGETFIRMWAREPATH _IOR('d', 28, dk_firmware_path_t)
55e303ae	206
2d21ac55 A	207	#define DKIOCISFORMATTED _IOR('d', 23, uint32_t)
2d21ac55 A	208	#define DKIOCISWRITABLE _IOR('d', 29, uint32_t)
9bccf70c	209
c910b4d9	210	#define DKIOCREQUESTIDLE _IO('d', 30)
060df5ea	211	#define DKIOCUNMAP _IOW('d', 31, dk_unmap_t)
3e170ce0	212	#define DKIOCCORESTORAGE _IOR('d', 32, dk_corestorage_info_t)
593a1d5f	213
2d21ac55 A	214	#define DKIOCGETMAXBLOCKCOUNTREAD _IOR('d', 64, uint64_t)
	215	#define DKIOCGETMAXBLOCKCOUNTWRITE _IOR('d', 65, uint64_t)
	216	#define DKIOCGETMAXBYTECOUNTREAD _IOR('d', 70, uint64_t)
	217	#define DKIOCGETMAXBYTECOUNTWRITE _IOR('d', 71, uint64_t)
9bccf70c	218
2d21ac55 A	219	#define DKIOCGETMAXSEGMENTCOUNTREAD _IOR('d', 66, uint64_t)
	220	#define DKIOCGETMAXSEGMENTCOUNTWRITE _IOR('d', 67, uint64_t)
	221	#define DKIOCGETMAXSEGMENTBYTECOUNTREAD _IOR('d', 68, uint64_t)
	222	#define DKIOCGETMAXSEGMENTBYTECOUNTWRITE _IOR('d', 69, uint64_t)
9bccf70c	223
2d21ac55 A	224	#define DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT _IOR('d', 74, uint64_t)
2d21ac55 A	225	#define DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT _IOR('d', 75, uint64_t)
9bccf70c	226
060df5ea	227	#define DKIOCGETFEATURES _IOR('d', 76, uint32_t)
593a1d5f	228	#define DKIOCGETPHYSICALBLOCKSIZE _IOR('d', 77, uint32_t)
b0d623f7	229	#define DKIOCGETCOMMANDPOOLSIZE _IOR('d', 78, uint32_t)
593a1d5f	230
39037602 A	231	#define DKIOCGETPROVISIONSTATUS _IOWR('d', 79, dk_provision_status_t)
39037602 A	232
d190cdc3 A	233	#define DKIOCGETERRORDESCRIPTION _IOR('d', 80, dk_error_description_t)
d190cdc3 A	234
3e170ce0 A	235	#define DKIOCSYNCHRONIZECACHE _IO('d', 22)
3e170ce0 A	236
9bccf70c	237	#ifdef KERNEL
2d21ac55	238	#define DK_FEATURE_FORCE_UNIT_ACCESS 0x00000001
6d2010ae	239
fe8ab488 A	240	#define DK_ENCRYPTION_TYPE_AES_CBC 1
	241	#define DK_ENCRYPTION_TYPE_AES_XEX 2
	242	#define DK_ENCRYPTION_TYPE_AES_XTS 3
	243
	244	#define DK_TIER_MASK 0xC0
	245	#define DK_TIER_SHIFT 6
	246
	247	#define DK_TIER_TO_PRIORITY(tier) (((tier) << DK_TIER_SHIFT) \| ~DK_TIER_MASK)
	248	#define DK_PRIORITY_TO_TIER(priority) ((priority) >> DK_TIER_SHIFT)
	249
6d2010ae A	250	typedef struct
	251	{
	252	uint64_t offset;
	253	uint64_t length;
	254
	255	uint8_t reserved0128[12]; /* reserved, clear to zero */
	256
	257	dev_t dev;
	258	} dk_physical_extent_t;
	259
fe8ab488 A	260	typedef struct
	261	{
	262	dk_extent_t * extents;
	263	uint32_t extentsCount;
	264
	265	uint8_t tier;
	266
	267	#ifdef __LP64__
	268	uint8_t reserved0104[3]; /* reserved, clear to zero */
	269	#else /* !__LP64__ */
	270	uint8_t reserved0072[7]; /* reserved, clear to zero */
	271	#endif /* !__LP64__ */
	272	} dk_set_tier_t;
	273
2d21ac55 A	274	#define DKIOCSETBLOCKSIZE _IOW('d', 24, uint32_t)
2d21ac55 A	275	#define DKIOCGETBSDUNIT _IOR('d', 27, uint32_t)
6d2010ae	276	#define DKIOCISSOLIDSTATE _IOR('d', 79, uint32_t)
2d21ac55 A	277	#define DKIOCISVIRTUAL _IOR('d', 72, uint32_t)
2d21ac55 A	278	#define DKIOCGETBASE _IOR('d', 73, uint64_t)
6d2010ae A	279	#define DKIOCGETTHROTTLEMASK _IOR('d', 80, uint64_t)
	280	#define DKIOCLOCKPHYSICALEXTENTS _IO('d', 81)
	281	#define DKIOCGETPHYSICALEXTENT _IOWR('d', 82, dk_physical_extent_t)
	282	#define DKIOCUNLOCKPHYSICALEXTENTS _IO('d', 83)
fe8ab488 A	283	#define DKIOCSETTIER _IOW('d', 85, dk_set_tier_t)
	284	#define DKIOCGETENCRYPTIONTYPE _IOR('d', 86, uint32_t)
	285	#define DKIOCISLOWPOWERMODE _IOR('d', 87, uint32_t)
39037602	286	#define DKIOCGETIOMINSATURATIONBYTECOUNT _IOR('d', 88, uint32_t)
39236c6e A	287
	288	#ifdef XNU_KERNEL_PRIVATE
	289	typedef struct
	290	{
	291	boolean_t mi_mdev; /* Is this a memdev device? */
	292	boolean_t mi_phys; /* Physical memory? */
	293	uint32_t mi_base; /* Base page number of the device? */
	294	uint64_t mi_size; /* Size of the device (in ) */
	295	} dk_memdev_info_t;
	296
	297	typedef dk_memdev_info_t memdev_info_t;
	298
	299	#define DKIOCGETMEMDEVINFO _IOR('d', 90, dk_memdev_info_t)
	300	#endif /* XNU_KERNEL_PRIVATE */
7ddcb079	301	#ifdef PRIVATE
316670eb A	302	typedef struct _dk_cs_pin {
	303	dk_extent_t cp_extent;
	304	int64_t cp_flags;
	305	} _dk_cs_pin_t;
3e170ce0 A	306	/* The following are modifiers to _DKIOCCSPINEXTENT/cp_flags operation */
	307	#define _DKIOCCSPINTOFASTMEDIA (0) /* Pin extent to the fast (SSD) media */
	308	#define _DKIOCCSPINFORHIBERNATION (1 << 0) /* Pin of hibernation file, content not preserved */
	309	#define _DKIOCCSPINDISCARDBLACKLIST (1 << 1) /* Hibernation complete/error, stop blacklisting */
	310	#define _DKIOCCSPINTOSLOWMEDIA (1 << 2) /* Pin extent to the slow (HDD) media */
	311	#define _DKIOCCSTEMPORARYPIN (1 << 3) /* Relocate, but do not pin, to indicated media */
	312	#define _DKIOCCSHIBERNATEIMGSIZE (1 << 4) /* Anticipate/Max size of the upcoming hibernate */
	313	#define _DKIOCCSPINFORSWAPFILE (1 << 5) /* Pin of swap file, content not preserved */
	314
	315	#define _DKIOCCSSETLVNAME _IOW('d', 198, char[256])
316670eb A	316	#define _DKIOCCSPINEXTENT _IOW('d', 199, _dk_cs_pin_t)
	317	#define _DKIOCCSUNPINEXTENT _IOW('d', 200, _dk_cs_pin_t)
	318	#define _DKIOCGETMIGRATIONUNITBYTESIZE _IOR('d', 201, uint32_t)
fe8ab488	319
39236c6e A	320	typedef struct _dk_cs_map {
	321	dk_extent_t cm_extent;
	322	uint64_t cm_bytes_mapped;
	323	} _dk_cs_map_t;
fe8ab488 A	324
	325	typedef struct _dk_cs_unmap {
	326	dk_extent_t *extents;
	327	uint32_t extentsCount;
	328	uint32_t options;
	329	} _dk_cs_unmap_t;
	330
39236c6e	331	#define _DKIOCCSMAP _IOWR('d', 202, _dk_cs_map_t)
3e170ce0	332	// No longer used: _DKIOCCSSETFSVNODE (203) & _DKIOCCSGETFREEBYTES (204)
fe8ab488	333	#define _DKIOCCSUNMAP _IOWR('d', 205, _dk_cs_unmap_t)
5ba3f43e A	334
	335	typedef enum {
	336	DK_APFS_ONE_DEVICE = 1,
	337	DK_APFS_FUSION
	338	} dk_apfs_flavour_t;
	339
	340	#define DKIOCGETAPFSFLAVOUR _IOR('d', 91, dk_apfs_flavour_t)
	341
7ddcb079	342	#endif /* PRIVATE */
9bccf70c A	343	#endif /* KERNEL */
9bccf70c A	344
316670eb	345	#ifdef PRIVATE
5ba3f43e A	346	#if TARGET_OS_EMBEDDED
	347	#define _DKIOCSETSTATIC _IO('d', 84)
	348	#endif /* TARGET_OS_EMBEDDED */
316670eb A	349	#endif /* PRIVATE */
316670eb A	350
9bccf70c	351	#endif /* _SYS_DISK_H_ */