|
1 | | -**SMC Tool by David R:** |
2 | | -- |
3 | | -Aimed at Mac logic board technicians, SMCTool makes flashing a replacement SMC quicker and easier. It not only saves time, but money, as a specific donor SMC isn't necessary to have 'on hand'. Simply take a matching donor SMC* from another board, replace and flash. |
4 | 1 |
|
5 | | -*Currently, a full list of SMC boot compatibility between boards has not been established. I recommend you keep the board years as close as possible when taking a donor SMC from a non-matching board, otherwise the machine may not power on. |
| 2 | +<h1 align="center"> |
| 3 | +<img width="200" src="resource/img/icon256.png" alt="SMCTool Logo"> |
| 4 | +<br> |
| 5 | +SMCTool |
| 6 | +</h1> |
6 | 7 |
|
7 | | -It has come to my attention SMCTool may not like some USB memory sticks, I use SanDisk SDCZ50 USB 2.0 without issue. Possibly an issue with UEFI, I don't know, yet. Also, removing the system storage drive is necessary in most cases, otherwise 'startup.nsh' may not run. |
| 8 | +<h4 align="center">Making SMC flashing quicker and easier.</h4> |
8 | 9 |
|
9 | | -💡 This project is based on the work from [logi.wiki](https://logi.wiki/index.php?title=SMC_flashing).\ |
10 | | -🎥 SMC Tool tested by Paul L Daniels on [YouTube](https://www.youtube.com/watch?v=q8LEh8C4iYo). |
| 10 | +<p align="center"> |
| 11 | + <a href="#about">About</a> • |
| 12 | + <a href="#download">Download</a> • |
| 13 | + <a href="#bootable-usb">Bootable USB</a> • |
| 14 | + <a href="#flashing-an-smc">Flashing An SMC</a> • |
| 15 | + <a href="#compatibility">Compatibility</a> • |
| 16 | + <a href="#disclaimers">Disclaimers</a> • |
| 17 | + <a href="#acknowledgements">Acknowledgements</a> • |
| 18 | + <a href="#donate">Donate</a> |
| 19 | +</p> |
11 | 20 |
|
12 | | -**Thanks to:-**\ |
13 | | -**Paul L Daniels** for development help, and the kick to finish this project.\ |
14 | | -**Logi.wiki** for the original work, which I could base this project on.\ |
15 | | -**EineWildeStehlampe** for information and help regarding UEFI.\ |
16 | | -**theSmudge** for being a great help verifying information.\ |
17 | | -**Nobluesky** for gathering Board-IDs. |
| 21 | +## About |
18 | 22 |
|
19 | | -☕ If you'd like to make a donation for my work, please [see here](https://www.buymeacoffee.com/Muerto). Cheers. ☕ |
| 23 | +This bootable shell is used to program a Mac LM4F (Stellaris) System Management Controller (SMC) in EFI mode with the correct stock firmware, this enables a technician to replace a faulty SMC with a donor from a non-matching machine. This not only saves time, but money, as a specific donor SMC isn't necessary to have 'on hand'; simply take a donor SMC* from another board, replace it, and flash with this handy bootable software. |
20 | 24 |
|
21 | | ---- |
22 | | -**Before you start:** |
23 | | -- |
24 | | -I'm not responsible if you do something wrong, if you're here I expect you to know what you're doing. Where I do my utmost to verify all information to my best ability, I'm also not responsible for any mistakes my end either. As they say, sometimes shit happens. |
| 25 | +> ⚠ *Currently, a full list of SMC boot compatibility between boards has not been established, I recommend you keep the platform and GPU type the same (MacBook, iMac, Mac Mini), (iGPU, dGPU). |
25 | 26 |
|
26 | | -This is also **not** a magical 'fix my Mac' tool, it has a specific purpose, which is flashing correct payloads to a System Management Controller with incorrect firmware. |
| 27 | +## Download |
27 | 28 |
|
28 | | ---- |
29 | | -**Download:** |
30 | | -- |
31 | | -Current Version: `1.0.6` - (31.01.2023)\ |
32 | | -See the [Changelog](CHANGELOG.md).\ |
33 | | -Downloads can be acquired in the [releases](https://github.com/MuertoGB/SMCTool/releases) section. |
| 29 | +| Version| Release Date| Latest| |
| 30 | +|--------|-------------|--------| |
| 31 | +| [V1.0.7](https://github.com/MuertoGB/SMCTool/releases/tag/v1.0.7)| 18th Feb 2023 | `Yes` | |
| 32 | +| [V1.0.6](https://github.com/MuertoGB/SMCTool/releases/tag/v1.0.6)| 31st Jan 2022 | `No` | |
34 | 33 |
|
35 | | ---- |
36 | | -**Creating a USB disk:** |
37 | | -- |
38 | | -To begin, format a USB disk in ExFAT, FAT32, VFAT or HFS+ using a GPT or MBR partition table, then.... |
| 34 | +> 📔 See the full [Changelog](CHANGELOG.md). |
39 | 35 |
|
40 | | -- Option A: Manually copy all SMC_Tool.iso files to the formatted USB disk. |
41 | | -- Option B: Write the SMC_Tool.img to disk with ddrescue, Passmark imageUSB, or similar. |
42 | | -- Option C: Use a bootable USB creation tool and select SMC_Tool.iso as the source file. |
| 36 | +## Bootable USB |
43 | 37 |
|
44 | | -Extended instructions [here](BOOTABLEUSB.md). |
| 38 | +To begin, format a USB disk in ExFAT, FAT32, VFAT or HFS+ for use with SMCTool. |
| 39 | +> ⚠ FAT32 using a GPT partition table is recommended. |
45 | 40 |
|
46 | | ---- |
47 | | -**Flashing the SMC:** |
48 | | -- |
49 | | - 1. Plug in your USB disk and power on the Mac whilst holding the `Option ⌥` key. |
50 | | - 2. Load into `SMC Tool` from the boot menu and let startup.nsh run. |
51 | | - 3. Type the boardnumber.nsh you want to flash, e.g: `820-00165.nsh`, then press return, the script will then flash the SMC. |
52 | | - 4. Type 'exit' to reboot, or power off machine to complete the process. |
| 41 | +Once the memory stick is ready, you can do any of the following: |
| 42 | +- Option A: Manually copy all files from the ISO to the formatted memory stick. |
| 43 | +- Option B: Write the image to the memory stick with ddrescue, Passmark imageUSB, or similar. |
| 44 | +- Option C: Use a bootable USB creation tool and select the ISO, or image as the source file, and the memory stick as the destination. |
53 | 45 |
|
54 | | - Quick video of flashing an SMC [here](https://www.youtube.com/watch?v=nUm30m3zNxI). |
| 46 | +> ❕ Extended instructions [here](BOOTABLEUSB.md). |
55 | 47 |
|
56 | | ---- |
57 | | -**Compatible Boards:** |
58 | | -- |
59 | | -See the [compatibility information](COMPATIBILITY.md). |
| 48 | +## Flashing An SMC |
60 | 49 |
|
61 | | -Older, single file payloads for boards such as 820-3115/3332 are currently being worked out. Support may be added in the future. |
| 50 | +1. Remove the internal storage drive. |
| 51 | +2. If you have a portable device, plug in the power adapter. |
| 52 | +3. Insert your USB stick, then power on the device whilst holding `Option ⌥`. |
| 53 | +4. Load into SMCTool from the boot menu and let 'startup.nsh' run. |
| 54 | +5. Type the 'boardnumber.nsh' you want to flash, e.g: `820-00165.nsh`, then press return; the script will then flash the SMC. |
| 55 | +6. Type `exit` to reboot, or power off machine to complete the process. |
62 | 56 |
|
63 | | ---- |
| 57 | +> ⚠ You may need to perform an [NVRAM reset](https://support.apple.com/en-mide/HT201255) after flashing an SMC. |
64 | 58 |
|
65 | | -**Compatible SMC:** |
66 | | -- |
| 59 | +**Why must the SMC be flashed?:**\ |
| 60 | +Each System Management Controller is specifically programmed for it's counterpart board, and is in charge of managing video, hibernation, battery charging, thermal and power management. Incorrect or mismatched firmware causes erratic behaviour such as broken display resolution, high fan speed, throttling, and crashing. |
67 | 61 |
|
68 | | -✅ Texus Instruments LM4 BGA157\ |
69 | | -❌ Texus Instruments TM4 BGA168\ |
70 | | -❌ Renesas DF2117 BGA145 |
| 62 | +**I flashed an incorrect firmware:**\ |
| 63 | +No problem, just type the correct board number and the correct payload will be flashed. If you restart, or power off after an incorrect payload flash you may brick the device. If a system is somehow rendered 'bricked', and cannot get to the boot menu, you must replace the SMC again. You can always put the incorrectly flashed SMC aside for future use on a board it was 'accidentally' programmed for. |
71 | 64 |
|
72 | | -Currently supporting MacBook, and Mac Mini. iMac support is in development. |
| 65 | +> 💻 Quick video of flashing an SMC [here](https://www.youtube.com/watch?v=nUm30m3zNxI). |
73 | 66 |
|
74 | | ---- |
75 | | -**Why must the firmware be flashed:** |
76 | | -- |
77 | | -Each System Management Controller is specifically programmed for it's counterpart board, and is in charge of managing video, hibernation, battery charging, thermal and power management. Incorrect or mismatched firmware causes erratic behaviour such as broken display resolution, high fan speed, throttling, and crashing. |
| 67 | +## Compatibility |
| 68 | + |
| 69 | +**Devices:** |
78 | 70 |
|
79 | | ---- |
80 | | -**If you flash the wrong firmware:** |
81 | | -- |
82 | | -You must immediately flash the correct firmware before powering off the system. In some cases you **might** brick the system if you reboot after flashing the incorrect firmware. After much testing I've never achieved a bricked board by flashing an incorrect firmware, however, others have mentioned 'no power' after loading the wrong SMC firmware for that board after a reboot, or power down. |
| 71 | +| Platform | Supported? | Planned?| |
| 72 | +|----------|-------------|--------| |
| 73 | +| MacBook | ✅ | `N/A` | |
| 74 | +| Mac Mini | ✅ | `N/A` | |
| 75 | +| iMac | ❌ | `In development`| |
| 76 | +| Mac Pro | ❌ | `Researching` | |
83 | 77 |
|
84 | | -If a system is somehow rendered 'bricked' and cannot get to the boot menu, you must replace the SMC again. You can always put the incorrectly flashed SMC aside for future use on a board it was 'accidentally' programmed for. |
| 78 | +> ℹ See the [compatibility information](COMPATIBILITY.md) for a full list of supported models. |
85 | 79 |
|
86 | | ---- |
87 | | -**If you want to flash a different firmware:** |
88 | | -- |
89 | | -You must replace the update, base, code and EPM in the respective folder, say 820-00165 would be `payloads\Mac-937CB26E2E02BB01`. |
| 80 | +**System Management Controllers:** |
90 | 81 |
|
91 | | -Alternative SMC payloads can be found in firmwareupdate.pkg inside the MacOS Install.ESD file, or [here](https://github.com/sadponyguerillaboy/SMC-Toolkit/tree/main/SMCPayloads). |
| 82 | +| SMC | Supported? | Planned?| |
| 83 | +|----------------|-------------|---------| |
| 84 | +| LM4F BGA157 | ✅ | `N/A` | |
| 85 | +| TM4C BGA168 | ❌ | `Researching` | |
| 86 | +| F2117LP BGA145 | ❌ | `No` | |
92 | 87 |
|
93 | | ---- |
| 88 | +> ℹ Older single file payloads for boards such as 820-3115, 3332, and 3462 are currently being worked out. Support *may* be added in the future. |
94 | 89 |
|
95 | | -**Screen resolution:** |
96 | | -- |
97 | | -Use the `mode` command to display a list of supported screen modes, type the highest mode available e.g. `mode 160 47`, then press return. |
| 90 | +## Disclaimers |
98 | 91 |
|
99 | | -The script will automatically switch screen mode when it can. |
| 92 | +I'm not responsible if you do something wrong, if you're here I expect you to know what you're doing. Where I do my utmost to verify all information to my best ability, I'm not responsible for any mistakes my end either. |
100 | 93 |
|
101 | | ---- |
102 | | -**Licenses and acknowledgements:** |
103 | | -- |
104 | | -Startup manager icon by [KBuHT](https://macosicons.com/#/u/KBuHT) on macOSicons. |
| 94 | +This is **not** a magical 'fix my Mac' tool, it has a specific purpose, which is flashing correct payloads to a System Management Controller with incorrect firmware. **Do not** flash your SMC if you have no reason to. |
105 | 95 |
|
106 | | - *** UEFI Shell v2.0, release 4.632 *** |
| 96 | +## Acknowledgements |
107 | 97 |
|
108 | | - This bootable image contains builds of the 2.0 UEFI Shell, as provided by the |
109 | | - Open Source 'EDK' project (https://github.com/tianocore/edk). |
| 98 | +> 🖼 Project icon by [KBuHT](https://macosicons.com/#/u/KBuHT) on macOSicons.\ |
| 99 | +> 💡 This tool is based on the work from [logi.wiki](https://logi.wiki/index.php?title=SMC_flashing).\ |
| 100 | +>🎥 SMC Tool tested by Paul L Daniels on [YouTube](https://www.youtube.com/watch?v=q8LEh8C4iYo). |
110 | 101 |
|
111 | | - More specifically, this release, which we call '4.632', was produced using the |
112 | | - Shell executables, built on 2010.05.07, and published at: |
113 | | - https://github.com/tianocore/edk/tree/master/Other/Maintained/Application/UefiShell/bin |
| 102 | +**⭐ Many Thanks To ⭐** |
| 103 | +* Paul L Daniels for development help, and the kick to finish this project. |
| 104 | +* Logi.wiki for the original work, which I could base this project on. |
| 105 | +* EineWildeStehlampe for information and help regarding UEFI. |
| 106 | +* theSmudge for being a great help verifying information. |
| 107 | +* Nobluesky for verifying iMac board-id's. |
114 | 108 |
|
115 | | - This image supports the following UEFI platform architectures: |
116 | | - * X64 |
117 | | - * IA32 |
| 109 | +## Donate |
118 | 110 |
|
119 | | - You are invited to validate that the binaries provided on this ISO are 100% |
120 | | - identical to the ones from the official EDK project. |
| 111 | +<a href="https://www.buymeacoffee.com/Muerto"> |
| 112 | +<img width="160" src="https://uc80e5ba3058c2d15b2a77972a8b.previews.dropboxusercontent.com/p/thumb/AB18JbfsN4REmFgvOrzwO3ooBl2K1VkxckN-h1H0qKcNhQDfIIROLC57mhfRHlNPZXBDEK7S3gHEnx6Uc35udaYsS-Mx66J6llYd_lSwfaIAntk3eynVXJNhd5nRHFDI1ncBuDVpVbrtKeQZlP2WPhejwCDH99YAFH8xcPef9q2d37EBjVV9-cK4cGUd7KmXCfa81wP6tXXV8r7-f_5L1c6tgs9HxLgqaDlAPXG8BcM9B6NRFdxlOsLGvYh9ESFE7fMb7dTrOu7PgsBsVrrIfTOxL8akUj2QiSGMJiZNXJrYrsW7mjKu_qQ-7Z-mhlZ2ZtY-FApmMFhfQrWj17D7hiXCemMdb_SaZCbaHBucMaJZ5Y1OPY3a6XlAxUCNJXSrFoI/p.png" alt="Buy Me A Coffee Logo"> |
| 113 | +</a> |
121 | 114 |
|
122 | | - For more information on this release, you are invited to visit our official |
123 | | - project page at https://github.com/pbatard/UEFI-Shell. |
| 115 | +--- |
0 commit comments