|
ADC Home > Reference Library > Reference > Darwin > Kernel Framework Reference
|
IOPCIDevice |
| Inherits from: | |
| Declared In: |
An IOService class representing a PCI device.
The discovery of a PCI device by the PCI bus family results in an instance of the IOPCIDevice being created and published. It provides services for looking up and mapping memory mapped hardware, and access to the PCI configuration and I/O spaces.
Matching Supported by IOPCIDevice
Two types of matching are available, OpenFirmware name matching and PCI register matching. Currently, only one of these two matching schemes can be used in the same property table.
OpenFirmware Name Matching
IOService performs matching based on the IONameMatch property (see IOService). IOPCIDevices created with OpenFirmware device tree entries will name match based on the standard OpenFirmware name matching properties.
PCI Register Matching
A PCI device driver can also match on the values of certain config space registers.
In each case, several matching values can be specified, and an optional mask for the value of the config space register may follow the value, preceded by an '&' character.
kIOPCIMatchKey, "IOPCIMatch"
The kIOPCIMatchKey property matches the vendor and device ID (0x00) register, or the subsystem register (0x2c).
kIOPCIPrimaryMatchKey, "IOPCIPrimaryMatch"
The kIOPCIPrimaryMatchKey property matches the vendor and device ID (0x00) register.
kIOPCISecondaryMatchKey, "IOPCISecondaryMatch"
The kIOPCISecondaryMatchKey property matches the subsystem register (0x2c).
kIOPCIClassMatchKey, "IOPCIClassMatch"
The kIOPCIClassMatchKey property matches the class code register (0x08). The default mask for this register is 0xffffff00.
Examples:
<key>IOPCIMatch</key>
<string>0x00261011</string>
Matches a device whose vendor ID is 0x1011, and device ID is 0x0026, including subsystem IDs.
<key>IOPCIMatch</key>
<string>0x00789004&0x00ffffff 0x78009004&0x0xff00ffff</string>
Matches with any device with a vendor ID of 0x9004, and a device ID of 0xzz78 or 0x78zz, where 'z' is don't care.
<key>IOPCIClassMatch</key>
<string>0x02000000&0xffff0000</string>
Matches a device whose class code is 0x0200zz, an ethernet device.
Reads a 16-bit value from the PCI device's configuration space.
Reads a 32-bit value from the PCI device's configuration space.
Reads a 8-bit value from the PCI device's configuration space.
Writes a 16-bit value to the PCI device's configuration space.
Writes a 32-bit value to the PCI device's configuration space.
Writes a 8-bit value to the PCI device's configuration space.
Enables PCI power management for sleep state.
Reads a 16-bit value from the PCI device's configuration space.
Reads a 32-bit value from the PCI device's configuration space.
Reads an 8-bit value from the PCI device's configuration space.
Writes a 16-bit value to the PCI device's configuration space.
Writes a 32-bit value to the PCI device's configuration space.
Writes an 8-bit value to the PCI device's configuration space.
Searches configuration space for a PCI capability register.
Searches configuration space for a PCI capability register.
Returns the PCI device's assigned bus number.
Returns an instance of IODeviceMemory representing one of the device's memory mapped ranges.
Returns the PCI device's device number.
Returns the PCI device's function number.
Determines whether or not the device supports PCI Bus Power Management.
Accessor to the I/O space aperture for the bus.
Reads a 16-bit value from an I/O space aperture.
Reads a 32-bit value from an I/O space aperture.
Reads an 8-bit value from an I/O space aperture.
Writes a 16-bit value to an I/O space aperture.
Writes a 32-bit value to an I/O space aperture.
Writes an 8-bit value to an I/O space aperture.
Maps a physical range of the device.
Sets the device's bus master enable.
Sets masked bits in a configuration space register.
Sets the device's I/O space response.
Sets the device's memory space response.
configRead16 |
Reads a 16-bit value from the PCI device's configuration space.
public
virtual UInt16 configRead16( UInt8 offset );
offsetAn 8-bit offset into configuration space, of which bit 0 is ignored.
An 16-bit value in host byte order (big endian on PPC).
This method reads a 16-bit configuration space register on the device and returns its value.
configRead32 |
Reads a 32-bit value from the PCI device's configuration space.
public
virtual UInt32 configRead32( UInt8 offset );
offsetAn 8-bit offset into configuration space, of which bits 0-1 are ignored.
An 32-bit value in host byte order (big endian on PPC).
This method reads a 32-bit configuration space register on the device and returns its value.
configRead8 |
Reads a 8-bit value from the PCI device's configuration space.
public
virtual UInt8 configRead8( UInt8 offset );
offsetAn 8-bit offset into configuration space.
An 8-bit value.
This method reads a 8-bit configuration space register on the device and returns its value.
configWrite16 |
Writes a 16-bit value to the PCI device's configuration space.
public
virtual void configWrite16( UInt8 offset, UInt16 data );
offsetAn 8-bit offset into configuration space, of which bit 0 is ignored.
dataAn 16-bit value to be written in host byte order (big endian on PPC).
This method writes a 16-bit value to a configuration space register on the device.
configWrite32 |
Writes a 32-bit value to the PCI device's configuration space.
public
virtual void configWrite32( UInt8 offset, UInt32 data );
offsetAn 8-bit offset into configuration space, of which bits 0-1 are ignored.
dataAn 32-bit value to be written in host byte order (big endian on PPC).
This method writes a 32-bit value to a configuration space register on the device.
configWrite8 |
Writes a 8-bit value to the PCI device's configuration space.
public
virtual void configWrite8( UInt8 offset, UInt8 data );
offsetAn 8-bit offset into configuration space.
dataAn 8-bit value to be written.
This method writes a 8-bit value to a configuration space register on the device.
enablePCIPowerManagement |
Enables PCI power management for sleep state.
public
virtual IOReturn enablePCIPowerManagement( IOOptionBits state = 0xffffffff);
state(optional) Enables PCI Power Management by placing the function in the given state (e.g. kPCIPMCSPowerStateD3). If state is not specified or is 0xffffffff, then the IOPCIDevice determines the desired state. If state is kPCIPMCSPowerStateD0 (0) then PCI Power Management is disabled.
kIOReturnSuccess if there were no errors
This method will enable PCI Bus Powermanagement when going to sleep mode.
extendedConfigRead16 |
Reads a 16-bit value from the PCI device's configuration space.
private
UInt16 extendedConfigRead16( IOByteCount offset );
offsetA byte offset into configuration space, of which bit 0 is ignored.
An 16-bit value in host byte order (big endian on PPC).
This method reads a 16-bit configuration space register on the device and returns its value.
extendedConfigRead32 |
Reads a 32-bit value from the PCI device's configuration space.
private
UInt32 extendedConfigRead32( IOByteCount offset );
offsetA byte offset into configuration space, of which bits 0-1 are ignored.
An 32-bit value in host byte order (big endian on PPC).
This method reads a 32-bit configuration space register on the device and returns its value.
extendedConfigRead8 |
Reads an 8-bit value from the PCI device's configuration space.
private
UInt8 extendedConfigRead8( IOByteCount offset );
offsetA byte offset into configuration space.
An 8-bit value.
This method reads an 8-bit configuration space register on the device and returns its value.
extendedConfigWrite16 |
Writes a 16-bit value to the PCI device's configuration space.
private
void extendedConfigWrite16( IOByteCount offset, UInt16 data );
offsetA byte offset into configuration space, of which bit 0 is ignored.
dataAn 16-bit value to be written in host byte order (big endian on PPC).
This method writes a 16-bit value to a configuration space register on the device.
extendedConfigWrite32 |
Writes a 32-bit value to the PCI device's configuration space.
private
void extendedConfigWrite32( IOByteCount offset, UInt32 data );
offsetA byte offset into configuration space, of which bits 0-1 are ignored.
dataAn 32-bit value to be written in host byte order (big endian on PPC).
This method writes a 32-bit value to a configuration space register on the device.
extendedConfigWrite8 |
Writes an 8-bit value to the PCI device's configuration space.
private
void extendedConfigWrite8( IOByteCount offset, UInt8 data );
offsetA byte offset into configuration space.
dataAn 8-bit value to be written.
This method writes an 8-bit value to a configuration space register on the device.
extendedFindPCICapability |
Searches configuration space for a PCI capability register.
public
virtual UInt32 extendedFindPCICapability( UInt32 capabilityID, IOByteCount *offset = 0 );
capabilityIDA PCI capability ID. PCI Express devices may support extended capabilities in config space starting at offset 0x100. To search this space, the ID passed should be the negated value of the PCI-SIG assigned ID for the extended capability.
offsetAn optional in/out parameter to return the offset into config space where the capability was found, and to set the start point of the next search. Initialize the offset to zero before the first call to extendedFindPCICapability and subsequent calls will find all capabilty blocks that may exist on the device with the same ID.
The 32-bit value of the capability register if one was found, zero otherwise.
This method searches the device's config space for a PCI capability register matching the passed capability ID, if the device supports PCI capabilities.
findPCICapability |
Searches configuration space for a PCI capability register.
public
virtual UInt32 findPCICapability( UInt8 capabilityID, UInt8 *offset = 0 );
capabilityIDAn 8-bit PCI capability ID.
offsetAn optional pointer to return the offset into config space where the capability was found.
The 32-bit value of the capability register if one was found, zero otherwise.
This method searches the device's config space for a PCI capability register matching the passed capability ID, if the device supports PCI capabilities. To search for PCI Express extended capabilities or for multiple capablities with the same ID, use the extendedFindPCICapability method.
getBusNumber |
Returns the PCI device's assigned bus number.
public
virtual UInt8 getBusNumber( void );
The 8-bit value of device's PCI bus number.
This method is an accessor to return the PCI device's assigned bus number.
getDeviceMemoryWithRegister |
Returns an instance of IODeviceMemory representing one of the device's memory mapped ranges.
public
virtual IODeviceMemory * getDeviceMemoryWithRegister( UInt8 reg );
regThe 8-bit configuration space register that is the base address register for the desired range.
A pointer to an instance of IODeviceMemory, or zero no such range was found. The IODeviceMemory is retained by the provider, so is valid while attached, or while any mappings to it exist. It should not be released by the caller.
This method will return a pointer to an instance of IODeviceMemory for the physical memory range that was assigned to the configuration space base address register passed in. It is analogous to IOService::getDeviceMemoryWithIndex.
getDeviceNumber |
Returns the PCI device's device number.
public
virtual UInt8 getDeviceNumber( void );
The 5-bit value of device's device number.
This method is an accessor to return the PCI device's device number.
getFunctionNumber |
Returns the PCI device's function number.
public
virtual UInt8 getFunctionNumber( void );
The 3-bit value of device's function number.
This method is an accessor to return the PCI device's function number.
hasPCIPowerManagement |
Determines whether or not the device supports PCI Bus Power Management.
public
virtual bool hasPCIPowerManagement( IOOptionBits state = 0);
state(optional) Check for support of a specific state (e.g. kPCIPMCPMESupportFromD3Cold). If state is not supplied or is 0, then check for a property in the I/O Registry which tells which state the hardware expects the device to go to during sleep.
true if the specified state is supported
This method will look at the device's capabilties registers and determine whether or not the device supports the PCI BUS Power Management Specification.
ioDeviceMemory |
Accessor to the I/O space aperture for the bus.
public
virtual IODeviceMemory * ioDeviceMemory( void );
A pointer to an IODeviceMemory object for the I/O aperture. The IODeviceMemory object is retained by the provider, so is valid while attached, or while any mappings to it exist. It should not be released by the caller.
This method will return a reference to the IODeviceMemory for the I/O aperture of the bus the device is on.
ioRead16 |
Reads a 16-bit value from an I/O space aperture.
public
virtual UInt16 ioRead16( UInt16 offset, IOMemoryMap *map = 0 );
offsetAn offset into a bus or device's I/O space aperture.
mapIf the offset is relative to the beginning of a device's aperture, an IOMemoryMap object for that object should be passed in. Otherwise, passing zero will write the value relative to the beginning of the bus' I/O space.
The value read in host byte order (big endian on PPC).
This method will read a 16-bit value from a 2 byte aligned offset in an I/O space aperture. If a map object is passed in, the value is read relative to it, otherwise the value is read relative to the I/O space aperture for the bus. This function encapsulates the differences between architectures in generating I/O space operations. An eieio instruction is included on PPC.
ioRead32 |
Reads a 32-bit value from an I/O space aperture.
public
virtual UInt32 ioRead32( UInt16 offset, IOMemoryMap *map = 0 );
offsetAn offset into a bus or device's I/O space aperture.
mapIf the offset is relative to the beginning of a device's aperture, an IOMemoryMap object for that object should be passed in. Otherwise, passing zero will write the value relative to the beginning of the bus' I/O space.
The value read in host byte order (big endian on PPC).
This method will read a 32-bit value from a 4 byte aligned offset in an I/O space aperture. If a map object is passed in, the value is read relative to it, otherwise the value is read relative to the I/O space aperture for the bus. This function encapsulates the differences between architectures in generating I/O space operations. An eieio instruction is included on PPC.
ioRead8 |
Reads an 8-bit value from an I/O space aperture.
public
virtual UInt8 ioRead8( UInt16 offset, IOMemoryMap *map = 0 );
offsetAn offset into a bus or device's I/O space aperture.
mapIf the offset is relative to the beginning of a device's aperture, an IOMemoryMap object for that object should be passed in. Otherwise, passing zero will write the value relative to the beginning of the bus' I/O space.
The value read.
This method will read an 8-bit value from an offset in an I/O space aperture. If a map object is passed in, the value is read relative to it, otherwise the value is read relative to the I/O space aperture for the bus. This function encapsulates the differences between architectures in generating I/O space operations. An eieio instruction is included on PPC.
ioWrite16 |
Writes a 16-bit value to an I/O space aperture.
public
virtual void ioWrite16( UInt16 offset, UInt16 value, IOMemoryMap *map = 0 );
offsetAn offset into a bus or device's I/O space aperture.
valueThe value to be written in host byte order (big endian on PPC).
mapIf the offset is relative to the beginning of a device's aperture, an IOMemoryMap object for that object should be passed in. Otherwise, passing zero will write the value relative to the beginning of the bus' I/O space.
This method will write a 16-bit value to a 2 byte aligned offset in an I/O space aperture. If a map object is passed in, the value is written relative to it, otherwise the value is written relative to the I/O space aperture for the bus. This function encapsulates the differences between architectures in generating I/O space operations. An eieio instruction is included on PPC.
ioWrite32 |
Writes a 32-bit value to an I/O space aperture.
public
virtual void ioWrite32( UInt16 offset, UInt32 value, IOMemoryMap *map = 0 );
offsetAn offset into a bus or device's I/O space aperture.
valueThe value to be written in host byte order (big endian on PPC).
mapIf the offset is relative to the beginning of a device's aperture, an IOMemoryMap object for that object should be passed in. Otherwise, passing zero will write the value relative to the beginning of the bus' I/O space.
This method will write a 32-bit value to a 4 byte aligned offset in an I/O space aperture. If a map object is passed in, the value is written relative to it, otherwise the value is written relative to the I/O space aperture for the bus. This function encapsulates the differences between architectures in generating I/O space operations. An eieio instruction is included on PPC.
ioWrite8 |
Writes an 8-bit value to an I/O space aperture.
public
virtual void ioWrite8( UInt16 offset, UInt8 value, IOMemoryMap *map = 0 );
offsetAn offset into a bus or device's I/O space aperture.
valueThe value to be written in host byte order (big endian on PPC).
mapIf the offset is relative to the beginning of a device's aperture, an IOMemoryMap object for that object should be passed in. Otherwise, passing zero will write the value relative to the beginning of the bus' I/O space.
This method will write an 8-bit value to an offset in an I/O space aperture. If a map object is passed in, the value is written relative to it, otherwise the value is written relative to the I/O space aperture for the bus. This function encapsulates the differences between architectures in generating I/O space operations. An eieio instruction is included on PPC.
mapDeviceMemoryWithRegister |
Maps a physical range of the device.
public
virtual IOMemoryMap * mapDeviceMemoryWithRegister( UInt8 reg, IOOptionBits options = 0 );
regThe 8-bit configuration space register that is the base address register for the desired range.
optionsOptions to be passed to the IOMemoryDescriptor::map() method.
An instance of IOMemoryMap, or zero if the index is beyond the count available. The mapping should be released only when access to it is no longer required.
This method will create a mapping for the IODeviceMemory for the physical memory range that was assigned to the configuration space base address register passed in, with IODeviceMemory::map(options). The mapping is represented by the returned instance of IOMemoryMap, which should not be released until the mapping is no longer required. This method is analogous to IOService::mapDeviceMemoryWithIndex.
setBusMasterEnable |
Sets the device's bus master enable.
public
virtual bool setBusMasterEnable( bool enable );
enableTrue or false to enable or disable bus mastering.
True if bus mastering was previously enabled, false otherwise.
This method sets the bus master enable bit in the device's command config space register to the passed value, and returns the previous state of the enable.
setConfigBits |
Sets masked bits in a configuration space register.
public
virtual UInt32 setConfigBits( UInt8 offset, UInt32 mask, UInt32 value );
offsetAn 8-bit offset into configuration space, of which bits 0-1 are ignored.
maskAn 32-bit mask indicating which bits in the value parameter are valid.
dataAn 32-bit value to be written in host byte order (big endian on PPC).
The value of the register masked with the mask before the write.
This method sets masked bits in a configuration space register on the device by reading and writing the register. It returns the value of the masked bits before the write.
setIOEnable |
Sets the device's I/O space response.
public
virtual bool setIOEnable( bool enable, bool exclusive = false );
enableTrue or false to enable or disable the I/O space response.
exclusiveIf true, only one setIOEnable with the exclusive flag set will be allowed at a time on the bus, this should be only for temporary access.
True if the I/O space response was previously enabled, false otherwise.
This method sets the I/O space response bit in the device's command config space register to the passed value, and returns the previous state of the enable. The exclusive option allows only one exclusive device on the bus to be enabled concurrently, this should be only for temporary access.
setMemoryEnable |
Sets the device's memory space response.
public
virtual bool setMemoryEnable( bool enable );
enableTrue or false to enable or disable the memory space response.
True if the memory space response was previously enabled, false otherwise.
This method sets the memory space response bit in the device's command config space register to the passed value, and returns the previous state of the enable.
reserved |
protected
struct IOPCIDeviceExpansionData * reserved;
Reserved for future use. (Internal use only)
|
Last Updated: 2008-12-19