aboutsummaryrefslogtreecommitdiff
path: root/fw
diff options
context:
space:
mode:
authorjaseg <git@jaseg.net>2018-01-05 12:23:24 +0100
committerjaseg <git@jaseg.net>2018-01-05 12:23:24 +0100
commitc2e293d976f37784a22f552ce1562dcb3bc8345a (patch)
treea9f54d95580da67f7bdf7448cf90efd872ece292 /fw
parente3094b18d4fc1b5f8e5e7ca146318e501a7a4ff9 (diff)
download7seg-c2e293d976f37784a22f552ce1562dcb3bc8345a.tar.gz
7seg-c2e293d976f37784a22f552ce1562dcb3bc8345a.tar.bz2
7seg-c2e293d976f37784a22f552ce1562dcb3bc8345a.zip
Split project into individual source files and add license
Diffstat (limited to 'fw')
-rw-r--r--fw/LICENSE674
-rw-r--r--fw/Makefile18
-rw-r--r--fw/adc.c95
-rw-r--r--fw/adc.h30
-rw-r--r--fw/display.c279
-rw-r--r--fw/display.h34
-rw-r--r--fw/global.h48
-rw-r--r--fw/led.c70
-rw-r--r--fw/led.h29
-rw-r--r--fw/main.c681
-rw-r--r--fw/serial.c255
-rw-r--r--fw/serial.h64
12 files changed, 1620 insertions, 657 deletions
diff --git a/fw/LICENSE b/fw/LICENSE
new file mode 100644
index 0000000..94a9ed0
--- /dev/null
+++ b/fw/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ 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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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 <http://www.gnu.org/licenses/>.
+
+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:
+
+ <program> Copyright (C) <year> <name of author>
+ 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
+<http://www.gnu.org/licenses/>.
+
+ 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
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/fw/Makefile b/fw/Makefile
index 70f1132..6bd74c5 100644
--- a/fw/Makefile
+++ b/fw/Makefile
@@ -1,3 +1,19 @@
+# Megumin LED display firmware
+# Copyright (C) 2018 Sebastian Götte <code@jaseg.net>
+#
+# 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 <http://www.gnu.org/licenses/>.
+
CUBE_PATH ?= $(wildcard ~)/resource/STM32CubeF0
CMSIS_PATH ?= $(CUBE_PATH)/Drivers/CMSIS
CMSIS_DEV_PATH ?= $(CMSIS_PATH)/Device/ST/STM32F0xx
@@ -61,7 +77,7 @@ sources.c: sources.tar.xz.zip
xxd -i $< | head -n -1 | sed 's/=/__attribute__((section(".source_tarball"))) =/' > $@
# FIXME re-add sources.o
-main.elf: main.o startup_stm32f030x6.o system_stm32f0xx.o $(HAL_PATH)/Src/stm32f0xx_ll_utils.o base.o cmsis_exports.o transpose.o mac.o
+main.elf: main.o startup_stm32f030x6.o system_stm32f0xx.o $(HAL_PATH)/Src/stm32f0xx_ll_utils.o base.o cmsis_exports.o transpose.o mac.o adc.o serial.o display.o led.o
$(CC) $(CFLAGS) $(LDFLAGS) -o $@ $^ $(LIBS)
$(OBJCOPY) -O ihex $@ $(@:.elf=.hex)
$(OBJCOPY) -O binary $@ $(@:.elf=.bin)
diff --git a/fw/adc.c b/fw/adc.c
new file mode 100644
index 0000000..85b7b4f
--- /dev/null
+++ b/fw/adc.c
@@ -0,0 +1,95 @@
+/* Megumin LED display firmware
+ * Copyright (C) 2018 Sebastian Götte <code@jaseg.net>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#include "adc.h"
+
+volatile int16_t adc_vcc_mv = 0;
+volatile int16_t adc_temp_celsius = 0;
+
+static volatile uint16_t adc_buf[2];
+
+void adc_init(void) {
+ /* The ADC is used for temperature measurement. To compute the temperature from an ADC reading of the internal
+ * temperature sensor, the supply voltage must also be measured. Thus we are using two channels.
+ *
+ * The ADC is triggered by compare channel 4 of timer 1. The trigger is set to falling edge to trigger on compare
+ * match, not overflow.
+ */
+ ADC1->CFGR1 = ADC_CFGR1_DMAEN | ADC_CFGR1_DMACFG | (2<<ADC_CFGR1_EXTEN_Pos) | (1<<ADC_CFGR1_EXTSEL_Pos);
+ /* Clock from PCLK/4 instead of the internal exclusive high-speed RC oscillator. */
+ ADC1->CFGR2 = (2<<ADC_CFGR2_CKMODE_Pos);
+ /* Use the slowest available sample rate */
+ ADC1->SMPR = (7<<ADC_SMPR_SMP_Pos);
+ /* Internal VCC and temperature sensor channels */
+ ADC1->CHSELR = ADC_CHSELR_CHSEL16 | ADC_CHSELR_CHSEL17;
+ /* Enable internal voltage reference and temperature sensor */
+ ADC->CCR = ADC_CCR_TSEN | ADC_CCR_VREFEN;
+ /* Perform ADC calibration */
+ ADC1->CR |= ADC_CR_ADCAL;
+ while (ADC1->CR & ADC_CR_ADCAL)
+ ;
+ /* Enable ADC */
+ ADC1->CR |= ADC_CR_ADEN;
+ ADC1->CR |= ADC_CR_ADSTART;
+
+ /* Configure DMA 1 Channel 1 to get rid of all the data */
+ DMA1_Channel1->CPAR = (unsigned int)&ADC1->DR;
+ DMA1_Channel1->CMAR = (unsigned int)&adc_buf;
+ DMA1_Channel1->CNDTR = sizeof(adc_buf)/sizeof(adc_buf[0]);
+ DMA1_Channel1->CCR = (0<<DMA_CCR_PL_Pos);
+ DMA1_Channel1->CCR |=
+ DMA_CCR_CIRC /* circular mode so we can leave it running indefinitely */
+ | (1<<DMA_CCR_MSIZE_Pos) /* 16 bit */
+ | (1<<DMA_CCR_PSIZE_Pos) /* 16 bit */
+ | DMA_CCR_MINC
+ | DMA_CCR_TCIE; /* Enable transfer complete interrupt. */
+ DMA1_Channel1->CCR |= DMA_CCR_EN; /* Enable channel */
+
+ /* triggered on transfer completion. We use this to process the ADC data */
+ NVIC_EnableIRQ(DMA1_Channel1_IRQn);
+ NVIC_SetPriority(DMA1_Channel1_IRQn, 3);
+}
+
+void DMA1_Channel1_IRQHandler(void) {
+ /* This interrupt takes either 1.2us or 13us. It can be pre-empted by the more timing-critical UART and LED timer
+ * interrupts. */
+ static int count = 0; /* oversampling accumulator sample count */
+ static uint32_t adc_aggregate[2] = {0, 0}; /* oversampling accumulator */
+
+ /* Clear the interrupt flag */
+ DMA1->IFCR |= DMA_IFCR_CGIF1;
+
+ adc_aggregate[0] += adc_buf[0];
+ adc_aggregate[1] += adc_buf[1];
+
+ if (++count == (1<<ADC_OVERSAMPLING)) {
+ /* This has been copied from the code examples to section 12.9 ADC>"Temperature sensor and internal reference
+ * voltage" in the reference manual with the extension that we actually measure the supply voltage instead of
+ * hardcoding it. This is not strictly necessary since we're running off a bored little LDO but it's free and
+ * the current supply voltage is a nice health value.
+ */
+ adc_vcc_mv = (3300 * VREFINT_CAL)/(adc_aggregate[0]>>ADC_OVERSAMPLING);
+ int32_t temperature = (((uint32_t)TS_CAL1) - ((adc_aggregate[1]>>ADC_OVERSAMPLING) * adc_vcc_mv / 3300)) * 1000;
+ temperature = (temperature/5336) + 30;
+ adc_temp_celsius = temperature;
+
+ count = 0;
+ adc_aggregate[0] = 0;
+ adc_aggregate[1] = 0;
+ }
+}
+
diff --git a/fw/adc.h b/fw/adc.h
new file mode 100644
index 0000000..57a2ce9
--- /dev/null
+++ b/fw/adc.h
@@ -0,0 +1,30 @@
+/* Megumin LED display firmware
+ * Copyright (C) 2018 Sebastian Götte <code@jaseg.net>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __ADC_H__
+#define __ADC_H__
+
+#include "global.h"
+
+#define ADC_OVERSAMPLING 8
+
+extern volatile int16_t adc_vcc_mv;
+extern volatile int16_t adc_temp_celsius;
+
+void adc_init(void);
+
+#endif/*__ADC_H__*/
diff --git a/fw/display.c b/fw/display.c
new file mode 100644
index 0000000..7c1b5a6
--- /dev/null
+++ b/fw/display.c
@@ -0,0 +1,279 @@
+/* Megumin LED display firmware
+ * Copyright (C) 2018 Sebastian Götte <code@jaseg.net>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#include "led.h"
+#include "display.h"
+
+volatile int frame_duration_us = 0;
+volatile int nbits = MAX_BITS;
+
+/* Modulation data */
+volatile enum FB_OPERATION fb_op;
+static volatile struct framebuf fb[2] = {0};
+volatile struct framebuf *read_fb=fb+0, *write_fb=fb+1;
+
+/* Auxiliary shift register values */
+#define LED_COMM 0x0001
+#define LED_ERROR 0x0002
+#define LED_ID 0x0004
+#define SR_ILED_HIGH 0x0080
+#define SR_ILED_LOW 0x0040
+
+/* This is a lookup table mapping segments to present a standard segment order on the UART interface. This is converted
+ * into an internal representation once on startup in main(). The data type must be at least uint16. */
+static uint32_t segment_map[8] = {5, 7, 6, 4, 1, 3, 0, 2};
+
+static unsigned int active_bit = 0;
+static int active_segment = 0;
+
+/* Bit timing base value. This is the lowes bit interval used in TIM1/TIM3 timer counts. */
+#define PERIOD_BASE 4
+
+/* This value is a constant offset added to every bit period to allow for the timer IRQ handler to execute. This is set
+ * empirically using a debugger and a logic analyzer.
+ *
+ * This value is in TIM1/TIM3 timer counts. */
+#define TIMER_CYCLES_FOR_SPI_TRANSMISSIONS 9
+
+/* This value sets the point when the LED strobe is asserted after the begin of the current bit cycle and IRQ
+ * processing. This must be less than TIMER_CYCLES_FOR_SPI_TRANSMISSIONS but must be large enough to allow for the SPI
+ * transmission to reliably finish.
+ *
+ * This value is in TIM1/TIM3 timer counts. */
+#define TIMER_CYCLES_BEFORE_LED_STROBE 8
+
+/* This value sets how long the TIM1 CC IRQ used for AUX register setting etc. is triggered before the end of the
+ * longest cycle. This value should not be larger than PERIOD_BASE<<MIN_BITS to make sure the TIM1 CC IRQ does only
+ * trigger in the longest cycle no matter what nbits is set to.
+ *
+ * This value is in TIM1/TIM3 timer counts. */
+#define AUX_SPI_PRETRIGGER 64 /* trigger with about 24us margin to the end of cycle/next TIM3 IRQ */
+
+/* This value sets how long a batch of ADC conversions used for temperature measurement is started before the end of the
+ * longest cycle. Here too the above caveats apply.
+ *
+ * This value is in TIM1/TIM3 timer counts. */
+#define ADC_PRETRIGGER 150 /* trigger with about 12us margin to TIM1 CC IRQ */
+
+/* Defines for brevity */
+#define A TIMER_CYCLES_FOR_SPI_TRANSMISSIONS
+#define B PERIOD_BASE
+
+/* This is a constant offset containing some empirically determined correction values */
+#define C (0)
+
+/* This lookup table maps bit positions to timer period values. This is a lookup table to allow for the compensation for
+ * non-linear effects of ringing at lower bit durations.
+ */
+static uint16_t timer_period_lookup[MAX_BITS+1] = {
+ /* LSB here */
+ A - C + (B<< 0),
+ A - C + (B<< 1),
+ A - C + (B<< 2),
+ A - C + (B<< 3),
+ A - C + (B<< 4),
+ A - C + (B<< 5),
+ A - C + (B<< 6),
+ A - C + (B<< 7),
+ A - C + (B<< 8),
+ A - C + (B<< 9),
+ A - C + (B<< 0),
+ /* MSB here */
+};
+
+/* Don't pollute the global namespace */
+#undef A
+#undef B
+#undef C
+
+void display_cfg_timers(void);
+void display_cfg_spi(void);
+
+void display_init() {
+ display_cfg_spi();
+
+ /* Pre-compute aux register values for timer ISR */
+ for (int i=0; i<NSEGMENTS; i++) {
+ segment_map[i] = 0xff00 ^ (0x100<<segment_map[i]);
+ }
+
+ /* Clear frame buffer */
+ read_fb->brightness = 1;
+ for (int i=0; i<sizeof(read_fb->data)/sizeof(uint32_t); i++) {
+ read_fb->data[i] = 0xffffffff; /* FIXME this is a debug value. Should be 0x00000000; */
+ }
+
+ display_cfg_timers();
+}
+
+void display_cfg_spi() {
+ /* Configure SPI controller */
+ SPI1->I2SCFGR = 0;
+ SPI1->CR2 &= ~SPI_CR2_DS_Msk;
+ SPI1->CR2 &= ~SPI_CR2_DS_Msk;
+ SPI1->CR2 |= LL_SPI_DATAWIDTH_16BIT;
+
+ /* Baud rate PCLK/4 -> 12.5MHz */
+ SPI1->CR1 =
+ SPI_CR1_BIDIMODE
+ | SPI_CR1_BIDIOE
+ | SPI_CR1_SSM
+ | SPI_CR1_SSI
+ | SPI_CR1_SPE
+ | (1<<SPI_CR1_BR_Pos)
+ | SPI_CR1_MSTR
+ | SPI_CR1_CPOL
+ | SPI_CR1_CPHA;
+ /* FIXME maybe try w/o BIDI */
+}
+
+void display_cfg_timers() {
+ /* Ok, so this part is unfortunately a bit involved.
+ *
+ * Because the GPIO alternate function assignments worked out that way, the LED driving logic uses timers 1 and 3.
+ * Timer 1 is synchronized to timer 3. When timer 3 overflows, timer 1 is reset. Both use the same prescaler so both
+ * are synchronous possibly modulo some propagation delay in the synchronization hardware.
+ *
+ * Timer 3:
+ * * The IRQ handler is set to trigger on overflow and
+ * * triggers the SPI transmissions to the LED drivers and
+ * * updates the timing logic with the delays for the next cycle
+ * * Compare unit 1 generates the !OE signal for the led drivers
+ * Timer 1:
+ * * Compare unit 1 triggers the interrupt handler only in the longest bit cycle. The IRQ handler
+ * * transmits the data to the auxiliary shift registers and
+ * * swaps the frame buffers if pending
+ * * Compare unit 2 generates the led drivers' STROBE signal
+ *
+ * The AUX_STROBE signal for the two auxiliary shift registers that deal with segment selection, current setting and
+ * status leds is generated in software in both ISRs. TIM3's ISR indiscriminately resets this strobe every bit
+ * cycle, and TIM1's ISR sets it every NBITSth bit cycle.
+ *
+ * The reason both timers' IRQ handlers are used is that this way no big if/else statement is necessary to
+ * distinguish between both cases. Timer 1's IRQ handler is set via CC2 to trigger a few cycles earlier than the end
+ * of the longest bit cycle. This means that if both timers perform bit cycles of length 1, 2, 4, 8, 16 and 32
+ * TIM1_CC2 will be set to trigger at count e.g. 28. This means it is only triggered once in the last timer cycle.
+ */
+
+ TIM3->CR2 = (2<<TIM_CR2_MMS_Pos); /* master mode: update */
+ TIM3->CCMR1 = (6<<TIM_CCMR1_OC1M_Pos) | TIM_CCMR1_OC1PE; /* PWM Mode 1, enable CCR preload */
+ TIM3->CCER = TIM_CCER_CC1E;
+ TIM3->CCR1 = TIMER_CYCLES_FOR_SPI_TRANSMISSIONS;
+ TIM3->DIER = TIM_DIER_UIE;
+ TIM3->PSC = SystemCoreClock/5000000 * 2 - 1; /* 0.20us/tick */
+ TIM3->ARR = 0xffff;
+ TIM3->EGR |= TIM_EGR_UG;
+ TIM3->CR1 = TIM_CR1_ARPE;
+ TIM3->CR1 |= TIM_CR1_CEN;
+
+ /* Slave TIM1 to TIM3. */
+ TIM1->PSC = TIM3->PSC;
+ TIM1->SMCR = (2<<TIM_SMCR_TS_Pos) | (4<<TIM_SMCR_SMS_Pos); /* Internal Trigger 2 (ITR2) -> TIM3; slave mode: reset */
+
+ /* Setup CC1 and CC2. CC2 generates the LED drivers' STROBE, CC1 triggers the IRQ handler */
+ TIM1->BDTR = TIM_BDTR_MOE;
+ TIM1->CCMR1 = (6<<TIM_CCMR1_OC2M_Pos) | TIM_CCMR1_OC2PE; /* PWM Mode 1, enable CCR preload for AUX_STROBE */
+ TIM1->CCMR2 = (6<<TIM_CCMR2_OC4M_Pos); /* PWM Mode 1 */
+ TIM1->CCER = TIM_CCER_CC1E | TIM_CCER_CC2E | TIM_CCER_CC4E;
+ TIM1->CCR2 = TIMER_CYCLES_BEFORE_LED_STROBE;
+ /* Trigger at the end of the longest bit cycle. This means this does not trigger in shorter bit cycles. */
+ TIM1->CCR1 = timer_period_lookup[nbits-1] - AUX_SPI_PRETRIGGER;
+ TIM1->CCR4 = timer_period_lookup[nbits-1] - ADC_PRETRIGGER;
+ TIM1->DIER = TIM_DIER_CC1IE;
+
+ TIM1->ARR = 0xffff; /* This is as large as possible since TIM1 is reset by TIM3. */
+ /* Preload all values */
+ TIM1->EGR |= TIM_EGR_UG;
+ TIM1->CR1 = TIM_CR1_ARPE;
+ /* And... go! */
+ TIM1->CR1 |= TIM_CR1_CEN;
+
+ /* Sends aux data and swaps frame buffers if necessary */
+ NVIC_EnableIRQ(TIM1_CC_IRQn);
+ NVIC_SetPriority(TIM1_CC_IRQn, 0);
+ /* Sends LED data and sets up the next bit cycle's timings */
+ NVIC_EnableIRQ(TIM3_IRQn);
+ NVIC_SetPriority(TIM3_IRQn, 0);
+}
+
+void TIM1_CC_IRQHandler() {
+ //static int last_frame_time = 0;
+ /* This handler takes about 1.5us */
+ GPIOA->BSRR = GPIO_BSRR_BS_0; // Debug
+
+ /* Set SPI baudrate to 12.5MBd for slow-ish 74HC(T)595. This is reset again in TIM3's IRQ handler.*/
+ SPI1->CR1 |= (2<<SPI_CR1_BR_Pos);
+
+ /* Advance bit counts and perform pending frame buffer swap */
+ active_bit = 0;
+ active_segment++;
+ if (active_segment == NSEGMENTS) {
+ active_segment = 0;
+
+ /* Frame buffer swap */
+ if (fb_op == FB_UPDATE) {
+ volatile struct framebuf *tmp = read_fb;
+ read_fb = write_fb;
+ write_fb = tmp;
+ fb_op = FB_WRITE;
+ }
+ }
+
+ /* Reset aux strobe */
+ GPIOA->BSRR = GPIO_BSRR_BR_10;
+ /* Send AUX register data */
+ uint32_t aux_reg = (read_fb->brightness ? SR_ILED_HIGH : SR_ILED_LOW) | (led_state<<1);
+ SPI1->DR = aux_reg | segment_map[active_segment];
+
+ /* TODO: Measure frame rate for status report */
+
+ /* Clear interrupt flag */
+ TIM1->SR &= ~TIM_SR_CC1IF_Msk;
+
+ GPIOA->BSRR = GPIO_BSRR_BR_0; // Debug
+}
+
+void TIM3_IRQHandler() {
+ /* This handler takes about 2.1us */
+ GPIOA->BSRR = GPIO_BSRR_BS_0; // Debug
+
+ /* Reset SPI baudrate to 25MBd for fast MBI5026. Every couple of cycles, TIM1's ISR will set this to a slower value
+ * for the slower AUX registers.*/
+ SPI1->CR1 &= ~SPI_CR1_BR_Msk;
+ /* Assert aux strobe reset by TIM1's IRQ handler */
+ GPIOA->BSRR = GPIO_BSRR_BS_10;
+
+ /* Queue LED driver data into SPI peripheral */
+ uint32_t spi_word = read_fb->data[active_bit*FRAME_SIZE_WORDS + active_segment];
+ SPI1->DR = spi_word>>16;
+ spi_word &= 0xFFFF;
+ /* Note that this only waits until the internal FIFO is ready, not until all data has been sent. */
+ while (!(SPI1->SR & SPI_SR_TXE));
+ SPI1->DR = spi_word;
+
+ /* Advance bit. This will overflow, but that is OK since before the next invocation of this ISR, the other ISR will
+ * reset it. */
+ active_bit++;
+ /* Schedule next bit cycle */
+ TIM3->ARR = timer_period_lookup[active_bit];
+
+ /* Clear interrupt flag */
+ TIM3->SR &= ~TIM_SR_UIF_Msk;
+
+ GPIOA->BSRR = GPIO_BSRR_BR_0; // Debug
+}
+
diff --git a/fw/display.h b/fw/display.h
new file mode 100644
index 0000000..72ddd84
--- /dev/null
+++ b/fw/display.h
@@ -0,0 +1,34 @@
+/* Megumin LED display firmware
+ * Copyright (C) 2018 Sebastian Götte <code@jaseg.net>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __DISPLAY_H__
+#define __DISPLAY_H__
+
+#include "global.h"
+#include "transpose.h"
+
+extern volatile struct framebuf *read_fb, *write_fb;
+
+enum FB_OPERATION { FB_WRITE, FB_FORMAT, FB_UPDATE };
+extern volatile enum FB_OPERATION fb_op;
+
+extern volatile int nbits;
+extern volatile int frame_duration_us;
+
+void display_init(void);
+
+#endif/*__DISPLAY_H__*/
diff --git a/fw/global.h b/fw/global.h
new file mode 100644
index 0000000..03d3920
--- /dev/null
+++ b/fw/global.h
@@ -0,0 +1,48 @@
+/* Megumin LED display firmware
+ * Copyright (C) 2018 Sebastian Götte <code@jaseg.net>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __GLOBAL_H__
+#define __GLOBAL_H__
+
+/* Workaround for sub-par ST libraries */
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wstrict-aliasing"
+#include <stm32f0xx.h>
+#include <stm32f0xx_ll_utils.h>
+#include <stm32f0xx_ll_spi.h>
+#pragma GCC diagnostic pop
+
+#include <system_stm32f0xx.h>
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <string.h>
+#include <unistd.h>
+
+/* Microcontroller part number: STM32F030F4C6 */
+
+/* Things used for module status reporting. */
+#define FIRMWARE_VERSION 2
+#define HARDWARE_VERSION 4
+
+#define TS_CAL1 (*(uint16_t *)0x1FFFF7B8)
+#define VREFINT_CAL (*(uint16_t *)0x1FFFF7BA)
+
+extern volatile unsigned int sys_time;
+extern volatile unsigned int sys_time_seconds;
+
+#endif/*__GLOBAL_H__*/
diff --git a/fw/led.c b/fw/led.c
new file mode 100644
index 0000000..b9f1592
--- /dev/null
+++ b/fw/led.c
@@ -0,0 +1,70 @@
+/* Megumin LED display firmware
+ * Copyright (C) 2018 Sebastian Götte <code@jaseg.net>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#include "global.h"
+#include "led.h"
+
+/* Status LED control */
+#define LED_STRETCHING_MS 50
+static volatile int error_led_timeout = 0;
+static volatile int comm_led_timeout = 0;
+static volatile int id_led_timeout = 0;
+
+volatile int led_state = 0;
+
+void trigger_error_led() {
+ error_led_timeout = LED_STRETCHING_MS;
+}
+
+void trigger_comm_led() {
+ comm_led_timeout = LED_STRETCHING_MS;
+}
+
+void trigger_id_led() {
+ id_led_timeout = LED_STRETCHING_MS;
+}
+
+void led_task() {
+ static int last_time = 0;
+ /* Crude LED logic. The comm, id and error LEDs each have a timeout counter
+ * that is reset to the LED_STRETCHING_MS constant on an event (either a
+ * frame received correctly or some uart, framing or protocol error). These
+ * timeout counters count down in milliseconds and the LEDs are set while
+ * they are non-zero. This means a train of several very brief events will
+ * make the LED lit permanently.
+ */
+ int time_now = sys_time; /* Latch sys_time here to avoid race conditions */
+ if (last_time != time_now) {
+ int diff = (time_now - last_time);
+
+ error_led_timeout -= diff;
+ if (error_led_timeout < 0)
+ error_led_timeout = 0;
+
+ comm_led_timeout -= diff;
+ if (comm_led_timeout < 0)
+ comm_led_timeout = 0;
+
+ id_led_timeout -= diff;
+ if (id_led_timeout < 0)
+ id_led_timeout = 0;
+
+ led_state = (led_state & ~7) | (!!id_led_timeout)<<2 | (!!error_led_timeout)<<1 | (!!comm_led_timeout)<<0;
+ last_time = time_now;
+ }
+}
+
diff --git a/fw/led.h b/fw/led.h
new file mode 100644
index 0000000..5a6ecaf
--- /dev/null
+++ b/fw/led.h
@@ -0,0 +1,29 @@
+/* Megumin LED display firmware
+ * Copyright (C) 2018 Sebastian Götte <code@jaseg.net>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __LED_H__
+#define __LED_H__
+
+void trigger_error_led(void);
+void trigger_comm_led(void);
+void trigger_id_led(void);
+
+void led_task(void);
+
+extern volatile int led_state;
+
+#endif/*__LED_H__*/
diff --git a/fw/main.c b/fw/main.c
index 7740426..c0ad092 100644
--- a/fw/main.c
+++ b/fw/main.c
@@ -1,624 +1,30 @@
-/* Workaround for sub-par ST libraries */
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wstrict-aliasing"
-#include <stm32f0xx.h>
-#include <stm32f0xx_ll_utils.h>
-#include <stm32f0xx_ll_spi.h>
-#pragma GCC diagnostic pop
-
-#include <system_stm32f0xx.h>
-
-#include <stdint.h>
-#include <stdbool.h>
-#include <string.h>
-#include <unistd.h>
-
-#include "transpose.h"
-#include "mac.h"
-
-/* Microcontroller part number: STM32F030F4C6 */
-
-/* Things used for module status reporting. */
-#define FIRMWARE_VERSION 2
-#define HARDWARE_VERSION 4
-
-#define TS_CAL1 (*(uint16_t *)0x1FFFF7B8)
-#define VREFINT_CAL (*(uint16_t *)0x1FFFF7BA)
+/* Megumin LED display firmware
+ * Copyright (C) 2018 Sebastian Götte <code@jaseg.net>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
-volatile int16_t adc_vcc_mv = 0;
-volatile int16_t adc_temp_celsius = 0;
+#include "global.h"
-volatile uint16_t adc_buf[2];
+#include "display.h"
+#include "serial.h"
+#include "led.h"
+#include "adc.h"
volatile unsigned int sys_time = 0;
volatile unsigned int sys_time_seconds = 0;
-/* Error counters for debugging */
-static unsigned int uart_overruns = 0;
-static unsigned int frame_overruns = 0;
-static unsigned int invalid_frames = 0;
-
-/* Status LED control */
-#define LED_STRETCHING_MS 50
-static volatile int error_led_timeout = 0;
-static volatile int comm_led_timeout = 0;
-static volatile int id_led_timeout = 0;
-
-/* Modulation data */
-volatile struct framebuf fb[2] = {0};
-volatile struct framebuf *read_fb=fb+0, *write_fb=fb+1;
-volatile int led_state = 0;
-volatile enum { FB_WRITE, FB_FORMAT, FB_UPDATE } fb_op;
-volatile union {
- struct __attribute__((packed)) { struct framebuf fb; uint8_t end[0]; } set_fb_rq;
- struct __attribute__((packed)) { uint8_t nbits; uint8_t end[0]; } set_nbits_rq;
- uint8_t byte_data[0];
- uint32_t mac_data;
-} rx_buf;
-
-/* Auxiliary shift register values */
-#define LED_COMM 0x0001
-#define LED_ERROR 0x0002
-#define LED_ID 0x0004
-#define SR_ILED_HIGH 0x0080
-#define SR_ILED_LOW 0x0040
-
-/* This is a lookup table mapping segments to present a standard segment order on the UART interface. This is converted
- * into an internal representation once on startup in main(). The data type must be at least uint16. */
-uint32_t segment_map[8] = {5, 7, 6, 4, 1, 3, 0, 2};
-
-static volatile int frame_duration_us;
-volatile int nbits = MAX_BITS;
-
-static unsigned int active_bit = 0;
-static int active_segment = 0;
-
-/* Bit timing base value. This is the lowes bit interval used in TIM1/TIM3 timer counts. */
-#define PERIOD_BASE 4
-
-/* This value is a constant offset added to every bit period to allow for the timer IRQ handler to execute. This is set
- * empirically using a debugger and a logic analyzer.
- *
- * This value is in TIM1/TIM3 timer counts. */
-#define TIMER_CYCLES_FOR_SPI_TRANSMISSIONS 9
-
-/* This value sets the point when the LED strobe is asserted after the begin of the current bit cycle and IRQ
- * processing. This must be less than TIMER_CYCLES_FOR_SPI_TRANSMISSIONS but must be large enough to allow for the SPI
- * transmission to reliably finish.
- *
- * This value is in TIM1/TIM3 timer counts. */
-#define TIMER_CYCLES_BEFORE_LED_STROBE 8
-
-/* This value sets how long the TIM1 CC IRQ used for AUX register setting etc. is triggered before the end of the
- * longest cycle. This value should not be larger than PERIOD_BASE<<MIN_BITS to make sure the TIM1 CC IRQ does only
- * trigger in the longest cycle no matter what nbits is set to.
- *
- * This value is in TIM1/TIM3 timer counts. */
-#define AUX_SPI_PRETRIGGER 64 /* trigger with about 24us margin to the end of cycle/next TIM3 IRQ */
-
-/* This value sets how long a batch of ADC conversions used for temperature measurement is started before the end of the
- * longest cycle. Here too the above caveats apply.
- *
- * This value is in TIM1/TIM3 timer counts. */
-#define ADC_PRETRIGGER 150 /* trigger with about 12us margin to TIM1 CC IRQ */
-
-/* Defines for brevity */
-#define A TIMER_CYCLES_FOR_SPI_TRANSMISSIONS
-#define B PERIOD_BASE
-
-/* This is a constant offset containing some empirically determined correction values */
-#define C (0)
-
-/* This lookup table maps bit positions to timer period values. This is a lookup table to allow for the compensation for
- * non-linear effects of ringing at lower bit durations.
- */
-static uint16_t timer_period_lookup[MAX_BITS+1] = {
- /* LSB here */
- A - C + (B<< 0),
- A - C + (B<< 1),
- A - C + (B<< 2),
- A - C + (B<< 3),
- A - C + (B<< 4),
- A - C + (B<< 5),
- A - C + (B<< 6),
- A - C + (B<< 7),
- A - C + (B<< 8),
- A - C + (B<< 9),
- A - C + (B<< 0),
- /* MSB here */
-};
-
-/* Don't pollute the global namespace */
-#undef A
-#undef B
-#undef C
-
-void cfg_timers_led() {
- /* Ok, so this part is unfortunately a bit involved.
- *
- * Because the GPIO alternate function assignments worked out that way, the LED driving logic uses timers 1 and 3.
- * Timer 1 is synchronized to timer 3. When timer 3 overflows, timer 1 is reset. Both use the same prescaler so both
- * are synchronous possibly modulo some propagation delay in the synchronization hardware.
- *
- * Timer 3:
- * * The IRQ handler is set to trigger on overflow and
- * * triggers the SPI transmissions to the LED drivers and
- * * updates the timing logic with the delays for the next cycle
- * * Compare unit 1 generates the !OE signal for the led drivers
- * Timer 1:
- * * Compare unit 1 triggers the interrupt handler only in the longest bit cycle. The IRQ handler
- * * transmits the data to the auxiliary shift registers and
- * * swaps the frame buffers if pending
- * * Compare unit 2 generates the led drivers' STROBE signal
- *
- * The AUX_STROBE signal for the two auxiliary shift registers that deal with segment selection, current setting and
- * status leds is generated in software in both ISRs. TIM3's ISR indiscriminately resets this strobe every bit
- * cycle, and TIM1's ISR sets it every NBITSth bit cycle.
- *
- * The reason both timers' IRQ handlers are used is that this way no big if/else statement is necessary to
- * distinguish between both cases. Timer 1's IRQ handler is set via CC2 to trigger a few cycles earlier than the end
- * of the longest bit cycle. This means that if both timers perform bit cycles of length 1, 2, 4, 8, 16 and 32
- * TIM1_CC2 will be set to trigger at count e.g. 28. This means it is only triggered once in the last timer cycle.
- */
-
- TIM3->CR2 = (2<<TIM_CR2_MMS_Pos); /* master mode: update */
- TIM3->CCMR1 = (6<<TIM_CCMR1_OC1M_Pos) | TIM_CCMR1_OC1PE; /* PWM Mode 1, enable CCR preload */
- TIM3->CCER = TIM_CCER_CC1E;
- TIM3->CCR1 = TIMER_CYCLES_FOR_SPI_TRANSMISSIONS;
- TIM3->DIER = TIM_DIER_UIE;
- TIM3->PSC = SystemCoreClock/5000000 * 2 - 1; /* 0.20us/tick */
- TIM3->ARR = 0xffff;
- TIM3->EGR |= TIM_EGR_UG;
- TIM3->CR1 = TIM_CR1_ARPE;
- TIM3->CR1 |= TIM_CR1_CEN;
-
- /* Slave TIM1 to TIM3. */
- TIM1->PSC = TIM3->PSC;
- TIM1->SMCR = (2<<TIM_SMCR_TS_Pos) | (4<<TIM_SMCR_SMS_Pos); /* Internal Trigger 2 (ITR2) -> TIM3; slave mode: reset */
-
- /* Setup CC1 and CC2. CC2 generates the LED drivers' STROBE, CC1 triggers the IRQ handler */
- TIM1->BDTR = TIM_BDTR_MOE;
- TIM1->CCMR1 = (6<<TIM_CCMR1_OC2M_Pos) | TIM_CCMR1_OC2PE; /* PWM Mode 1, enable CCR preload for AUX_STROBE */
- TIM1->CCMR2 = (6<<TIM_CCMR2_OC4M_Pos); /* PWM Mode 1 */
- TIM1->CCER = TIM_CCER_CC1E | TIM_CCER_CC2E | TIM_CCER_CC4E;
- TIM1->CCR2 = TIMER_CYCLES_BEFORE_LED_STROBE;
- /* Trigger at the end of the longest bit cycle. This means this does not trigger in shorter bit cycles. */
- TIM1->CCR1 = timer_period_lookup[nbits-1] - AUX_SPI_PRETRIGGER;
- TIM1->CCR4 = timer_period_lookup[nbits-1] - ADC_PRETRIGGER;
- TIM1->DIER = TIM_DIER_CC1IE;
-
- TIM1->ARR = 0xffff; /* This is as large as possible since TIM1 is reset by TIM3. */
- /* Preload all values */
- TIM1->EGR |= TIM_EGR_UG;
- TIM1->CR1 = TIM_CR1_ARPE;
- /* And... go! */
- TIM1->CR1 |= TIM_CR1_CEN;
-
- /* Sends aux data and swaps frame buffers if necessary */
- NVIC_EnableIRQ(TIM1_CC_IRQn);
- NVIC_SetPriority(TIM1_CC_IRQn, 0);
- /* Sends LED data and sets up the next bit cycle's timings */
- NVIC_EnableIRQ(TIM3_IRQn);
- NVIC_SetPriority(TIM3_IRQn, 0);
-}
-
-void TIM1_CC_IRQHandler() {
- //static int last_frame_time = 0;
- /* This handler takes about 1.5us */
- GPIOA->BSRR = GPIO_BSRR_BS_0; // Debug
-
- /* Set SPI baudrate to 12.5MBd for slow-ish 74HC(T)595. This is reset again in TIM3's IRQ handler.*/
- SPI1->CR1 |= (2<<SPI_CR1_BR_Pos);
-
- /* Advance bit counts and perform pending frame buffer swap */
- active_bit = 0;
- active_segment++;
- if (active_segment == NSEGMENTS) {
- active_segment = 0;
-
- /* Frame buffer swap */
- if (fb_op == FB_UPDATE) {
- volatile struct framebuf *tmp = read_fb;
- read_fb = write_fb;
- write_fb = tmp;
- fb_op = FB_WRITE;
- }
- }
-
- /* Reset aux strobe */
- GPIOA->BSRR = GPIO_BSRR_BR_10;
- /* Send AUX register data */
- uint32_t aux_reg = (read_fb->brightness ? SR_ILED_HIGH : SR_ILED_LOW) | (led_state<<1);
- SPI1->DR = aux_reg | segment_map[active_segment];
-
- /* TODO: Measure frame rate for status report */
-
- /* Clear interrupt flag */
- TIM1->SR &= ~TIM_SR_CC1IF_Msk;
-
- GPIOA->BSRR = GPIO_BSRR_BR_0; // Debug
-}
-
-void TIM3_IRQHandler() {
- /* This handler takes about 2.1us */
- GPIOA->BSRR = GPIO_BSRR_BS_0; // Debug
-
- /* Reset SPI baudrate to 25MBd for fast MBI5026. Every couple of cycles, TIM1's ISR will set this to a slower value
- * for the slower AUX registers.*/
- SPI1->CR1 &= ~SPI_CR1_BR_Msk;
- /* Assert aux strobe reset by TIM1's IRQ handler */
- GPIOA->BSRR = GPIO_BSRR_BS_10;
-
- /* Queue LED driver data into SPI peripheral */
- uint32_t spi_word = read_fb->data[active_bit*FRAME_SIZE_WORDS + active_segment];
- SPI1->DR = spi_word>>16;
- spi_word &= 0xFFFF;
- /* Note that this only waits until the internal FIFO is ready, not until all data has been sent. */
- while (!(SPI1->SR & SPI_SR_TXE));
- SPI1->DR = spi_word;
-
- /* Advance bit. This will overflow, but that is OK since before the next invocation of this ISR, the other ISR will
- * reset it. */
- active_bit++;
- /* Schedule next bit cycle */
- TIM3->ARR = timer_period_lookup[active_bit];
-
- /* Clear interrupt flag */
- TIM3->SR &= ~TIM_SR_UIF_Msk;
-
- GPIOA->BSRR = GPIO_BSRR_BR_0; // Debug
-}
-
-void cfg_spi1() {
- /* Configure SPI controller */
- SPI1->I2SCFGR = 0;
- SPI1->CR2 &= ~SPI_CR2_DS_Msk;
- SPI1->CR2 &= ~SPI_CR2_DS_Msk;
- SPI1->CR2 |= LL_SPI_DATAWIDTH_16BIT;
-
- /* Baud rate PCLK/4 -> 12.5MHz */
- SPI1->CR1 =
- SPI_CR1_BIDIMODE
- | SPI_CR1_BIDIOE
- | SPI_CR1_SSM
- | SPI_CR1_SSI
- | SPI_CR1_SPE
- | (1<<SPI_CR1_BR_Pos)
- | SPI_CR1_MSTR
- | SPI_CR1_CPOL
- | SPI_CR1_CPHA;
- /* FIXME maybe try w/o BIDI */
-}
-
-void uart_config(void) {
- USART1->CR1 = /* 8-bit -> M1, M0 clear */
- /* RTOIE clear */
- (8 << USART_CR1_DEAT_Pos) /* 8 sample cycles/1 bit DE assertion time */
- | (8 << USART_CR1_DEDT_Pos) /* 8 sample cycles/1 bit DE assertion time */
- /* OVER8 clear. Use default 16x oversampling */
- /* CMIF clear */
- | USART_CR1_MME
- /* WAKE clear */
- /* PCE, PS clear */
- | USART_CR1_RXNEIE /* Enable receive interrupt */
- /* other interrupts clear */
- | USART_CR1_TE
- | USART_CR1_RE;
- //USART1->CR2 = USART_CR2_RTOEN; /* Timeout enable */
- USART1->CR3 = USART_CR3_DEM; /* RS485 DE enable (output on RTS) */
- /* Set divider for 25MHz baud rate @50MHz system clock. */
- int usartdiv = 25;
- USART1->BRR = usartdiv;
-
- /* And... go! */
- USART1->CR1 |= USART_CR1_UE;
-
- /* Enable receive interrupt */
- NVIC_EnableIRQ(USART1_IRQn);
- NVIC_SetPriority(USART1_IRQn, 1);
-}
-
-void trigger_error_led() {
- error_led_timeout = LED_STRETCHING_MS;
-}
-
-void trigger_comm_led() {
- comm_led_timeout = LED_STRETCHING_MS;
-}
-
-void trigger_id_led() {
- id_led_timeout = LED_STRETCHING_MS;
-}
-
-void tx_char(uint8_t c) {
- while (!(USART1->ISR & USART_ISR_TC));
- USART1->TDR = c;
-}
-
-void send_frame_formatted(uint8_t *buf, int len) {
- uint8_t *p=buf, *q=buf, *end=buf+len;
- do {
- while (*q && q!=end)
- q++;
- tx_char(q-p+1);
- while (*p && p!=end)
- tx_char(*p++);
- p++, q++;
- } while (p < end);
- tx_char('\0');
-}
-
-union {
- struct __attribute__((packed)) {
- uint8_t firmware_version,
- hardware_version,
- digit_rows,
- digit_cols;
- uint32_t uptime_s,
- framerate_millifps,
- uart_overruns,
- frame_overruns,
- invalid_frames;
- int16_t vcc_mv,
- temp_celsius;
- uint8_t nbits;
- } desc_reply;
- uint8_t byte_data[0];
-} tx_buf;
-
-void send_status_reply(void) {
- tx_buf.desc_reply.firmware_version = FIRMWARE_VERSION;
- tx_buf.desc_reply.hardware_version = HARDWARE_VERSION;
- tx_buf.desc_reply.digit_rows = NROWS;
- tx_buf.desc_reply.digit_cols = NCOLS;
- tx_buf.desc_reply.uptime_s = sys_time_seconds;
- tx_buf.desc_reply.vcc_mv = adc_vcc_mv;
- tx_buf.desc_reply.temp_celsius = adc_temp_celsius;
- tx_buf.desc_reply.nbits = nbits;
- tx_buf.desc_reply.framerate_millifps = frame_duration_us > 0 ? 1000000000 / frame_duration_us : 0;
- tx_buf.desc_reply.uart_overruns = uart_overruns;
- tx_buf.desc_reply.frame_overruns = frame_overruns;
- tx_buf.desc_reply.invalid_frames = invalid_frames;
- send_frame_formatted(tx_buf.byte_data, sizeof(tx_buf.desc_reply));
-}
-
-/* This is the higher-level protocol handler for the serial protocol. It gets passed the number of data bytes in this
- * frame (which may be zero) and returns a pointer to the buffer where the next frame should be stored.
- */
-volatile uint8_t *packet_received(int len) {
- static enum {
- PROT_ADDRESSED = 0,
- PROT_EXPECT_FRAME_SECOND_HALF = 1,
- PROT_IGNORE = 2,
- } protocol_state = PROT_IGNORE;
- /* Use mac frames as delimiters to synchronize this protocol layer */
- trigger_comm_led();
- if (len == 0) { /* Discovery packet */
- if (sys_time < 100 && sys_time_seconds == 0) { /* Only respond during the first 100ms after boot */
- send_frame_formatted((uint8_t*)&device_mac, sizeof(device_mac));
- }
-
- } else if (len == 1) { /* Command packet */
- if (protocol_state == PROT_ADDRESSED) {
- switch (rx_buf.byte_data[0]) {
- case 0x01:
- GPIOA->BSRR = GPIO_BSRR_BS_4; // Debug
- //for (int i=0; i<100; i++)
- // tick();
- send_status_reply();
- GPIOA->BSRR = GPIO_BSRR_BR_4; // Debug
- break;
- }
- } else {
- invalid_frames++;
- trigger_error_led();
- }
- protocol_state = PROT_IGNORE;
-
- } else if (len == 4) { /* Address packet */
- if (rx_buf.mac_data == device_mac) { /* we are addressed */
- protocol_state = PROT_ADDRESSED; /* start listening for frame buffer data */
- } else { /* we are not addressed */
- protocol_state = PROT_IGNORE; /* ignore packet */
- }
-
- } else if (len == sizeof(rx_buf.set_fb_rq)/2) {
- if (protocol_state == PROT_ADDRESSED) { /* First of two half-framebuffer data frames */
- protocol_state = PROT_EXPECT_FRAME_SECOND_HALF;
- /* Return second half of receive buffer */
- return rx_buf.byte_data + (sizeof(rx_buf.set_fb_rq)/2);
-
- } else if (protocol_state == PROT_EXPECT_FRAME_SECOND_HALF) { /* Second of two half-framebuffer data frames */
- /* Kick off buffer transfer. This triggers the main loop to copy data out of the receive buffer and paste it
- * properly formatted into the frame buffer. */
- if (fb_op == FB_WRITE) {
- fb_op = FB_FORMAT;
- trigger_id_led();
- } else {
- /* FIXME An overrun happend. What should we do? */
- frame_overruns++;
- trigger_error_led();
- }
-
- /* Go to "hang mode" until next zero-length packet. */
- protocol_state = PROT_IGNORE;
- }
-
- } else {
- /* FIXME An invalid packet has been received. What should we do? */
- invalid_frames++;
- trigger_error_led();
- protocol_state = PROT_IGNORE; /* go into "hang mode" until next zero-length packet */
- }
-
- /* By default, return rx_buf.byte_data . This means if an invalid protocol state is reached ("hang mode"), the next
- * frame is still written to rx_buf. This is not a problem since whatever garbage is written at that point will be
- * overwritten before the next buffer transfer. */
- return rx_buf.byte_data;
-}
-
-void USART1_IRQHandler(void) {
- /* Since a large amount of data will be shoved down this UART interface we need a more reliable and more efficient
- * way of framing than just waiting between transmissions.
- *
- * This code uses "Consistent Overhead Byte Stuffing" (COBS). For details, see its Wikipedia page[0] or the proper
- * scientific paper[1] published on it. Roughly, it works like this:
- *
- * * A frame is at most 254 bytes in length.
- * * The null byte 0x00 acts as a frame delimiter. There is no null bytes inside frames.
- * * Every frame starts with an "overhead" byte indicating the number of non-null payload bytes until the next null
- * byte in the payload, **plus one**. This means this byte can never be zero.
- * * Every null byte in the payload is replaced by *its* distance to *its* next null byte as above.
- *
- * This means, at any point the receiver can efficiently be synchronized on the next frame boundary by simply
- * waiting for a null byte. After that, only a simple state machine is necessary to strip the overhead byte and a
- * counter to then count skip intervals.
- *
- * Here is Wikipedia's table of example values:
- *
- * Unencoded data Encoded with COBS
- * 00 01 01 00
- * 00 00 01 01 01 00
- * 11 22 00 33 03 11 22 02 33 00
- * 11 22 33 44 05 11 22 33 44 00
- * 11 00 00 00 02 11 01 01 01 00
- * 01 02 ...FE FF 01 02 ...FE 00
- *
- * [0] https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing
- * [1] Cheshire, Stuart; Baker, Mary (1999). "Consistent Overhead Byte Stuffing"
- * IEEE/ACM Transactions on Networking. doi:10.1109/90.769765
- * http://www.stuartcheshire.org/papers/COBSforToN.pdf
- */
-
- /* This pointer stores where we write data. The higher-level protocol logic decides on a frame-by-frame-basis where
- * the next frame's data will be stored. */
- static volatile uint8_t *writep = rx_buf.byte_data;
- /* Index inside the current frame payload */
- static int rxpos = 0;
- /* COBS state machine. This implementation might be a little too complicated, but it works well enough and I find it
- * reasonably easy to understand. */
- static enum {
- COBS_WAIT_SYNC = 0, /* Synchronize with frame */
- COBS_WAIT_START = 1, /* Await overhead byte */
- COBS_RUNNING = 2 /* Process payload */
- } cobs_state = 0;
- /* COBS skip counter. During payload processing this contains the remaining non-null payload bytes */
- static int cobs_count = 0;
-
- if (USART1->ISR & USART_ISR_ORE) { /* Overrun handling */
- uart_overruns++;
- trigger_error_led();
- /* Reset and re-synchronize. Retry next frame. */
- rxpos = 0;
- cobs_state = COBS_WAIT_SYNC;
- /* Clear interrupt flag */
- USART1->ICR = USART_ICR_ORECF;
-
- } else { /* Data received */
- uint8_t data = USART1->RDR; /* This automatically acknowledges the IRQ */
-
- if (data == 0x00) { /* End-of-packet */
- /* Process higher protocol layers on this packet. */
- writep = packet_received(rxpos);
-
- /* Reset for next packet. */
- cobs_state = COBS_WAIT_START;
- rxpos = 0;
-
- } else { /* non-null byte */
- if (cobs_state == COBS_WAIT_SYNC) { /* Wait for null byte */
- /* ignore data */
-
- } else if (cobs_state == COBS_WAIT_START) { /* Overhead byte */
- cobs_count = data;
- cobs_state = COBS_RUNNING;
-
- } else { /* Payload byte */
- if (--cobs_count == 0) { /* Skip byte */
- cobs_count = data;
- data = 0;
- }
-
- /* Write processed payload byte to current receive buffer */
- writep[rxpos++] = data;
- }
- }
- }
-}
-
-#define ADC_OVERSAMPLING 8
-uint32_t vsense;
-void DMA1_Channel1_IRQHandler(void) {
- /* This interrupt takes either 1.2us or 13us. It can be pre-empted by the more timing-critical UART and LED timer
- * interrupts. */
- static int count = 0; /* oversampling accumulator sample count */
- static uint32_t adc_aggregate[2] = {0, 0}; /* oversampling accumulator */
-
- /* Clear the interrupt flag */
- DMA1->IFCR |= DMA_IFCR_CGIF1;
-
- adc_aggregate[0] += adc_buf[0];
- adc_aggregate[1] += adc_buf[1];
-
- if (++count == (1<<ADC_OVERSAMPLING)) {
- /* This has been copied from the code examples to section 12.9 ADC>"Temperature sensor and internal reference
- * voltage" in the reference manual with the extension that we actually measure the supply voltage instead of
- * hardcoding it. This is not strictly necessary since we're running off a bored little LDO but it's free and
- * the current supply voltage is a nice health value.
- */
- adc_vcc_mv = (3300 * VREFINT_CAL)/(adc_aggregate[0]>>ADC_OVERSAMPLING);
- int32_t temperature = (((uint32_t)TS_CAL1) - ((adc_aggregate[1]>>ADC_OVERSAMPLING) * adc_vcc_mv / 3300)) * 1000;
- temperature = (temperature/5336) + 30;
- adc_temp_celsius = temperature;
-
- count = 0;
- adc_aggregate[0] = 0;
- adc_aggregate[1] = 0;
- }
-}
-
-void adc_config(void) {
- /* The ADC is used for temperature measurement. To compute the temperature from an ADC reading of the internal
- * temperature sensor, the supply voltage must also be measured. Thus we are using two channels.
- *
- * The ADC is triggered by compare channel 4 of timer 1. The trigger is set to falling edge to trigger on compare
- * match, not overflow.
- */
- ADC1->CFGR1 = ADC_CFGR1_DMAEN | ADC_CFGR1_DMACFG | (2<<ADC_CFGR1_EXTEN_Pos) | (1<<ADC_CFGR1_EXTSEL_Pos);
- /* Clock from PCLK/4 instead of the internal exclusive high-speed RC oscillator. */
- ADC1->CFGR2 = (2<<ADC_CFGR2_CKMODE_Pos);
- /* Use the slowest available sample rate */
- ADC1->SMPR = (7<<ADC_SMPR_SMP_Pos);
- /* Internal VCC and temperature sensor channels */
- ADC1->CHSELR = ADC_CHSELR_CHSEL16 | ADC_CHSELR_CHSEL17;
- /* Enable internal voltage reference and temperature sensor */
- ADC->CCR = ADC_CCR_TSEN | ADC_CCR_VREFEN;
- /* Perform ADC calibration */
- ADC1->CR |= ADC_CR_ADCAL;
- while (ADC1->CR & ADC_CR_ADCAL)
- ;
- /* Enable ADC */
- ADC1->CR |= ADC_CR_ADEN;
- ADC1->CR |= ADC_CR_ADSTART;
-
- /* Configure DMA 1 Channel 1 to get rid of all the data */
- DMA1_Channel1->CPAR = (unsigned int)&ADC1->DR;
- DMA1_Channel1->CMAR = (unsigned int)&adc_buf;
- DMA1_Channel1->CNDTR = sizeof(adc_buf)/sizeof(adc_buf[0]);
- DMA1_Channel1->CCR = (0<<DMA_CCR_PL_Pos);
- DMA1_Channel1->CCR |=
- DMA_CCR_CIRC /* circular mode so we can leave it running indefinitely */
- | (1<<DMA_CCR_MSIZE_Pos) /* 16 bit */
- | (1<<DMA_CCR_PSIZE_Pos) /* 16 bit */
- | DMA_CCR_MINC
- | DMA_CCR_TCIE; /* Enable transfer complete interrupt. */
- DMA1_Channel1->CCR |= DMA_CCR_EN; /* Enable channel */
-
- /* triggered on transfer completion. We use this to process the ADC data */
- NVIC_EnableIRQ(DMA1_Channel1_IRQn);
- NVIC_SetPriority(DMA1_Channel1_IRQn, 3);
-}
-
int main(void) {
RCC->CR |= RCC_CR_HSEON;
while (!(RCC->CR&RCC_CR_HSERDY));
@@ -676,50 +82,13 @@ int main(void) {
| (1<<GPIO_PUPDR_PUPDR2_Pos) /* TX */
| (1<<GPIO_PUPDR_PUPDR3_Pos); /* RX */
- cfg_spi1();
-
- /* Pre-compute aux register values for timer ISR */
- for (int i=0; i<NSEGMENTS; i++) {
- segment_map[i] = 0xff00 ^ (0x100<<segment_map[i]);
- }
-
- /* Clear frame buffer */
- read_fb->brightness = 1;
- for (int i=0; i<sizeof(read_fb->data)/sizeof(uint32_t); i++) {
- read_fb->data[i] = 0xffffffff; /* FIXME this is a debug value. Should be 0x00000000; */
- }
-
- cfg_timers_led();
+ display_init();
SysTick_Config(SystemCoreClock/1000); /* 1ms interval */
- uart_config();
- adc_config();
+ serial_init();
+ adc_init();
- int last_time = 0;
while (42) {
- /* Crude LED logic. The comm, id and error LEDs each have a timeout counter that is reset to the
- * LED_STRETCHING_MS constant on an event (either a frame received correctly or some uart, framing or protocol
- * error). These timeout counters count down in milliseconds and the LEDs are set while they are non-zero. This
- * means a train of several very brief events will make the LED lit permanently.
- */
- int time_now = sys_time; /* Latch sys_time here to avoid race conditions */
- if (last_time != time_now) {
- int diff = (time_now - last_time);
-
- error_led_timeout -= diff;
- if (error_led_timeout < 0)
- error_led_timeout = 0;
-
- comm_led_timeout -= diff;
- if (comm_led_timeout < 0)
- comm_led_timeout = 0;
-
- id_led_timeout -= diff;
- if (id_led_timeout < 0)
- id_led_timeout = 0;
-
- led_state = (led_state & ~7) | (!!id_led_timeout)<<2 | (!!error_led_timeout)<<1 | (!!comm_led_timeout)<<0;
- last_time = time_now;
- }
+ led_task();
/* Process pending buffer transfer */
if (fb_op == FB_FORMAT) {
diff --git a/fw/serial.c b/fw/serial.c
new file mode 100644
index 0000000..fc797e3
--- /dev/null
+++ b/fw/serial.c
@@ -0,0 +1,255 @@
+/* Megumin LED display firmware
+ * Copyright (C) 2018 Sebastian Götte <code@jaseg.net>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#include "serial.h"
+#include "adc.h"
+#include "mac.h"
+#include "led.h"
+
+unsigned int uart_overruns = 0;
+unsigned int frame_overruns = 0;
+unsigned int invalid_frames = 0;
+
+static union tx_buf_union tx_buf;
+volatile union rx_buf_union rx_buf;
+
+void serial_init() {
+ USART1->CR1 = /* 8-bit -> M1, M0 clear */
+ /* RTOIE clear */
+ (8 << USART_CR1_DEAT_Pos) /* 8 sample cycles/1 bit DE assertion time */
+ | (8 << USART_CR1_DEDT_Pos) /* 8 sample cycles/1 bit DE assertion time */
+ /* OVER8 clear. Use default 16x oversampling */
+ /* CMIF clear */
+ | USART_CR1_MME
+ /* WAKE clear */
+ /* PCE, PS clear */
+ | USART_CR1_RXNEIE /* Enable receive interrupt */
+ /* other interrupts clear */
+ | USART_CR1_TE
+ | USART_CR1_RE;
+ //USART1->CR2 = USART_CR2_RTOEN; /* Timeout enable */
+ USART1->CR3 = USART_CR3_DEM; /* RS485 DE enable (output on RTS) */
+ /* Set divider for 25MHz baud rate @50MHz system clock. */
+ int usartdiv = 25;
+ USART1->BRR = usartdiv;
+
+ /* And... go! */
+ USART1->CR1 |= USART_CR1_UE;
+
+ /* Enable receive interrupt */
+ NVIC_EnableIRQ(USART1_IRQn);
+ NVIC_SetPriority(USART1_IRQn, 1);
+}
+
+void tx_char(uint8_t c) {
+ while (!(USART1->ISR & USART_ISR_TC));
+ USART1->TDR = c;
+}
+
+void send_frame_formatted(uint8_t *buf, int len) {
+ uint8_t *p=buf, *q=buf, *end=buf+len;
+ do {
+ while (*q && q!=end)
+ q++;
+ tx_char(q-p+1);
+ while (*p && p!=end)
+ tx_char(*p++);
+ p++, q++;
+ } while (p < end);
+ tx_char('\0');
+}
+
+void send_status_reply(void) {
+ tx_buf.desc_reply.firmware_version = FIRMWARE_VERSION;
+ tx_buf.desc_reply.hardware_version = HARDWARE_VERSION;
+ tx_buf.desc_reply.digit_rows = NROWS;
+ tx_buf.desc_reply.digit_cols = NCOLS;
+ tx_buf.desc_reply.uptime_s = sys_time_seconds;
+ tx_buf.desc_reply.vcc_mv = adc_vcc_mv;
+ tx_buf.desc_reply.temp_celsius = adc_temp_celsius;
+ tx_buf.desc_reply.nbits = nbits;
+ tx_buf.desc_reply.framerate_millifps = frame_duration_us > 0 ? 1000000000 / frame_duration_us : 0;
+ tx_buf.desc_reply.uart_overruns = uart_overruns;
+ tx_buf.desc_reply.frame_overruns = frame_overruns;
+ tx_buf.desc_reply.invalid_frames = invalid_frames;
+ send_frame_formatted(tx_buf.byte_data, sizeof(tx_buf.desc_reply));
+}
+
+/* This is the higher-level protocol handler for the serial protocol. It gets passed the number of data bytes in this
+ * frame (which may be zero) and returns a pointer to the buffer where the next frame should be stored.
+ */
+volatile uint8_t *packet_received(int len) {
+ static enum {
+ PROT_ADDRESSED = 0,
+ PROT_EXPECT_FRAME_SECOND_HALF = 1,
+ PROT_IGNORE = 2,
+ } protocol_state = PROT_IGNORE;
+ /* Use mac frames as delimiters to synchronize this protocol layer */
+ trigger_comm_led();
+ if (len == 0) { /* Discovery packet */
+ if (sys_time < 100 && sys_time_seconds == 0) { /* Only respond during the first 100ms after boot */
+ send_frame_formatted((uint8_t*)&device_mac, sizeof(device_mac));
+ }
+
+ } else if (len == 1) { /* Command packet */
+ if (protocol_state == PROT_ADDRESSED) {
+ switch (rx_buf.byte_data[0]) {
+ case 0x01:
+ GPIOA->BSRR = GPIO_BSRR_BS_4; // Debug
+ //for (int i=0; i<100; i++)
+ // tick();
+ send_status_reply();
+ GPIOA->BSRR = GPIO_BSRR_BR_4; // Debug
+ break;
+ }
+ } else {
+ invalid_frames++;
+ trigger_error_led();
+ }
+ protocol_state = PROT_IGNORE;
+
+ } else if (len == 4) { /* Address packet */
+ if (rx_buf.mac_data == device_mac) { /* we are addressed */
+ protocol_state = PROT_ADDRESSED; /* start listening for frame buffer data */
+ } else { /* we are not addressed */
+ protocol_state = PROT_IGNORE; /* ignore packet */
+ }
+
+ } else if (len == sizeof(rx_buf.set_fb_rq)/2) {
+ if (protocol_state == PROT_ADDRESSED) { /* First of two half-framebuffer data frames */
+ protocol_state = PROT_EXPECT_FRAME_SECOND_HALF;
+ /* Return second half of receive buffer */
+ return rx_buf.byte_data + (sizeof(rx_buf.set_fb_rq)/2);
+
+ } else if (protocol_state == PROT_EXPECT_FRAME_SECOND_HALF) { /* Second of two half-framebuffer data frames */
+ /* Kick off buffer transfer. This triggers the main loop to copy data out of the receive buffer and paste it
+ * properly formatted into the frame buffer. */
+ if (fb_op == FB_WRITE) {
+ fb_op = FB_FORMAT;
+ trigger_id_led();
+ } else {
+ /* FIXME An overrun happend. What should we do? */
+ frame_overruns++;
+ trigger_error_led();
+ }
+
+ /* Go to "hang mode" until next zero-length packet. */
+ protocol_state = PROT_IGNORE;
+ }
+
+ } else {
+ /* FIXME An invalid packet has been received. What should we do? */
+ invalid_frames++;
+ trigger_error_led();
+ protocol_state = PROT_IGNORE; /* go into "hang mode" until next zero-length packet */
+ }
+
+ /* By default, return rx_buf.byte_data . This means if an invalid protocol state is reached ("hang mode"), the next
+ * frame is still written to rx_buf. This is not a problem since whatever garbage is written at that point will be
+ * overwritten before the next buffer transfer. */
+ return rx_buf.byte_data;
+}
+
+void USART1_IRQHandler(void) {
+ /* Since a large amount of data will be shoved down this UART interface we need a more reliable and more efficient
+ * way of framing than just waiting between transmissions.
+ *
+ * This code uses "Consistent Overhead Byte Stuffing" (COBS). For details, see its Wikipedia page[0] or the proper
+ * scientific paper[1] published on it. Roughly, it works like this:
+ *
+ * * A frame is at most 254 bytes in length.
+ * * The null byte 0x00 acts as a frame delimiter. There is no null bytes inside frames.
+ * * Every frame starts with an "overhead" byte indicating the number of non-null payload bytes until the next null
+ * byte in the payload, **plus one**. This means this byte can never be zero.
+ * * Every null byte in the payload is replaced by *its* distance to *its* next null byte as above.
+ *
+ * This means, at any point the receiver can efficiently be synchronized on the next frame boundary by simply
+ * waiting for a null byte. After that, only a simple state machine is necessary to strip the overhead byte and a
+ * counter to then count skip intervals.
+ *
+ * Here is Wikipedia's table of example values:
+ *
+ * Unencoded data Encoded with COBS
+ * 00 01 01 00
+ * 00 00 01 01 01 00
+ * 11 22 00 33 03 11 22 02 33 00
+ * 11 22 33 44 05 11 22 33 44 00
+ * 11 00 00 00 02 11 01 01 01 00
+ * 01 02 ...FE FF 01 02 ...FE 00
+ *
+ * [0] https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing
+ * [1] Cheshire, Stuart; Baker, Mary (1999). "Consistent Overhead Byte Stuffing"
+ * IEEE/ACM Transactions on Networking. doi:10.1109/90.769765
+ * http://www.stuartcheshire.org/papers/COBSforToN.pdf
+ */
+
+ /* This pointer stores where we write data. The higher-level protocol logic decides on a frame-by-frame-basis where
+ * the next frame's data will be stored. */
+ static volatile uint8_t *writep = rx_buf.byte_data;
+ /* Index inside the current frame payload */
+ static int rxpos = 0;
+ /* COBS state machine. This implementation might be a little too complicated, but it works well enough and I find it
+ * reasonably easy to understand. */
+ static enum {
+ COBS_WAIT_SYNC = 0, /* Synchronize with frame */
+ COBS_WAIT_START = 1, /* Await overhead byte */
+ COBS_RUNNING = 2 /* Process payload */
+ } cobs_state = 0;
+ /* COBS skip counter. During payload processing this contains the remaining non-null payload bytes */
+ static int cobs_count = 0;
+
+ if (USART1->ISR & USART_ISR_ORE) { /* Overrun handling */
+ uart_overruns++;
+ trigger_error_led();
+ /* Reset and re-synchronize. Retry next frame. */
+ rxpos = 0;
+ cobs_state = COBS_WAIT_SYNC;
+ /* Clear interrupt flag */
+ USART1->ICR = USART_ICR_ORECF;
+
+ } else { /* Data received */
+ uint8_t data = USART1->RDR; /* This automatically acknowledges the IRQ */
+
+ if (data == 0x00) { /* End-of-packet */
+ /* Process higher protocol layers on this packet. */
+ writep = packet_received(rxpos);
+
+ /* Reset for next packet. */
+ cobs_state = COBS_WAIT_START;
+ rxpos = 0;
+
+ } else { /* non-null byte */
+ if (cobs_state == COBS_WAIT_SYNC) { /* Wait for null byte */
+ /* ignore data */
+
+ } else if (cobs_state == COBS_WAIT_START) { /* Overhead byte */
+ cobs_count = data;
+ cobs_state = COBS_RUNNING;
+
+ } else { /* Payload byte */
+ if (--cobs_count == 0) { /* Skip byte */
+ cobs_count = data;
+ data = 0;
+ }
+
+ /* Write processed payload byte to current receive buffer */
+ writep[rxpos++] = data;
+ }
+ }
+ }
+}
+
diff --git a/fw/serial.h b/fw/serial.h
new file mode 100644
index 0000000..509c742
--- /dev/null
+++ b/fw/serial.h
@@ -0,0 +1,64 @@
+/* Megumin LED display firmware
+ * Copyright (C) 2018 Sebastian Götte <code@jaseg.net>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __SERIAL_H__
+#define __SERIAL_H__
+
+#include "global.h"
+#include "display.h"
+
+/* High-level stuff */
+void serial_init(void);
+void send_status_reply(void);
+
+/* Internal low-level stuff */
+void tx_char(uint8_t c);
+void send_frame_formatted(uint8_t *buf, int len);
+volatile uint8_t *packet_received(int len);
+
+/* Error counters for debugging */
+extern unsigned int uart_overruns;
+extern unsigned int frame_overruns;
+extern unsigned int invalid_frames;
+
+union tx_buf_union {
+ struct __attribute__((packed)) {
+ uint8_t firmware_version,
+ hardware_version,
+ digit_rows,
+ digit_cols;
+ uint32_t uptime_s,
+ framerate_millifps,
+ uart_overruns,
+ frame_overruns,
+ invalid_frames;
+ int16_t vcc_mv,
+ temp_celsius;
+ uint8_t nbits;
+ } desc_reply;
+ uint8_t byte_data[0];
+};
+
+union rx_buf_union {
+ struct __attribute__((packed)) { struct framebuf fb; uint8_t end[0]; } set_fb_rq;
+ struct __attribute__((packed)) { uint8_t nbits; uint8_t end[0]; } set_nbits_rq;
+ uint8_t byte_data[0];
+ uint32_t mac_data;
+};
+extern volatile union rx_buf_union rx_buf;
+
+#endif/*__SERIAL_H__*/