From a6449c911f54d13e9120c1aa170c1bfa62052191 Mon Sep 17 00:00:00 2001 From: mutchiko <95985922+mutchiko@users.noreply.github.com> Date: Sun, 8 Dec 2024 00:07:51 +0100 Subject: [PATCH 1/7] add instructoins to the list of supported devices --- docs/supported_devices.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/supported_devices.md b/docs/supported_devices.md index 55a28c6..0bb0833 100644 --- a/docs/supported_devices.md +++ b/docs/supported_devices.md @@ -5,6 +5,11 @@ - ⭕ - partially supported (has problems) - ❓ - supported by hardware but not the driver (yet?) +# Instructions + +- Save some time and use the search functionality in your browser: ```ctrl+f``` and then type the model (example: ```Katana GF66 11UC```) +- If you can't find your device on this list, follow [this guide](https://github.com/mutchiko/msi-ec/blob/main/docs/device_support_guide.md) to add support to your device and open a new issue + | Model | EC version | Issues & PRs | ID |                      Functions                      | |---------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Alpha 15 B5EE / B5EEK | 158LEMS1 | Issues:
- [#16](https://github.com/BeardOverflow/msi-ec/issues/16)
PRs:
- [#22](https://github.com/BeardOverflow/msi-ec/pull/22) | 5 | ✔️ Battery thresholds
✔️ Webcam toggle
✔️ Webcam block
✔️ Fn <-> Win
✔️ Cooler boost
✔️ Shift mode
✔️ Fan mode
✔️ Mic mute LED
✔️ Sound mute LED
❌ Keyboard backlight intensity | From 75ae250651c25dfa0540317f3a98c776edb14479 Mon Sep 17 00:00:00 2001 From: mutchiko <95985922+mutchiko@users.noreply.github.com> Date: Sun, 8 Dec 2024 00:50:42 +0100 Subject: [PATCH 2/7] Improve README.md 1- added mention of MControlCenter because it acts as a good replacement for the graphical interfaces found on windows 2- removed mention of the wiki article to avoid confusoin because it was unfinished and not very helpful when there is already a guide to make things easy to understand --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7ab6e90..6467a8f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ This driver might not work on other laptops produced by MSI. Use it at your own risk, we are not responsible for any damage suffered. -Also, and until future enhancements, no DMI data is used to identify your laptop model. In the meantime, check the msi-ec.c file before using. +Also, and until future enhancements, no DMI data is used to identify your laptop model. In the meantime, check the list of supported devices and the msi-ec.c file before using. + +There is a graphical interface that uses this driver: [MControlCenter](https://github.com/dmitry-s93/MControlCenter). however, current version doesn't use this driver; so you need to build the app from source to control the driver through it. ## Supported devices @@ -15,8 +17,7 @@ Can't find your device in the list? Check the contribution guides and open a new ## Contribute Eager to support the project? Your help is always welcome to keep the project alive and going! -- Read how to add support for your device and get the necessary information on Windows and Linux in [this guide](docs/device_support_guide.md) -- Check out the relevant [wiki article](https://github.com/BeardOverflow/msi-ec/wiki/Contributing). +- Read how to add support for your device and get the necessary information on Windows and Linux in [this guide](docs/device_support_guide.md). - If you want to go deeper: [read into this discussion regarding EC firmware naming patterns](https://github.com/BeardOverflow/msi-ec/discussions/98). From 73d7cdbf1fdd18575ce8abb298b501f3fbc04430 Mon Sep 17 00:00:00 2001 From: mutchiko <95985922+mutchiko@users.noreply.github.com> Date: Sun, 8 Dec 2024 18:19:52 +0100 Subject: [PATCH 3/7] Update README.md add acpi clarification new MCC version is set to release this month - remove mention of compiling from source --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6467a8f..c32a308 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ This driver might not work on other laptops produced by MSI. Use it at your own Also, and until future enhancements, no DMI data is used to identify your laptop model. In the meantime, check the list of supported devices and the msi-ec.c file before using. -There is a graphical interface that uses this driver: [MControlCenter](https://github.com/dmitry-s93/MControlCenter). however, current version doesn't use this driver; so you need to build the app from source to control the driver through it. +The driver has no effect on ACPI, so if you have any ACPI errors, the driver can't fix them; consider extracting the ACPI tables and/or following the [Arch wiki](https://wiki.archlinux.org/title/DSDT) + +You might want to use a graphical interface instead of executing commands to use the driver: [MControlCenter](https://github.com/dmitry-s93/MControlCenter). ## Supported devices From dc589ac8051aa276ddbe64d036fd34bd236e6359 Mon Sep 17 00:00:00 2001 From: mutchiko <95985922+mutchiko@users.noreply.github.com> Date: Sun, 8 Dec 2024 19:43:15 +0100 Subject: [PATCH 4/7] expand Contribute section mention discussion by @glpnk that has fixes for common problems --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index c32a308..47fa199 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Can't find your device in the list? Check the contribution guides and open a new ## Contribute Eager to support the project? Your help is always welcome to keep the project alive and going! - Read how to add support for your device and get the necessary information on Windows and Linux in [this guide](docs/device_support_guide.md). +- Get solutions for common MSI laptop problems (ACPI errors, slow charger detection,...) and submit fixes if you have any in this [discussion](https://github.com/BeardOverflow/msi-ec/discussions/130#discussioncomment-9694621). - If you want to go deeper: [read into this discussion regarding EC firmware naming patterns](https://github.com/BeardOverflow/msi-ec/discussions/98). From 1ba2c2ff921c04bba7fdf2fd6649a20b4ae18168 Mon Sep 17 00:00:00 2001 From: mutchiko <95985922+mutchiko@users.noreply.github.com> Date: Sun, 8 Dec 2024 19:49:10 +0100 Subject: [PATCH 5/7] Update README.md fix link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 47fa199..80390b7 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Can't find your device in the list? Check the contribution guides and open a new ## Contribute Eager to support the project? Your help is always welcome to keep the project alive and going! - Read how to add support for your device and get the necessary information on Windows and Linux in [this guide](docs/device_support_guide.md). -- Get solutions for common MSI laptop problems (ACPI errors, slow charger detection,...) and submit fixes if you have any in this [discussion](https://github.com/BeardOverflow/msi-ec/discussions/130#discussioncomment-9694621). +- Get solutions for common MSI laptop problems (ACPI errors, slow charger detection,...) and submit fixes if you have any in this [discussion](https://github.com/BeardOverflow/msi-ec/discussions/130#). - If you want to go deeper: [read into this discussion regarding EC firmware naming patterns](https://github.com/BeardOverflow/msi-ec/discussions/98). From 70ca559a1bc7ae9fe280e3250169cf013826a7ce Mon Sep 17 00:00:00 2001 From: mutchiko <95985922+mutchiko@users.noreply.github.com> Date: Tue, 10 Dec 2024 17:00:08 +0100 Subject: [PATCH 6/7] fix link --- docs/supported_devices.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/supported_devices.md b/docs/supported_devices.md index 0bb0833..da00033 100644 --- a/docs/supported_devices.md +++ b/docs/supported_devices.md @@ -8,7 +8,7 @@ # Instructions - Save some time and use the search functionality in your browser: ```ctrl+f``` and then type the model (example: ```Katana GF66 11UC```) -- If you can't find your device on this list, follow [this guide](https://github.com/mutchiko/msi-ec/blob/main/docs/device_support_guide.md) to add support to your device and open a new issue +- If you can't find your device on this list, follow [this guide](https://github.com/BeardOverflow/msi-ec/blob/main/docs/device_support_guide.md) to add support to your device and open a new issue | Model | EC version | Issues & PRs | ID |                      Functions                      | |---------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| From c6ba9ae172c8498277e156de6fe9d162d43e55be Mon Sep 17 00:00:00 2001 From: mutchiko <95985922+mutchiko@users.noreply.github.com> Date: Sat, 4 Jan 2025 00:02:48 +0100 Subject: [PATCH 7/7] Update issue template to be in line with README --- .github/ISSUE_TEMPLATE/support_request.yml | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/support_request.yml b/.github/ISSUE_TEMPLATE/support_request.yml index b8ec22e..78f9caf 100644 --- a/.github/ISSUE_TEMPLATE/support_request.yml +++ b/.github/ISSUE_TEMPLATE/support_request.yml @@ -1,17 +1,16 @@ name: New firmware request -description: Request a new EC configuration to be added +description: Request to add support for a new device (new EC configuration) labels: ["New firmware"] body: - type: markdown attributes: value: > - Please, get the latest version of the driver from github, - build it and load it in the debug mode, then fill out the fields below. - - To build the driver from source, run `make` - - To load the driver in the debug mode, run `sudo make load-debug` + Before you open a new issue, please check the [supported devices list](https://github.com/BeardOverflow/msi-ec/blob/main/docs/supported_devices.md), + If it's not there, you should follow the guide mentioned on the main page, + and then make a list of the addresses for features and their values to submit it here. + + It's also possible to skip the issue and make a pull request directly. - type: input id: model @@ -25,15 +24,15 @@ body: id: ec-firmware attributes: label: EC firmware version - description: cat /sys/devices/platform/msi-ec/debug/fw_version + description: Get your current EC firmware version from the msi app on windows or the info page in the bios validations: required: false - type: textarea - id: ec-dump + id: feature-list attributes: - label: EC memory dump - description: cat /sys/devices/platform/msi-ec/debug/ec_dump + label: List of addresses and their values + description: Make a list of address = value for each possible feature, you can submit an incomplete list and continue later render: text validations: required: false