[apple/xnu.git] / iokit / IOKit / ata / ata-device / ATADevice.h

/*
 * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 *
 * ATADevice.h
 *
 */

#ifndef _ATADEVICE_H
#define _ATADEVICE_H

#define kDefaultInquirySize	255

typedef UInt32 ATAUnit;

    
enum ATADeviceTimeouts
{
    kATATimerIntervalmS 	= 500,
    kATAProbeTimeoutmS	 	= 5000,
    kATAResetIntervalmS 	= 3000,
    kATAAbortTimeoutmS  	= 5000,
    kATAReqSenseTimeoutmS	= 5000,
    kATADisableTimeoutmS	= 5000,
    kATAResetPollIntervalmS     = 50,
    kATAResetTimeoutmS		= 25000,
    kATABusyTimeoutmS		= 10,
    kATADRQTimeoutmS		= 10,
};

enum ATAClientMessage
{
    kATAClientMsgNone	 		=  0x00005000,
    kATAClientMsgDeviceAbort,
    kATAClientMsgDeviceReset,
    kATAClientMsgBusReset,
    kATAClientMsgSelectTiming,		

    kATAClientMsgDone			= 0x80000000,
};

enum ATAQueueType
{
    kATAQTypeNormalQ		= 0,
    kATAQTypeBypassQ		= 1,
};

enum ATAQueuePosition
{
    kATAQPositionTail		= 0,
    kATAQPositionHead		= 1,
};


#define kATAPropertyProtocol		"ATA Protocol"			/* IOCString */
#define kATAPropertyDeviceNumber 	"ATA Device Number"    		/* OSNumber  */
#define kATAPropertyDeviceType		"ATA Device Type"		/* IOCString */
#define kATAPropertyDeviceId		"ATA Device Id"			/* OSNumber  */
#define kATAPropertyModelNumber		"ATA Device Model Number"	/* IOCString */
#define kATAPropertyFirmwareRev		"ATA Device Firmware Revision"  /* IOCString */
#define kATAPropertyVendorName		"ATA Device Vendor Name"	/* IOCString */
#define kATAPropertyProductName		"ATA Device Product Name"	/* IOCString */
#define kATAPropertyProductRevision	"ATA Device Product Revision"	/* IOCString */
#define kATAPropertyLocation		"IOUnit"			/* OSNumber  */

#define kATAMaxProperties		9

#define kATAPropertyProtocolATA		"ATA"
#define kATAPropertyProtocolATAPI	"ATAPI"

#define kATADeviceTypeDisk		"Disk"
#define kATADeviceTypeTape		"Tape"
#define kATADeviceTypeCDRom		"CDRom"
#define kATADeviceTypeScanner		"Scanner"
#define kATADeviceTypeOther		"Other"

#endif
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
	11	*
	12	* This Original Code and all software distributed under the License are
	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*
	23	*
	24	* ATADevice.h
	25	*
	26	*/
	27
	28	#ifndef _ATADEVICE_H
	29	#define _ATADEVICE_H
	30
	31	#define kDefaultInquirySize 255
	32
	33	typedef UInt32 ATAUnit;
	34
	35
	36	enum ATADeviceTimeouts
	37	{
	38	kATATimerIntervalmS = 500,
	39	kATAProbeTimeoutmS = 5000,
	40	kATAResetIntervalmS = 3000,
	41	kATAAbortTimeoutmS = 5000,
	42	kATAReqSenseTimeoutmS = 5000,
	43	kATADisableTimeoutmS = 5000,
	44	kATAResetPollIntervalmS = 50,
	45	kATAResetTimeoutmS = 25000,
	46	kATABusyTimeoutmS = 10,
	47	kATADRQTimeoutmS = 10,
	48	};
	49
	50	enum ATAClientMessage
	51	{
	52	kATAClientMsgNone = 0x00005000,
	53	kATAClientMsgDeviceAbort,
	54	kATAClientMsgDeviceReset,
	55	kATAClientMsgBusReset,
	56	kATAClientMsgSelectTiming,
	57
	58	kATAClientMsgDone = 0x80000000,
	59	};
	60
	61	enum ATAQueueType
	62	{
	63	kATAQTypeNormalQ = 0,
	64	kATAQTypeBypassQ = 1,
65	};
66
67	enum ATAQueuePosition
68	{
69	kATAQPositionTail = 0,
70	kATAQPositionHead = 1,
71	};
72
73
74	#define kATAPropertyProtocol "ATA Protocol" /* IOCString */
75	#define kATAPropertyDeviceNumber "ATA Device Number" /* OSNumber */
76	#define kATAPropertyDeviceType "ATA Device Type" /* IOCString */
77	#define kATAPropertyDeviceId "ATA Device Id" /* OSNumber */
78	#define kATAPropertyModelNumber "ATA Device Model Number" /* IOCString */
79	#define kATAPropertyFirmwareRev "ATA Device Firmware Revision" /* IOCString */
80	#define kATAPropertyVendorName "ATA Device Vendor Name" /* IOCString */
81	#define kATAPropertyProductName "ATA Device Product Name" /* IOCString */
82	#define kATAPropertyProductRevision "ATA Device Product Revision" /* IOCString */
83	#define kATAPropertyLocation "IOUnit" /* OSNumber */
84
85	#define kATAMaxProperties 9
86
87	#define kATAPropertyProtocolATA "ATA"
88	#define kATAPropertyProtocolATAPI "ATAPI"
89
90	#define kATADeviceTypeDisk "Disk"
91	#define kATADeviceTypeTape "Tape"
92	#define kATADeviceTypeCDRom "CDRom"
93	#define kATADeviceTypeScanner "Scanner"
94	#define kATADeviceTypeOther "Other"
95
96	#endif