From: Jonathan McDowell Date: Wed, 8 Feb 2017 22:14:44 +0000 (+0000) Subject: Initial check-in of ESP8266 / MAX7219 NTP backed LED clock X-Git-Url: https://the.earth.li/gitweb/?a=commitdiff_plain;h=a6b9bc4387fe370b7a3cddac157b1b9137847f30;p=esp8266-clock.git Initial check-in of ESP8266 / MAX7219 NTP backed LED clock --- a6b9bc4387fe370b7a3cddac157b1b9137847f30 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..45eb11d --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +project_config.h +*.o +clock_app.a +clock.elf +clock-*.bin diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..3e0ffec --- /dev/null +++ b/Makefile @@ -0,0 +1,38 @@ +SDKDIR ?= /opt/esp8266-sdk + +AR = $(SDKDIR)/bin/xtensa-lx106-elf-ar +CC = $(SDKDIR)/bin/xtensa-lx106-elf-gcc +LD = $(SDKDIR)/bin/xtensa-lx106-elf-gcc +OBJCOPY = $(SDKDIR)/bin/xtensa-lx106-elf-objcopy +OBJDUMP = $(SDKDIR)/bin/xtensa-lx106-elf-objdump + +LIBS = -lc -lhal -lphy -lpp -lnet80211 -llwip -lwpa -lmain + +LD_SCRIPT = eagle.app.v6.ld + +CFLAGS = -Wall -Os -fno-inline-functions -mlongcalls -DICACHE_FLASH -I. +LDFLAGS = -nostdlib -Wl,--no-check-sections -u call_user_start -Wl,-static + +APP = clock +OBJS = user_main.o max7219.o spi.o clock.o + +$(APP)-0x00000.bin: $(APP).elf + PATH=$$PATH:$(SDKDIR)/bin esptool.py elf2image $^ -o $(APP)- + +$(APP).elf: $(APP)_app.a + $(LD) -T$(LD_SCRIPT) $(LDFLAGS) -Wl,--start-group $(LIBS) $^ -Wl,--end-group -lgcc -o $@ + $(OBJDUMP) -h -j .data -j .rodata -j .bss -j .text -j .irom0.text $@ + +$(APP)_app.a: project_config.h $(OBJS) + $(AR) cru $@ $^ + +flash: $(APP)-0x00000.bin $(APP)-0x10000.bin + $(SDKDIR)/bin/esptool.py write_flash 0 $(APP)-0x00000.bin 0x10000 $(APP)-0x10000.bin + +project_config.h: + echo '#error "Edit this file to match your configuration."' > $@ + echo '#define CFG_WIFI_SSID "My Wifi"' >> $@ + echo '#define CFG_WIFI_PASSWORD "password"' >> $@ + +clean: + rm -f $(OBJS) $(APP)_app.a $(APP).elf $(APP)-0x00000.bin $(APP)-0x10000.bin diff --git a/clock.c b/clock.c new file mode 100644 index 0000000..02bc1b5 --- /dev/null +++ b/clock.c @@ -0,0 +1,187 @@ +/* + * Copyright 2017 Jonathan McDowell + * + * 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 . + * + * NTP code based on https://github.com/raburton/esp8266/tree/master/ntp + * Those portions MIT licensed: + * + * Copyright (c) 2015 Richard A Burton (richardaburton@gmail.com) + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ +#include + +#include +#include +#include +#include + +#include "espmissingincludes.h" + +#include "clock.h" + +#define NTP_TIMEOUT_MS 5000 + +static uint32_t sys_last_ticks; +static uint32_t sys_delta; +static os_timer_t ntp_timeout; +static struct espconn *pCon = NULL; + +uint8 ntp_server[] = {87, 124, 126, 49}; + +typedef struct { + uint8 options; + uint8 stratum; + uint8 poll; + uint8 precision; + uint32 root_delay; + uint32 root_disp; + uint32 ref_id; + uint8 ref_time[8]; + uint8 orig_time[8]; + uint8 recv_time[8]; + uint8 trans_time[8]; +} ntp_t; + +void ICACHE_FLASH_ATTR set_time(uint32_t now) +{ + sys_last_ticks = system_get_time(); + sys_delta = now - (sys_last_ticks / 1000000); +} + +uint32_t ICACHE_FLASH_ATTR get_time(void) +{ + uint32_t sys_ticks; + + sys_ticks = system_get_time(); + if (sys_ticks < sys_last_ticks) { + sys_delta += (1ULL << 32ULL) / 1000000; + } + sys_last_ticks = sys_ticks; + + return sys_ticks / 1000000 + sys_delta; +} + +void ICACHE_FLASH_ATTR breakdown_time(uint32_t time, struct tm *result) +{ + result->tm_sec = time % 60; + time /= 60; + result->tm_min = time % 60; + time /= 60; + result->tm_hour = time % 24; + time /= 24; + + result->tm_year = time / (365 * 4 + 1) * 4 + 70; + time %= 365 * 4 + 1; +} + +static void ICACHE_FLASH_ATTR ntp_udp_timeout(void *arg) { + os_timer_disarm(&ntp_timeout); + os_printf("NTP timeout.\n"); + + // clean up connection + if (pCon) { + espconn_delete(pCon); + os_free(pCon->proto.udp); + os_free(pCon); + pCon = 0; + } +} + +static void ICACHE_FLASH_ATTR ntp_udp_recv(void *arg, char *pdata, + unsigned short len) +{ + uint32_t timestamp; + ntp_t *ntp; + struct tm dt; + + os_printf("Got NTP response.\n"); + + os_timer_disarm(&ntp_timeout); + + // Extract NTP time + ntp = (ntp_t *) pdata; + timestamp = ntp->trans_time[0] << 24 | ntp->trans_time[1] << 16 | + ntp->trans_time[2] << 8 | ntp->trans_time[3]; + // Convert to Unix time ms + timestamp -= 2208988800ULL; + + // Store the time + set_time(timestamp); + + // Print it out + breakdown_time(timestamp, &dt); + os_printf("%04d %02d:%02d:%02d (%u)\r\n", dt.tm_year, dt.tm_hour, + dt.tm_min, dt.tm_sec, timestamp); + + // clean up connection + if (pCon) { + espconn_delete(pCon); + os_free(pCon->proto.udp); + os_free(pCon); + pCon = NULL; + } +} + +void ICACHE_FLASH_ATTR ntp_get_time(void) +{ + ntp_t ntp; + + os_printf("Sending NTP request.\n"); + + // Set up the UDP "connection" + pCon = (struct espconn *) os_zalloc(sizeof(struct espconn)); + pCon->type = ESPCONN_UDP; + pCon->state = ESPCONN_NONE; + pCon->proto.udp = (esp_udp *) os_zalloc(sizeof(esp_udp)); + pCon->proto.udp->local_port = espconn_port(); + pCon->proto.udp->remote_port = 123; + os_memcpy(pCon->proto.udp->remote_ip, ntp_server, 4); + + // Create a really simple NTP request packet + os_memset(&ntp, 0, sizeof(ntp_t)); + ntp.options = 0b00100011; // leap = 0, version = 4, mode = 3 (client) + + // Set timeout timer + os_timer_disarm(&ntp_timeout); + os_timer_setfn(&ntp_timeout, (os_timer_func_t*) ntp_udp_timeout, pCon); + os_timer_arm(&ntp_timeout, NTP_TIMEOUT_MS, 0); + + // Send the NTP request + espconn_create(pCon); + espconn_regist_recvcb(pCon, ntp_udp_recv); + espconn_sent(pCon, (uint8_t *) &ntp, sizeof(ntp_t)); +} + +void ICACHE_FLASH_ATTR rtc_init(void) +{ + sys_last_ticks = system_get_time(); +} diff --git a/clock.h b/clock.h new file mode 100644 index 0000000..26c1e64 --- /dev/null +++ b/clock.h @@ -0,0 +1,38 @@ +/* + * Copyright 2017 Jonathan McDowell + * + * 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 . + */ +#ifndef _CLOCK_H_ +#define _CLOCK_H_ + +struct tm { + int tm_sec; + int tm_min; + int tm_hour; + int tm_mday; + int tm_mon; + int tm_year; + int tm_wday; + int tm_yday; + int tm_isdst; +}; + +void rtc_init(void); +void set_time(uint32_t now); +uint32_t get_time(void); +void breakdown_time(uint32_t time, struct tm *result); +void ICACHE_FLASH_ATTR ntp_get_time(void); + +#endif /* _CLOCK_H_ */ diff --git a/espmissingincludes.h b/espmissingincludes.h new file mode 100644 index 0000000..1469c89 --- /dev/null +++ b/espmissingincludes.h @@ -0,0 +1,87 @@ +/* + * Taken from https://github.com/Spritetm/libesphttpd/tree/master/include/ + * + * Potentially originally from Martin Harizanov (http://harizanov.com/) + * and the ESP8266 community. + */ +#ifndef ESPMISSINGINCLUDES_H +#define ESPMISSINGINCLUDES_H + +#include +#include + +int strcasecmp(const char *a, const char *b); +#ifndef FREERTOS +#include +#include +// Missing function prototypes in include folders. GCC will warn on these if +// we don't define 'em anywhere. +// MOST OF THESE ARE GUESSED! but they seem to work and shut up the compiler. +typedef struct espconn espconn; + +int atoi(const char *nptr); +void ets_install_putc1(void *routine); +void ets_isr_attach(int intr, void *handler, void *arg); +void ets_isr_mask(unsigned intr); +void ets_isr_unmask(unsigned intr); +int ets_memcmp(const void *s1, const void *s2, size_t n); +void *ets_memcpy(void *dest, const void *src, size_t n); +void *ets_memset(void *s, int c, size_t n); +int ets_sprintf(char *str, const char *format, ...) + __attribute__ ((format (printf, 2, 3))); +int ets_str2macaddr(void *, void *); +int ets_strcmp(const char *s1, const char *s2); +char *ets_strcpy(char *dest, const char *src); +size_t ets_strlen(const char *s); +int ets_strncmp(const char *s1, const char *s2, int len); +char *ets_strncpy(char *dest, const char *src, size_t n); +char *ets_strstr(const char *haystack, const char *needle); +void ets_timer_arm_new(os_timer_t *a, int b, int c, int isMstimer); +void ets_timer_disarm(os_timer_t *a); +void ets_timer_setfn(os_timer_t *t, ETSTimerFunc *fn, void *parg); +void ets_update_cpu_frequency(int freqmhz); +void *os_memmove(void *dest, const void *src, size_t n); +int os_printf(const char *format, ...) + __attribute__ ((format (printf, 1, 2))); +int os_snprintf(char *str, size_t size, const char *format, ...) + __attribute__ ((format (printf, 3, 4))); +int os_printf_plus(const char *format, ...) + __attribute__ ((format (printf, 1, 2))); +void uart_div_modify(int no, unsigned int freq); +uint8 wifi_get_opmode(void); +uint32 system_get_time(); +int rand(void); +void ets_bzero(void *s, size_t n); +void ets_delay_us(int ms); + +// Hack: this is defined in SDK 1.4.0 and undefined in 1.3.0. It's only used +// for this, the symbol itself has no meaning here. +#ifndef RC_LIMIT_P2P_11N +// Defs for SDK <1.4.0 +void *pvPortMalloc(size_t xWantedSize); +void *pvPortZalloc(size_t); +void vPortFree(void *ptr); +void *vPortMalloc(size_t xWantedSize); +void pvPortFree(void *ptr); +#else +void *pvPortMalloc(size_t xWantedSize, const char *file, int line); +void *pvPortZalloc(size_t, const char *file, int line); +void vPortFree(void *ptr, const char *file, int line); +void *vPortMalloc(size_t xWantedSize, const char *file, int line); +void pvPortFree(void *ptr, const char *file, int line); +#endif + +// Standard PIN_FUNC_SELECT gives a warning. Replace by a non-warning one. +#ifdef PIN_FUNC_SELECT +#undef PIN_FUNC_SELECT +#define PIN_FUNC_SELECT(PIN_NAME, FUNC) do { \ + WRITE_PERI_REG(PIN_NAME, \ + (READ_PERI_REG(PIN_NAME) \ + & (~(PERIPHS_IO_MUX_FUNC<) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x01, 0x02, 0x04, 0x02, 0x01, 0x00, } }, + /* 63 (?) */ + { .width = 3, + .bitmap = { 0x00, 0x02, 0x05, 0x04, 0x02, 0x00, 0x02, 0x00, } }, + /* 64 (@) */ + { .width = 3, + .bitmap = { 0x00, 0x02, 0x05, 0x05, 0x01, 0x01, 0x06, 0x00, } }, + /* 65 (A) */ + { .width = 3, + .bitmap = { 0x00, 0x02, 0x05, 0x05, 0x07, 0x05, 0x05, 0x00, } }, + /* 66 (B) */ + { .width = 3, + .bitmap = { 0x00, 0x03, 0x05, 0x03, 0x05, 0x05, 0x03, 0x00, } }, + /* 67 (C) */ + { .width = 3, + .bitmap = { 0x00, 0x02, 0x05, 0x01, 0x01, 0x05, 0x02, 0x00, } }, + /* 68 (D) */ + { .width = 3, + .bitmap = { 0x00, 0x03, 0x05, 0x05, 0x05, 0x05, 0x03, 0x00, } }, + /* 69 (E) */ + { .width = 3, + .bitmap = { 0x00, 0x07, 0x01, 0x07, 0x01, 0x01, 0x07, 0x00, } }, + /* 70 (F) */ + { .width = 3, + .bitmap = { 0x00, 0x07, 0x01, 0x07, 0x01, 0x01, 0x01, 0x00, } }, + /* 71 (G) */ + { .width = 3, + .bitmap = { 0x00, 0x02, 0x05, 0x01, 0x05, 0x05, 0x02, 0x00, } }, + /* 72 (H) */ + { .width = 3, + .bitmap = { 0x00, 0x05, 0x05, 0x07, 0x05, 0x05, 0x05, 0x00, } }, + /* 73 (I) */ + { .width = 3, + .bitmap = { 0x00, 0x07, 0x02, 0x02, 0x02, 0x02, 0x07, 0x00, } }, + /* 74 (J) */ + { .width = 3, + .bitmap = { 0x00, 0x04, 0x04, 0x04, 0x04, 0x05, 0x02, 0x00, } }, + /* 75 (K) */ + { .width = 3, + .bitmap = { 0x00, 0x05, 0x05, 0x03, 0x05, 0x05, 0x05, 0x00, } }, + /* 76 (L) */ + { .width = 3, + .bitmap = { 0x00, 0x01, 0x01, 0x01, 0x01, 0x01, 0x07, 0x00, } }, + /* 77 (M) */ + { .width = 3, + .bitmap = { 0x00, 0x05, 0x07, 0x05, 0x05, 0x05, 0x05, 0x00, } }, + /* 78 (N) */ + { .width = 3, + .bitmap = { 0x00, 0x04, 0x05, 0x07, 0x07, 0x05, 0x01, 0x00, } }, + /* 79 (O) */ + { .width = 3, + .bitmap = { 0x00, 0x02, 0x05, 0x05, 0x05, 0x05, 0x02, 0x00, } }, + /* 80 (P) */ + { .width = 3, + .bitmap = { 0x00, 0x03, 0x05, 0x05, 0x03, 0x01, 0x01, 0x00, } }, + /* 81 (Q) */ + { .width = 3, + .bitmap = { 0x00, 0x02, 0x05, 0x05, 0x05, 0x03, 0x06, 0x00, } }, + /* 82 (R) */ + { .width = 3, + .bitmap = { 0x00, 0x03, 0x05, 0x05, 0x03, 0x05, 0x05, 0x00, } }, + /* 83 (S) */ + { .width = 3, + .bitmap = { 0x00, 0x02, 0x05, 0x02, 0x04, 0x05, 0x02, 0x00, } }, + /* 84 (T) */ + { .width = 3, + .bitmap = { 0x00, 0x07, 0x02, 0x02, 0x02, 0x02, 0x02, 0x00, } }, + /* 85 (U) */ + { .width = 3, + .bitmap = { 0x00, 0x05, 0x05, 0x05, 0x05, 0x05, 0x07, 0x00, } }, + /* 86 (V) */ + { .width = 3, + .bitmap = { 0x00, 0x05, 0x05, 0x05, 0x05, 0x05, 0x02, 0x00, } }, + /* 87 (W) */ + { .width = 3, + .bitmap = { 0x00, 0x05, 0x05, 0x05, 0x05, 0x07, 0x05, 0x00, } }, + /* 88 (X) */ + { .width = 3, + .bitmap = { 0x00, 0x05, 0x05, 0x02, 0x05, 0x05, 0x05, 0x00, } }, + /* 89 (Y) */ + { .width = 3, + .bitmap = { 0x00, 0x05, 0x05, 0x02, 0x02, 0x02, 0x02, 0x00, } }, + /* 90 (Z) */ + { .width = 3, + .bitmap = { 0x00, 0x07, 0x04, 0x02, 0x02, 0x01, 0x07, 0x00, } }, + /* 91 ([) */ + { .width = 2, + .bitmap = { 0x00, 0x03, 0x01, 0x01, 0x01, 0x01, 0x03, 0x00, } }, + /* 92 (\) */ + { .width = 3, + .bitmap = { 0x00, 0x01, 0x01, 0x02, 0x02, 0x04, 0x04, 0x00, } }, + /* 93 (]) */ + { .width = 2, + .bitmap = { 0x00, 0x03, 0x02, 0x02, 0x02, 0x02, 0x03, 0x00, } }, + /* 94 (^) */ + { .width = 3, + .bitmap = { 0x00, 0x02, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00, } }, + /* 95 (_) */ + { .width = 4, + .bitmap = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0F, } }, + /* 96 (`) */ + { .width = 2, + .bitmap = { 0x00, 0x01, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, } }, + /* 97 (a) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x03, 0x04, 0x06, 0x05, 0x06, 0x00, } }, + /* 98 (b) */ + { .width = 3, + .bitmap = { 0x00, 0x01, 0x01, 0x03, 0x05, 0x05, 0x03, 0x00, } }, + /* 99 (c) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x06, 0x01, 0x01, 0x01, 0x06, 0x00, } }, + /* 100 (d) */ + { .width = 3, + .bitmap = { 0x00, 0x04, 0x04, 0x06, 0x05, 0x05, 0x06, 0x00, } }, + /* 101 (e) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x02, 0x05, 0x07, 0x01, 0x06, 0x00, } }, + /* 102 (f) */ + { .width = 3, + .bitmap = { 0x00, 0x04, 0x02, 0x07, 0x02, 0x02, 0x02, 0x00, } }, + /* 103 (g) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x06, 0x05, 0x05, 0x06, 0x04, 0x03, } }, + /* 104 (h) */ + { .width = 3, + .bitmap = { 0x00, 0x01, 0x01, 0x03, 0x05, 0x05, 0x05, 0x00, } }, + /* 105 (i) */ + { .width = 3, + .bitmap = { 0x00, 0x02, 0x00, 0x03, 0x02, 0x02, 0x07, 0x00, } }, + /* 106 (j) */ + { .width = 3, + .bitmap = { 0x00, 0x04, 0x00, 0x06, 0x04, 0x04, 0x04, 0x03, } }, + /* 107 (k) */ + { .width = 3, + .bitmap = { 0x00, 0x01, 0x01, 0x05, 0x03, 0x05, 0x05, 0x00, } }, + /* 108 (l) */ + { .width = 1, + .bitmap = { 0x00, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x00, } }, + /* 109 (m) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x05, 0x07, 0x05, 0x05, 0x05, 0x00, } }, + /* 110 (n) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x03, 0x05, 0x05, 0x05, 0x05, 0x00, } }, + /* 111 (o) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x02, 0x05, 0x05, 0x05, 0x02, 0x00, } }, + /* 112 (p) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x03, 0x05, 0x05, 0x03, 0x01, 0x01, } }, + /* 113 (q) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x06, 0x05, 0x05, 0x06, 0x04, 0x04, } }, + /* 114 (r) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x06, 0x01, 0x01, 0x01, 0x01, 0x00, } }, + /* 115 (s) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x06, 0x01, 0x02, 0x04, 0x03, 0x00, } }, + /* 116 (t) */ + { .width = 3, + .bitmap = { 0x00, 0x02, 0x02, 0x07, 0x02, 0x02, 0x02, 0x00, } }, + /* 117 (u) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x05, 0x05, 0x05, 0x05, 0x07, 0x00, } }, + /* 118 (v) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x05, 0x05, 0x05, 0x05, 0x02, 0x00, } }, + /* 119 (w) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x05, 0x05, 0x05, 0x07, 0x05, 0x00, } }, + /* 120 (x) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x05, 0x05, 0x02, 0x05, 0x05, 0x00, } }, + /* 121 (y) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x05, 0x05, 0x05, 0x06, 0x04, 0x03, } }, + /* 122 (z) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x07, 0x04, 0x02, 0x01, 0x07, 0x00, } }, + /* 123 ({) */ + { .width = 3, + .bitmap = { 0x04, 0x02, 0x02, 0x01, 0x02, 0x02, 0x04, 0x00, } }, + /* 124 (|) */ + { .width = 1, + .bitmap = { 0x01, 0x01, 0x01, 0x00, 0x01, 0x01, 0x01, 0x00, } }, + /* 125 (}) */ + { .width = 3, + .bitmap = { 0x01, 0x02, 0x02, 0x04, 0x02, 0x02, 0x01, 0x00, } }, + /* 126 (~) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x03, 0x06, 0x00, 0x00, 0x00, 0x00, } }, + /* 127 (C177) */ + { .width = 3, + .bitmap = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, } }, +}; diff --git a/max7219.c b/max7219.c new file mode 100644 index 0000000..12c559e --- /dev/null +++ b/max7219.c @@ -0,0 +1,185 @@ +/* + * Copyright 2017 Jonathan McDowell + * + * 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 . + */ +#include +#include +#include + +#include +#include +#include +#include + +#include "espmissingincludes.h" +#include "max7219.h" +#include "spi.h" + +/* This is a small 8x4 font */ +#include "font-atari.h" + +/* The number of 8x8 displays we have daisy chained together */ +#define MAX7219_WIDTH 4 + +enum max7129_regs { + NOOP = 0, + ROW7 = 1, + ROW6 = 2, + ROW5 = 3, + ROW4 = 4, + ROW3 = 5, + ROW2 = 6, + ROW1 = 7, + ROW0 = 8, + DECODEMODE = 9, + INTENSITY = 10, + SCANLIMIT = 11, + SHUTDOWN = 12, + DISPLAYTEST = 15, +}; + +struct max7219_ctx { + unsigned int width; + unsigned int cs; + uint8_t buf[8 * MAX7219_WIDTH]; +}; + +/* Runtime context */ +static struct max7219_ctx ctx; + +static void ICACHE_FLASH_ATTR max7219_write_reg(uint8_t reg, uint8_t data) +{ + int block; + + /* Set CS low */ + gpio_output_set(0, ctx.cs, ctx.cs, 0); + for (block = 0; block < ctx.width; block++) { + spi_write(1, ®); + spi_write(1, &data); + } + /* Set CS high to latch data into MAX7219 */ + gpio_output_set(ctx.cs, 0, ctx.cs, 0); + ets_delay_us(10); +} + +void ICACHE_FLASH_ATTR max7219_set_pixel(unsigned int x, unsigned int y, + bool set) +{ + unsigned int block; + + block = x & 0x38; + x = x & 7; + + if (set) { + ctx.buf[y + block] |= 1 << x; + } else { + ctx.buf[y + block] &= ~(1 << x); + } +} + +void ICACHE_FLASH_ATTR max7219_blit(unsigned int x, unsigned int y, + const uint8_t *data, unsigned int width, unsigned int height) +{ + unsigned int block = x & 0x38; + unsigned int left_shift = x & 7; + bool twoblocks = ((left_shift + width) > 8) && + ((x + width) < (ctx.width * 8)); + unsigned int right_shift; + unsigned int row; + + if (block >= (ctx.width << 3)) { + /* We're off the right hand side; do nothing */ + return; + } + + if (twoblocks) { + if (block > (ctx.width << 3)) { + /* 2nd block is off the edge; ignore it */ + twoblocks = false; + } else { + right_shift = (8 - left_shift); + } + } + + for (row = 0; row < height; row++) + { + if ((y + row) > 7) { + break; + } + ctx.buf[y + row + block] |= ((data[row] << left_shift) & 0xFF); + if (twoblocks) { + ctx.buf[y + row + (block + 8)] |= + (data[row] >> right_shift); + } + } +} + +void ICACHE_FLASH_ATTR max7219_clear(void) +{ + int i; + + for (i = 0; i < ctx.width * 8;i++) + ctx.buf[i] = 0; +} + +void ICACHE_FLASH_ATTR max7219_show(void) +{ + int y, block; + uint8_t data[2]; + + for (y = 0; y < 8; y++) { + /* Set CS low */ + gpio_output_set(0, ctx.cs, ctx.cs, 0); + for (block = ctx.width - 1; block >= 0; block--) { + data[0] = 8 - y; /* Row reg */ + data[1] = ctx.buf[y + (block << 3)]; /* Pixel val */ + spi_write(2, data); + } + /* Set CS high to latch data into MAX7219 */ + gpio_output_set(ctx.cs, 0, ctx.cs, 0); + ets_delay_us(10); + } +} + +void ICACHE_FLASH_ATTR max7219_print(const char *str) +{ + int x = 0; + unsigned char cur; + + while ((cur = (unsigned char) *str++) && x < (ctx.width * 8)) { + if ((cur > 31) && (cur < 127)) { + cur -= 32; + max7219_blit(x, 0, font[cur].bitmap, + font[cur].width, 8); + x += font[cur].width + 1; + } + } +} + +void ICACHE_FLASH_ATTR max7219_init(unsigned int cs) +{ + ctx.width = MAX7219_WIDTH; + ctx.cs = cs; + + max7219_write_reg(SHUTDOWN, 0); + max7219_write_reg(DISPLAYTEST, 0); + max7219_write_reg(SCANLIMIT, 7); + max7219_write_reg(DECODEMODE, 0); + max7219_write_reg(INTENSITY, 0); + max7219_write_reg(SHUTDOWN, 1); + + max7219_clear(); + max7219_show(); +} diff --git a/max7219.h b/max7219.h new file mode 100644 index 0000000..46ae112 --- /dev/null +++ b/max7219.h @@ -0,0 +1,34 @@ +/* + * Copyright 2017 Jonathan McDowell + * + * 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 . + */ +#ifndef _MAX7219_H_ +#define _MAX7219_H_ + +struct fontchar { + uint8_t width; + uint8_t bitmap[8]; +}; + +void ICACHE_FLASH_ATTR max7219_set_pixel(unsigned int x, unsigned int y, + bool set); +void ICACHE_FLASH_ATTR max7219_blit(unsigned int x, unsigned int y, + const uint8_t *data, unsigned int width, unsigned int height); +void ICACHE_FLASH_ATTR max7219_clear(void); +void ICACHE_FLASH_ATTR max7219_print(const char *str); +void ICACHE_FLASH_ATTR max7219_show(void); +void ICACHE_FLASH_ATTR max7219_init(unsigned int cs); + +#endif /* _MAX7219_H_ */ diff --git a/spi.c b/spi.c new file mode 100644 index 0000000..dd3d971 --- /dev/null +++ b/spi.c @@ -0,0 +1,89 @@ +/* + * Copyright 2017 Jonathan McDowell + * + * 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 . + */ +#include + +#include +#include + +#include "spi_register.h" + +#define spi_busy(spi_no) (READ_PERI_REG(SPI_CMD(spi_no)) & SPI_USR) + +#define SPI 0 +#define HSPI 1 + +void ICACHE_FLASH_ATTR spi_init(void) +{ + /* SPI clock = CPU clock/160 [(79 + 1) * 2]= 500KHz */ + WRITE_PERI_REG(SPI_CLOCK(HSPI), + ((79 & SPI_CLKDIV_PRE) << SPI_CLKDIV_PRE_S) | + ((1 & SPI_CLKCNT_N) << SPI_CLKCNT_N_S) | + ((1 & SPI_CLKCNT_H) << SPI_CLKCNT_H_S) | + ((0 & SPI_CLKCNT_L) << SPI_CLKCNT_L_S)); + + /* + * We use hardware SPI, but repurpose MISO for CS, as we don't need it. + */ + WRITE_PERI_REG(PERIPHS_IO_MUX, 0x105); + PIN_FUNC_SELECT(PERIPHS_IO_MUX_MTCK_U, 2); /* GPIO13: MOSI */ + PIN_FUNC_SELECT(PERIPHS_IO_MUX_MTMS_U, 2); /* GPIO14: CLK */ + /* FIXME: CS/SS is not this pin */ + PIN_FUNC_SELECT(PERIPHS_IO_MUX_MTDO_U, 2); /* GPIO15 */ + /* We don't use MISO, repurpose this pin for GPIO12 (used as CS) */ + PIN_FUNC_SELECT(PERIPHS_IO_MUX_MTDI_U, FUNC_GPIO12); + PIN_PULLUP_DIS(PERIPHS_IO_MUX_MTDI_U); + gpio_output_set(0, 0, BIT12, 0); + + /* Configure up our SPI options */ + SET_PERI_REG_MASK(SPI_USER(HSPI), + SPI_WR_BYTE_ORDER | /* MSB output first */ + SPI_USR_MOSI /* Enable data (MOSI) output */ + ); + CLEAR_PERI_REG_MASK(SPI_USER(HSPI), + SPI_FLASH_MODE | /* Disable flash mode */ + SPI_USR_MISO | SPI_USR_COMMAND | + SPI_USR_ADDR | SPI_USR_DUMMY | /* Disable non-data output */ + SPI_CS_SETUP | SPI_CS_HOLD | /* We drive our own CS */ + SPI_CK_OUT_EDGE /* Data valid on CLK leading */ + ); + /* Clock low when inactive */ + CLEAR_PERI_REG_MASK(SPI_PIN(HSPI), SPI_IDLE_EDGE); + + /* We're writing 8 bits at a time */ + /* TODO: We could write up to 32 bits at once potentially. */ + WRITE_PERI_REG(SPI_USER1(HSPI), + (7 & SPI_USR_MOSI_BITLEN) << SPI_USR_MOSI_BITLEN_S); +} + +void ICACHE_FLASH_ATTR spi_write(size_t len, uint8_t *data) +{ + int i; + + for (i = 0; i < len; i++) { + /* Wait for SPI to be ready */ + while (spi_busy(HSPI)); + + /* We just write the top 8 bits of the 32 bit value */ + WRITE_PERI_REG(SPI_W0(HSPI), data[i] << 24); + + /* Begin the SPI transaction */ + SET_PERI_REG_MASK(SPI_CMD(HSPI), SPI_USR); + } + + /* Don't return until it's done */ + while (spi_busy(HSPI)); +} diff --git a/spi.h b/spi.h new file mode 100644 index 0000000..7884712 --- /dev/null +++ b/spi.h @@ -0,0 +1,23 @@ +/* + * Copyright 2017 Jonathan McDowell + * + * 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 . + */ +#ifndef _SPI_H_ +#define _SPI_H_ + +void ICACHE_FLASH_ATTR spi_init(void); +void ICACHE_FLASH_ATTR spi_write(size_t len, uint8_t *data); + +#endif /* _SPI_H_ */ diff --git a/spi_register.h b/spi_register.h new file mode 100644 index 0000000..53ee910 --- /dev/null +++ b/spi_register.h @@ -0,0 +1,280 @@ +/* + * Copyright (c) 2010 - 2011 Espressif System + * Modified by David Ogilvy (MetalPhreak) + * Based on original file included in SDK 1.0.0 + * + * Missing defines from previous SDK versions have + * been added and are noted with comments. The + * names of these defines are likely to change. + */ + +#ifndef SPI_REGISTER_H_INCLUDED +#define SPI_REGISTER_H_INCLUDED + +#define REG_SPI_BASE(i) (0x60000200-i*0x100) + +#define SPI_CMD(i) (REG_SPI_BASE(i) + 0x0) +#define SPI_FLASH_READ (BIT(31)) //From previous SDK +#define SPI_FLASH_WREN (BIT(30)) //From previous SDK +#define SPI_FLASH_WRDI (BIT(29)) //From previous SDK +#define SPI_FLASH_RDID (BIT(28)) //From previous SDK +#define SPI_FLASH_RDSR (BIT(27)) //From previous SDK +#define SPI_FLASH_WRSR (BIT(26)) //From previous SDK +#define SPI_FLASH_PP (BIT(25)) //From previous SDK +#define SPI_FLASH_SE (BIT(24)) //From previous SDK +#define SPI_FLASH_BE (BIT(23)) //From previous SDK +#define SPI_FLASH_CE (BIT(22)) //From previous SDK +#define SPI_FLASH_DP (BIT(21)) //From previous SDK +#define SPI_FLASH_RES (BIT(20)) //From previous SDK +#define SPI_FLASH_HPM (BIT(19)) //From previous SDK +#define SPI_USR (BIT(18)) + +#define SPI_ADDR(i) (REG_SPI_BASE(i) + 0x4) + +#define SPI_CTRL(i) (REG_SPI_BASE(i) + 0x8) +#define SPI_WR_BIT_ORDER (BIT(26)) +#define SPI_RD_BIT_ORDER (BIT(25)) +#define SPI_QIO_MODE (BIT(24)) +#define SPI_DIO_MODE (BIT(23)) +#define SPI_TWO_BYTE_STATUS_EN (BIT(22)) //From previous SDK +#define SPI_WP_REG (BIT(21)) //From previous SDK +#define SPI_QOUT_MODE (BIT(20)) +#define SPI_SHARE_BUS (BIT(19)) //From previous SDK +#define SPI_HOLD_MODE (BIT(18)) //From previous SDK +#define SPI_ENABLE_AHB (BIT(17)) //From previous SDK +#define SPI_SST_AAI (BIT(16)) //From previous SDK +#define SPI_RESANDRES (BIT(15)) //From previous SDK +#define SPI_DOUT_MODE (BIT(14)) +#define SPI_FASTRD_MODE (BIT(13)) + +#define SPI_CTRL1(i) (REG_SPI_BASE (i) + 0xC) //From previous SDK. Removed _FLASH_ from name to match other registers. +#define SPI_CS_HOLD_DELAY 0x0000000F //Espressif BBS +#define SPI_CS_HOLD_DELAY_S 28 //Espressif BBS +#define SPI_CS_HOLD_DELAY_RES 0x00000FFF //Espressif BBS +#define SPI_CS_HOLD_DELAY_RES_S 16 //Espressif BBS +#define SPI_BUS_TIMER_LIMIT 0x0000FFFF //From previous SDK +#define SPI_BUS_TIMER_LIMIT_S 0 //From previous SDK + + +#define SPI_RD_STATUS(i) (REG_SPI_BASE(i) + 0x10) +#define SPI_STATUS_EXT 0x000000FF //From previous SDK +#define SPI_STATUS_EXT_S 24 //From previous SDK +#define SPI_WB_MODE 0x000000FF //From previous SDK +#define SPI_WB_MODE_S 16 //From previous SDK +#define SPI_FLASH_STATUS_PRO_FLAG (BIT(7)) //From previous SDK +#define SPI_FLASH_TOP_BOT_PRO_FLAG (BIT(5)) //From previous SDK +#define SPI_FLASH_BP2 (BIT(4)) //From previous SDK +#define SPI_FLASH_BP1 (BIT(3)) //From previous SDK +#define SPI_FLASH_BP0 (BIT(2)) //From previous SDK +#define SPI_FLASH_WRENABLE_FLAG (BIT(1)) //From previous SDK +#define SPI_FLASH_BUSY_FLAG (BIT(0)) //From previous SDK + +#define SPI_CTRL2(i) (REG_SPI_BASE(i) + 0x14) +#define SPI_CS_DELAY_NUM 0x0000000F +#define SPI_CS_DELAY_NUM_S 28 +#define SPI_CS_DELAY_MODE 0x00000003 +#define SPI_CS_DELAY_MODE_S 26 +#define SPI_MOSI_DELAY_NUM 0x00000007 +#define SPI_MOSI_DELAY_NUM_S 23 +#define SPI_MOSI_DELAY_MODE 0x00000003 //mode 0 : posedge; data set at positive edge of clk + //mode 1 : negedge + 1 cycle delay, only if freq<10MHz ; data set at negitive edge of clk + //mode 2 : Do not use this mode. +#define SPI_MOSI_DELAY_MODE_S 21 +#define SPI_MISO_DELAY_NUM 0x00000007 +#define SPI_MISO_DELAY_NUM_S 18 +#define SPI_MISO_DELAY_MODE 0x00000003 +#define SPI_MISO_DELAY_MODE_S 16 +#define SPI_CK_OUT_HIGH_MODE 0x0000000F +#define SPI_CK_OUT_HIGH_MODE_S 12 +#define SPI_CK_OUT_LOW_MODE 0x0000000F +#define SPI_CK_OUT_LOW_MODE_S 8 +#define SPI_HOLD_TIME 0x0000000F +#define SPI_HOLD_TIME_S 4 +#define SPI_SETUP_TIME 0x0000000F +#define SPI_SETUP_TIME_S 0 + +#define SPI_CLOCK(i) (REG_SPI_BASE(i) + 0x18) +#define SPI_CLK_EQU_SYSCLK (BIT(31)) +#define SPI_CLKDIV_PRE 0x00001FFF +#define SPI_CLKDIV_PRE_S 18 +#define SPI_CLKCNT_N 0x0000003F +#define SPI_CLKCNT_N_S 12 +#define SPI_CLKCNT_H 0x0000003F +#define SPI_CLKCNT_H_S 6 +#define SPI_CLKCNT_L 0x0000003F +#define SPI_CLKCNT_L_S 0 + +#define SPI_USER(i) (REG_SPI_BASE(i) + 0x1C) +#define SPI_USR_COMMAND (BIT(31)) +#define SPI_USR_ADDR (BIT(30)) +#define SPI_USR_DUMMY (BIT(29)) +#define SPI_USR_MISO (BIT(28)) +#define SPI_USR_MOSI (BIT(27)) +#define SPI_USR_DUMMY_IDLE (BIT(26)) //From previous SDK +#define SPI_USR_MOSI_HIGHPART (BIT(25)) +#define SPI_USR_MISO_HIGHPART (BIT(24)) +#define SPI_USR_PREP_HOLD (BIT(23)) //From previous SDK +#define SPI_USR_CMD_HOLD (BIT(22)) //From previous SDK +#define SPI_USR_ADDR_HOLD (BIT(21)) //From previous SDK +#define SPI_USR_DUMMY_HOLD (BIT(20)) //From previous SDK +#define SPI_USR_DIN_HOLD (BIT(19)) //From previous SDK +#define SPI_USR_DOUT_HOLD (BIT(18)) //From previous SDK +#define SPI_USR_HOLD_POL (BIT(17)) //From previous SDK +#define SPI_SIO (BIT(16)) +#define SPI_FWRITE_QIO (BIT(15)) +#define SPI_FWRITE_DIO (BIT(14)) +#define SPI_FWRITE_QUAD (BIT(13)) +#define SPI_FWRITE_DUAL (BIT(12)) +#define SPI_WR_BYTE_ORDER (BIT(11)) +#define SPI_RD_BYTE_ORDER (BIT(10)) +#define SPI_AHB_ENDIAN_MODE 0x00000003 //From previous SDK +#define SPI_AHB_ENDIAN_MODE_S 8 //From previous SDK +#define SPI_CK_OUT_EDGE (BIT(7)) +#define SPI_CK_I_EDGE (BIT(6)) +#define SPI_CS_SETUP (BIT(5)) +#define SPI_CS_HOLD (BIT(4)) +#define SPI_AHB_USR_COMMAND (BIT(3)) //From previous SDK +#define SPI_FLASH_MODE (BIT(2)) +#define SPI_AHB_USR_COMMAND_4BYTE (BIT(1)) //From previous SDK +#define SPI_DOUTDIN (BIT(0)) //From previous SDK + +//AHB = http://en.wikipedia.org/wiki/Advanced_Microcontroller_Bus_Architecture ? + +#define SPI_USER1(i) (REG_SPI_BASE(i) + 0x20) +#define SPI_USR_ADDR_BITLEN 0x0000003F +#define SPI_USR_ADDR_BITLEN_S 26 +#define SPI_USR_MOSI_BITLEN 0x000001FF +#define SPI_USR_MOSI_BITLEN_S 17 +#define SPI_USR_MISO_BITLEN 0x000001FF +#define SPI_USR_MISO_BITLEN_S 8 +#define SPI_USR_DUMMY_CYCLELEN 0x000000FF +#define SPI_USR_DUMMY_CYCLELEN_S 0 + +#define SPI_USER2(i) (REG_SPI_BASE(i) + 0x24) +#define SPI_USR_COMMAND_BITLEN 0x0000000F +#define SPI_USR_COMMAND_BITLEN_S 28 +#define SPI_USR_COMMAND_VALUE 0x0000FFFF +#define SPI_USR_COMMAND_VALUE_S 0 + +#define SPI_WR_STATUS(i) (REG_SPI_BASE(i) + 0x28) + //previously defined as SPI_FLASH_USER3. No further info available. + +#define SPI_PIN(i) (REG_SPI_BASE(i) + 0x2C) +#define SPI_IDLE_EDGE (BIT(29)) +#define SPI_CS2_DIS (BIT(2)) +#define SPI_CS1_DIS (BIT(1)) +#define SPI_CS0_DIS (BIT(0)) + +#define SPI_SLAVE(i) (REG_SPI_BASE(i) + 0x30) +#define SPI_SYNC_RESET (BIT(31)) +#define SPI_SLAVE_MODE (BIT(30)) +#define SPI_SLV_WR_RD_BUF_EN (BIT(29)) +#define SPI_SLV_WR_RD_STA_EN (BIT(28)) +#define SPI_SLV_CMD_DEFINE (BIT(27)) +#define SPI_TRANS_CNT 0x0000000F +#define SPI_TRANS_CNT_S 23 +#define SPI_SLV_LAST_STATE 0x00000007 //From previous SDK +#define SPI_SLV_LAST_STATE_S 20 //From previous SDK +#define SPI_SLV_LAST_COMMAND 0x00000007 //From previous SDK +#define SPI_SLV_LAST_COMMAND_S 17 //From previous SDK +#define SPI_CS_I_MODE 0x00000003 //From previous SDK +#define SPI_CS_I_MODE_S 10 //From previous SDK +#define SPI_TRANS_DONE_EN (BIT(9)) +#define SPI_SLV_WR_STA_DONE_EN (BIT(8)) +#define SPI_SLV_RD_STA_DONE_EN (BIT(7)) +#define SPI_SLV_WR_BUF_DONE_EN (BIT(6)) +#define SPI_SLV_RD_BUF_DONE_EN (BIT(5)) +#define SLV_SPI_INT_EN 0x0000001f +#define SLV_SPI_INT_EN_S 5 +#define SPI_TRANS_DONE (BIT(4)) +#define SPI_SLV_WR_STA_DONE (BIT(3)) +#define SPI_SLV_RD_STA_DONE (BIT(2)) +#define SPI_SLV_WR_BUF_DONE (BIT(1)) +#define SPI_SLV_RD_BUF_DONE (BIT(0)) + +#define SPI_SLAVE1(i) (REG_SPI_BASE(i) + 0x34) +#define SPI_SLV_STATUS_BITLEN 0x0000001F +#define SPI_SLV_STATUS_BITLEN_S 27 +#define SPI_SLV_STATUS_FAST_EN (BIT(26)) //From previous SDK +#define SPI_SLV_STATUS_READBACK (BIT(25)) //From previous SDK +#define SPI_SLV_BUF_BITLEN 0x000001FF +#define SPI_SLV_BUF_BITLEN_S 16 +#define SPI_SLV_RD_ADDR_BITLEN 0x0000003F +#define SPI_SLV_RD_ADDR_BITLEN_S 10 +#define SPI_SLV_WR_ADDR_BITLEN 0x0000003F +#define SPI_SLV_WR_ADDR_BITLEN_S 4 +#define SPI_SLV_WRSTA_DUMMY_EN (BIT(3)) +#define SPI_SLV_RDSTA_DUMMY_EN (BIT(2)) +#define SPI_SLV_WRBUF_DUMMY_EN (BIT(1)) +#define SPI_SLV_RDBUF_DUMMY_EN (BIT(0)) + + + +#define SPI_SLAVE2(i) (REG_SPI_BASE(i) + 0x38) +#define SPI_SLV_WRBUF_DUMMY_CYCLELEN 0X000000FF +#define SPI_SLV_WRBUF_DUMMY_CYCLELEN_S 24 +#define SPI_SLV_RDBUF_DUMMY_CYCLELEN 0X000000FF +#define SPI_SLV_RDBUF_DUMMY_CYCLELEN_S 16 +#define SPI_SLV_WRSTR_DUMMY_CYCLELEN 0X000000FF +#define SPI_SLV_WRSTR_DUMMY_CYCLELEN_S 8 +#define SPI_SLV_RDSTR_DUMMY_CYCLELEN 0x000000FF +#define SPI_SLV_RDSTR_DUMMY_CYCLELEN_S 0 + +#define SPI_SLAVE3(i) (REG_SPI_BASE(i) + 0x3C) +#define SPI_SLV_WRSTA_CMD_VALUE 0x000000FF +#define SPI_SLV_WRSTA_CMD_VALUE_S 24 +#define SPI_SLV_RDSTA_CMD_VALUE 0x000000FF +#define SPI_SLV_RDSTA_CMD_VALUE_S 16 +#define SPI_SLV_WRBUF_CMD_VALUE 0x000000FF +#define SPI_SLV_WRBUF_CMD_VALUE_S 8 +#define SPI_SLV_RDBUF_CMD_VALUE 0x000000FF +#define SPI_SLV_RDBUF_CMD_VALUE_S 0 + +//Previous SDKs referred to these following registers as SPI_C0 etc. + +#define SPI_W0(i) (REG_SPI_BASE(i) +0x40) +#define SPI_W1(i) (REG_SPI_BASE(i) +0x44) +#define SPI_W2(i) (REG_SPI_BASE(i) +0x48) +#define SPI_W3(i) (REG_SPI_BASE(i) +0x4C) +#define SPI_W4(i) (REG_SPI_BASE(i) +0x50) +#define SPI_W5(i) (REG_SPI_BASE(i) +0x54) +#define SPI_W6(i) (REG_SPI_BASE(i) +0x58) +#define SPI_W7(i) (REG_SPI_BASE(i) +0x5C) +#define SPI_W8(i) (REG_SPI_BASE(i) +0x60) +#define SPI_W9(i) (REG_SPI_BASE(i) +0x64) +#define SPI_W10(i) (REG_SPI_BASE(i) +0x68) +#define SPI_W11(i) (REG_SPI_BASE(i) +0x6C) +#define SPI_W12(i) (REG_SPI_BASE(i) +0x70) +#define SPI_W13(i) (REG_SPI_BASE(i) +0x74) +#define SPI_W14(i) (REG_SPI_BASE(i) +0x78) +#define SPI_W15(i) (REG_SPI_BASE(i) +0x7C) + + // +0x80 to +0xBC could be SPI_W16 through SPI_W31? + + // +0xC0 to +0xEC not currently defined. + +// From previous SDK. Removed _FLASH_ from name to match other registers. +#define SPI_EXT0(i) (REG_SPI_BASE(i) + 0xF0) +#define SPI_T_PP_ENA (BIT(31)) //From previous SDK +#define SPI_T_PP_SHIFT 0x0000000F //From previous SDK +#define SPI_T_PP_SHIFT_S 16 //From previous SDK +#define SPI_T_PP_TIME 0x00000FFF //From previous SDK +#define SPI_T_PP_TIME_S 0 //From previous SDK + +// From previous SDK. Removed _FLASH_ from name to match other registers. +#define SPI_EXT1(i) (REG_SPI_BASE(i) + 0xF4) +#define SPI_T_ERASE_ENA (BIT(31)) //From previous SDK +#define SPI_T_ERASE_SHIFT 0x0000000F //From previous SDK +#define SPI_T_ERASE_SHIFT_S 16 //From previous SDK +#define SPI_T_ERASE_TIME 0x00000FFF //From previous SDK +#define SPI_T_ERASE_TIME_S 0 //From previous SDK + +// From previous SDK. Removed _FLASH_ from name to match other registers. +#define SPI_EXT2(i) (REG_SPI_BASE(i) + 0xF8) +#define SPI_ST 0x00000007 // From previous SDK +#define SPI_ST_S 0 // From previous SDK + +#define SPI_EXT3(i) (REG_SPI_BASE(i) + 0xFC) +#define SPI_INT_HOLD_ENA 0x00000003 +#define SPI_INT_HOLD_ENA_S 0 +#endif // SPI_REGISTER_H_INCLUDED diff --git a/user_config.h b/user_config.h new file mode 100644 index 0000000..3d13cf4 --- /dev/null +++ b/user_config.h @@ -0,0 +1,3 @@ +/* + * This is an empty file to keep the SDK (which tries to include it) happy. + */ diff --git a/user_main.c b/user_main.c new file mode 100644 index 0000000..1484771 --- /dev/null +++ b/user_main.c @@ -0,0 +1,155 @@ +/* + * Copyright 2017 Jonathan McDowell + * + * 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 . + */ +#include +#include +#include +#include + +#include "espmissingincludes.h" + +#include "project_config.h" + +#include "clock.h" +#include "max7219.h" +#include "spi.h" + +struct station_config wificfg; +static os_timer_t update_timer; + +static const struct fontchar clocknums[] = { + { .width = 5, + .bitmap = { 0x0e, 0x11, 0x11, 0x11, 0x11, 0x11, 0x11, 0x0e } }, + { .width = 3, + .bitmap = { 0x02, 0x03, 0x02, 0x02, 0x02, 0x02, 0x02, 0x07 } }, + { .width = 5, + .bitmap = { 0x0e, 0x11, 0x10, 0x10, 0x08, 0x04, 0x02, 0x1f } }, + { .width = 5, + .bitmap = { 0x0e, 0x11, 0x10, 0x0c, 0x10, 0x10, 0x11, 0x0e } }, + { .width = 6, + .bitmap = { 0x10, 0x18, 0x14, 0x12, 0x11, 0x3f, 0x10, 0x10 } }, + { .width = 5, + .bitmap = { 0x1f, 0x01, 0x01, 0x0f, 0x10, 0x10, 0x11, 0x0e } }, + { .width = 5, + .bitmap = { 0x0e, 0x11, 0x01, 0x0f, 0x11, 0x11, 0x11, 0x0e } }, + { .width = 5, + .bitmap = { 0x1f, 0x10, 0x10, 0x08, 0x04, 0x02, 0x02, 0x02 } }, + { .width = 5, + .bitmap = { 0x0e, 0x11, 0x11, 0x0e, 0x11, 0x11, 0x11, 0x0e } }, + { .width = 5, + .bitmap = { 0x0e, 0x11, 0x11, 0x11, 0x1e, 0x10, 0x11, 0x0e } } +}; + +void ICACHE_FLASH_ATTR update_func(void *arg) +{ + static bool ind = false; + uint8_t hour, mins; + uint8_t digits[4], position[4]; + struct tm curtime; + + max7219_clear(); + ind = !ind; + + /* Draw the middle : */ + if (ind) { + max7219_set_pixel(15, 1, true); + max7219_set_pixel(15, 2, true); + max7219_set_pixel(15, 5, true); + max7219_set_pixel(15, 6, true); + max7219_set_pixel(16, 1, true); + max7219_set_pixel(16, 2, true); + max7219_set_pixel(16, 5, true); + max7219_set_pixel(16, 6, true); + } + + breakdown_time(get_time(), &curtime); + mins = curtime.tm_min; + hour = curtime.tm_hour; + + digits[0] = hour / 10; + digits[1] = hour % 10; + digits[2] = mins / 10; + digits[3] = mins % 10; + + /* + * We want our numbers to use as much of the LED matrix as possible, + * and the displayed time to be centred on the display, so we do our + * own positioning and blitting instead of using max7219_print. + */ + position[1] = 14 - clocknums[digits[1]].width; + position[0] = position[1] - clocknums[digits[0]].width - 1; + position[2] = 18; + position[3] = position[2] + clocknums[digits[2]].width + 1; + + max7219_blit(position[0], 0, clocknums[digits[0]].bitmap, + clocknums[digits[0]].width, 8); + max7219_blit(position[1], 0, clocknums[digits[1]].bitmap, + clocknums[digits[1]].width, 8); + max7219_blit(position[2], 0, clocknums[digits[2]].bitmap, + clocknums[digits[2]].width, 8); + max7219_blit(position[3], 0, clocknums[digits[3]].bitmap, + clocknums[digits[3]].width, 8); + + max7219_show(); +} + +void ICACHE_FLASH_ATTR wifi_callback(System_Event_t *evt) +{ + switch (evt->event) { + case EVENT_STAMODE_CONNECTED: + case EVENT_STAMODE_DISCONNECTED: + break; + case EVENT_STAMODE_GOT_IP: + ntp_get_time(); + default: + break; + } +} + +void ICACHE_FLASH_ATTR wifi_init(void) +{ + wificfg.bssid_set = 0; + os_memcpy(&wificfg.ssid, CFG_WIFI_SSID, + os_strlen(CFG_WIFI_SSID)); + os_memcpy(&wificfg.password, CFG_WIFI_PASSWORD, + os_strlen(CFG_WIFI_PASSWORD)); + + wifi_station_set_hostname("esp8266-clock"); + wifi_set_opmode(STATION_MODE); + wifi_station_set_config(&wificfg); + + wifi_set_event_handler_cb(wifi_callback); +} + +void user_init(void) +{ + /* Fix up UART0 baud rate */ + uart_div_modify(0, UART_CLK_FREQ / 115200); + os_printf("Starting up."); + + rtc_init(); + gpio_init(); + + spi_init(); + max7219_init(BIT12); /* GPIO12 is CS */ + max7219_print("Booting"); + max7219_show(); + + wifi_init(); + + os_timer_setfn(&update_timer, update_func, NULL); + os_timer_arm(&update_timer, 10000 /* 10s */, 1); +}