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  * DKIOCGETMAXBLOCKCOUNTREAD             get maximum block count for reads
  54  * DKIOCGETMAXBLOCKCOUNTWRITE            get maximum block count for writes
  55  * DKIOCGETMAXBYTECOUNTREAD              get maximum byte count for reads
  56  * DKIOCGETMAXBYTECOUNTWRITE             get maximum byte count for writes
  57  *
  58  * DKIOCGETMAXSEGMENTCOUNTREAD           get maximum segment count for reads
  59  * DKIOCGETMAXSEGMENTCOUNTWRITE          get maximum segment count for writes
  60  * DKIOCGETMAXSEGMENTBYTECOUNTREAD       get maximum segment byte count for reads
  61  * DKIOCGETMAXSEGMENTBYTECOUNTWRITE      get maximum segment byte count for writes
  62  *
  63  * DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  get minimum segment alignment in bytes
  64  * DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT get maximum segment width in bits
  65  */
  66
  67 typedef struct
  68 {
  69     char path[128];
  70 } dk_firmware_path_t;
  71
  72 typedef struct
  73 {
  74     uint64_t               blockCount;
  75     uint32_t               blockSize;
  76
  77     uint8_t                reserved0096[4];        /* reserved, clear to zero */
  78 } dk_format_capacity_t;
  79
  80 typedef struct
  81 {
  82     dk_format_capacity_t * capacities;
  83     uint32_t               capacitiesCount;        /* use zero to probe count */
  84
  85 #ifdef __LP64__
  86     uint8_t                reserved0096[4];        /* reserved, clear to zero */
  87 #else /* !__LP64__ */
  88     uint8_t                reserved0064[8];        /* reserved, clear to zero */
  89 #endif /* !__LP64__ */
  90 } dk_format_capacities_t;
  91
  92 #define DKIOCEJECT                            _IO('d', 21)
  93 #define DKIOCSYNCHRONIZECACHE                 _IO('d', 22)
  94
  95 #define DKIOCFORMAT                           _IOW('d', 26, dk_format_capacity_t)
  96 #define DKIOCGETFORMATCAPACITIES              _IOWR('d', 26, dk_format_capacities_t)
  97
  98 #define DKIOCGETBLOCKSIZE                     _IOR('d', 24, uint32_t)
  99 #define DKIOCGETBLOCKCOUNT                    _IOR('d', 25, uint64_t)
 100 #define DKIOCGETFIRMWAREPATH                  _IOR('d', 28, dk_firmware_path_t)
 101
 102 #define DKIOCISFORMATTED                      _IOR('d', 23, uint32_t)
 103 #define DKIOCISWRITABLE                       _IOR('d', 29, uint32_t)
 104
 105 #define DKIOCGETMAXBLOCKCOUNTREAD             _IOR('d', 64, uint64_t)
 106 #define DKIOCGETMAXBLOCKCOUNTWRITE            _IOR('d', 65, uint64_t)
 107 #define DKIOCGETMAXBYTECOUNTREAD              _IOR('d', 70, uint64_t)
 108 #define DKIOCGETMAXBYTECOUNTWRITE             _IOR('d', 71, uint64_t)
 109
 110 #define DKIOCGETMAXSEGMENTCOUNTREAD           _IOR('d', 66, uint64_t)
 111 #define DKIOCGETMAXSEGMENTCOUNTWRITE          _IOR('d', 67, uint64_t)
 112 #define DKIOCGETMAXSEGMENTBYTECOUNTREAD       _IOR('d', 68, uint64_t)
 113 #define DKIOCGETMAXSEGMENTBYTECOUNTWRITE      _IOR('d', 69, uint64_t)
 114
 115 #define DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  _IOR('d', 74, uint64_t)
 116 #define DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT _IOR('d', 75, uint64_t)
 117
 118 #ifdef KERNEL
 119 #define DK_FEATURE_FORCE_UNIT_ACCESS          0x00000001
 120 #define DKIOCGETBLOCKCOUNT32                  _IOR('d', 25, uint32_t)
 121 #define DKIOCSETBLOCKSIZE                     _IOW('d', 24, uint32_t)
 122 #define DKIOCGETBSDUNIT                       _IOR('d', 27, uint32_t)
 123 #define DKIOCISVIRTUAL                        _IOR('d', 72, uint32_t)
 124 #define DKIOCGETBASE                          _IOR('d', 73, uint64_t)
 125 #define DKIOCGETFEATURES                      _IOR('d', 76, uint32_t)
 126 #endif /* KERNEL */
 127
 128 #endif  /* _SYS_DISK_H_ */