Contributing

Contributing

WIP

Prerequisites

Linux

Get the latest version of the driver, build it and load it in the debug mode:

make
sudo make load-debug

You can also reload the driver if you have already loaded it previously:

sudo make reload-debug

Make sure the driver is working

Obtaining your EC firmware version

Linux

Load the driver in the debug mode and check the /sys/devices/platform/msi-ec/debug/fw_version file.

Windows

1. Install MSI system drivers
2. Install soundcard driver if keyboard has mute and micmute leds
3. Install MSI app for your model
4. Open RWEverything, select Embedded Controller (EC) menu
5. Save current values, load it by pressing Compare button, then press Compare button second time. Changed values which differ from the saved ones will be highlighted in red color. If the values are red but remain the same, you forgot to click Compare a second time.
6. Switch available modes in MSI app, find and write down addresses of changed values.
7. Save obtained data, if necessary repeat step 5-6

Adding support for a new firmware

Viewing and analyzing the EC memory contents

Linux

First, get an EC dump:

cat /sys/devices/platform/msi-ec/debug/ec_dump

You can also watch the EC memory in real time:

watch -d -n1 'cat /sys/devices/platform/msi-ec/debug/ec_dump'

(...)

Adding an updated version of a supported firmware