refactor: Split endpoint to transport and instance #1803
Conversation
joelspadin
force-pushed
the
endpoint-instances
branch
from
9d7a329
to
fcec2ad
Compare
joelspadin
force-pushed
the
endpoint-instances
branch
from
fcec2ad
to
9c519c5
Compare
app/include/zmk/endpoints.h
Outdated
| */ | ||
| #define ZMK_ENDPOINT_COUNT (ZMK_ENDPOINT_USB_COUNT + ZMK_ENDPOINT_BLE_COUNT) | ||
|
|
||
| bool zmk_endpoint_instance_equals(struct zmk_endpoint_instance a, struct zmk_endpoint_instance b); |
There was a problem hiding this comment.
So, Zephyr uses eq shorthand pretty consistently, any reason not to use that convention as well here?
There was a problem hiding this comment.
Nope. Wasn't aware of that convention. I can update this.
There was a problem hiding this comment.
Done. Also changed the _print() function to _to_str() and reordered the arguments to match what looks like Zephyr conventions for that type of function as well.
Changed the endpoints code to rename the existing endpoint types to "transport" and add the concept of "endpoint instances". A transport is the method by which data is sent, while instances allow describing multiple endpoints that use the same transport (e.g. bluetooth profiles) Also added new APIs to get the total number of possible endpoint instances and assign each instance a unique index, which can be used for tracking separate state for each endpoint in other code files.
joelspadin
force-pushed
the
endpoint-instances
branch
from
9c519c5
to
e4ae6b5
Compare
|
Tested here on my ZMK Uno, and toggling the 3-way switch to toggle the selected endpoint all works as expected, including the output display, which is one of the main consumers of the change to the events. Will review the code, but functionality wise it looks good. |
|
Addressed the review comments and fixed a missing include. I put the fixes up as a separate commit so you can easily review the difference. (You'll probably want to squash them together when merging this.) |
|
Guess I missed the nice!view code since that was probably added after I started this. |
|
This last commit is untested aside from that it builds. It would be good to have someone verify this on a nice!view. (I do have one, but I haven't hooked it up to anything yet, so I'd need to do a bit of work before I could test it myself.) I also took the opportunity to optimize a few functions by passing the large status struct by pointer instead of value. |
|
Ok, was able to test this on my ZMK Uno built with a nice!view, and they all build and run perfectly fine. Merging, thanks @joelspadin! |
Changed the endpoints code to rename the existing endpoint types to "endpoint transport" and add the concept of "endpoint instances". A transport is the method by which data is sent, while instances allow describing multiple endpoints that use the same transport (e.g. bluetooth profiles).
Also added new APIs to get the total number of possible endpoint instances and assign each instance a unique index, which can be used for tracking separate state for each endpoint in other code files.