Generic USB2.0 (EHCI) Driver

orByte · September 25, 2006

/****************************** INFO BAR ************************************

Edit: Last Modified: 24/12/08, Link to Slice's post added + signing off on this driver

*** Thanks to SLICE there is now an updated version of the USBEHCI driver, which also includes sleep support. Please go here for details: Slice's Post ***

PS: I am signing off on this driver. It was an enjoyable exercise. Thanks to everybody who contributed to its development. Anybody needing drivers for Kernel's 8.4.1 (10.4.6), 8.8.1 (10.4.8), 8.9.1 (10.4.9), 9.0.0 (10.5), 9.1.0 (10.5.1) pls. see below links.

LEOPARD READ FIRST: The 10.5.0/10.5.1 version is now ready. All kexts come as is without any warranty. Try them at your own risk. On my current MB, the EHCI ownership error does not happen - so I could not fully test, but nevertheless the version is working and should be OK. It should have compiled with 32/64 bit support.

Files

----------------------------------

1. Darwin 9.0.0/9.1.0 - PCGenUSBEHCI_303.4.5.kext.zip - Any support queries must include the output of 'kextstat' and 'dmesg | grep -i USB'. After the test phase, I will release full sources etc.

SOURCE - PCGen-303.4.5-src (1.3MB, MD5 (PCGen-303.4.5.zip) = 69c29c39850e50c5d27e774ed076d399)

TIGER READ FIRST: The 10.4.9/8.9.1 version is now ready and includes full source. All kexts come as is without any warranty. Try them at your own risk. On my current MB, the EHCI ownership error does not happen - so I could not fully test, but nevertheless the 10.4.9/8.9.1 version is working should be OK. Best.

Files

----------------------------------

1. Darwin 8.9.1 - PCGenUSBEHCI-2.7.0.zip

MD5 (PCGenUSBEHCI-2.7.0.zip) = f28159b35fe4bf5dcc755fad10917c8d

2. Darwin 8.8.1 - PCGenUSBEHCI-261.4.2a.zip

MD5 (PCGenUSBEHCI-2.6.1a.zip) = 6fb66c0c36e37a01e751f321d54e8957

3. Darwin 8.4.1 - PCGenUSBEHCI-256.4.2a.zip

MD5 (PCGenUSBEHCI-2.5.6a.zip) = 364f268a209709fc8dcf451ac61ddc31

Compatibility Guidelines, 22/12/06

----------------------------------

** Version <...>a fixes buggy SMI-bit13 handling ** (Thanks to mac fly for suggesting the solution)

** In practical terms, this extends support to machines that tried the reset but failed to do so. E.g., HP Pavillion 8000t NOW WORKS.

** See thread: for details.

1. For Darwin 8.9.1: USB 270.4.1 & 10.4.9 - use PCGenUSBEHCI-270.4.1 .

2. For Darwin 8.8.1: USB 261.4.2 & 10.4.8 - use PCGenUSBEHCI-261.4.2a .

2. For Darwin 8.4.1: USB 2.4.6 & 10.4.6; USB 256.4.2 & 10.4.7; USB 256.4.2 & 10.4.8 - use PCGenUSBEHCI-256.4.2a .

3. Thanks for all the reports! It seems to be working fine on DFI Lanparty now.

Not Working

with ATI SB200 chipset (cause -couldn't replicate this on an ECS board, likely only a laptop issue).

******************************************************************************/

DISCUSSION THREAD STARTS BELOW:

Hi all,

I have finally overcome teething problems and can now compile the Darwin, Open Source 256.4.2 IOUSBFamily kext AND get a usable kext.

However, I have been focusing on writing a version of AppleUSBEHCI.kext that will address the following problem(s):

(1) ON REBOOT/RESET one gets:

USBF:   20.136  EHCI controller unable to take control from BIOS

The problem appears to originate from a pci-quirk, which has to do with managing OS/BIOS ownership of the EHCI controller, and is not implemented in the Apple code. Not all systems may exhibit this error. Again, we are lucky to have the benefit of Linux - an excellent open source implementation - for a viable approach to dealing with this problem.

Briefly, while Apple implements

#define EHCI_USBLEGSUP_BIOS	(1 << 16)	/* BIOS semaphore */
#define EHCI_USBLEGSUP_OS	(1 << 24)	/* OS semaphore */

, they do not IMPLEMENT

#define EHCI_USBLEGCTLSTS	4		/* legacy control/status */
#define EHCI_USBLEGCTLSTS_SOOE	(1 << 13)	/* SMI on ownership change */

, which is actually a critical part of the management state machine (consequently on restart/reset BIOS reclaims but OS does not let go - so when you restart - no one gets it in the end). Well, in an unquirky world it would be taken care of by the BIOS, but hey! You know how it goes...

Oh yes, and the legacy part... Turning off legacy support in your BIOS may or may not make a difference. SO the best solution is porting these few lines + a few more over.

I shall keep you posted. Working title is: GenPCUSBEHCI.kext .

Best,

Edited December 24, 2008 by orByte

orByte · September 26, 2006

I am pleased to announce that this issue is now resolved. And I will make a kext available over the next few days - once I have all the licensing headers appropriately updated/added etc. Hopefully someone will also update the Darwin sources.

Discussion

The linux code proved helpful, but did not work, in the end the solution was (I ll post a proper diff later), in file AppleUSBEHCI.cpp, AppleUSBEHCI::AcquireOSOwnership(void)

We need something like

	 // orByte 26/9/06, check to see that EHCI ownership state machine is operating mutually exclusive
 // as it should be... if not reset OS ownership, and hope for the best.
 if ((data & kEHCI_USBLEGSUP_OSOwned) && (data & kEHCI_USBLEGSUP_BIOSOwned))
	{
		USBError(1, "EHCI - Ownership conflict - attempting to resolve ...");
		USBError(1, "EHCI - Resetting OS Ownership to 0");
		_device->configWrite32(eecp, data ^ kEHCI_USBLEGSUP_OSOwned);
			for (int i = 0; i < 25; i++)
			{
				data = _device->configRead32(eecp);
				if ((data & kEHCI_USBLEGSUP_OSOwned) == 0)
					break;
				IOSleep(10);			
			}
	}

Resetting the OS owned bit, generates the SMI event which then sorts out the rest of the registers properly after restart/reset. We need to do this check prior to writing an OS owned bit.

Best

Black Knight · September 27, 2006

This is excellent news! This problem has been frustrating me ever since I got my Asus A8R-MVP and Asus A8R32-MVP motherboards, which is about 5-6 months. Glad to hear someone has finally attacked this issue. Thanks.

Paul

hp8327 · September 29, 2006

This is excellent news! This problem has been frustrating me ever since I got my Asus A8R-MVP and Asus A8R32-MVP motherboards, which is about 5-6 months. Glad to hear someone has finally attacked this issue. Thanks.

Paul

I'm hoping for an update soon! I'm running 10.4.6 on an HP dv8327cl and have been having problems with USB from the start. Let us know as soon as you have a kext ready to test. I'm ready!

orByte · September 30, 2006

Cheers guys, here it is:

Edit

From now on link is posted on the topmost post of page 1 of this thread.

End Edit

One note: I say below that 10.4.7 is required, however, 10.4.6 may be fine. Basically if your system can run the Apple OSX USB 'Debug' kext 256.4.2, you ll be fine. However, read the instructions below first.

General and important Info, APSL terms in dmg:

------------------------------------------

README.1st

**********************************

PCGenUSBEHCI v. 2.5.6, 30/6/06

---------------------------------------------------------

RELEASED UNDER APSL 2.0.

READ THE ENCLOSED LICENSE. BY USING THIS SOFTWARE, YOU ARE AGREEING TO THE TERMS OF APSL 2.0. IF YOU DO NOT AGREE WITH THOSE TERMS THEN DO NOT USE THIS SOFWARE.

- Modified By: orByte

- Scope: PCGenUSBEHCI.kext replaces AppleUSBEHCI.kext

- Requires: x86 based platform, Darwin 10.4.7, Intel IOUSBFamily.kext version 256.4.2

which is obtainable from developer.apple.com in binary form, or from the Darwin Source tree in source form.

NOTES

---------------------------------------------------------

* Fixes on x86 based systems: 'EHCI controller unable to take control from BIOS' on restart/reset of system.

KNOWN ISSUES

---------------------------------------------------------

* If you reboot while you have a USB2.0 disk attached which has a corrupt MBR, the system might hang.

Likely to occur when rebooting from Hiren's Boot CD after MBR operations.

Resolution: Disconnect the USB2.0 drive and try again.

UNRESOLVED ISSUES

---------------------------------------------------------

* D3Cold/Hot Power Management, Severity: Low; Priority: Low

* USB EHCI Clock Registration, Severity: Low; Priority: Low

INSTALL

*************************************

PCGenUSBEHCI v. 2.5.6, 30/6/06

---------------------------------------------------------

** INSTALLATION INSTRUCTIONS **

*****************************************

CAUTION: If the incorrect version of the IOUSBFamily kernel extension is installed, the system may panic on startup. It is also possible that your system does not require or is not compatible with this fix. Make sure that you have a way to correct the problem (i.e. system not booting), before beginning the installation.

Make sure that you do not have any operation critical peripherals connected to the high speed USB bus during installation. Make sure that you have a way of reverting to your existing installation.

*****************************************

CRITICAL:

---------------------------------------------------

Obtain and Install IOUSBFamily.kext version 256.4.2, available from Apple. Requires Darwin 10.4.7.

Search Google for 'Mac OS X USB Debug Kits Downloads'

Note: I have been using the 'debug' version.

(A). The risk takers approach

---------------------------------------------------

sudo su

rm -R /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins/AppleUSBEHCI.kext

cp -R <path to>/PCGenUSBEHCI.kext /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins

chown -R root:wheel /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins/PCGenUSBEHCI.kext

chmod -R 755 /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins/PCGenUSBEHCI.kext

touch /System/Library/Extensions

shutdown -r now

( :blink: . Piano, piano

---------------------------------------------------

- Read (or skim through) the Apple Public Source Licence file.

- Read the README.1st file.

- Read the CAUTION note at least TWICE.

- Read the troubleshooting section below.

- Remove all mission critical USB from the EHCI port(s).

- Obtain and Install IOUSBFamily.kext version 256.4.2

- Reboot + verify OHCI (USB 1.1) operations

- Check to see if EHCI is working - look under 'About this Mac/More Info/USB' for High Speed USB. If it is already there (after above reboot) you do not need the fix.

- If you have no high speed USB, do sudo dmesg | grep EHCI look for 'EHCI controller unable to take control from BIOS.' If you see this line, then you are a good candidate for this fix.

- Now we run some additional tests:

sudo su

cp -R <path to>/PCGenUSBEHCI.kext /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins/

chown -R root:wheel /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins/PCGenUSBEHCI.kext

chmod -R 755 /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins/PCGenUSBEHCI.kext

kextload -v -t /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins/PCGenUSBEHCI.kext

- Look at the kextload output: Because AppleUSBEHCI is loaded, it will not load but it should say:

kextload: extension /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins/PCGenUSBEHCI.kext appears to be valid

If the kext is not valid make sure you followed the instructions. If it is valid, proceed to:

rm -R /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins/AppleUSBEHCI.kext

touch /System/Library/Extensions

shutdown -r now

TROUBLESHOOTING

---------------------------------------------------

1. I cannot install the IOUSBFamily version 256.4.2.

Solution: Upgrade to 'Darwin' version 10.4.7

2. I installed the fix and I still cannot get EHCI.

Solution: Delete or rename AppleUSBEHCI.kext in the /System/Library/Extensions/... folder. AppleUSBEHCI and GenPCUSBEHCI do the same thing and will cause conflicts if they are both present in the System Folder.

2a. I tried the above and the fix still does not work,

Solution: There may be no solution for this... According to ehci r-10 specifications, resetting OS ownership should get BIOS to reinitialize via an SMI signal after restart/reboot. But then this fix itself is patching a buggy ehci implementation. Sorry, you might be out of luck.

3. Do I really need this fix?

Solution: Read README.1st, and INSTALL. Additionally, on some machines, this problem goes away when legacy USB is disabled in BIOS.

If you need to have legacy USB enabled, then you can try this fix to get EHCI. I could not test this on my system, but it should work.

4. How do I compile the IOUSBFamily 256.4.2 from source?

Solution: Try XCode 2.3, and the apple mailing lists for common typecasting problems relating to clock.h . You may have to use the ...HibernatePrivate.h file from the xnu 10.4.7 kernel. Be prepared to spend some hours, days, weeks, months...

5. Will you release fixes for versions earlier than 10.4.7?

Solution: I won't, but you can use the diffs to help you modify earlier source code.

6. Can I use the 'patch' command on the diffs?

Solution: The diffs are generated from the 256.4.2 Darwin source. You can patch against those sources. You ll find the sources under the PPC branch. However, these are live sources subject to change so the patch may not apply.

7. Why did you change the name of AppleUSBEHCI.kext?

Solution: As my release is not officially from Apple, it is good practice to change the name. Also it gives you the opportunity to backup the original.

hp8327 · September 30, 2006

Cheers guys, here it is:

AWESOME! I'm going to try this later today or early tomorrow! Very exciting. Very detailed instructions, and this thread deserves a sticky! Thanks for your work on this, I'll reply back when I get it working.

Can't wait to have USB for flash and Wireless working!!!!!!! :blink:

Black Knight · October 3, 2006

Ok, so this worked great for me... after I hosed my OSX install. The problem is in the instructions. I noticed after my computer stopped working that there is a space after "rm -R /System/Library/" which appears in several lines of your instructions. If you copy and paste this line into terminal, guess what happens... it removes everything in /System/Library/. After a quick reinstall, I tried your method again and removed the spaces in the commands and sure enough, it worked great. Thank you so much, though please edit your instructions so nobody who doesn't know how to fix their install does the same thing I did. Maybe that's why nobody has yet responded after doing this fix.

Paul

hp8327 · October 3, 2006

Ok, so this worked great for me... after I hosed my OSX install. The problem is in the instructions. I noticed after my computer stopped working that there is a space after "rm -R /System/Library/" which appears in several lines of your instructions. If you copy and paste this line into terminal, guess what happens... it removes everything in /System/Library/. After a quick reinstall, I tried your method again and removed the spaces in the commands and sure enough, it worked great. Thank you so much, though please edit your instructions so nobody who doesn't know how to fix their install does the same thing I did. Maybe that's why nobody has yet responded after doing this fix.

Paul

I'm hoping to have time tonight to check this out. I am on the road and have been busy as heck. Thanks for the heads up though Black Night!

Black Knight · October 3, 2006

No problem. I hope it does work for you since it works so well for me.

SaxMachine · October 4, 2006

He works but without "debug kit"... I have an other problem my wifi and hd LaCie usb works but mouse and pendrive don' t works, why?

Ps. I have a notebook and I cannot disable "Usb Legacy" in my bios... look my sign for hardware components.

orByte · October 4, 2006

Hi Black Knight, thanks for pointing out the error for the instructions & sorry that your system got hosed - here are the corrected ones. I shall also update the fileshare later in the day.

(A). The risk takers approach

---------------------------------------------------

sudo su

rm -R /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins/AppleUSBEHCI.kext

cp -R <path to>/PCGenUSBEHCI.kext /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins

chown -R root:wheel /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins/PCGenUSBEHCI.kext

chmod -R 755 /System/Library/Extensions/IOUSBFamily.kext/Contents/Plugins/PCGenUSBEHCI.kext

touch /System/Library/Extensions

shutdown -r now

(. Piano, piano