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

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_HEADER_END@
 */
/*	@(#)disk.h	1.0	08/29/87	(c) 1987 NeXT	*/

#ifndef	_BSD_DEV_DISK_
#define	_BSD_DEV_DISK_
#ifndef	_SYS_DISK_H_
#define	_SYS_DISK_H_

#include <sys/appleapiopts.h>
#include <mach/machine/vm_types.h>
#include <mach/machine/boolean.h>
#include <sys/types.h>
#include <sys/ioctl.h>
#include <sys/time.h>
#include <dev/disk_label.h>

/*
 * USE <sys/disk.h> INSTEAD (NOTE: DKIOCGETBLOCKCOUNT -> DKIOCGETBLOCKCOUNT32)
 */

#ifdef	__APPLE_API_OBSOLETE

#define	DR_CMDSIZE	32
#define	DR_ERRSIZE	32

struct disk_req {
	int	dr_bcount;		/* byte count for data transfers */
	caddr_t	dr_addr;		/* memory addr for data transfers */
	struct	timeval dr_exec_time;	/* execution time of operation */

	/* 
	 * interpretation of cmdblk and errblk is driver specific.
	 */
	char	dr_cmdblk[DR_CMDSIZE];
	char	dr_errblk[DR_ERRSIZE];
};

struct sdc_wire {
	vm_offset_t	start, end;
	boolean_t	new_pageable;
};


#define	BAD_BLK_OFF	4		/* offset of bad blk tbl from label */
#define	NBAD_BLK	(12 * 1024 / sizeof (int))

struct bad_block {			/* bad block table, sized to be 12KB */
	int	bad_blk[NBAD_BLK];
};

/* 
 * sector bitmap states (2 bits per sector) 
 */
#define	SB_UNTESTED	0		/* must be zero */
#define	SB_BAD		1
#define	SB_WRITTEN	2
#define	SB_ERASED	3

struct drive_info {			/* info about drive hardware */
	char	di_name[MAXDNMLEN];	/* drive type name */
	int	di_label_blkno[NLABELS];/* label loc'ns in DEVICE SECTORS */
	int	di_devblklen;		/* device sector size */
	int	di_maxbcount;		/* max bytes per transfer request */
};

#define	DS_STATSIZE	32

struct	disk_stats {
	int	s_ecccnt;	/* avg ECC corrections per sector */
	int	s_maxecc;	/* max ECC corrections observed */

	/* 
	 * interpretation of s_stats is driver specific 
	 */
	char	s_stats[DS_STATSIZE];
};

struct drive_location {
	char	location[ 128 ];
};

#define	DKIOCGLABEL	_IOR('d', 0,struct disk_label)	/* read label */
#define	DKIOCSLABEL	_IOW('d', 1,struct disk_label)	/* write label */
#define	DKIOCGBITMAP	_IO('d', 2)			/* read bitmap */
#define	DKIOCSBITMAP	_IO('d', 3)			/* write bitmap */
#define	DKIOCREQ	_IOWR('d', 4, struct disk_req)	/* cmd request */
#define	DKIOCINFO	_IOR('d', 5, struct drive_info)	/* get drive info */
#define	DKIOCZSTATS	_IO('d',7)			/* zero statistics */
#define	DKIOCGSTATS	_IO('d', 8)			/* get statistics */
#define	DKIOCRESET	_IO('d', 9)			/* reset disk */
#define	DKIOCGFLAGS	_IOR('d', 11, int)		/* get driver flags */
#define	DKIOCSFLAGS	_IOW('d', 12, int)		/* set driver flags */
#define	DKIOCSDCWIRE	_IOW('d', 14, struct sdc_wire)	/* sdc wire memory */
#define	DKIOCSDCLOCK	_IO('d', 15)			/* sdc lock */
#define	DKIOCSDCUNLOCK	_IO('d', 16)			/* sdc unlock */
#define	DKIOCGFREEVOL	_IOR('d', 17, int)		/* get free volume # */
#define	DKIOCGBBT	_IO('d', 18)			/* read bad blk tbl */
#define	DKIOCSBBT	_IO('d', 19)			/* write bad blk tbl */
#define	DKIOCMNOTIFY	_IOW('d', 20, int)		/* message on insert */
#define	DKIOCEJECT	_IO('d', 21)			/* eject disk */
#define	DKIOCPANELPRT	_IOW('d', 22, int)		/* register Panel */
							/* Request port */
#define DKIOCSFORMAT	_IOW('d', 23, int)		/* set 'Formatted' flag */
#define DKIOCGFORMAT	_IOR('d', 23, int)		/* get 'Formatted' flag */ 
#define DKIOCBLKSIZE	_IOR('d', 24, int)		/* device sector size */
#define	DKIOCNUMBLKS	_IOR('d', 25, int)		/* number of sectors */
#define DKIOCCHECKINSERT _IO('d',26)		/* manually poll removable */ 
						/* media drive */
#define DKIOCCANCELAUTOMOUNT _IOW('d',27, dev_t)	/* cancel automount request */
#define DKIOCGLOCATION	_IOR('d',28, struct drive_location)	/* arch dependent location descrip */
#define DKIOCSETBLOCKSIZE   _IOW('d', 24, int)  /* set media's preferred sector size */
#define DKIOCGETBLOCKSIZE   DKIOCBLKSIZE        /* get media's preferred sector size */
#define DKIOCGETBLOCKCOUNT32	DKIOCNUMBLKS    /* get media's sector count */
#define DKIOCGETBLOCKCOUNT64	_IOR('d', 25, u_int64_t) /* get media's sector count */
#define DKIOCGETLOCATION    DKIOCGLOCATION      /* get media's location description */
#define DKIOCISFORMATTED    DKIOCGFORMAT        /* is media formatted? */
#define DKIOCISWRITABLE     _IOR('d', 29, int)  /* is media writable? */

#define DKIOCGETMAXBLOCKCOUNTREAD    _IOR('d', 64, u_int64_t) /* get device's maximum block count for read requests */
#define DKIOCGETMAXBLOCKCOUNTWRITE   _IOR('d', 65, u_int64_t) /* get device's maximum block count for write requests */
#define DKIOCGETMAXSEGMENTCOUNTREAD  _IOR('d', 66, u_int64_t) /* get device's maximum physical segment count for read buffers */
#define DKIOCGETMAXSEGMENTCOUNTWRITE _IOR('d', 67, u_int64_t) /* get device's maximum physical segment count for write buffers */

#endif	/* __APPLE_API_OBSOLETE */

#endif	/* _SYS_DISK_H_ */
#endif	/* _BSD_DEV_DISK_ */
Commit	Line	Data
1c79356b	1	/*
9bccf70c	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/* @(#)disk.h 1.0 08/29/87 (c) 1987 NeXT */
	26
1c79356b A	27	#ifndef _BSD_DEV_DISK_
1c79356b A	28	#define _BSD_DEV_DISK_
9bccf70c A	29	#ifndef _SYS_DISK_H_
9bccf70c A	30	#define _SYS_DISK_H_
1c79356b	31
9bccf70c	32	#include <sys/appleapiopts.h>
1c79356b A	33	#include <mach/machine/vm_types.h>
	34	#include <mach/machine/boolean.h>
	35	#include <sys/types.h>
	36	#include <sys/ioctl.h>
	37	#include <sys/time.h>
	38	#include <dev/disk_label.h>
	39
9bccf70c A	40	/*
	41	* USE <sys/disk.h> INSTEAD (NOTE: DKIOCGETBLOCKCOUNT -> DKIOCGETBLOCKCOUNT32)
	42	*/
	43
	44	#ifdef __APPLE_API_OBSOLETE
	45
1c79356b A	46	#define DR_CMDSIZE 32
	47	#define DR_ERRSIZE 32
	48
	49	struct disk_req {
	50	int dr_bcount; /* byte count for data transfers */
	51	caddr_t dr_addr; /* memory addr for data transfers */
	52	struct timeval dr_exec_time; /* execution time of operation */
	53
	54	/*
	55	* interpretation of cmdblk and errblk is driver specific.
	56	*/
	57	char dr_cmdblk[DR_CMDSIZE];
	58	char dr_errblk[DR_ERRSIZE];
	59	};
	60
	61	struct sdc_wire {
	62	vm_offset_t start, end;
	63	boolean_t new_pageable;
	64	};
	65
	66
	67	#define BAD_BLK_OFF 4 /* offset of bad blk tbl from label */
	68	#define NBAD_BLK (12 * 1024 / sizeof (int))
	69
	70	struct bad_block { /* bad block table, sized to be 12KB */
	71	int bad_blk[NBAD_BLK];
	72	};
	73
	74	/*
	75	* sector bitmap states (2 bits per sector)
	76	*/
	77	#define SB_UNTESTED 0 /* must be zero */
	78	#define SB_BAD 1
	79	#define SB_WRITTEN 2
	80	#define SB_ERASED 3
	81
	82	struct drive_info { /* info about drive hardware */
	83	char di_name[MAXDNMLEN]; /* drive type name */
	84	int di_label_blkno[NLABELS];/* label loc'ns in DEVICE SECTORS */
	85	int di_devblklen; /* device sector size */
	86	int di_maxbcount; /* max bytes per transfer request */
	87	};
	88
	89	#define DS_STATSIZE 32
	90
	91	struct disk_stats {
	92	int s_ecccnt; /* avg ECC corrections per sector */
	93	int s_maxecc; /* max ECC corrections observed */
	94
	95	/*
	96	* interpretation of s_stats is driver specific
	97	*/
	98	char s_stats[DS_STATSIZE];
	99	};
	100
	101	struct drive_location {
	102	char location[ 128 ];
	103	};
	104
	105	#define DKIOCGLABEL _IOR('d', 0,struct disk_label) /* read label */
	106	#define DKIOCSLABEL _IOW('d', 1,struct disk_label) /* write label */
	107	#define DKIOCGBITMAP _IO('d', 2) /* read bitmap */
	108	#define DKIOCSBITMAP _IO('d', 3) /* write bitmap */
	109	#define DKIOCREQ _IOWR('d', 4, struct disk_req) /* cmd request */
110	#define DKIOCINFO _IOR('d', 5, struct drive_info) /* get drive info */
111	#define DKIOCZSTATS _IO('d',7) /* zero statistics */
112	#define DKIOCGSTATS _IO('d', 8) /* get statistics */
113	#define DKIOCRESET _IO('d', 9) /* reset disk */
114	#define DKIOCGFLAGS _IOR('d', 11, int) /* get driver flags */
115	#define DKIOCSFLAGS _IOW('d', 12, int) /* set driver flags */
116	#define DKIOCSDCWIRE _IOW('d', 14, struct sdc_wire) /* sdc wire memory */
117	#define DKIOCSDCLOCK _IO('d', 15) /* sdc lock */
118	#define DKIOCSDCUNLOCK _IO('d', 16) /* sdc unlock */
119	#define DKIOCGFREEVOL _IOR('d', 17, int) /* get free volume # */
120	#define DKIOCGBBT _IO('d', 18) /* read bad blk tbl */
121	#define DKIOCSBBT _IO('d', 19) /* write bad blk tbl */
122	#define DKIOCMNOTIFY _IOW('d', 20, int) /* message on insert */
123	#define DKIOCEJECT _IO('d', 21) /* eject disk */
124	#define DKIOCPANELPRT _IOW('d', 22, int) /* register Panel */
125	/* Request port */
126	#define DKIOCSFORMAT _IOW('d', 23, int) /* set 'Formatted' flag */
127	#define DKIOCGFORMAT _IOR('d', 23, int) /* get 'Formatted' flag */
128	#define DKIOCBLKSIZE _IOR('d', 24, int) /* device sector size */
129	#define DKIOCNUMBLKS _IOR('d', 25, int) /* number of sectors */
130	#define DKIOCCHECKINSERT _IO('d',26) /* manually poll removable */
131	/* media drive */
132	#define DKIOCCANCELAUTOMOUNT _IOW('d',27, dev_t) /* cancel automount request */
133	#define DKIOCGLOCATION _IOR('d',28, struct drive_location) /* arch dependent location descrip */
134	#define DKIOCSETBLOCKSIZE _IOW('d', 24, int) /* set media's preferred sector size */
135	#define DKIOCGETBLOCKSIZE DKIOCBLKSIZE /* get media's preferred sector size */
9bccf70c A	136	#define DKIOCGETBLOCKCOUNT32 DKIOCNUMBLKS /* get media's sector count */
9bccf70c A	137	#define DKIOCGETBLOCKCOUNT64 _IOR('d', 25, u_int64_t) /* get media's sector count */
1c79356b A	138	#define DKIOCGETLOCATION DKIOCGLOCATION /* get media's location description */
	139	#define DKIOCISFORMATTED DKIOCGFORMAT /* is media formatted? */
	140	#define DKIOCISWRITABLE _IOR('d', 29, int) /* is media writable? */
1c79356b	141
0b4e3aa0 A	142	#define DKIOCGETMAXBLOCKCOUNTREAD _IOR('d', 64, u_int64_t) /* get device's maximum block count for read requests */
	143	#define DKIOCGETMAXBLOCKCOUNTWRITE _IOR('d', 65, u_int64_t) /* get device's maximum block count for write requests */
	144	#define DKIOCGETMAXSEGMENTCOUNTREAD _IOR('d', 66, u_int64_t) /* get device's maximum physical segment count for read buffers */
	145	#define DKIOCGETMAXSEGMENTCOUNTWRITE _IOR('d', 67, u_int64_t) /* get device's maximum physical segment count for write buffers */
	146
9bccf70c A	147	#endif /* __APPLE_API_OBSOLETE */
	148
	149	#endif /* _SYS_DISK_H_ */
0b4e3aa0	150	#endif /* _BSD_DEV_DISK_ */