bsd/sys/disk.h

   1 /*
   2  * Copyright (c) 1998-2006 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 /*
  36  * Definitions
  37  *
  38  * ioctl                                 description
  39  * ------------------------------------- ---------------------------------------
  40  * DKIOCEJECT                            eject media
  41  * DKIOCSYNCHRONIZECACHE                 flush media
  42  *
  43  * DKIOCFORMAT                           format media
  44  * DKIOCGETFORMATCAPACITIES              get media's formattable capacities
  45  *
  46  * DKIOCGETBLOCKSIZE                     get media's block size
  47  * DKIOCGETBLOCKCOUNT                    get media's block count
  48  * DKIOCGETFIRMWAREPATH                  get media's firmware path
  49  *
  50  * DKIOCISFORMATTED                      is media formatted?
  51  * DKIOCISWRITABLE                       is media writable?
  52  *
  53  * DKIOCREQUESTIDLE                      idle media
  54  * DKIOCUNMAP                            delete unused data
  55  *
  56  * DKIOCGETMAXBLOCKCOUNTREAD             get maximum block count for reads
  57  * DKIOCGETMAXBLOCKCOUNTWRITE            get maximum block count for writes
  58  * DKIOCGETMAXBYTECOUNTREAD              get maximum byte count for reads
  59  * DKIOCGETMAXBYTECOUNTWRITE             get maximum byte count for writes
  60  *
  61  * DKIOCGETMAXSEGMENTCOUNTREAD           get maximum segment count for reads
  62  * DKIOCGETMAXSEGMENTCOUNTWRITE          get maximum segment count for writes
  63  * DKIOCGETMAXSEGMENTBYTECOUNTREAD       get maximum segment byte count for reads
  64  * DKIOCGETMAXSEGMENTBYTECOUNTWRITE      get maximum segment byte count for writes
  65  *
  66  * DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  get minimum segment alignment in bytes
  67  * DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT get maximum segment width in bits
  68  *
  69  * DKIOCGETFEATURES                      get device's feature set
  70  * DKIOCGETPHYSICALBLOCKSIZE             get device's block size
  71  * DKIOCGETCOMMANDPOOLSIZE               get device's queue depth
  72  */
  73
  74 #define DK_FEATURE_UNMAP                      0x00000010
  75
  76 typedef struct
  77 {
  78     uint64_t               offset;
  79     uint64_t               length;
  80 } dk_extent_t;
  81
  82 typedef struct
  83 {
  84     char                   path[128];
  85 } dk_firmware_path_t;
  86
  87 typedef struct
  88 {
  89     uint64_t               blockCount;
  90     uint32_t               blockSize;
  91
  92     uint8_t                reserved0096[4];        /* reserved, clear to zero */
  93 } dk_format_capacity_t;
  94
  95 typedef struct
  96 {
  97     dk_format_capacity_t * capacities;
  98     uint32_t               capacitiesCount;        /* use zero to probe count */
  99
 100 #ifdef __LP64__
 101     uint8_t                reserved0096[4];        /* reserved, clear to zero */
 102 #else /* !__LP64__ */
 103     uint8_t                reserved0064[8];        /* reserved, clear to zero */
 104 #endif /* !__LP64__ */
 105 } dk_format_capacities_t;
 106
 107 typedef struct
 108 {
 109     dk_extent_t *          extents;
 110     uint32_t               extentsCount;
 111
 112 #ifdef __LP64__
 113     uint8_t                reserved0096[4];        /* reserved, clear to zero */
 114 #else /* !__LP64__ */
 115     uint8_t                reserved0064[8];        /* reserved, clear to zero */
 116 #endif /* !__LP64__ */
 117 } dk_unmap_t;
 118
 119 #define DKIOCEJECT                            _IO('d', 21)
 120 #define DKIOCSYNCHRONIZECACHE                 _IO('d', 22)
 121
 122 #define DKIOCFORMAT                           _IOW('d', 26, dk_format_capacity_t)
 123 #define DKIOCGETFORMATCAPACITIES              _IOWR('d', 26, dk_format_capacities_t)
 124
 125 #define DKIOCGETBLOCKSIZE                     _IOR('d', 24, uint32_t)
 126 #define DKIOCGETBLOCKCOUNT                    _IOR('d', 25, uint64_t)
 127 #define DKIOCGETFIRMWAREPATH                  _IOR('d', 28, dk_firmware_path_t)
 128
 129 #define DKIOCISFORMATTED                      _IOR('d', 23, uint32_t)
 130 #define DKIOCISWRITABLE                       _IOR('d', 29, uint32_t)
 131
 132 #define DKIOCREQUESTIDLE                      _IO('d', 30)
 133 #define DKIOCUNMAP                            _IOW('d', 31, dk_unmap_t)
 134
 135 #define DKIOCGETMAXBLOCKCOUNTREAD             _IOR('d', 64, uint64_t)
 136 #define DKIOCGETMAXBLOCKCOUNTWRITE            _IOR('d', 65, uint64_t)
 137 #define DKIOCGETMAXBYTECOUNTREAD              _IOR('d', 70, uint64_t)
 138 #define DKIOCGETMAXBYTECOUNTWRITE             _IOR('d', 71, uint64_t)
 139
 140 #define DKIOCGETMAXSEGMENTCOUNTREAD           _IOR('d', 66, uint64_t)
 141 #define DKIOCGETMAXSEGMENTCOUNTWRITE          _IOR('d', 67, uint64_t)
 142 #define DKIOCGETMAXSEGMENTBYTECOUNTREAD       _IOR('d', 68, uint64_t)
 143 #define DKIOCGETMAXSEGMENTBYTECOUNTWRITE      _IOR('d', 69, uint64_t)
 144
 145 #define DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  _IOR('d', 74, uint64_t)
 146 #define DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT _IOR('d', 75, uint64_t)
 147
 148 #define DKIOCGETFEATURES                      _IOR('d', 76, uint32_t)
 149 #define DKIOCGETPHYSICALBLOCKSIZE             _IOR('d', 77, uint32_t)
 150 #define DKIOCGETCOMMANDPOOLSIZE               _IOR('d', 78, uint32_t)
 151
 152 #ifdef KERNEL
 153 #define DK_FEATURE_FORCE_UNIT_ACCESS          0x00000001
 154
 155 typedef struct
 156 {
 157     uint64_t               offset;
 158     uint64_t               length;
 159
 160     uint8_t                reserved0128[12];       /* reserved, clear to zero */
 161
 162     dev_t                  dev;
 163 } dk_physical_extent_t;
 164
 165 #define DKIOCGETBLOCKCOUNT32                  _IOR('d', 25, uint32_t)
 166 #define DKIOCSETBLOCKSIZE                     _IOW('d', 24, uint32_t)
 167 #define DKIOCGETBSDUNIT                       _IOR('d', 27, uint32_t)
 168 #define DKIOCISSOLIDSTATE                     _IOR('d', 79, uint32_t)
 169 #define DKIOCISVIRTUAL                        _IOR('d', 72, uint32_t)
 170 #define DKIOCGETBASE                          _IOR('d', 73, uint64_t)
 171 #define DKIOCGETTHROTTLEMASK                  _IOR('d', 80, uint64_t)
 172 #define DKIOCLOCKPHYSICALEXTENTS              _IO('d', 81)
 173 #define DKIOCGETPHYSICALEXTENT                _IOWR('d', 82, dk_physical_extent_t)
 174 #define DKIOCUNLOCKPHYSICALEXTENTS            _IO('d', 83)
 175 #ifdef PRIVATE
 176 typedef struct _dk_cs_pin {
 177         dk_extent_t     cp_extent;
 178         int64_t         cp_flags;
 179 } _dk_cs_pin_t;
 180 #define _DKIOCSPINDISCARDDATA (1 << 0)
 181 #define _DKIOCCSPINEXTENT                     _IOW('d', 199, _dk_cs_pin_t)
 182 #define _DKIOCCSUNPINEXTENT                   _IOW('d', 200, _dk_cs_pin_t)
 183 #define _DKIOCGETMIGRATIONUNITBYTESIZE        _IOR('d', 201, uint32_t)
 184 #endif /* PRIVATE */
 185 #endif /* KERNEL */
 186
 187 #ifdef PRIVATE
 188 #ifdef TARGET_OS_EMBEDDED
 189 #define _DKIOCSETSTATIC                       _IO('d', 84)
 190 #endif /* TARGET_OS_EMBEDDED */
 191 #endif /* PRIVATE */
 192
 193 #endif  /* _SYS_DISK_H_ */