Merge pull request 'Update develop. Ready for pre-release v0.4' (#49) from dev into master

Reviewed-on: #49

.gitmodules

@@ -10,3 +10,6 @@
 	path = stm-firmware/base64-lib
 	url = https://git.shimatta.de/mhu/base64-lib.git
 	branch = master
+[submodule "stm-firmware/linklist-lib"]
+	path = stm-firmware/linklist-lib
+	url = https://git.shimatta.de/mhu/linklist-lib.git

GPLv2.md

@@ -0,0 +1,361 @@
+### GNU GENERAL PUBLIC LICENSE
+
+Version 2, June 1991
+
+    Copyright (C) 1989, 1991 Free Software Foundation, Inc.  
+    51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+
+    Everyone is permitted to copy and distribute verbatim copies
+    of this license document, but changing it is not allowed.
+
+### Preamble
+
+The licenses for most software are designed to take away your freedom
+to share and change it. By contrast, the GNU General Public License is
+intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) 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
+this service 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 make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if
+you distribute copies of the software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. 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.
+
+We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on,
+we want its recipients to know that what they have is not the
+original, so that any problems introduced by others will not reflect
+on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at
+all.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+### TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+**0.** This License applies to any program or other work which
+contains a notice placed by the copyright holder saying it may be
+distributed under the terms of this General Public License. The
+"Program", below, refers to any such program or work, and a "work
+based on the Program" means either the Program or any derivative work
+under copyright law: that is to say, a work containing the Program or
+a portion of it, either verbatim or with modifications and/or
+translated into another language. (Hereinafter, translation is
+included without limitation in the term "modification".) Each licensee
+is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the Program
+(independent of having been made by running the Program). Whether that
+is true depends on what the Program does.
+
+**1.** You may copy and distribute 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 and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a
+fee.
+
+**2.** You may modify your copy or copies of the Program or any
+portion of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+  
+**a)** You must cause the modified files to carry prominent notices
+stating that you changed the files and the date of any change.
+
+  
+**b)** You must cause any work that you distribute or publish, that in
+whole or in part contains or is derived from the Program or any part
+thereof, to be licensed as a whole at no charge to all third parties
+under the terms of this License.
+
+  
+**c)** If the modified program normally reads commands interactively
+when run, you must cause it, when started running for such interactive
+use in the most ordinary way, to print or display an announcement
+including an appropriate copyright notice and a notice that there is
+no warranty (or else, saying that you provide a warranty) and that
+users may redistribute the program under these conditions, and telling
+the user how to view a copy of this License. (Exception: if the
+Program itself is interactive but does not normally print such an
+announcement, your work based on the Program is not required to print
+an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+**3.** You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+  
+**a)** Accompany it with the complete corresponding machine-readable
+source code, which must be distributed under the terms of Sections 1
+and 2 above on a medium customarily used for software interchange; or,
+
+  
+**b)** Accompany it with a written offer, valid for at least three
+years, to give any third party, for a charge no more than your cost of
+physically performing source distribution, a complete machine-readable
+copy of the corresponding source code, to be distributed under the
+terms of Sections 1 and 2 above on a medium customarily used for
+software interchange; or,
+
+  
+**c)** Accompany it with the information you received as to the offer
+to distribute corresponding source code. (This alternative is allowed
+only for noncommercial distribution and only if you received the
+program in object code or executable form with such an offer, in
+accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+**4.** You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt otherwise
+to copy, modify, sublicense or distribute the Program is void, and
+will automatically terminate your rights under this License. However,
+parties who have received copies, or rights, from you under this
+License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+**5.** You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+**6.** Each time you redistribute the Program (or any work based on
+the Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+**7.** If, as a consequence of a court judgment or allegation of
+patent infringement or for any other reason (not limited to patent
+issues), 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 distribute so as to satisfy simultaneously your
+obligations under this License and any other pertinent obligations,
+then as a consequence you may not distribute the Program at all. For
+example, if a patent license would not permit royalty-free
+redistribution of the Program by all those who receive copies directly
+or indirectly through you, then the only way you could satisfy both it
+and this License would be to refrain entirely from distribution of the
+Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+**8.** If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+**9.** The Free Software Foundation may publish revised and/or new
+versions of the 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 a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Program does not specify a
+version number of this License, you may choose any version ever
+published by the Free Software Foundation.
+
+**10.** If you wish to incorporate parts of the Program into other
+free programs whose distribution conditions are different, write to
+the author to ask for permission. For software which is copyrighted by
+the Free Software Foundation, write to the Free Software Foundation;
+we sometimes make exceptions for this. Our decision will be guided by
+the two goals of preserving the free status of all derivatives of our
+free software and of promoting the sharing and reuse of software
+generally.
+
+**NO WARRANTY**
+
+**11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
+
+**12.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE 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.
+
+### 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
+convey 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 an idea of what it does.
+    Copyright (C) yyyy  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 2
+    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, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+Also add information on how to contact you by electronic and paper
+mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision 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, the
+commands you use may be called something other than \`show w' and
+\`show c'; they could even be mouse-clicks or menu items--whatever
+suits your program.
+
+You should also get your employer (if you work as a programmer) or
+your school, if any, to sign a "copyright disclaimer" for the program,
+if necessary. Here is a sample; alter the names:
+
+    Yoyodyne, Inc., hereby disclaims all copyright
+    interest in the program `Gnomovision'
+    (which makes passes at compilers) written 
+    by James Hacker.
+
+    signature of Ty Coon, 1 April 1989
+    Ty Coon, President of Vice
+
+This 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](https://www.gnu.org/licenses/lgpl.html) instead of this
+License.

Jenkinsfile

@@ -0,0 +1,21 @@
+pipeline {
+    agent any
+
+    stages {
+        stage('Build') {
+            steps {
+                echo 'Building..'
+            }
+        }
+        stage('Test') {
+            steps {
+                echo 'Testing..'
+            }
+        }
+        stage('Deploy') {
+            steps {
+                echo 'Deploying....'
+            }
+        }
+    }
+}

LICENSE.md

@@ -1,361 +1,10 @@
-### GNU GENERAL PUBLIC LICENSE
+# License of the Relow Oven Control Firmware
 
-Version 2, June 1991
+This software is licsensed according to the GPLv2. See GPLv2.md for details.
+However, this software includes various third party libraries for which different licenses apply:
 
-    Copyright (C) 1989, 1991 Free Software Foundation, Inc.  
-    51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
-
-    Everyone is permitted to copy and distribute verbatim copies
-    of this license document, but changing it is not allowed.
-
-### Preamble
-
-The licenses for most software are designed to take away your freedom
-to share and change it. By contrast, the GNU General Public License is
-intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users. This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it. (Some other Free Software Foundation software is covered by
-the GNU Lesser General Public License instead.) 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
-this service 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 make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if
-you distribute copies of the software, or if you modify it.
-
-For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have. 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.
-
-We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
-
-Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software. If the software is modified by someone else and passed on,
-we want its recipients to know that what they have is not the
-original, so that any problems introduced by others will not reflect
-on the original authors' reputations.
-
-Finally, any free program is threatened constantly by software
-patents. We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary. To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at
-all.
-
-The precise terms and conditions for copying, distribution and
-modification follow.
-
-### TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-**0.** This License applies to any program or other work which
-contains a notice placed by the copyright holder saying it may be
-distributed under the terms of this General Public License. The
-"Program", below, refers to any such program or work, and a "work
-based on the Program" means either the Program or any derivative work
-under copyright law: that is to say, a work containing the Program or
-a portion of it, either verbatim or with modifications and/or
-translated into another language. (Hereinafter, translation is
-included without limitation in the term "modification".) Each licensee
-is addressed as "you".
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the Program
-(independent of having been made by running the Program). Whether that
-is true depends on what the Program does.
-
-**1.** You may copy and distribute 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 and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a
-fee.
-
-**2.** You may modify your copy or copies of the Program or any
-portion of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
-  
-**a)** You must cause the modified files to carry prominent notices
-stating that you changed the files and the date of any change.
-
-  
-**b)** You must cause any work that you distribute or publish, that in
-whole or in part contains or is derived from the Program or any part
-thereof, to be licensed as a whole at no charge to all third parties
-under the terms of this License.
-
-  
-**c)** If the modified program normally reads commands interactively
-when run, you must cause it, when started running for such interactive
-use in the most ordinary way, to print or display an announcement
-including an appropriate copyright notice and a notice that there is
-no warranty (or else, saying that you provide a warranty) and that
-users may redistribute the program under these conditions, and telling
-the user how to view a copy of this License. (Exception: if the
-Program itself is interactive but does not normally print such an
-announcement, your work based on the Program is not required to print
-an announcement.)
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote
-it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
-
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
-**3.** You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
-
-  
-**a)** Accompany it with the complete corresponding machine-readable
-source code, which must be distributed under the terms of Sections 1
-and 2 above on a medium customarily used for software interchange; or,
-
-  
-**b)** Accompany it with a written offer, valid for at least three
-years, to give any third party, for a charge no more than your cost of
-physically performing source distribution, a complete machine-readable
-copy of the corresponding source code, to be distributed under the
-terms of Sections 1 and 2 above on a medium customarily used for
-software interchange; or,
-
-  
-**c)** Accompany it with the information you received as to the offer
-to distribute corresponding source code. (This alternative is allowed
-only for noncommercial distribution and only if you received the
-program in object code or executable form with such an offer, in
-accord with Subsection b above.)
-
-The source code for a work means the preferred form of the work for
-making modifications to it. For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable. However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
-**4.** You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License. Any attempt otherwise
-to copy, modify, sublicense or distribute the Program is void, and
-will automatically terminate your rights under this License. However,
-parties who have received copies, or rights, from you under this
-License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-**5.** You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Program or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
-
-**6.** Each time you redistribute the Program (or any work based on
-the Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
-
-**7.** If, as a consequence of a court judgment or allegation of
-patent infringement or for any other reason (not limited to patent
-issues), 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 distribute so as to satisfy simultaneously your
-obligations under this License and any other pertinent obligations,
-then as a consequence you may not distribute the Program at all. For
-example, if a patent license would not permit royalty-free
-redistribution of the Program by all those who receive copies directly
-or indirectly through you, then the only way you could satisfy both it
-and this License would be to refrain entirely from distribution of the
-Program.
-
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
-**8.** If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded. In such case, this License incorporates
-the limitation as if written in the body of this License.
-
-**9.** The Free Software Foundation may publish revised and/or new
-versions of the 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 a version number of this License which applies to it and
-"any later version", you have the option of following the terms and
-conditions either of that version or of any later version published by
-the Free Software Foundation. If the Program does not specify a
-version number of this License, you may choose any version ever
-published by the Free Software Foundation.
-
-**10.** If you wish to incorporate parts of the Program into other
-free programs whose distribution conditions are different, write to
-the author to ask for permission. For software which is copyrighted by
-the Free Software Foundation, write to the Free Software Foundation;
-we sometimes make exceptions for this. Our decision will be guided by
-the two goals of preserving the free status of all derivatives of our
-free software and of promoting the sharing and reuse of software
-generally.
-
-**NO WARRANTY**
-
-**11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
-
-**12.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
-AND/OR REDISTRIBUTE 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.
-
-### 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
-convey 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 an idea of what it does.
-    Copyright (C) yyyy  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 2
-    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, write to the Free Software
-    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-
-Also add information on how to contact you by electronic and paper
-mail.
-
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
-
-    Gnomovision version 69, Copyright (C) year name of author
-    Gnomovision 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, the
-commands you use may be called something other than \`show w' and
-\`show c'; they could even be mouse-clicks or menu items--whatever
-suits your program.
-
-You should also get your employer (if you work as a programmer) or
-your school, if any, to sign a "copyright disclaimer" for the program,
-if necessary. Here is a sample; alter the names:
-
-    Yoyodyne, Inc., hereby disclaims all copyright
-    interest in the program `Gnomovision'
-    (which makes passes at compilers) written 
-    by James Hacker.
-
-    signature of Ty Coon, 1 April 1989
-    Ty Coon, President of Vice
-
-This 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](https://www.gnu.org/licenses/lgpl.html) instead of this
-License.
+- Shellmatta Shell implementation by Stefan Strobel: Licensed under ``Mozilla Public License Version 2.0``
+- CMSIS by ARM Limited <https://github.com/ARM-software/CMSIS_5>, licensed under ``Apache License Version 2.0, January 2004``
+- STM Header Files etc. by ST Microelectronics icensed under a custom license. See the sphinx documentation (section License) for details.
+- FatFs: Custom License (See source files of FatFS)
+- SHA256 Library <https://github.com/amosnier/sha-2> licensed under the ``Unilicense``

doc/.gitignore

@@ -0,0 +1,2 @@
+build/*
+venv

doc/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "restructuredtext.confPath": "${workspaceFolder}/source"
+}

doc/make-with-virtualenv.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+SOURCE="${BASH_SOURCE[0]}"
+while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
+  DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE" # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located
+done
+DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )"
+
+cd "$DIR"
+
+if [[ ! -d "venv" ]]; then
+	virtualenv venv
+	source ./venv/bin/activate
+	pip install -r requirements.txt
+else
+	source ./venv/bin/activate
+fi
+
+make SPHINXBUILD='venv/bin/python venv/bin/sphinx-build' $@

doc/requirements.txt

@@ -0,0 +1,32 @@
+alabaster==0.7.12
+Babel==2.9.0
+blockdiag==2.0.1
+breathe==4.24.1
+certifi==2020.11.8
+chardet==3.0.4
+docutils==0.16
+funcparserlib==0.3.6
+idna==2.10
+imagesize==1.2.0
+Jinja2==2.11.2
+MarkupSafe==1.1.1
+packaging==20.7
+Pillow==8.0.1
+Pygments==2.7.2
+pyparsing==2.4.7
+pytz==2020.4
+requests==2.25.0
+six==1.15.0
+snowballstemmer==2.0.0
+Sphinx==3.3.1
+sphinx-rtd-theme==0.5.0
+sphinxcontrib-applehelp==1.0.2
+sphinxcontrib-blockdiag==2.0.0
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-drawio==0.0.12
+sphinxcontrib-htmlhelp==1.0.3
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.4
+urllib3==1.26.2
+webcolors==1.11.1

doc/source/.gitignore

@@ -0,0 +1,2 @@
+.drawio/*
+.drawio

doc/source/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "restructuredtext.confPath": "${workspaceFolder}"
+}

doc/source/Doxyfile.in

@@ -13,6 +13,10 @@
 # TAG += value [value, ...]
 # Values that contain spaces should be placed between quotes (\" \").
 
+
+
+
+
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
@@ -869,34 +873,7 @@ FILE_PATTERNS          = *.c \
                          *.hxx \
                          *.hpp \
                          *.h++ \
-                         *.cs \
-                         *.d \
-                         *.php \
-                         *.php4 \
-                         *.php5 \
-                         *.phtml \
-                         *.inc \
-                         *.m \
-                         *.markdown \
-                         *.md \
-                         *.mm \
-                         *.dox \
-                         *.doc \
-                         *.txt \
-                         *.py \
-                         *.pyw \
-                         *.f90 \
-                         *.f95 \
-                         *.f03 \
-                         *.f08 \
-                         *.f18 \
-                         *.f \
-                         *.for \
-                         *.vhd \
-                         *.vhdl \
-                         *.ucf \
-                         *.qsf \
-                         *.ice
+                         *.dox
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
@@ -911,10 +888,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = ../../stm-firmware/include/stm32 \
-                         ../../stm-firmware/include/cmsis \
-                         ../../stm-firmware/shellmatta/test \
-                         ../../stm-firmware/shellmatta/example
+EXCLUDE                = 
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -930,7 +904,12 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       =
+EXCLUDE_PATTERNS       = */include/stm32/* \
+                         */include/cmsis/* \
+                         */shellmatta/test/* \
+                         */shellmatta/example/* \
+                         */base64-lib/test/* \
+                         */updater/ram-code/*
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the

doc/source/conf.py

@@ -32,6 +32,7 @@ try:
 	os.mkdir('../build/_doxygen')
 except FileExistsError:
 	pass
+
 subprocess.call('doxygen Doxyfile.in', shell=True)
 
 # -- General configuration ---------------------------------------------------
@@ -44,6 +45,7 @@ extensions = [
 	'sphinx.ext.autodoc',
 	'sphinx.ext.todo',
 	'sphinxcontrib.blockdiag',
+	'sphinxcontrib.drawio',
 	'breathe'
 ]
 

doc/source/firmware/calibration.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2021-05-22T15:48:58.897Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.1.8 Chrome/87.0.4280.88 Electron/11.1.1 Safari/537.36" etag="60nNVEjkDLNBMWFG8AC7" version="14.1.8" type="device"><diagram id="3R1YF1CA5z1RRVBQNkpO" name="Page-1">7VlLc9o6FP41LGFkCduwbCBtF+1cbtOZpkthy7Z6ZURk8eqvr2TLLwSBFIgnmZtFxjqSjh7n+85D9NAk3X4SeJl85SFhPQjCbQ9NexB6vq/+a8GuEKCRVwhiQcNC5NSCB/qbGCEw0hUNSdYaKDlnki7bwoAvFiSQLRkWgm/awyLO2qsucUwswUOAmS39QUOZFNIR9Gv5Z0LjpFzZ8cZFT4rLweYkWYJDvmmI0H0PTQTnsvhKtxPC9N2V91LM+3ikt9qYIAt5zgRvNpa/npLHmH16+jdwvo+m7rzvmr3JXXlgEqrzmyYXMuExX2B2X0vvBF8tQqK1AtWqx3zhfKmEjhL+IlLujDHxSnIlSmTKTK/asNg9mvl546duDNyyOd02O6c70yr2qjd49ApKiGARE/nMuceVARRwCU+JWkfNE4RhSddt/dhAKK7GVVNnnKqVITBor1BrwO74oK2i2JeZ1bTVnqJ9PZ7b1pPxlQiIpUd9NI5Ti3IkvAAVhqJrzFbmKr7hjRLMvjsAgPyeMppJvAjIQfx8wXPlBVo2x4zGC/UdKFMRoQRrIiRVPPtgOlIahgW8lO7feJ7r01Zf6lPm53bveu60woFWQLa9A07ATK6p10TIcRrYcDDa+2DgAH/cMknfLHkhYhwwGLug8YcOrlIq5FGUkZuY3OnGE2ypfGx8N/yAatVuQDdKL/C33iNvzYig6qo0Al/oUgrKnXIpZ7geZ3ih72mZ/qV2HlvU7kGPqf3ezdVHLPM7KQQRz5FaI8J7WvGyo5/lNv2gBiC03NadtZZKkdpooautX4kba+6DjzEV4jXINgmV5GGJ88vfqCRjz7FkyyLuR3SroXgXUcYmnHGRK0KhS0bhUMkzKfh/pNEzgnPkec/5EwsGR10ELPlTeuyhcT2bOmlwjShp5AsuuJGdHce+0vfF5ytStwy3p7kLb5M3oHa8h8Pz8oarOX9geYWJCthzgaVCAwT/1GGnCag2XE7wdI+WURTBIDhEy9Cbe+6VaOnv3atrs9KBB2jp3YyW6O3Rsmbiz2YC/wq0hGfS8tJs/jKTQos8fdv5SkHxImZnBDTBpdo11zlxfwxs5hBHhTT/EHPGno/wtQIabAe0qiRpUAcdYM6+57raNUP4ZpijGjfMMy/OHw/HIA+cqDlvHIMgej4GVbXnt3dWe8IjOUVdfCIXOC3bXKn4RM7gcFH7CuXm0LK2Zc3SSrlFZzyjxivOuZQ81Q6wfFHTpgpxllRMtyzeQMO+8aV2BVrXUq+bbmP9jjkgTBlT6HEDPFeeFgdykK70uyOjucZOygw03CNp12UGfINlRnf5jHdmPuP4nSY09vNf0xOb1wJRlu4PZKGpuaZSb3FK1rRIX958tYBg59XCqBN2/SVTbv3A5vjn0qfTF7Zym/8/sd029lXlR2exD9hX+h5+PDtNxLOfuruNY/Zbt52tXBKVXqkSHx95HDxRiaOX414169+ji1S//lEf3f8B</diagram></mxfile>

doc/source/firmware/code/safety/safety-controller.rst

@@ -9,6 +9,3 @@ Safety Controller
    safety-adc
 
 
-.. doxygengroup:: safety-controller
-   :project: Reflow Controller Firmware
-

doc/source/firmware/hw-version-detect.rst

@@ -0,0 +1,31 @@
+.. _hw_version_detect:
+
+Automatic Hardware Version detection
+====================================
+
+Functional Description
+----------------------
+
+In order to automatically select the available hardware features, the firmware checks the PCB's version
+using vertain pins on the microcontroller.
+
+The hardware revision is represented by the enum type :c:enum:`hw_revision`. A call to :c:func:`get_pcb_hardware_version` retrieves the revision.
+When the function is called for the first time, it activates pull-up resistors on pin numbers :c:macro:`HW_REV_DETECT_PIN_LOW` to :c:macro:`HW_REV_DETECT_PIN_HIGH`
+on port :c:macro:`HW_REV_DETECT_GPIO` and reads in the binary number. 
+
+The revision is set by externally connecting the pins to ground. The bit pattern read from the port is inverted and then checked internally to derive the hardware version.
+After the version is read for the first time, it is stored internally and subsequent calls to :c:func:`get_pcb_hardware_version` only retrieve the internally stored value to reduce the overhead of the function.
+
+Hardware Version Dependent Features
+-----------------------------------
+
+- The settings module searches for an external EEPROM on the SPI interface to store some settings, like the calibration. This is enabled for all versions higher or equal to ``v1.3``.
+- The safety controller enables the acknowledging of the external watchdog for all versions higher or equal to ``v1.3``.
+- The oven driver has a separate safety enable for the solid state relay which it enables on all versions higher or equal to ``v1.3``.
+
+
+API Documentation
+-----------------
+
+.. doxygengroup:: hw-version-detect
+   :project: Reflow Controller Firmware

doc/source/firmware/index.rst

@@ -11,6 +11,8 @@ mechanisms and the behavior. For a detailed code documentation see the doxygen o
 	:maxdepth: 2
 	
 	pt1000-processing
+	pid-controller
 	safety/index
 	code/index
-
+	hw-version-detect
+	peripherals

doc/source/firmware/peripherals.rst

@@ -0,0 +1,44 @@
+.. _peripherals:
+
+Used Peripheral Modules
+=======================
+
+This section lists all the used peripheral modules of the ``STM32F407VxT6``.
+
+Core Peripherals
+----------------
+
+- ``SysTick``: Generating a 100us tick for the LCD routine and 1ms base system tick.
+- ``NVIC``: Interrupt controller
+- ``FPU``: The Flaoting Point Unit is activated and used in this formware.
+
+AHB Peripherals
+---------------
+
+- ``DMA2``
+	- ``Stream0``: DMA transfer of PT1000 measurement ADC to memory
+	- ``Stream4``: DMA transfer of Safety ADC measurement values
+	- ``Stream5``: Shell UART RX
+	- ``Stream7``: Shell UART TX
+- ``RNG``: Random number generation for stack corruption / overflow checker.
+- ``CRC``: CRC verfication of various data (Safety structures, EEPROM data, Safety RAM)
+- ``Backup RAM``: Backup RAM storing errors and bootloader information beyond system resets. The memory is cleared by a power cycle!
+
+ABP1 Peripherals
+----------------
+
+- ``IWDG``: Independent Watchdog
+- ``TIM2``: PT1000 measurement ADC sample time generation timer. Genewrates the 1 KHz sample trigger to the ADC peripheral via the internal event routing system.
+- ``TIM3``: PWM timer for oven relais output.
+- ``TIM5``: Input capture for rotary encoder.
+- ``TIM7``: Timer for loudspeaker tone generation.
+ 
+
+APB2 Peripherals
+----------------
+
+- ``SPI1``: SPI for external SPI-EEPROM
+- ``SDIO``: SD card interface
+- ``USART1``: Shell UART
+- ``ADC1``: Safety ADC for monitoring voltages
+- ``ADC3``: PT1000 measurement ADC

doc/source/firmware/pid-controller.rst

@@ -0,0 +1,78 @@
+.. _pid_controller:
+
+PID Controller
+==============
+
+The PID controller is the main element of the oven. It controls the output of the solid state relais in order to achieve the desired temperature.
+
+The PID controller is implemented in the ``pid-controller.c`` file. See the :ref:`pid_code_api` for details.
+
+Functional Description
+----------------------
+
+The following figure shows the PID controller's structure.
+
+.. drawio-image:: pid.drawio
+
+The controller is composed of 3 paths. The proportional, the derivate, and the integrator path.
+Compared to a textbook PID controller, this version contains a few additional features.
+
+The integrator has a configurable maximum limit of :c:var:`pid_controller.integral_max`. Once this value is reached (plus or minus), the integrator freezes.
+The integrator is also frozen in case the output value is in saturation. This serves as an anti-windup protection.
+
+The output value saturates at configurable high and low limits (:c:var:`pid_controller.output_sat_max` and :c:var:`pid_controller.output_sat_min`). The controller instance used for the
+reflow oven's solid state relais output is saturated by software to a limit of 0 to 100.
+
+In addition to the above features, the derivate term contains an additional first order low pass filter in order to prevent coupling of high frequency noise amplified by the derivate term.
+The low pass filter is charcterized by its time constant :math:`k_{d\tau}`.
+
+Time Continuous Transfer Function
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The time continous transfer function of the PID controller is
+
+.. math:: H_c(s) = \frac{Y_c(s)}{X_c(s)} = k_p + \frac{k_i}{s} + \frac{k_ds}{1+sk_{d\tau}} 
+
+
+Time Discrete Transfer Function
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The time descrete transfer function which is implemented in the code is derived by converting the time continuous transfer function
+with the bilinear transformation:
+
+.. math:: s = \frac{2}{T_s}\cdot \frac{z-1}{z+1}
+
+The frequency warping of the bilinear transform can be considered negligible because the PID controller is targetted for low frequency temperature signal data with a maximum far below the nyquist freqency.
+In this area, the mapping of the continuous frequencies to the time descrete can be considered linear.
+
+The time discrete transfer function after inserting the bilinear transform is:
+
+.. math:: H_d(z) = H_c(s)\bigg|_{s=\frac{2}{T_s}\cdot \frac{z-1}{z+1}} = k_p + \frac{k_i T_s (z+1)}{2(z-1)} + \frac{\frac{2}{T_s}k_d(z-1)}{\left(1+\frac{2k_{d\tau}}{T_s}\right)z+\left(1-\frac{2k_{d\tau}}{T_s}\right)}.
+
+Converted to an implementable form:
+
+.. math:: H_d(z) = k_p + \frac{k_iT_s(1+ z^{-1})}{2(1-z^{-1})} + \frac{\frac{2}{T_s}k_d(1-z^{-1})}{(1+2k_{d\tau}T_s^{-1})+(1-2k_{d\tau}T_s^{-1})z^{-1}}
+
+This function can be splitted in the three individual parts of the PID controller:
+
+.. math:: H_{d1}(z) = k_p
+.. math:: H_{d2}(z) = \frac{k_iT_s(1+ z^{-1})}{2(1-z^{-1})}
+.. math:: H_{d3}(z) = \frac{\frac{2}{T_s}k_d(1-z^{-1})}{(1+2k_{d\tau}T_s^{-1})+(1-2k_{d\tau}T_s^{-1})z^{-1}}
+
+The individual time domain difference equations :math:`y_i[n] = \mathcal{Z}^{-1}\left\lbrace H_{di} * X(z)\right\rbrace` that are implemented in software are:
+
+.. math:: y_1[n] = k_p x[n]
+.. math:: y_2[n] = \underbrace{\frac{k_iT_s}{2}}_{k_{i_t}} \left( x[n] + x[n-1]\right) + y_2[n-1]
+.. math:: y_3[n] = \underbrace{\frac{2k_{d}}{2k_{d\tau} + T_s}}_{k_{d_t}}\left( x[n] - x[n-1] \right) + \underbrace{\frac{2k_{d\tau} - T_s}{2k_{d\tau} + T_s}}_{\overline{k_{d_t}}} y_3[n-1]
+
+The final output value is the sum of all three terms:
+
+.. math:: y[n] = \sum_{i=1}^{3} y_i[n]
+
+.. _pid_code_api:
+
+PID Controller Code API
+-----------------------
+
+.. doxygengroup:: pid-controller
+   :project: Reflow Controller Firmware

doc/source/firmware/pid.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2021-06-14T21:01:35.428Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.1.8 Chrome/87.0.4280.88 Electron/11.1.1 Safari/537.36" etag="ORruDkFRflEPSgIrI-Cx" version="14.1.8" type="device"><diagram name="Page-1" id="b520641d-4fe3-3701-9064-5fc419738815">3Vttb6M4EP41+dgIMObl4/bl7lba1VXqSbt3XyonOMRXiDnjtGR//dnYQHhLySaEdFFV2ePx2Hjm8YzHZAbu4ux3hpL1VxrgaGYZQTYD9zPL8j1T/JeEnSJA6CtCyEigSGZFeCI/sCYamrolAU5rjJzSiJOkTlzSzQYveY2GGKNvdbYVjeqjJijELcLTEkVt6jcS8LWmmoZRNfyBSbjWQ3tQNyzQ8iVkdLvR480ssMof1RyjUpYipGsU0DdFykWAhxm4Y5RyVYqzOxzJpS2WTY3zW09rOW+GN3xIBy/JHl5eQ/vrX8//QJh8C+iPpxutq5TvivXAgVgeXaWMr2lINyh6qKi3+TtjKdUQtYrnC6WJIJqC+C/mfKd1jbacCtKax5FuxRnh3/fKf0tRc6hr95mWnFd2RWXD2e57xSirf++3Vd3yWq3fI2YkxhwzTVQvLd+0dy0LpdEtW+IDC1iYLGIh5of4zFLlAkmYiumwnejIcIQ4ea1PBGmbDku+susjJWKKlqHh50BLrEfeSePPstyCUohRk9M9KwsRhb2pVKTcbo6wISlyAiMqDaJmDpV19BjEcN2/r9NRVFrujIVCHWOQOtuC7HcEKeNuCfrEGNrtsSWSIT0wYbd7nN55NfjNOr8oqBmc1Ui1Gl5RtMXFfu1EQru3C1EIZeHzhuOQIU5Z0SRGKltLdlZRbPH38kxUoQWCysSlvb6tCcdPCcp3kzfhSuvmvCJRdEcjyvK+IIDYC2xBTzmjL3ivxbMWwHFKQ37FjOPssCm3TVR3ALChCe1CjLeaJ1S09b4TbFjSvlXXtpej1QQ+ikM6ow8Bo+wjtt+AJfTnHnRN21L//Ys6CfA+/u6Fl35Vb3wU/oJfBn/W9PgzPgr++gLCMjaYKCCEVxcQ+talA8JpNvHpA0I4TkBo1HcJAH7xgBBcIiCEHQ5J+ZOkx59wRtAmzI31Kp2JU8c96HAm3iV9ifO+y39kNBFQJxLo3U6/qQOc8fpao4iEG1FeimWS+/mtXESyRNEn3RCTIFA7DE7JD7TIRUngazMWcuHtDN5LWWJTSdX+MqEa62CwDdhSo9+hRmssNYI2Eq41JBCVMVM9I3ns93blkb212XU0bii8wNQXtMDRo8CIhKxoWlDOaSwhUSQ35ZoHKF2Xum/hc0/JTahyaRxSViLHjbNQZpznOMJLsfcKvjlaCOyhJZ+n2zhGchLPOYqnAitsgFVE9C2wwg6wwtHi92nA+pOh1+jJWWtg4HYytE9TmtUbi8zc22AG7zjaztz7nrjkWsAZ0ZAsn0PEcSrKbwlK02eBSiV4Eni2UiDAHQRP2xlL0+608Dzu7uScSHSGInFSIPaHrCua++xKcc5/W1o03Kig8ZNgMK0kqxqLOPYryki8jUUVxRJFm0WaHMhpCcQnsZysxH+Msj3slzGymlBPmHxS6gthb7Xsgqaz9PBiNQ403WGHldEcpzVJ4uuMCANDkxTjZJubO+3A1MLZ0ssDglghhiTpgOM7ShP1pcGKZFK7TYQY+XMeHFjNCBK2gWBd9LjXsXDXA4TzJ9csf+7bP2W7bVmwLUuQnEY0MfZNS/uq5fMm2cp5BviV5KemThXn8eN4yZVesOgve3TnWWna+8o/YKq90Lox5o4NzZo+dO1Eo7kBcG47RvXUBzHmvufvPZ5dH4CuVikeRff2JOCd+vp0nLS7Z7Rc2hyYBrBtz3Kh54BBqD42d+56x+XO3+EfJ3duX1FK0Bp8TWhNdfgBg+8ERzHklokMyy8ebbnNWx8bHrbcBj88bOjAdQ+wj2Tn7fPgn1uufGmK+JZpZ2qsMA7k96C/hl9V8O71q2Jr9626Mm7O41c9Z97cVsfzlaB9A1gq92lPuec8Wl8k69W6UADtI4XZdaZoxr1nO1PYkxyuT/yqxJ3MXXgD3cXJgc9pB0WvHz8x2ah814fLSzmNr2+9NnbcDujYo0HHbC3i9UNnMuT4HwM5/gHkFJniD48c054aOu1ESLnMitZc5It+XXKGJW+F3B3Xz11Z9J9IHopq9VMlFYJVPwcDD/8D</diagram></mxfile>

doc/source/firmware/pt1000-processing.rst

@@ -12,30 +12,7 @@ PT1000 Value Sampling
 
 The following block diagram shows the processing chain of the temperature signal.
 
-.. blockdiag::
-	:desctable:
-	
-	blockdiag {
-		orientation = portrait;
-		
-		FRONTEND[description=":ref:`hw_analog_fe`", label="Frontend"];
-		ADC[description="`Analog to Digital Converter <ADC_>`_"];
-		WATCHDOG [label = "WDT", shape=endpoint, description="`Hardware Value Watchdog <Watchdog_>`_"];
-		PREFILTER [label=Prefilter, description="`Prefiltering and Downsampling <Prefilter_>`_"];
-		ADC2RES [label= "Val -> Ohm", description="`Conversion from ADC value to resistance in Ohms <ADC Value to Ohm_>`_"]		
-		MAVG [label="MAVG Filter", description="`Exponential Moving Average Filter`_"];
-		RAW_HF [label="HF", shape = endpoint, description="High Frequency raw value reading"];
-		PT1000 [label = "LF", shape = endpoint, description="Low Frequency PT1000 resistance value (see: `MAVG Filter <Exponential Moving Average Filter_>`_)"]
-		RAW_STREAM [label = "Stream", shape = endpoint, description="Raw value streaming"];
-
-		FRONTEND -> ADC -> WATCHDOG;
-		ADC -> PREFILTER [label="1 kHz"];
-		PREFILTER -> ADC2RES [label="1/6 kHz"];
-		ADC2RES -> MAVG;
-		MAVG -> PT1000 [label="1/6 kHz"];
-		PREFILTER -> RAW_HF [label="1/6 kHz"];
-		PREFILTER -> RAW_STREAM [label="1/6 kHz"];		
-	}
+.. drawio-image:: pt1000.drawio
 
 ADC
 ~~~
@@ -110,9 +87,16 @@ and can be changed in code using
 
 .. doxygenfunction:: adc_pt1000_set_moving_average_filter_param
 
-After initial startup and after each change of the filter constant, the filter will set the :ref:`safety_flags_adc_unstable` flag for a defined sample count of:
+The moving average filter is considered unstable, if the input to output difference is greater than
 
-.. doxygendefine:: ADC_FILTER_STARTUP_CYCLES
+.. doxygendefine:: ADC_PT1000_FILTER_UNSTABLE_DIFF
+
+In this case, the :ref:`safety_flags_adc_unstable` flag will be set until the filter output converges within the range for at least
+
+.. doxygendefine:: ADC_PT1000_FILTER_STABLE_SAMPLE_COUNT
+
+samples.
+If the input value keeps changing or oscillating, the error flag will be permanently set.
 
 The moving average filter's output signal is the Low Frequency (LF) PT1000 resistance signal used for internal PT1000 measurements.
 
@@ -136,19 +120,7 @@ are used to set the resistance calibration internally. For a guide on how to cal
 
 The calibration is calculated the following way:
 
-.. blockdiag::
-	:desctable:
-	
-	blockdiag {
-		orientation = portrait;
-		
-		LF [label="LF", shape=beginpoint, description="Low Frequency PT1000 Value"];
-		SENS [label="Sens", description="Sensitivity Correction :math:`\sigma`"];
-		OFFSET [label="Offset", description="Offset Correction :math:`O`"];
-		OUT [shape=endpoint, description="Corrected Value"];
-
-		LF -> OFFSET -> SENS -> OUT
-	}
+.. drawio-image:: calibration.drawio
 
 The final calibrated PT1000 resistance is calculated as:
 
@@ -157,11 +129,11 @@ The final calibrated PT1000 resistance is calculated as:
 
 The default values, if no calibration is loaded / executed, are:
 
-============== =========
-:math:`\sigma` :math:`O`
-============== =========
-      0            0
-============== =========
+======== =====================
+Offset	 Sensitivity Deviation
+======== =====================
+0        0
+======== =====================
 
 Get Calibration Corrected Value
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/source/firmware/pt1000.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2021-01-26T21:12:06.071Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.1.8 Chrome/87.0.4280.88 Electron/11.1.1 Safari/537.36" etag="PrKjQ8DyGBUrBwv3aoCi" version="14.1.8" type="device"><diagram name="Page-1" id="099fd60b-425b-db50-ffb0-6b813814b670">7Vxbd6M4Ev41Pmf3IT7cL49ObHfmTHqS7cx07+yLj4xlWx2MHJAvya9fCQQGJGPHBl/S0w9pKGQJqr66qKqgpd/N1l9CMJ9+xSPotzRltG7p3ZamuY5K/zLCW0JQLUtPKJMQjThtQ3hG75ATFU5doBGMCgMJxj5B8yLRw0EAPVKggTDEq+KwMfaLq87BBAqEZw/4IvUHGpFpQnVMZUO/h2gyTVdWFX5lCLyXSYgXAV+vpenj+F9yeQbSufj4aApGeJUj6b2WfhdiTJKj2foO+oy3KduS3/W3XM3uO4QB2ecH8N5wZ2TQ/+PnqoPhj3Xn0fp5o2r85shbyhA4ovzhpzgkUzzBAfB7G+pt/NCQTavQs82YB4znlKhS4k9IyBsXNlgQTElTMvP5VbhG5L/85+z4b3bcNvlZd5271H3LnTzBEM0ggSGnRSTEL/AO+ziM7113tKFuWWx0QMK3bAl2kluDnW4Wic/SVcbI93PzjUzojAxKF5nN+R/hRehxzv3UX5V38HU98L4twG/6+rszgTdcGwgIJ5BUSMJOxjHu5xbgovwCMX3u8I0OCKEPCFoW0Qu4EkyycdlPnzCit6wpXGF1i8Mx1dcU6OkUyY3yX23gRA9yt7EhxSD7CODsawbcobCKz/ZH7/lQqFp1w7AAoAq0VN32EvgLvlKnS2eyfPoMt8OQHk1IxpccpJYwJIja+AcwhP4TjhBBOKCXhpgQPGO8T40xE8QIRNMMXcBHEzbUozxmosrDKJ22w8cQBj8215ytO1tPmItsQ5/6qZCNa4MhFTLwSHsEvBjHBPA7iddFIR2ZnK9gxJ6EzjBCdOWueKkECqhSWNgyGLmWrQMrN1nuWtfsOd1KKLFnhOtK2fOrmlk0JS5X7dXGjdp8xDTnQQ2rIbCo5uWYFkc/xri03RrMCwxGHRYf0dMABzCh9BHjqczV7YGnw82PIZof6bjLsj6pMbwEQKnWIYCqRkCt3uyXgJM8pnJKIZW9X0hFZQPecsPmbEC0fRlXHrn19xxuKyWFSNY/NLqTa4xzTo1RCxpzhAFWf1Hzq1+U+TWE4K+LxmNIH58+rKZ0ZnMfjREMxXjwC0ABHRH/SEkTDZccHtK4cMBmGPtofp8ChB5/5zPXCJb94ztVLVoQ2xTiuywZkg/wXKUhQJgCIATJxjYUhr0lZKa0KJZzSzui44A/SLQ1anuLkAlnkGrveYSslbyEIsjYkIjYakrE1f6DG9KLSQec0oafKJYxaKhpaI5p879qAR4ZPurPFlU99LVqfAgjFBEcRu0lCBEY+nCQkmJzn08ABAzHYo7gPJa/ZPhFo2BJjELmDGq3Cu5uGOTCLc8HUYS8ouy2cmWnQuWe2pQ8dUo7Ni/rtm1Lyf0zi4pXYm1iLgS9++i0zSV/5duDq642HG27ry39Iaqd1tYogJT7d/rn4eli42ofT5A3mABCwywfr+bUHgyoIU0mPo9FdXfmSk1NNC515EqleX79WhRxWylke/FkLzWVFz/2VNPat8lbbLdSwsyJK3WC9j8DuuVmW+8/qV2km23lX3SM8nL//m8BTTmpF9R8NUVUKecglsOK6m29It5fIXWjyFxNjHEynS1oZA0xjpTdZ801H5s5+3gpM8u13ShtRc0oyQ0Yrn5Iyu1wzZckyKTjNPc0qm+XInC1HP/VlFK2DUO6Tl1J4qGrWl9ty/vr5vX19jnovg6Wy5uzdgAcnSP2h3EAk8YkeSjnMsV/t3JZ5CPKKHsbwxIia1MDqQT1RkBv2UXQ66f1d2K6ubee44AyEVExCznmr3iJggnLQ1MosB4zTeknIeZniIpP44Qt3bqoqFg1zmKaDizDNtQ/VNWdtrt/6GwlpKrbzvcPUclgprbfY5qm/ADEm44Y6epD2BS++RhWlr0vZ33q0x+xX6v37ZvA2dRG0RnRPIJFbdjJ63nOY/IZck60LIrxeKx5nkwUI2tomTWJwilt1WTbCd0RJZHSapeEVh1kxVHMRcZXpzRq9Tc7busPKe81m4nmjXIjilVvNC/PJKmfDmlnaR6vROhOv5vGyk1D2TQP25jWlpQSK4JPIRz/E3h/MHRw3csKvCUVPkPh2UVBrvQhSVEkgrjKMpqh0SgxPzBC76wSywXNbSqd17xtmV02F7U4UWJ8KguHH+C2vjP5L6unllWrvuBA2cLtvvVJOG5YOzkua01vjuOS1qXPxfFyxvLsHHcEjt/36XkXEED/a7F90eUI4CI2LVm9I79/1E4qNNENPPwjtGqhSTr2Tis0vbqWfCEbgCt4ca8ysN+5A+C5nwtJvOknzz/k64l2qYHfcM8s5t37N7Nu8W2psVjFBrDUTe/oK/toJkJYpvpVlfJwp3q4WSoUWW4Jr02kOUTX1A/ha5uS7qbQe5HCPd54NuePRLhV6qLgZLKPKvBVWvkPE8icD9UtzdRLJePk7Ni8gt5WiltStW0UJ8HjcQSPTSpIy5lXVfW5vKqxzEU1Vzb+sCkqv+FQ/kzGjvHp4zVrXcQdeVqfumlpFpixDBN/1V15nM4EwBbhGJdNnotlkxz0zpJyMktJkKxbPBe4OpK4tbGGK10s+GfFwU1RUOn7QKwNfv59hl1K9GqmI4hLWlxsbp8h5lB+zeKiKSqOrLbYnOKIOfj4qxysLTRpiflVdaYUxuqSrbnakMr8rvXu4X/Cx5fftYe38Y8/jf8tHUkLb+ePzsPjlwr3oX7YfZymgb7UP6/tm6uq401FKW81gbddNEGEtYopbGZNecZjsqLPXCu3T1Qfss0LY7fYWfK4IPMFC9zS7CBjerlLrxeGlD+JRYpqFcSJTIrQE3lCQUiDeIlNiY3/X0GU7CNT88+j1mAYzTNeXJs7kGyZBXFWuIPSTkLyHmVjqVqp7ESbdTUR1FGScJTia8w3JwyhpIK46s+knCrZcMLW83KIfaO5bce1TFO1NUPVbVcpNerV1+ay/SmrX3i+lOaWzSfuoE/98OHwOErDs6/OpgI0xI+V6Jqo4eV3DGrTcDFd/FuQhCtpYueZukvkI8KeokvVK/kQwFndZA2CMJ1i5Ch1ek11AsgDFjG3FueelNad1ro1O/ToLvkUy/Uzf/f+U/bBngNYT083Xy5OrN7m89B67/8=</diagram></mxfile>

doc/source/firmware/safety/flags.rst

@@ -68,7 +68,8 @@ no         no            yes           no
 ERR_FLAG_MEAS_ADC_UNSTABLE
 --------------------------
 
-``ERR_FLAG_MEAS_ADC_UNSTABLE`` is set after startup of the PT1000 measuremnt or after reconfiguring the filter settings.
+``ERR_FLAG_MEAS_ADC_UNSTABLE`` is set if the Moving Average Filter of the PT1000 ADC detects a bigger deviation between input and filtered output value.
+The flag is automatically cleared by the controller as soon as the unstable condition is not met anymore. For this, the filter input to filter output difference has to stay below a certain threshold for a defined amount of samples.
 
 .. seealso:: :ref:`firmware_meas_adc_filter`
 
@@ -86,7 +87,7 @@ ERR_FLAG_SAFETY_MEM_CORRUPT
 
 ``ERR_FLAG_SAFETY_MEM_CORRUPT`` is set during the initialization of the controller, in case a corrupted safety memory is encountered.
 In this case the error memory is reinitialized and the flag is set in the error memory. Afer a reboot it will stay asserted until the 
-safety backup memory is cleared
+safety backup memory is cleared.
 
 .. seealso:: :ref:`backup_ram`
 
@@ -102,7 +103,7 @@ yes        no            yes           no
 ERR_FLAG_STACK
 ---------------------------
 
-``ERR_FLAG_STACK`` ialization of the controller, in case a corrupted safety memory is encountered.
+``ERR_FLAG_STACK`` Shutdown of the controller, in case a corrupted safety memory is encountered.
 This error is not recoverable and will trigger the panic mode.
 
 .. seealso:: :ref:`safety_stack_checking`
@@ -112,3 +113,38 @@ persistent self-clearing Stops PID     Panic Mode
 ========== ============= ============= ===========
 yes        no            yes           yes
 ========== ============= ============= ===========
+
+.. _safety_flags_timing_pid:
+
+ERR_FLAG_TIMING_PID
+---------------------------
+
+``ERR_FLAG_TIMING_PID`` is set if the timing monitor of the PID controller detects a violation in the sample frequency.
+The flag is recoverable and only shuts down the PID and therefore the oven control output.
+
+.. seealso:: Timing Monitor
+
+========== ============= ============= ===========
+persistent self-clearing Stops PID     Panic Mode
+========== ============= ============= ===========
+no         no            yes           no
+========== ============= ============= ===========
+
+.. _safety_flags_overtemp:
+
+ERR_FLAG_OVERTEMP
+---------------------------
+
+``ERR_FLAG_OVERTEMP`` is set if the :ref:`pt1000_processing` detects an overtemperature.
+The default limit is set to:
+
+.. doxygendefine:: SAFETY_DEFAULT_OVERTEMP_LIMIT_DEGC
+
+However, it is possible to configure the limit and permanenty store it in the EEPROM since hardware version v1.3.
+
+
+========== ============= ============= ===========
+persistent self-clearing Stops PID     Panic Mode
+========== ============= ============= ===========
+no         no            yes           no
+========== ============= ============= ===========

doc/source/firmware/safety/index.rst

@@ -21,4 +21,5 @@ which are used to retain boot information across resets, for example to communic
 	flags
 	backup-ram
 	error-handling
+	startup-tests
 	stack-checking

doc/source/firmware/safety/stack-checking.rst

@@ -34,6 +34,6 @@ On each run of the safety controller's handling function (:c:func:`safety_contro
 .. doxygenfunction:: stack_check_corruption_detect_area
 
 
-This function constantly checks the memory area for write modifications, and therefore detects, if the stack or heap have grown outside their boundaries.
+This function checks the memory area for write modifications, and therefore detects, if the stack or heap have grown outside their boundaries. This canary approach does, however, not guarantee a full protection against heap or stack overflows. 
 
 

doc/source/firmware/safety/startup-tests.rst

@@ -0,0 +1,23 @@
+.. _safety_startup_tests:
+
+Startup Tests
+=============
+
+The following tests will be performed after each reset / power cycle of the controller.
+
+Internal Memory Test
+--------------------
+Directly after startup and after setting up the system clocks, the controller performs memory checks on the internal SRAM and the core coupled memory.
+
+RAM checking is performed by testing the following sequences:
+
+- Alternating 0x55AA55AA / 0xAA55AA55 pattern
+- Alternating 0xAA55AA55 / 0x55AA55AA pattern
+- 0xFFFFFFFF constant value
+- 0x00000000 constant value
+
+The following functions implement the RAM checking:
+
+.. doxygenfunction:: startup_test_perform_ccm_ram_check
+
+.. doxygenfunction:: startup_test_perform_system_ram_check

doc/source/hardware/hardware-watchdog.rst

@@ -0,0 +1,27 @@
+.. _hw_watchdog:
+
+Hardware Watchdog
+=================
+
+the PCB (> v1.3) is equipped with an external power supply monitor and hardware watchdog IC ``STM6822S``.
+The watchdog is periodically reset by the firmware.
+
+.. note:: The external watchdog is only activated in Release mode. When building the application in Debug mode, it is deactivated because setting breakpoints or other events that distrb the program flow would trigger a the external watchdog and force a software reset.
+
+
+During startup of the power supply, it keeps the controller in reset until the power supply is stable.
+The following picture shows the 3.3 Volt supply rail on channel 2 and the low active reset signal of the STM32F407 on channel 1.
+
+.. image:: hw_watchdog_delay.png
+    :alt: Image not found
+
+The total startup delay is larger than 200 ms.
+
+The follwoing figure shows the startup of the voltage rgulator and the reset signal.
+
+.. image:: hw_watchdog_startup.png
+    :alt: Image not found
+    
+The power supply is gradually ramped up over approximately 500 us. The external watchdog does not work fpr voltages below 0.9 Volt. Therefore the reset signal rises simultaneously.
+Once the supply voltage exceeds 0.9 Volts, the reset signal is pulled low. This ensures that the controller is not able to start until the > 200 ms startup time have passed.
+

doc/source/hardware/index.rst

@@ -3,7 +3,7 @@
 Hardware
 ========
 
-This guide on the reflow controller's hardware is based on the ``reflow-oven-control-pcb`` -- Version ``v1.2``
+This guide on the reflow controller's hardware is based on the ``reflow-oven-control-pcb`` -- Version ``v1.3``
 
 .. toctree::
 	:maxdepth: 2

doc/source/hardware/modifications.rst

@@ -1,7 +1,7 @@
-.. _hardware_modifications:
+.. _hardware_modifications_v1_2:
 
-Hardware Modifications
-======================
+Hardware Modifications for PCB v1.2
+===================================
 
 Analog Frontend
 ---------------
@@ -13,3 +13,11 @@ Power Supply
 ------------
 .. note::
 	Replace transformer ``BV-EI-303-2010`` with ``BV-EI-303-2050``, which has the same footprint but a little more power and does not heat that much.
+
+.. _hardware_modifications_v1_3:
+
+Hardware Modifications for PCB v1.3
+===================================
+
+.. note::
+	solder jumpers to bridge GND and Earth together must be soldered for the SD card slot to work properly. The card detect's switch terminal is on Earth potential.

doc/source/index.rst

@@ -10,7 +10,8 @@ Quick Links
 ===========
 
 * :ref:`genindex`
-* :ref:`hardware_modifications`
+* :ref:`hardware_modifications_v1_2`
+* :ref:`hardware_modifications_v1_3` 
 
 .. warning::
 	Although the Shimatta Reflow Controller provides a bunch of safety mechanisms that -- in theory -- prevent your house from burning down, NEVER leave the oven controller running unattended. This project is published 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.

doc/source/license.rst

@@ -9,8 +9,36 @@ The firmware includes following third-party software libraries:
 - ``shellmatta`` by ``Stefan Strobel`` <https://git.shimatta.net/shimatta/shellmatta>, licensed under ``Mozilla Public License Version 2.0``
 - ``CMSIS`` by ``ARM Limited`` <https://github.com/ARM-software/CMSIS_5>, licensed under ``Apache License Version 2.0, January 2004``
 - ``STM Header files and startup code`` by ``ST Microelectronics``, licensed under a `custom license <ST License for Used Header Files_>`_
+- ``SHA-256 Library`` by ``Alain Mosnier`` <https://github.com/amosnier/sha-2>, licensed under ``Zero Clause BSD License`` or the ``Unlicense``
+- ``FatFS`` Library by ``ChaN`` licensed under a `custom license <FatFS License_>`_ 
 
 
+FatFS License
+-------------
+
+FatFs has being developped as a personal project of the author, ChaN. It is free from the code anyone else wrote at current release. Following code block shows a copy of the FatFs license document that heading the source files.::
+
+	/*----------------------------------------------------------------------------/
+	/  FatFs - Generic FAT Filesystem Module  Rx.xx                               /
+	/-----------------------------------------------------------------------------/
+	/
+	/ Copyright (C) 20xx, ChaN, all right reserved.
+	/
+	/ FatFs module is an open source software. Redistribution and use of FatFs in
+	/ source and binary forms, with or without modification, are permitted provided
+	/ that the following condition is met:
+	/
+	/ 1. Redistributions of source code must retain the above copyright notice,
+	/    this condition and the following disclaimer.
+	/
+	/ This software is provided by the copyright holder and contributors "AS IS"
+	/ and any warranties related to this software are DISCLAIMED.
+	/ The copyright owner or contributors be NOT LIABLE for any damages caused
+	/ by use of this software.
+	/----------------------------------------------------------------------------*/
+
+Therefore FatFs license is one of the BSD-style licenses, but there is a significant feature. FatFs is mainly intended for embedded systems. In order to extend the usability for commercial products, the redistributions of FatFs in binary form, such as embedded code, binary library and any forms without source code, do not need to include about FatFs in the documentations. This is equivalent to the 1-clause BSD license. Of course FatFs is compatible with the most of open source software licenses include GNU GPL. When you redistribute the FatFs source code with changes or create a fork, the license can also be changed to GNU GPL, BSD-style license or any open source software license that not conflict with FatFs license.
+
 ST License for Used Header Files
 --------------------------------
 

doc/source/reflow-profiles/reflow-245.tpr

@@ -0,0 +1,15 @@
+# This is a comment
+pid_conf 10 0.3 5 60 2.5 0.5
+temp_set 50
+wait_temp 45
+temp_set 45
+temp_ramp 150 120
+temp_ramp 190 90
+pid_conf 9 0.5 6 60 2.5 0.5
+temp_set 250
+wait_temp 245
+temp_off
+beep 1
+wait_time 1
+beep 0
+

error-mem-viewer/.gitignore

@@ -0,0 +1,3 @@
+*.ui~
+*.user
+*.user*

error-mem-viewer/CMakeLists.txt

@@ -0,0 +1,26 @@
+project(error-mem-viewer)
+cmake_minimum_required(VERSION 2.8)
+find_package(PkgConfig REQUIRED)
+
+pkg_search_module(GLIB REQUIRED glib-2.0)
+pkg_check_modules(GTK3 REQUIRED gtk+-3.0)
+pkg_check_modules(GTK_MOD REQUIRED gmodule-2.0)
+
+aux_source_directory("src" SRCES)
+include_directories("include" ${GLIB_INCLUDE_DIRS} ${GTK3_INCLUDE_DIRS} ${GTK_MOD_INCLUDE_DIRS})
+
+add_subdirectory(resources)
+
+set(SOURCE_GENERATED
+  ${CMAKE_CURRENT_BINARY_DIR}/resources/resources.c
+)
+SET_SOURCE_FILES_PROPERTIES(${SOURCE_GENERATED} PROPERTIES GENERATED 1)
+
+add_compile_options(-Wall -Wextra -Wold-style-declaration -Wuninitialized -Wmaybe-uninitialized -Wunused-parameter)
+
+link_directories(${GLIB_LINK_DIRS} ${GTK3_LINK_DIRS} ${GTK_MOD_LINK_DIRS})
+add_definitions(${GLIB2_CFLAGS_OTHER} ${GTK_MOD_CFLAGS_OTHER})
+
+add_executable(${PROJECT_NAME} ${SRCES} ${SOURCE_GENERATED})
+target_link_libraries(${PROJECT_NAME} ${GLIB_LDFLAGS} ${GTK3_LDFLAGS} ${GTK_MOD_LDFLAGS})
+add_dependencies(${PROJECT_NAME} glib-resources)

error-mem-viewer/include/error-mem-viewer/crc.h

@@ -0,0 +1,10 @@
+#ifndef _CRC_H_
+#define _CRC_H_
+
+#include <stdint.h>
+#include <stddef.h>
+
+uint32_t calculate_stm_crc(uint32_t *data, size_t len);
+
+
+#endif /* _CRC_H_ */

error-mem-viewer/include/error-mem-viewer/err-mem-viewer-hex-cell-renderer.h

@@ -0,0 +1,15 @@
+#ifndef _ERR_MEM_VIEWER_ADDRESS_CELL_RENDERER_H_
+#define _ERR_MEM_VIEWER_ADDRESS_CELL_RENDERER_H_
+
+#include <gtk/gtk.h>
+
+G_BEGIN_DECLS
+
+G_DECLARE_FINAL_TYPE(ErrMemViewHexCellRenderer, err_mem_view_hex_cell_renderer, ERR_MEM_VIEW, HEX_CELL_RENDERER, GtkCellRendererText)
+#define ERR_MEM_VIEW_TYPE_HEX_CELL_RENDERER (err_mem_view_address_cell_renderer_get_type())
+
+GtkCellRenderer *err_mem_view_hex_cell_renderer_new();
+
+G_END_DECLS
+
+#endif /* _ERR_MEM_VIEWER_ADDRESS_CELL_RENDERER_H_ */

error-mem-viewer/include/error-mem-viewer/safety-memory-types.h

@@ -0,0 +1,58 @@
+#ifndef _SAFETY_MEM_TYPES_H_
+#define _SAFETY_MEM_TYPES_H_
+
+#include <stdint.h>
+
+/**
+ * @brief Magic number to signal a valid safety memory header.
+ */
+#define SAFETY_MEMORY_MAGIC 0x12AA5CB7
+
+/**
+ * @brief Error memory NOP entry
+ */
+#define SAFETY_MEMORY_NOP_ENTRY 0xC1AA1222
+
+/**
+ * @brief Safety memory header
+ */
+struct safety_memory_header {
+        uint32_t magic;			/**< @brief Magic. Set to @ref SAFETY_MEMORY_MAGIC */
+        uint32_t boot_status_offset;	/**< @brief Offset of the safety_memory_boot_status struct (in 32 bit words)*/
+        uint32_t config_overrides_offset; /**< @brief Offset address of override entries */
+        uint32_t config_overrides_len;	/**< @brief Length of override entries in words */
+        uint32_t firmware_update_filename; /**< @brief Filename of the firmware update. This string is at maximum 256 bytes long including the 0 terminator */
+        uint32_t err_memory_offset;	/**< @brief Offset of the error memory */
+        uint32_t err_memory_end;	/**< @brief End of the error memory. This points to the word after the error memory, containing the CRC of the whole backup RAM. */
+        uint32_t crc;		/**< @brief  CRC of the header */
+};
+
+struct safety_memory_boot_status {
+        /**
+         * @brief Reboot into the bootloader
+         *
+         * When this flag is set, the controller will load the bootloader to
+         * memory and execute it.
+         */
+        uint32_t reboot_to_bootloader;
+
+        /**
+         * @brief Bootloader has updated the code
+         *
+         * This flag is set, if the firmware ahs been updated successfully
+         */
+        uint32_t code_updated;
+
+        /**
+         * @brief reset_from_panic
+         *
+         * This flag is set, when entering the panic mode.
+         * Because the panic mode is reset by a watchdog reset,
+         * this flag is needed, in order to ensure, that the panic is handled correcly after
+         * the watchdog reset.
+         */
+        uint32_t reset_from_panic;
+};
+
+
+#endif /* _SAFETY_MEM_TYPES_H_ */

error-mem-viewer/resources/CMakeLists.txt

@@ -0,0 +1,9 @@
+add_custom_target(glib-resources DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/resources.c")
+add_custom_command(DEPENDS
+	                 "${CMAKE_CURRENT_SOURCE_DIR}/*.ui"
+			 "${CMAKE_CURRENT_SOURCE_DIR}/resources.xml"
+		   OUTPUT
+		        "${CMAKE_CURRENT_BINARY_DIR}/resources.c"
+		   COMMAND 
+			glib-compile-resources --target="${CMAKE_CURRENT_BINARY_DIR}/resources.c" --sourcedir="${CMAKE_CURRENT_SOURCE_DIR}" --generate-source "${CMAKE_CURRENT_SOURCE_DIR}/resources.xml"
+		   )

error-mem-viewer/resources/main-window.ui

@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Generated with glade 3.38.1 -->
+<interface>
+  <requires lib="gtk+" version="3.24"/>
+  <object class="GtkWindow" id="main-window">
+    <property name="name">main-window</property>
+    <property name="can-focus">False</property>
+    <child>
+      <object class="GtkBox">
+        <property name="visible">True</property>
+        <property name="can-focus">False</property>
+        <property name="orientation">vertical</property>
+        <child>
+          <object class="GtkInfoBar" id="info-bar">
+            <property name="visible">True</property>
+            <property name="can-focus">False</property>
+            <property name="message-type">warning</property>
+            <property name="show-close-button">True</property>
+            <property name="revealed">False</property>
+            <signal name="response" handler="info_bar_close_cb" swapped="no"/>
+            <child internal-child="action_area">
+              <object class="GtkButtonBox">
+                <property name="can-focus">False</property>
+                <property name="spacing">6</property>
+                <property name="layout-style">end</property>
+                <child>
+                  <placeholder/>
+                </child>
+                <child>
+                  <placeholder/>
+                </child>
+                <child>
+                  <placeholder/>
+                </child>
+              </object>
+              <packing>
+                <property name="expand">False</property>
+                <property name="fill">False</property>
+                <property name="position">0</property>
+              </packing>
+            </child>
+            <child internal-child="content_area">
+              <object class="GtkBox">
+                <property name="can-focus">False</property>
+                <property name="spacing">16</property>
+                <child>
+                  <placeholder/>
+                </child>
+                <child>
+                  <placeholder/>
+                </child>
+                <child>
+                  <placeholder/>
+                </child>
+              </object>
+              <packing>
+                <property name="expand">False</property>
+                <property name="fill">False</property>
+                <property name="position">0</property>
+              </packing>
+            </child>
+            <child>
+              <placeholder/>
+            </child>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">True</property>
+            <property name="position">0</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkScrolledWindow">
+            <property name="visible">True</property>
+            <property name="can-focus">True</property>
+            <property name="shadow-type">in</property>
+            <child>
+              <object class="GtkTreeView" id="error-mem-tree-view">
+                <property name="visible">True</property>
+                <property name="can-focus">True</property>
+                <child internal-child="selection">
+                  <object class="GtkTreeSelection"/>
+                </child>
+              </object>
+            </child>
+          </object>
+          <packing>
+            <property name="expand">True</property>
+            <property name="fill">True</property>
+            <property name="position">1</property>
+          </packing>
+        </child>
+      </object>
+    </child>
+    <child type="titlebar">
+      <object class="GtkHeaderBar" id="header-bar">
+        <property name="visible">True</property>
+        <property name="can-focus">False</property>
+        <property name="title" translatable="yes">Error Memory Viewer</property>
+        <property name="subtitle" translatable="yes">Reflow Controller Error Memory Viewer</property>
+        <property name="show-close-button">True</property>
+        <child>
+          <object class="GtkButton" id="open-button">
+            <property name="label">gtk-open</property>
+            <property name="name">open-button</property>
+            <property name="visible">True</property>
+            <property name="can-focus">True</property>
+            <property name="receives-default">True</property>
+            <property name="use-stock">True</property>
+            <property name="always-show-image">True</property>
+            <signal name="clicked" handler="open_button_clicked_cb" swapped="no"/>
+            <style>
+              <class name="suggested-action"/>
+            </style>
+          </object>
+        </child>
+      </object>
+    </child>
+  </object>
+</interface>

error-mem-viewer/resources/resources.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<gresources>
+	<gresource prefix="/gui">
+		<file compressed="true" alias="main">main-window.ui</file>
+	</gresource>
+</gresources>

error-mem-viewer/src/crc.c

@@ -0,0 +1,25 @@
+#include <error-mem-viewer/crc.h>
+
+static uint32_t do_crc(uint32_t init, uint32_t data)
+{
+	uint32_t crc = init;
+	uint32_t cnt;
+
+	for (cnt=0; cnt < 32; cnt++) {
+		crc = ((int32_t)(crc ^ data))<0 ? (crc << 1) ^ 0x04C11DB7 : crc << 1;
+		data <<=1;
+	}
+
+	return crc;
+}
+
+uint32_t calculate_stm_crc(uint32_t *data, size_t len)
+{
+	uint32_t crc = ~0U;
+
+	while (len--) {
+		crc = do_crc(crc, *data++);
+	}
+
+	return crc;
+}

error-mem-viewer/src/err-mem-viewer-hex-cell-renderer.c

@@ -0,0 +1,81 @@
+#include <error-mem-viewer/err-mem-viewer-hex-cell-renderer.h>
+#include <string.h>
+
+struct _ErrMemViewHexCellRenderer {
+	GtkCellRendererText base;
+};
+
+enum {
+	PROP_HEXNUM = 1,
+	PROP_COUNT
+};
+
+G_DEFINE_TYPE(ErrMemViewHexCellRenderer, err_mem_view_address_cell_renderer, GTK_TYPE_CELL_RENDERER_TEXT)
+
+static void err_mem_view_address_cell_renderer_init(ErrMemViewHexCellRenderer *self)
+{
+	(void)self;
+}
+
+static void convert_gvalue_uint_to_string(const GValue *in, GValue *out)
+{
+	uint32_t val;
+	char text[32];
+
+	if (!in || !out)
+		return;
+
+	g_value_init(out, G_TYPE_STRING);
+
+	val = g_value_get_uint(in);
+	snprintf(text, sizeof(text), "0x%08X", val);
+	g_value_set_string(out, text);
+}
+
+static void err_mem_view_address_cell_renderer_set_property(GObject *obj, guint param_id, const GValue *value, GParamSpec *pspec)
+{
+	GValue val = G_VALUE_INIT;
+
+	switch (param_id) {
+	case PROP_HEXNUM:
+		convert_gvalue_uint_to_string(value, &val);
+		g_object_set_property(obj, "text", &val);
+		g_value_unset(&val);
+		break;
+	default:
+		G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
+		break;
+	}
+}
+
+static void err_mem_view_address_cell_renderer_get_property(GObject      *object,
+							    guint        param_id,
+							    GValue	*value,
+							    GParamSpec   *pspec)
+{
+	(void)value;
+
+	switch (param_id) {
+	default:
+		G_OBJECT_WARN_INVALID_PROPERTY_ID(object, param_id, pspec);
+		break;
+	}
+}
+
+static GParamSpec *properties[PROP_COUNT];
+
+void err_mem_view_address_cell_renderer_class_init(ErrMemViewHexCellRendererClass *klass)
+{
+	GObjectClass *oclass = G_OBJECT_CLASS(klass);
+
+	oclass->set_property = err_mem_view_address_cell_renderer_set_property;
+	oclass->get_property = err_mem_view_address_cell_renderer_get_property;
+
+	properties[PROP_HEXNUM] = g_param_spec_uint("hex-num", "hex-num", "Hex number to display", 0U, UINT_MAX, 0U, G_PARAM_WRITABLE);
+	g_object_class_install_properties(oclass, PROP_COUNT, properties);
+}
+
+GtkCellRenderer *err_mem_view_hex_cell_renderer_new()
+{
+	return GTK_CELL_RENDERER(g_object_new(ERR_MEM_VIEW_TYPE_HEX_CELL_RENDERER, NULL));
+}

error-mem-viewer/src/main.c

@@ -0,0 +1,542 @@
+#include <gtk/gtk.h>
+#include <glib.h>
+#include <stdint.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <stdarg.h>
+#include <stdbool.h>
+#include <error-mem-viewer/err-mem-viewer-hex-cell-renderer.h>
+#include <error-mem-viewer/safety-memory-types.h>
+#include <error-mem-viewer/crc.h>
+
+enum memory_view_columns {
+	MEM_VIEW_COL_ADDRESS = 0,
+	MEM_VIEW_COL_DATA,
+	MEM_VIEW_COL_INTERPRETATION,
+	MEM_VIEW_COLOR,
+	MEM_VIEW_COLUMN_COUNT
+};
+
+struct application_data {
+	GtkWidget *borrowed_main_window;
+	GtkTreeView *borrowed_tree_view;
+	GtkHeaderBar *borrowed_header_bar;
+	GtkInfoBar *borrowed_info_bar;
+	const char *error_memory_data;
+	size_t file_size;
+};
+
+enum entry_state {
+	ENTRY_STATE_VALID = 0,
+	ENTRY_STATE_INVALID,
+	ENTRY_STATE_NOT_PARSED,
+	ENTRY_STATE_BLOCK
+};
+
+static void append_data(GtkTreeStore *store, GtkTreeIter *parent, GtkTreeIter *iter, GString *interpretation, enum entry_state state, uint32_t addr, uint32_t val)
+{
+	const GdkRGBA invalid_color = {
+		.red = 1.0,
+		.alpha = 1.0,
+		.green = 0.0,
+		.blue = 0.0,
+	};
+
+	const GdkRGBA valid_color = {
+		.red = 0.0,
+		.alpha = 1.0,
+		.green = 1.0,
+		.blue = 0.0,
+	};
+
+	const GdkRGBA warn_color = {
+		.red = 1.0,
+		.alpha = 1.0,
+		.green = 1.0,
+		.blue = 0.0,
+	};
+
+	const GdkRGBA block_color = {
+		.red = 1.0,
+		.alpha = 1.0,
+		.green = 0.3,
+		.blue = 0.5,
+	};
+
+	const GdkRGBA *col;
+
+	switch (state) {
+	case ENTRY_STATE_VALID:
+		col = &valid_color;
+		break;
+	case ENTRY_STATE_NOT_PARSED:
+		col = &warn_color;
+		break;
+	case ENTRY_STATE_BLOCK:
+		col = &block_color;
+		break;
+	case ENTRY_STATE_INVALID:
+	default:
+		col = &invalid_color;
+		break;
+	}
+
+	gtk_tree_store_append(store, iter, parent);
+	gtk_tree_store_set(store, iter, MEM_VIEW_COL_ADDRESS, addr, MEM_VIEW_COLOR, col, MEM_VIEW_COL_INTERPRETATION, (interpretation ? interpretation->str : ""), MEM_VIEW_COL_DATA, val, -1);
+	if (interpretation)
+		g_string_free(interpretation, TRUE);
+}
+
+static void info_bar_show_message(GtkInfoBar *info_bar, GtkMessageType type, const char *format, ...)
+{
+	GString *string;
+	va_list args;
+	GtkWidget *content;
+	GList *children, *iter;
+	GtkWidget *label;
+
+	va_start(args, format);
+	string = g_string_new(NULL);
+
+	g_string_vprintf(string, format, args);
+	va_end(args);
+
+	content = gtk_info_bar_get_content_area(info_bar);
+	children = gtk_container_get_children(GTK_CONTAINER(content));
+	for (iter = children; iter; iter = g_list_next(iter))
+		gtk_widget_destroy(GTK_WIDGET(iter->data));
+	g_list_free(children);
+
+	label = gtk_label_new(string->str);
+	gtk_container_add(GTK_CONTAINER(content), label);
+	gtk_widget_show(label);
+	gtk_info_bar_set_message_type(info_bar, type);
+	gtk_widget_show(GTK_WIDGET(info_bar));
+	gtk_info_bar_set_revealed(info_bar, TRUE);
+
+	g_string_free(string, TRUE);
+}
+
+static bool check_err_mem_header(struct safety_memory_header *header, uint32_t *expected)
+{
+	uint32_t crc;
+
+	crc = calculate_stm_crc((uint32_t *)header, sizeof(*header) / sizeof(uint32_t) - 1);
+	if (expected)
+		*expected = crc;
+	if (crc == header->crc)
+		return true;
+	else
+		return false;
+}
+
+static GString *new_string_printf(const char *fmt, ...)
+{
+	GString *string;
+	va_list args;
+
+	va_start(args, fmt);
+
+	string = g_string_new(NULL);
+	g_string_vprintf(string, fmt, args);
+
+	va_end(args);
+
+	return string;
+}
+
+static void show_error_memory(GtkTreeView *tree_view, const unsigned char *memory, size_t len)
+{
+	GtkTreeStore *store;
+	GtkTreeIter iter;
+	GtkTreeIter iter2;
+	GtkTreeIter *parent_iter, *child_iter;
+	enum entry_state state;
+	GString *interpret;
+	bool valid;
+	bool analyze_further = true;
+	struct safety_memory_header header;
+	unsigned int i;
+	uint32_t dat, expected_value;
+
+	store = GTK_TREE_STORE(gtk_tree_view_get_model(tree_view));
+	gtk_tree_store_clear(store);
+
+	for (i = 0; i < len / 4; i++) {
+		valid = false;
+		interpret = NULL;
+		dat = memory[i*4];
+		dat |= ((uint32_t)memory[i*4+1]) << 8;
+		dat |= ((uint32_t)memory[i*4+2]) << 16;
+		dat |= ((uint32_t)memory[i*4+3]) << 24;
+
+		state = ENTRY_STATE_NOT_PARSED;
+
+		if (!analyze_further) {
+			interpret = g_string_new("Not analyzed due to previous error");
+			state = ENTRY_STATE_NOT_PARSED;
+			parent_iter = NULL;
+			child_iter = &iter;
+			goto print;
+		}
+		/* Parse header */
+		switch (i) {
+		case 0: /* Magic */
+			parent_iter = NULL;
+			child_iter = &iter;
+			append_data(store, parent_iter, child_iter, new_string_printf("Header"), ENTRY_STATE_BLOCK, i * 4, dat);
+			parent_iter = child_iter;
+			child_iter = &iter2;
+			if (dat == SAFETY_MEMORY_MAGIC) {
+				valid = true;
+				interpret = g_string_new("Valid Header Magic");
+			} else {
+				interpret = g_string_new("Invalid Header Magic");
+				analyze_further = false;
+			}
+			header.magic = dat;
+			break;
+		case 1:
+			header.boot_status_offset = dat;
+
+			valid = true;
+			interpret = new_string_printf("Boot status offset addr: %u", dat);
+			break;
+		case 2:
+			header.config_overrides_offset = dat;
+			interpret = new_string_printf("Config override offset addr: %u", dat);
+			valid = true;
+			break;
+		case 3:
+			header.config_overrides_len = dat;
+			interpret = new_string_printf("Config override length: %u", dat);
+			valid = true;
+			break;
+		case 4:
+			header.firmware_update_filename = dat;
+			interpret = new_string_printf("Offset of FW update filename: %u", dat);
+			valid = true;
+			break;
+		case 5:
+			header.err_memory_offset = dat;
+			interpret = new_string_printf("Error memory offset addr: %u", dat);
+			valid = true;
+			break;
+		case 6:
+			header.err_memory_end = dat;
+			interpret = new_string_printf("Error memory end ptr: %u", dat);
+			valid = true;
+			break;
+		case 7:
+			header.crc = dat;
+			valid = check_err_mem_header(&header, &expected_value);
+			if (valid) {
+				interpret = new_string_printf("Header CRC: 0x%08X", dat);
+			} else {
+
+				interpret = new_string_printf("Invalid CRC: 0x%08X | Expected: 0x%08X", dat, expected_value);
+				analyze_further = false;
+			}
+			break;
+		}
+		if (i <= 7) {
+			state = ENTRY_STATE_INVALID;
+			goto print;
+		}
+
+		/* Check if we're in the boot status structure */
+		if (i >= header.boot_status_offset && i < header.boot_status_offset + sizeof(struct safety_memory_boot_status) / 4) {
+			if (i == header.boot_status_offset) {
+				/* First entry of boot status struct */
+				parent_iter = NULL;
+				child_iter = &iter;
+				interpret = new_string_printf("Boot Status Struct");
+				append_data(store, parent_iter, child_iter, interpret, ENTRY_STATE_BLOCK, i * 4, dat);
+				parent_iter = &iter;
+				child_iter = &iter2;
+				interpret = NULL;
+			}
+			switch (i - header.boot_status_offset) {
+			case 0:
+				interpret = new_string_printf("%s into bootloader", (dat ? "Boot" : "Do not boot"));
+				valid = true;
+				break;
+			case 1:
+				interpret = new_string_printf("Code %s been updated", (dat ? "has" : "hasn't"));
+				valid = true;
+				break;
+			case 2:
+				interpret = new_string_printf("Panic %s", (dat ? "occured" : "did not occur"));
+				valid = true;
+				break;
+			default:
+				valid = false;
+				interpret = new_string_printf("Value undefined!");
+				break;
+			}
+			state = ENTRY_STATE_INVALID;
+			goto print;
+		}
+
+		if (i >= header.config_overrides_offset && i < (header.config_overrides_offset + header.config_overrides_len)) {
+			if (i == header.config_overrides_offset) {
+				parent_iter  = NULL;
+				child_iter = &iter;
+				append_data(store, parent_iter, child_iter,
+					    new_string_printf("Config Overrides"),
+					    ENTRY_STATE_BLOCK, i * 4, dat);
+				parent_iter = child_iter;
+				child_iter = &iter2;
+			}
+
+			interpret = new_string_printf("Config Overrides not yet implemented");
+			valid = true;
+			state = ENTRY_STATE_INVALID;
+			goto print;
+		}
+
+		if (i >= header.err_memory_offset && i < header.err_memory_end) {
+			if (i == header.err_memory_offset) {
+				parent_iter  = NULL;
+				child_iter = &iter;
+				append_data(store, parent_iter, child_iter,
+					    new_string_printf("Error Memory (length: %d)", header.err_memory_end - header.err_memory_offset),
+					    ENTRY_STATE_BLOCK, i * 4, dat);
+				parent_iter = child_iter;
+				child_iter = &iter2;
+			}
+
+			switch (dat) {
+			case SAFETY_MEMORY_NOP_ENTRY:
+				valid = true;
+				interpret = new_string_printf("Error Memory NOP");
+				break;
+			default:
+				if ((dat & 0xFFU) == 0x51U) {
+					valid = true;
+					interpret = new_string_printf("Err memory Entry");
+				} else
+					interpret = new_string_printf("Invalid error memory entry");
+				break;
+			}
+			state = ENTRY_STATE_INVALID;
+			goto print;
+		}
+
+		if (i == header.err_memory_end) {
+			expected_value = calculate_stm_crc((uint32_t *)memory, header.err_memory_end);
+			if (expected_value == dat) {
+				interpret = new_string_printf("Valid Memory CRC");
+				valid = true;
+			} else {
+				interpret = new_string_printf("Invalid CRC. Expected: 0x%08X", expected_value);
+			}
+			state = ENTRY_STATE_INVALID;
+			parent_iter = NULL;
+			child_iter = &iter;
+			goto print;
+		}
+
+		parent_iter = NULL;
+		child_iter = &iter;
+print:
+		if (state != ENTRY_STATE_NOT_PARSED) {
+			state = (valid ? ENTRY_STATE_VALID : ENTRY_STATE_INVALID);
+		}
+		append_data(store, parent_iter, child_iter, interpret, state, i * 4, dat);
+	}
+
+
+	if (!store)
+		return;
+}
+
+void setup_tree_view(GtkTreeView *tree_view)
+{
+	GtkTreeStore *tree_store;
+	GtkCellRenderer *string_renderer;
+	GtkCellRenderer *hex_renderer;
+	GtkTreeViewColumn *column;
+
+	g_return_if_fail(GTK_IS_TREE_VIEW(tree_view));
+
+	tree_store = gtk_tree_store_new(MEM_VIEW_COLUMN_COUNT, G_TYPE_UINT, G_TYPE_UINT, G_TYPE_STRING, GDK_TYPE_RGBA);
+	gtk_tree_view_set_model(tree_view, GTK_TREE_MODEL(tree_store));
+
+	string_renderer = gtk_cell_renderer_text_new();
+	hex_renderer = err_mem_view_hex_cell_renderer_new();
+
+	column = gtk_tree_view_column_new_with_attributes("Address", hex_renderer, "hex-num", MEM_VIEW_COL_ADDRESS, "foreground-rgba", MEM_VIEW_COLOR, NULL);
+	gtk_tree_view_append_column(tree_view, column);
+	column = gtk_tree_view_column_new_with_attributes("Data", hex_renderer, "hex-num", MEM_VIEW_COL_DATA, "foreground-rgba", MEM_VIEW_COLOR, NULL);
+	gtk_tree_view_append_column(tree_view, column);
+	column = gtk_tree_view_column_new_with_attributes("Interpretation", string_renderer, "text", MEM_VIEW_COL_INTERPRETATION, "foreground-rgba", MEM_VIEW_COLOR, NULL);
+	gtk_tree_view_append_column(tree_view, column);
+}
+
+static ptrdiff_t get_file_size(const char *filename)
+{
+	struct stat file_stat;
+	int res;
+	ptrdiff_t size;
+
+	res = stat(filename, &file_stat);
+
+	if (res)
+		size = -1UL;
+	else
+		size = (ptrdiff_t)file_stat.st_size;
+
+	return size;
+
+}
+
+/**
+ * @brief Loads a file to memory and decodes it using base64
+ * @param name Filename
+ * @param detected_size detected Size of the ouput generated
+ * @return Buffer of decoded data with size \p detected_size, NULL in case of an error.
+ * @note Return buffer is allocated on heap. Use free() to free the memory.
+ */
+static char *load_file_to_memory(const char *name, size_t *detected_size)
+{
+	ptrdiff_t size;
+	FILE *f;
+	char *ret = NULL;
+	size_t read_bytes;
+	gsize decoded_size;
+
+	size = get_file_size(name);
+	if (size <= 0)
+		goto exit;
+
+	f = fopen(name, "rb");
+	ret = (char *)malloc(size + 1);
+	if (!ret)
+		goto exit_close_file;
+
+	read_bytes = fread(ret, 1UL, (size_t)size, f);
+	if (read_bytes != (size_t)size) {
+		free(ret);
+		ret = NULL;
+		goto exit_close_file;
+	}
+
+	ret[size] = '\0';
+
+	g_base64_decode_inplace(ret, &decoded_size);
+	if (decoded_size == 0) {
+		free(ret);
+		ret = NULL;
+		goto exit_close_file;
+	}
+
+	if (detected_size)
+		*detected_size = (size_t)decoded_size;
+exit_close_file:
+	fclose(f);
+exit:
+	return ret;
+}
+
+G_MODULE_EXPORT
+void info_bar_close_cb(GtkInfoBar *info_bar, gpointer user_data)
+{
+	(void)user_data;
+
+	gtk_info_bar_set_revealed(info_bar, FALSE);
+}
+
+G_MODULE_EXPORT
+void open_button_clicked_cb(GtkButton *button, gpointer *user_data)
+{
+	struct application_data *data = (struct application_data *)user_data;
+	(void)button;
+	GtkDialog *dialog;
+	gint res;
+	gchar *filename;
+
+
+	dialog = GTK_DIALOG(gtk_file_chooser_dialog_new("Open File", GTK_WINDOW(data->borrowed_main_window),
+							GTK_FILE_CHOOSER_ACTION_OPEN,
+							"Cancel", GTK_RESPONSE_CANCEL,
+							"Open", GTK_RESPONSE_ACCEPT,
+							NULL));
+	res = gtk_dialog_run(dialog);
+	if (res == GTK_RESPONSE_ACCEPT) {
+		filename = gtk_file_chooser_get_filename(GTK_FILE_CHOOSER(dialog));
+		if (data->error_memory_data)
+			free((void *)data->error_memory_data);
+		data->error_memory_data = load_file_to_memory(filename, &data->file_size);
+		if (!data->error_memory_data) {
+			g_warning("File could not be loaded");
+			g_free(filename);
+			goto ret_destroy_dialog;
+		}
+
+		gtk_header_bar_set_subtitle(data->borrowed_header_bar, filename);
+		g_free(filename);
+	} else {
+		goto ret_destroy_dialog;
+	}
+
+	if (data->file_size % 4 || data->file_size == 0) {
+		free((void *)data->error_memory_data);
+		data->error_memory_data = NULL;
+		info_bar_show_message(data->borrowed_info_bar, GTK_MESSAGE_WARNING,
+				      "Data must be base64 encoded and must contain full 32 bit words of data.");
+		goto ret_destroy_dialog;
+	}
+
+	show_error_memory(data->borrowed_tree_view, (const unsigned char *)data->error_memory_data, data->file_size);
+
+ret_destroy_dialog:
+	gtk_widget_destroy(GTK_WIDGET(dialog));
+}
+
+static void app_activated(GApplication *app, gpointer user_data)
+{
+	struct application_data *data = (struct application_data *)user_data;
+	GtkBuilder *builder;
+	GtkWindow *main_window;
+
+	builder = gtk_builder_new_from_resource("/gui/main");
+	main_window = GTK_WINDOW(gtk_builder_get_object(builder, "main-window"));
+	data->borrowed_main_window = GTK_WIDGET(main_window);
+	data->error_memory_data = NULL;
+	data->borrowed_tree_view = GTK_TREE_VIEW(gtk_builder_get_object(builder, "error-mem-tree-view"));
+	data->borrowed_header_bar = GTK_HEADER_BAR(gtk_builder_get_object(builder, "header-bar"));
+	data->borrowed_info_bar = GTK_INFO_BAR(gtk_builder_get_object(builder, "info-bar"));
+
+	setup_tree_view(data->borrowed_tree_view);
+
+	gtk_builder_connect_signals(builder, data);
+	g_object_unref(builder);
+	gtk_application_add_window(GTK_APPLICATION(app), main_window);
+	gtk_widget_show(GTK_WIDGET(main_window));
+}
+
+static int start_gui(int argc, char **argv)
+{
+	int ret = 0;
+	GtkApplication *g_app;
+	static struct application_data data;
+
+	/* Create a new G application which will start a completely new process for each call to the program (NON_UNIQUE) instead
+	 * of creating an additional window in the same process
+	 */
+	g_app = gtk_application_new("de.shimatta.reflow.error-mem-viewer", G_APPLICATION_NON_UNIQUE);
+	g_signal_connect(g_app, "activate", G_CALLBACK(app_activated), &data);
+	ret = g_application_run(G_APPLICATION(g_app), argc, argv);
+	g_object_unref(g_app);
+	if (data.error_memory_data)
+		free((void *)data.error_memory_data);
+
+	return ret;
+}
+
+int main(int argc, char **argv)
+{
+	return start_gui(argc, argv);
+}

measurement-data/Analog_Measurement_Analysis.ipynb

@@ -384,6 +384,30 @@
     "plt.show()"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "fig, axes = plt.subplots(nrows=1, ncols=2, sharex='col', figsize=(28, 8))\n",
+    "v12_df = pd.read_csv(r'hw-v12-1000Ohm.csv')                       \n",
+    "plot_histogram(axes[0], v12_df['pt1000_res_raw_lf'], 21, 'HW v1.2 1k Ohm Sampling', '1k Resistance')\n",
+    "plot_histogram(axes[1], v12_df['adc_pt1000_raw_reading_hf'], 21, 'HW v1.2 1k Ohm Sampling', '1k Resistance HF RAW')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "fig, axes = plt.subplots(nrows=1, ncols=2, sharex='col', figsize=(28, 8))\n",
+    "v13_df = pd.read_csv(r'1000OhmSampling-v1.3.csv')                       \n",
+    "plot_histogram(axes[0], v13_df['pt1000_res_raw_lf'], 21, 'HW v1.3 1k Ohm Sampling', '1k Resistance')\n",
+    "plot_histogram(axes[1], v13_df['adc_pt1000_raw_reading_hf'], 21, 'HW v1.3 1k Ohm Sampling', '1k Resistance')"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -398,6 +422,13 @@
     "print(calc_temp(2000))\n",
     "print(calc_temp(2000+adc_min_res))"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
@@ -416,7 +447,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.2"
+   "version": "3.9.6"
   }
  },
  "nbformat": 4,

measurement-data/FilterAnalysis.ipynb

@@ -0,0 +1,475 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "7c270395",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import numpy as np\n",
+    "from scipy import signal\n",
+    "import matplotlib.pyplot as plt\n",
+    "import pandas as pd\n",
+    "from scipy.fft import fft, fftfreq"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "b09956cf",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
+  {
+   "cell_type": "markdown",
+   "id": "348b4663",
+   "metadata": {},
+   "source": [
+    "## Filter comparison"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "eef8fc32",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "alpha = 0.01\n",
+    "mavg_b = [alpha]\n",
+    "mavg_a = [1, -(1-alpha)]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "06cc8d91",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Sinc filter\n",
+    "b_sinc = [\n",
+    "    0.013166773445594984,\n",
+    "    0.015510026576574206,\n",
+    "    0.017943762856303655,\n",
+    "    0.020436419999452039,\n",
+    "    0.022953654956480787,\n",
+    "    0.025459023223972144,\n",
+    "    0.027914730737546672,\n",
+    "    0.030282439536854874,\n",
+    "    0.032524106530629059,\n",
+    "    0.034602833419516990,\n",
+    "    0.036483705201686277,\n",
+    "    0.038134594717421900,\n",
+    "    0.039526911389630152,\n",
+    "    0.040636273671486346,\n",
+    "    0.041443086683647982,\n",
+    "    0.041933009054862178,\n",
+    "    0.042097295996679322,\n",
+    "    0.041933009054862178,\n",
+    "    0.041443086683647982,\n",
+    "    0.040636273671486346,\n",
+    "    0.039526911389630152,\n",
+    "    0.038134594717421900,\n",
+    "    0.036483705201686277,\n",
+    "    0.034602833419516990,\n",
+    "    0.032524106530629059,\n",
+    "    0.030282439536854874,\n",
+    "    0.027914730737546672,\n",
+    "    0.025459023223972144,\n",
+    "    0.022953654956480787,\n",
+    "    0.020436419999452039,\n",
+    "    0.017943762856303655,\n",
+    "    0.015510026576574206,\n",
+    "    0.013166773445594984,\n",
+    "]\n",
+    "b_sinc = [\n",
+    "    -0.000005301919181359,\n",
+    "    -0.000020372384569462,\n",
+    "    -0.000043393375246200,\n",
+    "    -0.000071643508460196,\n",
+    "    -0.000101272447699964,\n",
+    "    -0.000127045709202358,\n",
+    "    -0.000142084479366378,\n",
+    "    -0.000137630058679112,\n",
+    "    -0.000102865422361326,\n",
+    "    -0.000024826753571648,\n",
+    "    0.000111564545505229,\n",
+    "    0.000323323938002668,\n",
+    "    0.000629062120588115,\n",
+    "    0.001048471626315150,\n",
+    "    0.001601644955843253,\n",
+    "    0.002308239744151386,\n",
+    "    0.003186518744650963,\n",
+    "    0.004252303894058680,\n",
+    "    0.005517893567100900,\n",
+    "    0.006990999568786174,\n",
+    "    0.008673764799041549,\n",
+    "    0.010561923390649710,\n",
+    "    0.012644162210467481,\n",
+    "    0.014901735907231652,\n",
+    "    0.017308377414832196,\n",
+    "    0.019830532444994709,\n",
+    "    0.022427930710902887,\n",
+    "    0.025054489273884574,\n",
+    "    0.027659525485854094,\n",
+    "    0.030189239563895277,\n",
+    "    0.032588410933658420,\n",
+    "    0.034802239101869442,\n",
+    "    0.036778249821351520,\n",
+    "    0.038468181363671021,\n",
+    "    0.039829764251821352,\n",
+    "    0.040828311002284692,\n",
+    "    0.041438040179150003,\n",
+    "    0.041643070995549647,\n",
+    "    0.041438040179150003,\n",
+    "    0.040828311002284692,\n",
+    "    0.039829764251821366,\n",
+    "    0.038468181363671021,\n",
+    "    0.036778249821351520,\n",
+    "    0.034802239101869456,\n",
+    "    0.032588410933658420,\n",
+    "    0.030189239563895291,\n",
+    "    0.027659525485854094,\n",
+    "    0.025054489273884584,\n",
+    "    0.022427930710902898,\n",
+    "    0.019830532444994709,\n",
+    "    0.017308377414832207,\n",
+    "    0.014901735907231647,\n",
+    "    0.012644162210467488,\n",
+    "    0.010561923390649715,\n",
+    "    0.008673764799041547,\n",
+    "    0.006990999568786178,\n",
+    "    0.005517893567100902,\n",
+    "    0.004252303894058680,\n",
+    "    0.003186518744650965,\n",
+    "    0.002308239744151388,\n",
+    "    0.001601644955843254,\n",
+    "    0.001048471626315152,\n",
+    "    0.000629062120588114,\n",
+    "    0.000323323938002668,\n",
+    "    0.000111564545505229,\n",
+    "    -0.000024826753571648,\n",
+    "    -0.000102865422361327,\n",
+    "    -0.000137630058679112,\n",
+    "    -0.000142084479366378,\n",
+    "    -0.000127045709202359,\n",
+    "    -0.000101272447699963,\n",
+    "    -0.000071643508460196,\n",
+    "    -0.000043393375246200,\n",
+    "    -0.000020372384569461,\n",
+    "    -0.000005301919181359,\n",
+    "]\n",
+    "b_sinc = np.around([k * 56536 for k in b_sinc])/65536\n",
+    "\n",
+    "\n",
+    "def combined_sinc_mavg(alpha = 0.4):\n",
+    "    b1 = [alpha]\n",
+    "    b2 = b_sinc\n",
+    "    a1 = [1, -(1-alpha)]\n",
+    "    a2 = [1]\n",
+    "    \n",
+    "    b = np.convolve(b1, b2)\n",
+    "    a = np.convolve(a1, a2)\n",
+    "    return b,a\n",
+    "\n",
+    "def iir_notch(freq, r, fsa):\n",
+    "    b = [1, -2*np.cos(freq/fsa*2*np.pi), 1]\n",
+    "    a = [1, -2*r*np.cos(freq/fsa*2*np.pi), r*r]\n",
+    "    return b,a"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "299fc59e",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0af3fa7b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def plot_transfer_func(b, a, fsa = 1):\n",
+    "    omega, vals = signal.freqz(b, a, worN = 1024)\n",
+    "    plt.plot(omega/(2*np.pi)*fsa, abs(vals))\n",
+    "    \n",
+    "sample_rate = 1e3/6\n",
+    "plt.figure(figsize=(16,8))\n",
+    "plt.yscale('log')\n",
+    "plot_transfer_func(mavg_b, mavg_a, sample_rate)\n",
+    "plt.ylabel('|H(w)| [dB]')\n",
+    "plt.xlabel('Frequency [Hz]')\n",
+    "\n",
+    "plot_transfer_func(b_sinc, [1], sample_rate)\n",
+    "\n",
+    "# Combined filter\n",
+    "b,a = combined_sinc_mavg(alpha = 1)\n",
+    "b_notch, a_notch = iir_notch(50, 0.875, sample_rate)\n",
+    "b = np.convolve(b, b_notch)\n",
+    "a = np.convolve(a, a_notch)\n",
+    "plot_transfer_func(b,a, sample_rate)\n",
+    "plt.grid()\n",
+    "\n",
+    "plt.legend(['MAVG a = 0.01', 'SINC', 'SINC+MAVG'])\n",
+    "plt.xlim(0, 70)\n",
+    "plt.show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "c9b87b82",
+   "metadata": {},
+   "source": [
+    "# Notch filters (Not used for implementation)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "c360b127",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "plt.figure(figsize=(16,8))\n",
+    "plt.yscale('log')\n",
+    "a = [1]\n",
+    "b = [1, -2*np.cos(50/sample_rate*2*np.pi), 1]\n",
+    "plot_transfer_func(b,a, sample_rate)\n",
+    "\n",
+    "b = [1, -2*np.cos(60/sample_rate*2*np.pi), 1]\n",
+    "plot_transfer_func(b,a, sample_rate)\n",
+    "\n",
+    "r = 0.875\n",
+    "b,a = iir_notch(50, r, sample_rate)\n",
+    "plot_transfer_func(b,a, sample_rate)\n",
+    "\n",
+    "b,a = iir_notch(60, r, sample_rate)\n",
+    "plot_transfer_func(b,a, sample_rate)\n",
+    "plt.xlim(40,70)\n",
+    "plt.legend(['FIR 50 Hz Notch', 'FIR 60 Hz', 'IIR 50Hz', 'IIR 60Hz'])\n",
+    "plt.show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "891bf909",
+   "metadata": {},
+   "source": [
+    "# Singal testing"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "29277520",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "N = 30000\n",
+    "time = np.linspace(0, 1/sample_rate*N, N, endpoint=False)\n",
+    "sig = 10*signal.sawtooth(2*np.pi*0.2*time)+10 #+ 0.5 * np.sin(2*np.pi*50*time)+0.8 * np.sin(2*np.pi*80*time)\n",
+    "\n",
+    "plt.figure(figsize=(16,8))\n",
+    "\n",
+    "spur_len = 3\n",
+    "\n",
+    "sig[1000:1000+spur_len] = sig[1000]+5\n",
+    "sig[2000:2000+spur_len] = sig[2000]-6\n",
+    "sig[3000:3000+spur_len] = sig[3000]+2\n",
+    "sig[4000:4000+spur_len] = sig[4000]+8\n",
+    "\n",
+    "\n",
+    "plt.plot(time, sig)\n",
+    "\n",
+    "\n",
+    "# Apply the combined filter:\n",
+    "b,a = combined_sinc_mavg(alpha = 1)\n",
+    "\n",
+    "bn,an = iir_notch(50, 0.875, sample_rate)\n",
+    "a = np.convolve(a, an)\n",
+    "b = np.convolve(b, bn)\n",
+    "\n",
+    "#b,a = mavg_b, mavg_a\n",
+    "\n",
+    "w,h = signal.freqz(b,a)\n",
+    "gain_corr = round(1/abs(h[0])*65536)/65536\n",
+    "\n",
+    "sig_f = signal.lfilter(b, a, sig) * gain_corr\n",
+    "\n",
+    "\n",
+    "print('Gain correction:', gain_corr)\n",
+    "\n",
+    "plt.plot(time, sig_f)\n",
+    "plt.xlim(5,10)\n",
+    "plt.show()\n",
+    "\n",
+    "plt.figure(figsize=(16,8))\n",
+    "plt.plot(time, abs(sig-sig_f))\n",
+    "plt.xlim(5,10)\n",
+    "plt.ylim(0,2)\n",
+    "plt.show()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "13758640",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "window = signal.windows.hamming(N)\n",
+    "\n",
+    "h_sig = fft(sig*window)\n",
+    "f_sig = fftfreq(N, 1/sample_rate)[:N//2]\n",
+    "\n",
+    "h_sig_f = fft(sig_f*window)\n",
+    "f_sig_f = fftfreq(N, 1/sample_rate)[:N//2]\n",
+    "\n",
+    "plt.figure(figsize=(16,10))\n",
+    "plt.yscale('log')\n",
+    "plt.plot(f_sig, 2.0/N*abs(h_sig[0:N//2]))\n",
+    "plt.plot(f_sig_f, 2.0/N*abs(h_sig_f[0:N//2]))\n",
+    "plt.show();"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "f4b81600",
+   "metadata": {},
+   "source": [
+    "# PT1000 HF Filtering"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a87370ee",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "raw_data = pd.read_csv(r'pt1000_hf_2kOhm_v1.3.dat')\n",
+    "raw_data = pd.read_csv(r'pt1000_hf_changing.dat')\n",
+    "time = np.linspace(0, 2000*6e-3, 2000, endpoint=False)\n",
+    "\n",
+    "plt.figure(figsize=(22,12))\n",
+    "plt.plot(time, raw_data['hf_value']*2500/4096)\n",
+    "\n",
+    "alpha = 0.005\n",
+    "\n",
+    "mavg_b = [alpha]\n",
+    "mavg_a = [1, -(1-alpha)]\n",
+    "\n",
+    "zi = signal.lfilter_zi(mavg_b, mavg_a)\n",
+    "filtered, _ = signal.lfilter(mavg_b, mavg_a, raw_data['hf_value'], zi=zi*raw_data['hf_value'][0])\n",
+    "plt.plot(time, filtered*2500/4096)\n",
+    "filtered_avg_low = filtered\n",
+    "\n",
+    "alpha = 0.01\n",
+    "mavg_b = [alpha]\n",
+    "mavg_a = [1, -(1-alpha)]\n",
+    "\n",
+    "zi = signal.lfilter_zi(mavg_b, mavg_a)\n",
+    "filtered, _ = signal.lfilter(mavg_b, mavg_a, raw_data['hf_value'], zi=zi*raw_data['hf_value'][0])\n",
+    "plt.plot(time, filtered*2500/4096)\n",
+    "filtered_avg = filtered\n",
+    "\n",
+    "\n",
+    "\n",
+    "# Apply the combined filter:\n",
+    "b,a = combined_sinc_mavg(alpha = 0.08)\n",
+    "\n",
+    "bn,an = iir_notch(4, 0.75, sample_rate)\n",
+    "a = np.convolve(a, an)\n",
+    "b = np.convolve(b, bn)\n",
+    "\n",
+    "zi = signal.lfilter_zi(b, a)\n",
+    "filtered, _ = signal.lfilter(b, a, raw_data['hf_value'], zi=zi*raw_data['hf_value'][0])\n",
+    "\n",
+    "w,h = signal.freqz(b,a)\n",
+    "gain_corr = round(1/abs(h[0])*65536)/65536\n",
+    "\n",
+    "plt.plot(time, filtered*gain_corr*2500/4096)\n",
+    "plt.savefig('expl.pdf', format='pdf', dpi=1200)\n",
+    "plt.show()\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3eae0e71",
+   "metadata": {},
+   "source": [
+    "## Spectrum"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "8d082b99",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "window =signal.windows.hamming(len(raw_data['hf_value']))\n",
+    "raw_fft = fft(np.array(raw_data['hf_value'].to_list())*window)\n",
+    "f_raw = fftfreq(len(raw_data), 1/sample_rate)[:len(raw_data)//2]\n",
+    "plt.figure(figsize=(16,10));\n",
+    "plt.yscale('log')\n",
+    "plt.plot(f_raw, abs(raw_fft[:len(raw_data)//2]))\n",
+    "\n",
+    "avg_fft = fft(np.array(filtered_avg)*window)\n",
+    "plt.plot(f_raw, abs(avg_fft[:len(raw_data)//2]))\n",
+    "\n",
+    "avg_fft = fft(np.array(filtered_avg_low)*window)\n",
+    "plt.plot(f_raw, abs(avg_fft[:len(raw_data)//2]))\n",
+    "\n",
+    "sinc_fft = fft(np.array(filtered)*window)\n",
+    "plt.plot(f_raw, abs(sinc_fft[:len(raw_data)//2]))\n",
+    "plt.xscale('log')\n",
+    "plt.show()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "e09d63f9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(np.std(filtered_avg_low/4096*2500))\n",
+    "print(np.std(filtered_avg/4096*2500))\n",
+    "print(np.std(filtered/4096*2500))\n",
+    "\n",
+    "print('Min',min(filtered_avg/4096*2500), 'Max', max(filtered_avg)/4096*2500)\n",
+    "print('Min',min(filtered)/4096*2500*gain_corr, 'Max', max(filtered)/4096*2500*gain_corr)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

stm-firmware/.gitignore

@@ -15,3 +15,11 @@ reflow-controller.includes
 *.config
 *.files
 *.user.*
+*.user
+
+# VSCODE and CLANGD sepcific excludes
+
+.vscode/
+build/
+.cache/
+compile_commands.json

stm-firmware/CMakeLists.txt

@@ -0,0 +1,136 @@
+set(CMAKE_SYSTEM_NAME Generic)
+set(CMAKE_SYSTEM_PROCESSOR arm)
+set(CMAKE_CROSSCOMPILING 1)
+cmake_minimum_required(VERSION 3.18)
+
+set(CMAKE_TOOLCHAIN_FILE "arm-none-eabi-gcc.cmake")
+
+project(reflow-controller)
+
+if(NOT WIN32)
+  string(ASCII 27 Esc)
+  set(ColorReset "${Esc}[m")
+  set(ColorBold  "${Esc}[1m")
+  set(Red         "${Esc}[31m")
+  set(Green       "${Esc}[32m")
+  set(Yellow      "${Esc}[33m")
+  set(Blue        "${Esc}[34m")
+  set(Magenta     "${Esc}[35m")
+  set(Cyan        "${Esc}[36m")
+  set(White       "${Esc}[37m")
+  set(BoldRed     "${Esc}[1;31m")
+  set(BoldGreen   "${Esc}[1;32m")
+  set(BoldYellow  "${Esc}[1;33m")
+  set(BoldBlue    "${Esc}[1;34m")
+  set(BoldMagenta "${Esc}[1;35m")
+  set(BoldCyan    "${Esc}[1;36m")
+  set(BoldWhite   "${Esc}[1;37m")
+endif()
+
+find_package(Git)
+if (GIT_FOUND)
+	message("Git found")
+	execute_process(
+		COMMAND ${GIT_EXECUTABLE} describe --always --tags --dirty
+		WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+		OUTPUT_VARIABLE GIT_DESCRIBE
+		OUTPUT_STRIP_TRAILING_WHITESPACE
+	)
+	message("${BoldGreen}Git based version number: ${GIT_DESCRIBE}${ColorReset}")
+else (GIT_FOUND)
+	set(GIT_DESCRIBE "v0.0.0-unknown")
+	message("${BoldRed}No git installation found. It is highly recommended using git to generate the version number")
+	message("Version is set to: ${GIT_DESCRIBE}${ColorReset}")
+endif (GIT_FOUND)
+
+find_program(PATCHELFCRC patchelfcrc)
+if (PATCHELFCRC)
+	message("patchelfcrc found: ${PATCHELFCRC}")
+else(PATCHELFCRC)
+	message(FATAL_ERROR "${BoldRed}Patchelfcrc not found. Cannot patch CRC checksum into ELF file: patchelfcrc: command not found! See: https://git.shimatta.de/mhu/patchelfcrc${ColorReset}")
+endif (PATCHELFCRC)
+
+
+set(ELFFILE ${PROJECT_NAME}.elf)
+set(HEXFILE ${PROJECT_NAME}.hex)
+set(MAPFILE ${PROJECT_NAME}.map)
+set(LINKER_SCRIPT ${CMAKE_CURRENT_SOURCE_DIR}/stm32f407vet6_flash.ld)
+
+add_compile_options(-Wall -Wextra -Wold-style-declaration -Wuninitialized -Wmaybe-uninitialized -Wunused-parameter)
+add_compile_options(-mlittle-endian -mthumb -mcpu=cortex-m4 -mfloat-abi=hard -mfpu=fpv4-sp-d16 -nostartfiles -Wimplicit-fallthrough=3 -Wsign-compare)
+
+
+set(GIT_DESCRIBE "${GIT_DESCRIBE}")
+add_definitions(-DBASE64_LOOKUP_TABLE_SECTION=\".ccm.bss\" -DSHELLMATTA_HELP_ALIAS=\"?\" -DGIT_VER=${GIT_DESCRIBE} -DHSE_VALUE=8000000UL -DSTM32F407xx -DSTM32F4XX -DARM_MATH_CM4)
+
+add_subdirectory(doxygen)
+add_subdirectory(updater/ram-code)
+
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)
+
+
+IF(CMAKE_BUILD_TYPE STREQUAL "Debug")
+	add_definitions(-DDEBUGBUILD)
+	add_compile_options(-O0 -g)
+	add_link_options(-Wl,-Map=${MAPFILE})
+ELSE()
+	add_compile_options(-O3 -g)
+	add_link_options(-Wl,--gc-sections)
+ENDIF(CMAKE_BUILD_TYPE STREQUAL "Debug")
+
+
+if (UART_ON_DEBUG_HEADER)
+    add_definitions(-DUART_ON_DEBUG_HEADER)
+    message("${BoldRed}UART forced to debug header${ColorReset}")
+endif (UART_ON_DEBUG_HEADER)
+
+add_subdirectory(base64-lib)
+add_subdirectory(linklist-lib)
+
+aux_source_directory("." MAIN_SOURCES)
+aux_source_directory("config-parser" CFG_PARSER_SRCS)
+aux_source_directory("ui" UI_SRCS)
+aux_source_directory("fatfs" FAT_SRCS)
+aux_source_directory("fatfs/shimatta_sdio_driver" SDIO_SRCS)
+aux_source_directory("boot" BOOT_SRCS)
+aux_source_directory("setup" SETUP_SRCS)
+aux_source_directory("stm-periph" STM_PERIPH_SRCS)
+aux_source_directory("settings" SETTINGS_SRCS)
+aux_source_directory("safety" SAFETY_SRCS)
+aux_source_directory("shellmatta/src" SHELLMATTA_SRCS)
+aux_source_directory("updater" UPDATER_SRCS)
+aux_source_directory("temp-profile" PROFILE_SRCS)
+
+add_executable(${ELFFILE} ${MAIN_SOURCES} ${CFG_PARSER_SRCS} ${UI_SRCS}
+			${FAT_SRCS} ${SDIO_SRCS} ${BOOT_SRCS} ${SETUP_SRCS}
+			${STM_PERIPH_SRCS} ${SETTINGS_SRCS} ${SAFETY_SRCS}
+			${SHELLMATTA_SRCS} ${UPDATER_SRCS} ${PROFILE_SRCS}
+		)
+	
+add_dependencies(${ELFFILE} updater-ram-code-header-blob)		
+
+target_include_directories(${ELFFILE} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/shellmatta/api ${CMAKE_CURRENT_SOURCE_DIR}/config-parser/include)
+target_link_options(${ELFFILE} PRIVATE -mlittle-endian -mthumb -mcpu=cortex-m4 -mfloat-abi=hard -mfpu=fpv4-sp-d16 --disable-newlib-supplied-syscalls -nostartfiles -T${LINKER_SCRIPT} -Wl,--print-memory-usage)
+target_link_libraries(${ELFFILE} base64-lib linklist-lib)
+target_include_directories(${ELFFILE} PRIVATE "${CMAKE_CURRENT_BINARY_DIR}/updater/ram-code/include/")
+
+add_custom_command(
+    TARGET ${ELFFILE}
+    POST_BUILD
+    COMMAND ${PATCHELFCRC} --little-endian --verbose --granularity word --start-magic 0xa8be53f9 --end-magic 0xffa582ff -O .flashcrc -p crc-32-mpeg -S .text -S .data -S .ccmdata -S .vectors "${CMAKE_CURRENT_BINARY_DIR}/${ELFFILE}"
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    COMMENT "Running Flash CRC Patcher"
+    )
+
+set(HEX_PATH "${CMAKE_CURRENT_BINARY_DIR}/${HEXFILE}")
+add_custom_target(update-image ALL DEPENDS ${HEX_PATH} "${HEX_PATH}.sha")
+add_custom_command(
+	DEPENDS ${ELFFILE}
+	OUTPUT ${HEX_PATH}
+	COMMAND ${CMAKE_OBJCOPY} -O ihex ${ELFFILE} ${HEX_PATH}
+	)
+add_custom_command(
+	DEPENDS ${HEX_PATH}
+	OUTPUT "${HEX_PATH}.sha"
+	COMMAND sha256sum "${HEX_PATH}" | cut -d " " -f 1 > "${HEX_PATH}.sha"
+	)

stm-firmware/Makefile

@@ -1,216 +0,0 @@
-################################Shimatta Makefile####################################
-#CPU:		STM32F407VET6
-#Compiler:	arm-none-eabi
-#####################################################################################
-#Add Files and Folders below#########################################################
-CFILES 	= main.c syscalls.c setup/system_stm32f4xx.c systick.c boot/startup_stm32f407vx.c
-ASFILES =
-INCLUDEPATH = -Iinclude
-
-OBJDIR_BASE = obj
-TARGET_BASE = reflow-controller
-LIBRARYPATH = -L.
-LIBRARIES =
-
-DEFINES = -DSTM32F407xx -DSTM32F4XX -DARM_MATH_CM4 -DHSE_VALUE=8000000UL
-MAPFILE_BASE = memory-mapping
-LINKER_SCRIPT=stm32f407vet6_flash.ld
-
-export GIT_VER = $(shell git describe --always --dirty --tags)
-DEFINES += -DGIT_VER=$(GIT_VER)
-
-ifneq ($(VERBOSE),true)
-QUIET=@
-else
-QUIET=
-endif
-
-##Custom Files###
-CFILES += adc-meas.c
-
-# Shellmatta
-CFILES += shellmatta/src/shellmatta.c shellmatta/src/shellmatta_autocomplete.c shellmatta/src/shellmatta_escape.c shellmatta/src/shellmatta_history.c shellmatta/src/shellmatta_utils.c shellmatta/src/shellmatta_opt.c shell.c
-INCLUDEPATH += -Ishellmatta/api
-DEFINES += -DSHELLMATTA_HELP_ALIAS=\"?\"
-
-# RCC Manager
-CFILES += stm-periph/clock-enable-manager.c
-CFILES += stm-periph/uart.c stm-periph/dma-ring-buffer.c stm-periph/backup-ram.c
-CFILES += stm-periph/rng.c
-CFILES += digio.c
-CFILES += stm-periph/unique-id.c
-CFILES += calibration.c
-CFILES += temp-converter.c
-CFILES += rotary-encoder.c button.c
-CFILES += ui/lcd.c ui/menu.c reflow-menu.c
-CFILES += fatfs/diskio.c fatfs/ff.c fatfs/ffsystem.c fatfs/ffunicode.c fatfs/shimatta_sdio_driver/shimatta_sdio.c
-CFILES += pid-controller.c oven-driver.c
-CFILES += settings/settings.c settings/settings-sd-card.c
-CFILES += stm-periph/crc-unit.c
-CFILES += safety/safety-adc.c safety/safety-controller.c safety/watchdog.c safety/fault.c safety/safety-memory.c safety/stack-check.c
-
-CFILES += config-parser/config-parser.c
-INCLUDEPATH += -Iconfig-parser/include
-
-CFILES += base64-lib/src/base64-lib.c
-INCLUDEPATH += -Ibase64-lib/include
-DEFINES += -DBASE64_LOOKUP_TABLE_SECTION="\".ccm.bss\""
-
-
-DEBUG_DEFINES = -DDEBUGBUILD
-RELEASE_DEFINES = -DUART_ON_DEBUG_HEADER
-
-###################################################################################
-ifeq ($(CROSS_COMPILE),)
-CROSS_COMPILE=arm-none-eabi-
-endif
-
-CC=$(CROSS_COMPILE)gcc
-OBJCOPY=$(CROSS_COMPILE)objcopy
-OBJDUMP=$(CROSS_COMPILE)objdump
-SIZE=$(CROSS_COMPILE)size
-
-CFLAGS_RELEASE = -O3 -g
-CFLAGS_DEBUG = -O0 -g
-
-LFLAGS_RELEASE = -Wl,--gc-sections
-LFLAGS_DEBUG =
-
-CFLAGS =
-LFLAGS =
-
-ifneq ($(DEBUGBUILD),true)
-DEFINES += $(RELEASE_DEFINES)
-CFLAGS += $(CFLAGS_RELEASE)
-LFLAGS += $(LFLAGS_RELEASE)
-target = $(TARGET_BASE)-release
-OBJDIR = $(OBJDIR_BASE)/release
-MAPFILE = $(MAPFILE_BASE)-release
-else
-DEFINES += $(DEBUG_DEFINES)
-target = $(TARGET_BASE)-debug
-CFLAGS += $(CFLAGS_DEBUG)
-LFLAGS += $(LFLAGS_DEBUG)
-OBJDIR = $(OBJDIR_BASE)/debug
-MAPFILE = $(MAPFILE_BASE)-debug
-endif
-
-LFLAGS += -mlittle-endian -mthumb -mcpu=cortex-m4 -mthumb-interwork
-LFLAGS += -mfloat-abi=hard -mfpu=fpv4-sp-d16 --disable-newlib-supplied-syscalls -nostartfiles
-LFLAGS += -T$(LINKER_SCRIPT) -Wl,-Map=$(MAPFILE).map -Wl,--print-memory-usage
-
-CFLAGS += -c -mlittle-endian -mthumb -mcpu=cortex-m4 -mthumb-interwork
-CFLAGS += -mfloat-abi=hard -mfpu=fpv4-sp-d16 -nostartfiles
-CFLAGS += -Wall -Wextra -Wold-style-declaration -Wuninitialized -Wmaybe-uninitialized -Wunused-parameter -Wimplicit-fallthrough=3 -Wsign-compare
-
-####################################################################################
-
-OBJ = $(CFILES:%.c=$(OBJDIR)/%.c.o)
-ASOBJ += $(ASFILES:%.S=$(OBJDIR)/%.S.o)
-
-default: $(target).elf
-
-all: debug release
-
-release:
-	$(QUIET)$(MAKE) DEBUGBUILD=false
-
-debug:
-	$(QUIET)$(MAKE) DEBUGBUILD=true
-
-%.bin: %.elf
-	$(QUIET)$(OBJCOPY) -O binary $^ $@
-%.hex: %.elf
-	$(QUIET)$(OBJCOPY) -O ihex $^ $@
-
-#Linking
-$(target).elf: $(OBJ) $(ASOBJ) $(LINKER_SCRIPT)
-	@echo [LD] $@
-	$(QUIET)$(CC) $(LFLAGS) $(LIBRARYPATH) -o $@ $(OBJ) $(ASOBJ) $(LIBRARIES)
-	$(QUIET)$(SIZE) $@
-	@echo "Built Version $(GIT_VER)"
-
-#Compiling
-$(OBJ):
-	@echo [CC] $@
-	$(eval OUTPATH=$(dir $@))
-	@mkdir -p $(OUTPATH)
-	$(QUIET)$(CC) $(CFLAGS) -MMD -MT $@ $(INCLUDEPATH) $(DEFINES) -o $@ $(@:$(OBJDIR)/%.c.o=%.c)
-$(ASOBJ):
-	@echo [AS] $@
-	$(eval OUTPATH=$(dir $@))
-	@mkdir -p $(OUTPATH)
-	$(QUIET)$(CC) $(CFLAGS) -MMD -MT $@ $(INCLUDEPATH) $(DEFINES) -o $@ $(@:$(OBJDIR)/%.S.o=%.S)
-
-
-.PHONY: qtproject-legacy qtproject qtproject-debug clean mrproper objcopy disassemble program program-debug
-
-program-debug:
-	$(QUIET)$(MAKE) DEBUGBUILD=true program
-
-program: $(target).elf
-	./program-device.sh $<
-
-disassemble: $(target).elf
-	$(QUIET)$(OBJDUMP) -D -s $< > $(target).lss
-
-objcopy: $(target).bin $(target).hex
-
-mrproper: clean
-ifneq ($(DEBUGBUILD),true)
-	@echo "Purging RELEASE project files"
-else
-	@echo "Purging DEBUG project files"
-endif
-	$(QUIET)rm -f $(target).pro $(target).creator $(target).files $(target).cflags $(target).cxxflags $(target).includes $(target).config
-ifneq ($(DEBUGBUILD),true)
-	$(QUIET)$(MAKE) DEBUGBUILD=true mrproper
-endif
-
-
-clean:
-	@echo -n "Cleaning up derived files for "
-ifneq ($(DEBUGBUILD),true)
-	@echo "RELEASE build"
-else
-	@echo "DEBUG build"
-endif
-	$(QUIET)rm -f $(target).elf $(target).bin $(target).hex $(OBJ) $(ASOBJ) $(mapfile).map $(CFILES:%.c=$(OBJDIR)/%.c.d) $(ASFILES:%.S=$(OBJDIR)/%.S.d) 
-	$(QUIET)rm -rf $(OBJDIR)/*
-ifneq ($(DEBUGBUILD),true)
-	$(QUIET)$(MAKE) DEBUGBUILD=true clean
-endif
-
-qtproject-legacy:
-	echo -e "TEMPLATE = app\nCONFIG -= console app_bundle qt" > $(target).pro
-	echo -e "SOURCES += $(CFILES) $(ASFILES)" >> $(target).pro
-	echo -ne "INCLUDEPATH += " >> $(target).pro
-	echo "$(INCLUDEPATH)" | sed "s!-I!./!g" >> $(target).pro
-	echo -ne "HEADERS += " >> $(target).pro
-	find -name "*.h" | tr "\\n" " " >> $(target).pro
-	echo -ne "\nDEFINES += " >> $(target).pro
-	echo "$(DEFINES)" | sed "s/-D//g" >> $(target).pro
-
-qtproject-debug:
-	@echo "Generating debug build project"
-	$(QUIET)$(MAKE) DEBUGBUILD=true qtproject
-
-qtproject:
-	$(QUIET)rm -f $(target).files $(target).cflags $(target).config $(target).creator $(target).includes $(target).creator.user
-	@echo "Generating source file list"
-	$(QUIET)echo "$(CFILES)" | tr ' ' '\n' > $(target).files
-	@echo -n "Appending found header files from folders "
-	@echo `echo $(INCLUDEPATH) | sed "s/-I//g"`
-	$(QUIET)for dir in `echo $(INCLUDEPATH) | sed "s/-I//g"`; do \
-		find `echo "$${dir}"` -name "*.h" >> $(target).files; \
-	done
-	@echo "Generating $(target).cflags"
-	$(QUIET)echo "" > $(target).cflags
-	@echo "Generating $(target).includes"
-	$(QUIET)echo $(INCLUDEPATH) | sed "s/-I/,/g" | tr , '\n' | sed "/^$$/d" > $(target).includes;
-	@echo "Generating $(target).config"
-	$(QUIET)echo $(DEFINES) | sed "s/-D/,#define /g" | tr , '\n' | sed "/^$$/d" > $(target).config
-	@echo "Generating $(target).creator"
-	$(QUIET)echo "[GENERAL]" > $(target).creator
-
--include $(CFILES:%.c=$(OBJDIR)/%.c.d) $(ASFILES:%.S=$(OBJDIR)/%.S.d)

stm-firmware/adc-meas.c

@@ -29,7 +29,7 @@
 #include <stm-periph/stm32-gpio-macros.h>
 #include <stdlib.h>
 #include <helper-macros/helper-macros.h>
-#include <stm-periph/clock-enable-manager.h>
+#include <stm-periph/rcc-manager.h>
 #include <reflow-controller/safety/safety-controller.h>
 
 static float IN_SECTION(.ccm.bss) pt1000_offset;
@@ -45,7 +45,6 @@ static float IN_SECTION(.ccm.bss) filter_alpha;
 static volatile float IN_SECTION(.ccm.bss) pt1000_res_raw_lf;
 
 static volatile int * volatile streaming_flag_ptr;
-static uint32_t IN_SECTION(.ccm.bss) filter_startup_cnt;
 static volatile float IN_SECTION(.ccm.bss) adc_pt1000_raw_reading_hf;
 static volatile uint16_t dma_sample_buffer[ADC_PT1000_DMA_AVG_SAMPLES];
 static volatile uint32_t IN_SECTION(.ccm.bss) adc_watchdog_counter;
@@ -83,6 +82,8 @@ static inline void adc_pt1000_disable_adc(void)
 	ADC_PT1000_PERIPH->CR2 &= ~ADC_CR2_ADON;
 	DMA2_Stream0->CR = 0;
 
+	safety_controller_set_crc_monitor(ERR_CRC_MON_MEAS_ADC, SAFETY_CRC_MON_MEAS_ADC_PW);
+
 	safety_controller_report_error_with_key(ERR_FLAG_MEAS_ADC_OFF, MEAS_ADC_SAFETY_FLAG_KEY);
 	safety_controller_enable_timing_mon(ERR_TIMING_MEAS_ADC, false);
 	rcc_manager_disable_clock(&RCC->APB2ENR, BITMASK_TO_BITNO(RCC_APB2ENR_ADC3EN));
@@ -182,13 +183,14 @@ void adc_pt1000_setup_meas(void)
 	streaming_flag_ptr = NULL;
 	adc_watchdog_counter = 0UL;
 	stream_buffer = NULL;
+
+	safety_controller_set_crc_monitor(ERR_CRC_MON_MEAS_ADC, SAFETY_CRC_MON_MEAS_ADC_PW);
 }
 
 void adc_pt1000_set_moving_average_filter_param(float alpha)
 {
 	filter_alpha = alpha;
 	safety_controller_report_error_with_key(ERR_FLAG_MEAS_ADC_UNSTABLE, MEAS_ADC_SAFETY_FLAG_KEY);
-	filter_startup_cnt = ADC_FILTER_STARTUP_CYCLES;
 }
 
 void adc_pt1000_set_resistance_calibration(float offset, float sensitivity_deviation, bool active)
@@ -216,7 +218,7 @@ void adc_pt1000_get_resistance_calibration(float *offset, float *sensitivity_dev
 static inline float adc_pt1000_apply_calibration(float raw_resistance)
 {
 	if (calibration_active)
-        return (raw_resistance - pt1000_offset) * (1.0f + pt1000_sens_dev);
+		return (raw_resistance - pt1000_offset) * (1.0f + pt1000_sens_dev);
 	else
 		return raw_resistance;
 
@@ -234,7 +236,7 @@ int adc_pt1000_get_current_resistance(float *resistance)
 	*resistance = adc_pt1000_apply_calibration(pt1000_res_raw_lf);
 
 	if (safety_controller_get_flags_by_mask(ERR_FLAG_MEAS_ADC_OFF | ERR_FLAG_MEAS_ADC_OVERFLOW |
-						ERR_FLAG_MEAS_ADC_WATCHDOG)) {
+						ERR_FLAG_MEAS_ADC_WATCHDOG | ERR_FLAG_TIMING_MEAS_ADC)) {
 		ret_val = -100;
 		goto return_value;
 	}
@@ -303,14 +305,34 @@ void adc_pt1000_disable(void)
 
 static inline __attribute__((optimize("O3"))) void adc_pt1000_filter(float adc_prefiltered_value)
 {
-	if (filter_startup_cnt > 0) {
-		filter_startup_cnt--;
-		if (filter_startup_cnt == 0)
-			safety_controller_ack_flag_with_key(ERR_FLAG_MEAS_ADC_UNSTABLE, MEAS_ADC_SAFETY_FLAG_KEY);
+	float alpha;
+	float res;
+	static uint8_t old_state = 0;
+	static uint32_t stable_sample_counter = 0;
+
+	res = ADC_TO_RES(adc_prefiltered_value);
+	if (ABS(res - pt1000_res_raw_lf) >= ADC_PT1000_FILTER_UNSTABLE_DIFF) {
+		stable_sample_counter = 0;
+		alpha = ADC_PT1000_FILTER_WEIGHT_FAST;
+		if (old_state != 1) {
+			safety_controller_report_error_with_key(ERR_FLAG_MEAS_ADC_UNSTABLE,
+								MEAS_ADC_SAFETY_FLAG_KEY);
+			old_state = 1;
+		}
+	} else {
+		alpha = filter_alpha;
+		if (old_state != 2) {
+			stable_sample_counter++;
+			if (stable_sample_counter >= ADC_PT1000_FILTER_STABLE_SAMPLE_COUNT) {
+				safety_controller_ack_flag_with_key(ERR_FLAG_MEAS_ADC_UNSTABLE,
+								    MEAS_ADC_SAFETY_FLAG_KEY);
+				old_state = 2;
+			}
+		}
 	}
 
-	pt1000_res_raw_lf = (1.0f - filter_alpha) * pt1000_res_raw_lf +
-			filter_alpha * ADC_TO_RES(adc_prefiltered_value);
+	pt1000_res_raw_lf = (1.0f - alpha) * pt1000_res_raw_lf +
+			alpha * res;
 
 	safety_controller_report_timing(ERR_TIMING_MEAS_ADC);
 }
@@ -382,11 +404,11 @@ void DMA2_Stream0_IRQHandler(void)
 	uint32_t lisr;
 	float adc_val;
 
-	lisr = DMA2->LISR;
+	lisr = DMA2->LISR & (0x3F);
 	DMA2->LIFCR = lisr;
 
 	if (lisr & DMA_LISR_TCIF0) {
-		/* Samples Transfered */
+		/* Samples transferred */
 		adc_val = adc_pt1000_dma_avg_pre_filter();
 		adc_pt1000_raw_reading_hf = adc_val;
 

stm-firmware/arm-none-eabi-gcc.cmake

@@ -0,0 +1,28 @@
+if(MINGW OR CYGWIN OR WIN32)
+    set(UTIL_SEARCH_CMD where)
+elseif(UNIX OR APPLE)
+    set(UTIL_SEARCH_CMD which)
+endif()
+
+set(TOOLCHAIN_PREFIX arm-none-eabi-)
+
+execute_process(
+  COMMAND ${UTIL_SEARCH_CMD} ${TOOLCHAIN_PREFIX}gcc
+  OUTPUT_VARIABLE BINUTILS_PATH
+  OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+get_filename_component(ARM_TOOLCHAIN_DIR ${BINUTILS_PATH} DIRECTORY)
+set(CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY)
+
+set(CMAKE_C_COMPILER ${TOOLCHAIN_PREFIX}gcc)
+set(CMAKE_ASM_COMPILER ${CMAKE_C_COMPILER})
+set(CMAKE_CXX_COMPILER ${TOOLCHAIN_PREFIX}g++)
+
+set(CMAKE_OBJCOPY ${ARM_TOOLCHAIN_DIR}/${TOOLCHAIN_PREFIX}objcopy CACHE INTERNAL "objcopy tool")
+set(CMAKE_SIZE_UTIL ${ARM_TOOLCHAIN_DIR}/${TOOLCHAIN_PREFIX}size CACHE INTERNAL "size tool")
+
+set(CMAKE_FIND_ROOT_PATH ${BINUTILS_PATH})
+set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
+set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
+set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)

stm-firmware/boot/startup-tests.c

@@ -0,0 +1,126 @@
+#include "startup-tests.h"
+
+uint32_t startup_test_perform_ccm_ram_check(void)
+{
+	const void *ccmram_base = (void *)0x10000000UL;
+	const uint32_t ccmram_size = 64U * 1024UL;
+	volatile uint32_t *word_ptr;
+	uint32_t target_val;
+	uint32_t idx;
+	uint32_t ret = 0UL;
+
+
+	/* Perform inversion test with 0x55 and 0xAA, Part 1 */
+	for (idx = 0, word_ptr = (volatile uint32_t *)ccmram_base; idx < ccmram_size / 4U; idx++) {
+		word_ptr[idx] = idx & 1 ? 0x55AA55AAUL : 0xAA55AA55UL;
+	}
+	for (idx = 0, word_ptr = (volatile uint32_t *)ccmram_base; idx < ccmram_size / 4U; idx++) {
+		target_val = idx & 1 ? 0x55AA55AAUL : 0xAA55AA55UL;
+		if (target_val != word_ptr[idx]) {
+			ret = (uint32_t)&word_ptr[idx];
+			goto exit_ret_address;
+		}
+	}
+
+	/* Perform inversion test with 0x55 and 0xAA, Part 2 */
+	for (idx = 0, word_ptr = (volatile uint32_t *)ccmram_base; idx < ccmram_size / 4U; idx++) {
+		word_ptr[idx] = idx & 1 ? 0xAA55AA55UL : 0x55AA55AAUL;
+	}
+	for (idx = 0, word_ptr = (volatile uint32_t *)ccmram_base; idx < ccmram_size / 4U; idx++) {
+		target_val = idx & 1 ? 0xAA55AA55UL : 0x55AA55AAUL;
+		if (target_val != word_ptr[idx]) {
+			ret = (uint32_t)&word_ptr[idx];
+			goto exit_ret_address;
+		}
+	}
+
+	/* Perform static test with 0xFF */
+	for (idx = 0, word_ptr = (volatile uint32_t *)ccmram_base; idx < ccmram_size / 4U; idx++) {
+		word_ptr[idx] = 0xFFFFFFFFUL;
+	}
+	for (idx = 0, word_ptr = (volatile uint32_t *)ccmram_base; idx < ccmram_size / 4U; idx++) {
+		target_val = 0xFFFFFFFFUL;
+		if (target_val != word_ptr[idx]) {
+			ret = (uint32_t)&word_ptr[idx];
+			goto exit_ret_address;
+		}
+	}
+
+	/* Perform static test with 0x00 */
+	for (idx = 0, word_ptr = (volatile uint32_t *)ccmram_base; idx < ccmram_size / 4U; idx++) {
+		word_ptr[idx] = 0x0UL;
+	}
+	for (idx = 0, word_ptr = (volatile uint32_t *)ccmram_base; idx < ccmram_size / 4U; idx++) {
+		target_val = 0x0UL;
+		if (target_val != word_ptr[idx]) {
+			ret = (uint32_t)&word_ptr[idx];
+			goto exit_ret_address;
+		}
+	}
+
+
+exit_ret_address:
+	return ret;
+}
+
+uint32_t startup_test_perform_system_ram_check()
+{
+	const void *ram_base = (void *)0x20000000UL;
+	const uint32_t ram_size = 128U * 1024UL;
+	volatile uint32_t *word_ptr;
+	uint32_t target_val;
+	uint32_t idx;
+	uint32_t ret = 0UL;
+
+
+	/* Perform inversion test with 0x55 and 0xAA, Part 1 */
+	for (idx = 0, word_ptr = (volatile uint32_t *)ram_base; idx < ram_size / 4U; idx++) {
+		word_ptr[idx] = idx & 1 ? 0x55AA55AAUL : 0xAA55AA55UL;
+	}
+	for (idx = 0, word_ptr = (volatile uint32_t *)ram_base; idx < ram_size / 4U; idx++) {
+		target_val = idx & 1 ? 0x55AA55AAUL : 0xAA55AA55UL;
+		if (target_val != word_ptr[idx]) {
+			ret = (uint32_t)&word_ptr[idx];
+			goto exit_ret_address;
+		}
+	}
+
+	/* Perform inversion test with 0x55 and 0xAA, Part 2 */
+	for (idx = 0, word_ptr = (volatile uint32_t *)ram_base; idx < ram_size / 4U; idx++) {
+		word_ptr[idx] = idx & 1 ? 0xAA55AA55UL : 0x55AA55AAUL;
+	}
+	for (idx = 0, word_ptr = (volatile uint32_t *)ram_base; idx < ram_size / 4U; idx++) {
+		target_val = idx & 1 ? 0xAA55AA55UL : 0x55AA55AAUL;
+		if (target_val != word_ptr[idx]) {
+			ret = (uint32_t)&word_ptr[idx];
+			goto exit_ret_address;
+		}
+	}
+
+	/* Perform static test with 0xFF */
+	for (idx = 0, word_ptr = (volatile uint32_t *)ram_base; idx < ram_size / 4U; idx++) {
+		word_ptr[idx] = 0xFFFFFFFFUL;
+	}
+	for (idx = 0, word_ptr = (volatile uint32_t *)ram_base; idx < ram_size / 4U; idx++) {
+		target_val = 0xFFFFFFFFUL;
+		if (target_val != word_ptr[idx]) {
+			ret = (uint32_t)&word_ptr[idx];
+			goto exit_ret_address;
+		}
+	}
+
+	/* Perform static test with 0x00 */
+	for (idx = 0, word_ptr = (volatile uint32_t *)ram_base; idx < ram_size / 4U; idx++) {
+		word_ptr[idx] = 0x0UL;
+	}
+	for (idx = 0, word_ptr = (volatile uint32_t *)ram_base; idx < ram_size / 4U; idx++) {
+		target_val = 0x0UL;
+		if (target_val != word_ptr[idx]) {
+			ret = (uint32_t)&word_ptr[idx];
+			goto exit_ret_address;
+		}
+	}
+
+exit_ret_address:
+	return ret;
+}

stm-firmware/boot/startup-tests.h

@@ -0,0 +1,25 @@
+#ifndef _STARTUP_TESTS_H_
+#define _STARTUP_TESTS_H_
+
+#include <stdint.h>
+
+/**
+ * @brief Do a RAM check of the CCM RAM.
+ *
+ * Loop over the whole CCM memory area and check it.
+ *
+ * @return 0 if successful. Else the defect address is returned.
+ * @warning This will completely corrupt this memory!
+ * You have to ensure to set it to sane values afterwards!
+ */
+uint32_t startup_test_perform_ccm_ram_check(void);
+
+/**
+ * @brief Do a RAM check of the stnadard SRAM regions
+ * @return 0 if successful. If an error is found, the faulty address is returned
+ * @warning This completely destroys all content in the memory!
+ * @warning Ensure that the stack pointer is moved to a different memory reagion (CCM RAM)!
+ */
+uint32_t startup_test_perform_system_ram_check(void);
+
+#endif /* _STARTUP_TESTS_H_ */

stm-firmware/boot/startup_stm32f407vx.c

@@ -19,6 +19,7 @@
 */
 
 #include <stdint.h>
+#include "startup-tests.h"
 
 /* C++ library init */
 # if defined(__cplusplus)
@@ -288,7 +289,7 @@ extern unsigned int __ld_eheap;
 
 #define CPACR (*((volatile uint32_t *)0xE000ED88))
 
-void Reset_Handler(void) {
+void __attribute__((noreturn)) Reset_Handler(void) {
 	/* Stack is already initialized by hardware */
 
 	/* The first thing we do here, is to initialize the FPU
@@ -297,6 +298,9 @@ void Reset_Handler(void) {
 	 */
 	CPACR |= (0xF << 20);
 
+	/**
+	 * Prepare RAM etc for the System Init function. This ensures, the RAM tests execute at max speed.
+	 */
 
 	/* Copy .data section */
 	__init_section(&__ld_load_data, &__ld_sdata, &__ld_edata);
@@ -311,6 +315,74 @@ void Reset_Handler(void) {
 
 	/* Set clocks, waitstates, ART operation etc. */
 	SystemInit();
+
+	if (startup_test_perform_ccm_ram_check()) {
+		/* Hang forever in case of an error. We cannot handle this (yet?) */
+		while (1);
+	}
+
+	/* Move the stack and the stack pointer to CCMRAM
+	 * This allows us to perform a RAM test on the main RAM.
+	 */
+	__asm__ __volatile__ (
+			"mov r2, sp\n" /* Move stack pointer to register 2 */
+			"sub r2, %[stacktop], r2\n" /* Subtract stackpointer from top of ram => byte usage */
+			"mov r3, sp\n" /* Init r3 with first word address to copy (stack pointer) */
+			"sub r4, %[ccmtop], r2\n" /* Init r4 with first address to copy to! This will be the new stack pointer! */
+			"mov r5, r4\n" /* R5 will be the new stackpointer after we are finished copying */
+			"copyloop:\n"
+			"cmp r3, %[stacktop]\n" /* Check if we still have word to copy. If not => finish */
+			"beq finish\n"
+			"ldr.w r6, [r3, #0]\n" /* Load word from [r3] and store into [r4] */
+			"str.w r6, [r4, #0]\n"
+			"add r3, #4\n" /* Increment pointers */
+			"add r4, #4\n"
+			"b copyloop\n" /* go back to loop head */
+			"finish:\n"
+			"mov sp, r5\n" /* Set the new stack pointer to the beginning of the copied area */
+			:
+			: [stacktop]"r"(&__ld_top_of_stack), [ccmtop]"r"(0x10000000UL + (64U * 1024UL))
+			: "memory", "r2", "r3", "r4", "r5", "r6");
+
+	if (startup_test_perform_system_ram_check()) {
+		while (1);
+	}
+
+	/* Move the stack back to system ram */
+	__asm__ __volatile__ (
+			"mov r2, sp\n" /* Move stack pointer to register 2 */
+			"sub r2, %[ccmtop], r2\n" /* Subtract stackpointer from top of ccmram => byte usage */
+			"mov r3, sp\n" /* Init r3 with first word address to copy (stack pointer) */
+			"sub r4, %[stacktop], r2\n" /* Init r4 with first address to copy to! This will be the new stack pointer! */
+			"mov r5, r4\n" /* R5 will be the new stackpointer after we are finished copying */
+			"copyloop_2:\n"
+			"cmp r3, %[ccmtop]\n" /* Check if we still have word to copy. If not => finish */
+			"beq finish_2\n"
+			"ldr.w r6, [r3, #0]\n" /* Load word from [r3] and store into [r4] */
+			"str.w r6, [r4, #0]\n"
+			"add r3, #4\n" /* Increment pointers */
+			"add r4, #4\n"
+			"b copyloop_2\n" /* go back to loop head */
+			"finish_2:\n"
+			"mov sp, r5\n" /* Set the new stack pointer to the beginning of the copied area */
+			:
+			: [stacktop]"r"(&__ld_top_of_stack), [ccmtop]"r"(0x10000000UL + (64U * 1024UL))
+			: "memory", "r2", "r3", "r4", "r5", "r6");
+
+	/**
+	 * RAM tests destroyed our values. So we have to copy them again...
+	 */
+
+	/* Copy .data section */
+	__init_section(&__ld_load_data, &__ld_sdata, &__ld_edata);
+	/* Fill bss with zero */
+	__fill_zero(&__ld_sbss, &__ld_ebss);
+	/* Fill Heap with zero */
+	__fill_zero(&__ld_sheap, &__ld_eheap);
+	/* Fill static CCM memory with zeroes */
+	__fill_zero(&__ld_sbss_ccm, &__ld_ebss_ccm);
+	/* Init CCM RAM data section */
+	__init_section(&__ld_load_ccm_data, &__ld_sdata_ccm, &__ld_edata_ccm);
 	
 	/* C++ init function */
 #if defined(__cplusplus)

stm-firmware/calibration.c

@@ -48,8 +48,6 @@ void calibration_calculate(float low_measured, float low_setpoint, float high_me
 	*offset = (high_setpoint * low_measured - low_setpoint * high_measured) / (high_setpoint - low_setpoint);
 }
 
-
-
 float *calibration_acquire_data_start(uint32_t count, volatile int *flag)
 {
 	int status;
@@ -195,6 +193,7 @@ shellmatta_retCode_t calibration_sequence_shell_cmd(shellmatta_handle_t shell, c
 	case CAL_START:
 		/* Clear errors of PT1000 reading */
 		safety_controller_ack_flag(ERR_FLAG_MEAS_ADC_WATCHDOG);
+		safety_controller_ack_flag(ERR_FLAG_OVERTEMP);
 		adc_pt1000_get_resistance_calibration(&offset, &sens_dev, &cal_active);
 		if (cal_active) {
 			shellmatta_printf(shell, "Already calibrated.\r\n\tOffset: %f\r\n\tSens: %f\r\n", offset, sens_dev);
@@ -215,6 +214,7 @@ shellmatta_retCode_t calibration_sequence_shell_cmd(shellmatta_handle_t shell, c
 					ret_val = SHELLMATTA_BUSY;
 					shellmatta_printf(shell, "Measurement...\r\n");
 					safety_controller_ack_flag(ERR_FLAG_MEAS_ADC_WATCHDOG);
+					safety_controller_ack_flag(ERR_FLAG_OVERTEMP);
 					data_buffer = calibration_acquire_data_start(512UL, &flag);
 					break;
 				} else if (stdin_data[i] == '\x03') {
@@ -266,6 +266,7 @@ shellmatta_retCode_t calibration_sequence_shell_cmd(shellmatta_handle_t shell, c
 					ret_val = SHELLMATTA_BUSY;
 					shellmatta_printf(shell, "Measurement...\r\n");
 					safety_controller_ack_flag(ERR_FLAG_MEAS_ADC_WATCHDOG);
+					safety_controller_ack_flag(ERR_FLAG_OVERTEMP);
 					data_buffer = calibration_acquire_data_start(512UL, &flag);
 					break;
 				} else if (stdin_data[i] == '\x03') {

stm-firmware/config-parser/config-parser.c

@@ -28,13 +28,27 @@
 #include <stdio.h>
 #include <stdlib.h>
 
+/**
+ * @brief Config parser magic value used to check sanity of passed structs
+ */
 #define CONFIG_PARSER_MAGIC 0x464a6e2bUL
+
+/**
+ * @brief Config parser type casting macro
+ */
 #define CONFIG_PARSER(p) ((struct config_parser *)(p))
 
-#define config_parser_check_handle(handle) do { if (!(handle) || \
-						((struct config_parser *)(handle))->magic != CONFIG_PARSER_MAGIC) \
-							return CONFIG_PARSER_PARAM_ERR; \
-						} while (0)
+/**
+ * @brief Check if the supplied pointer is a valid @ref config_parser_handle_t
+ *
+ * If the pointer is invalid, the function using this macro will return with
+ * CONFIG_PARSER_PARAM_ERR
+ */
+#define config_parser_check_handle(handle) do { \
+	if (!(handle) || \
+	((struct config_parser *)(handle))->magic != CONFIG_PARSER_MAGIC) \
+		return CONFIG_PARSER_PARAM_ERR; \
+	} while (0)
 
 config_parser_handle_t config_parser_open_file(struct config_parser *config_parser, bool write, const char *file_name,
 					       char *working_buffer, size_t buff_size)
@@ -56,9 +70,18 @@ config_parser_handle_t config_parser_open_file(struct config_parser *config_pars
 	return (config_parser_handle_t)config_parser;
 }
 
+/**
+ * @brief Token delimiters for the config parser.
+ */
 static const char * const token_delim = " \t";
 
-static int parse_value(struct config_parser_entry  *entry, char *value_start_token)
+/**
+ * @brief Parse a value in the configuration
+ * @param entry Entry to parse the value in to
+ * @param value_start_token char pointer holding the value. Must be null-terminated
+ * @return 0 if successful
+ */
+static int parse_value(struct config_parser_entry *entry, char *value_start_token)
 {
 	char *dot;
 	char *endptr;
@@ -76,19 +99,18 @@ static int parse_value(struct config_parser_entry  *entry, char *value_start_tok
 
 	if (value_start_token[0] != '-') {
 		/* Try parsing as ul */
-		/* Try parsing as int */
 		entry->value.uint_val = strtoul(value_start_token, &endptr, 0);
-		if (endptr == value_start_token) {
+		if (endptr == value_start_token)
 			return -1;
-		}
+
 		entry->type = CONFIG_PARSER_TYPE_UINT;
 		goto exit;
 	} else {
 		/* Try parsing as int */
 		entry->value.int_val = strtod(value_start_token, &endptr);
-		if (endptr == value_start_token) {
+		if (endptr == value_start_token)
 			return -1;
-		}
+
 		entry->type = CONFIG_PARSER_TYPE_INT;
 	}
 
@@ -96,14 +118,16 @@ exit:
 	return 0;
 }
 
-enum config_parser_ret config_parser_get_line(config_parser_handle_t handle, struct config_parser_entry *entry, bool force_float)
+enum config_parser_ret config_parser_get_line(config_parser_handle_t handle, struct config_parser_entry *entry,
+					      bool force_float)
 {
 	struct config_parser *p;
-	config_parser_check_handle(handle);
-	p = CONFIG_PARSER(handle);
 	char *token;
 	int token_round = 0;
 
+	config_parser_check_handle(handle);
+	p = CONFIG_PARSER(handle);
+
 	if (!entry)
 		return CONFIG_PARSER_PARAM_ERR;
 
@@ -117,8 +141,7 @@ enum config_parser_ret config_parser_get_line(config_parser_handle_t handle, str
 		if (token[0] == '#') {
 			if (token_round == 0)
 				return CONFIG_PARSER_LINE_COMMENT;
-			else
-				break;
+			break;
 		}
 
 		switch (token_round) {
@@ -126,9 +149,8 @@ enum config_parser_ret config_parser_get_line(config_parser_handle_t handle, str
 			entry->name = token;
 			break;
 		case 1: /* = Symbol */
-			if (strcmp(token, "=")) {
+			if (strcmp(token, "="))
 				return CONFIG_PARSER_LINE_MALFORM;
-			}
 			break;
 		case 2: /* VALUE */
 			if (parse_value(entry, token))
@@ -158,6 +180,7 @@ enum config_parser_ret config_parser_reset_to_start(config_parser_handle_t handl
 {
 	FRESULT res;
 	struct config_parser *p;
+
 	config_parser_check_handle(handle);
 	p = CONFIG_PARSER(handle);
 
@@ -180,6 +203,7 @@ enum config_parser_ret config_parser_close_file(config_parser_handle_t handle)
 {
 	struct config_parser *p;
 	FRESULT res;
+
 	config_parser_check_handle(handle);
 	p = CONFIG_PARSER(handle);
 
@@ -188,4 +212,15 @@ enum config_parser_ret config_parser_close_file(config_parser_handle_t handle)
 	return (res == FR_OK ? CONFIG_PARSER_OK : CONFIG_PARSER_IOERR);
 }
 
+bool config_parser_ret_is_abort_condition(enum config_parser_ret return_val)
+{
+	if (return_val == CONFIG_PARSER_END_REACHED ||
+			return_val == CONFIG_PARSER_GENERIC_ERR ||
+			return_val == CONFIG_PARSER_IOERR ||
+			return_val == CONFIG_PARSER_PARAM_ERR)
+		return true;
+
+	return false;
+}
+
 /** @} */

stm-firmware/config-parser/include/config-parser/config-parser.h

@@ -33,44 +33,68 @@
 #include <stdbool.h>
 #include <fatfs/ff.h>
 
+/**
+ * @brief Confi parser instance struct
+ */
 struct config_parser {
-	uint32_t magic;
-	bool write;
-	FIL file;
-	char *buffer;
-	size_t buff_size;
+	uint32_t magic; /**< @brief Magic value. Checked by each function to verify if the passed pointer is valid */
+	bool write; /**< @brief File opened in write / read mode */
+	FIL file; /**< @brief FatFS file */
+	char *buffer; /**< @brief Working buffer */
+	size_t buff_size; /** @brief Size of the working buffer config_parser::buffer */
 };
 
+/**
+ * @brief handle type for the config parser. Never dereference this pointer directly!
+ */
 typedef void * config_parser_handle_t;
 
+/**
+ * @brief Differnet value types a config entry can hold
+ */
 enum config_parser_value_type {
 	CONFIG_PARSER_TYPE_UINT = 0,
 	CONFIG_PARSER_TYPE_INT,
 	CONFIG_PARSER_TYPE_FLOAT,
 };
 
+/**
+ * @brief Error return code of config parser functions
+ */
 enum config_parser_ret {
-	CONFIG_PARSER_OK = 0,
-	CONFIG_PARSER_PARAM_ERR,
-	CONFIG_PARSER_GENERIC_ERR,
-	CONFIG_PARSER_IOERR,
-	CONFIG_PARSER_LINE_COMMENT,
-	CONFIG_PARSER_LINE_TOO_LONG,
-	CONFIG_PARSER_LINE_MALFORM,
-	CONFIG_PARSER_END_REACHED,
-	CONFIG_PARSER_WRONG_MODE,
+	CONFIG_PARSER_OK = 0, /**< @brief Operation succeeded */
+	CONFIG_PARSER_PARAM_ERR, /**< @brief Function parameter error */
+	CONFIG_PARSER_GENERIC_ERR, /**< @brief Generic unspecified error */
+	CONFIG_PARSER_IOERR, /**< @brief I/O Error while file handling */
+	CONFIG_PARSER_LINE_COMMENT, /**< @brief The parser encountered a line starting with a comment. */
+	CONFIG_PARSER_LINE_TOO_LONG, /**< @brief The read line is too long for the parser to process. */
+	CONFIG_PARSER_LINE_MALFORM, /**< @brief Malfoirmed line. Line is neither a commenbt nor a key=value string */
+	CONFIG_PARSER_END_REACHED, /**< @brief The config parser has reached the end of the file */
+	CONFIG_PARSER_WRONG_MODE, /**< @brief Read or write requested on config parser instance that is opened in a different mode */
 };
 
+/**
+ * @brief Represents a configuration key-value-pair used by the config parser
+ */
 struct config_parser_entry {
-	const char *name;
-	enum config_parser_value_type type;
+	const char *name; /**< @brief Pointer to the name of the config entry (key) */
+	enum config_parser_value_type type; /**< @brief Type of the value held by this struct */
 	union {
 		uint32_t uint_val;
 		int32_t int_val;
 		float float_val;
-	} value;
+	} value; /**< @brief Value of the config entry. For correct processing, config_parser_entry::type has to be taken into account */
 };
 
+/**
+ * @brief Open a config file
+ * @param config_parser Struict holding the config parser isntance. Will be filled by this function
+ * @param write Open the config file for writing (true) or reading (false)
+ * @param file_name File name to open
+ * @param working_buffer A working buffer used by the config parser to process the file.
+ * @param buff_size Size of \p working_buffer. Must be large enough to hold a full line of the config file
+ * @return Config parser error
+ */
 config_parser_handle_t config_parser_open_file(struct config_parser *config_parser, bool write, const char *file_name,
 					       char *working_buffer, size_t buff_size);
 
@@ -83,13 +107,39 @@ config_parser_handle_t config_parser_open_file(struct config_parser *config_pars
  * @return Config parser error
  */
 enum config_parser_ret config_parser_get_line(config_parser_handle_t handle, struct config_parser_entry *entry, bool force_float);
-
+/**
+ * @brief Reset the config parser instance to the beginning of the config file
+ * @param handle Config parser
+ * @return Config parser error
+ */
 enum config_parser_ret config_parser_reset_to_start(config_parser_handle_t handle);
 
+/**
+ * @brief Write a config entry to a config file
+ * @param handle Handle to the config parser. This must be opened in write mode.
+ * @param entry
+ * @return Config parser error
+ * @warning This function is currently not implemented and will return with a success!
+ */
 enum config_parser_ret config_parser_write_entry(config_parser_handle_t handle, const struct config_parser_entry *entry);
 
+/**
+ * @brief Close a config parser handle
+ * @param handle Config parser
+ * @return Config parser error
+ */
 enum config_parser_ret config_parser_close_file(config_parser_handle_t handle);
 
+/**
+ * @brief Check if the \p return_val is a abort condition to stop parsing a file.
+ *
+ * This function will return true if a disk error occured or the end of file is reached.
+ *
+ * @param return_val
+ * @return
+ */
+bool config_parser_ret_is_abort_condition(enum config_parser_ret return_val);
+
 #endif /* _CONFIG_PARSER_H_ */
 
 /** @} */

stm-firmware/create-c-file-with-header.py

@@ -6,7 +6,7 @@ import pathlib
 
 license_header = """/* Reflow Oven Controller
 *
-* Copyright (C) 2020  Mario Hüttel <mario.huettel@gmx.net>
+* Copyright (C) 2022  Mario Hüttel <mario.huettel@gmx.net>
 *
 * This file is part of the Reflow Oven Controller Project.
 *
@@ -37,7 +37,7 @@ cpath = os.path.join(project_dir, sys.argv[1]+'.c')
 hfile = sys.argv[1]+'.h'
 hpath = os.path.join(module_include_dir, hfile)
 
-h_define = '__'+hfile.replace('.', '_').replace('-', '_').replace('/', '_').upper()+'__'
+h_define = '_'+hfile.replace('.', '_').replace('-', '_').replace('/', '_').upper()+'_'
 
 if os.path.exists(cpath) or os.path.exists(hpath):
 	print("File already exists! Abort!")

stm-firmware/digio.c

@@ -18,9 +18,14 @@
  * If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @addtogroup digio
+ * @{
+ */
+
 #include <reflow-controller/digio.h>
 #include <stm32/stm32f4xx.h>
-#include <stm-periph/clock-enable-manager.h>
+#include <stm-periph/rcc-manager.h>
 #include <stm-periph/stm32-gpio-macros.h>
 #include <helper-macros/helper-macros.h>
 
@@ -47,17 +52,10 @@ static void digio_setup_pin_int(uint8_t bit_no, uint8_t in_out, uint8_t alt_func
 
 }
 
-void digio_setup_default_all(void)
+void digio_init(void)
 {
-	unsigned int i;
-
 	rcc_manager_enable_clock(&RCC->AHB1ENR, BITMASK_TO_BITNO(DIGIO_RCC_MASK));
-
-	for (i = 0; i < COUNT_OF(digio_pins); i++) {
-		digio_setup_pin_int(digio_pins[i], digio_default_io[i], digio_default_altfunc[i]);
-		if (digio_default_io[i] == 1)
-			digio_set(i, 0);
-	}
+	digio_set_default_values();
 }
 
 void digio_setup_pin(uint8_t num, uint8_t in_out, uint8_t alt_func)
@@ -69,12 +67,22 @@ void digio_setup_pin(uint8_t num, uint8_t in_out, uint8_t alt_func)
 
 void digio_set(uint8_t num, int val)
 {
+	uint8_t pin;
+
 	if (num >= COUNT_OF(digio_pins))
 		return;
+
+	pin = digio_pins[num];
+
+	/* Check if port is an output. If not, do noting. */
+	if ((DIGIO_PORT->MODER & (0x3<<pin)) != OUTPUT(pin)) {
+		return;
+	}
+
 	if (val)
-		DIGIO_PORT->ODR |= (1<<digio_pins[num]);
+		DIGIO_PORT->ODR |= (1<<pin);
 	else
-		DIGIO_PORT->ODR &= ~(1<<digio_pins[num]);
+		DIGIO_PORT->ODR &= ~(1<<pin);
 }
 
 int digio_get(uint8_t num)
@@ -119,7 +127,12 @@ int led_get(uint8_t num)
 	return ((LED_PORT->ODR & (1<<led_pins[num])) ? 1 : 0);
 }
 
-
+/**
+ * @brief Initialize the timer for the beeper to generate the output frequency
+ *
+ * TIM7 is used as the frequency generating timer. If @ref LOUDSPEAKER_MULTIFREQ
+ * is 0, the timer is unused and this function does nothing.
+ */
 static void loudspeaker_freq_timer_init(void)
 {
 #if LOUDSPEAKER_MULTIFREQ
@@ -143,10 +156,17 @@ void loudspeaker_setup(void)
 	loudspeaker_set(0U);
 }
 
+/**
+ * @brief Start the beeper
+ * @param val frequency value of the speaker in 'Timer relaod values'
+ * @note If @ref LOUDSPEAKER_MULTIFREQ isn't set,
+ * the speaker output will be set to high and no frequency is generated.
+ * The value of @p val is ignored in this case
+ */
 static void loudspeaker_start_beep(uint16_t val)
 {
 #if LOUDSPEAKER_MULTIFREQ
-	TIM7->ARR = val;
+	TIM7->ARR = (val == 1 ? LOUDSPEAKER_MULTIFREQ_DEFAULT : val);
 	TIM7->CNT = 0UL;
 	TIM7->CR1 |= TIM_CR1_CEN;
 #else
@@ -155,6 +175,9 @@ static void loudspeaker_start_beep(uint16_t val)
 #endif
 }
 
+/**
+ * @brief Stop the beeping of the loudspeaker
+ */
 static void loudspeaker_stop_beep(void)
 {
 #if LOUDSPEAKER_MULTIFREQ
@@ -172,11 +195,10 @@ void loudspeaker_set(uint16_t val)
 {
 	loudspeaker_val = val;
 
-	if (!val) {
+	if (!val)
 		loudspeaker_stop_beep();
-	} else {
+	else
 		loudspeaker_start_beep(val);
-	}
 }
 
 uint16_t loudspeaker_get(void)
@@ -185,6 +207,12 @@ uint16_t loudspeaker_get(void)
 }
 
 #if LOUDSPEAKER_MULTIFREQ
+/**
+ * @brief Timer7 IRQ Handler
+ *
+ * This IRQ Handler is used by the loudspeaker to synthesize the output frequency.
+ * If @ref LOUDSPEAKER_MULTIFREQ is 0, TIM7 and this interrupt will not be used.
+ */
 void TIM7_IRQHandler(void)
 {
 	TIM7->SR = 0UL;
@@ -192,3 +220,16 @@ void TIM7_IRQHandler(void)
 	LOUDSPEAKER_PORT->ODR ^= (1<<LOUDSPEAKER_PIN);
 }
 #endif
+
+/** @} */
+
+void digio_set_default_values()
+{
+	unsigned int i;
+
+	for (i = 0; i < COUNT_OF(digio_pins); i++) {
+		digio_setup_pin_int(digio_pins[i], digio_default_io[i], digio_default_altfunc[i]);
+		if (digio_default_io[i] == 1)
+			digio_set(i, 0);
+	}
+}

stm-firmware/doxygen/CMakeLists.txt

@@ -0,0 +1,40 @@
+find_package(Doxygen)
+
+if(NOT WIN32)
+  string(ASCII 27 Esc)
+  set(ColorReset "${Esc}[m")
+  set(ColorBold  "${Esc}[1m")
+  set(Red         "${Esc}[31m")
+  set(Green       "${Esc}[32m")
+  set(Yellow      "${Esc}[33m")
+  set(Blue        "${Esc}[34m")
+  set(Magenta     "${Esc}[35m")
+  set(Cyan        "${Esc}[36m")
+  set(White       "${Esc}[37m")
+  set(BoldRed     "${Esc}[1;31m")
+  set(BoldGreen   "${Esc}[1;32m")
+  set(BoldYellow  "${Esc}[1;33m")
+  set(BoldBlue    "${Esc}[1;34m")
+  set(BoldMagenta "${Esc}[1;35m")
+  set(BoldCyan    "${Esc}[1;36m")
+  set(BoldWhite   "${Esc}[1;37m")
+endif()
+
+if (DOXYGEN_FOUND)
+	add_custom_target(documentation DEPENDS doxygen doxygen-pdf)
+
+	add_custom_target(doxygen
+		COMMAND ./build-doxygen.sh "${PROJECT_BINARY_DIR}"
+		WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+		COMMENT "Generating documentation with Doxygen")
+
+	add_custom_target(
+	   doxygen-pdf
+	   COMMAND make
+	   WORKING_DIRECTORY "${PROJECT_BINARY_DIR}/latex"
+	   DEPENDS doxygen
+	   )
+else (DOXYGEN_FOUND)
+	message("${BoldMagenta}Doxygen needs to be installed to generate the doxygen documentation${ColorReset}")
+	message("${BoldMagenta}doxygen, documentation, doxygen-latex targets will not be available${ColorReset}")
+endif (DOXYGEN_FOUND)

stm-firmware/doxygen/Doxyconfig

@@ -1,4 +1,4 @@
-# Doxyfile 1.8.20
+# Doxyfile 1.9.2
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
@@ -93,14 +93,6 @@ ALLOW_UNICODE_NAMES    = NO
 
 OUTPUT_LANGUAGE        = English
 
-# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
-# documentation generated by doxygen is written. Doxygen will use this
-# information to generate all generated output in the proper direction.
-# Possible values are: None, LTR, RTL and Context.
-# The default value is: None.
-
-OUTPUT_TEXT_DIRECTION  = None
-
 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
 # descriptions after the members that are listed in the file and class
 # documentation (similar to Javadoc). Set to NO to disable this.
@@ -186,7 +178,7 @@ STRIP_FROM_INC_PATH    =
 # support long names like on DOS, Mac, or CD-ROM.
 # The default value is: NO.
 
-SHORT_NAMES            = NO
+SHORT_NAMES            = YES
 
 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
 # first line (until the first dot) of a Javadoc-style comment as the brief
@@ -258,16 +250,16 @@ TAB_SIZE               = 8
 # the documentation. An alias has the form:
 # name=value
 # For example adding
-# "sideeffect=@par Side Effects:\n"
+# "sideeffect=@par Side Effects:^^"
 # will allow you to put the command \sideeffect (or @sideeffect) in the
 # documentation, which will result in a user-defined paragraph with heading
-# "Side Effects:". You can put \n's in the value part of an alias to insert
-# newlines (in the resulting output). You can put ^^ in the value part of an
-# alias to insert a newline as if a physical newline was in the original file.
-# When you need a literal { or } or , in the value part of an alias you have to
-# escape them by means of a backslash (\), this can lead to conflicts with the
-# commands \{ and \} for these it is advised to use the version @{ and @} or use
-# a double escape (\\{ and \\})
+# "Side Effects:". Note that you cannot put \n's in the value part of an alias
+# to insert newlines (in the resulting output). You can put ^^ in the value part
+# of an alias to insert a newline as if a physical newline was in the original
+# file. When you need a literal { or } or , in the value part of an alias you
+# have to escape them by means of a backslash (\), this can lead to conflicts
+# with the commands \{ and \} for these it is advised to use the version @{ and
+# @} or use a double escape (\\{ and \\})
 
 ALIASES                =
 
@@ -312,8 +304,8 @@ OPTIMIZE_OUTPUT_SLICE  = NO
 # extension. Doxygen has a built-in mapping, but you can override or extend it
 # using this tag. The format is ext=language, where ext is a file extension, and
 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
-# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
-# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
+# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
+# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
 # tries to guess whether the code is fixed or free formatted code, this is the
 # default for Fortran type files). For instance to make doxygen treat .inc files
@@ -323,7 +315,10 @@ OPTIMIZE_OUTPUT_SLICE  = NO
 # Note: For files without extension you can use no_extension as a placeholder.
 #
 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
-# the files are not read by doxygen.
+# the files are not read by doxygen. When specifying no_extension you should add
+# * to the FILE_PATTERNS.
+#
+# Note see also the list of default file extension mappings.
 
 EXTENSION_MAPPING      =
 
@@ -463,12 +458,12 @@ LOOKUP_CACHE_SIZE      = 0
 # than 0 to get more control over the balance between CPU load and processing
 # speed. At this moment only the input processing can be done using multiple
 # threads. Since this is still an experimental feature the default is set to 1,
-# which efficively disables parallel processing. Please report any issues you
+# which effectively disables parallel processing. Please report any issues you
 # encounter. Generating dot graphs in parallel is controlled by the
 # DOT_NUM_THREADS setting.
 # Minimum value: 0, maximum value: 32, default value: 1.
 
-NUM_PROC_THREADS       = 1
+NUM_PROC_THREADS       = 0
 
 #---------------------------------------------------------------------------
 # Build related configuration options
@@ -533,6 +528,13 @@ EXTRACT_LOCAL_METHODS  = NO
 
 EXTRACT_ANON_NSPACES   = NO
 
+# If this flag is set to YES, the name of an unnamed parameter in a declaration
+# will be determined by the corresponding definition. By default unnamed
+# parameters remain unnamed in the output.
+# The default value is: YES.
+
+RESOLVE_UNNAMED_PARAMS = YES
+
 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
 # undocumented members inside documented classes or files. If set to NO these
 # members will be included in the various overviews, but no documentation
@@ -570,11 +572,18 @@ HIDE_IN_BODY_DOCS      = NO
 
 INTERNAL_DOCS          = NO
 
-# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
-# names in lower-case letters. If set to YES, upper-case letters are also
-# allowed. This is useful if you have classes or files whose names only differ
-# in case and if your file system supports case sensitive file names. Windows
-# (including Cygwin) and Mac users are advised to set this option to NO.
+# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
+# able to match the capabilities of the underlying filesystem. In case the
+# filesystem is case sensitive (i.e. it supports files in the same directory
+# whose names only differ in casing), the option must be set to YES to properly
+# deal with such files in case they appear in the input. For filesystems that
+# are not case sensitive the option should be be set to NO to properly deal with
+# output files written for symbols that only differ in casing, such as for two
+# classes, one named CLASS and the other named Class, and to also support
+# references to files without having to specify the exact matching casing. On
+# Windows (including Cygwin) and MacOS, users should typically set this option
+# to NO, whereas on Linux or other Unix flavors it should typically be set to
+# YES.
 # The default value is: system dependent.
 
 CASE_SENSE_NAMES       = NO
@@ -593,6 +602,12 @@ HIDE_SCOPE_NAMES       = YES
 
 HIDE_COMPOUND_REFERENCE= NO
 
+# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
+# will show which file needs to be included to use the class.
+# The default value is: YES.
+
+SHOW_HEADERFILE        = YES
+
 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
 # the files that are included by a file in the documentation of that file.
 # The default value is: YES.
@@ -750,7 +765,8 @@ FILE_VERSION_FILTER    =
 # output files in an output format independent way. To create the layout file
 # that represents doxygen's defaults, run doxygen with the -l option. You can
 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
-# will be used as the name of the layout file.
+# will be used as the name of the layout file. See also section "Changing the
+# layout of pages" for information.
 #
 # Note that if you run doxygen from a directory containing a file called
 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
@@ -796,24 +812,35 @@ WARNINGS               = YES
 WARN_IF_UNDOCUMENTED   = YES
 
 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
-# potential errors in the documentation, such as not documenting some parameters
-# in a documented function, or documenting parameters that don't exist or using
-# markup commands wrongly.
+# potential errors in the documentation, such as documenting some parameters in
+# a documented function twice, or documenting parameters that don't exist or
+# using markup commands wrongly.
 # The default value is: YES.
 
 WARN_IF_DOC_ERROR      = YES
 
+# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
+# function parameter documentation. If set to NO, doxygen will accept that some
+# parameters have no documentation without warning.
+# The default value is: YES.
+
+WARN_IF_INCOMPLETE_DOC = YES
+
 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
 # are documented, but have no documentation for their parameters or return
-# value. If set to NO, doxygen will only warn about wrong or incomplete
-# parameter documentation, but not about the absence of documentation. If
-# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
+# value. If set to NO, doxygen will only warn about wrong parameter
+# documentation, but not about the absence of documentation. If EXTRACT_ALL is
+# set to YES then this flag will automatically be disabled. See also
+# WARN_IF_INCOMPLETE_DOC
 # The default value is: NO.
 
 WARN_NO_PARAMDOC       = NO
 
 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
-# a warning is encountered.
+# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
+# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
+# at the end of the doxygen process doxygen will return with a non-zero status.
+# Possible values are: NO, YES and FAIL_ON_WARNINGS.
 # The default value is: NO.
 
 WARN_AS_ERROR          = NO
@@ -849,8 +876,8 @@ INPUT                  = ../
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
-# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
-# possible encodings.
+# documentation (see:
+# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
 # The default value is: UTF-8.
 
 INPUT_ENCODING         = UTF-8
@@ -863,12 +890,14 @@ INPUT_ENCODING         = UTF-8
 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
 # read by doxygen.
 #
+# Note the list of default checked file patterns might differ from the list of
+# default file extension mappings.
+#
 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
-# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
-# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
-# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
-# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
+# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
+# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
+# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
 # *.vhdl, *.ucf, *.qsf and *.ice.
 
 FILE_PATTERNS          = *.c \
@@ -934,8 +963,13 @@ RECURSIVE              = YES
 
 EXCLUDE                = ../include/stm32 \
                          ../include/arm_math.h \
-                         ../include/cmsis \
-                         ../shellmatta/test
+                         ../include/cmsis/ \
+                         ../shellmatta/test/ \
+                         ../linklist-lib/test \
+                         ../base64-lib/test \
+                         ../shellmatta/doc/main.dox \
+                         ../updater/ram-code \
+                         ./
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -1143,13 +1177,6 @@ VERBATIM_HEADERS       = YES
 
 ALPHABETICAL_INDEX     = YES
 
-# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
-# which the alphabetical index list will be split.
-# Minimum value: 1, maximum value: 20, default value: 5.
-# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
-
-COLS_IN_ALPHA_INDEX    = 5
-
 # In case all classes in a project start with a common prefix, all classes will
 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
 # can be used to specify a prefix (or a list of prefixes) that should be ignored
@@ -1249,7 +1276,7 @@ HTML_EXTRA_FILES       =
 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
 # will adjust the colors in the style sheet and background images according to
-# this color. Hue is specified as an angle on a colorwheel, see
+# this color. Hue is specified as an angle on a color-wheel, see
 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
 # purple, and 360 is red again.
@@ -1259,7 +1286,7 @@ HTML_EXTRA_FILES       =
 HTML_COLORSTYLE_HUE    = 220
 
 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
-# in the HTML output. For a value of 0 the output will use grayscales only. A
+# in the HTML output. For a value of 0 the output will use gray-scales only. A
 # value of 255 will produce the most vivid colors.
 # Minimum value: 0, maximum value: 255, default value: 100.
 # This tag requires that the tag GENERATE_HTML is set to YES.
@@ -1320,10 +1347,11 @@ HTML_INDEX_NUM_ENTRIES = 100
 
 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
 # generated that can be used as input for Apple's Xcode 3 integrated development
-# environment (see: https://developer.apple.com/xcode/), introduced with OSX
-# 10.5 (Leopard). To create a documentation set, doxygen will generate a
-# Makefile in the HTML output directory. Running make will produce the docset in
-# that directory and running make install will install the docset in
+# environment (see:
+# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
+# create a documentation set, doxygen will generate a Makefile in the HTML
+# output directory. Running make will produce the docset in that directory and
+# running make install will install the docset in
 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
 # genXcode/_index.html for more information.
@@ -1365,8 +1393,12 @@ DOCSET_PUBLISHER_NAME  = Publisher
 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
-# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
-# Windows.
+# on Windows. In the beginning of 2021 Microsoft took the original page, with
+# a.o. the download links, offline the HTML help workshop was already many years
+# in maintenance mode). You can download the HTML help workshop from the web
+# archives at Installation executable (see:
+# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
+# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
 #
 # The HTML Help Workshop contains a compiler that can convert all HTML output
 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
@@ -1441,7 +1473,8 @@ QCH_FILE               =
 
 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
 # Project output. For more information please see Qt Help Project / Namespace
-# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
+# (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
 # The default value is: org.doxygen.Project.
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
@@ -1449,8 +1482,8 @@ QHP_NAMESPACE          = org.doxygen.Project
 
 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
 # Help Project output. For more information please see Qt Help Project / Virtual
-# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
-# folders).
+# Folders (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
 # The default value is: doc.
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
@@ -1458,16 +1491,16 @@ QHP_VIRTUAL_FOLDER     = doc
 
 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
 # filter to add. For more information please see Qt Help Project / Custom
-# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
-# filters).
+# Filters (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHP_CUST_FILTER_NAME   =
 
 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
 # custom filter to add. For more information please see Qt Help Project / Custom
-# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
-# filters).
+# Filters (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHP_CUST_FILTER_ATTRS  =
@@ -1479,9 +1512,9 @@ QHP_CUST_FILTER_ATTRS  =
 
 QHP_SECT_FILTER_ATTRS  =
 
-# The QHG_LOCATION tag can be used to specify the location of Qt's
-# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
-# generated .qhp file.
+# The QHG_LOCATION tag can be used to specify the location (absolute path
+# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
+# run qhelpgenerator on the generated .qhp file.
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHG_LOCATION           =
@@ -1524,16 +1557,28 @@ DISABLE_INDEX          = NO
 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
 # (i.e. any modern browser). Windows users are probably better off using the
 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
-# further fine-tune the look of the index. As an example, the default style
-# sheet generated by doxygen has an example that shows how to put an image at
-# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
-# the same information as the tab index, you could consider setting
-# DISABLE_INDEX to YES when enabling this option.
+# further fine tune the look of the index (see "Fine-tuning the output"). As an
+# example, the default style sheet generated by doxygen has an example that
+# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
+# Since the tree basically has the same information as the tab index, you could
+# consider setting DISABLE_INDEX to YES when enabling this option.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
 GENERATE_TREEVIEW      = NO
 
+# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
+# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
+# area (value NO) or if it should extend to the full height of the window (value
+# YES). Setting this to YES gives a layout similar to
+# https://docs.readthedocs.io with more room for contents, but less room for the
+# project logo, title, and description. If either GENERATOR_TREEVIEW or
+# DISABLE_INDEX is set to NO, this option has no effect.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FULL_SIDEBAR           = NO
+
 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
 # doxygen will group on one line in the generated HTML documentation.
 #
@@ -1606,11 +1651,29 @@ FORMULA_MACROFILE      =
 
 USE_MATHJAX            = YES
 
+# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
+# Note that the different versions of MathJax have different requirements with
+# regards to the different settings, so it is possible that also other MathJax
+# settings have to be changed when switching between the different MathJax
+# versions.
+# Possible values are: MathJax_2 and MathJax_3.
+# The default value is: MathJax_2.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_VERSION        = MathJax_2
+
 # When MathJax is enabled you can set the default output format to be used for
-# the MathJax output. See the MathJax site (see:
-# http://docs.mathjax.org/en/latest/output.html) for more details.
+# the MathJax output. For more details about the output format see MathJax
+# version 2 (see:
+# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
+# (see:
+# http://docs.mathjax.org/en/latest/web/components/output.html).
 # Possible values are: HTML-CSS (which is slower, but has the best
-# compatibility), NativeMML (i.e. MathML) and SVG.
+# compatibility. This is the name for Mathjax version 2, for MathJax version 3
+# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
+# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
+# is the name for Mathjax version 3, for MathJax version 2 this will be
+# translated into HTML-CSS) and SVG.
 # The default value is: HTML-CSS.
 # This tag requires that the tag USE_MATHJAX is set to YES.
 
@@ -1623,22 +1686,29 @@ MATHJAX_FORMAT         = HTML-CSS
 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
 # Content Delivery Network so you can quickly see the result without installing
 # MathJax. However, it is strongly recommended to install a local copy of
-# MathJax from https://www.mathjax.org before deployment.
-# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
+# MathJax from https://www.mathjax.org before deployment. The default value is:
+# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
+# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
 # This tag requires that the tag USE_MATHJAX is set to YES.
 
 MATHJAX_RELPATH        = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
 
 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
 # extension names that should be enabled during MathJax rendering. For example
+# for MathJax version 2 (see
+# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# For example for MathJax version 3 (see
+# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
+# MATHJAX_EXTENSIONS = ams
 # This tag requires that the tag USE_MATHJAX is set to YES.
 
 MATHJAX_EXTENSIONS     =
 
 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
 # of code that will be used on startup of the MathJax code. See the MathJax site
-# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# (see:
+# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
 # example see the documentation.
 # This tag requires that the tag USE_MATHJAX is set to YES.
 
@@ -1685,7 +1755,8 @@ SERVER_BASED_SEARCH    = NO
 #
 # Doxygen ships with an example indexer (doxyindexer) and search engine
 # (doxysearch.cgi) which are based on the open source search engine library
-# Xapian (see: https://xapian.org/).
+# Xapian (see:
+# https://xapian.org/).
 #
 # See the section "External Indexing and Searching" for details.
 # The default value is: NO.
@@ -1698,8 +1769,9 @@ EXTERNAL_SEARCH        = NO
 #
 # Doxygen ships with an example indexer (doxyindexer) and search engine
 # (doxysearch.cgi) which are based on the open source search engine library
-# Xapian (see: https://xapian.org/). See the section "External Indexing and
-# Searching" for details.
+# Xapian (see:
+# https://xapian.org/). See the section "External Indexing and Searching" for
+# details.
 # This tag requires that the tag SEARCHENGINE is set to YES.
 
 SEARCHENGINE_URL       =
@@ -1737,7 +1809,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
 # The default value is: YES.
 
-GENERATE_LATEX         = NO
+GENERATE_LATEX         = YES
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -1808,29 +1880,31 @@ PAPER_TYPE             = a4
 
 EXTRA_PACKAGES         = amsmath
 
-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
-# generated LaTeX document. The header should contain everything until the first
-# chapter. If it is left blank doxygen will generate a standard header. See
-# section "Doxygen usage" for information on how to let doxygen write the
-# default header to a separate file.
+# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
+# the generated LaTeX document. The header should contain everything until the
+# first chapter. If it is left blank doxygen will generate a standard header. It
+# is highly recommended to start with a default header using
+# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
+# and then modify the file new_header.tex. See also section "Doxygen usage" for
+# information on how to generate the default header that doxygen normally uses.
 #
-# Note: Only use a user-defined header if you know what you are doing! The
-# following commands have a special meaning inside the header: $title,
-# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
-# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
-# string, for the replacement values of the other commands the user is referred
-# to HTML_HEADER.
+# Note: Only use a user-defined header if you know what you are doing!
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. The following
+# commands have a special meaning inside the header (and footer): For a
+# description of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_HEADER           =
 
-# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
-# generated LaTeX document. The footer should contain everything after the last
-# chapter. If it is left blank doxygen will generate a standard footer. See
+# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
+# the generated LaTeX document. The footer should contain everything after the
+# last chapter. If it is left blank doxygen will generate a standard footer. See
 # LATEX_HEADER for more information on how to generate a default footer and what
-# special commands can be used inside the footer.
-#
-# Note: Only use a user-defined footer if you know what you are doing!
+# special commands can be used inside the footer. See also section "Doxygen
+# usage" for information on how to generate the default footer that doxygen
+# normally uses. Note: Only use a user-defined footer if you know what you are
+# doing!
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_FOOTER           =
@@ -1875,8 +1949,7 @@ USE_PDFLATEX           = YES
 
 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
 # command to the generated LaTeX files. This will instruct LaTeX to keep running
-# if errors occur, instead of asking the user for help. This option is also used
-# when generating formulas in HTML.
+# if errors occur, instead of asking the user for help.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
@@ -1889,16 +1962,6 @@ LATEX_BATCHMODE        = NO
 
 LATEX_HIDE_INDICES     = NO
 
-# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
-# code with syntax highlighting in the LaTeX output.
-#
-# Note that which sources are shown also depends on other settings such as
-# SOURCE_BROWSER.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_SOURCE_CODE      = YES
-
 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
 # bibliography, e.g. plainnat, or ieeetr. See
 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
@@ -1979,16 +2042,6 @@ RTF_STYLESHEET_FILE    =
 
 RTF_EXTENSIONS_FILE    =
 
-# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
-# with syntax highlighting in the RTF output.
-#
-# Note that which sources are shown also depends on other settings such as
-# SOURCE_BROWSER.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_RTF is set to YES.
-
-RTF_SOURCE_CODE        = NO
-
 #---------------------------------------------------------------------------
 # Configuration options related to the man page output
 #---------------------------------------------------------------------------
@@ -2085,15 +2138,6 @@ GENERATE_DOCBOOK       = NO
 
 DOCBOOK_OUTPUT         = docbook
 
-# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
-# program listings (including syntax highlighting and cross-referencing
-# information) to the DOCBOOK output. Note that enabling this will significantly
-# increase the size of the DOCBOOK output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-
-DOCBOOK_PROGRAMLISTING = NO
-
 #---------------------------------------------------------------------------
 # Configuration options for the AutoGen Definitions output
 #---------------------------------------------------------------------------
@@ -2206,7 +2250,7 @@ INCLUDE_FILE_PATTERNS  =
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
 PREDEFINED             = __attribute__(x)= \
-			 IN_SECTION(x)=
+                         IN_SECTION(x)=
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The
@@ -2383,10 +2427,32 @@ UML_LOOK               = NO
 # but if the number exceeds 15, the total amount of fields shown is limited to
 # 10.
 # Minimum value: 0, maximum value: 100, default value: 10.
-# This tag requires that the tag HAVE_DOT is set to YES.
+# This tag requires that the tag UML_LOOK is set to YES.
 
 UML_LIMIT_NUM_FIELDS   = 10
 
+# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
+# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
+# tag is set to YES, doxygen will add type and arguments for attributes and
+# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
+# will not generate fields with class member information in the UML graphs. The
+# class diagrams will look similar to the default class diagrams but using UML
+# notation for the relationships.
+# Possible values are: NO, YES and NONE.
+# The default value is: NO.
+# This tag requires that the tag UML_LOOK is set to YES.
+
+DOT_UML_DETAILS        = NO
+
+# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
+# to display on a single line. If the actual line length exceeds this threshold
+# significantly it will wrapped across multiple lines. Some heuristics are apply
+# to avoid ugly line breaks.
+# Minimum value: 0, maximum value: 1000, default value: 17.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_WRAP_THRESHOLD     = 17
+
 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
 # collaboration graphs will show the relations between templates and their
 # instances.
@@ -2576,9 +2642,11 @@ DOT_MULTI_TARGETS      = NO
 
 GENERATE_LEGEND        = YES
 
-# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
 # files that are used to generate the various graphs.
+#
+# Note: This setting is not only used for dot files but also for msc temporary
+# files.
 # The default value is: YES.
-# This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_CLEANUP            = YES

stm-firmware/fatfs/LICENSE.txt

@@ -0,0 +1,24 @@
+FatFs License
+
+FatFs has being developped as a personal project of the author, ChaN. It is free from the code anyone else wrote at current release. Following code block shows a copy of the FatFs license document that heading the source files.
+
+/*----------------------------------------------------------------------------/
+/  FatFs - Generic FAT Filesystem Module  Rx.xx                               /
+/-----------------------------------------------------------------------------/
+/
+/ Copyright (C) 20xx, ChaN, all right reserved.
+/
+/ FatFs module is an open source software. Redistribution and use of FatFs in
+/ source and binary forms, with or without modification, are permitted provided
+/ that the following condition is met:
+/
+/ 1. Redistributions of source code must retain the above copyright notice,
+/    this condition and the following disclaimer.
+/
+/ This software is provided by the copyright holder and contributors "AS IS"
+/ and any warranties related to this software are DISCLAIMED.
+/ The copyright owner or contributors be NOT LIABLE for any damages caused
+/ by use of this software.
+/----------------------------------------------------------------------------*/
+
+Therefore FatFs license is one of the BSD-style licenses, but there is a significant feature. FatFs is mainly intended for embedded systems. In order to extend the usability for commercial products, the redistributions of FatFs in binary form, such as embedded code, binary library and any forms without source code, do not need to include about FatFs in the documentations. This is equivalent to the 1-clause BSD license. Of course FatFs is compatible with the most of open source software licenses include GNU GPL. When you redistribute the FatFs source code with changes or create a fork, the license can also be changed to GNU GPL, BSD-style license or any open source software license that not conflict with FatFs license.

stm-firmware/fatfs/diskio.c

@@ -1,5 +1,5 @@
 /*-----------------------------------------------------------------------*/
-/* Low level disk I/O module skeleton for FatFs     (C)ChaN, 2019        */
+/* Low level disk I/O module SKELETON for FatFs     (C)ChaN, 2019        */
 /*-----------------------------------------------------------------------*/
 /* If a working storage control module is available, it should be        */
 /* attached to the FatFs via a glue function rather than modifying it.   */
@@ -12,14 +12,8 @@
 #include "shimatta_sdio_driver/shimatta_sdio.h"
 
 /* Definitions of physical drive number for each drive */
-#define DEV_SD		0	/* Example: Map MMC/SD card to physical drive 0*/
-/*
-DSTATUS SDIO_status();
-DSTATUS SDIO_initialize();
-DRESULT SDIO_disk_read(BYTE *buff, DWORD sector, UINT count);
-DRESULT SDIO_disk_write(const BYTE *buff, DWORD sector, UINT count);
-DRESULT SDIO_disk_ioctl(BYTE cmd, void* buff);
-*/
+#define DEV_SD 0
+
 /*-----------------------------------------------------------------------*/
 /* Get Drive Status                                                      */
 /*-----------------------------------------------------------------------*/
@@ -116,4 +110,3 @@ DRESULT disk_ioctl (
 
 	return RES_PARERR;
 }
-

stm-firmware/hw-version-detect.c

@@ -0,0 +1,84 @@
+/* Reflow Oven Controller
+ *
+ * Copyright (C) 2021  Mario Hüttel <mario.huettel@gmx.net>
+ *
+ * This file is part of the Reflow Oven Controller Project.
+ *
+ * The reflow oven controller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ * The Reflow Oven Control Firmware 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 the reflow oven controller project.
+ * If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @addtogroup hw-version-detect
+ * @{
+ */
+
+#include <reflow-controller/hw-version-detect.h>
+#include <stm-periph/rcc-manager.h>
+#include <stm32/stm32f4xx.h>
+
+#if HW_REV_DETECT_PIN_LOW > HW_REV_DETECT_PIN_HIGH
+#error Configuration error for Hardware derection pins. Lowest position must be less than the highest pin position.
+#endif
+
+enum hw_revision get_pcb_hardware_version(void)
+{
+	uint8_t current_pin;
+	uint16_t port_bitmask = 0U; /* Use uint16_t because a port can have 16 IOs max. */
+	const uint16_t highest_bit_mask = (1 << (HW_REV_DETECT_PIN_HIGH - HW_REV_DETECT_PIN_LOW));
+	static enum hw_revision revision = HW_REV_NOT_DETECTED;
+
+	/* If the revision has been previously detected,
+	 * just return it and don't do the whole detection stuff
+	 */
+	if (revision != HW_REV_NOT_DETECTED)
+		return revision;
+
+	rcc_manager_enable_clock(&RCC->AHB1ENR, BITMASK_TO_BITNO(HW_REV_DETECT_RCC_FIELD));
+
+	/* Setup the pins as input with pull up */
+	for (current_pin = HW_REV_DETECT_PIN_LOW; current_pin <= HW_REV_DETECT_PIN_HIGH; current_pin++) {
+		HW_REV_DETECT_GPIO->MODER &= MODER_DELETE(current_pin);
+		HW_REV_DETECT_GPIO->PUPDR &= PUPDR_DELETE(current_pin);
+		HW_REV_DETECT_GPIO->PUPDR |= PULLUP(current_pin);
+	}
+
+	/* Loop again and read in the pin mask.
+	 * Because we use GND-Shorts on the pins to detect the version, the pins are read inverted.
+	 */
+	for (current_pin = HW_REV_DETECT_PIN_LOW; current_pin <= HW_REV_DETECT_PIN_HIGH; current_pin++) {
+		port_bitmask >>= 1;
+		port_bitmask |= (HW_REV_DETECT_GPIO->IDR & (1 << current_pin)) ? 0x0 : highest_bit_mask;
+	}
+
+	/* Resolve the read in bitmask to a hardware version */
+	switch (port_bitmask) {
+	case 0U:
+		revision = HW_REV_V1_2;
+		break;
+	case 1U:
+		revision = HW_REV_V1_3;
+		break;
+	case 2U:
+		revision = HW_REV_V1_3_1;
+		break;
+	default:
+		revision = HW_REV_ERROR;
+	}
+
+	rcc_manager_disable_clock(&RCC->AHB1ENR, BITMASK_TO_BITNO(HW_REV_DETECT_RCC_FIELD));
+
+	return revision;
+}
+
+/** @} */

stm-firmware/include/fatfs/ff.h

@@ -1,8 +1,8 @@
 /*----------------------------------------------------------------------------/
-/  FatFs - Generic FAT Filesystem module  R0.14                               /
+/  FatFs - Generic FAT Filesystem module  R0.14b                              /
 /-----------------------------------------------------------------------------/
 /
-/ Copyright (C) 2019, ChaN, all right reserved.
+/ Copyright (C) 2021, ChaN, all right reserved.
 /
 / FatFs module is an open source software. Redistribution and use of FatFs in
 / source and binary forms, with or without modification, are permitted provided
@@ -20,7 +20,7 @@
 
 
 #ifndef FF_DEFINED
-#define FF_DEFINED	86606	/* Revision ID */
+#define FF_DEFINED	86631	/* Revision ID */
 
 #ifdef __cplusplus
 extern "C" {
@@ -35,10 +35,14 @@ extern "C" {
 
 /* Integer types used for FatFs API */
 
-#if defined(_WIN32)	/* Main development platform */
+#if defined(_WIN32)		/* Windows VC++ (for development only) */
 #define FF_INTDEF 2
 #include <windows.h>
 typedef unsigned __int64 QWORD;
+#include <float.h>
+#define isnan(v) _isnan(v)
+#define isinf(v) (!_finite(v))
+
 #elif (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || defined(__cplusplus)	/* C99 or later */
 #define FF_INTDEF 2
 #include <stdint.h>
@@ -48,6 +52,7 @@ typedef uint16_t		WORD;	/* 16-bit unsigned integer */
 typedef uint32_t		DWORD;	/* 32-bit unsigned integer */
 typedef uint64_t		QWORD;	/* 64-bit unsigned integer */
 typedef WORD			WCHAR;	/* UTF-16 character type */
+
 #else  	/* Earlier than C99 */
 #define FF_INTDEF 1
 typedef unsigned int	UINT;	/* int must be 16-bit or 32-bit */
@@ -58,28 +63,29 @@ typedef WORD			WCHAR;	/* UTF-16 character type */
 #endif
 
 
-/* Definitions of volume management */
+/* Type of file size and LBA variables */
 
-#if FF_MULTI_PARTITION		/* Multiple partition configuration */
-typedef struct {
-	BYTE pd;	/* Physical drive number */
-	BYTE pt;	/* Partition: 0:Auto detect, 1-4:Forced partition) */
-} PARTITION;
-extern PARTITION VolToPart[];	/* Volume - Partition mapping table */
+#if FF_FS_EXFAT
+#if FF_INTDEF != 2
+#error exFAT feature wants C99 or later
 #endif
-
-#if FF_STR_VOLUME_ID
-#ifndef FF_VOLUME_STRS
-extern const char* VolumeStr[FF_VOLUMES];	/* User defied volume ID */
+typedef QWORD FSIZE_t;
+#if FF_LBA64
+typedef QWORD LBA_t;
+#else
+typedef DWORD LBA_t;
 #endif
+#else
+#if FF_LBA64
+#error exFAT needs to be enabled when enable 64-bit LBA
+#endif
+typedef DWORD FSIZE_t;
+typedef DWORD LBA_t;
 #endif
 
 
 
-/* Type of path name strings on FatFs API */
-
-#ifndef _INC_TCHAR
-#define _INC_TCHAR
+/* Type of path name strings on FatFs API (TCHAR) */
 
 #if FF_USE_LFN && FF_LFN_UNICODE == 1 	/* Unicode in UTF-16 encoding */
 typedef WCHAR TCHAR;
@@ -101,28 +107,22 @@ typedef char TCHAR;
 #define _TEXT(x) x
 #endif
 
-#endif
 
 
+/* Definitions of volume management */
 
-/* Type of file size and LBA variables */
+#if FF_MULTI_PARTITION		/* Multiple partition configuration */
+typedef struct {
+	BYTE pd;	/* Physical drive number */
+	BYTE pt;	/* Partition: 0:Auto detect, 1-4:Forced partition) */
+} PARTITION;
+extern PARTITION VolToPart[];	/* Volume - Partition mapping table */
+#endif
 
-#if FF_FS_EXFAT
-#if FF_INTDEF != 2
-#error exFAT feature wants C99 or later
+#if FF_STR_VOLUME_ID
+#ifndef FF_VOLUME_STRS
+extern const char* VolumeStr[FF_VOLUMES];	/* User defied volume ID */
 #endif
-typedef QWORD FSIZE_t;
-#if FF_LBA64
-typedef QWORD LBA_t;
-#else
-typedef DWORD LBA_t;
-#endif
-#else
-#if FF_LBA64
-#error exFAT needs to be enabled when enable 64-bit LBA
-#endif
-typedef DWORD FSIZE_t;
-typedef DWORD LBA_t;
 #endif
 
 
@@ -345,10 +345,6 @@ TCHAR* f_gets (TCHAR* buff, int len, FIL* fp);						/* Get a string from the fil
 #define f_rmdir(path) f_unlink(path)
 #define f_unmount(path) f_mount(0, path, 0)
 
-#ifndef EOF
-#define EOF (-1)
-#endif
-
 
 
 

stm-firmware/include/fatfs/ffconf.h

@@ -2,7 +2,7 @@
 /  FatFs Functional Configurations
 /---------------------------------------------------------------------------*/
 
-#define FFCONF_DEF	86606	/* Revision ID */
+#define FFCONF_DEF	86631	/* Revision ID */
 
 /*---------------------------------------------------------------------------/
 / Function Configurations
@@ -25,15 +25,7 @@
 /   3: f_lseek() function is removed in addition to 2. */
 
 
-#define FF_USE_STRFUNC	1
-/* This option switches string functions, f_gets(), f_putc(), f_puts() and f_printf().
-/
-/  0: Disable string functions.
-/  1: Enable without LF-CRLF conversion.
-/  2: Enable with LF-CRLF conversion. */
-
-
-#define FF_USE_FIND		0
+#define FF_USE_FIND		1
 /* This option switches filtered directory read functions, f_findfirst() and
 /  f_findnext(). (0:Disable, 1:Enable 2:Enable with matching altname[] too) */
 
@@ -64,6 +56,30 @@
 /* This option switches f_forward() function. (0:Disable or 1:Enable) */
 
 
+#define FF_USE_STRFUNC	1
+#define FF_PRINT_LLI	0
+#define FF_PRINT_FLOAT	0
+#define FF_STRF_ENCODE	0
+/* FF_USE_STRFUNC switches string functions, f_gets(), f_putc(), f_puts() and
+/  f_printf().
+/
+/   0: Disable. FF_PRINT_LLI, FF_PRINT_FLOAT and FF_STRF_ENCODE have no effect.
+/   1: Enable without LF-CRLF conversion.
+/   2: Enable with LF-CRLF conversion.
+/
+/  FF_PRINT_LLI = 1 makes f_printf() support long long argument and FF_PRINT_FLOAT = 1/2
+   makes f_printf() support floating point argument. These features want C99 or later.
+/  When FF_LFN_UNICODE >= 1 with LFN enabled, string functions convert the character
+/  encoding in it. FF_STRF_ENCODE selects assumption of character encoding ON THE FILE
+/  to be read/written via those functions.
+/
+/   0: ANSI/OEM in current CP
+/   1: Unicode in UTF-16LE
+/   2: Unicode in UTF-16BE
+/   3: Unicode in UTF-8
+*/
+
+
 /*---------------------------------------------------------------------------/
 / Locale and Namespace Configurations
 /---------------------------------------------------------------------------*/
@@ -137,19 +153,6 @@
 /  on character encoding. When LFN is not enabled, these options have no effect. */
 
 
-#define FF_STRF_ENCODE	3
-/* When FF_LFN_UNICODE >= 1 with LFN enabled, string I/O functions, f_gets(),
-/  f_putc(), f_puts and f_printf() convert the character encoding in it.
-/  This option selects assumption of character encoding ON THE FILE to be
-/  read/written via those functions.
-/
-/   0: ANSI/OEM in current CP
-/   1: Unicode in UTF-16LE
-/   2: Unicode in UTF-16BE
-/   3: Unicode in UTF-8
-*/
-
-
 #define FF_FS_RPATH		2
 /* This option configures support for relative path.
 /
@@ -194,7 +197,7 @@
 #define FF_MAX_SS		512
 /* This set of options configures the range of sector size to be supported. (512,
 /  1024, 2048 or 4096) Always set both 512 for most systems, generic memory card and
-/  harddisk. But a larger value may be required for on-board flash memory and some
+/  harddisk, but a larger value may be required for on-board flash memory and some
 /  type of optical media. When FF_MAX_SS is larger than FF_MIN_SS, FatFs is configured
 /  for variable sector size mode and disk_ioctl() function needs to implement
 /  GET_SECTOR_SIZE command. */
@@ -205,8 +208,8 @@
 /  To enable the 64-bit LBA, also exFAT needs to be enabled. (FF_FS_EXFAT == 1) */
 
 
-#define FF_MIN_GPT		0x100000000
-/* Minimum number of sectors to switch GPT format to create partition in f_mkfs and
+#define FF_MIN_GPT		0x10000000
+/* Minimum number of sectors to switch GPT as partitioning format in f_mkfs and
 /  f_fdisk function. 0x100000000 max. This option has no effect when FF_LBA64 == 0. */
 
 
@@ -228,7 +231,7 @@
 /  buffer in the filesystem object (FATFS) is used for the file data transfer. */
 
 
-#define FF_FS_EXFAT		0
+#define FF_FS_EXFAT		1
 /* This option switches support for exFAT filesystem. (0:Disable or 1:Enable)
 /  To enable exFAT, also LFN needs to be enabled. (FF_USE_LFN >= 1)
 /  Note that enabling exFAT discards ANSI C (C89) compatibility. */
@@ -237,7 +240,7 @@
 #define FF_FS_NORTC		0
 #define FF_NORTC_MON	1
 #define FF_NORTC_MDAY	1
-#define FF_NORTC_YEAR	2019
+#define FF_NORTC_YEAR	2020
 /* The option FF_FS_NORTC switches timestamp functiton. If the system does not have
 /  any RTC function or valid timestamp is not needed, set FF_FS_NORTC = 1 to disable
 /  the timestamp function. Every object modified by FatFs will have a fixed timestamp

stm-firmware/include/reflow-controller/adc-meas.h

@@ -36,7 +36,24 @@
 /**
  * @brief Moving average filter coefficient for PT1000 measurement
  */
-#define ADC_PT1000_FILTER_WEIGHT 0.005f
+#define ADC_PT1000_FILTER_WEIGHT 0.01f
+
+/**
+  * @brief Moving average filter weight used for fast regaulation. This is used when the measured resistance
+  * is more than @ref ADC_PT1000_FILTER_UNSTABLE_DIFF Ohms away from the current averaged value.
+  */
+#define ADC_PT1000_FILTER_WEIGHT_FAST 0.05
+
+/**
+ * @brief Difference in Ohm between filter input and output that determines if the filter is stable or unstable.
+ */
+#define ADC_PT1000_FILTER_UNSTABLE_DIFF 20
+
+/**
+ * @brief Sample count, the moving average filter has to be within @ref ADC_PT1000_FILTER_UNSTABLE_DIFF for the filter
+ * to be considered stable
+ */
+#define ADC_PT1000_FILTER_STABLE_SAMPLE_COUNT 200
 
 /**
  * @brief ADC channel number of PT1000 sensor input
@@ -58,12 +75,6 @@
  */
 #define ADC_PT1000_PIN 2U
 
-/**
- * @brief The cycle count the moving average filter is labeled 'instable' after startup of the measurement or changing
- * the alpha value @ref ADC_PT1000_FILTER_WEIGHT
- */
-#define ADC_FILTER_STARTUP_CYCLES 800U
-
 /**
  * @brief The delay value programmed into the sample timer
  */
@@ -99,6 +110,8 @@
  */
 #define ADC_TO_RES(adc) ((float)(adc) / 4096.0f * 2500.0f)
 
+#define RES_TO_ADC(res) ((float)(res) / 2500.0f * 4096.0f)
+
 /**
  * @brief This function sets up the ADC measurement fo the external PT1000 temperature sensor
  *
@@ -131,6 +144,7 @@ void adc_pt1000_set_moving_average_filter_param(float alpha);
  *
  * @param offset Offset \f$O\f$
  * @param sensitivity_deviation Sensitivity Deviation \f$\sigma\f$ after offset correction
+ * @param active Calibration is active
  */
 void adc_pt1000_set_resistance_calibration(float offset, float sensitivity_deviation, bool active);
 

stm-firmware/include/reflow-controller/digio.h

@@ -18,6 +18,11 @@
  * If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @addtogroup digio
+ * @{
+ */
+
 #ifndef __DIGIO_H__
 #define __DIGIO_H__
 
@@ -25,10 +30,22 @@
 #include <stdint.h>
 #include <helper-macros/helper-macros.h>
 
+/**
+ * @brief Port the digital I/Os are located in
+ */
 #define DIGIO_PORT GPIOB
+
+/**
+ * @brief Reset and clock control bit mask to enable clock of @ref DIGIO_PORT
+ */
 #define DIGIO_RCC_MASK RCC_AHB1ENR_GPIOBEN
+
+/**
+ * @brief List of the pins used by the digio module
+ */
 #define DIGIO_PINS 4,5,6,7
 
+
 #if defined(DEBUGBUILD) || defined(UART_ON_DEBUG_HEADER)
 #define DIGIO_INOUT_DEFAULT 0,0,0,0
 #define DIGIO_ALTFUNC_DEFAULT 0,0,0,0
@@ -37,32 +54,139 @@
 #define DIGIO_ALTFUNC_DEFAULT 0,0,7,7
 #endif
 
+/**
+ * @brief The port, the loudspeaker is connected to
+ */
 #define BEEPER_PORT GPIOB
+
+/**
+ * @brief The RCC mask for @ref BEEPER_PORT
+ */
 #define BEEPER_RCC_MASK RCC_AHB1ENR_GPIOBEN
 
+/**
+ * @brief Enable all clocks and setup pins in default setting.
+ * @warning This function uses @ref rcc_manager_enable_clock to enable the clocks. Therefore, it must not be called
+ * multiple times.
+ * @note Calls @ref digio_set_default_values() internally.
+ */
+void digio_init(void);
 
-void digio_setup_default_all(void);
+/**
+ * @brief Setup or restore the default DIGIO settings.
+ *
+ * This function can be called multiple times.
+ */
+void digio_set_default_values(void);
 
+/**
+ * @brief Set up a DIGIO pin.
+ *
+ * Set up a digital IO pin config. For the index association see the @ref DIGIO_PINS table.
+ *
+ * @param num DIGIO number starting with 0
+ * @param in_out In: 0, Out 1, alternate function: 2
+ * @param alt_func Alternate function to set. Consult datasheet of STM32F407
+ */
 void digio_setup_pin(uint8_t num, uint8_t in_out, uint8_t alt_func);
+
+/**
+ * @brief Set a digio output port
+ * @param num Digio channel number
+ * @param val Value: 0 or 1.
+ */
 void digio_set(uint8_t num, int val);
+
+/**
+ * @brief Read the state of a digio channel
+ * @param num Channel number
+ * @return digital pin level.
+ */
 int digio_get(uint8_t num);
 
+/**
+ * @brief Port the LEDs are connected to
+ */
 #define LED_PORT GPIOB
+
+/**
+ * @brief RCC mask to enable clock for @ref LED_PORT
+ */
 #define LED_RCC_MASK RCC_AHB1ENR_GPIOBEN
+
+/**
+ * @brief Pin list on @ref LED_PORT that are connected to LEDs
+ */
 #define LED_PINS 2,3
 
+/**
+ * @brief Set up the LED Port
+ */
 void led_setup(void);
+
+/**
+ * @brief Set the LED status
+ * @param num LED number
+ * @param val Value: 1 on, 0 off.
+ */
 void led_set(uint8_t num, int val);
+
+/**
+ * @brief Get the state of a LED
+ * @param num LED number
+ * @return Stateof the LED: 0 off, 1 on; -1 in case of an error
+ */
 int led_get(uint8_t num);
 
+/**
+ * @brief Port to use for the loudpseaker
+ */
 #define LOUDSPEAKER_PORT GPIOB
+
+/**
+ * @brief RCC mask for @ref LOUDSPEAKER_PORT
+ */
 #define LOUDSPEAKER_RCC_MASK RCC_AHB1ENR_GPIOBEN
+
+/**
+ * @brief Pin on @ref LOUDSPEAKER_PORT the speaker is cnnected to
+ */
 #define LOUDSPEAKER_PIN 1
+
+/**
+ * @brief The loudpseaker requires a frequency signal instead of a simple on/off signal.
+ */
 #define LOUDSPEAKER_MULTIFREQ 1
 
+/**
+ * @brief Defautl timer relaod for the frequency of the speaker. Only relevant if @ref LOUDSPEAKER_MULTIFREQ is 1.
+ */
+#define LOUDSPEAKER_MULTIFREQ_DEFAULT 9
+
+/**
+ * @brief Setup the loudspeaker
+ */
 void loudspeaker_setup(void);
+
+/**
+ * @brief Set the loudspeaker value
+ *
+ * Zero turns off the beeper. 1 is a special value
+ * and will set the @ref LOUDSPEAKER_MULTIFREQ_DEFAULT value.
+ *
+ * If @ref LOUDSPEAKER_MULTIFREQ is 0, then no actual frequency is produced.
+ * Instead any @p val unequal to zero turns the output pin high and 0 will turn it low.
+ *
+ * @param val Value.
+ */
 void loudspeaker_set(uint16_t val);
+
+/**
+ * @brief Get current value of the loadspeaker
+ * @return Value
+ */
 uint16_t loudspeaker_get(void);
 
-
 #endif /* __DIGIO_H__ */
+
+/** @} */

stm-firmware/include/reflow-controller/hw-version-detect.h

@@ -0,0 +1,83 @@
+/* Reflow Oven Controller
+*
+* Copyright (C) 2021  Mario Hüttel <mario.huettel@gmx.net>
+*
+* This file is part of the Reflow Oven Controller Project.
+*
+* The reflow oven controller is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License version 2 as
+* published by the Free Software Foundation.
+*
+* The Reflow Oven Control Firmware 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 the reflow oven controller project.
+* If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @addtogroup hw-version-detect
+ * @{
+ */
+
+#ifndef _HW_VERSION_DETECT_H_
+#define _HW_VERSION_DETECT_H_
+
+#include <stdint.h>
+
+/**
+ * @brief GPIO Port used for hardware version detection
+ */
+#define HW_REV_DETECT_GPIO GPIOE
+
+/**
+ * @brief RCC Clock register mask used to enable @ref HW_REV_DETECT_GPIO GPIO Port
+ */
+#define HW_REV_DETECT_RCC_FIELD RCC_AHB1ENR_GPIOEEN
+
+/**
+ * @brief Lowest pin on @ref HW_REV_DETECT_GPIO GPIO Port that shall be used to read in the hardware version
+ */
+#define HW_REV_DETECT_PIN_LOW (8U)
+
+/**
+ * @brief Highest pin on @ref HW_REV_DETECT_GPIO GPIO Port that shall be used to read in the hardware version
+ */
+#define HW_REV_DETECT_PIN_HIGH (15U)
+
+/**
+ * @brief PCB/Hardware Revision Type
+ */
+enum hw_revision {
+	HW_REV_NOT_DETECTED = 0, /**< @brief The hardware has'nt been detected (yet) */
+	HW_REV_ERROR = 1,	/**< @brief The hardware revision could not be detected due to an internal error */
+	HW_REV_V1_2 = 120,	/**< @brief Hardware Revision v1.2 */
+	HW_REV_V1_3 = 130,	/**< @brief Hardware Revision v1.3 */
+	HW_REV_V1_3_1 = 131,	/**< @brief Hardware revision v1.3.1 */
+};
+
+/**
+ * @brief This function returns the hardware version of the PCB.
+ *
+ * This is used to
+ * determine the feature set of the hardware. So this firmware can be used on all hardwares.
+ *
+ * The first hardware revision supported, is: v1.2
+ *
+ * The function returns the HW revision as an enum hw_revision.
+ * For v1.2 the return value is 120 (HW_REV_V1_2).
+ * For v1.3 the return value is 130 (HW_REV_V1_3).
+ * For v1.3.1 the return value is 131 (HW_REV_V1_3_1).
+ *
+ * Other return values are not defined yet.
+ *
+ * @return Harware revision
+ */
+enum hw_revision get_pcb_hardware_version(void);
+
+#endif /* _HW_VERSION_DETECT_H_ */
+
+/** @} */

stm-firmware/include/reflow-controller/main-cycle-counter.h

@@ -0,0 +1,51 @@
+/* Reflow Oven Controller
+*
+* Copyright (C) 2020  Mario Hüttel <mario.huettel@gmx.net>
+*
+* This file is part of the Reflow Oven Controller Project.
+*
+* The reflow oven controller is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License version 2 as
+* published by the Free Software Foundation.
+*
+* The Reflow Oven Control Firmware 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 the reflow oven controller project.
+* If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @defgroup main-cycle-counter Main Cycle Counter
+ * The main cycle counter is incremented after every loop run of the main loop in main.c
+ * @{
+ */
+
+#ifndef __MAIN_CYCLE_COUNTER_H__
+#define __MAIN_CYCLE_COUNTER_H__
+
+#include <stdint.h>
+
+/**
+ * @brief Initialize/Reset the main cycle counter to 0.
+ * This function can be called multiple times.
+ */
+void main_cycle_counter_init(void);
+
+/**
+ * @brief Increment the main cycle counter by 1
+ */
+void main_cycle_counter_inc(void);
+
+/**
+ * @brief Get the current main cycle counter value
+ * @return Value
+ */
+uint64_t main_cycle_counter_get(void);
+
+#endif /* __MAIN_CYCLE_COUNTER_H__ */
+
+/** @} */

stm-firmware/include/reflow-controller/oven-driver.h

@@ -21,32 +21,93 @@
 #ifndef __OVEN_DRIVER_H__
 #define __OVEN_DRIVER_H__
 
+/**
+ * @defgroup oven-driver Oven SSR Driver and PID Controller
+ * @{
+ */
+
 #include <stdint.h>
 #include <stdbool.h>
 #include <reflow-controller/pid-controller.h>
 
-enum oven_pid_status {OVEN_PID_DEACTIVATED,
-		      OVEN_PID_RUNNING,
-		      OVEN_PID_ABORTED};
+/**
+ * @brief Status of the PID controlling the oven
+ */
+enum oven_pid_status {
+	OVEN_PID_DEACTIVATED, /**< @brief The PID of the oven is deactivated. */
+	OVEN_PID_RUNNING, /**< @brief The PID of the oven is currently active and running. */
+	OVEN_PID_ABORTED, /**< @brief The PID of the oven has been aborted due to an error and is not running. */
+};
 
+/**
+ * @brief Initialize the oven driver.
+ *
+ * This will initialize the Timer for the PWM output to the SSR.
+ * If the hardware revision is >= v1.3 the SSR safety enable line will also be initialized.
+ */
 void oven_driver_init(void);
 
+/**
+ * @brief Set a power level on the oven control output
+ * @param power Power level between 0 to 100
+ * @note This will not actually set the output. For this, @ref oven_driver_apply_power_level() has to be called.
+ * It will be called in the main loop.
+ */
 void oven_driver_set_power(uint8_t power);
 
+/**
+ * @brief Disable the oven driver.
+ *
+ * This shuts down the oven driver timer and the corresponding clocks.
+ */
 void oven_driver_disable(void);
 
-void oven_pid_ack_errors(void);
-
+/**
+ * @brief Initialize the PID controller for the oven output
+ * @param PID controller holding the settings
+ */
 void oven_pid_init(struct pid_controller *controller_to_copy);
 
-void oven_pid_handle(float target_temp);
+/**
+ * @brief Handle the PID controller.
+ * This must be called cyclically. When the sampling period has passed, the function will process the PT1000
+ * resistance and do a PID cycluilation for this sample.
+ * @note This function must be called with a frequency greater or equal to the PID's sampling frequency
+ */
+void oven_pid_handle(void);
 
+/**
+ * @brief Stop the oven PID controller
+ */
 void oven_pid_stop(void);
 
+/**
+ * @brief Abort the oven PID controller. This is the same as oven_pid_stop() but will set the abort flag.
+ * @note this function is called by the safety controller to disable the PID controller in case of an error.
+ */
 void oven_pid_abort(void);
 
+/**
+ * @brief Set the target temperature of the PID controller.
+ * @param temp
+ */
+void oven_pid_set_target_temperature(float temp);
+
+/**
+ * @brief Output the power level currently configured to the SSR.
+ *
+ * This function is separated from oven_driver_set_power() because it is called in the main loop after the
+ * safety controller has run. This ensures, that if the safety controller decides to stop the PID no glitch makes it
+ * out to the SSR.
+ */
 void oven_driver_apply_power_level(void);
 
+/**
+ * @brief Get the current status of the oven's PID controller
+ * @return
+ */
 enum oven_pid_status oven_pid_get_status(void);
 
+/** @} */
+
 #endif /* __OVEN_DRIVER_H__ */

stm-firmware/include/reflow-controller/periph-config/oven-driver-hwcfg.h

@@ -18,16 +18,53 @@
 * If not, see <http://www.gnu.org/licenses/>.
 */
 
+/**
+ * @file oven-driver-hwcfg.h
+ * @brief hardware configuration for oven PWM driver
+ */
+
 #ifndef __OVEN_DRIVER_HWCFG_H__
 #define __OVEN_DRIVER_HWCFG_H__
 
 #include <stm32/stm32f4xx.h>
 
+/**
+ * @brief Timer to use to generate PWM for oven
+ */
 #define OVEN_CONTROLLER_PWM_TIMER TIM3
+
+/**
+ * @brief Port the oven control output is connected to
+ */
 #define OVEN_CONTROLLER_PORT GPIOB
+
+/**
+ * @brief The Pin number the oven control output is located at
+ */
 #define OVEN_CONTROLLER_PIN (0)
+
+/**
+ * @brief The AHB1ENR Bitmask to enable the clock to the output port #OVEN_CONTROLLER_PORT
+ */
 #define OVEN_CONTROLLER_PORT_RCC_MASK RCC_AHB1ENR_GPIOBEN
+
+/**
+ * @brief The APB1ENR bitmask to enable the #OVEN_CONTROLLER_PWM_TIMER
+ */
 #define OVEN_CONTROLLER_TIM_RCC_MASK RCC_APB1ENR_TIM3EN
+
+/**
+ * @brief The alternate function #OVEN_CONTROLLER_PWM_TIMER's pwm output is located on #OVEN_CONTROLLER_PORT
+ */
 #define OVEN_CONTROLLER_PIN_ALTFUNC (2)
 
+/**
+ * @brief GPIO Port for the safety enable line used by PCB versions > v1.3
+ */
+#define SSR_SAFETY_EN_PORT GPIOA
+
+#define SSR_SAFETY_EN_PIN (3)
+
+#define SSR_SAFETY_EN_PORT_RCC_MASK RCC_AHB1ENR_GPIOAEN
+
 #endif /* __OVEN_DRIVER_HWCFG_H__ */

stm-firmware/include/reflow-controller/periph-config/safety-adc-hwcfg.h

@@ -21,18 +21,90 @@
 #ifndef __SAFETY_ADC_HWCFG_H__
 #define __SAFETY_ADC_HWCFG_H__
 
+/**
+ * @file safety-adc-hwcfg.h
+ * @brief Safety ADC configuration settings
+ */
+
 #include <stm32/stm32f4xx.h>
 
+/**
+ * @brief Peripheral to use as safety ADC.
+ * @note This must be ADC1, because it is the only ADC with access to the internal temperature sensor
+ */
 #define SAFETY_ADC_ADC_PERIPHERAL ADC1
+
+/**
+ * @brief Clock enable mask in RCC->APB2ENR to enable the #SAFETY_ADC_ADC_PERIPHERAL
+ */
 #define SAFETY_ADC_ADC_RCC_MASK RCC_APB2ENR_ADC1EN
+
+/**
+ * @brief ADC channel number of the internal temperature sensor
+ */
 #define TEMP_CHANNEL_NUM (16)
+
+/**
+ * @brief ADC channel number of the internal reference voltage
+ */
 #define INT_REF_CHANNEL_NUM (17)
 
+#define SAFETY_ADC_SUPPLY_VOLTAGE_MONITOR_CHANNEL_NUM (15)
+#define SAFETY_ADC_SUPPLY_VOLTAGE_MONITOR_PIN (5)
+#define SAFETY_ADC_SUPPLY_VOLTAGE_MONITOR_PORT GPIOC
+#define SAFETY_ADC_SUPPLY_VOLTAGE_MONITOR_PORT_RCC_MASK RCC_AHB1ENR_GPIOCEN
+
+
+/**
+ * @brief Nominal value of the internal reference voltage.
+ *
+ * This is used to compare to the external reference voltage.
+ */
 #define SAFETY_ADC_INT_REF_MV 1210.0f
 
+/**
+ * @brief Nominal temperature in degrees celsius of the internal temperature sensor at which it reads
+ * #SAFETY_ADC_TEMP_NOM_MV millivolts.
+ *
+ */
 #define SAFETY_ADC_TEMP_NOM 25.0f
+
+/**
+ * @brief Nominal internal temperature sensor voltage at temperature #SAFETY_ADC_TEMP_NOM
+ */
 #define SAFETY_ADC_TEMP_NOM_MV 760.0f
+
+/**
+ * @brief Sensitivity of the internal temperature sensor in millivolts per Kelvin
+ */
 #define SAFETY_ADC_TEMP_MV_SLOPE 2.5f
 
+/**
+ * @brief Number of channels to handle for the SAFETY ADC.
+ * @note The maximum amount of channels is limited to 16
+ */
+#define SAFETY_ADC_NUM_OF_CHANNELS 12
+
+/**
+ * @brief Channel numbers to sample with the SAFETY ADC
+ *
+ * - The first 4 values are the internal temperature sensor
+ * - The next 4 values are the internal reference voltage
+ *
+ * The values are samples 4 times each to allow averaging them to get
+ * more precise readings. Check the maximum value of #SAFETY_ADC_NUM_OF_CHANNELS
+ * when adding more channels.
+ * @warning Safety controller expects the current measurment list. If you change it, check @ref safety_controller_handle_safety_adc
+ */
+#define SAFETY_ADC_CHANNELS TEMP_CHANNEL_NUM, TEMP_CHANNEL_NUM, TEMP_CHANNEL_NUM, TEMP_CHANNEL_NUM, \
+				INT_REF_CHANNEL_NUM, INT_REF_CHANNEL_NUM, INT_REF_CHANNEL_NUM, INT_REF_CHANNEL_NUM, \
+				SAFETY_ADC_SUPPLY_VOLTAGE_MONITOR_CHANNEL_NUM, SAFETY_ADC_SUPPLY_VOLTAGE_MONITOR_CHANNEL_NUM, \
+				SAFETY_ADC_SUPPLY_VOLTAGE_MONITOR_CHANNEL_NUM, SAFETY_ADC_SUPPLY_VOLTAGE_MONITOR_CHANNEL_NUM
+
+
+/* Check the channel count of the safety ADC */
+#if SAFETY_ADC_NUM_OF_CHANNELS > 16 || SAFETY_ADC_NUM_OF_CHANNELS < 0
+#error "Invlaid count of channels for safety ADC"
+#endif
 
 #endif /* __SAFETY_ADC_HWCFG_H__ */

stm-firmware/include/reflow-controller/periph-config/shell-uart-config.h

@@ -25,9 +25,11 @@
 #endif
 
 /* UART_DIV is 45.5625 => 115200 @ 84 MHz */
-#define SHELL_UART_DIV_FRACTION 9U /* Equals 9/16 = 0.5625 */
-#define SHELL_UART_DIV_MANTISSA 45U /* Equals 45 */
+#define SHELL_UART_DEFAULT_DIV_FRACTION 9U /* Equals 9/16 = 0.5625 */
+#define SHELL_UART_DEFAULT_DIV_MANTISSA 45U /* Equals 45 */
 
-#define SHELL_UART_BRR_REG_VALUE ((SHELL_UART_DIV_MANTISSA<<4) | SHELL_UART_DIV_FRACTION);
+#define SHELL_UART_DEFAULT_BRR_REG_VALUE ((SHELL_UART_DEFAULT_DIV_MANTISSA<<4) | SHELL_UART_DEFAULT_DIV_FRACTION);
+
+#define SHELL_UART_PERIPHERAL_CLOCK (84000000UL)
 
 #endif /* __SHELL_UART_CONFIG_H__ */

stm-firmware/include/reflow-controller/periph-config/spi-eeprom-hwcfg.h

@@ -0,0 +1,36 @@
+/* Reflow Oven Controller
+*
+* Copyright (C) 2021  Mario Hüttel <mario.huettel@gmx.net>
+*
+* This file is part of the Reflow Oven Controller Project.
+*
+* The reflow oven controller is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License version 2 as
+* published by the Free Software Foundation.
+*
+* The Reflow Oven Control Firmware 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 the reflow oven controller project.
+* If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef _SPI_EEPROM_HWCFG_H_
+#define _SPI_EEPROM_HWCFG_H_
+
+#include <stm32/stm32f4xx.h>
+
+#define SPI_EEPROM_SPI_PORT GPIOA
+#define SPI_EEPROM_SPI_PORT_RCC_REG RCC->AHB1ENR
+#define SPI_EEPROM_SPI_PORT_RCC_MASK RCC_AHB1ENR_GPIOAEN
+
+#define SPI_EEPROM_SPI_ALTFUNC_NO (5)
+#define SPI_EEPROM_MISO_PIN (6)
+#define SPI_EEPROM_MOSI_PIN (7)
+#define SPI_EEPROM_SCK_PIN (5)
+#define SPI_EEPROM_CS_PIN (4)
+
+#endif /* _SPI_EEPROM_HWCFG_H_ */

stm-firmware/include/reflow-controller/pid-controller.h

@@ -18,33 +18,150 @@
 * If not, see <http://www.gnu.org/licenses/>.
 */
 
+/** @addtogroup pid-controller
+ *  @{
+ */
+
 #ifndef __PID_CONTROLLER_H__
 #define __PID_CONTROLLER_H__
 
+/**
+ * @brief Representation of a PID controller
+ */
 struct pid_controller {
+	/**
+	 * @brief Derivate term @f$k_d@f$
+	 */
 	float k_deriv;
+
+	/**
+	 * @brief Integral term @f$k_i@f$
+	 */
 	float k_int;
+
+	/**
+	 * @brief Proportional term @f$k_p@f$
+	 */
 	float k_p;
+
+	/**
+	 * @brief Internally precalculated auxiliary value. @f$k_{i_t} = \frac{1}{2}k_{i} \cdot T_s@f$
+	 *
+	 * This value is caluclated during the @ref pid_init function to reduce calculations during the continous
+	 * PID sampling.
+	 */
 	float k_int_t;
+
+	/**
+	 * @brief Internally precalculated auxiliary value. @f$k_{d_t} = 2\frac{k_{d}}{T_s + 2 k_{d\tau}}@f$
+	 *
+	 * This value is caluclated during the @ref pid_init function to reduce calculations during the continous
+	 * PID sampling.
+	 */
 	float k_deriv_t;
+
+	/**
+	 * @brief Internally precalculated auxiliary value. @f$\overline{k_{d_t}} = \frac{2 k_{d\tau} - T_s}{ 2k_{d\tau} + T_s}@f$
+	 *
+	 * This value is caluclated during the @ref pid_init function to reduce calculations during the continous
+	 * PID sampling.
+	 */
+	float k_inv_deriv_t;
+
+	/**
+	 * @brief Saturation of output value
+	 * @note This value is set to 100 (corresponding to 100%) for the temperature controller
+	 */
 	float output_sat_max;
+
+	/**
+	 * @brief Minumum saturation of PID output value.
+	 * @note This value is set to 0 for the temperature controller as the oven driver is not able to cool
+	 */
 	float output_sat_min;
+
+	/**
+	 * @brief Maximum value @f$i_{max}@f$ the inegrator in the PID controller can reach.
+	 *
+	 * The output of the integral term of the PID controller is limited to @f$\pm i_{max}@f$
+	 *
+	 */
 	float integral_max;
+
+	/**
+	 * @brief Sampling period @f$T_s@f$ of the PID controller in seconds
+	 */
 	float sample_period;
+
+	/**
+	 * @brief Output value of the PID controller
+	 */
 	volatile float control_output;
+
+	/**
+	 * @brief Internal state variable holding the last input value.
+	 */
 	volatile float last_in;
+
+	/**
+	 * @brief integral term's value
+	 */
 	volatile float integral;
+
+	/**
+	 * @brief derivate term's value
+	 */
 	volatile float derivate;
 };
 
-void pid_init(struct pid_controller *pid, float k_deriv, float k_int, float k_p, float output_sat_min, float output_sat_max, float integral_max, float sample_period);
+/**
+ * @brief Initialize a @ref pid_controller struct
+ * @param pid Struct to initilaize
+ * @param k_deriv Derivate term
+ * @param k_int integral term
+ * @param k_p Proportional term
+ * @param output_sat_min Minimum output saturation
+ * @param output_sat_max Maximum output saturation
+ * @param integral_max Maximum integral term
+ * @param kd_tau Time constant of derivate term low pass filter
+ * @param sample_period Sample time in seconds
+ */
+void pid_init(struct pid_controller *pid, float k_deriv, float k_int, float k_p,
+	      float output_sat_min, float output_sat_max, float integral_max, float kd_tau, float sample_period);
 
+/**
+ * @brief Reset a PID controller.
+ *
+ * This sets all internal states to 0.
+ *
+ * @param pid Controller
+ */
 void pid_zero(struct pid_controller *pid);
 
+/**
+ * @brief Execute a tiome step of the PID controller. This function must be periodically called in an pid_controller::sample_period interval
+ * @note This function does not check its calling interval. It must be ensured by the caller.
+ * @param pid Pid controller to execute
+ * @param deviation Input deviation
+ * @return Current controller output after the calculated time step
+ */
 float pid_sample(struct pid_controller *pid, float deviation);
 
+/**
+ * @brief Retrieve the controller's current output
+ * @param pid Pid controller
+ * @return Output
+ */
 float pid_get_control_output(const struct pid_controller *pid);
 
+/**
+ * @brief Duplicate a PID controller
+ * @param dest destination controller
+ * @param src Source controller
+ * @return 0 if successful
+ */
 int pid_copy(struct pid_controller *dest, const struct pid_controller *src);
 
 #endif /* __PID_CONTROLLER_H__ */
+
+/** @} */

stm-firmware/include/reflow-controller/safety/flash-crc-struct.h

@@ -0,0 +1,37 @@
+/* Reflow Oven Controller
+*
+* Copyright (C) 2022  Mario Hüttel <mario.huettel@gmx.net>
+*
+* This file is part of the Reflow Oven Controller Project.
+*
+* The reflow oven controller is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License version 2 as
+* published by the Free Software Foundation.
+*
+* The Reflow Oven Control Firmware 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 the reflow oven controller project.
+* If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef _SAFETY_FLASH_CRC_STRUCT_H_
+#define _SAFETY_FLASH_CRC_STRUCT_H_
+
+#include <stdint.h>
+
+struct flash_crcs {
+    uint32_t start_magic;
+    uint32_t crc_section_text;
+    uint32_t crc_section_data;
+    uint32_t crc_section_ccm_data;
+    uint32_t crc_section_vectors;
+    uint32_t end_magic;
+};
+
+extern const struct flash_crcs crcs_in_flash;
+
+#endif /* _SAFETY_FLASH_CRC_STRUCT_H_ */

stm-firmware/include/reflow-controller/safety/flash-crc.h

@@ -0,0 +1,56 @@
+/* Reflow Oven Controller
+*
+* Copyright (C) 2022  Mario Hüttel <mario.huettel@gmx.net>
+*
+* This file is part of the Reflow Oven Controller Project.
+*
+* The reflow oven controller is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License version 2 as
+* published by the Free Software Foundation.
+*
+* The Reflow Oven Control Firmware 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 the reflow oven controller project.
+* If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef _SAFETY_FLASH_CRC_H_
+#define _SAFETY_FLASH_CRC_H_
+
+#include <stdint.h>
+
+enum flash_crc_section {
+    FLASH_CRC_VECTOR = 0,
+    FLASH_CRC_TEXT,
+    FLASH_CRC_DATA,
+    FLASH_CRC_CCMDATA,
+    N_FLASH_CRC,
+};
+
+/**
+ * @brief Perform a CRC check of the flash memory and set appropriate flags
+ * @return negative if internal error occured. Otherwise (independent from CRC check result) 0.
+ * @note This function requires the safety controller (and CRC unit) to be set up before calling!
+ */
+int flash_crc_trigger_check(void);
+
+/**
+ * @brief Calculate CRC over flash section
+ * @param sec Section to calculate CRC over
+ * @param[out] crc_result Calculated CRC
+ * @return negative if internal error occured. Otherwise (independent from CRC check result) 0.
+ */
+int flash_crc_calc_section(enum flash_crc_section sec, uint32_t *crc_result);
+
+/**
+ * @brief Get expected CRC value of a section
+ * @param sec Section
+ * @return Expected CRC
+ */
+uint32_t flash_crc_get_expected_crc(enum flash_crc_section sec);
+
+#endif /* _SAFETY_FLASH_CRC_H_ */

stm-firmware/include/reflow-controller/safety/safety-adc.h

@@ -29,23 +29,55 @@
 #include <stdint.h>
 #include <stdbool.h>
 
-enum safety_adc_meas_channel {SAFETY_ADC_MEAS_VREF, SAFETY_ADC_MEAS_TEMP};
+/**
+ * @brief The safety ADC's measure channel
+ */
+enum safety_adc_meas_channel {
+	SAFETY_ADC_MEAS_VREF, /**< @brief Internal reference voltage @note This will not output the internal reference voltage but the recalculated external voltage! */
+	SAFETY_ADC_MEAS_TEMP, /**< @brief Internal temperature sensor */
+	SAFETY_ADC_MEAS_SUPPLY, /**< @brief Supply voltage */
+};
 
-void safety_adc_init();
+/**
+ * @brief Initialize safety ADC. Only call this function once!
+ */
+void safety_adc_init(void);
 
-void safety_adc_deinit();
+/**
+ * @brief safety_adc_deinit Deactivate safety ADC
+ * @warning For completeness. Do not call! the safety ADC is a vital component. It's malfunction will trigger a critical safety flag.
+ */
+void safety_adc_deinit(void);
 
-void safety_adc_trigger_meas(enum safety_adc_meas_channel measurement);
+/**
+ * @brief safety_adc_trigger_meas
+ */
+void safety_adc_trigger_meas(void);
 
 /**
  * @brief Poll ADC result.
- * @param results adc results
  * @return 1 if measurement successful, 0 if not ready, -1 if ADC aborted or not started
  */
-int safety_adc_poll_result(uint16_t *adc_result);
+int safety_adc_poll_result(void);
 
-enum safety_adc_check_result handle_safety_adc();
+/**
+ * @brief Get the sampled signal values of the safety ADC.
+ *
+ * Use #safety_adc_poll_result to poll for a finished conversion of the safety ADC.
+ * After that, it is safe to use the output values until a new conversion is triggered using #safety_adc_trigger_meas
+ *
+ * @warning This function return a constant buffer, that is directly written on by the DMA! Check #safety_adc_poll_result to prevent race conditions.
+ * @return Array of raw ADC readings with length of #SAFETY_ADC_NUM_OF_CHANNELS
+ */
+const uint16_t *safety_adc_get_values(void);
 
+/**
+ * @brief Convert a safety ADC raw value to an actual signal value
+ * @param channel Measurment channel to convert voltage for
+ * @param analog_value Raw value of the ADC to convert
+ * @warning Double check @ref safety_adc_meas_channel to make sure you understand the output of this function correctly.
+ * @return
+ */
 float safety_adc_convert_channel(enum safety_adc_meas_channel channel, uint16_t analog_value);
 
 #endif /* __SAFETY_ADC_H__ */

stm-firmware/include/reflow-controller/safety/safety-config.h

@@ -18,10 +18,32 @@
 * If not, see <http://www.gnu.org/licenses/>.
 */
 
+/**
+ * @file safety-config.h
+ * @brief Safety Controller Configuration.
+ * @warning MAKE SURE XOU UNDERSTAND WHAT YOU ARE DOING IN HERE
+ */
+
 #ifndef __SAFETY_CONFIG_H__
 #define __SAFETY_CONFIG_H__
 
+/**
+ * @brief Weights of error flags.
+ */
+enum config_weight {
+    SAFETY_FLAG_CONFIG_WEIGHT_NONE = 0, /**< @brief This flag has no global error consequence, but might be respected by certain software modules. */
+    SAFETY_FLAG_CONFIG_WEIGHT_PID = 1, /**< @brief This flag will force a stop of the temperature PID controller */
+    SAFETY_FLAG_CONFIG_WEIGHT_PANIC = 2, /**< @brief This flag will trigger the panic mode */
+};
 
+/**
+ * @brief Enum type representing safety flags.
+ *
+ * The enum type is binary or'able to allow combining
+ * multiple safety flags.
+ *
+ * @note For a more detailed explaination of the flags, check out the Sphinx documentation.
+ */
 enum safety_flag {
 	ERR_FLAG_NO_FLAG = 0,
 	ERR_FLAG_MEAS_ADC_OFF = (1<<0),
@@ -41,8 +63,20 @@ enum safety_flag {
 	ERR_FLAG_TIMING_MAIN_LOOP = (1<<14),
 	ERR_FLAG_SAFETY_MEM_CORRUPT = (1<<15),
 	ERR_FLAG_SAFETY_TAB_CORRUPT = (1<<16),
+	ERR_FLAG_AMON_SUPPLY_VOLT = (1<<17),
+	ERR_FLAG_OVERTEMP = (1<<18),
+	ERR_FLAG_FLASH_CRC_CODE = (1<<19),
+	ERR_FLAG_FLASH_CRC_DATA = (1<<20),
+	ERR_FLAG_CFG_CRC_MEAS_ADC = (1<<21),
+	ERR_FLAG_CFG_CRC_SAFETY_ADC = (1<<22),
 };
 
+/**
+ * @brief Enum Type representing timing monitors.
+ *
+ * The enum type is binary or'able to allow combining
+ * multiple safety flags.
+ */
 enum timing_monitor {
 	ERR_TIMING_PID = (1<<0),
 	ERR_TIMING_MEAS_ADC = (1<<1),
@@ -50,16 +84,29 @@ enum timing_monitor {
 	ERR_TIMING_MAIN_LOOP = (1<<3),
 };
 
+enum crc_monitor {
+	ERR_CRC_MON_MEAS_ADC = 0,
+	ERR_CRC_MON_SAFETY_ADC,
+	N_ERR_CRC_MON
+};
+
+/**
+ * @brief Enum Type representing analog value monitors.
+ *
+ * The enum type is binary or'able to allow combining
+ * multiple safety flags.
+ */
 enum analog_value_monitor {
 	ERR_AMON_VREF = (1<<0),
 	ERR_AMON_UC_TEMP = (1<<1),
+	ERR_AMON_SUPPLY_VOLT = (1<<2),
 };
 
-#define ERR_FLAG_ENTRY(errflag) {.name=#errflag, .flag = (errflag), .error_state = false, .error_state_inv = true, .key = 0UL, .weight = NULL, .persistency = NULL}
+#define ERR_FLAG_ENTRY(errflag) {.name=#errflag, .flag = (errflag), .error_state = false, .error_state_inv = true, .key = 0UL, .weight = NULL, .persistence = NULL}
 #define TIM_MON_ENTRY(mon, min, max, flag) {.name=#mon, .monitor = (mon), .associated_flag=(flag), .min_delta = (min), .max_delta = (max), .last = 0ULL, .enabled= false}
 #define ANA_MON_ENTRY(mon, min_value, max_value, flag) {.name=#mon, .monitor = (mon), .associated_flag=(flag), .min = (min_value), .max = (max_value), .value = 0.0f, .valid = false}
 #define ERR_FLAG_WEIGHT_ENTRY(_flag, _weight) {.flag = (_flag), .flag_ptr = NULL, .weight = (_weight), .start_dummy = 0x11823344, .end_dummy = 0xAABBCCFD}
-#define ERR_FLAG_PERSIST_ENTRY(_flag, _persist) {.flag = (_flag), .flag_ptr = NULL, .persistency = (_persist), .start_dummy = 0xFF1100BB, .end_dummy = 0xEBB439A2}
+#define ERR_FLAG_PERSIST_ENTRY(_flag, _persist) {.flag = (_flag), .flag_ptr = NULL, .persistence = (_persist), .start_dummy = 0xFF1100BB, .end_dummy = 0xEBB439A2}
 
 /**
  * @brief Magic key used to reset the watchdog using the @ref watchdog_ack function
@@ -84,25 +131,45 @@ enum analog_value_monitor {
  */
 #define SAFETY_MIN_STACK_FREE 0x100
 
-#define PID_CONTROLLER_ERR_CAREMASK (ERR_FLAG_STACK | ERR_FLAG_AMON_UC_TEMP | ERR_FLAG_AMON_VREF | \
-					ERR_FLAG_TIMING_PID | ERR_FLAG_TIMING_MEAS_ADC | ERR_FLAG_MEAS_ADC_OFF | \
-					ERR_FLAG_MEAS_ADC_OVERFLOW)
-
-#define HALTING_CAREMASK (ERR_FLAG_STACK | ERR_FLAG_AMON_UC_TEMP)
-
 #define SAFETY_ADC_VREF_MVOLT (2500.0f)
 #define SAFETY_ADC_VREF_TOL_MVOLT (100.0f)
 #define SAFETY_ADC_TEMP_LOW_LIM (0.0f)
 #define SAFETY_ADC_TEMP_HIGH_LIM (65.0f)
+#define SAFETY_ADC_SUPPLY_MVOLT (3300.0f)
+#define SAFETY_ADC_SUPPLY_TOL_MVOLT (150.0f)
 
+#define SAFETY_EXT_WATCHDOG_PORT GPIOD
+#define SAFETY_EXT_WATCHDOG_RCC_MASK RCC_AHB1ENR_GPIODEN
+#define SAFETY_EXT_WATCHDOG_PIN (12)
 
 /**
- * @brief Key used to lock the safety flags from external ack'ing
+ * @brief Default Limit of the overtemperature detection in degrees celsius
+ */
+#define SAFETY_DEFAULT_OVERTEMP_LIMIT_DEGC (260.0f)
+
+/**
+ * @brief Key used to lock the safety flags coming from the measurment ADC from external ack'ing
  */
 #define MEAS_ADC_SAFETY_FLAG_KEY 0xe554dac3UL
 
-#define SAFETY_CONTROLLER_ADC_DELAY_MS 120
+/**
+ * @brief Safety ADC trigger interval
+ */
+#define SAFETY_CONTROLLER_ADC_DELAY_MS 250
 
+/**
+ * @brief Password for resetting ERR_CRC_MON_MEAS_ADC
+ */
+#define SAFETY_CRC_MON_MEAS_ADC_PW 0xD96254A2
+
+/**
+ * @brief Password for resetting ERR_CRC_MON_SAFETY_ADC
+ */
+#define SAFETY_CRC_MON_SAFETY_ADC_PW 0xA8DF2368
+
+/**
+ * @brief Default persistence of safety flags. These values are loaded into the safety tables on startup.
+ */
 #define SAFETY_CONFIG_DEFAULT_PERSIST	ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_MEAS_ADC_OFF, false), \
 					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_MEAS_ADC_WATCHDOG, false), \
 					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_MEAS_ADC_UNSTABLE, false), \
@@ -119,8 +186,16 @@ enum analog_value_monitor {
 					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_DEBUG, true), \
 					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_TIMING_MAIN_LOOP, true), \
 					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_SAFETY_MEM_CORRUPT, true), \
-					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_SAFETY_TAB_CORRUPT, true),
-
+					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_SAFETY_TAB_CORRUPT, true), \
+					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_AMON_SUPPLY_VOLT, false), \
+					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_OVERTEMP, false), \
+					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_FLASH_CRC_CODE, true), \
+					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_FLASH_CRC_DATA, true), \
+					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_CFG_CRC_MEAS_ADC, true), \
+					ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_CFG_CRC_SAFETY_ADC, true)
+/**
+ * @brief Default config weights of safety flags. These values are loaded into the safety tables on startup.
+ */
 #define SAFETY_CONFIG_DEFAULT_WEIGHTS 	ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_MEAS_ADC_OFF, SAFETY_FLAG_CONFIG_WEIGHT_PID), \
 			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_MEAS_ADC_WATCHDOG, SAFETY_FLAG_CONFIG_WEIGHT_PID), \
 			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_MEAS_ADC_UNSTABLE, SAFETY_FLAG_CONFIG_WEIGHT_NONE), \
@@ -132,13 +207,17 @@ enum analog_value_monitor {
 			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_STACK, SAFETY_FLAG_CONFIG_WEIGHT_PANIC), \
 			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_SAFETY_ADC, SAFETY_FLAG_CONFIG_WEIGHT_PANIC), \
 			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_SYSTICK, SAFETY_FLAG_CONFIG_WEIGHT_PANIC), \
-			/* Watchdog timeout is not handled perioodically, but only on startup.
-			 * Therefore, it is not listed here */\
-			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_WTCHDG_FIRED, SAFETY_FLAG_CONFIG_WEIGHT_NONE), \
+			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_WTCHDG_FIRED, SAFETY_FLAG_CONFIG_WEIGHT_PID), \
 			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_UNCAL, SAFETY_FLAG_CONFIG_WEIGHT_NONE), \
 			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_DEBUG, SAFETY_FLAG_CONFIG_WEIGHT_NONE), \
 			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_TIMING_MAIN_LOOP, SAFETY_FLAG_CONFIG_WEIGHT_PANIC), \
 			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_SAFETY_MEM_CORRUPT, SAFETY_FLAG_CONFIG_WEIGHT_PID), \
-			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_SAFETY_TAB_CORRUPT, SAFETY_FLAG_CONFIG_WEIGHT_PANIC),
+			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_SAFETY_TAB_CORRUPT, SAFETY_FLAG_CONFIG_WEIGHT_PANIC), \
+			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_AMON_SUPPLY_VOLT, SAFETY_FLAG_CONFIG_WEIGHT_PID), \
+			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_OVERTEMP, SAFETY_FLAG_CONFIG_WEIGHT_PID), \
+			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_FLASH_CRC_CODE, SAFETY_FLAG_CONFIG_WEIGHT_PANIC), \
+			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_FLASH_CRC_DATA, SAFETY_FLAG_CONFIG_WEIGHT_PANIC), \
+			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_CFG_CRC_MEAS_ADC, SAFETY_FLAG_CONFIG_WEIGHT_PID), \
+			ERR_FLAG_WEIGHT_ENTRY(ERR_FLAG_CFG_CRC_SAFETY_ADC, SAFETY_FLAG_CONFIG_WEIGHT_PANIC)
 
 #endif /* __SAFETY_CONFIG_H__ */

stm-firmware/include/reflow-controller/safety/safety-controller.h

@@ -48,6 +48,7 @@ struct analog_monitor_info {
 	float min;	/**< @brief Minumum value allowed */
 	float max;	/**< @brief Maximum value allowed */
 	enum analog_monitor_status status; /**< @brief Current monitor status */
+	enum safety_flag associated_flag; /**< @brief Associated safety flag, that will be set, if monitor out of range */
 	uint64_t timestamp; /**< @brief ms timestamp when @ref analog_monitor_info::value was taken. */
 };
 
@@ -69,14 +70,14 @@ struct timing_monitor_info {
  * You have to call safety_controller_handle
  * If this function fails, it will hang, because errors in the safety controller are not recoverable
  */
-void safety_controller_init();
+void safety_controller_init(void);
 
 /**
  * @brief Handle the safety controller.
  * @note This function must be executed periodically in order to prevent the watchdog from resetting the firmware
- * @return 0 if successful
+ * @returns Worst flag weigth that is currently set.
  */
-int safety_controller_handle();
+enum config_weight safety_controller_handle(void);
 
 /**
  * @brief Report one or multiple errors to the safety controller
@@ -169,13 +170,13 @@ bool safety_controller_get_flags_by_mask(enum safety_flag mask);
  * @brief Get the count of error flags
  * @return Error flag count
  */
-uint32_t safety_controller_get_flag_count();
+uint32_t safety_controller_get_flag_count(void);
 
 /**
  * @brief Get the count of analog monitors
  * @return Analog monitor count
  */
-uint32_t safety_controller_get_analog_monitor_count();
+uint32_t safety_controller_get_analog_monitor_count(void);
 
 /**
  * @brief Get an error flag's name by its index.
@@ -249,7 +250,30 @@ int safety_controller_get_timing_mon_name_by_index(uint32_t index, char *buffer,
  * @brief Get the count of timing monitors
  * @return Timing monitor count
  */
-uint32_t safety_controller_get_timing_monitor_count();
+uint32_t safety_controller_get_timing_monitor_count(void);
+
+/**
+ * @brief Set the overtemperature limit and store it permanently in the EEPROM
+ *
+ * If no EEPROM is present, this will fail. The default value @ref SAFETY_DEFAULT_OVERTEMP_LIMIT_DEGC will be used.
+ * @param over_temperature Over temperature to set
+ * @return 0 if successfully saved and applied, negative if error
+ */
+int safety_controller_set_overtemp_limit(float over_temperature);
+
+/**
+ * @brief Read the current overtemperature limit.
+ * @return Over temperature limit
+ */
+float safety_controller_get_overtemp_limit(void);
+
+/**
+ * @brief Recalculate the CRC of a given CRC Monitor. This has to be done once the supervised registers update
+ * @param mon Monitor to recalculate
+ * @param password Password
+ * @return 0 if successful
+ */
+int safety_controller_set_crc_monitor(enum crc_monitor mon, uint32_t password);
 
 #endif /* __SAFETY_CONTROLLER_H__ */
 

stm-firmware/include/reflow-controller/safety/safety-memory.h

@@ -23,6 +23,8 @@
 
 #include <stdint.h>
 #include <stddef.h>
+#include <stdbool.h>
+#include <reflow-controller/safety/safety-config.h>
 
 /** @addtogroup safety-memory
  * @{
@@ -34,9 +36,14 @@
 #define SAFETY_MEMORY_MAGIC 0x12AA5CB7
 
 /**
- * @brief Error memory NOP entry
+ * @brief Error memory NOP entry word written to the memory
  */
-#define SAFETY_MEMORY_NOP_ENTRY 0xC1AA1222
+#define SAFETY_MEMORY_NOP_ENTRY_WORD 0xC1AA1222UL
+
+/**
+ * @brief Low Byte (byte 0) of error memory entry
+ */
+#define SAFETY_MEMORY_ERROR_ENTRY_MARKER 0x51U
 
 /**
  * @brief Offset address for the safety_memory_header.
@@ -46,6 +53,8 @@
 
 #define SAFETY_MEMORY_CONFIG_OVERRIDE_COUNT 32UL
 
+#define SAFETY_MEMORY_UPDATE_FILENAME_MAXSIZE 256U
+
 /**
  * @brief Safety memory header
  */
@@ -54,6 +63,7 @@ struct safety_memory_header {
 	uint32_t boot_status_offset;	/**< @brief Offset of the safety_memory_boot_status struct (in 32 bit words)*/
 	uint32_t config_overrides_offset; /**< @brief Offset address of override entries */
 	uint32_t config_overrides_len;	/**< @brief Length of override entries in words */
+	uint32_t firmware_update_filename; /**< @brief Filename of the firmware update. This string is at maximum 256 bytes long including the 0 terminator */
 	uint32_t err_memory_offset;	/**< @brief Offset of the error memory */
 	uint32_t err_memory_end;	/**< @brief End of the error memory. This points to the word after the error memory, containing the CRC of the whole backup RAM. */
 	uint32_t crc;		/**< @brief  CRC of the header */
@@ -119,16 +129,7 @@ struct error_memory_entry {
  */
 enum config_override_entry_type {
 	SAFETY_MEMORY_CONFIG_OVERRIDE_WEIGHT = 1,
-	SAFETY_MEMORY_CONFIG_OVERRIDE_PERSISTANCE = 2,
-};
-
-/**
- * @brief Weights of error flags.
- */
-enum config_weight {
-	SAFETY_FLAG_CONFIG_WEIGHT_NONE = 0, /**< @brief This flag has no global error consequence, but might be respected by certain software modules. */
-	SAFETY_FLAG_CONFIG_WEIGHT_PID = 1, /**< @brief This flag will force a stop of the temperature PID controller */
-	SAFETY_FLAG_CONFIG_WEIGHT_PANIC = 2, /**< @brief This flag will trigger the panic mode */
+	SAFETY_MEMORY_CONFIG_OVERRIDE_PERSISTENCE = 2,
 };
 
 /**
@@ -143,8 +144,8 @@ struct config_override {
 		} weight_override;
 		struct {
 			uint8_t flag;
-			uint8_t persistance;
-		} persistance_override;
+			bool persistence;
+		} persistence_override;
 	} entry;
 };
 
@@ -239,13 +240,35 @@ int safety_memory_insert_config_override(struct config_override *config_override
 int safety_memory_get_config_override_count(uint32_t *count);
 
 /**
- * @brief Get a config ovveide entry
+ * @brief Get a config  entry
  * @param idx Index of the requested entry
  * @param[out] config_override READ override
  * @return 0 if successful
  */
 int safety_memory_get_config_override(uint32_t idx, struct config_override *config_override);
 
+/**
+ * @brief Read the set update filename from the safety backup memory
+ *
+ * \p filename has to be large enough to hold the filename (255 chars) plus the '\0'-terminator.
+ *
+ * @param[out] filename Array to fill in file name. May be NULL to only read the length.
+ * @param[out] outlen String length of the filename. May be NULL to only read the file name.
+ * @note \p filename may be NULL. In this case this function can be used to read the currently set filename's length.
+ * @warning Function will fail if both parameters are NULL
+ * @return 0 if successful
+ */
+int safety_memory_get_update_filename(char *filename, size_t *outlen);
+
+/**
+ * @brief Set the filename of the update file
+ * @param[in] filename Filename to set. Must be 255 chars at max (256 including null terminator)
+ * @return 0 if successful
+ */
+int safety_memory_set_update_filename(const char *filename);
+
+#ifndef SAFETY_MEMORY_STRIPOUT_DUMP
+
 /**
  * @brief Get a base64 dump of the whole safety memory.
  * @param[out] buffer Buffer to write the base 64 dump into.
@@ -255,6 +278,8 @@ int safety_memory_get_config_override(uint32_t idx, struct config_override *conf
  */
 int safety_memory_dump_base64(char *buffer, size_t buffsize, size_t *used_size);
 
+#endif /* SAFETY_MEMORY_STRIPOUT_DUMP */
+
 #endif /* __SAFETY_MEMORY_H__ */
 
 /** @} */

stm-firmware/include/reflow-controller/safety/stack-check.h

@@ -87,7 +87,7 @@ int stack_check_init_corruption_detect_area(void);
  * @ref stack_check_init_corruption_detect_area beforehand.
  *
  * The CRC unit must be enabled for this function to work properly.
- * After calling @stack_check_init_corruption_detect_area, this is the case.
+ * After calling @ref stack_check_init_corruption_detect_area, this is the case.
  *
  * @return 0 if no error is detected, all other values are an error.
  * @note Make sure CRC unit is enabled.

stm-firmware/include/reflow-controller/safety/watchdog.h

@@ -40,11 +40,4 @@ int watchdog_setup(uint8_t prescaler);
  */
 int watchdog_ack(uint32_t magic);
 
-/**
- * @brief Check if reset was generated by the watchdog.
- * @note This also clears the relevant flag, so the function will return false when called a second time
- * @return true, if reset was generated by the watchdog
- */
-bool watchdog_check_reset_source(void);
-
 #endif /* __WATCHDOG_H__ */

stm-firmware/include/reflow-controller/sd.h

@@ -0,0 +1,42 @@
+/* Reflow Oven Controller
+ *
+ * Copyright (C) 2022  Mario Hüttel <mario.huettel@gmx.net>
+ *
+ * This file is part of the Reflow Oven Controller Project.
+ *
+ * The reflow oven controller is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ * GDSII-Converter 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 the reflow oven controller project.
+ * If not, see <http://www.gnu.org/licenses/>.
+ */
+
+ #ifndef _SD_H_
+ #define _SD_H_
+
+#include <stdbool.h>
+#include <fatfs/ff.h>
+
+/**
+ * @brief Mount the SD card if available and not already mounted
+ * @param fs Filesystem to mount to.
+ * @return true if mounted, false if an error occured or the SD is not inserted and cannot be mounted
+ */
+bool mount_sd_card_if_avail(FATFS *fs);
+
+/**
+ * @brief Return whether an SD card is inserted and mounted
+ * 
+ * @return true SD inserted and mounted
+ * @return false No SD inserted or not mounted
+ */
+bool sd_card_is_mounted(void);
+
+#endif /* _SD_H_ */

stm-firmware/include/reflow-controller/settings/settings-eeprom.h

@@ -0,0 +1,36 @@
+/* Reflow Oven Controller
+*
+* Copyright (C) 2020  Mario Hüttel <mario.huettel@gmx.net>
+*
+* This file is part of the Reflow Oven Controller Project.
+*
+* The reflow oven controller is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License version 2 as
+* published by the Free Software Foundation.
+*
+* The Reflow Oven Control Firmware 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 the reflow oven controller project.
+* If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef __SETTINGS_SETTINGS_EEPROM_H__
+#define __SETTINGS_SETTINGS_EEPROM_H__
+
+#include <stdbool.h>
+
+bool settings_eeprom_detect_and_prepare(void);
+
+int settings_eeprom_save_calibration(float sens, float offset, bool active);
+
+int settings_eeprom_load_calibration(float *sens, float *offset, bool *active);
+
+int settings_eeprom_save_overtemp_limit(float overtemp_limit, bool active);
+
+int settings_eeprom_load_overtemp_limit(float *overtemp_limit);
+
+#endif /* __SETTINGS_SETTINGS_EEPROM_H__ */

stm-firmware/include/reflow-controller/settings/settings-sd-card.h

@@ -24,6 +24,13 @@
 #include <stdbool.h>
 #include <reflow-controller/settings/settings.h>
 
+/**
+ * @brief Save the calibration to the SD card
+ * @param sens_deviation Sensitivity deviation from nomila sensitivity (1)
+ * @param offset Offset
+ * @param active Calibration is active. If false, the calibration will be deleted from SD card
+ * @return 0 if successful
+ */
 int sd_card_settings_save_calibration(float sens_deviation, float offset, bool active);
 
 /**
@@ -34,6 +41,13 @@ int sd_card_settings_save_calibration(float sens_deviation, float offset, bool a
  */
 int sd_card_settings_try_load_calibration(float *sens_deviation, float *offset);
 
+/**
+ * @brief Load the PID parameters from @ref SETTINGS_PID_PARAMETER_FILE
+ * @param settings The PID settings
+ * @return Load result.
+ * @note This function is currently not used for the temperature profiles. They implement the PID parameters directy
+ * inside the profile
+ */
 enum settings_load_result sd_card_settings_load_pid_oven_parameters(struct oven_pid_settings *settings);
 
 #endif /* __SETTINGS_SETTINGS_SD_CARD_H__ */

stm-firmware/include/reflow-controller/settings/settings.h

@@ -18,25 +18,31 @@
 * If not, see <http://www.gnu.org/licenses/>.
 */
 
-
 #ifndef __SETTINGS_SETTINGS_H__
 #define __SETTINGS_SETTINGS_H__
 
 #include <stdbool.h>
 
+/**
+ * @brief Settings for the PID controller that are stored in the config file
+ */
 struct oven_pid_settings {
-	float kd;
-	float kp;
-	float ki;
-	float t_sample;
-	float max_integral;
+	float kd; /**< @brief Derivate term */
+	float kp; /**< @brief Proportional term */
+	float ki; /**< @brief Integral term */
+	float kd_tau; /**< @brief Time constant of the derivate term's low pass filter */
+	float t_sample; /**< @brief Sampling time in seconds. @warning The loading function expects the file to hold a ms value */
+	float max_integral; /**< @brief Maximum value of the intgral term */
 };
 
+/**
+ * @brief Results of a setting loading
+ */
 enum settings_load_result {
-	SETT_LOAD_SUCCESS = 0,
-	SETT_LOAD_FILE_NOT_FOUND,
-	SETT_LOAD_ERR,
-	SETT_LOAD_DISK_ERR
+	SETT_LOAD_SUCCESS = 0, /**< @brief Setting loaded successfully */
+	SETT_LOAD_FILE_NOT_FOUND, /**< @brief File not found. This is only used by Settings on the SD card */
+	SETT_LOAD_ERR, /**< @brief Generic loading error */
+	SETT_LOAD_DISK_ERR, /**< @brief Disk access failure during loading */
 };
 
 #define SETTINGS_PID_PARAMETER_FILE "pid.conf"
@@ -49,8 +55,49 @@ enum settings_load_result {
  */
 int settings_save_calibration(float sens_deviation, float offset, bool active);
 
+/**
+ * @brief Load the calibration
+ *
+ * If an EEPROM is present, it is first tried to be retrieved from EEPROM.
+ * If there is no EEPROM or there is no valid data inside, it is tried to be loaded from SD card.
+ *
+ * @param sens_dev Sensiotivity deviation
+ * @param offset Offset
+ * @return 0 if successful and calibration valid
+ */
 int settings_load_calibration(float *sens_dev, float *offset);
 
+/**
+ * @brief Load PID overn parameters from file on SD card. This function is not implemented for EEPROM.
+ * @param settings settings
+ * @return Load result
+ */
 enum settings_load_result settings_load_pid_oven_parameters(struct oven_pid_settings *settings);
 
+/**
+ * @brief read the configured overtemperature limit
+ * @param[out] over_temp_limit Overtemperature limit in degrees Celsius
+ * @return Load result
+ */
+enum settings_load_result settings_load_overtemp_limit(float *over_temp_limit);
+
+/**
+ * @brief Save the overtemperature limit
+ * @param over_temp_limit Limit in degrees Celsius
+ * @param active Overtemperature limit active. If false: The config is delted and the controller uses its default limit
+ * @return 0 if successful
+ */
+int settings_save_overtemp_limit(float over_temp_limit, bool active);
+
+/**
+ * @brief Setup the settings module
+ *
+ * This function has to be called before performing any settings operations.
+ * It checks if an EEPTROM is connected and sets the appropriate settings storage in this case.
+ *
+ * EEPROM storage will only be available for HW versions > 1.3. Some functions require an EEPROM because the counterpart
+ * on the SD card is not defined. These functions will fail without an EEPROM.
+ */
+void settings_setup(void);
+
 #endif /* __SETTINGS_SETTINGS_H__ */

stm-firmware/include/reflow-controller/settings/spi-eeprom.h

@@ -0,0 +1,82 @@
+/* Reflow Oven Controller
+*
+* Copyright (C) 2021 Mario Hüttel <mario.huettel@gmx.net>
+*
+* This file is part of the Reflow Oven Controller Project.
+*
+* The reflow oven controller is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License version 2 as
+* published by the Free Software Foundation.
+*
+* The Reflow Oven Control Firmware 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 the reflow oven controller project.
+* If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef __SETTINGS_SPI_EEPROM_H__
+#define __SETTINGS_SPI_EEPROM_H__
+
+#include <stdint.h>
+#include <stdbool.h>
+
+/**
+ * @brief Initialize the SPI for the eeprom.
+ * @return 0 if succesful
+ */
+int spi_eeprom_init(void);
+
+/**
+ * @brief Uninitialize the SPI EEPROM
+ */
+void spi_eeprom_deinit(void);
+
+/**
+ * @brief Read from SPI EEPROM
+ * @param addr address to read from
+ * @param rx_buff buffer to write data to
+ * @param count Amount of bytes to read
+ * @return  0 if successful
+ */
+int spi_eeprom_read(uint32_t addr, uint8_t *rx_buff, uint32_t count);
+
+/**
+ * @brief Check if the EEPROM is currently performing a write and therefore cannot serve other requests
+ * @return true: Write in Progress, false: No write active
+ */
+bool spi_eeprom_write_in_progress(void);
+
+/**
+ * @brief Write data to the EEPROM
+ * @param addr Address to write to
+ * @param data Data to write
+ * @param count Amount of bytes to write
+ * @return 0 if successful
+ * @note The page handling of the EEPROM is done internally. When using this function there is no need to worry about
+ * the 16 byte page boundaries of the EEPROM
+ */
+int spi_eeprom_write(uint32_t addr, const uint8_t *data, uint32_t count);
+
+/**
+ * @brief Read the status register of the EEPROM
+ * @return status register
+ */
+uint8_t spi_eeprom_read_status_reg(void);
+
+/**
+ * @brief Check if an EEPROM is connected to the SPI.
+ *
+ * This is done by trying to set the write enable latch in the status register and reading it back.
+ * After it has been set, it is immediately reset.
+ *
+ * If it can't be read back, no EEPROM is connected
+ *
+ * @return true: EEPROM is connected, false: No (compatible) EEPROM found
+ */
+bool spi_eeprom_check_connected(void);
+
+#endif /* __SETTINGS_SPI_EEPROM_H__ */

stm-firmware/include/reflow-controller/systick.h

@@ -31,7 +31,7 @@
 /**
  * @brief Reload value for the systick timer.
  *
- * This value has to be configured to set the systick to a one milliscond tick interval
+ * This value has to be configured to set the systick to a 100 us tick interval
  * The default value is 16800, which results in a 100us tick for 168 MHz CPU speed
  */
 #define SYSTICK_RELOAD (16800UL)
@@ -55,7 +55,7 @@ extern volatile uint64_t global_tick_ms;
 extern volatile uint32_t lcd_tick_100us;
 
 /**
- * @brief Setup the Systick timer to generate a 1 ms tick
+ * @brief Setup the Systick timer to generate a 100 us tick
  */
 void systick_setup(void);
 
@@ -69,10 +69,28 @@ void systick_setup(void);
  */
 void systick_wait_ms(uint32_t ms);
 
-uint64_t systick_get_global_tick();
+/**
+ * @brief Get the gloabl millisecond tick. This can be used to implement all sorts of time based procedures / waits.
+ * @warning Use this with care in interrupts. It may lead to race conditions. It is generally safe for use in standard program flow though.
+ * @return  Global millisecond tick.
+ */
+uint64_t systick_get_global_tick(void);
 
+/**
+ * @brief Calculate the uptime from the current millisecond tick.
+ * @param[out] days Days. May be NULL.
+ * @param[out] hours Hours. May be NULL.
+ * @param[out] minutes Minutes. May be NULL.
+ * @param[out] seconds Seconds. May be NULL.
+ */
 void systick_get_uptime_from_tick(uint32_t *days, uint32_t *hours, uint32_t *minutes, uint32_t *seconds);
 
+/**
+ * @brief Check if \p ticks (milliseconds) have passed since \p start_timestamp
+ * @param start_timestamp Start timestamp
+ * @param ticks tick count
+ * @return true: Time has passed
+ */
 bool systick_ticks_have_passed(uint64_t start_timestamp, uint64_t ticks);
 
 #endif /* __SYSTICK_H__ */

stm-firmware/include/reflow-controller/temp-converter.h

@@ -25,8 +25,18 @@
  * @brief Convert PT1000 resistance to temperature in degrees celsius
  * @param resistance PT1000 resistance value
  * @param[out] temp_out Temperature output
- * @return 0 if ok, -1 if value is below conversion range, 1 if value is above conversion range,-1000 in case of pointer error
+ * @return 0 if ok, -1 if value is below conversion range, 1 if value is above conversion range,
+ * -1000 in case of pointer error
  */
 int temp_converter_convert_resistance_to_temp(float resistance, float *temp_out);
 
+/**
+ * @brief Convert temperature to PT1000 resistance
+ * @param temp Temperature in degrees celsius
+ * @param[out] resistance_out Resistance value
+ * @return 0 if ok, -1 if tmeperature is below the lookup table, 1 if value is above the lookup table, -1000 in case of a pointer error,
+ *	   -100 if an internal error occured. This should never happen, if the lookup table is correct
+ */
+int temp_converter_convert_temp_to_resistance(float temp, float *resistance_out);
+
 #endif /* __TEMP_CONVERTER_H__ */

stm-firmware/include/reflow-controller/temp-profile/temp-profile-executer.h

@@ -0,0 +1,94 @@
+/* Reflow Oven Controller
+*
+* Copyright (C) 2021  Mario Hüttel <mario.huettel@gmx.net>
+*
+* This file is part of the Reflow Oven Controller Project.
+*
+* The reflow oven controller is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License version 2 as
+* published by the Free Software Foundation.
+*
+* The Reflow Oven Control Firmware 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 the reflow oven controller project.
+* If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @addtogroup temp-profile
+ * @{
+ */
+
+#ifndef __TEMP_PROFILE_EXECUTER_H__
+#define __TEMP_PROFILE_EXECUTER_H__
+
+#include <stdint.h>
+#include <reflow-controller/temp-profile/temp-profile-parser.h>
+
+/**
+ * @brief Maximum command count of a temperature profile the parser will handle
+ */
+#define MAX_PROFILE_LENGTH 64
+
+/**
+ * @brief Status of the temperature profile execution
+ */
+enum tpe_status {
+	TPE_OFF, /**< @brief No profile execution */
+	TPE_RUNNING, /**< @brief Profile currently running */
+	TPE_ABORT, /**< @brief Profile execution aborted due to event / error */
+};
+
+/**
+ * @brief The execution state of the temperature profile
+ */
+struct tpe_exec_state {
+	enum tpe_status status; /**< @brief Execution status */
+	float setpoint; /**< @brief Temperature setpoint in degrees Celsius */
+	uint64_t start_timestamp; /**< @brief The millisicend tick timestamp, the profile execution was started */
+	uint32_t step; /**< @brief Current execution step. Starts at 0 */
+	uint32_t profile_steps; /**< @brief Number of steps (commands) in profile */
+	enum pl_command_type current_command; /**< @brief The currently executed command */
+};
+
+/**
+ * @brief Start a temperature profile execution from a file on SD card.
+ * @param filename Filename of the temperature profile
+ * @return Status. PL_RET_SUCCESS id profile was parsed and started successfully
+ */
+enum pl_ret_val temp_profile_executer_start(const char *filename);
+
+/**
+ * @brief Handle the profile execution
+ *
+ * The function checks if since the last time it ran, 100 ms have passed. If yes,
+ * it proceeds with the command execution.
+ *
+ * @note This must be periodically called.
+ * @return  0 if successul, negative if profile not running or aborted or temperature set and PID not configured.
+ */
+int temp_profile_executer_handle(void);
+
+/**
+ * @brief Get the curretn execution state of the temperature profile executer
+ * @warning The returned state structure is static and used internally. You must not modify it.
+ * @return Execution state
+ */
+const struct tpe_exec_state *temp_profile_executer_status(void);
+
+/**
+ * @brief Stop the temperature profile execution.
+ *
+ * The profile execution is stopped and the beeper is deactivated.
+ *
+ * @return always 0. This function cannot fail.
+ */
+int temp_profile_executer_stop(void);
+
+#endif /* __TEMP_PROFILE_EXECUTER_H__ */
+
+/** @} */

stm-firmware/include/reflow-controller/temp-profile/temp-profile-parser.h

@@ -0,0 +1,105 @@
+/* Reflow Oven Controller
+*
+* Copyright (C) 2021  Mario Hüttel <mario.huettel@gmx.net>
+*
+* This file is part of the Reflow Oven Controller Project.
+*
+* The reflow oven controller is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License version 2 as
+* published by the Free Software Foundation.
+*
+* The Reflow Oven Control Firmware 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 the reflow oven controller project.
+* If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @defgroup temp-profile Temperature Profile Parser and Executer
+ * @{
+ */
+
+#ifndef __CONFIG_PARSER_TEMP_PROFILE_PARSER_H__
+#define __CONFIG_PARSER_TEMP_PROFILE_PARSER_H__
+
+#include <stdint.h>
+#include <linklist-lib/singly-linked-list.h>
+
+/**
+ * @brief Command types the temperature profile language supports
+ */
+enum pl_command_type {
+	PL_PID_CONF = 0, /**< @brief Configure the PID parameters and start PID controller */
+	PL_SET_TEMP, /**< @brief Set the target temperature of the PID controller */
+	PL_SET_RAMP, /**< @brief Perform a temperature ramp */
+	PL_WAIT_FOR_TEMP, /**< @brief Wait until a temperature is reached */
+	PL_WAIT_FOR_TIME, /**< @brief Wait for a specific amount of time */
+	PL_LOUDSPEAKER_SET, /**< @brief Set the loudspeaker/beeper */
+	PL_OFF, /**< @brief Disable the temperature output and shutdown the PID controller */
+	PL_CLEAR_FLAGS, /**< @brief Try clear all flags */
+	PL_DIGIO_CONF, /**< @brief Configure a DIGIO pin */
+	PL_DIGIO_SET, /**< @brief Set a DIGIO pin */
+	PL_DIGIO_WAIT, /**< @brief Wait until a DIGIO pin is set to the specified level */
+	_PL_NUM_CMDS, /**< @brief Sentinel to determine the total amount of commands */
+};
+
+/**
+ * @brief Profile language parser return value
+ */
+enum pl_ret_val {
+	PL_RET_SUCCESS = 0, /**< @brief Profile parsed successfully */
+	PL_RET_DISK_ERR, /**< @brief Disk I/O error */
+	PL_RET_PARAM_ERR, /**< @brief Function parameter error */
+	PL_RET_LIST_FULL, /**< @brief Command list is full. Temperature profile is longer than the specified maximum */
+	PL_RET_SCRIPT_ERR, /**< @brief Syntax error in temperature profile */
+};
+
+/**
+ * @brief Maximum parameter count of a command.
+ */
+#define PROFILE_LANG_MAX_NUM_ARGS (8)
+
+/**
+ * @brief Structure representing a command in a temperature profile.
+ */
+struct pl_command {
+	enum pl_command_type cmd; /**< @brief Command */
+	float params[PROFILE_LANG_MAX_NUM_ARGS]; /**< @brief Parameters */
+};
+
+/**
+ * @brief Parse a temperature profile from file and generate the command list
+ *
+ * Commands are parsed into the list given by \p command_list. If \p max_len is reached,
+ * the function returns with @ref PL_RET_LIST_FULL
+ *
+ * In any case, the command list not cleared afterwards. The user has to clear the command list manually
+ * using @ref temp_profile_free_command_list.
+ *
+ * @param filename File to parse
+ * @param[in, out] command_list Command list to output @ref pl_command elements in.
+ * @param max_len maximum number of commands.
+ * @param cmds_parsed Number of parsed commands
+ * @return
+ */
+enum pl_ret_val temp_profile_parse_from_file(const char *filename,
+					     SlList **command_list,
+					     uint32_t max_len,
+					     uint32_t *cmds_parsed);
+
+/**
+ * @brief Fully free a comamnd list including hte stored command structures.
+ *
+ * \p list's destination is set to NULL to indicate the empty list.
+ *
+ * @param[in, out] list Pointer to list.
+ */
+void temp_profile_free_command_list(SlList **list);
+
+#endif /* __CONFIG_PARSER_TEMP_PROFILE_PARSER_H__ */
+
+/** @} */