projects / apple / xnu.git / blame
| Commit | Line | Data |
|---|---|---|
| 1c79356b A |
1 | /* |
| 2 | * Copyright (c) 2000 Apple Computer, Inc. All rights reserved. | |
| 3 | * | |
| 4 | * @APPLE_LICENSE_HEADER_START@ | |
| 5 | * | |
| d7e50217 | 6 | * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved. |
| 1c79356b | 7 | * |
| d7e50217 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, |
| 18 | * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, | |
| d7e50217 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 | ||
| 26 | /* | |
| 27 | * | |
| 28 | * Copyright (c) 2000 Apple Computer, Inc. All rights reserved. | |
| 29 | * | |
| 30 | * HISTORY | |
| 31 | * | |
| 32 | * 2001-01-18 gvdl Made the primary queue pointer public, to be used when | |
| 33 | * Ownership is clear. | |
| 34 | * 11/13/2000 CJS Created IOCommand class and implementation | |
| 35 | * | |
| 36 | */ | |
| 37 | ||
| 38 | /*! | |
| 39 | * @header IOCommand | |
| 40 | * @abstract | |
| 41 | * This header contains the IOCommand class definition. | |
| 42 | */ | |
| 43 | ||
| 44 | #ifndef _IOKIT_IO_COMMAND_H_ | |
| 45 | #define _IOKIT_IO_COMMAND_H_ | |
| 46 | ||
| 47 | /* | |
| 48 | * Kernel | |
| 49 | */ | |
| 50 | ||
| 51 | #if defined(KERNEL) && defined(__cplusplus) | |
| 52 | ||
| 53 | #include <kern/queue.h> | |
| 54 | #include <libkern/c++/OSObject.h> | |
| 55 | ||
| 56 | class IOCommandPool; | |
| 57 | ||
| 58 | /*! | |
| 59 | * @class IOCommand | |
| 60 | * @abstract | |
| 61 | * This class is an abstract class which represents an I/O command. | |
| 62 | * @discussion | |
| 63 | * This class is an abstract class which represents an I/O command passed | |
| 64 | * from a device driver to a controller. All controller commands (e.g. IOATACommand) | |
| 65 | * should inherit from this class. | |
| 66 | */ | |
| 67 | ||
| 68 | class IOCommand : public OSObject | |
| 69 | { | |
| 70 | OSDeclareAbstractStructors(IOCommand) | |
| 71 | ||
| 72 | protected: | |
| 73 | virtual bool init(void); | |
| 74 | ||
| 75 | public: | |
| 76 | /*! @var fCommandChain | |
| 77 | This variable is used by the current 'owner' to queue the command. During the life cycle of a command it moves through a series of queues. This is the queue pointer for it. Only valid while 'ownership' is clear. For instance a IOCommandPool uses this pointer to maintain its list of free commands. May be manipulated using the kern/queue.h macros */ | |
| 78 | queue_chain_t fCommandChain; /* used to queue commands */ | |
| 79 | }; | |
| 80 | ||
| 81 | #endif /* defined(KERNEL) && defined(__cplusplus) */ | |
| 82 | ||
| 83 | #endif /* _IOKIT_IO_COMMAND_H_ */ |