commit 9692706c3d221f6b440f286b5b91e03966a1d29c Author: kenji Date: Fri May 30 15:53:20 2025 -0400 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..be9312e --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/build/**/* +!/build/**/*.uf2 diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..8999287 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,45 @@ +set(PROJECT hyperx_kb_rgb) +cmake_minimum_required(VERSION 3.13) +set(PICO_SDK_PATH /home/kenji/programming/pico/c/pico-sdk) +set(PICO_PIO_USB_PATH /home/kenji/programming/pico/c/Pico-PIO-USB) +include (${PICO_SDK_PATH}/external/pico_sdk_import.cmake) +project(${PROJECT} C CXX ASM) + +pico_sdk_init() + +add_subdirectory(${PICO_PIO_USB_PATH} pico_pio_usb) + +add_executable(${PROJECT}) +target_sources(${PROJECT} PRIVATE + main_device.c + main_host.c + usb_descriptors.c + hyperx_elite2.c + # can use 'tinyusb_pico_pio_usb' library later when pico-sdk is updated + ${PICO_TINYUSB_PATH}/src/portable/raspberrypi/pio_usb/dcd_pio_usb.c + ${PICO_TINYUSB_PATH}/src/portable/raspberrypi/pio_usb/hcd_pio_usb.c +) + + + + + # print memory usage, enable all warnings +target_link_options(${PROJECT} PRIVATE -Xlinker --print-memory-usage) +target_compile_options(${PROJECT} PRIVATE ) #-Wall -Wextra + +# use tinyusb implementation +target_compile_definitions(${PROJECT} PRIVATE PIO_USB_USE_TINYUSB) + +# needed so tinyusb can find tusb_config.h +target_include_directories(${PROJECT} PRIVATE ${CMAKE_CURRENT_LIST_DIR}) + +target_link_libraries(${PROJECT} PRIVATE + pico_stdlib + pico_pio_usb + tinyusb_device + tinyusb_host + hardware_adc +) + +pico_add_extra_outputs(${PROJECT}) + diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..529e42c --- /dev/null +++ b/COPYING @@ -0,0 +1,16 @@ +HyperX Alloy Elite 2 Automatic Backlight - turn on/off backlight using +a light dependent resistor +Copyright (C) 2025 Kenji Kozai + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..fc4fc42 --- /dev/null +++ b/README.md @@ -0,0 +1,88 @@ +# HyperX Alloy Elite 2 Automatic Backlight + +This project automatically controls the RGB backlight of a HyperX Alloy Elite 2 +keyboard based on ADC readings from an attached light dependent resistor. The +backlight automatically turns on to white when the LDR reading is below +a programmed threshold and otherwise turns all RGB lights completely off. + +![Keyboard RGB turning on and off with ambient lighting](lightonoff.gif) + +## Setup + +### Hardware + +You will need the following hardware to make the device: +- Raspberry Pi Pico +- USB extension cable +- light dependent resistor such as GL5528 (specific part number may vary) +- 10k ohm resistor (resistance value may vary) + +You will need to cut the USB extension in half and connect the wires from the +female end to the Raspberry Pi Pico. The default configuration is to attach the +USB's green wire to pin 1/GP0 and USB's white wire to pin 2/GP1. You will also +need to connect the red to 5V VBUS/VSYS (since you'll be powering from the +USB host device, VBUS should be fine) and the black to any ground pin. Pin 38 +is the closest and most convenient. While you can connect the Raspberry Pi Pico +to the host device using the micro USB port and a micro USB cable, since +you have already sacrificed half of the USB extension cable, you might as well +use the male half to create a standard USB-A connection. If you wish to do, +then simply connect the red and black wires of the male connector end to +VBUS (5V) and GND, respectively. For the data wires, you can solder them to the +two test points TP2 and TP3 on the back of the Raspberry Pi Pico. The white +cable goes to TP2 and the green cable to TP3. + +![Back of Raspberry Pi Pico with USB connections to TP2 and TP3](back.jpg) + +The LDR should then be connected to the ADC2 pin (pin 34/GP28) and 3.3V (pin 36) +or alternative to the ADC_VREF (pin 35) and the regular resistor between ADC2 +and any ground, including ADC_GND (pin 33). The results look something like +the following. + +![Back of Raspberry Pi Pico with USB and LDR connected](front.jpg) + +The individual wires on the USB can be fragile, so hot glue or other strain +relief is a good idea. There is also a [model for a 3D printed +enclosure](pico-usb-ldr.stl) that you can use to place the Pico inside with a +hole for the LDR to detect ambient light. + +![3D printed enclosure with finished device](enclosure.jpg) + +## Software + +Flash the [hyperx_kb_rgb.uf2](hyperx_kb_rgb.uf2) file to the Raspberry Pi Pico, +and connect the keyboard to the female USB port and the insert the male USB +connector of the device into your host device such as PC. + +If you wish to change the ADC reading threshold for changing the lighting, +you can do so in the `get_light` function of [hyperx_elite2.c](hyperx_elite2.c). + +You can change the color used in the two different modes inside the `rgb_task()` +function of [hyperx_elite2.c](hyperx_elite2.c). + +If you used a different ADC pin than ADC2, you can change the selected ADC pin +in the `startADC()` function of [hyperx_elite2.c](hyperx_elite2.c). + +For any of the changes above, you will need to modify the +[CMakeLists.txt](CMakeLists.txt) file and compile the program yourself. You +will need to change `PICO_SDK_PATH` and `PICO_PIO_USB_PATH` to the +directories where you have the +[Raspberry Pi Pico SDK](https://github.com/raspberrypi/pico-sdk) and +[Pico-PIO-USB](https://github.com/sekigon-gonnoc/Pico-PIO-USB) library +downloaded on your machine. + +## Licensing + +This software is distributed under the [GNU General Public License version +3](LICENSE), with the exception of the libraries in the following section. + +## Credits + +The project uses code from the following sources: +- [OpenRGB](https://gitlab.com/CalcProgrammer1/OpenRGB/) for code related to + HyperX's [RGB lighting protocol](https://gitlab.com/CalcProgrammer1/OpenRGB/-/blob/master/Controllers/HyperXKeyboardController/HyperXAlloyElite2Controller/HyperXAlloyElite2Controller.cpp) + on the Alloy Elite 2 keyboard licensed under GNU-GPLv2 +- [Pico-PIO-USB](https://github.com/sekigon-gonnoc/Pico-PIO-USB/) for templates + used from the [host_hid_to_device_cdc](https://github.com/sekigon-gonnoc/Pico-PIO-USB/tree/control-keyboard-led/examples/host_hid_to_device_cdc) + example released under the MIT license +- [TinyUSB](https://github.com/hathach/tinyusb) for templates used in + [tusb_config.h](tusb_config.h) distributed under the MIT license diff --git a/back.jpg b/back.jpg new file mode 100644 index 0000000..6da722d Binary files /dev/null and b/back.jpg differ diff --git a/build/hyperx_kb_rgb.uf2 b/build/hyperx_kb_rgb.uf2 new file mode 100644 index 0000000..22a23fb Binary files /dev/null and b/build/hyperx_kb_rgb.uf2 differ diff --git a/enclosure.jpg b/enclosure.jpg new file mode 100644 index 0000000..c75c314 Binary files /dev/null and b/enclosure.jpg differ diff --git a/front.jpg b/front.jpg new file mode 100644 index 0000000..c6232ce Binary files /dev/null and b/front.jpg differ diff --git a/hyperx_elite2.c b/hyperx_elite2.c new file mode 100644 index 0000000..fe7b316 --- /dev/null +++ b/hyperx_elite2.c @@ -0,0 +1,307 @@ +#include + +#include "pico/stdlib.h" +#include "tusb.h" +#include "hardware/adc.h" + +#include "hyperx_elite2.h" +#include "usb_descriptors.h" + +static bool sending = false; +static absolute_time_t lastTime; +static bool backlight = false; + +static const unsigned int SKIP_INDICES[] = { 23, 29, 41, 47, 70, 71, 76, 87, 88, 93, 99, 100, 102, 108, 113, 123 }; +// added play/pause (123) + +static unsigned char buf[BUF_SIZE]; +static uint8_t buf_idx=0; +static uint8_t packets_sent=0; +static uint8_t color_idx = 0; +static uint8_t skipped = 0; +const unsigned int* skip_idx = &SKIP_INDICES[0]; + +static unsigned char nkro_buf[NKRO_BUF_SIZE]; +static unsigned char nkro_buf1[NKRO_BUF_SIZE]; +static unsigned char nkro_buf2[NKRO_BUF_SIZE]; +static unsigned char mediakeys[1] = {0}; +static unsigned char key_buf[KEY_BUF_SIZE]; +static uint8_t buf_start=0; +static uint8_t buf_end=0; +static uint8_t mediabit=0; +static uint8_t pos=0; +static bool mute=false; +static bool sendkeys=false; +static bool sendmedia=false; + +void get_light() { + // get ADC reading from LDR + // if above threshold, set backlight to off + if (adc_read() > 400) { + backlight = false; + } else { + backlight = true; + } +} + +void rgb_task(uint8_t dev_addr, uint8_t instance, uint8_t report_id) { + // the RGB protocol used by HyperX sends individual key RGB data in + // multiple packets + // the code here will determine if we are in the middle of sending + // updated color info (sending==true) and continue to send the next + // packet if so at a rate of one packet every 20ms + // otherwise, wait 1s before sending the next set of color packets + if (sending) { + if ( absolute_time_diff_us(lastTime, get_absolute_time()) > 20000) { + if( backlight) { + send_color(dev_addr, instance, report_id, 0x20, 0x20, 0x20); + // send a dim white color (#202020) for all keys + } else{ + send_color(dev_addr, instance, report_id, 0x00, 0x00, 0x00); + // turn off all lighting by sending (#000000) for all keys + } + lastTime = get_absolute_time(); + } + } else { + if ( absolute_time_diff_us(lastTime, get_absolute_time()) > 1000000) { + send_initial(dev_addr, instance, report_id); + lastTime = get_absolute_time(); + } + } +} + +// send an individual color packett with the desired RGB color +void send_color(uint8_t dev_addr, uint8_t instance, uint8_t report_id, uint8_t red, uint8_t green, uint8_t blue) { + memset(buf, 0x00, BUF_SIZE); + + buf_idx = 0; + + // check if there are still keys left to send and send updated colors + // for those keys + // each key gets 4 bytes - an init byte (0x81) plus 3 bytes for RGB + if(color_idx < NUM_KEYS) + { + while(color_idx < NUM_KEYS && buf_idx < BUF_SIZE){ + if(*skip_idx == color_idx + skipped) + { + // keys in skip_idx are not assigned to a key, so send all 0x00 + buf[buf_idx] = 0x00; + buf[buf_idx + 1] = 0x00; + buf[buf_idx + 2] = 0x00; + buf[buf_idx + 3] = 0x00; + + skip_idx++; + + if(skip_idx >= SKIP_INDICES + sizeof(SKIP_INDICES) / sizeof(unsigned int)) + { + skip_idx = SKIP_INDICES; + } + skipped++; + } else { + // start by sending color init byte for the current key + buf[buf_idx] = 0x81; + // turn rewind and fast forward keys to white + if(color_idx==105 || color_idx== 108) { + buf[buf_idx + 1] = 0x20; + buf[buf_idx + 2] = 0x20; + buf[buf_idx + 3] = 0x20; + } else if(color_idx==99) { + // set color of mute button to green or red based on mute + // toggle - note that this toggle is not synced to the PC's + // audio state and is presumed to be unmuted when the keyboard + // first receives power + if(mute) { + buf[buf_idx + 1] = 0x40; + buf[buf_idx + 2] = 0x00; + buf[buf_idx + 3] = 0x00; + } else { + buf[buf_idx + 1] = 0x00; + buf[buf_idx + 2] = 0x40; + buf[buf_idx + 3] = 0x00; + } + } else { + // for a normal key, send the desired RGB colors + buf[buf_idx + 1] = red; + buf[buf_idx + 2] = green; + buf[buf_idx + 3] = blue; + } + color_idx++; + } + buf_idx += 4; + } + + if(tuh_hid_set_report(dev_addr, instance, report_id, HID_REPORT_TYPE_FEATURE, buf, BUF_SIZE)) + { + // packet sent successfully, increment + packets_sent++; + } + } else { + if(packets_sent < NUM_PACKETS) + { + // all keys have been sent, but the protocol expects NUM_PACKETS + // packets to be sent in total; if we have not sent enough packets, + // send extra packets of all 0x00 until done + if(tuh_hid_set_report(dev_addr, instance, report_id, HID_REPORT_TYPE_FEATURE, buf, BUF_SIZE)) + { + packets_sent++; + } + } else { + // mark that sending of a full round of color packets completed + sending=false; + } + } +} + +// send the special initialization packet that tells the keyboard to expect +// color packets to follow +void send_initial(uint8_t dev_addr, uint8_t instance, uint8_t report_id) { + memset(buf, 0x00, BUF_SIZE); + + color_idx = 0; + skipped = 0; + skip_idx = &SKIP_INDICES[0]; + + // send initialization packet + buf[0x00] = 0x04; + buf[0x01] = 0xf2; + + if (tuh_hid_set_report(dev_addr, instance, report_id, HID_REPORT_TYPE_FEATURE, buf, BUF_SIZE)) + { + // we have begun sending packets, so set flag to continue sending + // packets at regular intervals + sending = true; + packets_sent=1; + } +} + +// initialize the ADC for reading the LDR +void startADC() { + stdio_init_all(); + adc_init(); + adc_gpio_init(28); + adc_select_input(2); +} + +// process media key presses and prepare HID Consumer Control byte +void send_media(uint8_t const* report, uint16_t len) { + (void) len; + switch(report[2]) { + case 0xB0: // set next button to vol up + mediabit = 4; + break; + case 0xB1: // set prev button to vol down + mediabit = 5; + break; + case 0xB3: // play/pause + mediabit = 2; + break; + case 0xB5: // mute + mediabit = 3; + if (report[3]) { + mute = !mute; + } + break; + default: + return; + } + if (report[3]) { + SET_KEYBIT(mediakeys, mediabit); + } else { + CLEAR_KEYBIT(mediakeys, mediabit); + } + // set flag to send media keys during the next sending round + sendmedia = true; +} + +// process new HID reports from the keyboard and set them up to forward to host +void process_report(uint8_t instance, uint8_t const* report, uint16_t len) { + if (instance==HYPERX_ITF_KEYBOARD || instance==HYPERX_ITF_NKRO) { + // received regular keyboard key events + if (sendkeys) { + // keyboard is currently sending to the host, add to queue + key_buf[buf_end]=len; + key_buf[buf_end+2]=instance; + memcpy(&key_buf[buf_end+2], report, len); + buf_end += (len + 2); + } else { + // immediately process keys and send new HID report to host + updatekeys(instance, report, len); + } + } else if (instance==HYPERX_ITF_KEYPRESS) { + // received media key events + send_media(report, len); + } +} + +// merge key states from boot keyboard and NKRO keyboard interfaces into a +// single packet to send to the host +void updatekeys(uint8_t instance, uint8_t const* report, uint16_t len) { + if(instance==HYPERX_ITF_KEYBOARD) { + boot2nkro(report, nkro_buf1, len); + sendkeys=true; + } else if (instance==HYPERX_ITF_NKRO) { + memcpy(nkro_buf2, report, len); + sendkeys=true; + } + merge_bitmap(nkro_buf, nkro_buf1, nkro_buf2); +} + +// set initial state of keyboard +void reset_keyboard() { + memset(nkro_buf, 0x00, NKRO_BUF_SIZE); + memset(nkro_buf1, 0x00, NKRO_BUF_SIZE); + memset(nkro_buf2, 0x00, NKRO_BUF_SIZE); + memset(key_buf, 0x00, KEY_BUF_SIZE); + buf_start=0; + buf_end=0; + sendkeys=false; + sendmedia=false; +} + +// check if there are any key events waiting to be sent to the host and send +void keyboard_task() { + if (sendkeys) { + // send the current keyboard state to the host + if (tud_hid_report(REPORT_ID_KEYBOARD, nkro_buf, NKRO_BUF_SIZE)) { + sendkeys=false; + } + } else if (sendmedia) { + // send the media keys state to the the host + if (tud_hid_report(REPORT_ID_CONSUMER_CONTROL, mediakeys, 1)) { + sendmedia=false; + } + } else if (buf_start != buf_end) { + // previous key state has been send, but a new key state is waiting + // in the buffer + // load from buffer and setup for sending in the next round + updatekeys(key_buf[buf_start+1], &key_buf[buf_start+2], key_buf[buf_start]); + buf_start += (key_buf[buf_start] + 2); + } else if (buf_start == buf_end) { + // the buffer has been cleared, so reset the buffer position to front + buf_start = 0; + buf_end = 0; + } +} + +// convert a boot keyboard packet into the NKRO bitmap format used by HyperX +void boot2nkro(uint8_t const* boot_report, uint8_t* nkro_report, uint16_t len) { + memset(nkro_report, 0x00, NKRO_BUF_SIZE); + (void) len; + // copy modifiers + nkro_report[0] = boot_report[0]; + + // set regular keyboard keys + for (pos=2; pos<8; pos++) { + if (boot_report[pos] > 0) { + SET_KEYBIT(nkro_report, boot_report[pos]+8); + } + } +} + +// merge two NKRO keyboard bitmaps into a single NKRO keyboard bitmap +void merge_bitmap(uint8_t* nkro_report, uint8_t const* nkro_report1, uint8_t const* nkro_report2){ + for (pos=0; pos < NKRO_BUF_SIZE; pos++) { + nkro_report[pos] = nkro_report1[pos] | nkro_report2[pos]; + } +} + diff --git a/hyperx_elite2.h b/hyperx_elite2.h new file mode 100644 index 0000000..d125425 --- /dev/null +++ b/hyperx_elite2.h @@ -0,0 +1,42 @@ +#ifndef HYPERX_ELITE2_H_ +#define HYPERX_ELITE2_H_ + +enum +{ + HYPERX_KEYBOARD_VID = 0x0951, + HYPERX_ELITE2_PID = 0x1711, + NUM_KEYS = 128, + BUF_SIZE = 64, + NUM_PACKETS = 10, + NKRO_BUF_SIZE = 15, + KEY_BUF_SIZE = 16*16, +}; + +enum +{ + HYPERX_ITF_KEYBOARD = 0, + HYPERX_ITF_KEYPRESS, + HYPERX_ITF_NKRO +}; + +void get_light(); +void rgb_task(uint8_t dev_addr, uint8_t instance, uint8_t report_id); +void send_color(uint8_t dev_addr, uint8_t instance, uint8_t report_id, + uint8_t red, uint8_t green, uint8_t blue); +void send_initial(uint8_t dev_addr, uint8_t instance, uint8_t report_id); +void startADC(); +void send_media(uint8_t const* report, uint16_t len); +void keyboard_task(); +void reset_keyboard(); +void updatekeys(uint8_t instance, uint8_t const* report, uint16_t len); +void process_report(uint8_t instance, uint8_t const* report, uint16_t len); + + +void merge_bitmap(uint8_t* nkro_report, uint8_t const* nkro_report1, uint8_t const* nkro_report2); +void boot2nkro(uint8_t const* boot_report, uint8_t* nkro_report, uint16_t len); + +#define SET_KEYBIT(array, index) do { (array)[(index) / 8] |= 1 << ((index) % 8); } while(0) +#define CLEAR_KEYBIT(array, index) do { (array)[(index) / 8] &= ~(1 << ((index) % 8)); } while(0) + + +#endif diff --git a/lightonoff.gif b/lightonoff.gif new file mode 100644 index 0000000..692b178 Binary files /dev/null and b/lightonoff.gif differ diff --git a/main_device.c b/main_device.c new file mode 100644 index 0000000..cb9981f --- /dev/null +++ b/main_device.c @@ -0,0 +1,94 @@ +#include +#include +#include + +#include "pico/stdlib.h" +#include "pico/multicore.h" +#include "pico/bootrom.h" +#include "hardware/clocks.h" + +#include "tusb.h" +#include "usb_descriptors.h" + +#include "hyperx_elite2.h" +#include "main_host.h" + +static absolute_time_t lastRead; + +extern void core1_main(); + +int main(void) { + // default 125MHz is not appropreate. Sysclock should be multiple of 12MHz. + set_sys_clock_khz(144000, true); + + // start ADC for reading LDR + startADC(); + + sleep_ms(10); + + multicore_reset_core1(); + // run TinyUSB host on core 1 + multicore_launch_core1(core1_main); + + // run TinyUSB device on core 0 + tud_init(0); + + while (true) { + if ( absolute_time_diff_us(lastRead, get_absolute_time()) > 500000) { + // read the ADC every 500ms to determine RGB lighting + get_light(); + } + // check keyboard packet queue and send to TinyUSB device + keyboard_task(); + // TinyUSB device task + tud_task(); + } + + return 0; +} + + +// Invoked when received SET_REPORT control request or +// received data on OUT endpoint ( Report ID = 0, Type = 0 ) + +void tud_hid_set_report_cb(uint8_t instance, uint8_t report_id, hid_report_type_t report_type, uint8_t const* buffer, uint16_t bufsize) +{ + + + if (instance == 0 && report_type==HID_REPORT_TYPE_OUTPUT && report_id==REPORT_ID_KEYBOARD) { + // received keyboard indicator LED status from host, so update on + // the keyboard + set_indicator(buffer,bufsize); + } + + // echo the HID report to CDC for debugging + char tempbuf[128]; + size_t count; + if(bufsize>0) { + count = sprintf(tempbuf, "\nReceived device set report type %u on interface %u with ID %u (%u)\n", report_type, instance, report_id, bufsize); + tud_cdc_write(tempbuf, count); + for(int i=0;i +#include +#include + +#include "pico/stdlib.h" +#include "pico/multicore.h" +#include "pico/bootrom.h" + +#include "pio_usb.h" +#include "tusb.h" +#include "usb_descriptors.h" +#include "hyperx_elite2.h" + +#include "main_host.h" + +static bool enabled=false; +static uint8_t kb_addr=0; + +// main process for core 1 to handle USB host events +void core1_main() { + sleep_ms(10); + + // configure PIO USB for use as TinyUSB host + pio_usb_configuration_t pio_cfg = PIO_USB_DEFAULT_CONFIG; + pio_cfg.alarm_pool = (void*) alarm_pool_create(2,1); + tuh_configure(1, TUH_CFGID_RPI_PIO_USB_CONFIGURATION, &pio_cfg); + tuh_init(1); + + + while (true) { + if (enabled) { + // keyboard is plugged in, so send RGB states on regular intervals + rgb_task(kb_addr, HYPERX_ITF_KEYBOARD, REPORT_ID_KEYBOARD); + } + tuh_task(); // tinyusb host task + } +} + +// Invoked when device with hid interface is mounted +void tuh_hid_mount_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* desc_report, uint16_t desc_len) +{ + (void)desc_report; + (void)desc_len; + + uint16_t vid, pid; + tuh_vid_pid_get(dev_addr, &vid, &pid); + const char* protocol_str[] = { "None", "Keyboard", "Mouse" }; + uint8_t const itf_protocol = tuh_hid_interface_protocol(dev_addr, instance); + + // send device vid:pid information to CDC for debugging + char tempbuf[128]; + size_t count = sprintf(tempbuf, "[%04x:%04x][%u] HID Interface %u, Protocol = %s \n", vid, pid, dev_addr, instance, protocol_str[itf_protocol]); + tud_cdc_write(tempbuf, count); + tud_cdc_write_flush(); + + // request to receive report if mounted device matches HyperX Alloy Elite 2 + if (vid==HYPERX_KEYBOARD_VID && pid==HYPERX_ELITE2_PID) + { + enabled = true; + kb_addr = dev_addr; + reset_keyboard(); + if ( !tuh_hid_receive_report(dev_addr, instance) ) + { + //tud_cdc_write_str("Error: cannot request report\r\n"); + } + } + +} + +// Invoked when device with hid interface is un-mounted +void tuh_hid_umount_cb(uint8_t dev_addr, uint8_t instance) +{ + (void) instance; + + if(dev_addr==kb_addr){ + kb_addr=0; + enabled=false; + } +} + +// Invoked when received report from device via interrupt endpoint +void tuh_hid_report_received_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* report, uint16_t len) +{ + char tempbuf[64]; + size_t count; + if(len>0) { + // echo HID report to CDC for debugging + count = sprintf(tempbuf, "\n[%u] Received message on interface %u (%u)\n", dev_addr, instance, len); + tud_cdc_write(tempbuf, count); + for(int i=0;i 31 ) chr_count = 31; + + // Convert ASCII string into UTF-16 + for(uint8_t i=0; i