bsd/sys/disk.h

   1 /*
   2  * Copyright (c) 1998-2005 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 <sys/ioctl.h>
  33 #include <sys/types.h>
  34 #include <sys/cdefs.h>
  35
  36 /*
  37  * Definitions
  38  *
  39  * ioctl                                 description
  40  * ------------------------------------- ---------------------------------------
  41  * DKIOCEJECT                            eject media
  42  * DKIOCSYNCHRONIZECACHE                 flush media
  43  *
  44  * DKIOCFORMAT                           format media
  45  * DKIOCGETFORMATCAPACITIES              get media's formattable capacities
  46  *
  47  * DKIOCGETBLOCKSIZE                     get media's block size
  48  * DKIOCGETBLOCKCOUNT                    get media's block count
  49  * DKIOCGETFIRMWAREPATH                  get media's firmware path
  50  *
  51  * DKIOCISFORMATTED                      is media formatted?
  52  * DKIOCISWRITABLE                       is media writable?
  53  *
  54  * DKIOCGETMAXBLOCKCOUNTREAD             get maximum block count for reads
  55  * DKIOCGETMAXBLOCKCOUNTWRITE            get maximum block count for writes
  56  * DKIOCGETMAXBYTECOUNTREAD              get maximum byte count for reads
  57  * DKIOCGETMAXBYTECOUNTWRITE             get maximum byte count for writes
  58  *
  59  * DKIOCGETMAXSEGMENTCOUNTREAD           get maximum segment count for reads
  60  * DKIOCGETMAXSEGMENTCOUNTWRITE          get maximum segment count for writes
  61  * DKIOCGETMAXSEGMENTBYTECOUNTREAD       get maximum segment byte count for reads
  62  * DKIOCGETMAXSEGMENTBYTECOUNTWRITE      get maximum segment byte count for writes
  63  *
  64  * DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  get minimum segment alignment in bytes
  65  * DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT get maximum segment width in bits
  66  */
  67
  68 #pragma pack(4)
  69
  70 typedef struct
  71 {
  72     char path[128];
  73 } dk_firmware_path_t;
  74
  75 typedef struct
  76 {
  77     u_int64_t              blockCount;
  78     u_int32_t              blockSize;
  79
  80     u_int8_t               reserved0096[4];        /* reserved, clear to zero */
  81 } dk_format_capacity_t;
  82
  83 /* LP64todo: not 64-bit clean */
  84 typedef struct
  85 {
  86     dk_format_capacity_t * capacities;
  87     u_int32_t              capacitiesCount;        /* use zero to probe count */
  88
  89     u_int8_t               reserved0064[8];        /* reserved, clear to zero */
  90 } dk_format_capacities_t;
  91
  92 #pragma pack()
  93
  94 #define DKIOCEJECT                            _IO('d', 21)
  95 #define DKIOCSYNCHRONIZECACHE                 _IO('d', 22)
  96
  97 #define DKIOCFORMAT                           _IOW('d', 26, dk_format_capacity_t)
  98 #define DKIOCGETFORMATCAPACITIES              _IOWR('d', 26, dk_format_capacities_t)
  99
 100 #define DKIOCGETBLOCKSIZE                     _IOR('d', 24, u_int32_t)
 101 #define DKIOCGETBLOCKCOUNT                    _IOR('d', 25, u_int64_t)
 102 #define DKIOCGETFIRMWAREPATH                  _IOR('d', 28, dk_firmware_path_t)
 103
 104 #define DKIOCISFORMATTED                      _IOR('d', 23, u_int32_t)
 105 #define DKIOCISWRITABLE                       _IOR('d', 29, u_int32_t)
 106
 107 #define DKIOCGETMAXBLOCKCOUNTREAD             _IOR('d', 64, u_int64_t)
 108 #define DKIOCGETMAXBLOCKCOUNTWRITE            _IOR('d', 65, u_int64_t)
 109 #define DKIOCGETMAXBYTECOUNTREAD              _IOR('d', 70, u_int64_t)
 110 #define DKIOCGETMAXBYTECOUNTWRITE             _IOR('d', 71, u_int64_t)
 111
 112 #define DKIOCGETMAXSEGMENTCOUNTREAD           _IOR('d', 66, u_int64_t)
 113 #define DKIOCGETMAXSEGMENTCOUNTWRITE          _IOR('d', 67, u_int64_t)
 114 #define DKIOCGETMAXSEGMENTBYTECOUNTREAD       _IOR('d', 68, u_int64_t)
 115 #define DKIOCGETMAXSEGMENTBYTECOUNTWRITE      _IOR('d', 69, u_int64_t)
 116
 117 #define DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  _IOR('d', 74, u_int64_t)
 118 #define DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT _IOR('d', 75, u_int64_t)
 119
 120 #ifdef KERNEL
 121 #define DKIOCGETBLOCKCOUNT32                  _IOR('d', 25, u_int32_t)
 122 #define DKIOCSETBLOCKSIZE                     _IOW('d', 24, u_int32_t)
 123 #define DKIOCGETBSDUNIT                       _IOR('d', 27, u_int32_t)
 124 #define DKIOCISVIRTUAL                        _IOR('d', 72, u_int32_t)
 125 #define DKIOCGETBASE                          _IOR('d', 73, u_int64_t)
 126 #endif /* KERNEL */
 127
 128 #endif  /* _SYS_DISK_H_ */