Ecchan is a Rust-based ecram library for Rust. It allows you to control a lot of hardware features for your MSI laptop:

• get fan count
• get wmi version
• get fw info (version, date time)
• control shift mode
• control battery charge mode
• enable/disable super battery mode
• get fan 1-4 rpms
• control fan mode
• enable/disable webcam
• enable/disable cooler boost
• swap fn/win keys
• enable/disable mic/audio mute leds
• view real time cpu/gpu temp/fan speed
• view/set cpu/gpu fan/temp/hysteresis curves
• get raw/pretty ec dump
• custom model specific functions (things like overdrive, usb power share, etc)

In addition to that, it also has:

• an ipc server so client programs can control hardware
• dms (dankmaterialshell) control panel

Currently only supports WMI2 models.

This currently requires the Linux ec_sys driver is loaded with write_support enabled, however compatibility with msi-ec driver is planned at some point*, and using the driver will be preferred over direct ecram editing where possible.

* Note that msi-ec does not support editing of fan curves or model specific functions, so ec_sys will be required if you wish to control those functions.

• Install rust
• cargo build -p <crate_name>

Server is required for all clients. Client and servers are split because server must be run as root, but it's usually not feasible or possible to run clients as root.

ec: The core ecram editing library.

ecchan-dbus: This is currently unfinished because I don't have a need for it. I probably won't pick dev back up unless a significant need arises.

ecchan-qml: This plugin is required for any qml-based ui. This requires a c++ compiler as well as qt6 and all associated dev packages.

ecchan-ipc: Exposes types to interface with ecchan-server over socket

ecchan-server: The socket server which all clients talk to. Only 1 client at a time is allowed.

Use ecchan-ipc crate and make a client which reads/writes to the socket

1. Check if your ec version is supported under the fw folder.
2. If it isn't, then check msi-ec.c for your specific version
3. If it exists there, you may create a new module under wmi2 for your ec version. The format is similar, so it should be relatively easy to copy it from the c file.
4. If it does not exist, please check here for how to get the addresses and values for your specific model. While you're at it, you may consider making an issue report containing the addresses/values in their repo so they can also supoprt it.

You may add support for model specific features that are unavailable under fw in the models directory. You may find the model string for your laptop by doing a cat /sys/class/dmi/id/product_name.

msi-ec is a great project and is already a kernel driver. Building and installing it is relatively trivial too. However it does not support gpu fan/temp/hysteresis curves and model specific features, nor does it have an ipc api or ui.

This project has a hard ban on AI usage.

No AI was used in the programming of this library. It is entirely human produced.

Contributions to further improve and expand ec fw and model support are welcome. As per the AI policy, AI is not allowed to be used in the making of your contribution, and any such PRs and issues will immediately be rejected. If you used AI, please do not contribute.

However, AI assistance is allowed in a minimal sense for non-fw/model submissions. If you have gotten ideas and help from it, that's fine, but ultimately you must know in detail how your entire contribution works, and must have programmed it yourself (AI written code is not allowed).

Contibutions for new fw/models must have fully verified ec memory addresses and values. Since even a single incorrect memory write can brick hardware, there is zero tolerance for a single bug.

• Do not use AI to research or verify addresses, not even as an assistant.
• Thoroughly research addresses and values, then test them on your own hardware before submitting. If the values came from the msi-ec project, you are exempt from this requirement, but you must carefully ensure they match the project.
• Explicitly state your sources and the exact method used to find the addresses.

I do not plan to develop this ui and library past my current needs, i.e. I made this purely for myself. As stated, contributions such as bug fixes or features are welcome, but I am very unlikely to go out of my way to support anyone else's needs or requests. My level of support is purely on a "it works on my machine" basis. That being said, the library and ui has been intentionally designed to support other laptop models, so you should be able to fairly easily make support for your own firmware / models.

This mode is thought to be the same as "Turbo" mode, but the official software never actually uses or exposes this mode, so I avoid it. It's here for completeness sake though.

This is the "ending" battery percentage for battery charging. 60 means charge 50-60% 80 means charge 70-80% 100 means charge 100%

Except for 100%, every percentage you set it to will charge to N-10 to N. 10 is the lowest possible value as your battery would never charge otherwise.

Yes there are! All curve nodes are exposed for each fan curve (unlike official software), and 2 extra hidden fan curves are available (temperature and hysteresis)! Unlike most software, every single node is exposed. As a result, take care to set these to reasonable values, or your hardware may get damaged.

This requires a temperature change of ±N before the fw up/down ramps the fan. This promotes fan stability by keeping the fans from fluctuating as it crosses the threshold. Recommended to leave them alone, but they're there if you wanna change it.

This software is a hobby project. Every best effort has been made to ensure everything works properly, however it is still technically possible - even though highly unlikely - that something goes wrong. An extensive test suite was made precisely to ensure safety. If you are wary of a product that edits your ecram, you are encouraged to read, understand, and verify the memory addresses and values for your particular ec version and computer model (see point 4 under adding support for your model). I take no responsibility for ruined or damaged hardware. Use this at your own risk.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.