|
ADC Home > Reference Library > Reference > Hardware & Drivers > I/O Kit Framework Reference
|
IOEthernetController |
| Inherits from: | |
| Declared In: |
Abstract superclass for Ethernet controllers.
Ethernet controller drivers should subclass IOEthernetController, and implement or override the hardware specific methods to create an Ethernet driver. An interface object (an IOEthernetInterface instance) must be instantiated by the driver, through attachInterface(), to connect the controller driver to the data link layer.
Creates an IOEthernetInterface object.
Disables a packet filter that is currently enabled from the given filter group.
Enables one of the supported packet filters from the given filter group.
Frees the IOEthernetController instance.
Gets the Ethernet controller's permanent station address.
Gets the Ethernet controller's station address.
Gets the maximum packet size supported by the Ethernet controller, including the frame header and FCS.
Gets the minimum packet size supported by the Ethernet controller, including the frame header and FCS.
Gets the set of packet filters supported by the Ethernet controller in the given filter group.
Gets the set of packet filters supported by the Ethernet controller in the network filter group.
Fetch the demand for hardware vlan tag stuffing for the given packet before it is transmitted on the network.
Initializes an IOEthernetController object.
IOEthernetController class initializer.
Fetch the demand for hardware vlan tag stuffing for the given packet before it is transmitted on the network.
Encode a received packet with the vlan tag result reported by the hardware.
Publishes Ethernet controller properties and capabilities.
Sets or changes the station address used by the Ethernet controller.
Sets or changes the station address used by the Ethernet controller.
Sets the list of multicast addresses a multicast filter should use to match against the destination address of an incoming frame.
Enables or disables multicast mode.
Enables or disables promiscuous mode.
Encode a received packet with the vlan tag result reported by the hardware.
Enables or disables the wake on Magic Packet support.
createInterface |
Creates an IOEthernetInterface object.
protected
virtual IONetworkInterface * createInterface();
Returns a newly allocated and initialized IOEthernetInterface object.
This method allocates and returns a new IOEthernetInterface instance. A subclass of IONetworkController must implement this method and return a matching interface object. The implementation in IOEthernetController will return an IOEthernetInterface object. Subclasses of IOEthernetController, such as Ethernet controller drivers, will have little reason to override this implementation.
disablePacketFilter |
Disables a packet filter that is currently enabled from the given filter group.
public
virtual IOReturn disablePacketFilter( const OSSymbol * group, UInt32 aFilter, UInt32 enabledFilters, IOOptionBits options = 0);
groupThe name of the filter group containing the filter to be disabled.
aFilterThe filter to disable.
enabledFiltersAll filters currently enabled by the client.
optionsOptional flags for the disable request.
Returns the value returned by setMulticastMode() or setPromiscuousMode() if either of those two methods are called. Returns kIOReturnSuccess if the filter specified is kIOPacketFilterUnicast or kIOPacketFilterBroadcast. Returns kIOReturnUnsupported if the filter group specified is not gIONetworkFilterGroup.
The default implementation of the abstract method inherited from IONetworkController. This method will call setMulticastMode() or setPromiscuousMode() when the multicast or the promiscuous filter is to be disabled. Requests to disable the Unicast or Broadcast filters are handled silently, without informing the subclass. Subclasses can override this method to change this default behavior, or to extend it to handle additional filter types or filter groups. This method call is synchronized by the workloop's gate.
enablePacketFilter |
Enables one of the supported packet filters from the given filter group.
public
virtual IOReturn enablePacketFilter( const OSSymbol * group, UInt32 aFilter, UInt32 enabledFilters, IOOptionBits options = 0);
groupThe name of the filter group containing the filter to be enabled.
aFilterThe filter to enable.
enabledFiltersAll filters currently enabled by the client.
optionsOptional flags for the enable request.
Returns the value returned by setMulticastMode() or setPromiscuousMode() if either of those two methods are called. Returns kIOReturnSuccess if the filter specified is kIOPacketFilterUnicast or kIOPacketFilterBroadcast. Returns kIOReturnUnsupported if the filter group specified is not gIONetworkFilterGroup.
The default implementation of the abstract method inherited from IONetworkController. This method will call setMulticastMode() or setPromiscuousMode() when the multicast or the promiscuous filter is to be enabled. Requests to disable the Unicast or Broadcast filters are handled silently, without informing the subclass. Subclasses can override this method to change this default behavior, or to extend it to handle additional filter types or filter groups. This method call is synchronized by the workloop's gate.
free |
Frees the IOEthernetController instance.
protected
virtual void free();
This method releases resources, and is then followed by a call to super::free().
getHardwareAddress(IOEthernetAddress *) |
Gets the Ethernet controller's permanent station address.
public
virtual IOReturn getHardwareAddress( IOEthernetAddress *addrP) = 0;
addrPPointer to an IOEthernetAddress where the hardware address should be returned.
Returns kIOReturnSuccess on success, or an error return code otherwise.
Ethernet drivers must implement this method, by reading the address from hardware and writing it to the buffer provided. This method is called from the workloop context.
getHardwareAddress(void *, UInt32 *) |
Gets the Ethernet controller's station address.
public
virtual IOReturn getHardwareAddress( void *addr, UInt32 *inOutAddrBytes);
addrThe buffer where the controller's hardware address should be written.
inOutAddrBytesThe size of the address buffer provided by the client, and replaced by this method with the actual size of the hardware address in bytes.
Returns kIOReturnSuccess on success, or an error otherwise.
The default implementation of the abstract method inherited from IONetworkController. This method will call the overloaded form IOEthernetController::getHardwareAddress() that subclasses are expected to override.
getMaxPacketSize |
Gets the maximum packet size supported by the Ethernet controller, including the frame header and FCS.
public
virtual IOReturn getMaxPacketSize( UInt32 *maxSize) const;
maxSizePointer to the return value.
Returns kIOReturnSuccess on success, or an error code otherwise.
getMinPacketSize |
Gets the minimum packet size supported by the Ethernet controller, including the frame header and FCS.
public
virtual IOReturn getMinPacketSize( UInt32 *minSize) const;
minSizePointer to the return value.
Returns kIOReturnSuccess on success, or an error code otherwise.
getPacketFilters(const OSSymbol *, UInt32 *) |
Gets the set of packet filters supported by the Ethernet controller in the given filter group.
public
virtual IOReturn getPacketFilters( const OSSymbol * group, UInt32 * filters) const;
groupThe name of the filter group.
filtersPointer to the mask of supported filters returned by this method.
Returns kIOReturnSuccess. Drivers that override this method must return kIOReturnSuccess to indicate success, or an error return code otherwise.
The default implementation of the abstract method inherited from IONetworkController. When the filter group specified is gIONetworkFilterGroup, then this method will return a value formed by a bitwise OR of kIOPacketFilterUnicast, kIOPacketFilterBroadcast, kIOPacketFilterMulticast, kIOPacketFilterPromiscuous. Otherwise, the return value will be set to zero (0). Subclasses must override this method if their filtering capability differs from what is reported by this default implementation. This method is called from the workloop context, and the result is published to the I/O Kit Registry.
getPacketFilters(UInt32 *) |
Gets the set of packet filters supported by the Ethernet controller in the network filter group.
public
virtual IOReturn getPacketFilters( UInt32 *filters) const;
filtersPointer to the return value containing a mask of supported filters.
Returns kIOReturnSuccess. Drivers that override this method must return kIOReturnSuccess to indicate success, or an error return code otherwise.
getVlanTagDemand |
Fetch the demand for hardware vlan tag stuffing for the given packet before it is transmitted on the network.
protected
OSMetaClassDeclareReservedUsed( IOEthernetController, 0);
packetA mbuf containing a packet that may require vlan tag stuffing.
vlanTagAfter calling, the low order 16 bits contain the 802.1Q priority and vlan ID tag in host order. The hi-order 16 bits are currently unused and should be ignored.
true if vlanTag has been set and should be used. false if no vlan tag stuffing is required for this packet.
A network controller that can insert 802.1Q vlan tags for output packets must call this method to obtain vlan tag information that it must insert into the given output packet.
init |
Initializes an IOEthernetController object.
public
virtual bool init( OSDictionary *properties);
propertiesA dictionary object containing a property table associated with this instance.
Returns true on success, false otherwise.
initialize |
IOEthernetController class initializer.
public
static void initialize();
Creates global OSSymbol objects that are used as keys.
OSMetaClassDeclareReservedUsed(IOEthernetController, 0) |
Fetch the demand for hardware vlan tag stuffing for the given packet before it is transmitted on the network.
protected
OSMetaClassDeclareReservedUsed( IOEthernetController, 0);
packetA mbuf containing a packet that may require vlan tag stuffing.
vlanTagAfter calling, the low order 16 bits contain the 802.1Q priority and vlan ID tag in host order. The hi-order 16 bits are currently unused and should be ignored.
true if vlanTag has been set and should be used. false if no vlan tag stuffing is required for this packet.
A network controller that can insert 802.1Q vlan tags for output packets must call this method to obtain vlan tag information that it must insert into the given output packet.
OSMetaClassDeclareReservedUsed(IOEthernetController, 1) |
Encode a received packet with the vlan tag result reported by the hardware.
protected
OSMetaClassDeclareReservedUsed( IOEthernetController, 1);
packetA mbuf containing a packet that has had its 802.1q vlan tag stripped by the hardware.
vlanTagA value in host order that contains the 802.1q vlan tag and priority in the low order 16 bits. The hi order word is currently unused and should be set to 0.
A network controller that can strip 802.1Q vlan tag information for a received packet should call this method to encode the result on the packet, before passing it up towards the protocol stacks.
publishProperties |
Publishes Ethernet controller properties and capabilities.
protected
virtual bool publishProperties();
Returns true if all properties and capabilities were discovered, and published successfully, false otherwise. Returning false will prevent client objects from attaching to the Ethernet controller since a property that a client relies upon may be missing.
This method publishes Ethernet controller properties to the property table. For instance, getHardwareAddress() is called to fetch the hardware address, and the address is then published to the property table. This method call is synchronized by the workloop's gate, and must never be called directly by subclasses.
setHardwareAddress(const IOEthernetAddress *) |
Sets or changes the station address used by the Ethernet controller.
public
virtual IOReturn setHardwareAddress( const IOEthernetAddress * addrP);
addrPPointer to an IOEthernetAddress containing the new station address.
The default implementation will always return kIOReturnUnsupported. If overridden, drivers must return kIOReturnSuccess on success, or an error return code otherwise.
This method is called in response to a client command to change the station address used by the Ethernet controller. Implementation of this method is optional. This method is called from the workloop context.
setHardwareAddress(const void *, UInt32) |
Sets or changes the station address used by the Ethernet controller.
public
virtual IOReturn setHardwareAddress( const void * addr, UInt32 addrBytes);
addrThe buffer containing the hardware address provided by the client.
addrBytesThe size of the address buffer provided by the client in bytes.
Returns kIOReturnSuccess on success, or an error otherwise.
The default implementation of the abstract method inherited from IONetworkController. This method will call the overloaded form IOEthernetController::setHardwareAddress() that subclasses are expected to override.
setMulticastList |
Sets the list of multicast addresses a multicast filter should use to match against the destination address of an incoming frame.
public
virtual IOReturn setMulticastList( IOEthernetAddress *addrs, UInt32 count);
addrsAn array of Ethernet addresses. This argument must be ignored if the count argument is 0.
countThe number of Ethernet addresses in the list. This value will be zero when the list becomes empty.
Returns kIOReturnUnsupported. Drivers must return kIOReturnSuccess to indicate success, or an error return code otherwise.
This method sets the list of multicast addresses that the multicast filter should use to match against the destination address of an incoming frame. The frame should be accepted when a match occurs. Called when the multicast group membership of an interface object is changed. Drivers that support kIOPacketFilterMulticast should override this method and update the hardware multicast filter using the list of Ethernet addresses provided. Perfect multicast filtering is preferred if supported by the hardware, in order to reduce the number of unwanted packets received. If the number of multicast addresses in the list exceeds what the hardware is capable of supporting, or if perfect filtering is not supported, then ideally the hardware should be programmed to perform imperfect filtering, through some form of hash filtering mechanism. Only as a last resort should the driver enable reception of all multicast packets to satisfy this request. This method is called from the workloop context, and only if the driver reports kIOPacketFilterMulticast support in getPacketFilters().
setMulticastMode |
Enables or disables multicast mode.
public
virtual IOReturn setMulticastMode( bool active);
activeTrue to enable multicast mode, false to disable it.
Returns kIOReturnUnsupported. If overridden, drivers must return kIOReturnSuccess on success, or an error return code otherwise.
Called by enablePacketFilter() or disablePacketFilter() when there is a change in the activation state of the multicast filter identified by kIOPacketFilterMulticast. This method is called from the workloop context.
setPromiscuousMode |
Enables or disables promiscuous mode.
public
virtual IOReturn setPromiscuousMode( bool active);
activeTrue to enable promiscuous mode, false to disable it.
Returns kIOReturnUnsupported. If overridden, drivers must return kIOReturnSuccess on success, or an error return code otherwise.
Called by enablePacketFilter() or disablePacketFilter() when there is a change in the activation state of the promiscuous filter identified by kIOPacketFilterPromiscuous. This method is called from the workloop context.
setVlanTag |
Encode a received packet with the vlan tag result reported by the hardware.
protected
OSMetaClassDeclareReservedUsed( IOEthernetController, 1);
packetA mbuf containing a packet that has had its 802.1q vlan tag stripped by the hardware.
vlanTagA value in host order that contains the 802.1q vlan tag and priority in the low order 16 bits. The hi order word is currently unused and should be set to 0.
A network controller that can strip 802.1Q vlan tag information for a received packet should call this method to encode the result on the packet, before passing it up towards the protocol stacks.
setWakeOnMagicPacket |
Enables or disables the wake on Magic Packet support.
public
virtual IOReturn setWakeOnMagicPacket( bool active);
activeTrue to enable support for system wake on reception of a Magic Packet, false to disable it.
Returns kIOReturnUnsupported. If overridden, drivers must return kIOReturnSuccess on success, or an error return code otherwise.
Called by enablePacketFilter() or disablePacketFilter() when there is a change in the activation state of the wake-on-LAN filter identified by kIOEthernetWakeOnMagicPacket. This method is called from the workloop context.
_reserved |
protected
ExpansionData * _reserved;
Reserved for future use. (Internal use only)
reserved |
protected
ExpansionData * _reserved;
Reserved for future use. (Internal use only)
|
Last Updated: 2009-02-23