├── .gitmodules ├── COPYING.GPL3 ├── Makefile ├── README ├── TODO.org ├── stm32-tx-hid-bootldr.c ├── stm32-tx-hid.c ├── stm32f103-board.jpg └── stm32f103.ld /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "libopencm3"] 2 | path = libopencm3 3 | url = https://github.com/libopencm3/libopencm3.git 4 | -------------------------------------------------------------------------------- /COPYING.GPL3: -------------------------------------------------------------------------------- 1 | 2 | GNU GENERAL PUBLIC LICENSE 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The GNU General Public License is a free, copyleft license for 12 | software and other kinds of works. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | the GNU General Public License is intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. We, the Free Software Foundation, use the 19 | GNU General Public License for most of our software; it applies also to 20 | any other work released this way by its authors. You can apply it to 21 | your programs, too. 22 | 23 | When we speak of free software, we are referring to freedom, not 24 | price. Our General Public Licenses are designed to make sure that you 25 | have the freedom to distribute copies of free software (and charge for 26 | them if you wish), that you receive source code or can get it if you 27 | want it, that you can change the software or use pieces of it in new 28 | free programs, and that you know you can do these things. 29 | 30 | To protect your rights, we need to prevent others from denying you 31 | these rights or asking you to surrender the rights. Therefore, you have 32 | certain responsibilities if you distribute copies of the software, or if 33 | you modify it: responsibilities to respect the freedom of others. 34 | 35 | For example, if you distribute copies of such a program, whether 36 | gratis or for a fee, you must pass on to the recipients the same 37 | freedoms that you received. You must make sure that they, too, receive 38 | or can get the source code. And you must show them these terms so they 39 | know their rights. 40 | 41 | Developers that use the GNU GPL protect your rights with two steps: 42 | (1) assert copyright on the software, and (2) offer you this License 43 | giving you legal permission to copy, distribute and/or modify it. 44 | 45 | For the developers' and authors' protection, the GPL clearly explains 46 | that there is no warranty for this free software. For both users' and 47 | authors' sake, the GPL requires that modified versions be marked as 48 | changed, so that their problems will not be attributed erroneously to 49 | authors of previous versions. 50 | 51 | Some devices are designed to deny users access to install or run 52 | modified versions of the software inside them, although the manufacturer 53 | can do so. This is fundamentally incompatible with the aim of 54 | protecting users' freedom to change the software. The systematic 55 | pattern of such abuse occurs in the area of products for individuals to 56 | use, which is precisely where it is most unacceptable. Therefore, we 57 | have designed this version of the GPL to prohibit the practice for those 58 | products. If such problems arise substantially in other domains, we 59 | stand ready to extend this provision to those domains in future versions 60 | of the GPL, as needed to protect the freedom of users. 61 | 62 | Finally, every program is threatened constantly by software patents. 63 | States should not allow patents to restrict development and use of 64 | software on general-purpose computers, but in those that do, we wish to 65 | avoid the special danger that patents applied to a free program could 66 | make it effectively proprietary. To prevent this, the GPL assures that 67 | patents cannot be used to render the program non-free. 68 | 69 | The precise terms and conditions for copying, distribution and 70 | modification follow. 71 | 72 | TERMS AND CONDITIONS 73 | 74 | 0. Definitions. 75 | 76 | "This License" refers to version 3 of the GNU General Public License. 77 | 78 | "Copyright" also means copyright-like laws that apply to other kinds of 79 | works, such as semiconductor masks. 80 | 81 | "The Program" refers to any copyrightable work licensed under this 82 | License. Each licensee is addressed as "you". "Licensees" and 83 | "recipients" may be individuals or organizations. 84 | 85 | To "modify" a work means to copy from or adapt all or part of the work 86 | in a fashion requiring copyright permission, other than the making of an 87 | exact copy. The resulting work is called a "modified version" of the 88 | earlier work or a work "based on" the earlier work. 89 | 90 | A "covered work" means either the unmodified Program or a work based 91 | on the Program. 92 | 93 | To "propagate" a work means to do anything with it that, without 94 | permission, would make you directly or secondarily liable for 95 | infringement under applicable copyright law, except executing it on a 96 | computer or modifying a private copy. Propagation includes copying, 97 | distribution (with or without modification), making available to the 98 | public, and in some countries other activities as well. 99 | 100 | To "convey" a work means any kind of propagation that enables other 101 | parties to make or receive copies. Mere interaction with a user through 102 | a computer network, with no transfer of a copy, is not conveying. 103 | 104 | An interactive user interface displays "Appropriate Legal Notices" 105 | to the extent that it includes a convenient and prominently visible 106 | feature that (1) displays an appropriate copyright notice, and (2) 107 | tells the user that there is no warranty for the work (except to the 108 | extent that warranties are provided), that licensees may convey the 109 | work under this License, and how to view a copy of this License. If 110 | the interface presents a list of user commands or options, such as a 111 | menu, a prominent item in the list meets this criterion. 112 | 113 | 1. Source Code. 114 | 115 | The "source code" for a work means the preferred form of the work 116 | for making modifications to it. "Object code" means any non-source 117 | form of a work. 118 | 119 | A "Standard Interface" means an interface that either is an official 120 | standard defined by a recognized standards body, or, in the case of 121 | interfaces specified for a particular programming language, one that 122 | is widely used among developers working in that language. 123 | 124 | The "System Libraries" of an executable work include anything, other 125 | than the work as a whole, that (a) is included in the normal form of 126 | packaging a Major Component, but which is not part of that Major 127 | Component, and (b) serves only to enable use of the work with that 128 | Major Component, or to implement a Standard Interface for which an 129 | implementation is available to the public in source code form. A 130 | "Major Component", in this context, means a major essential component 131 | (kernel, window system, and so on) of the specific operating system 132 | (if any) on which the executable work runs, or a compiler used to 133 | produce the work, or an object code interpreter used to run it. 134 | 135 | The "Corresponding Source" for a work in object code form means all 136 | the source code needed to generate, install, and (for an executable 137 | work) run the object code and to modify the work, including scripts to 138 | control those activities. However, it does not include the work's 139 | System Libraries, or general-purpose tools or generally available free 140 | programs which are used unmodified in performing those activities but 141 | which are not part of the work. For example, Corresponding Source 142 | includes interface definition files associated with source files for 143 | the work, and the source code for shared libraries and dynamically 144 | linked subprograms that the work is specifically designed to require, 145 | such as by intimate data communication or control flow between those 146 | subprograms and other parts of the work. 147 | 148 | The Corresponding Source need not include anything that users 149 | can regenerate automatically from other parts of the Corresponding 150 | Source. 151 | 152 | The Corresponding Source for a work in source code form is that 153 | same work. 154 | 155 | 2. Basic Permissions. 156 | 157 | All rights granted under this License are granted for the term of 158 | copyright on the Program, and are irrevocable provided the stated 159 | conditions are met. This License explicitly affirms your unlimited 160 | permission to run the unmodified Program. The output from running a 161 | covered work is covered by this License only if the output, given its 162 | content, constitutes a covered work. This License acknowledges your 163 | rights of fair use or other equivalent, as provided by copyright law. 164 | 165 | You may make, run and propagate covered works that you do not 166 | convey, without conditions so long as your license otherwise remains 167 | in force. You may convey covered works to others for the sole purpose 168 | of having them make modifications exclusively for you, or provide you 169 | with facilities for running those works, provided that you comply with 170 | the terms of this License in conveying all material for which you do 171 | not control copyright. Those thus making or running the covered works 172 | for you must do so exclusively on your behalf, under your direction 173 | and control, on terms that prohibit them from making any copies of 174 | your copyrighted material outside their relationship with you. 175 | 176 | Conveying under any other circumstances is permitted solely under 177 | the conditions stated below. Sublicensing is not allowed; section 10 178 | makes it unnecessary. 179 | 180 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 181 | 182 | No covered work shall be deemed part of an effective technological 183 | measure under any applicable law fulfilling obligations under article 184 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 185 | similar laws prohibiting or restricting circumvention of such 186 | measures. 187 | 188 | When you convey a covered work, you waive any legal power to forbid 189 | circumvention of technological measures to the extent such circumvention 190 | is effected by exercising rights under this License with respect to 191 | the covered work, and you disclaim any intention to limit operation or 192 | modification of the work as a means of enforcing, against the work's 193 | users, your or third parties' legal rights to forbid circumvention of 194 | technological measures. 195 | 196 | 4. Conveying Verbatim Copies. 197 | 198 | You may convey verbatim copies of the Program's source code as you 199 | receive it, in any medium, provided that you conspicuously and 200 | appropriately publish on each copy an appropriate copyright notice; 201 | keep intact all notices stating that this License and any 202 | non-permissive terms added in accord with section 7 apply to the code; 203 | keep intact all notices of the absence of any warranty; and give all 204 | recipients a copy of this License along with the Program. 205 | 206 | You may charge any price or no price for each copy that you convey, 207 | and you may offer support or warranty protection for a fee. 208 | 209 | 5. Conveying Modified Source Versions. 210 | 211 | You may convey a work based on the Program, or the modifications to 212 | produce it from the Program, in the form of source code under the 213 | terms of section 4, provided that you also meet all of these conditions: 214 | 215 | a) The work must carry prominent notices stating that you modified 216 | it, and giving a relevant date. 217 | 218 | b) The work must carry prominent notices stating that it is 219 | released under this License and any conditions added under section 220 | 7. This requirement modifies the requirement in section 4 to 221 | "keep intact all notices". 222 | 223 | c) You must license the entire work, as a whole, under this 224 | License to anyone who comes into possession of a copy. This 225 | License will therefore apply, along with any applicable section 7 226 | additional terms, to the whole of the work, and all its parts, 227 | regardless of how they are packaged. This License gives no 228 | permission to license the work in any other way, but it does not 229 | invalidate such permission if you have separately received it. 230 | 231 | d) If the work has interactive user interfaces, each must display 232 | Appropriate Legal Notices; however, if the Program has interactive 233 | interfaces that do not display Appropriate Legal Notices, your 234 | work need not make them do so. 235 | 236 | A compilation of a covered work with other separate and independent 237 | works, which are not by their nature extensions of the covered work, 238 | and which are not combined with it such as to form a larger program, 239 | in or on a volume of a storage or distribution medium, is called an 240 | "aggregate" if the compilation and its resulting copyright are not 241 | used to limit the access or legal rights of the compilation's users 242 | beyond what the individual works permit. Inclusion of a covered work 243 | in an aggregate does not cause this License to apply to the other 244 | parts of the aggregate. 245 | 246 | 6. Conveying Non-Source Forms. 247 | 248 | You may convey a covered work in object code form under the terms 249 | of sections 4 and 5, provided that you also convey the 250 | machine-readable Corresponding Source under the terms of this License, 251 | in one of these ways: 252 | 253 | a) Convey the object code in, or embodied in, a physical product 254 | (including a physical distribution medium), accompanied by the 255 | Corresponding Source fixed on a durable physical medium 256 | customarily used for software interchange. 257 | 258 | b) Convey the object code in, or embodied in, a physical product 259 | (including a physical distribution medium), accompanied by a 260 | written offer, valid for at least three years and valid for as 261 | long as you offer spare parts or customer support for that product 262 | model, to give anyone who possesses the object code either (1) a 263 | copy of the Corresponding Source for all the software in the 264 | product that is covered by this License, on a durable physical 265 | medium customarily used for software interchange, for a price no 266 | more than your reasonable cost of physically performing this 267 | conveying of source, or (2) access to copy the 268 | Corresponding Source from a network server at no charge. 269 | 270 | c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 275 | 276 | d) Convey the object code by offering access from a designated 277 | place (gratis or for a charge), and offer equivalent access to the 278 | Corresponding Source in the same way through the same place at no 279 | further charge. You need not require recipients to copy the 280 | Corresponding Source along with the object code. If the place to 281 | copy the object code is a network server, the Corresponding Source 282 | may be on a different server (operated by you or a third party) 283 | that supports equivalent copying facilities, provided you maintain 284 | clear directions next to the object code saying where to find the 285 | Corresponding Source. Regardless of what server hosts the 286 | Corresponding Source, you remain obligated to ensure that it is 287 | available for as long as needed to satisfy these requirements. 288 | 289 | e) Convey the object code using peer-to-peer transmission, provided 290 | you inform other peers where the object code and Corresponding 291 | Source of the work are being offered to the general public at no 292 | charge under subsection 6d. 293 | 294 | A separable portion of the object code, whose source code is excluded 295 | from the Corresponding Source as a System Library, need not be 296 | included in conveying the object code work. 297 | 298 | A "User Product" is either (1) a "consumer product", which means any 299 | tangible personal property which is normally used for personal, family, 300 | or household purposes, or (2) anything designed or sold for incorporation 301 | into a dwelling. In determining whether a product is a consumer product, 302 | doubtful cases shall be resolved in favor of coverage. For a particular 303 | product received by a particular user, "normally used" refers to a 304 | typical or common use of that class of product, regardless of the status 305 | of the particular user or of the way in which the particular user 306 | actually uses, or expects or is expected to use, the product. A product 307 | is a consumer product regardless of whether the product has substantial 308 | commercial, industrial or non-consumer uses, unless such uses represent 309 | the only significant mode of use of the product. 310 | 311 | "Installation Information" for a User Product means any methods, 312 | procedures, authorization keys, or other information required to install 313 | and execute modified versions of a covered work in that User Product from 314 | a modified version of its Corresponding Source. The information must 315 | suffice to ensure that the continued functioning of the modified object 316 | code is in no case prevented or interfered with solely because 317 | modification has been made. 318 | 319 | If you convey an object code work under this section in, or with, or 320 | specifically for use in, a User Product, and the conveying occurs as 321 | part of a transaction in which the right of possession and use of the 322 | User Product is transferred to the recipient in perpetuity or for a 323 | fixed term (regardless of how the transaction is characterized), the 324 | Corresponding Source conveyed under this section must be accompanied 325 | by the Installation Information. But this requirement does not apply 326 | if neither you nor any third party retains the ability to install 327 | modified object code on the User Product (for example, the work has 328 | been installed in ROM). 329 | 330 | The requirement to provide Installation Information does not include a 331 | requirement to continue to provide support service, warranty, or updates 332 | for a work that has been modified or installed by the recipient, or for 333 | the User Product in which it has been modified or installed. Access to a 334 | network may be denied when the modification itself materially and 335 | adversely affects the operation of the network or violates the rules and 336 | protocols for communication across the network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders of 364 | that material) supplement the terms of this License with terms: 365 | 366 | a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 368 | 369 | b) Requiring preservation of specified reasonable legal notices or 370 | author attributions in that material or in the Appropriate Legal 371 | Notices displayed by works containing it; or 372 | 373 | c) Prohibiting misrepresentation of the origin of that material, or 374 | requiring that modified versions of such material be marked in 375 | reasonable ways as different from the original version; or 376 | 377 | d) Limiting the use for publicity purposes of names of licensors or 378 | authors of the material; or 379 | 380 | e) Declining to grant rights under trademark law for use of some 381 | trade names, trademarks, or service marks; or 382 | 383 | f) Requiring indemnification of licensors and authors of that 384 | material by anyone who conveys the material (or modified versions of 385 | it) with contractual assumptions of liability to the recipient, for 386 | any liability that these contractual assumptions directly impose on 387 | those licensors and authors. 388 | 389 | All other non-permissive additional terms are considered "further 390 | restrictions" within the meaning of section 10. If the Program as you 391 | received it, or any part of it, contains a notice stating that it is 392 | governed by this License along with a term that is a further 393 | restriction, you may remove that term. If a license document contains 394 | a further restriction but permits relicensing or conveying under this 395 | License, you may add to a covered work material governed by the terms 396 | of that license document, provided that the further restriction does 397 | not survive such relicensing or conveying. 398 | 399 | If you add terms to a covered work in accord with this section, you 400 | must place, in the relevant source files, a statement of the 401 | additional terms that apply to those files, or a notice indicating 402 | where to find the applicable terms. 403 | 404 | Additional terms, permissive or non-permissive, may be stated in the 405 | form of a separately written license, or stated as exceptions; 406 | the above requirements apply either way. 407 | 408 | 8. Termination. 409 | 410 | You may not propagate or modify a covered work except as expressly 411 | provided under this License. Any attempt otherwise to propagate or 412 | modify it is void, and will automatically terminate your rights under 413 | this License (including any patent licenses granted under the third 414 | paragraph of section 11). 415 | 416 | However, if you cease all violation of this License, then your 417 | license from a particular copyright holder is reinstated (a) 418 | provisionally, unless and until the copyright holder explicitly and 419 | finally terminates your license, and (b) permanently, if the copyright 420 | holder fails to notify you of the violation by some reasonable means 421 | prior to 60 days after the cessation. 422 | 423 | Moreover, your license from a particular copyright holder is 424 | reinstated permanently if the copyright holder notifies you of the 425 | violation by some reasonable means, this is the first time you have 426 | received notice of violation of this License (for any work) from that 427 | copyright holder, and you cure the violation prior to 30 days after 428 | your receipt of the notice. 429 | 430 | Termination of your rights under this section does not terminate the 431 | licenses of parties who have received copies or rights from you under 432 | this License. If your rights have been terminated and not permanently 433 | reinstated, you do not qualify to receive new licenses for the same 434 | material under section 10. 435 | 436 | 9. Acceptance Not Required for Having Copies. 437 | 438 | You are not required to accept this License in order to receive or 439 | run a copy of the Program. Ancillary propagation of a covered work 440 | occurring solely as a consequence of using peer-to-peer transmission 441 | to receive a copy likewise does not require acceptance. However, 442 | nothing other than this License grants you permission to propagate or 443 | modify any covered work. These actions infringe copyright if you do 444 | not accept this License. Therefore, by modifying or propagating a 445 | covered work, you indicate your acceptance of this License to do so. 446 | 447 | 10. Automatic Licensing of Downstream Recipients. 448 | 449 | Each time you convey a covered work, the recipient automatically 450 | receives a license from the original licensors, to run, modify and 451 | propagate that work, subject to this License. You are not responsible 452 | for enforcing compliance by third parties with this License. 453 | 454 | An "entity transaction" is a transaction transferring control of an 455 | organization, or substantially all assets of one, or subdividing an 456 | organization, or merging organizations. If propagation of a covered 457 | work results from an entity transaction, each party to that 458 | transaction who receives a copy of the work also receives whatever 459 | licenses to the work the party's predecessor in interest had or could 460 | give under the previous paragraph, plus a right to possession of the 461 | Corresponding Source of the work from the predecessor in interest, if 462 | the predecessor has it or can get it with reasonable efforts. 463 | 464 | You may not impose any further restrictions on the exercise of the 465 | rights granted or affirmed under this License. For example, you may 466 | not impose a license fee, royalty, or other charge for exercise of 467 | rights granted under this License, and you may not initiate litigation 468 | (including a cross-claim or counterclaim in a lawsuit) alleging that 469 | any patent claim is infringed by making, using, selling, offering for 470 | sale, or importing the Program or any portion of it. 471 | 472 | 11. Patents. 473 | 474 | A "contributor" is a copyright holder who authorizes use under this 475 | License of the Program or a work on which the Program is based. The 476 | work thus licensed is called the contributor's "contributor version". 477 | 478 | A contributor's "essential patent claims" are all patent claims 479 | owned or controlled by the contributor, whether already acquired or 480 | hereafter acquired, that would be infringed by some manner, permitted 481 | by this License, of making, using, or selling its contributor version, 482 | but do not include claims that would be infringed only as a 483 | consequence of further modification of the contributor version. For 484 | purposes of this definition, "control" includes the right to grant 485 | patent sublicenses in a manner consistent with the requirements of 486 | this License. 487 | 488 | Each contributor grants you a non-exclusive, worldwide, royalty-free 489 | patent license under the contributor's essential patent claims, to 490 | make, use, sell, offer for sale, import and otherwise run, modify and 491 | propagate the contents of its contributor version. 492 | 493 | In the following three paragraphs, a "patent license" is any express 494 | agreement or commitment, however denominated, not to enforce a patent 495 | (such as an express permission to practice a patent or covenant not to 496 | sue for patent infringement). To "grant" such a patent license to a 497 | party means to make such an agreement or commitment not to enforce a 498 | patent against the party. 499 | 500 | If you convey a covered work, knowingly relying on a patent license, 501 | and the Corresponding Source of the work is not available for anyone 502 | to copy, free of charge and under the terms of this License, through a 503 | publicly available network server or other readily accessible means, 504 | then you must either (1) cause the Corresponding Source to be so 505 | available, or (2) arrange to deprive yourself of the benefit of the 506 | patent license for this particular work, or (3) arrange, in a manner 507 | consistent with the requirements of this License, to extend the patent 508 | license to downstream recipients. "Knowingly relying" means you have 509 | actual knowledge that, but for the patent license, your conveying the 510 | covered work in a country, or your recipient's use of the covered work 511 | in a country, would infringe one or more identifiable patents in that 512 | country that you have reason to believe are valid. 513 | 514 | If, pursuant to or in connection with a single transaction or 515 | arrangement, you convey, or propagate by procuring conveyance of, a 516 | covered work, and grant a patent license to some of the parties 517 | receiving the covered work authorizing them to use, propagate, modify 518 | or convey a specific copy of the covered work, then the patent license 519 | you grant is automatically extended to all recipients of the covered 520 | work and works based on it. 521 | 522 | A patent license is "discriminatory" if it does not include within 523 | the scope of its coverage, prohibits the exercise of, or is 524 | conditioned on the non-exercise of one or more of the rights that are 525 | specifically granted under this License. You may not convey a covered 526 | work if you are a party to an arrangement with a third party that is 527 | in the business of distributing software, under which you make payment 528 | to the third party based on the extent of your activity of conveying 529 | the work, and under which the third party grants, to any of the 530 | parties who would receive the covered work from you, a discriminatory 531 | patent license (a) in connection with copies of the covered work 532 | conveyed by you (or copies made from those copies), or (b) primarily 533 | for and in connection with specific products or compilations that 534 | contain the covered work, unless you entered into that arrangement, 535 | or that patent license was granted, prior to 28 March 2007. 536 | 537 | Nothing in this License shall be construed as excluding or limiting 538 | any implied license or other defenses to infringement that may 539 | otherwise be available to you under applicable patent law. 540 | 541 | 12. No Surrender of Others' Freedom. 542 | 543 | If conditions are imposed on you (whether by court order, agreement or 544 | otherwise) that contradict the conditions of this License, they do not 545 | excuse you from the conditions of this License. If you cannot convey a 546 | covered work so as to satisfy simultaneously your obligations under this 547 | License and any other pertinent obligations, then as a consequence you may 548 | not convey it at all. For example, if you agree to terms that obligate you 549 | to collect a royalty for further conveying from those to whom you convey 550 | the Program, the only way you could satisfy both those terms and this 551 | License would be to refrain entirely from conveying the Program. 552 | 553 | 13. Use with the GNU Affero General Public License. 554 | 555 | Notwithstanding any other provision of this License, you have 556 | permission to link or combine any covered work with a work licensed 557 | under version 3 of the GNU Affero General Public License into a single 558 | combined work, and to convey the resulting work. The terms of this 559 | License will continue to apply to the part which is the covered work, 560 | but the special requirements of the GNU Affero General Public License, 561 | section 13, concerning interaction through a network will apply to the 562 | combination as such. 563 | 564 | 14. Revised Versions of this License. 565 | 566 | The Free Software Foundation may publish revised and/or new versions of 567 | the GNU General Public License from time to time. Such new versions will 568 | be similar in spirit to the present version, but may differ in detail to 569 | address new problems or concerns. 570 | 571 | Each version is given a distinguishing version number. If the 572 | Program specifies that a certain numbered version of the GNU General 573 | Public License "or any later version" applies to it, you have the 574 | option of following the terms and conditions either of that numbered 575 | version or of any later version published by the Free Software 576 | Foundation. If the Program does not specify a version number of the 577 | GNU General Public License, you may choose any version ever published 578 | by the Free Software Foundation. 579 | 580 | If the Program specifies that a proxy can decide which future 581 | versions of the GNU General Public License can be used, that proxy's 582 | public statement of acceptance of a version permanently authorizes you 583 | to choose that version for the Program. 584 | 585 | Later license versions may give you additional or different 586 | permissions. However, no additional obligations are imposed on any 587 | author or copyright holder as a result of your choosing to follow a 588 | later version. 589 | 590 | 15. Disclaimer of Warranty. 591 | 592 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 593 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 594 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 595 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 596 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 597 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 598 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 599 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 600 | 601 | 16. Limitation of Liability. 602 | 603 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 604 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 605 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 606 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 607 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 608 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 609 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 610 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 611 | SUCH DAMAGES. 612 | 613 | 17. Interpretation of Sections 15 and 16. 614 | 615 | If the disclaimer of warranty and limitation of liability provided 616 | above cannot be given local legal effect according to their terms, 617 | reviewing courts shall apply local law that most closely approximates 618 | an absolute waiver of all civil liability in connection with the 619 | Program, unless a warranty or assumption of liability accompanies a 620 | copy of the Program in return for a fee. 621 | 622 | END OF TERMS AND CONDITIONS 623 | 624 | How to Apply These Terms to Your New Programs 625 | 626 | If you develop a new program, and you want it to be of the greatest 627 | possible use to the public, the best way to achieve this is to make it 628 | free software which everyone can redistribute and change under these terms. 629 | 630 | To do so, attach the following notices to the program. It is safest 631 | to attach them to the start of each source file to most effectively 632 | state the exclusion of warranty; and each file should have at least 633 | the "copyright" line and a pointer to where the full notice is found. 634 | 635 | 636 | Copyright (C) 637 | 638 | This program is free software: you can redistribute it and/or modify 639 | it under the terms of the GNU General Public License as published by 640 | the Free Software Foundation, either version 3 of the License, or 641 | (at your option) any later version. 642 | 643 | This program is distributed in the hope that it will be useful, 644 | but WITHOUT ANY WARRANTY; without even the implied warranty of 645 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 646 | GNU General Public License for more details. 647 | 648 | You should have received a copy of the GNU General Public License 649 | along with this program. If not, see . 650 | 651 | Also add information on how to contact you by electronic and paper mail. 652 | 653 | If the program does terminal interaction, make it output a short 654 | notice like this when it starts in an interactive mode: 655 | 656 | Copyright (C) 657 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 658 | This is free software, and you are welcome to redistribute it 659 | under certain conditions; type `show c' for details. 660 | 661 | The hypothetical commands `show w' and `show c' should show the appropriate 662 | parts of the General Public License. Of course, your program's commands 663 | might be different; for a GUI interface, you would use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or school, 666 | if any, to sign a "copyright disclaimer" for the program, if necessary. 667 | For more information on this, and how to apply and follow the GNU GPL, see 668 | . 669 | 670 | The GNU General Public License does not permit incorporating your program 671 | into proprietary programs. If your program is a subroutine library, you 672 | may consider it more useful to permit linking proprietary applications with 673 | the library. If this is what you want to do, use the GNU Lesser General 674 | Public License instead of this License. But first, please read 675 | . 676 | 677 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | CROSS_COMPILE ?= arm-none-eabi- 2 | CC = $(CROSS_COMPILE)gcc 3 | OBJCOPY = $(CROSS_COMPILE)objcopy 4 | LIBOPENCM3 ?= ./libopencm3 5 | 6 | APP_ADDRESS = 0x08002000 7 | APP_OFFSET = $(shell echo $$(($(APP_ADDRESS) - 0x08000000))) 8 | 9 | CFLAGS = -Os -std=gnu99 -Wall -pedantic -Werror -Istm32/include \ 10 | -mcpu=cortex-m3 -mthumb -DSTM32F1 \ 11 | -I$(LIBOPENCM3)/include -DAPP_ADDRESS=$(APP_ADDRESS) -ggdb3 12 | 13 | LDFLAGS = -lopencm3_stm32f1 \ 14 | -Wl,-Tstm32f103.ld -nostartfiles -lc -lnosys \ 15 | -mthumb -mcpu=cortex-m3 -L$(LIBOPENCM3)/lib/ -Wl,-gc-sections 16 | 17 | stm32-tx-hid-bootldr-combined.bin: stm32-tx-hid-bootldr.bin stm32-tx-hid.bin 18 | cp stm32-tx-hid-bootldr.bin $@ 19 | dd if=stm32-tx-hid.bin of=$@ seek=1 bs=$(APP_OFFSET) 20 | 21 | stm32-tx-hid.elf: stm32-tx-hid.o | $(LIBOPENCM3)/lib/libopencm3_stm32f1.a 22 | $(CC) $^ -o $@ $(LDFLAGS) -Wl,-Ttext=$(APP_ADDRESS) 23 | 24 | stm32-tx-hid-bootldr.elf: stm32-tx-hid-bootldr.o | $(LIBOPENCM3)/lib/libopencm3_stm32f1.a 25 | $(CC) $^ -o $@ $(LDFLAGS) 26 | 27 | $(LIBOPENCM3)/lib/libopencm3_stm32f1.a: 28 | $(MAKE) -C $(LIBOPENCM3) TARGETS=stm32/f1 29 | 30 | %.bin: %.elf 31 | $(OBJCOPY) -O binary $^ $@ 32 | 33 | clean: 34 | -rm *.elf *.o *.bin 35 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | STM32-Tx-HID 2 | ------------ 3 | 4 | This project aims to bring inexpensive and easy solution to the task 5 | of connecting various RC transmitters to a computer. 6 | 7 | With the wide availability of relatively cheap RC toys a beginner user 8 | might end up with a reasonably decent collective pitch helicopter and 9 | a cheap transmitter as part of an RTF bundle. Learning to control a CP 10 | heli can be a daunting task, so a lot of people prefer to practice 11 | with a computer simulation. However, many transmitters do not support 12 | USB connectivity (and some do not even provide a PPM output). To 13 | connect equipment like that to a computer, additional hardware is 14 | needed. 15 | 16 | This firmware is targetting the cheapest STM32F103 board as found in 17 | numerous listings on eBay and Aliexpress (might have the following 18 | keywords: ARM STM32F103C8T6 Minimum System Development Board Module 19 | For Arduino). 20 | 21 | The board photo is in stm32f103-board.jpg. 22 | 23 | Once the firmware is installed and running, a computer will see a 24 | regular HID joystick with 8 analog channels and 8 buttons. During USB 25 | operation the power switch must be in the off state, the device is 26 | bus-powered. Once you disconnect the board from a computer and power 27 | on the transmitter normally, the board goes to a sleep mode and 28 | doesn't interfere with normal operation. 29 | 30 | * Board description 31 | The board has an STM32F103C8T6 controller (in LQFP48 package), 32 | microusb connector, 8 MHz main quartz and an additional 32768 kHz 33 | quartz for clock. The controller is powered from an LDO outputting 34 | 3.3V from the 5V USB bus. D+ pullup resistor is permanently attached 35 | but software can force USB bus reset by putting the corresponding pin 36 | (PA12) in GPIO push-pull mode and setting it low for at least 37 | 2.5us. It also has a physical reset button and two LEDs: one 38 | permanently on, one controlled by PC13 (active low). 39 | 40 | In addition to that there're 4 pins exposed for SWD (flashing and 41 | debug) and two jumpers (unlabeled). Both jumpers can connect their 42 | middle pin either to the GND ("0" position) or the Vcc ("1" 43 | position). The jumper that is closer to the board side has middle pin 44 | connected to BOOT0 via a 100k series resistor and the other jumper is 45 | connected via a 100k series resistor to BOOT1. 46 | 47 | For reliable board startup both BOOTx pins should be pulled low ("0" 48 | position). 49 | 50 | * Building the firmware 51 | After cloning the repository "git submodule init; git submodule 52 | update" needs to be run once, then "make" to build everything 53 | necessary. 54 | 55 | It is assumed that "arm-none-eabi" toolchain is available in PATH, 56 | "GCC ARM Embedded" is the recommended option. In case you need to 57 | specify a path, CROSS_COMPILE make variable should be set 58 | appropriately. 59 | 60 | * Initial flashing procedure 61 | There're two ways of flashing a blank board: via SWD and via serial 62 | bootloader. For the first method a suitable debug adapter is needed 63 | (e.g. ST-Link or J-Link), for the second one can use just about any 64 | USB-UART bridge (the only requirement that is a bit unusual is to 65 | support "even" parity). 66 | 67 | The image to be flashed is "stm32-tx-hid-bootldr-combined.bin", it 68 | contains both a DFU-compliant bootloader and the main firmware. After 69 | the bootloader is in place, you can reflash via USB without 70 | disassembly and attaching any additional hardware, see the next 71 | section. 72 | 73 | To flash the controller via its serial ROM bootloader the BOOT0 jumper 74 | (the one closer to the board side) should be switched to "1" and 75 | USART1 (PA9/TX, PA10/RX) attached to a computer running stm32flash 76 | software (http://sourceforge.net/projects/stm32flash/, alternatively, 77 | windows users might consider 78 | http://www.st.com/web/en/catalog/tools/PF257525). When flashing the 79 | board for the first time full mass-erase might need to be performed by 80 | using stm32flash's "-k" option ("Disable the flash 81 | read-protection"). Do not forget to switch the jumper back to "0" 82 | after flashing is complete. 83 | 84 | To flash via SWD with ST-Link the following command can be used: 85 | openocd -f interface/stlink-v2.cfg -f target/stm32f1x.cfg \ 86 | -c "init; reset halt; stm32f1x mass_erase 0" \ 87 | -c "program stm32-tx-hid-bootldr-combined.bin 0x08000000 verify reset exit" 88 | 89 | * Reflashing via the DFU bootloader 90 | If the main firmware is functioning normally, dfu-util will be able 91 | to reset the board into the bootloader mode automatically. In case 92 | that doesn't work one can force bootloader mode by pulling both PB8 93 | and PB9 low before attaching USB. 94 | 95 | To update the main board firmware use the following command: 96 | 97 | dfu-util -R -s 0x08002000 -D stm32-tx-hid.bin 98 | 99 | Alternatively, windows users can consider ST's DfuSe utility 100 | (http://www.st.com/web/en/catalog/tools/FM147/CL1794/SC961/SS1533/PF257916). 101 | 102 | * Connecting the board to the transmitter 103 | The firmware assumes the following connections are made: 104 | 105 | 1. PA0-PA7 are used as 8 analog channels; ground the unused ones; 106 | 2. PB8-PB15 are used as 8 discrete inputs, pulled-up internally; 107 | 3. PB0 is pulled low when USB is connected, it might be attached to 108 | the transmitter's microcontroller's nRST line to stop it from 109 | interfering; 110 | 4. GND and 3.3V must be connected to the corresponding transmitter 111 | points. 112 | 113 | * Development and contacts 114 | The development repository is hosted at: 115 | https://github.com/paulfertser/stm32-tx-hid. 116 | 117 | If you have any suggestions or questions, feel free to contact me 118 | directly via email. 119 | 120 | Have fun, and happy flying, 121 | Paul Fertser 122 | -------------------------------------------------------------------------------- /TODO.org: -------------------------------------------------------------------------------- 1 | 1. Rewrite ADC acquisition with DMA 2 | 2. Check systick timings 3 | 3. Check USB suspend with different OSes 4 | 4. What can be done about USB autosuspend releasing nSRST when PC is 5 | still attached 6 | 5. Investigate trimmer buttons on v977 tx 7 | 6. Software debouncing for discrete inputs 8 | 7. Consider adding user-tweakable options 9 | 8. Software filtering ADC inputs 10 | -------------------------------------------------------------------------------- /stm32-tx-hid-bootldr.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2016 Paul Fertser 3 | * Copyright (C) 2010 Gareth McMullin 4 | * 5 | * This program is free software: you can redistribute it and/or 6 | * modify it under the terms of the GNU General Public License as 7 | * published by the Free Software Foundation, either version 3 of the 8 | * License, or (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, but 11 | * WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | * General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see 17 | * . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | 29 | #define FORCE_BOOT (GPIO8 | GPIO9) 30 | 31 | /* Commands sent with wBlockNum == 0 as per ST implementation. */ 32 | #define CMD_SETADDR 0x21 33 | #define CMD_ERASE 0x41 34 | 35 | /* We need a special large control buffer for this device: */ 36 | uint8_t usbd_control_buffer[1024]; 37 | 38 | static enum dfu_state usbdfu_state = STATE_DFU_IDLE; 39 | 40 | static struct { 41 | uint8_t buf[sizeof(usbd_control_buffer)]; 42 | uint16_t len; 43 | uint32_t addr; 44 | uint16_t blocknum; 45 | } prog; 46 | 47 | const struct usb_device_descriptor dev = { 48 | .bLength = USB_DT_DEVICE_SIZE, 49 | .bDescriptorType = USB_DT_DEVICE, 50 | .bcdUSB = 0x0200, 51 | .bDeviceClass = 0, 52 | .bDeviceSubClass = 0, 53 | .bDeviceProtocol = 0, 54 | .bMaxPacketSize0 = 64, 55 | .idVendor = 0x0483, 56 | .idProduct = 0xDF11, 57 | .bcdDevice = 0x0200, 58 | .iManufacturer = 1, 59 | .iProduct = 2, 60 | .iSerialNumber = 3, 61 | .bNumConfigurations = 1, 62 | }; 63 | 64 | const struct usb_dfu_descriptor dfu_function = { 65 | .bLength = sizeof(struct usb_dfu_descriptor), 66 | .bDescriptorType = DFU_FUNCTIONAL, 67 | .bmAttributes = USB_DFU_CAN_DOWNLOAD | USB_DFU_WILL_DETACH, 68 | .wDetachTimeout = 255, 69 | .wTransferSize = 1024, 70 | .bcdDFUVersion = 0x011A, 71 | }; 72 | 73 | const struct usb_interface_descriptor iface = { 74 | .bLength = USB_DT_INTERFACE_SIZE, 75 | .bDescriptorType = USB_DT_INTERFACE, 76 | .bInterfaceNumber = 0, 77 | .bAlternateSetting = 0, 78 | .bNumEndpoints = 0, 79 | .bInterfaceClass = 0xFE, /* Device Firmware Upgrade */ 80 | .bInterfaceSubClass = 1, 81 | .bInterfaceProtocol = 2, 82 | 83 | /* The ST Microelectronics DfuSe application needs this string. 84 | * The format isn't documented... */ 85 | .iInterface = 4, 86 | 87 | .extra = &dfu_function, 88 | .extralen = sizeof(dfu_function), 89 | }; 90 | 91 | const struct usb_interface ifaces[] = {{ 92 | .num_altsetting = 1, 93 | .altsetting = &iface, 94 | }}; 95 | 96 | const struct usb_config_descriptor config = { 97 | .bLength = USB_DT_CONFIGURATION_SIZE, 98 | .bDescriptorType = USB_DT_CONFIGURATION, 99 | .wTotalLength = 0, 100 | .bNumInterfaces = 1, 101 | .bConfigurationValue = 1, 102 | .iConfiguration = 0, 103 | .bmAttributes = 0xC0, 104 | .bMaxPower = 0x32, 105 | 106 | .interface = ifaces, 107 | }; 108 | 109 | static char serial_no[25]; 110 | 111 | static const char *usb_strings[] = { 112 | "libopencm3", 113 | "STM32 Tx HID adapter (DFU)", 114 | serial_no, 115 | /* This string is used by ST Microelectronics' DfuSe utility. */ 116 | "@Internal Flash /0x08000000/8*001Ka,56*001Kg", 117 | }; 118 | 119 | static char *get_dev_unique_id(char *s) 120 | { 121 | volatile uint8_t *unique_id = (volatile uint8_t *)0x1FFFF7E8; 122 | int i; 123 | 124 | /* Fetch serial number from chip's unique ID */ 125 | for(i = 0; i < 24; i+=2) { 126 | s[i] = ((*unique_id >> 4) & 0xF) + '0'; 127 | s[i+1] = (*unique_id++ & 0xF) + '0'; 128 | } 129 | for(i = 0; i < 24; i++) 130 | if(s[i] > '9') 131 | s[i] += 'A' - '9' - 1; 132 | 133 | return s; 134 | } 135 | 136 | static uint8_t usbdfu_getstatus(uint32_t *bwPollTimeout) 137 | { 138 | switch (usbdfu_state) { 139 | case STATE_DFU_DNLOAD_SYNC: 140 | usbdfu_state = STATE_DFU_DNBUSY; 141 | *bwPollTimeout = 100; 142 | return DFU_STATUS_OK; 143 | case STATE_DFU_MANIFEST_SYNC: 144 | /* Device will reset when read is complete. */ 145 | usbdfu_state = STATE_DFU_MANIFEST; 146 | return DFU_STATUS_OK; 147 | default: 148 | return DFU_STATUS_OK; 149 | } 150 | } 151 | 152 | static void usbdfu_getstatus_complete(usbd_device *usbd_dev, struct usb_setup_data *req) 153 | { 154 | int i; 155 | (void)req; 156 | (void)usbd_dev; 157 | 158 | switch (usbdfu_state) { 159 | case STATE_DFU_DNBUSY: 160 | flash_unlock(); 161 | if (prog.blocknum == 0) { 162 | switch (prog.buf[0]) { 163 | case CMD_ERASE: 164 | { 165 | uint32_t *dat = (uint32_t *)(prog.buf + 1); 166 | flash_erase_page(*dat); 167 | } 168 | case CMD_SETADDR: 169 | { 170 | uint32_t *dat = (uint32_t *)(prog.buf + 1); 171 | prog.addr = *dat; 172 | } 173 | } 174 | } else { 175 | uint32_t baseaddr = prog.addr + ((prog.blocknum - 2) * 176 | dfu_function.wTransferSize); 177 | for (i = 0; i < prog.len; i += 2) { 178 | uint16_t *dat = (uint16_t *)(prog.buf + i); 179 | flash_program_half_word(baseaddr + i, 180 | *dat); 181 | } 182 | } 183 | flash_lock(); 184 | 185 | /* Jump straight to dfuDNLOAD-IDLE, skipping dfuDNLOAD-SYNC. */ 186 | usbdfu_state = STATE_DFU_DNLOAD_IDLE; 187 | return; 188 | case STATE_DFU_MANIFEST: 189 | return; /* Count on main loop to reset the board */ 190 | default: 191 | return; 192 | } 193 | } 194 | 195 | static int usbdfu_control_request(usbd_device *usbd_dev, struct usb_setup_data *req, uint8_t **buf, 196 | uint16_t *len, void (**complete)(usbd_device *usbd_dev, struct usb_setup_data *req)) 197 | { 198 | (void)usbd_dev; 199 | 200 | if ((req->bmRequestType & 0x7F) != 0x21) 201 | return USBD_REQ_NEXT_CALLBACK; /* Only accept class request. */ 202 | 203 | switch (req->bRequest) { 204 | case DFU_DNLOAD: 205 | if ((len == NULL) || (*len == 0)) { 206 | usbdfu_state = STATE_DFU_MANIFEST_SYNC; 207 | return USBD_REQ_HANDLED; 208 | } else { 209 | /* Copy download data for use on GET_STATUS. */ 210 | prog.blocknum = req->wValue; 211 | prog.len = *len; 212 | memcpy(prog.buf, *buf, *len); 213 | usbdfu_state = STATE_DFU_DNLOAD_SYNC; 214 | return USBD_REQ_HANDLED; 215 | } 216 | case DFU_CLRSTATUS: 217 | /* Clear error and return to dfuIDLE. */ 218 | if (usbdfu_state == STATE_DFU_ERROR) 219 | usbdfu_state = STATE_DFU_IDLE; 220 | return USBD_REQ_HANDLED; 221 | case DFU_ABORT: 222 | /* Abort returns to dfuIDLE state. */ 223 | usbdfu_state = STATE_DFU_IDLE; 224 | return USBD_REQ_HANDLED; 225 | case DFU_DETACH: 226 | usbdfu_state = STATE_DFU_MANIFEST; 227 | return USBD_REQ_HANDLED; 228 | case DFU_UPLOAD: 229 | /* Upload not supported for now. */ 230 | return USBD_REQ_NOTSUPP; 231 | case DFU_GETSTATUS: { 232 | uint32_t bwPollTimeout = 0; /* 24-bit integer in DFU class spec */ 233 | (*buf)[0] = usbdfu_getstatus(&bwPollTimeout); 234 | (*buf)[1] = bwPollTimeout & 0xFF; 235 | (*buf)[2] = (bwPollTimeout >> 8) & 0xFF; 236 | (*buf)[3] = (bwPollTimeout >> 16) & 0xFF; 237 | (*buf)[4] = usbdfu_state; 238 | (*buf)[5] = 0; /* iString not used here */ 239 | *len = 6; 240 | *complete = usbdfu_getstatus_complete; 241 | return USBD_REQ_HANDLED; 242 | } 243 | case DFU_GETSTATE: 244 | /* Return state with no state transision. */ 245 | *buf[0] = usbdfu_state; 246 | *len = 1; 247 | return USBD_REQ_HANDLED; 248 | } 249 | 250 | return USBD_REQ_NEXT_CALLBACK; 251 | } 252 | 253 | static void usbdfu_set_config(usbd_device *usbd_dev, uint16_t wValue) 254 | { 255 | (void)wValue; 256 | 257 | usbd_register_control_callback( 258 | usbd_dev, 259 | USB_REQ_TYPE_CLASS | USB_REQ_TYPE_INTERFACE, 260 | USB_REQ_TYPE_TYPE | USB_REQ_TYPE_RECIPIENT, 261 | usbdfu_control_request); 262 | } 263 | 264 | int main(void) 265 | { 266 | rcc_clock_setup_in_hse_8mhz_out_72mhz(); 267 | 268 | rcc_periph_clock_enable(RCC_GPIOB); 269 | gpio_set_mode(GPIOB, GPIO_MODE_INPUT, 270 | GPIO_CNF_INPUT_PULL_UPDOWN, FORCE_BOOT); 271 | gpio_set(GPIOB, FORCE_BOOT); 272 | /* Boot the application if it's valid, we're not forced to 273 | * enter DFU by discrete inputs and we haven't just rebooted 274 | * from the app firmware */ 275 | if ((*(volatile uint32_t *)APP_ADDRESS & 0x2FFE0000) == 0x20000000 && 276 | gpio_get(GPIOB, FORCE_BOOT) && 277 | !(RCC_APB2ENR & RCC_APB2ENR_ADC1EN)) { 278 | /* Set vector table base address. */ 279 | SCB_VTOR = APP_ADDRESS & 0xFFFF; 280 | /* Initialise master stack pointer. */ 281 | asm volatile("msr msp, %0"::"g" 282 | (*(volatile uint32_t *)APP_ADDRESS)); 283 | /* Jump to application. */ 284 | (*(void (**)())(APP_ADDRESS + 4))(); 285 | } 286 | 287 | /* Disable USB peripheral as it overrides GPIO settings */ 288 | *USB_CNTR_REG = USB_CNTR_PWDN; 289 | /* 290 | * Vile hack to reenumerate, physically _drag_ d+ low. 291 | * (need at least 2.5us to trigger usb disconnect) 292 | */ 293 | rcc_periph_clock_enable(RCC_GPIOA); 294 | gpio_set_mode(GPIOA, GPIO_MODE_OUTPUT_2_MHZ, 295 | GPIO_CNF_OUTPUT_PUSHPULL, GPIO12); 296 | gpio_clear(GPIOA, GPIO12); 297 | for (unsigned int i = 0; i < 800000; i++) 298 | __asm__("nop"); 299 | 300 | get_dev_unique_id(serial_no); 301 | 302 | usbd_device *usbd_dev; 303 | usbd_dev = usbd_init(&st_usbfs_v1_usb_driver, &dev, &config, 304 | usb_strings, 4, 305 | usbd_control_buffer, sizeof(usbd_control_buffer)); 306 | usbd_register_set_config_callback(usbd_dev, usbdfu_set_config); 307 | 308 | while (1) { 309 | usbd_poll(usbd_dev); 310 | if (usbdfu_state == STATE_DFU_MANIFEST) { 311 | /* USB device must detach, we just reset... */ 312 | scb_reset_system(); 313 | } 314 | } 315 | } 316 | -------------------------------------------------------------------------------- /stm32-tx-hid.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2016 Paul Fertser 3 | * Copyright (C) 2010 Gareth McMullin 4 | * 5 | * This program is free software: you can redistribute it and/or 6 | * modify it under the terms of the GNU General Public License as 7 | * published by the Free Software Foundation, either version 3 of the 8 | * License, or (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, but 11 | * WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | * General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see 17 | * . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | #include 30 | #include 31 | #include 32 | #include 33 | 34 | #define BUTTONS_PINS 0xff00 35 | #define BUTTONS_SHIFT 8 36 | 37 | #define NSRST_PIN GPIO0 38 | 39 | /* We need a special large control buffer for this device: */ 40 | uint8_t usbd_control_buffer[5*64]; 41 | 42 | #include 43 | #include 44 | 45 | static usbd_device *usbd_dev; 46 | 47 | const struct usb_device_descriptor dev_descr = { 48 | .bLength = USB_DT_DEVICE_SIZE, 49 | .bDescriptorType = USB_DT_DEVICE, 50 | .bcdUSB = 0x0200, 51 | .bDeviceClass = 0, 52 | .bDeviceSubClass = 0, 53 | .bDeviceProtocol = 0, 54 | .bMaxPacketSize0 = 64, 55 | .idVendor = 0x0483, 56 | .idProduct = 0x5710, 57 | .bcdDevice = 0x0200, 58 | .iManufacturer = 1, 59 | .iProduct = 2, 60 | .iSerialNumber = 3, 61 | .bNumConfigurations = 1, 62 | }; 63 | 64 | static const uint8_t hid_report_descriptor[] = { 65 | 0x05, 0x01, // USAGE_PAGE (Generic Desktop) 66 | 0x09, 0x04, // USAGE (Joystick) 67 | 68 | 0xa1, 0x01, // COLLECTION (Application) 69 | 0xa1, 0x00, // COLLECTION (Physical) 70 | 71 | 0x05, 0x09, // USAGE_PAGE (Button) 72 | 0x19, 0x01, // USAGE_MINIMUM (Button 1) 73 | 0x29, 0x08, // USAGE_MAXIMUM (Button 8) 74 | 0x15, 0x00, // LOGICAL_MINIMUM (0) 75 | 0x25, 0x01, // LOGICAL_MAXIMUM (1) 76 | 0x95, 0x08, // REPORT_COUNT (8) 77 | 0x75, 0x01, // REPORT_SIZE (1) 78 | 0x81, 0x02, // INPUT (Data,Var,Abs) 79 | 80 | 0x05, 0x01, // USAGE_PAGE (Generic Desktop) 81 | 0x15, 0x00, // LOGICAL_MINIMUM (0) 82 | 0x26, 0xff, 0x0f, // LOGICAL_MAXIMUM 83 | 0x75, 0x10, // REPORT_SIZE 84 | 85 | 0x09, 0x30, // USAGE (X) 86 | 0x09, 0x31, // USAGE (Y) 87 | 0x09, 0x32, // USAGE (Z) 88 | 0x09, 0x33, // USAGE (Rx) 89 | 0x09, 0x34, // USAGE (Ry) 90 | 0x09, 0x35, // USAGE (Rz) 91 | 0x09, 0x36, // USAGE (Throttle) 92 | 0x09, 0x37, // USAGE (Rudder) 93 | 0x95, 0x08, // REPORT_COUNT 94 | 0x81, 0x82, // INPUT (Data,Var,Abs,Vol) 95 | 96 | 0xc0, // END_COLLECTION 97 | 0xc0 // END_COLLECTION 98 | }; 99 | 100 | static const struct { 101 | struct usb_hid_descriptor hid_descriptor; 102 | struct { 103 | uint8_t bReportDescriptorType; 104 | uint16_t wDescriptorLength; 105 | } __attribute__((packed)) hid_report; 106 | } __attribute__((packed)) hid_function = { 107 | .hid_descriptor = { 108 | .bLength = sizeof(hid_function), 109 | .bDescriptorType = USB_DT_HID, 110 | .bcdHID = 0x0100, 111 | .bCountryCode = 0, 112 | .bNumDescriptors = 1, 113 | }, 114 | .hid_report = { 115 | .bReportDescriptorType = USB_DT_REPORT, 116 | .wDescriptorLength = sizeof(hid_report_descriptor), 117 | } 118 | }; 119 | 120 | const struct usb_endpoint_descriptor hid_endpoint = { 121 | .bLength = USB_DT_ENDPOINT_SIZE, 122 | .bDescriptorType = USB_DT_ENDPOINT, 123 | .bEndpointAddress = 0x81, 124 | .bmAttributes = USB_ENDPOINT_ATTR_INTERRUPT, 125 | .wMaxPacketSize = 17, 126 | .bInterval = 0x02, 127 | }; 128 | 129 | const struct usb_interface_descriptor hid_iface = { 130 | .bLength = USB_DT_INTERFACE_SIZE, 131 | .bDescriptorType = USB_DT_INTERFACE, 132 | .bInterfaceNumber = 0, 133 | .bAlternateSetting = 0, 134 | .bNumEndpoints = 1, 135 | .bInterfaceClass = USB_CLASS_HID, 136 | .bInterfaceSubClass = 0, /* boot */ 137 | .bInterfaceProtocol = 0, /* mouse */ 138 | .iInterface = 0, 139 | 140 | .endpoint = &hid_endpoint, 141 | 142 | .extra = &hid_function, 143 | .extralen = sizeof(hid_function), 144 | }; 145 | 146 | const struct usb_dfu_descriptor dfu_function = { 147 | .bLength = sizeof(struct usb_dfu_descriptor), 148 | .bDescriptorType = DFU_FUNCTIONAL, 149 | .bmAttributes = USB_DFU_CAN_DOWNLOAD | USB_DFU_WILL_DETACH, 150 | .wDetachTimeout = 255, 151 | .wTransferSize = 1024, 152 | .bcdDFUVersion = 0x011A, 153 | }; 154 | 155 | const struct usb_interface_descriptor dfu_iface = { 156 | .bLength = USB_DT_INTERFACE_SIZE, 157 | .bDescriptorType = USB_DT_INTERFACE, 158 | .bInterfaceNumber = 1, 159 | .bAlternateSetting = 0, 160 | .bNumEndpoints = 0, 161 | .bInterfaceClass = 0xFE, 162 | .bInterfaceSubClass = 1, 163 | .bInterfaceProtocol = 1, 164 | /* The ST Microelectronics DfuSe application needs this string. 165 | * The format isn't documented... */ 166 | .iInterface = 4, 167 | 168 | .extra = &dfu_function, 169 | .extralen = sizeof(dfu_function), 170 | }; 171 | 172 | const struct usb_interface ifaces[] = {{ 173 | .num_altsetting = 1, 174 | .altsetting = &hid_iface, 175 | }, { 176 | .num_altsetting = 1, 177 | .altsetting = &dfu_iface, 178 | }}; 179 | 180 | const struct usb_config_descriptor config = { 181 | .bLength = USB_DT_CONFIGURATION_SIZE, 182 | .bDescriptorType = USB_DT_CONFIGURATION, 183 | .wTotalLength = 0, 184 | .bNumInterfaces = 2, 185 | .bConfigurationValue = 1, 186 | .iConfiguration = 0, 187 | .bmAttributes = 0xC0, 188 | .bMaxPower = 0x32, 189 | 190 | .interface = ifaces, 191 | }; 192 | 193 | static int hid_control_request(usbd_device *dev, struct usb_setup_data *req, uint8_t **buf, uint16_t *len, 194 | void (**complete)(usbd_device *dev, struct usb_setup_data *req)) 195 | { 196 | (void)complete; 197 | (void)dev; 198 | 199 | if((req->bmRequestType != 0x81) || 200 | (req->bRequest != USB_REQ_GET_DESCRIPTOR) || 201 | (req->wValue != 0x2200)) 202 | return 0; 203 | 204 | /* Handle the HID report descriptor. */ 205 | *buf = (uint8_t *)hid_report_descriptor; 206 | *len = sizeof(hid_report_descriptor); 207 | 208 | return 1; 209 | } 210 | 211 | static void dfu_detach_complete(usbd_device *dev, struct usb_setup_data *req) 212 | { 213 | (void)req; 214 | (void)dev; 215 | 216 | scb_reset_core(); 217 | } 218 | 219 | static int dfu_control_request(usbd_device *dev, struct usb_setup_data *req, uint8_t **buf, uint16_t *len, 220 | void (**complete)(usbd_device *dev, struct usb_setup_data *req)) 221 | { 222 | (void)buf; 223 | (void)len; 224 | (void)dev; 225 | 226 | if ((req->bmRequestType != 0x21) || (req->bRequest != DFU_DETACH)) 227 | return 0; /* Only accept class request. */ 228 | 229 | *complete = dfu_detach_complete; 230 | 231 | return 1; 232 | } 233 | 234 | static void hid_set_config(usbd_device *dev, uint16_t wValue) 235 | { 236 | (void)wValue; 237 | 238 | usbd_ep_setup(dev, 0x81, USB_ENDPOINT_ATTR_INTERRUPT, 4, NULL); 239 | 240 | usbd_register_control_callback( 241 | dev, 242 | USB_REQ_TYPE_STANDARD | USB_REQ_TYPE_INTERFACE, 243 | USB_REQ_TYPE_TYPE | USB_REQ_TYPE_RECIPIENT, 244 | hid_control_request); 245 | usbd_register_control_callback( 246 | dev, 247 | USB_REQ_TYPE_CLASS | USB_REQ_TYPE_INTERFACE, 248 | USB_REQ_TYPE_TYPE | USB_REQ_TYPE_RECIPIENT, 249 | dfu_control_request); 250 | 251 | systick_set_clocksource(STK_CSR_CLKSOURCE_AHB_DIV8); 252 | /* SysTick interrupt every N clock pulses: set reload to N-1 */ 253 | systick_set_reload(99999); 254 | systick_interrupt_enable(); 255 | systick_counter_enable(); 256 | } 257 | 258 | void sys_tick_handler(void) 259 | { 260 | static uint8_t buf[1 + 16]; 261 | static uint8_t channels[] = { 0, 1, 2, 3, 4, 5, 6, 7 }; 262 | 263 | for (unsigned int i = 0; i < 8; i++) { 264 | uint8_t channel_array[] = { channels[i] }; 265 | adc_set_regular_sequence(ADC1, 1, channel_array); 266 | adc_start_conversion_direct(ADC1); 267 | /* Wait for end of conversion. */ 268 | while (!(adc_eoc(ADC1))) 269 | ; 270 | 271 | uint16_t res = adc_read_regular(ADC1); 272 | buf[1 + i * 2] = res & 0xff; 273 | buf[1 + i * 2 + 1] = res >> 8; 274 | } 275 | 276 | buf[0] = ~(gpio_get(GPIOB, BUTTONS_PINS) >> BUTTONS_SHIFT); 277 | usbd_ep_write_packet(usbd_dev, 0x81, buf, sizeof(buf)); 278 | } 279 | 280 | static char serial_no[25]; 281 | 282 | static const char *usb_strings[] = { 283 | "libopencm3", 284 | "STM32 Tx HID adapter", 285 | serial_no, 286 | /* This string is used by ST Microelectronics' DfuSe utility. */ 287 | "@Internal Flash /0x08000000/8*001Ka,56*001Kg", 288 | }; 289 | 290 | static char *get_dev_unique_id(char *s) 291 | { 292 | volatile uint8_t *unique_id = (volatile uint8_t *)0x1FFFF7E8; 293 | int i; 294 | 295 | /* Fetch serial number from chip's unique ID */ 296 | for(i = 0; i < 24; i+=2) { 297 | s[i] = ((*unique_id >> 4) & 0xF) + '0'; 298 | s[i+1] = (*unique_id++ & 0xF) + '0'; 299 | } 300 | for(i = 0; i < 24; i++) 301 | if(s[i] > '9') 302 | s[i] += 'A' - '9' - 1; 303 | 304 | return s; 305 | } 306 | 307 | static void gpio_setup(void) 308 | { 309 | /* Button inputs */ 310 | rcc_periph_clock_enable(RCC_GPIOB); 311 | gpio_set_mode(GPIOB, GPIO_MODE_INPUT, 312 | GPIO_CNF_INPUT_PULL_UPDOWN, BUTTONS_PINS); 313 | gpio_set(GPIOB, BUTTONS_PINS); 314 | 315 | /* Pull down for nSRST */ 316 | gpio_set_mode(GPIOB, GPIO_MODE_OUTPUT_2_MHZ, 317 | GPIO_CNF_OUTPUT_PUSHPULL, NSRST_PIN); 318 | gpio_clear(GPIOB, NSRST_PIN); 319 | } 320 | 321 | static void adc_setup(void) 322 | { 323 | gpio_set_mode(GPIOA, GPIO_MODE_INPUT, GPIO_CNF_INPUT_ANALOG, 0xff); 324 | 325 | rcc_periph_clock_enable(RCC_ADC1); 326 | 327 | /* Make sure the ADC doesn't run during config. */ 328 | adc_off(ADC1); 329 | 330 | /* We configure everything for one single conversion. */ 331 | adc_disable_scan_mode(ADC1); 332 | adc_set_single_conversion_mode(ADC1); 333 | adc_disable_external_trigger_regular(ADC1); 334 | adc_set_right_aligned(ADC1); 335 | adc_set_sample_time_on_all_channels(ADC1, ADC_SMPR_SMP_28DOT5CYC); 336 | 337 | adc_power_on(ADC1); 338 | 339 | /* Wait for ADC starting up. */ 340 | for (unsigned int i = 0; i < 800000; i++) /* Wait a bit. */ 341 | __asm__("nop"); 342 | 343 | adc_reset_calibration(ADC1); 344 | adc_calibration(ADC1); 345 | } 346 | 347 | static void usb_suspend_callback(void) 348 | { 349 | gpio_set(GPIOB, NSRST_PIN); 350 | *USB_CNTR_REG |= USB_CNTR_FSUSP; 351 | *USB_CNTR_REG |= USB_CNTR_LP_MODE; 352 | SCB_SCR |= SCB_SCR_SLEEPDEEP; 353 | __WFI(); 354 | } 355 | 356 | void usb_wakeup_isr(void) 357 | { 358 | exti_reset_request(EXTI18); 359 | rcc_clock_setup_in_hse_8mhz_out_72mhz(); 360 | *USB_CNTR_REG &= ~USB_CNTR_FSUSP; 361 | gpio_clear(GPIOB, NSRST_PIN); 362 | } 363 | 364 | int main(void) 365 | { 366 | rcc_clock_setup_in_hse_8mhz_out_72mhz(); 367 | 368 | rcc_periph_clock_enable(RCC_GPIOA); 369 | 370 | exti_set_trigger(EXTI18, EXTI_TRIGGER_RISING); 371 | exti_enable_request(EXTI18); 372 | nvic_enable_irq(NVIC_USB_WAKEUP_IRQ); 373 | 374 | adc_setup(); 375 | gpio_setup(); 376 | 377 | /* 378 | * Vile hack to reenumerate, physically _drag_ d+ low. 379 | * (need at least 2.5us to trigger usb disconnect) 380 | */ 381 | gpio_set_mode(GPIOA, GPIO_MODE_OUTPUT_2_MHZ, 382 | GPIO_CNF_OUTPUT_PUSHPULL, GPIO12); 383 | gpio_clear(GPIOA, GPIO12); 384 | for (unsigned int i = 0; i < 800000; i++) 385 | __asm__("nop"); 386 | 387 | get_dev_unique_id(serial_no); 388 | 389 | usbd_dev = usbd_init(&st_usbfs_v1_usb_driver, &dev_descr, &config, 390 | usb_strings, 4, 391 | usbd_control_buffer, sizeof(usbd_control_buffer)); 392 | usbd_register_set_config_callback(usbd_dev, hid_set_config); 393 | usbd_register_suspend_callback(usbd_dev, usb_suspend_callback); 394 | 395 | while (1) 396 | usbd_poll(usbd_dev); 397 | } 398 | -------------------------------------------------------------------------------- /stm32f103-board.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/paulfertser/stm32-tx-hid/00b0736126ca1320e641283313ccfb6a873006ef/stm32f103-board.jpg -------------------------------------------------------------------------------- /stm32f103.ld: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of the libopenstm32 project. 3 | * 4 | * Copyright (C) 2010 Thomas Otto 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | 20 | /* Define memory regions. */ 21 | MEMORY 22 | { 23 | rom (rx) : ORIGIN = 0x08000000, LENGTH = 64K 24 | ram (rwx) : ORIGIN = 0x20000000, LENGTH = 20K 25 | } 26 | 27 | /* Include the common ld script from libopenstm32. */ 28 | INCLUDE libopencm3_stm32f1.ld 29 | --------------------------------------------------------------------------------