/*
- * Copyright (c) 1998-2002 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2006 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>
+
+/*
+ * Definitions
+ *
+ * ioctl description
+ * ------------------------------------- ---------------------------------------
+ * DKIOCEJECT eject media
+ * DKIOCSYNCHRONIZECACHE 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
+ */
+
+#define DK_FEATURE_UNMAP 0x00000010
+
+typedef struct
+{
+ uint64_t offset;
+ uint64_t length;
+} dk_extent_t;
typedef struct
{
- char path[128];
+ char path[128];
} dk_firmware_path_t;
-#define DKIOCEJECT _IO('d', 21)
-#define DKIOCSYNCHRONIZECACHE _IO('d', 22)
+typedef struct
+{
+ uint64_t blockCount;
+ uint32_t blockSize;
+
+ uint8_t reserved0096[4]; /* reserved, clear to zero */
+} dk_format_capacity_t;
-#define DKIOCGETBLOCKSIZE _IOR('d', 24, u_int32_t)
-#define DKIOCGETBLOCKCOUNT _IOR('d', 25, u_int64_t)
-#define DKIOCGETBLOCKCOUNT32 _IOR('d', 25, u_int32_t)
-#define DKIOCGETFIRMWAREPATH _IOR('d', 28, dk_firmware_path_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
+{
+ dk_extent_t * extents;
+ uint32_t extentsCount;
+
+#ifdef __LP64__
+ uint8_t reserved0096[4]; /* reserved, clear to zero */
+#else /* !__LP64__ */
+ uint8_t reserved0064[8]; /* reserved, clear to zero */
+#endif /* !__LP64__ */
+} dk_unmap_t;
+
+#define DKIOCEJECT _IO('d', 21)
+#define DKIOCSYNCHRONIZECACHE _IO('d', 22)
+
+#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 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)
+
+typedef struct
+{
+ uint64_t offset;
+ uint64_t length;
-#define DKIOCISFORMATTED _IOR('d', 23, u_int32_t)
-#define DKIOCISWRITABLE _IOR('d', 29, u_int32_t)
+ uint8_t reserved0128[16]; /* reserved, clear to zero */
+} dk_discard_t __attribute__ ((deprecated));
-#define DKIOCGETMAXBLOCKCOUNTREAD _IOR('d', 64, u_int64_t)
-#define DKIOCGETMAXBLOCKCOUNTWRITE _IOR('d', 65, u_int64_t)
-#define DKIOCGETMAXSEGMENTCOUNTREAD _IOR('d', 66, u_int64_t)
-#define DKIOCGETMAXSEGMENTCOUNTWRITE _IOR('d', 67, u_int64_t)
+#define DKIOCDISCARD _IOW('d', 31, dk_discard_t)
#ifdef KERNEL
-#define DKIOCSETBLOCKSIZE _IOW('d', 24, u_int32_t)
+#define DK_FEATURE_FORCE_UNIT_ACCESS 0x00000001
+#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)
#endif /* KERNEL */
#endif /* _SYS_DISK_H_ */
projects / apple / xnu.git / blobdiff