从变色龙源码分析ACER 4741G HM55主板芯片组的睡眠问题

suhetao

    写在前面的话：鄙人是一个不折不扣的IT民工，整天“被沉浸”在无休无止的工作当中，这里写下的一切一切仅仅是忙里偷闲所致，如有不当，敬请原谅。
    因为苹果操作系统完善的内存和磁盘管理，快捷迅速的任务响应机制，所以对这个操作系统情有独钟，至于苹果，史上最差的性价比，不敢恭维。一直都想让自己的笔记本安装上苹果操作系统，其实是因为近来在做I疯的一些开发工作，需要XCODE这一仅仅运行在MAC平台的开发工具。无奈，只能下个安装光盘镜像在4741G上安装，一切顺利，唯独睡眠唤醒问题一直很纠结。难道这是4741G的通病？通过对DSDT打EHCI补丁，依旧无效，一气之下删除了所有有关EHCI相关的ASL代码，却意外的可以睡眠了，但是却无法正常唤醒，唤醒症状是黑屏，但是各指示灯正常以及硬盘已经启动。船到桥头自然直，想起了变色龙的USB FIX选项，在org.chameleon.Boot.plist添加如下选项。

1. <key>EHCIacquire</key>
   
2. <string>Yes</string>
   
3. <key>USBLegacyOff</key>
   
4. <string>Yes</string>

复制代码

睡眠唤醒正常了。到底这两个神奇的选项为什么可以化腐朽为传奇，引起了鄙人的高度的重视。二话不说，下载了变色龙的源代码，稍稍分析了一下，整个变色龙项目编译以后成为一个boot的文件，因此猜测源代码中的boot.c文件类似于Main函数所在，不失所望。一切从boot函数开始。

1. 
   
2. //==========================================================================
   
3. // This is the entrypoint from real-mode which functions exactly as it did
   
4. // before. Multiboot does its own runtime initialization, does some of its
   
5. // own things, and then calls common_boot.
   
6. void boot(int biosdev)
   
7. {
   
8.         initialize_runtime();
   
9.         // Enable A20 gate before accessing memory above 1Mb.
   
10.         enableA20();
    
11.         common_boot(biosdev);
    
12. }
    

复制代码

其中common_boot函数有以下一段

1. if (ret <= 0) {
   
2.                         printf("Can't find %s\n", bootFile);
   
3.                         sleep(1);
   
4.                         
   
5.                         if (gBootFileType == kNetworkDeviceType) {
   
6.                                 // Return control back to PXE. Don't unload PXE base code.
   
7.                                 gUnloadPXEOnExit = false;
   
8.                                 break;
   
9.                         }
   
10.                         pause();
    
11. 
    
12.                 } else {
    
13.                         /* Won't return if successful. */
    
14.                         ret = ExecKernel(binary);
    
15.                 }

复制代码

我们想要的答案就隐藏在ExecKernel函数中, ExecKernel有以下这么一段

1. ......
   
2. usb_loop();
   
3. ......

复制代码

usb_loop这个函数包含在变色龙源码usb.c文件中，内容如下

1. 
   
2. // Loop through the list and call the apropriate patch function
   
3. int usb_loop()
   
4. {
   
5.         int retVal = 1;
   
6.         bool fix_ehci, fix_uhci, fix_usb, fix_legacy;
   
7.         fix_ehci = fix_uhci = fix_usb = fix_legacy = false;
   
8.         
   
9.         if (getBoolForKey(kUSBBusFix, &fix_usb, &bootInfo->chameleonConfig))
   
10.         {
    
11.                 fix_ehci = fix_uhci = fix_legacy = fix_usb;        // Disable all if none set
    
12.         }
    
13.         else
    
14.         {
    
15.                 getBoolForKey(kEHCIacquire, &fix_ehci, &bootInfo->chameleonConfig);
    
16.                 getBoolForKey(kUHCIreset, &fix_uhci, &bootInfo->chameleonConfig);
    
17.                 getBoolForKey(kLegacyOff, &fix_legacy, &bootInfo->chameleonConfig);
    
18.         }
    
19.         
    
20.         struct pciList* current = usbList;
    
21.         
    
22.         while(current)
    
23.         {
    
24.                 switch (pci_config_read8(current->pciDev->dev.addr, PCI_CLASS_PROG))
    
25.                 {
    
26.                         // EHCI
    
27.                         case 0x20:
    
28.                             if(fix_ehci)   retVal &= ehci_acquire(current->pciDev);
    
29.                             if(fix_legacy) retVal &= legacy_off(current->pciDev);
    
30.                                 
    
31.                                 break;
    
32.                                 
    
33.                         // UHCI
    
34.                         case 0x00:
    
35.                                 if (fix_uhci) retVal &= uhci_reset(current->pciDev);
    
36. 
    
37.                                 break;
    
38.                 }
    
39.                
    
40.                 current = current->next;
    
41.         }
    
42.         return retVal;
    
43. }
    

复制代码

usb_loop函数通过getBoolForKey函数读取org.chameleon.Boot.plist文件中相关的USB FIX设定，然后遍历所有的EHCI设备，执行ehci_acquire，legacy_off这两个函数。（仅仅针对上面提到的“添加如下选项”的情况）所有的谜团已经解开，真相只有一个，先来看看legacy_off函数的源代码

1. 
   
2. int legacy_off (pci_dt_t *pci_dev)
   
3. {
   
4.         // Set usb legacy off modification by Signal64
   
5.         // NOTE: This *must* be called after the last file is loaded from the drive in the event that we are booting form usb.
   
6.         // NOTE2: This should be called after any getc()/getchar() call. (aka, after the Wait=y keyworkd is used)
   
7.         // AKA: Make this run immediatly before the kernel is called
   
8.         uint32_t        capaddr, opaddr;                  
   
9.         uint8_t                eecp;                        
   
10.         uint32_t        usbcmd, usbsts, usbintr;                        
    
11.         uint32_t        usblegsup, usblegctlsts;               
    
12.         
    
13.         int isOSowned;
    
14.         int isBIOSowned;
    
15.         
    
16.         verbose("Setting Legacy USB Off on controller [%04x:%04x] at %02x:%2x.%x\n",
    
17.                         pci_dev->vendor_id, pci_dev->device_id,
    
18.                         pci_dev->dev.bits.bus, pci_dev->dev.bits.dev, pci_dev->dev.bits.func);
    
19.         
    
20.         
    
21.         // capaddr = Capability Registers = dev.addr + offset stored in dev.addr + 0x10 (USBBASE)
    
22.         capaddr = pci_config_read32(pci_dev->dev.addr, 0x10);        
    
23.         
    
24.         // opaddr = Operational Registers = capaddr + offset (8bit CAPLENGTH in Capability Registers + offset 0)
    
25.         opaddr = capaddr + *((unsigned char*)(capaddr));                 
    
26.         
    
27.         // eecp = EHCI Extended Capabilities offset = capaddr HCCPARAMS bits 15:8
    
28.         eecp=*((unsigned char*)(capaddr + 9));
    
29.         
    
30.         DBG("capaddr=%x opaddr=%x eecp=%x\n", capaddr, opaddr, eecp);
    
31.         
    
32.         usbcmd = *((unsigned int*)(opaddr));                        // Command Register
    
33.         usbsts = *((unsigned int*)(opaddr + 4));                // Status Register
    
34.         usbintr = *((unsigned int*)(opaddr + 8));                // Interrupt Enable Register
    
35.         
    
36.         DBG("usbcmd=%08x usbsts=%08x usbintr=%08x\n", usbcmd, usbsts, usbintr);
    
37.         
    
38.         // read PCI Config 32bit USBLEGSUP (eecp+0)
    
39.         usblegsup = pci_config_read32(pci_dev->dev.addr, eecp);
    
40.         
    
41.         // informational only
    
42.         isBIOSowned = !!((usblegsup) & (1 << (16)));
    
43.         isOSowned = !!((usblegsup) & (1 << (24)));
    
44.         
    
45.         // read PCI Config 32bit USBLEGCTLSTS (eecp+4)
    
46.         usblegctlsts = pci_config_read32(pci_dev->dev.addr, eecp + 4);
    
47.         
    
48.         DBG("usblegsup=%08x isOSowned=%d isBIOSowned=%d usblegctlsts=%08x\n", usblegsup, isOSowned, isBIOSowned, usblegctlsts);
    
49.         
    
50.         // Reset registers to Legacy OFF
    
51.         DBG("Clearing USBLEGCTLSTS\n");
    
52.         pci_config_write32(pci_dev->dev.addr, eecp + 4, 0);        //usblegctlsts
    
53.         
    
54.         // if delay value is in milliseconds it doesn't appear to work.
    
55.         // setting value to anything up to 65535 does not add the expected delay here.
    
56.         delay(100);
    
57.         
    
58.         usbcmd = *((unsigned int*)(opaddr));
    
59.         usbsts = *((unsigned int*)(opaddr + 4));
    
60.         usbintr = *((unsigned int*)(opaddr + 8));
    
61.         
    
62.         DBG("usbcmd=%08x usbsts=%08x usbintr=%08x\n", usbcmd, usbsts, usbintr);
    
63.         
    
64.         DBG("Clearing Registers\n");
    
65.         
    
66.         // clear registers to default
    
67.         usbcmd = (usbcmd & 0xffffff00);
    
68.         *((unsigned int*)(opaddr)) = usbcmd;
    
69.         *((unsigned int*)(opaddr + 8)) = 0;                                        //usbintr - clear interrupt registers
    
70.         *((unsigned int*)(opaddr + 4)) = 0x1000;                        //usbsts - clear status registers         
    
71.         pci_config_write32(pci_dev->dev.addr, eecp, 1);                //usblegsup
    
72.         
    
73.         // get the results
    
74.         usbcmd = *((unsigned int*)(opaddr));
    
75.         usbsts = *((unsigned int*)(opaddr + 4));
    
76.         usbintr = *((unsigned int*)(opaddr + 8));
    
77.         
    
78.         DBG("usbcmd=%08x usbsts=%08x usbintr=%08x\n", usbcmd, usbsts, usbintr);
    
79.         
    
80.         // read 32bit USBLEGSUP (eecp+0)
    
81.         usblegsup = pci_config_read32(pci_dev->dev.addr, eecp);
    
82.         
    
83.         // informational only
    
84.         isBIOSowned = !!((usblegsup) & (1 << (16)));
    
85.         isOSowned = !!((usblegsup) & (1 << (24)));
    
86.         
    
87.         // read 32bit USBLEGCTLSTS (eecp+4)
    
88.         usblegctlsts = pci_config_read32(pci_dev->dev.addr, eecp + 4);
    
89.         
    
90.         DBG("usblegsup=%08x isOSowned=%d isBIOSowned=%d usblegctlsts=%08x\n", usblegsup, isOSowned, isBIOSowned, usblegctlsts);
    
91.         
    
92.         verbose("Legacy USB Off Done\n");        
    
93.         return 1;
    
94. }
    

复制代码

这些到底是什么天书？配合一下INTEL发布的EHCI参考文档，其实都很简单。先上个图，让大家熟悉一下EHCI的组织架构

可以看到通过设备地址我们先到到达一个PCI CONFIGURATION寄存器的区域，而其中的USB BASE ADDRESS指向的就是MMIO地址，也就是CAPABILITY REGISTERS和OPERATIONAL REGISTERS.
再来几张图看看PCI CONFIGURATION寄存器以及CAPABILITY、OPERATIONAL REGISTERS的具体说明

以及

还有

其中EECP在HCCPARAMS寄存器中指定

最后是CAPABILITY、OPERATIONAL REGISTERS之间的关系。

有了这些说明图片legacy_off函数就很好理解了。首先legacy_off函数从设备地址的偏移量0x10读取USBBASE地址访问CAPABILITY REGISTER，然后CAPABILITY REGISTER偏移CAPLENGTH个长度就是OPERATIONAL REGISTER。有了所有寄存器的地址，就很好处理了。首先对USBLEGCTLSTS寄存器清零(EECP+4)，相当于USBLEGCTLSTS寄存器RESET（默认全是0），延迟100毫秒等待寄存器RESET完毕，然后RESET USBCMD，通过对寄存器[0,1]两个位赋0值，通过设置USBINTR为0关闭USB中断，以及重置USB状态寄存器的USBSTS。剩下的就是读取一些信息。整个legacy_off函数的作用相当于重置USB设置。
再来看看ehci_acquire函数。代码如下

1. 
   
2. int ehci_acquire (pci_dt_t *pci_dev)
   
3. {
   
4.         int                j, k;
   
5.         uint32_t        base;
   
6.         uint8_t                eecp;
   
7.         uint8_t                legacy[8];
   
8.         bool                isOwnershipConflict;        
   
9.         bool                alwaysHardBIOSReset;
   
10. 
    
11.         alwaysHardBIOSReset = false;        
    
12.         if (!getBoolForKey(kEHCIhard, &alwaysHardBIOSReset, &bootInfo->chameleonConfig)) {
    
13.                 alwaysHardBIOSReset = true;
    
14.         }
    
15. 
    
16.         pci_config_write16(pci_dev->dev.addr, 0x04, 0x0002);
    
17.         base = pci_config_read32(pci_dev->dev.addr, 0x10);
    
18. 
    
19.         verbose("EHCI controller [%04x:%04x] at %02x:%2x.%x DMA @%x\n",
    
20.                 pci_dev->vendor_id, pci_dev->device_id,
    
21.                 pci_dev->dev.bits.bus, pci_dev->dev.bits.dev, pci_dev->dev.bits.func,
    
22.                 base);
    
23. 
    
24.         if (*((unsigned char*)base) < 0xc)
    
25.         {
    
26.                 DBG("Config space too small: no legacy implementation\n");
    
27.                 return 1;
    
28.         }
    
29.         eecp = *((unsigned char*)(base + 9));
    
30.         if (!eecp) {
    
31.                 DBG("No extended capabilities: no legacy implementation\n");
    
32.                 return 1;
    
33.         }
    
34. 
    
35.         DBG("eecp=%x\n",eecp);
    
36. 
    
37.         // bad way to do it
    
38.         // pci_conf_write(pci_dev->dev.addr, eecp, 4, 0x01000001);
    
39.         for (j = 0; j < 8; j++) {
    
40.                 legacy[j] = pci_config_read8(pci_dev->dev.addr, eecp + j);
    
41.                 DBG("%02x ", legacy[j]);
    
42.         }
    
43.         DBG("\n");
    
44. 
    
45.         //Real Job: based on orByte's AppleUSBEHCI.cpp
    
46.         //We try soft reset first - some systems hang on reboot with hard reset
    
47.         // Definitely needed during reboot on 10.4.6
    
48. 
    
49.         isOwnershipConflict = ((legacy[3] & 1 !=  0) && (legacy[2] & 1 !=  0));
    
50.         if (!alwaysHardBIOSReset && isOwnershipConflict) {
    
51.                 DBG("EHCI - Ownership conflict - attempting soft reset ...\n");
    
52.                 DBG("EHCI - toggle OS Ownership to 0\n");
    
53.                 pci_config_write8(pci_dev->dev.addr, eecp + 3, 0);
    
54.                 for (k = 0; k < 25; k++) {
    
55.                         for (j = 0; j < 8; j++) {
    
56.                                 legacy[j] = pci_config_read8(pci_dev->dev.addr, eecp + j);
    
57.                         }
    
58.                         if (legacy[3] == 0) {
    
59.                                 break;
    
60.                         }
    
61.                         delay(10);
    
62.                 }
    
63.         }        
    
64. 
    
65.         DBG("Found USBLEGSUP_ID - value %x:%x - writing OSOwned\n", legacy[3],legacy[2]);
    
66.         pci_config_write8(pci_dev->dev.addr, eecp + 3, 1);
    
67. 
    
68.         // wait for kEHCI_USBLEGSUP_BIOSOwned bit to clear
    
69.         for (k = 0; k < 25; k++) {
    
70.                 for (j = 0;j < 8; j++) {
    
71.                         legacy[j] = pci_config_read8(pci_dev->dev.addr, eecp + j);
    
72.                 }
    
73.                 DBG ("%x:%x,",legacy[3],legacy[2]);
    
74.                 if (legacy[2] == 0) {
    
75.                         break;
    
76.                 }
    
77.                 delay(10);
    
78.         }
    
79. 
    
80.         for (j = 0;j < 8; j++) {
    
81.                 legacy[j] = pci_config_read8(pci_dev->dev.addr, eecp + j);
    
82.         }
    
83.         isOwnershipConflict = ((legacy[2]) != 0);
    
84.         if (isOwnershipConflict) {
    
85.                 // Soft reset has failed. Assume SMI being ignored
    
86.                 // Hard reset
    
87.                 // Force Clear BIOS BIT
    
88.                 DBG("EHCI - Ownership conflict - attempting hard reset ...\n");                        
    
89.                 DBG ("%x:%x\n",legacy[3],legacy[2]);
    
90.                 DBG("EHCI - Force BIOS Ownership to 0\n");
    
91. 
    
92.                 pci_config_write8(pci_dev->dev.addr, eecp + 2, 0);
    
93.                 for (k = 0; k < 25; k++) {
    
94.                         for (j = 0; j < 8; j++) {
    
95.                                 legacy[j] = pci_config_read8(pci_dev->dev.addr, eecp + j);
    
96.                         }
    
97.                         DBG ("%x:%x,",legacy[3],legacy[2]);
    
98. 
    
99.                         if ((legacy[2]) == 0) {
    
100.                                 break;
     
101.                         }
     
102.                         delay(10);        
     
103.                 }               
     
104.                 // Disable further SMI events
     
105.                 for (j = 4; j < 8; j++) {
     
106.                         pci_config_write8(pci_dev->dev.addr, eecp + j, 0);
     
107.                 }
     
108.         }
     
109. 
     
110.         for (j = 0; j < 8; j++) {
     
111.                 legacy[j] = pci_config_read8(pci_dev->dev.addr, eecp + j);
     
112.         }
     
113. 
     
114.         DBG ("%x:%x\n",legacy[3],legacy[2]);
     
115. 
     
116.         // Final Ownership Resolution Check...
     
117.         if (legacy[2] & 1) {                                       
     
118.                 DBG("EHCI controller unable to take control from BIOS\n");
     
119.                 return 0;
     
120.         }
     
121. 
     
122.         DBG("EHCI Acquire OS Ownership done\n");        
     
123.         return 1;
     
124. }
     

复制代码

对PCI_CONFIGURATION偏移量0x04的地方写入0x0002，可惜没有主板的详细开发文档，而且INTEL提供的EHCI只提到说00&#8722;08h，Register implementation as needed for specific PCI device。所以具体作用不得而知，其实鄙人也不相信这个有啥用。然后剩下的部分就是EHCI的Ownership修复。
所以整体上看，只要进行Ownership修复，以及重置USB相关寄存器，就可以使HM55的睡眠唤醒正常。
若想详细了解以上所说函数中对USB相关寄存器地址以及设定的具体值含义请查阅INTEL官方的EHCI文档《Enhanced Host Controller Interface Specification for Universal Serial Bus 》，我就不再复述。今天就说到这里吧。抱砖引玉，希望大家少扔点鸡蛋。等这段子忙完看看，能否单纯在DSDT中添加相应的Ownership fix以及USB reset来修复HM55的睡眠唤醒问题，而不需要在变蛇龙引导参数中添加相关的USB设定。

sensssz

膜拜大神……

lhongj

管用。本来睡眠唤醒黑屏，现在是睡眠唤醒花屏，能看见东西了

FisherMac

楼主图挂了..用256kb以下附件上传图片吧

hjyun060872

直接添加就行了吗？看这，高手啊

suhetao

下班前修复了一下图片的链接。简而言之，就和我文章中最后说的一样。要启用HM55的睡眠唤醒功能，Ownership fix以及USB reset是必须的。
简单的说就是在变色龙配置文件添加选项
<key>EHCIacquire</key>
<string>Yes</string>
<key>USBLegacyOff</key>
<string>Yes</string>
以及在DSDT ASL中删除所有USB相关的代码，就可以使HM55唤醒睡眠正常。
上面只是原理性的探讨。

mingming0206

却是高深呀

道奇兔

suhetao 发表于 2011-11-17 17:50
下班前修复了一下图片的链接。简而言之，就和我文章中最后说的一样。要启用HM55的睡眠唤醒功能，Ownership  ...

說穿了dsdt也是可以...這部分說明我就省略了

其實  95%的人都忽略了睡眠BIOS的關係(mac只有三種睡眠....不像win)

crazybirdy

通过对DSDT打EHCI补丁，依旧无效，一气之下删除了所有有关EHCI相关的ASL代码，却意外的可以睡眠了，但是却无法正常唤醒，唤醒症状是黑屏，但是各指示灯正常以及硬盘已经启动。

以前我的P5B一直不愿意睡眠，总是一睡就醒，完全不断电，完全是USB不断电在搞鬼
后来只留下/Extra/SleepEnabler.kext + UHC1~6 + EHC1~2 的USB内建dsdt，其他USB dsdt都删掉
就可以正常睡眠了，睡眠中，主机+显示器.完全断电，不过只能按电源键唤醒睡眠。睡醒之后一切正常。

倒是没用到变色龙的USB修正功能

            Device (UHC1)
            {
                Name (_ADR, 0x001D0000)
                Method (_DSM, 4, NotSerialized)
                {
                    Store (Package (0x02)
                        {
                            "device-id",
                            Buffer (0x04)
                            {
                                0x34, 0x3A, 0x00, 0x00
                            }
                        }, Local0)
                    DTGP (Arg0, Arg1, Arg2, Arg3, RefOf (Local0))
                    Return (Local0)
                }
            }

xinjiemail

都是高手啊，真不错这贴。兔版应该加到资源集合贴去

zshwq5

技术帖收藏先，能有HM65芯片组的修复就更好 了。