Added power tracking api #12691

purdeaandrei · 2021-04-25T13:33:41Z

Description

This has now been tested on chibios, running on an STM32F446, and atmega32u4, and atmega32u2.

Types of Changes

Issues Fixed or Closed by This PR

Checklist

My code follows the code style of this project: C, Python
I have read the PR Checklist document and have made the appropriate changes.
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).

purdeaandrei · 2021-05-01T14:37:14Z

Tested on STM32F446, and atmega32u4, and atmega32u2.

quantum/power.c

drashna · 2021-06-22T02:36:29Z

While the code looks good, "power tracking" doesn't sound right to me.

The point is getting the status from USB, correct? Then maybe "USB Power State" would be more accurate, maybe?

That said, I know that naming stuff is hard. I have some truly atrociously named stuff that has made it into core, so I definitely understand that.

stale · 2021-08-06T18:07:13Z

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.

purdeaandrei · 2021-08-22T23:12:39Z

@drashna
I have rebased the branch on top of latest develop.
I have also renamed power to usb_power. So for example the main .c file is now quantum/usb_power.c, and the main variable holding the usb power state is called "usb_power_state".
The word 'tracking' is not in the source code content, only in some commit messages, the branch name, and the PR description.

Let me know if any further changes are needed.
Note: I have not yet tested this since the rebase. I will test soon, and I will drop another comment here when that happens.

drashna · 2021-08-23T01:30:57Z

Honestly, i'm still not too happy with the naming, as it doesn't really reflect what it is.

usb_device_state_* feels much more accurate of a name for this (and is similar to the LUFA and ChibiOS event names, to boot).

purdeaandrei · 2021-08-23T04:46:47Z

@drashna Renamed as you suggested.

quantum/usb_device_state.h

purdeaandrei · 2021-08-26T19:37:10Z

I re-tested the current version of a branch on an STM32F446-based keyboard.
I set the locklights to output the usb_device_state enum every time it changes.
On connection to a linux pc I observed:
USB_DEVICE_STATE_INIT -> USB_DEVICE_STATE_SUSPEND -> USB_DEVICE_STATE_INIT -> USB_DEVICE_STATE_CONFIGURED
I observed the same as above on connection to an Android phone.

On the computer suspending I observed:
USB_DEVICE_STATE_CONFIGURED -> USB_DEVICE_STATE_SUSPEND

On the computer exiting suspend I observed:
USB_DEVICE_STATE_SUSPEND -> USB_DEVICE_STATE_CONFIGURED

On the 1Amp port of a 'powerzilla' power bank I observed: USB_DEVICE_STATE_INIT -> USB_DEVICE_STATE_SUSPEND
On the 2.1Amp port of the same power bank I ovserved the keyboard staying in USB_DEVICE_STATE_INIT forever.

Note: since I didn't analyze this with a logical analyzer, in theory there could be super fast state transitions that I missed with my eyes.

…r_init();

Co-authored-by: Drashna Jaelre <[email protected]>

purdeaandrei · 2021-09-16T22:34:02Z

Rebased (not cause this PR needed it, but because the dependent 12692 PR had a conflict)

tzarc · 2021-09-18T07:31:50Z

Can you explain the unused configurationNumber parameters?

purdeaandrei · 2021-09-18T11:47:01Z

@tzarc In general, the configuration number matters to how much power the USB device is allowed to consume, because each USB device could have multiple configurations, only one of which is selected at any point in time (or none if not configured).
Each configuration descriptor has its own ".MaxPowerConsumption", so you could have in theory one configuration that consumes 500mA, and one that consumes only 100mA. At the moment everything is using just one configuration in QMK, so that's why it's unused for now.

One possible usecase in the future would be, if a keyboard has a 500mA-using solenoid driver, it could have one configuration to select 500mA, and another one to select 100mA, and disable the solenoid driver automatically, or set it into a 100mA current-limited mode. So when you plug the keyboard into a normal USB port, or powered hub, you get full solenoid operation, but in an unpowered usb hub, the solenoid is automatically disabled, or in slower current-limited mode.

Or in case of keyboards with high current-consumption backlights, it could throttle the backlight intensity when plugged into a 100mA-only port.

I'm not 100% sure if default HID operating system drivers are smart enough to select the alternative 100mA configuration, when they can't enable the 500mA one, or if they will just disable the USB device, so my specific example may not be a good one, but it's still worth keeping the interface, even if my example doesn't actually work in the real world, just in case we will add multiple-configuration support in the future for other reasons.

* qmk/develop: (21 commits) massdrop alt/ctrl: support saving into nvm (qmk#6068) Added power tracking api (qmk#12691) Mechlovin Hannah60RGB touch-up (qmk#14646) [Core] Fix "6kro enable" and clarify naming (qmk#14563) [Keymap] Update to Drashna Code (qmk#14644) [Keyboard] add support for Quark_LP (qmk#14552) [Keyboard] Update Grandiceps to Rev2 (qmk#14618) [Keymap] Jonavin murphpad keymap update (qmk#14637) [Keyboard] Updates for Tractyl Manuform config (qmk#14641) [Keyboard] Fix end of file issue for Owlab suit80 (qmk#14640) [Keyboard] Add support for PaladinPad, Arya pcb and move keyboards by KapCave into their own directory (qmk#14194) [Keymap] Keychron Q1 user keymap (qmk#14636) Fix for mechlovin/adelais/standard_led/arm/rev4 (qmk#14639) convert checkerboards/quark_squared:via rules.mk to Unix line endings (qmk#14638) Mechlovin Delphine: add LAYOUT_numpad_6x4 (qmk#14635) Move "firmware size check skipped" note to message.mk (qmk#14632) [Keymap] fix NKRO - switch to get_mods() and refactor encoder action code (qmk#14278) [Keyboard] Yampad VIA support (qmk#14397) [Keyboard] Add OwLab Suit80 (qmk#14362) [Keymap] arkag userspace/keymap -- new macro and minor preonic keymap change (qmk#14623) ...

* Add power tracking API to lufa and chibios targets * power.c: Pass through power state to the notify function * power: added notify_power_state_change_user too. * making it pass the PR linter * Add a POWER_STATE_NO_INIT state, that we start in before calling power_init(); * Rename *power* to *usb_power* * removing stray newline * Rename usb_power* to usb_device_state* * Update quantum/usb_device_state.h Co-authored-by: Drashna Jaelre <[email protected]> * Fix comment * usb_device_state.h: Don't include quantum.h, only the necessary headers. Co-authored-by: Drashna Jaelre <[email protected]>

github-actions bot added cli qmk cli command core documentation keyboard keymap python translation via Adds via keymap and/or updates keyboard for via support labels Apr 25, 2021

purdeaandrei changed the base branch from master to develop April 25, 2021 13:34

This was referenced Apr 25, 2021

haptic: Feature to disable haptic feedback when USB is not configured or suspended #12487

Closed

F haptic disable when usb not configured or suspended #12692

Merged

drashna requested changes May 9, 2021

View reviewed changes

quantum/power.c Outdated Show resolved Hide resolved

drashna requested review from tzarc, fauxpark and a team May 9, 2021 03:26

purdeaandrei force-pushed the f_added_power_tracking_api branch from 7a5fcda to 7667026 Compare June 21, 2021 19:37

github-actions bot removed keymap cli qmk cli command via Adds via keymap and/or updates keyboard for via support documentation keyboard python translation labels Jun 21, 2021

drashna self-requested a review June 22, 2021 02:36

stale bot added the awaiting changes label Aug 6, 2021

purdeaandrei force-pushed the f_added_power_tracking_api branch from 74f3fc8 to c084d5a Compare August 22, 2021 23:08

stale bot removed the awaiting changes label Aug 22, 2021

drashna requested changes Aug 23, 2021

View reviewed changes

quantum/usb_device_state.h Outdated Show resolved Hide resolved

drashna approved these changes Aug 23, 2021

View reviewed changes

drashna requested a review from a team September 11, 2021 02:28

purdeaandrei and others added 11 commits September 17, 2021 01:30

Add power tracking API to lufa and chibios targets

62354ab

power.c: Pass through power state to the notify function

a9287a3

power: added notify_power_state_change_user too.

44effd9

making it pass the PR linter

a9aaf8e

Add a POWER_STATE_NO_INIT state, that we start in before calling powe…

95958c1

…r_init();

Rename *power* to *usb_power*

547661b

removing stray newline

b8193dc

Rename usb_power* to usb_device_state*

103b29d

Update quantum/usb_device_state.h

e1c45e6

Co-authored-by: Drashna Jaelre <[email protected]>

Fix comment

f9a44d4

usb_device_state.h: Don't include quantum.h, only the necessary headers.

e4e7de9

purdeaandrei force-pushed the f_added_power_tracking_api branch from 7aadee6 to e4e7de9 Compare September 16, 2021 22:30

jackhumbert approved these changes Sep 18, 2021

View reviewed changes

tzarc approved these changes Sep 29, 2021

View reviewed changes

tzarc merged commit b02a539 into qmk:develop Sep 29, 2021

purdeaandrei deleted the f_added_power_tracking_api branch September 10, 2022 09:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Added power tracking api #12691

Added power tracking api #12691

Uh oh!

purdeaandrei commented Apr 25, 2021 •

edited

Loading

Uh oh!

purdeaandrei commented May 1, 2021 •

edited

Loading

Uh oh!

Uh oh!

drashna commented Jun 22, 2021

Uh oh!

stale bot commented Aug 6, 2021

Uh oh!

purdeaandrei commented Aug 22, 2021

Uh oh!

drashna commented Aug 23, 2021

Uh oh!

purdeaandrei commented Aug 23, 2021

Uh oh!

Uh oh!

purdeaandrei commented Aug 26, 2021 •

edited

Loading

Uh oh!

purdeaandrei commented Sep 16, 2021

Uh oh!

tzarc commented Sep 18, 2021

Uh oh!

purdeaandrei commented Sep 18, 2021 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Added power tracking api #12691

Added power tracking api #12691

Uh oh!

Conversation

purdeaandrei commented Apr 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

Uh oh!

purdeaandrei commented May 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

drashna commented Jun 22, 2021

Uh oh!

stale bot commented Aug 6, 2021

Uh oh!

purdeaandrei commented Aug 22, 2021

Uh oh!

drashna commented Aug 23, 2021

Uh oh!

purdeaandrei commented Aug 23, 2021

Uh oh!

Uh oh!

purdeaandrei commented Aug 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

purdeaandrei commented Sep 16, 2021

Uh oh!

tzarc commented Sep 18, 2021

Uh oh!

purdeaandrei commented Sep 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

purdeaandrei commented Apr 25, 2021 •

edited

Loading

purdeaandrei commented May 1, 2021 •

edited

Loading

purdeaandrei commented Aug 26, 2021 •

edited

Loading

purdeaandrei commented Sep 18, 2021 •

edited

Loading