iokit/IOKit/IOService.h

45 #include <IOKit/IOReturn.h>
170 typedef IOReturn (*IOServiceInterestHandler)( void * target, void * refCon,
405 virtual IOReturn configureReport(IOReportChannelList   *channels,
419 virtual IOReturn updateReport(IOReportChannelList      *channels,
661         IOReturn waitQuiet(mach_timespec_t * timeout)
670     IOReturn waitQuiet(uint64_t timeout = UINT64_MAX);
993     @result An IOReturn code; <code>kIOReturnSuccess</code> if the function was successfully executed, <code>kIOReturnUnsupported</code> if a service to execute the function could not be found. Other return codes may be returned by the function.*/
995     virtual IOReturn callPlatformFunction( const OSSymbol * functionName,
1000     virtual IOReturn callPlatformFunction( const char * functionName,
1041     @result An IOReturn code; <code>kIOReturnSuccess</code> is necessary for the IOService object to be successfully used, otherwise the registration process for the object is halted. */
1043     virtual IOReturn getResources( void );
1094     @result An IOReturn code.<br><code>kIOReturnNoInterrupt</code> is returned if the source is not valid; <code>kIOReturnNoResources</code> is returned if the interrupt already has an installed handler. */
1096     virtual IOReturn registerInterrupt(int source, OSObject *target,
1104     @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */
1106     virtual IOReturn unregisterInterrupt(int source);
1113     IOReturn addInterruptStatistics(IOInterruptAccountingData * statistics, int source);
1119     IOReturn removeInterruptStatistics(int source);
1125     @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */
1127     virtual IOReturn getInterruptType(int source, int *interruptType);
1133     @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */
1135     virtual IOReturn enableInterrupt(int source);
1141     @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */
1143     virtual IOReturn disableInterrupt(int source);
1149     @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */
1151     virtual IOReturn causeInterrupt(int source);
1157     @result An IOReturn code. */
1159     virtual IOReturn requestProbe( IOOptionBits options );
1169     @result An IOReturn code defined by the message type. */
1171     virtual IOReturn message( UInt32 type, IOService * provider,
1183     virtual IOReturn messageClient( UInt32 messageType, OSObject * client,
1194     virtual IOReturn messageClients( UInt32 type,
1211     virtual IOReturn acknowledgeNotification( IONotificationRef notification,
1226     virtual IOReturn newUserClient( task_t owningTask, void * securityID,
1230     virtual IOReturn newUserClient( task_t owningTask, void * securityID,
1236     @abstract Supplies a programmer-friendly string from an IOReturn code.
1237     @discussion Strings are available for the standard return codes in <code>IOReturn.h</code> in IOService, while subclasses may implement this method to interpret family dependent return codes.
1238     @param rtn The IOReturn code.
1241     virtual const char * stringFromReturn( IOReturn rtn );
1244     @abstract Translates an IOReturn code to a BSD <code>errno</code>.
1245     @discussion BSD defines its own return codes for its functions in <code>sys/errno.h</code>, and I/O Kit families may need to supply compliant results in BSD shims. Results are available for the standard return codes in <code>IOReturn.h</code> in IOService, while subclasses may implement this method to interpret family dependent return codes.
1246     @param rtn The IOReturn code.
1249     virtual int errnoFromReturn( IOReturn rtn );
1281     static IOReturn catalogNewDrivers( OSOrderedSet * newTables );
1287     IOReturn setAuthorizationID( uint64_t authorizationID );
1290     static IOReturn waitMatchIdle( UInt32 ms );
1371         IOReturn waitForState( UInt32 mask, UInt32 value,
1374     IOReturn waitForState( UInt32 mask, UInt32 value, uint64_t timeout );
1400         IOReturn resolveInterrupt(IOService *nub, int source);
1402         IOReturn lookupInterrupt(int source, bool resolve, IOInterruptController **interruptController);
1442     virtual IOReturn registerPowerDriver(
1467     IOReturn deRegisterInterestedDriver( IOService * theDriver );
1477     IOReturn acknowledgePowerChange( IOService * whichDriver );
1486     IOReturn acknowledgeSetPowerState( void );
1492     virtual IOReturn requestPowerDomainState(
1504     IOReturn makeUsable( void );
1512     IOReturn temporaryPowerClampOn( void );
1524     IOReturn changePowerStateTo( unsigned long ordinal );
1565     virtual IOReturn setAggressiveness(
1575     virtual IOReturn getAggressiveness(
1584     virtual IOReturn systemWake( void )
1591     virtual IOReturn temperatureCriticalForZone( IOService * whichZone )
1598     virtual IOReturn youAreRoot( void )
1604     virtual IOReturn setPowerParent(
1616     virtual IOReturn addPowerChild( IOService * theChild );
1622     virtual IOReturn removePowerChild( IOPowerConnection * theChild );
1657     virtual IOReturn setIdleTimerPeriod( unsigned long );
1684     virtual IOReturn setPowerState(
1730     virtual IOReturn powerStateWillChangeTo(
1744     virtual IOReturn powerStateDidChangeTo(
1763     virtual IOReturn newTemperature( long currentTemp, IOService * whichZone )
1771     virtual IOReturn allowPowerChange( unsigned long refcon );
1772     virtual IOReturn cancelPowerChange( unsigned long refcon );
1783     IOReturn changePowerStateToPriv( unsigned long ordinal );
1790     IOReturn powerOverrideOnPriv( void );
1797     IOReturn powerOverrideOffPriv( void );
1810     IOReturn synchronizePowerTree( IOOptionBits options = 0, IOService * notifyRoot = 0 );
1813     IOReturn changePowerStateWithOverrideTo( IOPMPowerStateIndex ordinal, IOPMRequestTag tag );
1814     IOReturn changePowerStateForRootDomain( IOPMPowerStateIndex ordinal );
1815     IOReturn setIgnoreIdleTimer( bool ignore );
1822     IOReturn registerInterestForNotifer( IONotifier *notify, const OSSymbol * typeOfInterest,
1837     IOReturn serializedAllowPowerChange2 ( unsigned long );
1838     IOReturn serializedCancelPowerChange2 ( unsigned long );
1839     IOReturn powerDomainWillChangeTo( IOPMPowerFlags, IOPowerConnection * );
1840     IOReturn powerDomainDidChangeTo( IOPMPowerFlags, IOPowerConnection * );
1845     IOReturn startPowerChange( IOPMPowerChangeFlags, IOPMPowerStateIndex, IOPMPowerFlags, IOPowerConnection *, IOPMPowerFlags );
1847     IOReturn notifyAll ( uint32_t nextMS );
1866     IOReturn ParentChangeStart( void );
1891     static IOReturn actionAckTimerExpired(OSObject *, void *, void *, void *, void * );
1892     static IOReturn watchdog_timer_expired ( OSObject *, void *, void *, void *, void * );
1894     static IOReturn actionDriverCalloutDone(OSObject *, void *, void *, void *, void * );
1940     IOReturn requestPowerState( const OSSymbol * client, uint32_t state );
1941     IOReturn requestDomainPower( IOPMPowerStateIndex ourPowerState, IOOptionBits options = 0 );
1942     IOReturn configurePowerStatesReport( IOReportConfigureAction action, void *result );
1943     IOReturn updatePowerStatesReport( IOReportConfigureAction action, void *result, void *destination );
1944     IOReturn configureSimplePowerReport(IOReportConfigureAction action, void *result );
1945     IOReturn updateSimplePowerReport( IOReportConfigureAction action, void *result, void *destination );