Migrate keyboards using uGFX to LED_MATRIX #9657

firetech · 2020-07-05T17:58:07Z

Migrate Input Club keyboards (Ergodox Infinity and Whitefox) away from uGFX for keyboard backlight.

Description

Ergodox Infinity and Whitefox use uGFX to control their keyboard backlight. Because of licensing issues, it's desirable to move away from uGFX (see #5268). The chip in question (IS31FL3731C) already had a working driver for use with LED Matrix (drivers/issi/is31fl3731-simple.c).

Since uGFX is still compiled for the LCD display in Ergodox Infinity, and it caused some naming conflicts, I had to rename the point_t type of LED/RGB Matrix. led_point_t seemed fitting. (This is in conflict with two lines in #12651, but is an easy fix.)

Types of Changes

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

drashna · 2020-07-21T00:48:08Z

I suspect that it will need more changes to get this working properly (read: 100%), but it looks like a good start, at least!

tzarc · 2020-07-21T00:51:39Z

Given that it's changing a bunch of things at once, it'll need to go to develop instead of master.

firetech · 2020-07-21T08:36:39Z

I suspect that it will need more changes to get this working properly (read: 100%), but it looks like a good start, at least!

Definitely. For now, I'm waiting for the i2c support to be merged before doing more work on this. I partly put it up here in case I forget, or someone else wants to continue. :)

drashna · 2020-07-24T04:07:22Z

Looks like there is an issue with the whitefox board:

Making whitefox with keymap default                                                                    [ERRORS]
lib/ugfx/src/gdisp/gdisp.c: In function '_gdispInit':
lib/ugfx/src/gdisp/gdisp.c:566:4: error: useless type name in empty declaration [-Werror]
    extern GDISPVMTLIST        GDISP_DRIVER_LIST;
    ^~~~~~
cc1: all warnings being treated as errors
 | 
 | 
 | 
make[1]: *** [tmk_core/rules.mk:386: .build/obj_whitefox/lib/ugfx/src/gdisp/gdisp.o] Error 1
make[1]: *** Waiting for unfinished jobs....

firetech · 2020-07-24T08:28:15Z

Looks like there is an issue with the whitefox board:

Yeah, I haven't touched the Whitefox yet, but I have changed some common code in quantum/visualizer, so it's entirely expected that it doesn't compile yet. ;)

Making this posting as a PR might have been jumping the gun a bit, it might have been better to make a normal issue and just refer to my branch...

fauxpark · 2020-07-30T10:28:43Z

The I2C PR has been merged now, so this should be good to progress.
Additionally, I just discovered the Infinity60 (also by Input:Club) uses the 3731C too, but has some custom controller code instead of uGFX.

stale · 2021-02-02T03:41:16Z

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

fauxpark · 2021-05-11T11:09:41Z

Yeah, that's an issue with the rest of the ISSI drivers too. It'd probably be best to update them all in one go, this will involve modifying some keyboard-level code as some of them also have SDB hooked up to a GPIO and needed a similar patch:

exclusive/e6_rgb
k_type
melgeek/mj61
melgeek/mj63
melgeek/mj64
melgeek/mj65
melgeek/mojo75
opendeck/32

firetech · 2021-05-11T11:53:57Z

@fauxpark Do you intend to work on that, or what is the plan?

EDIT: In the meantime, I'll check if setting SDB in matrix_init_kb() instead would work for Ergodox Infinity (although I have a feeling I tried that), and if so, this could be merged before such a rewrite?

fauxpark · 2021-05-11T13:18:53Z

@fauxpark Do you intend to work on that, or what is the plan?

Yup, but it might be a short while as technically develop is now locked to new PRs (apart from urgent bugfixes, of course).

firetech · 2021-05-11T17:10:24Z

Updated to be based on #12864 (not including it, but can't be built without it), and moved the IS31FL3731 SDB stuff to keyboard_pre_init_kb() (matrix_init_kb() is called after led_matrix_init(), so that didn't work), in anticipation of an improved, common way of setting SDB.

keyboards/whitefox/whitefox.c

keyboards/ergodox_infinity/ergodox_infinity.c

Completely untested, but it at least compiles, and is based on similar (tested) work on Ergodox Infinity.

firetech · 2021-05-13T11:30:17Z

Fixed the changes requested by @fauxpark, and removed some code made unnecessary by #12878.

fauxpark · 2021-06-08T13:39:09Z

keyboards/whitefox/whitefox.c

+#ifdef LED_MATRIX_ENABLE
+    /*
+     * Since K20x is stuck with a 32 byte EEPROM (see tmk_core/common/chibios/eeprom_teensy.c),
+     * and neither led_matrix_eeconfig.speed or .flags fit in this boundary, just force their values to default on boot.
+     */
+#    if !defined(LED_MATRIX_STARTUP_SPD)
+#        define LED_MATRIX_STARTUP_SPD UINT8_MAX / 2
+#    endif
+    led_matrix_set_speed(LED_MATRIX_STARTUP_SPD),
+    led_matrix_set_flags(LED_FLAG_ALL);
+#endif


Ideally, I would like to see if something like #12947 for the K20x fixes this, before merging.

As far as my research has lead me to understand, you basically need to wipe the entire MCU and reflash the bootloader to change the "EEPROM" size. 🙁

Then I'm not sure how else this can be solved if we want VIA support (and room for future core settings)... perhaps we should just fall back to the transient EEPROM implementation, that will eliminate the need for this code at least.

I've done some more investigation and realized that the partitioning code in eeprom_teensy.c isn't actually run on an already partitioned MCU. When I tried increasing EEPROM_SIZE locally, I guess my board therefore just crashed due to the firmware configuration not matching the hardware configuration.

The documentation is a bit fuzzy on the subject, but NXP Support claimed in their forum that the relevant flash and registers need to be in "an erased state" before running the PGMPART command. I'm a bit hesitant to try since I don't want to risk bricking my main keyboard, but it might be possible to try skipping the FTFL->FCNFG & FTFL_FCNFG_RAMRDY if statement and that way force the PGMPART command to be run. Due to what NXP Support said in the forums, my guess is that it won't work.

Edit: Forgot to mention that I have verified that the current config on my board MCU matches the setup that would be created by eeprom_initialize for a 32 byte EEPROM. Skimming the bootloader code made me worried that it expected a different partitioning, but that doesn't seem to be the case.

I've done some more investigation and realized that the partitioning code in eeprom_teensy.c isn't actually run on an already partitioned MCU.

As far as I can tell, the original Kiibohd firmware doesn't do any partitioning (so there is no persistent storage, apparently). So what probably happens when switching from Kiibohd to QMK is the eeprom_initialize() function gets called and sets up the FlexNVM for a 32-byte EEPROM.

This code seems to be mainly intended for actual Teensys, which have an external chip doing the bootloading, and according to the PJRC forum thread mentioned in the other PR, it sends the SETRAM command to turn the EEPROM functionality off. It also likely does a mass erase first.

And yeah, the manual says:

After clearing CCIF to launch the Program Partition command, the flash memory module first verifies that the EEPROM Data Size Code and FlexNVM Partition Code in the data flash IFR are erased.

Hmm. It might even be possible to switch the FlexRAM function over from EEPROM to RAM when an incompatible EESIZE is detected in SIM->FCFG1, in effect making the EEPROM driver work using the same code, but behaving transient. I'm gonna do some experimenting. 👨‍🔬

Working prototype! 😄

I also realized that the "crash" during boot after increasing EEPROM_SIZE was just an infinite loop in flexram_wait() due to the EEERDY flag never being set after an out-of-bounds write. Just making sure the FlexRAM isn't written to outside the partitioned EEPROM size is enough to make the board boot properly. In other words, the entire if (eeprom_size < EEPROM_SIZE) { ... } block in my prototype can be removed (but it might be desired).

If you feel that this would be a valid solution to the problem, I can make a PR of this after #12947 has been merged (would conflict heavily otherwise).

An issue detailing all of these findings may be a good idea, rather than having it all in this tangentially-related PR discussion.

Good point... I'll get one started.

fauxpark

One last thing, then I think I can merge this :)

keyboards/whitefox/config.h

keyboards/ergodox_infinity/config.h

firetech · 2021-06-10T07:42:36Z

Fixed.

Was considering adding a check of EEPROM_SIZE to the eeprom limit hack in matrix_init_kb discussed above, but realized that EEPROM_SIZE probably isn't defined in that context...

fauxpark · 2021-06-10T07:46:02Z

Thanks for all your work!

firetech mentioned this pull request Jul 5, 2020

[Feature Request] Port Adafruit ST7565 LCD code #5268

Closed

4 tasks

drashna added awaiting_pr Relies on another PR to be merged first core enhancement labels Jul 21, 2020

drashna requested a review from a team July 21, 2020 00:46

firetech changed the base branch from master to develop July 21, 2020 08:33

noroadsleft force-pushed the develop branch from 7d7f5bf to 2302d3b Compare July 26, 2020 07:32

noroadsleft force-pushed the develop branch from 550bb6a to 9d827f9 Compare July 31, 2020 19:44

noroadsleft force-pushed the develop branch from 7499550 to 8b7b3ce Compare August 11, 2020 08:24

noroadsleft force-pushed the develop branch 2 times, most recently from 1d4c0cd to 65c27a3 Compare August 29, 2020 21:41

noroadsleft force-pushed the develop branch from 3a8e1b8 to a1b96ba Compare September 4, 2020 22:03

noroadsleft force-pushed the develop branch from a1b96ba to 3430907 Compare September 12, 2020 11:46

skullydazed force-pushed the develop branch from fa8cf59 to cce70f1 Compare October 18, 2020 21:10

noroadsleft force-pushed the develop branch from 5720202 to dcefc1a Compare October 23, 2020 22:37

skullydazed force-pushed the develop branch from db745a9 to 68fc044 Compare October 28, 2020 02:16

noroadsleft force-pushed the develop branch from 92ca6b9 to c3221d4 Compare October 30, 2020 20:23

noroadsleft closed this Nov 28, 2020

noroadsleft deleted the branch qmk:develop November 28, 2020 20:02

tzarc reopened this Nov 28, 2020

github-actions bot added the keyboard label Nov 28, 2020

noroadsleft force-pushed the develop branch from 7d3841e to 3cc7d22 Compare November 30, 2020 11:32

drashna requested a review from tzarc December 17, 2020 04:14

firetech force-pushed the input_club_led_matrix branch from 067a3bf to e8b3fac Compare May 11, 2021 17:06

github-actions bot removed the core label May 11, 2021

fauxpark requested changes May 12, 2021

View reviewed changes

firetech added 3 commits May 13, 2021 11:18

Switch over Whitefox to LED Matrix for key backlight.

2044399

Completely untested, but it at least compiles, and is based on similar (tested) work on Ergodox Infinity.

Add is_keyboard_left() for Ergodox Infinity.

0c41148

Switch over Ergodox Infinity to LED Matrix for key backlight.

37c22b1

firetech force-pushed the input_club_led_matrix branch from e8b3fac to 37c22b1 Compare May 13, 2021 11:27

fauxpark approved these changes May 13, 2021

View reviewed changes

fauxpark requested a review from a team May 13, 2021 17:18

firetech mentioned this pull request May 14, 2021

Extensible split data sync #11930

Merged

14 tasks

firetech mentioned this pull request Jun 8, 2021

Add ST7565 LCD driver #13089

Merged

14 tasks

fauxpark reviewed Jun 8, 2021

View reviewed changes

fauxpark requested changes Jun 10, 2021

View reviewed changes

keyboards/whitefox/config.h Outdated Show resolved Hide resolved

keyboards/ergodox_infinity/config.h Outdated Show resolved Hide resolved

Remove value of LED_DISABLE_WHEN_USB_SUSPENDED defines.

e68c47a

fauxpark approved these changes Jun 10, 2021

View reviewed changes

fauxpark merged commit 6fe3943 into qmk:develop Jun 10, 2021

firetech mentioned this pull request Jun 10, 2021

Too small EEPROM size partitioning on K20x boards #13164

Closed

fauxpark mentioned this pull request Jul 2, 2021

Fancy lightning on Infinity Ergodox? #12450

Closed

firetech deleted the input_club_led_matrix branch July 12, 2021 15:48

mechlovin pushed a commit to mechlovin/qmk_firmware that referenced this pull request Jul 30, 2021

Migrate keyboards using uGFX to LED_MATRIX (qmk#9657)

2886eaa

mechlovin pushed a commit to mechlovin/qmk_firmware that referenced this pull request Jul 30, 2021

Migrate keyboards using uGFX to LED_MATRIX (qmk#9657)

6d8e51c

nhongooi pushed a commit to nhongooi/qmk_firmware that referenced this pull request Dec 5, 2021

Migrate keyboards using uGFX to LED_MATRIX (qmk#9657)

559b60b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate keyboards using uGFX to LED_MATRIX #9657

Migrate keyboards using uGFX to LED_MATRIX #9657

firetech commented Jul 5, 2020 •

edited

drashna commented Jul 21, 2020

tzarc commented Jul 21, 2020

firetech commented Jul 21, 2020 •

edited

drashna commented Jul 24, 2020

firetech commented Jul 24, 2020 •

edited

fauxpark commented Jul 30, 2020

stale bot commented Feb 2, 2021

fauxpark commented May 11, 2021

firetech commented May 11, 2021 •

edited

fauxpark commented May 11, 2021

firetech commented May 11, 2021

firetech commented May 13, 2021

fauxpark Jun 8, 2021

firetech Jun 8, 2021

fauxpark Jun 8, 2021

firetech Jun 8, 2021 •

edited

fauxpark Jun 8, 2021 •

edited

firetech Jun 9, 2021

firetech Jun 9, 2021 •

edited

fauxpark Jun 10, 2021

firetech Jun 10, 2021

firetech Jun 10, 2021

fauxpark left a comment

firetech commented Jun 10, 2021

fauxpark commented Jun 10, 2021

Migrate keyboards using uGFX to LED_MATRIX #9657

Migrate keyboards using uGFX to LED_MATRIX #9657

Conversation

firetech commented Jul 5, 2020 • edited

Description

Types of Changes

Checklist

drashna commented Jul 21, 2020

tzarc commented Jul 21, 2020

firetech commented Jul 21, 2020 • edited

drashna commented Jul 24, 2020

firetech commented Jul 24, 2020 • edited

fauxpark commented Jul 30, 2020

stale bot commented Feb 2, 2021

fauxpark commented May 11, 2021

firetech commented May 11, 2021 • edited

fauxpark commented May 11, 2021

firetech commented May 11, 2021

firetech commented May 13, 2021

fauxpark Jun 8, 2021

Choose a reason for hiding this comment

firetech Jun 8, 2021

Choose a reason for hiding this comment

fauxpark Jun 8, 2021

Choose a reason for hiding this comment

firetech Jun 8, 2021 • edited

Choose a reason for hiding this comment

fauxpark Jun 8, 2021 • edited

Choose a reason for hiding this comment

firetech Jun 9, 2021

Choose a reason for hiding this comment

firetech Jun 9, 2021 • edited

Choose a reason for hiding this comment

fauxpark Jun 10, 2021

Choose a reason for hiding this comment

firetech Jun 10, 2021

Choose a reason for hiding this comment

firetech Jun 10, 2021

Choose a reason for hiding this comment

fauxpark left a comment

Choose a reason for hiding this comment

firetech commented Jun 10, 2021

fauxpark commented Jun 10, 2021

firetech commented Jul 5, 2020 •

edited

firetech commented Jul 21, 2020 •

edited

firetech commented Jul 24, 2020 •

edited

firetech commented May 11, 2021 •

edited

firetech Jun 8, 2021 •

edited

fauxpark Jun 8, 2021 •

edited

firetech Jun 9, 2021 •

edited