CFMutableDictionaryRef IOBSDNameMatching( mach_port_t masterPort, unsigned int options, const char * bsdName );
IOServices that represent BSD devices have an associated BSD name. This function creates a matching dictionary that will match IOService's with a given BSD name.
Result: The matching dictionary created, is returned on success, or zero on failure. The dictionary is commonly passed to IOServiceGetMatchingServices or IOServiceAddNotification which will consume a reference, otherwise it should be released with CFRelease by the caller.
Name Description masterPort The master port obtained from IOMasterPort(). options No options are currently defined. bsdName The BSD name, as a const char *.
kern_return_t IOConnectAddClient( io_connect_t connect, io_connect_t client );
This is a generic method to inform a family connection of a second connection, and is rarely used.
Result: A kern_return_t error code returned by the family.
Name Description connect The connect handle created by IOServiceOpen. client Another connect handle created by IOServiceOpen.
kern_return_t IOConnectGetService( io_connect_t connect, io_service_t * service );
Finds the service object a connection was opened on.
Result: A kern_return_t error code.
Name Description connect The connect handle created by IOServiceOpen. service On succes, the service handle the connection was opened on, which should be released with IOObjectRelease.
kern_return_t IOConnectMapMemory( io_connect_t connect, unsigned int memoryType, task_port_t intoTask, vm_address_t * atAddress, vm_size_t * ofSize, IOOptionBits options );
This is a generic method to create a mapping in the callers task. The family will interpret the type parameter to determine what sort of mapping is being requested. Cache modes and placed mappings may be requested by the caller.
Result: A kern_return_t error code.
Name Description connect The connect handle created by IOServiceOpen. memoryType What is being requested to be mapped, not interpreted by IOKit and family defined. The family may support physical hardware or shared memory mappings. intoTask The task port for the task in which to create the mapping. This may be different to the task which the opened the connection. atAddress An in/out parameter - if the kIOMapAnywhere option is not set, the caller should pass the address where it requests the mapping be created, otherwise nothing need to set on input. The address of the mapping created is passed back on sucess. ofSize The size of the mapping created is passed back on success.
kern_return_t IOConnectSetCFProperties( io_connect_t connect, CFTypeRef properties );
This is a generic method to pass a CF container of properties to the connection. The properties are interpreted by the family and commonly represent configuration settings, but may be interpreted as anything.
Result: A kern_return_t error code returned by the family.
Name Description connect The connect handle created by IOServiceOpen. properties A CF container - commonly a CFDictionary but this is not enforced. The container should consist of objects which are understood by IOKit - these are currently : CFDictionary, CFArray, CFSet, CFString, CFData, CFNumber, CFBoolean, and are passed in the kernel as the corresponding OSDictionary etc. objects.
kern_return_t IOConnectSetNotificationPort( io_connect_t connect, unsigned int type, mach_port_t port, unsigned int reference );
This is a generic method to pass a mach port send right to be be used by family specific notifications.
Result: A kern_return_t error code.
Name Description connect The connect handle created by IOServiceOpen. type The type of notification requested, not interpreted by IOKit and family defined. port The port to which to send notifications. reference Some families may support passing a reference parameter for the callers use with the notification.
kern_return_t IOCreateReceivePort( int msgType, mach_port_t * recvPort );
In the future IOKit may use specialized messages and ports instead of the standard ports created by mach_port_allocate(). Use this function instead of mach_port_allocate() to ensure compatibility with future revisions of IOKit.
Result: A kern_return_t error code.
Name Description msgType Type of message to be sent to this port (kOSNotificationMessageID or kOSAsyncCompleteMessageID) recvPort The created port is returned.
boolean_t IOIteratorIsValid( io_iterator_t iterator );
Some iterators will be made invalid if changes are made to the structure they are iterating over. This function checks the iterator is still valid and should be called when IOIteratorNext returns zero. An invalid iterator can be reset and the iteration restarted.
Result: True if the iterator handle is valid, otherwise false is returned.
Name Description iterator An IOKit iterator handle.
io_object_t IOIteratorNext( io_iterator_t iterator );
This function returns the next object in an iteration, or zero if no more remain or the iterator is invalid.
Result: If the iterator handle is valid, the next element in the iteration is returned, otherwise zero is returned.
Name Description iterator An IOKit iterator handle.
void IOIteratorReset( io_iterator_t iterator );
If an iterator is invalid, or if the caller wants to start over, IOIteratorReset will set the iteration back to the beginning.
Name Description iterator An IOKit iterator handle.
kern_return_t IOKitGetBusyState( mach_port_t masterPort, int * busyState );
Many activities in IOService are asynchronous. When registration, matching, or termination is in progress on an IOService, its busyState is increased by one. Change in busyState to or from zero also changes the IOService's provider's busyState by one, which means that an IOService is marked busy when any of the above activities is ocurring on it or any of its clients. IOKitGetBusyState returns the busy state of the root of the service plane which reflects the busy state of all IOServices.
Result: A kern_return_t error code.
Name Description masterPort The master port obtained from IOMasterPort(). busyState The busyState count is returned.
kern_return_t IOKitWaitQuiet( mach_port_t masterPort, mach_timespec_t * waitTime );
Blocks the caller until all IOServices are non busy, see IOKitGetBusyState.
Result: Returns an error code if mach synchronization primitives fail, kIOReturnTimeout, or kIOReturnSuccess.
Name Description masterPort The master port obtained from IOMasterPort(). waitTime Specifies a maximum time to wait.
kern_return_t IOMasterPort( mach_port_t bootstrapPort, mach_port_t * masterPort );
Functions that don't specify an existing object require the IOKit master port to be passed. This function obtains that port.
Result: A kern_return_t error code.
Name Description size The task's bootstrap port, pass bootstrap_port from mach/mach_init.h. masterPort The master port is returned.
boolean_t IOObjectConformsTo( io_object_t object, const io_name_t className );
This function uses the OSMetaClass system in the kernel to determine if the object will dynamic cast to a class, specified as a C-string. In other words, if the object is of that class or a subclass.
Result: If the object handle is valid, and represents an object in the kernel that dynamic casts to the class true is returned, otherwise false.
Name Description object An IOKit object. className The name of the class, as a C-string.
kern_return_t IOObjectGetClass( io_object_t object, io_name_t className );
This function uses the OSMetaClass system in the kernel to derive the name of the class the object is an instance of.
Result: A kern_return_t error code.
Name Description object The IOKit object. className Caller allocated buffer to receive the name string.
int IOObjectGetRetainCount( io_object_t object );
This function may be used in diagnostics to determine the current retain count of the kernel object.
Result: If the object handle is valid, the kernel objects retain count is returned, otherwise zero is returned.
Name Description object An IOKit object.
boolean_t IOObjectIsEqualTo( io_object_t object, io_object_t anObject );
If two object handles are returned by IOKitLib functions, this function will compare them to see if they represent the same kernel object.
Result: If both object handles are valid, and represent the same object in the kernel true is returned, otherwise false.
Name Description object An IOKit object. anObject Another IOKit object.
kern_return_t IOObjectRelease( io_object_t object );
All objects returned by IOKitLib should be released with this function when access to them is no longer needed. Using the object after it has been released may or may not return an error, depending on how many references the task has to the same object in the kernel.
Result: A kern_return_t error code.
Name Description object The IOKit object to release.
CFMutableDictionaryRef IOOpenFirmwarePathMatching( mach_port_t masterPort, unsigned int options, const char * path );
Certain IOServices (currently, block and ethernet boot devices) may be looked up by a path that specifies their location in the OpenFirmware device tree, represented in the registry by the kIODeviceTreePlane plane. This function creates a matching dictionary that will match IOService's found with a given OpenFirmware device path.
Result: The matching dictionary created, is returned on success, or zero on failure. The dictionary is commonly passed to IOServiceGetMatchingServices or IOServiceAddNotification which will consume a reference, otherwise it should be released with CFRelease by the caller.
Name Description masterPort The master port obtained from IOMasterPort(). options No options are currently defined. path The OpenFirmware device path, as a const char *.
kern_return_t IORegistryCreateIterator( mach_port_t masterPort, const io_name_t plane, IOOptionBits options, io_iterator_t * iterator );
This method creates an IORegistryIterator in the kernel that is set up with options to iterate children of the registry root entry, and to recurse automatically into entries as they are returned, or only when instructed with calls to IORegistryIteratorEnterEntry. The iterator object keeps track of entries that have been recursed into previously to avoid loops.
Result: A kern_return_t error code.
Name Description masterPort The master port obtained from IOMasterPort(). plane The name of an existing registry plane. Plane names are defined in IOKitKeys, eg. kIOServicePlane. options kIORegistryIterateRecursively may be set to recurse automatically into each entry as it is returned from IOIteratorNext calls on the registry iterator. iterator A created iterator handle, to be released by the caller when it has finished with it.
kern_return_t IORegistryEntryCreateCFProperties( io_registry_entry_t entry, CFMutableDictionaryRef * properties, CFAllocatorRef allocator, IOOptionBits options );
This function creates an instantaneous snapshot of a registry entry's property table, creating a CFDictionary analogue in the caller's task. Not every object available in the kernel is represented as a CF container; currently OSDictionary, OSArray, OSSet, OSSymbol, OSString, OSData, OSNumber, OSBoolean are created as their CF counterparts.
Result: A kern_return_t error code.
Name Description entry The registry entry handle whose property table to copy. properties A CFDictionary is created and returned the caller on success. The caller should release with CFRelease. allocator The CF allocator to use when creating the CF containers. options No options are currently defined.
kern_return_t IORegistryEntryCreateIterator( io_registry_entry_t entry, const io_name_t plane, IOOptionBits options, io_iterator_t * iterator );
This method creates an IORegistryIterator in the kernel that is set up with options to iterate children or parents of a root entry, and to recurse automatically into entries as they are returned, or only when instructed with calls to IORegistryIteratorEnterEntry. The iterator object keeps track of entries that have been recursed into previously to avoid loops.
Result: A kern_return_t error code.
Name Description entry The root entry to begin the iteration at. plane The name of an existing registry plane. Plane names are defined in IOKitKeys, eg. kIOServicePlane. options kIORegistryIterateRecursively may be set to recurse automatically into each entry as it is returned from IOIteratorNext calls on the registry iterator. kIORegistryIterateParents may be set to iterate the parents of each entry, by default the children are iterated. iterator A created iterator handle, to be released by the caller when it has finished with it.
io_registry_entry_t IORegistryEntryFromPath( mach_port_t masterPort, const io_string_t path );
This function parses paths to lookup registry entries. The path should begin with '
Result: A handle to the IORegistryEntry witch was found with the path, to be released with IOObjectRelease by the caller, or MACH_PORT_NULL on failure.
Name Description masterPort The master port obtained from IOMasterPort(). path A C-string path.
kern_return_t IORegistryEntryGetChildEntry( io_registry_entry_t entry, const io_name_t plane, io_registry_entry_t * child );
This function will return the child which first attached to a registry entry in a plane.
Result: A kern_return_t error code.
Name Description entry The registry entry whose child to look up. plane The name of an existing registry plane. Plane names are defined in IOKitKeys, eg. kIOServicePlane. child The first child of the registry entry, on success. The child must be released by the caller.
kern_return_t IORegistryEntryGetChildIterator( io_registry_entry_t entry, const io_name_t plane, io_iterator_t * iterator );
This method creates an iterator which will return each of a registry entry's child entries in a specified plane.
Result: A kern_return_t error code.
Name Description entry The registry entry whose children to iterate over. plane The name of an existing registry plane. Plane names are defined in IOKitKeys, eg. kIOServicePlane. iterator The created iterator over the children of the entry, on success. The iterator must be released when the iteration is finished.
kern_return_t IORegistryEntryGetName( io_registry_entry_t entry, io_name_t name );
Registry entries can be named in a particular plane, or globally. This function returns the entry's global name. The global name defaults to the entry's meta class name if it has not been named.
Result: A kern_return_t error code.
Name Description entry The registry entry handle whose name to look up. name The caller's buffer to receive the name.
kern_return_t IORegistryEntryGetNameInPlane( io_registry_entry_t entry, const io_name_t plane, io_name_t name );
Registry entries can be named in a particular plane, or globally. This function returns the entry's name in the specified plane or global name if it has not been named in that plane. The global name defaults to the entry's meta class name if it has not been named.
Result: A kern_return_t error code.
Name Description entry The registry entry handle whose name to look up. name The caller's buffer to receive the name.
kern_return_t IORegistryEntryGetParentEntry( io_registry_entry_t entry, const io_name_t plane, io_registry_entry_t * parent );
This function will return the parent to which the registry entry was first attached in a plane.
Result: A kern_return_t error code.
Name Description entry The registry entry whose parent to look up. plane The name of an existing registry plane. Plane names are defined in IOKitKeys, eg. kIOServicePlane. child The first parent of the registry entry, on success. The parent must be released by the caller.
kern_return_t IORegistryEntryGetParentIterator( io_registry_entry_t entry, const io_name_t plane, io_iterator_t * iterator );
This method creates an iterator which will return each of a registry entry's parent entries in a specified plane.
Result: A kern_return_t error.
Name Description entry The registry entry whose parents to iterate over. plane The name of an existing registry plane. Plane names are defined in IOKitKeys, eg. kIOServicePlane. iterator The created iterator over the parents of the entry, on success. The iterator must be released when the iteration is finished.
kern_return_t IORegistryEntryGetPath( io_registry_entry_t entry, const io_name_t plane, io_string_t path );
The path for a registry entry is copied to the caller's buffer. The path describes the entry's attachment in a particular plane, which must be specified. The path begins with the plane name followed by a colon, and then followed by '/' separated path components for each of the entries between the root and the registry entry. An alias may also exist for the entry, and will be returned if available.
Result: IORegistryEntryGetPath will fail if the entry is not attached in the plane, or if the buffer is not large enough to contain the path.
Name Description entry The registry entry handle whose path to look up. plane The name of an existing registry plane. Plane names are defined in IOKitKeys, eg. kIOServicePlane. path A char buffer allocated by the caller.
kern_return_t IORegistryEntryGetProperty( io_registry_entry_t entry, const io_name_t propertyName, io_struct_inband_t buffer, unsigned int * size );
This function has limited use to retrieve a binary copy of simple property values without using CF containers. Currently, only OSData, OSString (& OSSymbol), OSNumber & OSBoolean properties are retrievable with IORegistryEntryGetProperty, and the size is limited to that of io_struct_inband_t (4096 bytes).
Result: A kern_return_t error code.
Name Description entry The registry entry handle whose property table read one property. propertyName The name of the property in the registry entry's property table as a C-string. buffer The caller's buffer to receive the binary representation of the property if it exists. size The size of the property copied is returned.
boolean_t IORegistryEntryInPlane( io_registry_entry_t entry, const io_name_t plane );
This method determines if the entry is attached in a plane to any other entry.
Result: If the entry has a parent in the plane, true is returned, otherwise false is returned.
Name Description entry The registry entry. plane The name of an existing registry plane. Plane names are defined in IOKitKeys, eg. kIOServicePlane.
kern_return_t IORegistryEntrySetCFProperties( io_registry_entry_t entry, CFTypeRef properties );
This is a generic method to pass a CF container of properties to an object in the registry. Setting properties in a registry entry is not generally supported, it is more common to support IOConnectSetCFProperties for connection based property setting. The properties are interpreted by the object.
Result: A kern_return_t error code returned by the object.
Name Description entry The registry entry whose properties to set. properties A CF container - commonly a CFDictionary but this is not enforced. The container should consist of objects which are understood by IOKit - these are currently : CFDictionary, CFArray, CFSet, CFString, CFData, CFNumber, CFBoolean, and are passed in the kernel as the corresponding OSDictionary etc. objects.
io_registry_entry_t IORegistryGetRootEntry( mach_port_t masterPort );
This method provides an accessor to the root of the registry for the machine. The root may be passed to a registry iterator when iterating a plane, and contains properties that describe the available planes, and diagnostic information for IOKit.
Result: A handle to the IORegistryEntry root instance, to be released with IOObjectRelease by the caller, or MACH_PORT_NULL on failure.
Name Description masterPort The master port obtained from IOMasterPort().
kern_return_t IORegistryIteratorEnterEntry( io_iterator_t iterator );
This method makes the current entry, ie. the last entry returned by IOIteratorNext, the root in a new level of recursion.
Result: A kern_return_t error code.kern_return_t IORegistryIteratorExitEntry( io_iterator_t iterator );
This method undoes an IORegistryIteratorEnterEntry, restoring the current entry. If there are no more levels of recursion to exit false is returned, otherwise true is returned.
Result: kIOReturnSuccess if a level of recursion was undone, kIOReturnNoDevice if no recursive levels are left in the iteration.kern_return_t IOServiceAddNotification( mach_port_t masterPort, const io_name_t notificationType, CFDictionaryRef matching, mach_port_t wakePort, int reference, io_iterator_t * notification );
This is the preferred method of finding IOService objects that may arrive at any time. The type of notification specifies the state change the caller is interested in, on IOService's that match the match dictionary. Notification types are identified by name, and are defined in IOKitKeys.h. The matching information used in the matching dictionary may vary depending on the class of service being looked up.
Result: A kern_return_t error code.
Name Description masterPort The master port obtained from IOMasterPort(). notificationType A notification type from IOKitKeys.h
kIOPublishNotification Delivered when an IOService is registered.
kIOFirstPublishNotification Delivered when an IOService is registered, but only once per IOService instance. Some IOService's may be reregistered when their state is changed.
kIOMatchedNotification Delivered when an IOService has had all matching drivers in the kernel probed and started.
kIOFirstMatchNotification Delivered when an IOService has had all matching drivers in the kernel probed and started, but only once per IOService instance. Some IOService's may be reregistered when their state is changed.
kIOTerminatedNotification Delivered after an IOService has been terminated.matching A CF dictionary containing matching information, of which one reference is consumed by this function. IOKitLib can construct matching dictionaries for common criteria with helper functions such as IOServiceMatching, IOOpenFirmwarePathMatching. wakePort A port to which messages will be sent when the armed notification is fired. When the notification is delivered, the io_iterator_t representing the notification should be iterated through to pick up all outstanding objects. When the iteration is finished the notification is rearmed. notification An iterator handle is returned on success, and should be released by the caller when the notification is to be destroyed. The notification is armed when the iterator is emptied by calls to IOIteratorNext - when no more objects are returned, the notification is armed. Note the notification is not armed when first created.
kern_return_t IOServiceClose( io_connect_t connect );
A connection created with the IOServiceOpen should be closed when the connection is no longer to be used with IOServiceClose.
Result: A kern_return_t error code.
Name Description connect The connect handle created by IOServiceOpen. It will be destroyed by this function, and should not be released with IOObjectRelease.
kern_return_t IOServiceGetBusyState( io_service_t service, int * busyState );
Many activities in IOService are asynchronous. When registration, matching, or termination is in progress on an IOService, its busyState is increased by one. Change in busyState to or from zero also changes the IOService's provider's busyState by one, which means that an IOService is marked busy when any of the above activities is ocurring on it or any of its clients.
Result: A kern_return_t error code.
Name Description service The IOService whose busyState to return. busyState The busyState count is returned.
kern_return_t IOServiceGetMatchingServices( mach_port_t masterPort, CFDictionaryRef matching, io_iterator_t * existing );
This is the preferred method of finding IOService objects currently registered by IOKit. IOServiceAddNotification can also supply this information and install a notification of new IOServices. The matching information used in the matching dictionary may vary depending on the class of service being looked up.
Result: A kern_return_t error code.
Name Description masterPort The master port obtained from IOMasterPort(). matching A CF dictionary containing matching information, of which one reference is consumed by this function. IOKitLib can contruct matching dictionaries for common criteria with helper functions such as IOServiceMatching, IOOpenFirmwarePathMatching. existing An iterator handle is returned on success, and should be released by the caller when the iteration is finished.
CFMutableDictionaryRef IOServiceMatching( const char * name );
A very common matching criteria for IOService is based on its class. IOServiceMatching will create a matching dictionary that specifies any IOService of a class, or its subclasses. The class is specified by C-string name.
Result: The matching dictionary created, is returned on success, or zero on failure. The dictionary is commonly passed to IOServiceGetMatchingServices or IOServiceAddNotification which will consume a reference, otherwise it should be released with CFRelease by the caller.
Name Description name The class name, as a const C-string. Class matching is successful on IOService's of this class or any subclass.
CFMutableDictionaryRef IOServiceNameMatching( const char * name );
A common matching criteria for IOService is based on its name. IOServiceNameMatching will create a matching dictionary that specifies an IOService with a given name. Some IOServices created from the OpenFirmware device tree will perform name matching on the standard OF compatible, name, model properties.
Result: The matching dictionary created, is returned on success, or zero on failure. The dictionary is commonly passed to IOServiceGetMatchingServices or IOServiceAddNotification which will consume a reference, otherwise it should be released with CFRelease by the caller.
Name Description name The IOService name, as a const C-string.
kern_return_t IOServiceOFPathToBSDName(mach_port_t masterPort, const io_name_t openFirmwarePath, io_name_t bsdName);
Certain IOServices (currently, block and ethernet boot devices) may be looked up by a path that specifies their location in the OpenFirmware device tree, represented in the registry by the kIODeviceTreePlane plane. This function looks up an IOService object with a given OpenFirmware device path, and returns its associated BSD device name.
Result: A kern_return_t error code.
Name Description masterPort The master port obtained from IOMasterPort(). openFirmwarePath The OpenFirmware device path, as a const char *. bsdName The BSD name, as a const char *, is copied to the callers buffer.
kern_return_t IOServiceOpen( io_service_t service, task_port_t owningTask, unsigned int type, io_connect_t * connect );
A non kernel client may request a connection be opened via the IOServiceOpen() library function, which will call IOService::newUserClient in the kernel. The rules & capabilities of user level clients are family dependent, the default IOService implementation returns kIOReturnUnsupported.
Result: A return code generated by IOService::newUserClient.
Name Description service The IOService object to open a connection to, usually obtained via the IOServiceGetMatchingServices or IOServiceAddNotification APIs. owningTask The mach task requesting the connection. type A constant specifying the type of connection to be created, interpreted only by the IOService's family. connect An io_connect_t handle is returned on success, to be used with the IOConnectXXX APIs. It should be destroyed with IOServiceClose().
kern_return_t IOServiceWaitQuiet( io_service_t service, mach_timespec_t * waitTime );
Blocks the caller until an IOService is non busy, see IOServiceGetBusyState.
Result: Returns an error code if mach synchronization primitives fail, kIOReturnTimeout, or kIOReturnSuccess.
Name Description service The IOService wait on. waitTime Specifies a maximum time to wait.
© 2000 Apple Computer, Inc. (Last Updated 2/23/2000)