xnu-792.12.6.tar.gz

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

/*
 * Copyright (c) 1998-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_OSREFERENCE_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_LICENSE_OSREFERENCE_HEADER_END@
 */

#ifndef	_SYS_DISK_H_
#define	_SYS_DISK_H_

#include <sys/ioctl.h>
#include <sys/types.h>
#include <sys/cdefs.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?
 *
 * 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
 */

#if __DARWIN_ALIGN_POWER
#pragma options align=power
#endif

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

typedef struct
{
    u_int64_t              blockCount;
    u_int32_t              blockSize;

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

/* LP64todo: not 64-bit clean */
typedef struct
{
    dk_format_capacity_t * capacities;
    u_int32_t              capacitiesCount;        /* use zero to probe count */

    u_int8_t               reserved0064[8];        /* reserved, clear to zero */
} dk_format_capacities_t;

#if __DARWIN_ALIGN_POWER
#pragma options align=reset
#endif

#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, u_int32_t)
#define DKIOCGETBLOCKCOUNT               _IOR('d', 25, u_int64_t)
#define DKIOCGETFIRMWAREPATH             _IOR('d', 28, dk_firmware_path_t)

#define DKIOCISFORMATTED                 _IOR('d', 23, u_int32_t)
#define DKIOCISWRITABLE                  _IOR('d', 29, u_int32_t)

#define DKIOCGETMAXBLOCKCOUNTREAD        _IOR('d', 64, u_int64_t)
#define DKIOCGETMAXBLOCKCOUNTWRITE       _IOR('d', 65, u_int64_t)
#define DKIOCGETMAXBYTECOUNTREAD         _IOR('d', 70, u_int64_t)
#define DKIOCGETMAXBYTECOUNTWRITE        _IOR('d', 71, u_int64_t)
#define DKIOCGETMAXSEGMENTCOUNTREAD      _IOR('d', 66, u_int64_t)
#define DKIOCGETMAXSEGMENTCOUNTWRITE     _IOR('d', 67, u_int64_t)
#define DKIOCGETMAXSEGMENTBYTECOUNTREAD  _IOR('d', 68, u_int64_t)
#define DKIOCGETMAXSEGMENTBYTECOUNTWRITE _IOR('d', 69, u_int64_t)

#ifdef KERNEL
#define DKIOCGETBLOCKCOUNT32             _IOR('d', 25, u_int32_t)
#define DKIOCSETBLOCKSIZE                _IOW('d', 24, u_int32_t)
#define DKIOCGETBSDUNIT                  _IOR('d', 27, u_int32_t)
#define DKIOCISVIRTUAL                   _IOR('d', 72, u_int32_t)
#define DKIOCGETBASE                     _IOR('d', 73, u_int64_t)
#endif /* KERNEL */

#endif	/* _SYS_DISK_H_ */