/* * IOFireWireLocalNode.h * IOFireWireFamily * * Created by Niels on Fri Aug 16 2002. * Copyright (c) 2002 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@ */ /* $Log: IOFireWireLocalNode.h,v $ Revision 1.8 2009/03/26 22:45:17 calderon <rdar://6728033> User client fails to terminate with unexpected consuequences Revision 1.7 2008/11/14 00:17:12 arulchan fix for rdar://5939334 Revision 1.6 2005/02/18 22:56:53 gecko1 3958781 Q45C EVT: FireWire ASP reporter says port speed is 800 Mb/sec Revision 1.5 2003/02/20 02:00:12 collin *** empty log message *** Revision 1.4 2003/02/17 21:47:53 collin *** empty log message *** Revision 1.3 2002/10/18 23:29:44 collin fix includes, fix cast which fails on new compiler Revision 1.2 2002/09/25 00:27:24 niels flip your world upside-down */ // public #import <IOKit/firewire/IOFireWireNub.h> class IOFireWireLocalNode; #pragma mark - /*! @class IOFireWireLocalNodeAux */ class IOFireWireLocalNodeAux : public IOFireWireNubAux { OSDeclareDefaultStructors(IOFireWireLocalNodeAux) friend class IOFireWireLocalNode; protected: /*! @struct ExpansionData @discussion This structure will be used to expand the capablilties of the class in the future. */ struct ExpansionData { }; /*! @var reserved Reserved for future use. (Internal use only) */ ExpansionData * reserved; virtual bool init( IOFireWireLocalNode * primary ); virtual void free(); private: OSMetaClassDeclareReservedUnused(IOFireWireLocalNodeAux, 0); OSMetaClassDeclareReservedUnused(IOFireWireLocalNodeAux, 1); OSMetaClassDeclareReservedUnused(IOFireWireLocalNodeAux, 2); OSMetaClassDeclareReservedUnused(IOFireWireLocalNodeAux, 3); }; #pragma mark - /*! @class IOFireWireLocalNode */ class IOFireWireLocalNode : public IOFireWireNub { OSDeclareDefaultStructors(IOFireWireLocalNode) friend class IOFireWireLocalNodeAux; /*------------------Useful info about device (also available in the registry)--------*/ protected: /*-----------Methods provided to FireWire device clients-------------*/ public: // Set up properties affected by bus reset virtual void setNodeProperties(UInt32 generation, UInt16 nodeID, UInt32 *selfIDs, int numIDs, IOFWSpeed maxSpeed ); /* * Standard nub initialization */ virtual bool init(OSDictionary * propTable); virtual bool attach(IOService * provider ); virtual void handleClose( IOService * forClient, IOOptionBits options ) ; virtual bool handleOpen( IOService * forClient, IOOptionBits options, void * arg ) ; virtual bool handleIsOpen( const IOService * forClient ) const; /* * Trick method to create protocol user clients */ virtual IOReturn setProperties( OSObject * properties ); protected: virtual IOFireWireNubAux * createAuxiliary( void ); public: virtual IOReturn message( UInt32 type, IOService * provider, void * argument ); virtual void free(); protected: OSSet * fOpenClients; };