ref: ad1df2d2a01bd064e643287ff305673dfede3ce3
parent: f7494952a2c095450e7cb0d99c16392a355eb8f8
author: Jon Sharp <jon@jonsharp.net>
date: Sun Nov 5 06:26:17 EST 2023
Import of QP/C + Zephyr project
- Imported all of the assets from the initial
work to adapt QP/C Zephyr template to the
ESP32 test board
- Import of QM models from HeyMac repo
--- /dev/null
+++ b/.gitmodules
@@ -1,0 +1,3 @@
+[submodule "qpc"]
+ path = qpc
+ url = https://github.com/QuantumLeaps/qpc.git
--- /dev/null
+++ b/CMakeLists.txt
@@ -1,0 +1,37 @@
+# QPC Zephyr application template and example
+# SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-QL-commercial
+
+cmake_minimum_required(VERSION 3.20.0)
+
+# location of the QPC Zephyr module
+# NOTE: might need to adjust for your project
+#
+set(QPC ${CMAKE_CURRENT_SOURCE_DIR}/qpc)+
+# Zephyr stuff
+set(ZEPHYR_EXTRA_MODULES ${QPC})+set(BOARD_ROOT ${CMAKE_CURRENT_SOURCE_DIR})+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})+
+# project name
+# NOTE: Adjust for your project
+#
+project(qpc-zephyr-app)
+
+# sources for your project
+# NOTE: Adjust for your project
+#
+target_sources(app PRIVATE
+ src/main.c
+ src/bsp.c
+ src/philo.c
+ src/table.c
+ src/sx127x.c
+)
+
+# option to turn QSPY software tracing ON or OFF
+# NOTE: Typically specified on command-line, e.g.:
+# west build -b <board> -- -DQSPY=ON
+#
+option(QSPY "QSPY software tracing" OFF)
+
--- /dev/null
+++ b/HeymacCsmaHsm.qm
@@ -1,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<model version="5.3.0" links="0">
+ <framework name="qpc"/>
+ <package name="AOs" stereotype="0x02">
+ <class name="HeymacCsmaHsm" superclass="qpc::QActive">
+ <attribute name="tmEvnt" type="QTimeEvt" visibility="0x02" properties="0x00"/>
+ <statechart properties="0x01">
+ <initial target="../1">
+ <initial_glyph conn="28,4,5,0,4,6">
+ <action box="0,-2,10,2"/>
+ </initial_glyph>
+ </initial>
+ <state name="_initializing">
+ <tran trig="_ALWAYS" target="../../2">
+ <tran_glyph conn="22,20,3,0,10,6">
+ <action box="0,-2,10,2"/>
+ </tran_glyph>
+ </tran>
+ <state_glyph node="22,10,28,12"/>
+ </state>
+ <state name="_lurking">
+ <documentation>ex_prep()</documentation>
+ <entry brief="bcn_evt.post_in(2 * _BCN_PRD)"/>
+ <exit brief="bcn_evt.disarm()"/>
+ <tran trig="_LNK_BCN_TMOUT" target="../2">
+ <action brief="[ident]"/>
+ <tran_glyph conn="22,36,3,0,26,2">
+ <action box="0,-2,22,2"/>
+ </tran_glyph>
+ </tran>
+ <tran trig="_LNK_RXD_FROM_PHY">
+ <tran_glyph conn="22,70,3,-1,26">
+ <action box="0,-2,20,2"/>
+ </tran_glyph>
+ </tran>
+ <state name="_beaconing">
+ <entry brief="bcn_evt.post_every(_BCN_PRD)">Picks beacon slot, sets timer for next Tslot</entry>
+ <exit brief="bcn_evt.disarm()"/>
+ <tran trig="_LNK_BCN_TMOUT">
+ <action brief="_tx_bcn()"/>
+ <tran_glyph conn="24,48,3,-1,24">
+ <action box="0,-2,24,2"/>
+ </tran_glyph>
+ </tran>
+ <tran trig="_LNK_RXD_FROM_PHY">
+ <choice target="../../2">
+ <guard brief="ngbr_hears_me()"/>
+ <choice_glyph conn="46,50,4,0,4">
+ <action box="1,0,15,2"/>
+ </choice_glyph>
+ </choice>
+ <choice>
+ <choice_glyph conn="46,50,5,-1,2">
+ <action box="1,0,10,2"/>
+ </choice_glyph>
+ </choice>
+ <tran_glyph conn="24,50,3,-1,22">
+ <action box="0,-2,20,2"/>
+ </tran_glyph>
+ </tran>
+ <state name="_linking">
+ <entry brief="_tm_evt.post_every(_LNK_UPDT_PRD)"/>
+ <tran trig="_LNK_TMOUT">
+ <tran_glyph conn="26,62,3,-1,22">
+ <action box="0,-2,20,2"/>
+ </tran_glyph>
+ </tran>
+ <state_glyph node="26,54,32,10">
+ <entry box="1,2,31,2"/>
+ </state_glyph>
+ </state>
+ <state_glyph node="24,38,36,28">
+ <entry box="1,2,29,2"/>
+ <exit box="1,4,29,2"/>
+ </state_glyph>
+ </state>
+ <state_glyph node="22,26,40,46">
+ <entry box="1,2,25,2"/>
+ <exit box="1,4,25,2"/>
+ </state_glyph>
+ </state>
+ <state_diagram size="84,80"/>
+ </statechart>
+ </class>
+ </package>
+ <directory name="."/>
+</model>
--- /dev/null
+++ b/LICENSES/GPL-3.0-or-later.txt
@@ -1,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
--- a/README.md
+++ b/README.md
@@ -1,4 +1,16 @@
-A HeyMac implementation for common ESP32-based LoRa boards
-====
+# HeyMac on ESP32 via QP/C + Zephyr
-Or, it will be...
+This project is an attempt to implement the HeyMac protocol/stack on commonly-
+available ESP32 + LoRa (Semtech SX127x) development boards as a self-contained
+modem firmware, suitable for interfacing with any number of systems -- modern
+or retro. This is accomplished using the QP/C framework running on top of /
+alongside the Zephyr RTOS and as a result, this project is based on the template
+provided by QuantumLeaps:
+ (Dining philosophers to be pruned from repo at some point...)
+
+[QP/C](https://github.com/QuantumLeaps/qpc)
+
+## Building:
+
+west build -b ttgo_lora32 -p always
+west flash
--- /dev/null
+++ b/SX127xHsm.qm
@@ -1,0 +1,222 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<model version="5.2.5" links="0">
+ <framework name="qpc"/>
+ <package name="net.frst.heymac" stereotype="0x02">
+ <class name="SX127x" superclass="qpc::QHsm">
+ <documentation>// HSM for SX127x LoRa Phy layer</documentation>
+ <attribute name="timeEvt" type="QTimeEvt" visibility="0x02" properties="0x00"/>
+ <attribute name="actionQueue" type="QEQueue" visibility="0x00" properties="0x00"/>
+ <statechart properties="0x01">
+ <initial target="../1">
+ <action>QTimeEvt_armX(&me->timeEvt, BSP_TICKS_PER_SEC/2, BSP_TICKS_PER_SEC/2);</action>
+ <initial_glyph conn="26,6,5,0,4,6">
+ <action box="0,-2,10,2"/>
+ </initial_glyph>
+ </initial>
+ <state name="_initializing">
+ <entry brief="tmout_evt.post_in(0.0)"/>
+ <tran trig="_PHY_TMOUT">
+ <choice target="../../../2">
+ <guard brief="sx127x.open()">true</guard>
+ <choice_glyph conn="36,20,4,0,8">
+ <action box="-11,4,13,2"/>
+ </choice_glyph>
+ </choice>
+ <tran_glyph conn="20,20,3,-1,16">
+ <action box="0,-2,20,2"/>
+ </tran_glyph>
+ </tran>
+ <state_glyph node="20,12,20,10">
+ <entry box="1,2,19,2"/>
+ </state_glyph>
+ </state>
+ <state name="_scheduling">
+ <entry brief="post_in(delay)"/>
+ <tran trig="_PHY_TMOUT">
+ <choice target="../../../3">
+ <guard>true</guard>
+ <choice_glyph conn="36,40,5,3,6,-8,2">
+ <action box="1,0,10,2"/>
+ </choice_glyph>
+ </choice>
+ <choice target="../../../4/2">
+ <guard>true</guard>
+ <choice_glyph conn="36,40,4,0,6,18,8">
+ <action box="1,0,10,2"/>
+ </choice_glyph>
+ </choice>
+ <choice target="../../../4/3">
+ <guard>true</guard>
+ <choice_glyph conn="36,40,5,0,-10,14">
+ <action box="1,0,10,2"/>
+ </choice_glyph>
+ </choice>
+ <tran_glyph conn="20,36,3,-1,16,4">
+ <action box="0,-2,10,2"/>
+ </tran_glyph>
+ </tran>
+ <tran trig="_PHY_RQST">
+ <tran_glyph conn="20,38,3,-1,12">
+ <action box="0,-2,10,2"/>
+ </tran_glyph>
+ </tran>
+ <state_glyph node="20,28,20,16">
+ <entry box="1,2,18,2"/>
+ </state_glyph>
+ </state>
+ <state name="_txing">
+ <entry brief="write_opmode(TX)"/>
+ <exit brief="tmout_evt.disarm()"/>
+ <tran trig="_DIO_TX_DONE" target="../../2">
+ <tran_glyph conn="44,36,3,0,24,-10,-30,2">
+ <action box="0,-2,18,2"/>
+ </tran_glyph>
+ </tran>
+ <tran trig="_PHY_TMOUT">
+ <tran_glyph conn="44,40,3,-1,14">
+ <action box="0,-2,12,2"/>
+ </tran_glyph>
+ </tran>
+ <tran trig="_PHY_RQST">
+ <tran_glyph conn="44,38,3,-1,14">
+ <action box="0,-2,12,2"/>
+ </tran_glyph>
+ </tran>
+ <tran trig="_DIO_MODE_RDY" target="../../2">
+ <tran_glyph conn="44,42,3,0,24,-16,-30,2">
+ <action box="0,-2,16,2"/>
+ </tran_glyph>
+ </tran>
+ <state_glyph node="44,28,18,16">
+ <entry box="1,2,16,2"/>
+ <exit box="1,4,16,2"/>
+ </state_glyph>
+ </state>
+ <state name="_lingering">
+ <exit brief="write_opmode(STBY)"/>
+ <tran trig="_PHY_RQST">
+ <choice target="../../../2">
+ <guard brief="_default_action">true</guard>
+ <choice_glyph conn="34,90,5,0,34,-64,-30,2">
+ <action box="1,-2,13,2"/>
+ </choice_glyph>
+ </choice>
+ <choice>
+ <guard brief="else">// not empty</guard>
+ <action>// not empty 2</action>
+ <choice_glyph conn="34,90,4,-1,2,26">
+ <action box="1,0,10,2"/>
+ </choice_glyph>
+ </choice>
+ <tran_glyph conn="20,90,3,-1,14">
+ <action box="0,-2,12,2"/>
+ </tran_glyph>
+ </tran>
+ <tran trig="_PHY_TMOUT" target="../../2">
+ <tran_glyph conn="20,94,3,0,48,-68,-30,2">
+ <action box="0,-2,12,2"/>
+ </tran_glyph>
+ </tran>
+ <state name="_sleeping">
+ <state_glyph node="50,54,10,8"/>
+ </state>
+ <state name="_listening">
+ <entry brief="prdc_evt.post_every()"/>
+ <exit brief="prdc_evt.disarm()"/>
+ <tran trig="_DIO_VALID_HDR" target="../4">
+ <tran_glyph conn="22,66,3,0,20,2">
+ <action box="0,-2,18,2"/>
+ </tran_glyph>
+ </tran>
+ <tran trig="_PHY_PRDC">
+ <action brief="updt_noise()"/>
+ <tran_glyph conn="22,64,3,-1,20">
+ <action box="0,-2,20,2"/>
+ </tran_glyph>
+ </tran>
+ <tran trig="_DIO_RX_TMOUT" target="../../../2">
+ <tran_glyph conn="22,84,3,0,46,-58,-30,2">
+ <action box="0,-2,14,2"/>
+ </tran_glyph>
+ </tran>
+ <tran trig="_DIO_RX_DONE" target="../../../2">
+ <tran_glyph conn="22,82,3,0,46,-56,-30,2">
+ <action box="0,-2,18,2"/>
+ </tran_glyph>
+ </tran>
+ <state name="_rxing">
+ <exit brief="tmout_evt.disarm()"/>
+ <tran trig="_PHY_RQST">
+ <tran_glyph conn="24,76,3,-1,18">
+ <action box="0,-2,10,2"/>
+ </tran_glyph>
+ </tran>
+ <state_glyph node="24,68,22,10">
+ <exit box="1,2,19,2"/>
+ </state_glyph>
+ </state>
+ <state_glyph node="22,54,26,32">
+ <entry box="1,2,19,2"/>
+ <exit box="1,4,17,2"/>
+ </state_glyph>
+ </state>
+ <state_glyph node="20,48,42,50">
+ <exit box="1,2,17,2"/>
+ </state_glyph>
+ </state>
+ <state_diagram size="95,117"/>
+ </statechart>
+ </class>
+ <class name="ActionEvt" superclass="qpc::QEvt"/>
+ </package>
+ <directory name="src">
+ <file name="sx127x.c">
+ <text>#include "qpc.h"
+#include "bsp.h"
+
+Q_DEFINE_THIS_FILE
+
+enum SX127x_Signals {+ _PHY_TMOUT_SIG = Q_USER_SIG,
+ _PHY_RQST_SIG,
+ _DIO_TX_DONE_SIG,
+ _DIO_MODE_RDY_SIG,
+ _DIO_VALID_HDR_SIG,
+ _PHY_PRDC_SIG,
+ _DIO_RX_TMOUT_SIG,
+ _DIO_RX_DONE_SIG
+}
+
+/* Active object class -----------------------------------------------------*/
+
+$declare${net.frst.heymac::ActionEvt}+
+$declare${net.frst.heymac::SX127x}+
+#define LINGER_TIME \
+ (QTimeEvtCtr)((BSP_random() % BSP_TICKS_PER_SEC) + BSP_TICKS_PER_SEC)
+
+$define${net.frst.heymac::SX127x}+
+$define${net.frst.heymac::ActionEvt}</text>+ </file>
+ <file name="sx127x.h">
+ <text>#ifndef SX127X_H
+#define SX127X_H
+
+enum SX127x_Signals {+ _PHY_TMOUT_SIG = Q_USER_SIG,
+ _PHY_RQST_SIG,
+ _DIO_TX_DONE_SIG,
+ _DIO_MODE_RDY_SIG,
+ _DIO_VALID_HDR_SIG,
+ _PHY_PRDC_SIG,
+ _DIO_RX_TMOUT_SIG,
+ _DIO_RX_DONE_SIG
+}
+
+#endif</text>
+ </file>
+ <file name="main.c" properties="external"/>
+ </directory>
+</model>
binary files /dev/null b/boards/xtensa/ttgo_lora32/.ttgo_lora32-pinctrl.dtsi.swo differ
binary files /dev/null b/boards/xtensa/ttgo_lora32/.ttgo_lora32-pinctrl.dtsi.swp differ
--- /dev/null
+++ b/boards/xtensa/ttgo_lora32/CMakeLists.txt
@@ -1,0 +1,6 @@
+# SPDX-License-Identifier: Apache-2.0
+
+if(CONFIG_GPIO_ESP32)
+ zephyr_library()
+ zephyr_library_sources(board_init.c)
+endif()
--- /dev/null
+++ b/boards/xtensa/ttgo_lora32/Kconfig.board
@@ -1,0 +1,7 @@
+config BOARD_TTGO_LORA32
+ bool "TTGO LoRa32 (V1.6.1) Board"
+ depends on SOC_SERIES_ESP32
+
+choice SOC_PART_NUMBER
+ default SOC_ESP32_D0WD_V3
+endchoice
--- /dev/null
+++ b/boards/xtensa/ttgo_lora32/Kconfig.defconfig
@@ -1,0 +1,15 @@
+config BOARD
+ default "ttgo_lora32"
+ depends on BOARD_TTGO_LORA32
+
+config ENTROPY_GENERATOR
+ default y
+
+config HEAP_MEM_POOL_SIZE
+ default 98304 if WIFI
+ default 40960 if BT
+ default 4096
+
+choice BT_HCI_BUS_TYPE
+ default BT_ESP32 if BT
+endchoice
--- /dev/null
+++ b/boards/xtensa/ttgo_lora32/Kconfig.sysbuild
@@ -1,0 +1,10 @@
+# Copyright (c) 2023 Espressif Systems (Shanghai) Co., Ltd.
+# SPDX-License-Identifier: Apache-2.0
+
+choice BOOTLOADER
+ default BOOTLOADER_MCUBOOT
+endchoice
+
+choice BOOT_SIGNATURE_TYPE
+ default BOOT_SIGNATURE_TYPE_NONE
+endchoice
--- /dev/null
+++ b/boards/xtensa/ttgo_lora32/board.cmake
@@ -1,0 +1,3 @@
+# SPDX-License-Identifier: Apache-2.0
+
+include(${ZEPHYR_BASE}/boards/common/esp32.board.cmake)--- /dev/null
+++ b/boards/xtensa/ttgo_lora32/board_init.c
@@ -1,0 +1,36 @@
+/*
+ * Copyright (c) 2021 Instituto de Pesquisas Eldorado (eldorado.org.br)
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/device.h>
+#include <zephyr/drivers/gpio.h>
+#include <zephyr/init.h>
+
+#define VEXT_PIN DT_GPIO_PIN(DT_NODELABEL(vext), gpios)
+//#define OLED_RST DT_GPIO_PIN(DT_NODELABEL(oledrst), gpios)
+
+static int board_ttgo_lora32_v2_init(void)
+{+ const struct device *gpio;
+
+ gpio = DEVICE_DT_GET(DT_NODELABEL(gpio0));
+ if (!device_is_ready(gpio)) {+ return -ENODEV;
+ }
+
+ /* turns external VCC on */
+ gpio_pin_configure(gpio, VEXT_PIN, GPIO_OUTPUT);
+ gpio_pin_set_raw(gpio, VEXT_PIN, 0);
+
+ /* turns OLED on */
+ /*
+ gpio_pin_configure(gpio, OLED_RST, GPIO_OUTPUT);
+ gpio_pin_set_raw(gpio, OLED_RST, 1);
+ */
+
+ return 0;
+}
+
+SYS_INIT(board_ttgo_lora32_v2_init, PRE_KERNEL_2, CONFIG_GPIO_INIT_PRIORITY);
--- /dev/null
+++ b/boards/xtensa/ttgo_lora32/doc/index.rst
@@ -1,0 +1,208 @@
+.. _heltec_wifi_lora32_v2:
+
+Heltec WiFi LoRa 32 (V2)
+########################
+
+Overview
+********
+
+Heltec WiFi LoRa 32 is a classic IoT dev-board designed & produced by Heltec Automation(TM), it's a highly
+integrated product based on ESP32 + SX127x, it has Wi-Fi, BLE, LoRa functions, also Li-Po battery management
+system, 0.96" OLED are also included. [1]_
+
+The features include the following:
+
+- Microprocessor: ESP32 (dual-core 32-bit MCU + ULP core)
+- LoRa node chip SX1276/SX1278
+- Micro USB interface with a complete voltage regulator, ESD protection, short circuit protection,
+ RF shielding, and other protection measures
+- Onboard SH1.25-2 battery interface, integrated lithium battery management system
+- Integrated WiFi, LoRa, Bluetooth three network connections, onboard Wi-Fi, Bluetooth dedicated 2.4GHz
+ metal 3D antenna, reserved IPEX (U.FL) interface for LoRa use
+- Onboard 0.96-inch 128*64 dot matrix OLED display
+- Integrated CP2102 USB to serial port chip
+
+System requirements
+*******************
+
+Prerequisites
+=============
+
+Espressif HAL requires WiFi and Bluetooth binary blobs in order work. Run the command
+below to retrieve those files.
+
+.. code-block:: console
+
+ west blobs fetch hal_espressif
+
+.. note::
+
+ It is recommended running the command above after :file:`west update`.
+
+Building & Flashing
+*******************
+
+ESP-IDF bootloader
+==================
+
+The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
+It is build as a subproject at each application build. No further attention
+is expected from the user.
+
+MCUboot bootloader
+==================
+
+User may choose to use MCUboot bootloader instead. In that case the bootloader
+must be build (and flash) at least once.
+
+There are two options to be used when building an application:
+
+1. Sysbuild
+2. Manual build
+
+.. note::
+
+ User can select the MCUboot bootloader by adding the following line
+ to the board default configuration file.
+ ```
+ CONFIG_BOOTLOADER_MCUBOOT=y
+ ```
+
+Sysbuild
+========
+
+The sysbuild makes possible to build and flash all necessary images needed to
+bootstrap the board with the EPS32 SoC.
+
+To build the sample application using sysbuild use the command:
+
+.. zephyr-app-commands::
+ :tool: west
+ :app: samples/hello_world
+ :board: heltec_wifi_lora32_v2
+ :goals: build
+ :west-args: --sysbuild
+ :compact:
+
+By default, the ESP32 sysbuild creates bootloader (MCUboot) and application
+images. But it can be configured to create other kind of images.
+
+Build directory structure created by sysbuild is different from traditional
+Zephyr build. Output is structured by the domain subdirectories:
+
+.. code-block::
+
+ build/
+ ├── hello_world
+ │ └── zephyr
+ │ ├── zephyr.elf
+ │ └── zephyr.bin
+ ├── mcuboot
+ │ └── zephyr
+ │ ├── zephyr.elf
+ │ └── zephyr.bin
+ └── domains.yaml
+
+.. note::
+
+ With ``--sysbuild`` option the bootloader will be re-build and re-flash
+ every time the pristine build is used.
+
+For more information about the system build please read the :ref:`sysbuild` documentation.
+
+Manual build
+============
+
+During the development cycle, it is intended to build & flash as quickly possible.
+For that reason, images can be build one at a time using traditional build.
+
+The instructions following are relevant for both manual build and sysbuild.
+The only difference is the structure of the build directory.
+
+.. note::
+
+ Remember that bootloader (MCUboot) needs to be flash at least once.
+
+Build and flash applications as usual (see :ref:`build_an_application` and
+:ref:`application_run` for more details).
+
+.. zephyr-app-commands::
+ :zephyr-app: samples/hello_world
+ :board: heltec_wifi_lora32_v2
+ :goals: build
+
+The usual ``flash`` target will work with the ``heltec_wifi_lora32_v2`` board
+configuration. Here is an example for the :ref:`hello_world`
+application.
+
+.. zephyr-app-commands::
+ :zephyr-app: samples/hello_world
+ :board: heltec_wifi_lora32_v2
+ :goals: flash
+
+Open the serial monitor using the following command:
+
+.. code-block:: shell
+
+ west espressif monitor
+
+After the board has automatically reset and booted, you should see the following
+message in the monitor:
+
+.. code-block:: console
+
+ ***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
+ Hello World! heltec_wifi_lora32_v2
+
+Debugging
+*********
+
+As with much custom hardware, the ESP32 modules require patches to
+OpenOCD that are not upstreamed yet. Espressif maintains their own fork of
+the project. The custom OpenOCD can be obtained at `OpenOCD ESP32`_
+
+The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite that behavior by adding the
+``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
+parameter when building.
+
+Here is an example for building the :ref:`hello_world` application.
+
+.. zephyr-app-commands::
+ :zephyr-app: samples/hello_world
+ :board: heltec_wifi_lora32_v2
+ :goals: build flash
+ :gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>
+
+You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
+
+.. zephyr-app-commands::
+ :zephyr-app: samples/hello_world
+ :board: heltec_wifi_lora32_v2
+ :goals: debug
+
+Utilizing Hardware Features
+***************************
+
+Onboard OLED display
+====================
+
+The onboard OLED display is of type ``ssd1306``, has 128*64 pixels and is
+connected via I2C. It can therefore be used by enabling the
+:ref:`ssd1306_128_shield` as shown in the following for the :ref:`lvgl-sample`:
+
+.. zephyr-app-commands::
+ :zephyr-app: samples/subsys/display/lvgl
+ :board: heltec_wifi_lora32_v2
+ :shield: ssd1306_128x64
+ :goals: flash
+
+References
+**********
+
+- `Heltec WiFi LoRa (v2) Pinout Diagram <https://resource.heltec.cn/download/WiFi_LoRa_32/WIFI_LoRa_32_V2.pdf>`_
+- `Heltec WiFi LoRa (v2) Schematic Diagrams <https://resource.heltec.cn/download/WiFi_LoRa_32/V2>`_
+- `ESP32 Toolchain <https://docs.espressif.com/projects/esp-idf/en/v4.2/esp32/api-guides/tools/idf-tools.html#xtensa-esp32-elf>`_
+- `esptool documentation <https://github.com/espressif/esptool/blob/master/README.md>`_
+- `OpenOCD ESP32 <https://github.com/espressif/openocd-esp32/releases>`_
+
+.. [1] https://heltec.org/project/wifi-lora-32/
--- /dev/null
+++ b/boards/xtensa/ttgo_lora32/ttgo_lora32-pinctrl.dtsi
@@ -1,0 +1,49 @@
+/*
+ * Copyright (c) 2022 Espressif Systems (Shanghai) Co., Ltd.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/dt-bindings/pinctrl/esp-pinctrl-common.h>
+#include <dt-bindings/pinctrl/esp32-pinctrl.h>
+#include <zephyr/dt-bindings/pinctrl/esp32-gpio-sigmap.h>
+
+&pinctrl {+
+ uart0_default: uart0_default {+ group1 {+ pinmux = <UART0_TX_GPIO1>;
+ output-high;
+ };
+ group2 {+ pinmux = <UART0_RX_GPIO3>;
+ bias-pull-up;
+ };
+ };
+
+ spim3_default: spim3_default {+ group1 {+ pinmux = <SPIM3_MISO_GPIO19>,
+ <SPIM3_SCLK_GPIO5>;
+ };
+ group2 {+ pinmux = <SPIM3_MOSI_GPIO27>;
+ output-low;
+ };
+ };
+
+ i2c0_default: i2c0_default {+ group1 {+ /*
+ pinmux = <I2C0_SDA_GPIO22>,
+ <I2C0_SCL_GPIO21>;
+ */
+ pinmux = <I2C0_SDA_GPIO21>,
+ <I2C0_SCL_GPIO22>;
+ bias-pull-up;
+ drive-open-drain;
+ output-high;
+ };
+ };
+
+};
--- /dev/null
+++ b/boards/xtensa/ttgo_lora32/ttgo_lora32.dts
@@ -1,0 +1,183 @@
+/*
+ * Copyright (c) 2021 Instituto de Pesquisas Eldorado (eldorado.org.br)
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/dts-v1/;
+
+#include <espressif/esp32/esp32_pico_d4.dtsi>
+#include "ttgo_lora32-pinctrl.dtsi"
+#include <zephyr/dt-bindings/input/input-event-codes.h>
+
+/ {+ model = "ttgo_lora32";
+ compatible = "espressif,esp32";
+
+ aliases {+ uart-0 = &uart0;
+ i2c-0 = &i2c0;
+ led0 = &led0;
+ //sw0 = &button0;
+ watchdog0 = &wdt0;
+ lora0 = &lora0;
+ };
+
+ leds {+ compatible = "gpio-leds";
+ led0: led {+ gpios = <&gpio0 25 GPIO_ACTIVE_HIGH>;
+ label = "White LED";
+ };
+
+ vext: vext {+ gpios = <&gpio0 3 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>;
+ label = "External VCC";
+ };
+
+ /*
+ oledrst: oledrst {+ gpios = <&gpio0 16 (GPIO_PULL_UP | GPIO_ACTIVE_HIGH)>;
+ label = "OLED Reset";
+ };
+ */
+ };
+
+ /*
+ buttons {+ compatible = "gpio-keys";
+ button0: button_0 {+ gpios = <&gpio0 0 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>;
+ label = "PRG Button";
+ zephyr,code = <INPUT_KEY_0>;
+ };
+ };
+ */
+
+ chosen {+ zephyr,sram = &sram0;
+ zephyr,console = &uart0;
+ zephyr,shell-uart = &uart0;
+ zephyr,flash = &flash0;
+ zephyr,display = &oled_screen;
+ };
+};
+
+&cpu0 {+ clock-frequency = <ESP32_CLK_CPU_240M>;
+};
+
+&cpu1 {+ clock-frequency = <ESP32_CLK_CPU_240M>;
+};
+
+&uart0 {+ status = "okay";
+ current-speed = <115200>;
+ pinctrl-0 = <&uart0_default>;
+ pinctrl-names = "default";
+};
+
+&gpio0 {+ status = "okay";
+};
+
+&gpio1 {+ status = "okay";
+};
+
+&trng0 {+ status = "okay";
+};
+
+&i2c0 {+ status = "okay";
+ clock-frequency = <I2C_BITRATE_FAST>;
+ sda-gpios = <&gpio0 4 GPIO_OPEN_DRAIN>;
+ scl-gpios = <&gpio0 15 GPIO_OPEN_DRAIN>;
+ pinctrl-0 = <&i2c0_default>;
+ pinctrl-names = "default";
+
+ oled_screen: ssd1306@3c {+ compatible = "solomon,ssd1306fb";
+ reg = <0x3c>;
+ width = <128>;
+ height = <64>;
+ segment-offset = <0>;
+ page-offset = <0>;
+ display-offset = <0>;
+ multiplex-ratio = <63>;
+ segment-remap;
+ com-invdir;
+ prechargep = <0x22>;
+ };
+};
+
+&spi3 {+ #address-cells = <1>;
+ #size-cells = <0>;
+ status = "okay";
+ pinctrl-0 = <&spim3_default>;
+ pinctrl-names = "default";
+ cs-gpios = <&gpio0 18 GPIO_ACTIVE_LOW>;
+ lora0: sx1276@0 {+ compatible = "semtech,sx1276";
+ reg = <0>;
+ reset-gpios = <&gpio0 23 GPIO_ACTIVE_LOW>;
+ dio-gpios =
+ /* SX1276 D0 -> GPIO26 */
+ <&gpio0 26 (GPIO_PULL_DOWN | GPIO_ACTIVE_HIGH)>,
+ /* SX1276 D1 -> GPIO35 */
+ <&gpio1 1 (GPIO_PULL_DOWN | GPIO_ACTIVE_HIGH)>,
+ /* SX1276 D1 -> GPIO34 */
+ <&gpio0 32 (GPIO_PULL_DOWN | GPIO_ACTIVE_HIGH)>;
+ spi-max-frequency = <1000000>;
+ power-amplifier-output = "pa-boost";
+ };
+};
+
+&flash0 {+ /* the board is using plain d0wd SoC part without the flash
+ * so any additional flash size should be defined at the board level
+ */
+ reg = <0x0 DT_SIZE_M(8)>;
+
+ status = "okay";
+ partitions {+ compatible = "fixed-partitions";
+ #address-cells = <1>;
+ #size-cells = <1>;
+
+ /* Reserve 60kB for the bootloader */
+ boot_partition: partition@1000 {+ label = "mcuboot";
+ reg = <0x00001000 0x0000F000>;
+ read-only;
+ };
+
+ /* Reserve 1024kB for the application in slot 0 */
+ slot0_partition: partition@10000 {+ label = "image-0";
+ reg = <0x00010000 0x00100000>;
+ };
+
+ /* Reserve 1024kB for the application in slot 1 */
+ slot1_partition: partition@110000 {+ label = "image-1";
+ reg = <0x00110000 0x00100000>;
+ };
+
+ /* Reserve 256kB for the scratch partition */
+ scratch_partition: partition@210000 {+ label = "image-scratch";
+ reg = <0x00210000 0x00040000>;
+ };
+
+ storage_partition: partition@250000 {+ label = "storage";
+ reg = <0x00250000 0x00006000>;
+ };
+ };
+};
+
+/* Required by the ssd1306_128x64 shield which enables the OLED display */
+arduino_i2c: &i2c0 {};--- /dev/null
+++ b/boards/xtensa/ttgo_lora32/ttgo_lora32.yaml
@@ -1,0 +1,16 @@
+identifier: ttgo_lora32
+name: TTGO LoRa32 (V1.6.1) Board
+type: mcu
+arch: xtensa
+toolchain:
+ - zephyr
+supported:
+ - gpio
+ - i2c
+ - watchdog
+ - uart
+ - nvs
+testing:
+ ignore_tags:
+ - net
+ - bluetooth
--- /dev/null
+++ b/boards/xtensa/ttgo_lora32/ttgo_lora32_defconfig
@@ -1,0 +1,10 @@
+CONFIG_BOARD_TTGO_LORA32=y
+CONFIG_SOC_SERIES_ESP32=y
+
+CONFIG_MAIN_STACK_SIZE=2048
+
+CONFIG_CONSOLE=y
+CONFIG_SERIAL=y
+CONFIG_UART_CONSOLE=y
+
+CONFIG_GPIO=y
--- /dev/null
+++ b/dpp.qm
@@ -1,0 +1,488 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<model version="5.2.5" links="1">
+ <documentation>Dining Philosopher Problem example</documentation>
+ <!--${qpc}-->+ <framework name="qpc"/>
+ <!--${Events}-->+ <package name="Events" stereotype="0x01">
+ <!--${Events::TableEvt}-->+ <class name="TableEvt" superclass="qpc::QEvt">
+ <!--${Events::TableEvt::philoNum}-->+ <attribute name="philoNum" type="uint8_t" visibility="0x00" properties="0x00"/>
+ </class>
+ </package>
+ <!--${AOs}-->+ <package name="AOs" stereotype="0x02">
+ <!--${AOs::Philo}-->+ <class name="Philo" superclass="qpc::QActive">
+ <!--${AOs::Philo::inst[N_PHILO]}-->+ <attribute name="inst[N_PHILO]" type="Philo" visibility="0x00" properties="0x01">
+ <documentation>The array of static insts of the Philo class (Singleton pattern)</documentation>
+ </attribute>
+ <!--${AOs::Philo::timeEvt}-->+ <attribute name="timeEvt" type="QTimeEvt" visibility="0x02" properties="0x00"/>
+ <!--${AOs::Philo::SM}-->+ <statechart properties="0x01">
+ <!--${AOs::Philo::SM::initial}-->+ <initial target="../1">
+ <action>static uint8_t registered = (uint8_t)0; /* starts off with 0, per C-standard */
+(void)par; /* unused parameter */
+// Here's a start:
+if (registered == (uint8_t)0) {+ registered = (uint8_t)1;
+
+ QS_OBJ_DICTIONARY(&Philo_inst[0]);
+ QS_OBJ_DICTIONARY(&Philo_inst[0].timeEvt);
+ QS_OBJ_DICTIONARY(&Philo_inst[1]);
+ QS_OBJ_DICTIONARY(&Philo_inst[1].timeEvt);
+ QS_OBJ_DICTIONARY(&Philo_inst[2]);
+ QS_OBJ_DICTIONARY(&Philo_inst[2].timeEvt);
+ QS_OBJ_DICTIONARY(&Philo_inst[3]);
+ QS_OBJ_DICTIONARY(&Philo_inst[3].timeEvt);
+ QS_OBJ_DICTIONARY(&Philo_inst[4]);
+ QS_OBJ_DICTIONARY(&Philo_inst[4].timeEvt);
+
+ QS_FUN_DICTIONARY(&Philo_initial);
+ QS_FUN_DICTIONARY(&Philo_thinking);
+ QS_FUN_DICTIONARY(&Philo_hungry);
+ QS_FUN_DICTIONARY(&Philo_eating);
+}
+QS_SIG_DICTIONARY(HUNGRY_SIG, me); /* signal for each Philos */
+QS_SIG_DICTIONARY(TIMEOUT_SIG, me); /* signal for each Philos */
+
+QActive_subscribe(&me->super, EAT_SIG);
+QActive_subscribe(&me->super, TEST_SIG);</action>
+ <initial_glyph conn="2,3,5,1,20,5,-3">
+ <action box="0,-2,6,2"/>
+ </initial_glyph>
+ </initial>
+ <!--${AOs::Philo::SM::thinking}-->+ <state name="thinking">
+ <entry>QTimeEvt_armX(&me->timeEvt, THINK_TIME, 0U);</entry>
+ <exit>QTimeEvt_disarm(&me->timeEvt);</exit>
+ <!--${AOs::Philo::SM::thinking::TIMEOUT}-->+ <tran trig="TIMEOUT" target="../../2">
+ <tran_glyph conn="2,13,3,1,20,12,-3">
+ <action box="0,-2,6,2"/>
+ </tran_glyph>
+ </tran>
+ <!--${AOs::Philo::SM::thinking::EAT, DONE}-->+ <tran trig="EAT, DONE">
+ <action>/* EAT or DONE must be for other Philos than this one */
+Q_ASSERT(Q_EVT_CAST(TableEvt)->philoNum != PHILO_ID(me));</action>
+ <tran_glyph conn="2,17,3,-1,13">
+ <action box="0,-2,14,2"/>
+ </tran_glyph>
+ </tran>
+ <!--${AOs::Philo::SM::thinking::TEST}-->+ <tran trig="TEST">
+ <tran_glyph conn="2,20,3,-1,13">
+ <action box="0,-2,11,4"/>
+ </tran_glyph>
+ </tran>
+ <state_glyph node="2,5,17,16">
+ <entry box="1,2,5,2"/>
+ <exit box="1,4,6,2"/>
+ </state_glyph>
+ </state>
+ <!--${AOs::Philo::SM::hungry}-->+ <state name="hungry">
+ <entry>TableEvt *pe = Q_NEW(TableEvt, HUNGRY_SIG);
+pe->philoNum = PHILO_ID(me);
+QACTIVE_POST(AO_Table, &pe->super, me);</entry>
+ <!--${AOs::Philo::SM::hungry::EAT}-->+ <tran trig="EAT">
+ <!--${AOs::Philo::SM::hungry::EAT::[Q_EVT_CAST(TableEvt)->philoNum=~}-->+ <choice target="../../../3">
+ <guard>Q_EVT_CAST(TableEvt)->philoNum == PHILO_ID(me)</guard>
+ <choice_glyph conn="15,30,5,1,7,13,-3">
+ <action box="1,0,19,4"/>
+ </choice_glyph>
+ </choice>
+ <tran_glyph conn="2,30,3,-1,13">
+ <action box="0,-2,14,2"/>
+ </tran_glyph>
+ </tran>
+ <!--${AOs::Philo::SM::hungry::DONE}-->+ <tran trig="DONE">
+ <action>/* DONE must be for other Philos than this one */
+Q_ASSERT(Q_EVT_CAST(TableEvt)->philoNum != PHILO_ID(me));</action>
+ <tran_glyph conn="2,36,3,-1,14">
+ <action box="0,-2,14,2"/>
+ </tran_glyph>
+ </tran>
+ <state_glyph node="2,23,17,16">
+ <entry box="1,2,5,2"/>
+ </state_glyph>
+ </state>
+ <!--${AOs::Philo::SM::eating}-->+ <state name="eating">
+ <entry>QTimeEvt_armX(&me->timeEvt, EAT_TIME, 0U);</entry>
+ <exit>TableEvt *pe = Q_NEW(TableEvt, DONE_SIG);
+pe->philoNum = PHILO_ID(me);
+QACTIVE_PUBLISH(&pe->super, &me->super);</exit>
+ <!--${AOs::Philo::SM::eating::TIMEOUT}-->+ <tran trig="TIMEOUT" target="../../1">
+ <tran_glyph conn="2,51,3,1,22,-41,-5">
+ <action box="0,-2,6,2"/>
+ </tran_glyph>
+ </tran>
+ <!--${AOs::Philo::SM::eating::EAT, DONE}-->+ <tran trig="EAT, DONE">
+ <action>/* EAT or DONE must be for other Philos than this one */
+Q_ASSERT(Q_EVT_CAST(TableEvt)->philoNum != PHILO_ID(me));</action>
+ <tran_glyph conn="2,55,3,-1,13">
+ <action box="0,-2,14,2"/>
+ </tran_glyph>
+ </tran>
+ <state_glyph node="2,41,17,18">
+ <entry box="1,2,5,2"/>
+ <exit box="1,4,5,2"/>
+ </state_glyph>
+ </state>
+ <state_diagram size="37,61"/>
+ </statechart>
+ </class>
+ <!--${AOs::Table}-->+ <class name="Table" superclass="qpc::QActive">
+ <!--${AOs::Table::inst}-->+ <attribute name="inst" type="Table" visibility="0x00" properties="0x01">
+ <documentation>The only static inst of the Table class (Singleton pattern)</documentation>
+ </attribute>
+ <!--${AOs::Table::fork[N_PHILO]}-->+ <attribute name="fork[N_PHILO]" type="uint8_t" visibility="0x02" properties="0x00"/>
+ <!--${AOs::Table::isHungry[N_PHILO]}-->+ <attribute name="isHungry[N_PHILO]" type="uint8_t" visibility="0x02" properties="0x00"/>
+ <!--${AOs::Table::SM}-->+ <statechart properties="0x03">
+ <!--${AOs::Table::SM::initial}-->+ <initial target="../1/2">
+ <action>uint8_t n;
+(void)par; /* unused parameter */
+
+QS_OBJ_DICTIONARY(&Table_inst);
+
+QS_SIG_DICTIONARY(DONE_SIG, (void *)0); /* global signals */
+QS_SIG_DICTIONARY(EAT_SIG, (void *)0);
+QS_SIG_DICTIONARY(PAUSE_SIG, (void *)0);
+QS_SIG_DICTIONARY(SERVE_SIG, (void *)0);
+QS_SIG_DICTIONARY(TEST_SIG, (void *)0);
+
+QS_SIG_DICTIONARY(HUNGRY_SIG, me); /* signal just for Table */
+
+QActive_subscribe(&me->super, DONE_SIG);
+QActive_subscribe(&me->super, PAUSE_SIG);
+QActive_subscribe(&me->super, SERVE_SIG);
+QActive_subscribe(&me->super, TEST_SIG);
+
+for (n = 0U; n < N_PHILO; ++n) {+ me->fork[n] = FREE;
+ me->isHungry[n] = 0U;
+ BSP_displayPhilStat(n, "thinking");
+}</action>
+ <initial_glyph conn="3,3,5,1,44,18,-9">
+ <action box="0,-2,6,2"/>
+ </initial_glyph>
+ </initial>
+ <!--${AOs::Table::SM::active}-->+ <state name="active">
+ <!--${AOs::Table::SM::active::TEST}-->+ <tran trig="TEST">
+ <tran_glyph conn="2,11,3,-1,14">
+ <action box="0,-2,11,4"/>
+ </tran_glyph>
+ </tran>
+ <!--${AOs::Table::SM::active::EAT}-->+ <tran trig="EAT">
+ <action>Q_ERROR();</action>
+ <tran_glyph conn="2,15,3,-1,14">
+ <action box="0,-2,10,4"/>
+ </tran_glyph>
+ </tran>
+ <!--${AOs::Table::SM::active::serving}-->+ <state name="serving">
+ <entry brief="give pending permissions to eat">uint8_t n;
+for (n = 0U; n < N_PHILO; ++n) { /* give permissions to eat... */+ if ((me->isHungry[n] != 0U)
+ && (me->fork[LEFT(n)] == FREE)
+ && (me->fork[n] == FREE))
+ {+ TableEvt *te;
+
+ me->fork[LEFT(n)] = USED;
+ me->fork[n] = USED;
+ te = Q_NEW(TableEvt, EAT_SIG);
+ te->philoNum = n;
+ QACTIVE_PUBLISH(&te->super, &me->super);
+ me->isHungry[n] = 0U;
+ BSP_displayPhilStat(n, "eating ");
+ }
+}</entry>
+ <!--${AOs::Table::SM::active::serving::HUNGRY}-->+ <tran trig="HUNGRY">
+ <action>uint8_t n, m;
+
+n = Q_EVT_CAST(TableEvt)->philoNum;
+/* phil ID must be in range and he must be not hungry */
+Q_ASSERT((n < N_PHILO) && (me->isHungry[n] == 0U));
+
+BSP_displayPhilStat(n, "hungry ");
+m = LEFT(n);</action>
+ <!--${AOs::Table::SM::active::serving::HUNGRY::[bothfree]}-->+ <choice>
+ <guard brief="both free">(me->fork[m] == FREE) && (me->fork[n] == FREE)</guard>
+ <action>TableEvt *pe;
+me->fork[m] = USED;
+me->fork[n] = USED;
+pe = Q_NEW(TableEvt, EAT_SIG);
+pe->philoNum = n;
+QACTIVE_PUBLISH(&pe->super, &me->super);
+BSP_displayPhilStat(n, "eating ");</action>
+ <choice_glyph conn="19,26,5,-1,10">
+ <action box="1,0,10,2"/>
+ </choice_glyph>
+ </choice>
+ <!--${AOs::Table::SM::active::serving::HUNGRY::[else]}-->+ <choice>
+ <guard>else</guard>
+ <action>me->isHungry[n] = 1U;</action>
+ <choice_glyph conn="19,26,4,-1,5,10">
+ <action box="1,5,6,2"/>
+ </choice_glyph>
+ </choice>
+ <tran_glyph conn="4,26,3,-1,15">
+ <action box="0,-2,8,2"/>
+ </tran_glyph>
+ </tran>
+ <!--${AOs::Table::SM::active::serving::DONE}-->+ <tran trig="DONE">
+ <action>uint8_t n, m;
+TableEvt *pe;
+
+n = Q_EVT_CAST(TableEvt)->philoNum;
+/* phil ID must be in range and he must be not hungry */
+Q_ASSERT((n < N_PHILO) && (me->isHungry[n] == 0U));
+
+BSP_displayPhilStat(n, "thinking");
+m = LEFT(n);
+/* both forks of Phil[n] must be used */
+Q_ASSERT((me->fork[n] == USED) && (me->fork[m] == USED));
+
+me->fork[m] = FREE;
+me->fork[n] = FREE;
+m = RIGHT(n); /* check the right neighbor */
+
+if ((me->isHungry[m] != 0U) && (me->fork[m] == FREE)) {+ me->fork[n] = USED;
+ me->fork[m] = USED;
+ me->isHungry[m] = 0U;
+ pe = Q_NEW(TableEvt, EAT_SIG);
+ pe->philoNum = m;
+ QACTIVE_PUBLISH(&pe->super, &me->super);
+ BSP_displayPhilStat(m, "eating ");
+}
+m = LEFT(n); /* check the left neighbor */
+n = LEFT(m); /* left fork of the left neighbor */
+if ((me->isHungry[m] != 0U) && (me->fork[n] == FREE)) {+ me->fork[m] = USED;
+ me->fork[n] = USED;
+ me->isHungry[m] = 0U;
+ pe = Q_NEW(TableEvt, EAT_SIG);
+ pe->philoNum = m;
+ QACTIVE_PUBLISH(&pe->super, &me->super);
+ BSP_displayPhilStat(m, "eating ");
+}</action>
+ <tran_glyph conn="4,34,3,-1,15">
+ <action box="0,-2,6,2"/>
+ </tran_glyph>
+ </tran>
+ <!--${AOs::Table::SM::active::serving::EAT}-->+ <tran trig="EAT">
+ <action>Q_ERROR();</action>
+ <tran_glyph conn="4,37,3,-1,15">
+ <action box="0,-2,12,4"/>
+ </tran_glyph>
+ </tran>
+ <!--${AOs::Table::SM::active::serving::PAUSE}-->+ <tran trig="PAUSE" target="../../3">
+ <tran_glyph conn="4,41,3,1,37,6,-3">
+ <action box="0,-2,7,2"/>
+ </tran_glyph>
+ </tran>
+ <state_glyph node="4,19,34,24">
+ <entry box="1,2,27,2"/>
+ </state_glyph>
+ </state>
+ <!--${AOs::Table::SM::active::paused}-->+ <state name="paused">
+ <entry>BSP_displayPaused(1U);</entry>
+ <exit>BSP_displayPaused(0U);</exit>
+ <!--${AOs::Table::SM::active::paused::SERVE}-->+ <tran trig="SERVE" target="../../2">
+ <tran_glyph conn="4,57,3,1,39,-20,-5">
+ <action box="0,-2,7,2"/>
+ </tran_glyph>
+ </tran>
+ <!--${AOs::Table::SM::active::paused::HUNGRY}-->+ <tran trig="HUNGRY">
+ <action>uint8_t n = Q_EVT_CAST(TableEvt)->philoNum;
+/* philo ID must be in range and he must be not hungry */
+Q_ASSERT((n < N_PHILO) && (me->isHungry[n] == 0U));
+me->isHungry[n] = 1U;
+BSP_displayPhilStat(n, "hungry ");</action>
+ <tran_glyph conn="4,60,3,-1,15">
+ <action box="0,-2,6,2"/>
+ </tran_glyph>
+ </tran>
+ <!--${AOs::Table::SM::active::paused::DONE}-->+ <tran trig="DONE">
+ <action>uint8_t n, m;
+
+n = Q_EVT_CAST(TableEvt)->philoNum;
+/* phil ID must be in range and he must be not hungry */
+Q_ASSERT((n < N_PHILO) && (me->isHungry[n] == 0U));
+
+BSP_displayPhilStat(n, "thinking");
+m = LEFT(n);
+/* both forks of Phil[n] must be used */
+Q_ASSERT((me->fork[n] == USED) && (me->fork[m] == USED));
+
+me->fork[m] = FREE;
+me->fork[n] = FREE;</action>
+ <tran_glyph conn="4,63,3,-1,15">
+ <action box="0,-2,6,2"/>
+ </tran_glyph>
+ </tran>
+ <state_glyph node="4,45,34,20">
+ <entry box="1,2,18,4"/>
+ <exit box="1,6,18,4"/>
+ </state_glyph>
+ </state>
+ <state_glyph node="2,5,43,62"/>
+ </state>
+ <state_diagram size="49,69"/>
+ </statechart>
+ </class>
+ <!--${AOs::AO_Philo[N_PHILO]}-->+ <attribute name="AO_Philo[N_PHILO]" type="QActive * const" visibility="0x00" properties="0x00">
+ <code>= { /* "opaque" pointers to Philo AO */+ &Philo_inst[0].super,
+ &Philo_inst[1].super,
+ &Philo_inst[2].super,
+ &Philo_inst[3].super,
+ &Philo_inst[4].super
+};</code>
+ </attribute>
+ <!--${AOs::AO_Table}-->+ <attribute name="AO_Table" type="QActive * const" visibility="0x00" properties="0x00">
+ <code>= &Table_inst.super; /* "opaque" pointer to Table AO */</code>
+ </attribute>
+ <!--${AOs::Philo_ctor}-->+ <operation name="Philo_ctor" type="void" visibility="0x00" properties="0x00">
+ <code>uint8_t n;
+Philo *me;
+for (n = 0U; n < N_PHILO; ++n) {+ me = &Philo_inst[n];
+ QActive_ctor(&me->super, Q_STATE_CAST(&Philo_initial));
+ QTimeEvt_ctorX(&me->timeEvt, &me->super, TIMEOUT_SIG, 0U);
+}</code>
+ </operation>
+ <!--${AOs::Table_ctor}-->+ <operation name="Table_ctor" type="void" visibility="0x00" properties="0x00">
+ <code>Table *me = &Table_inst;
+uint8_t n;
+
+QActive_ctor(&me->super, Q_STATE_CAST(&Table_initial));
+
+for (n = 0U; n < N_PHILO; ++n) {+ me->fork[n] = FREE;
+ me->isHungry[n] = 0U;
+}</code>
+ </operation>
+ </package>
+ <!--${src}-->+ <directory name="src">
+ <!--${src::dpp.h}-->+ <file name="dpp.h">
+ <text>#ifndef DPP_H
+#define DPP_H
+
+enum DPPSignals {+ EAT_SIG = Q_USER_SIG, /* published by Table to let a philosopher eat */
+ DONE_SIG, /* published by Philosopher when done eating */
+ PAUSE_SIG, /* published by BSP to pause serving forks */
+ SERVE_SIG, /* published by BSP to serve re-start serving forks */
+ TEST_SIG, /* published by BSP to test the application */
+ MAX_PUB_SIG, /* the last published signal */
+
+ HUNGRY_SIG, /* posted direclty to Table from hungry Philo */
+ TIMEOUT_SIG, /* used by Philosophers for time events */
+ MAX_SIG /* the last signal */
+};
+
+$declare(Events::TableEvt)
+
+/* number of philosophers */
+#define N_PHILO ((uint8_t)5)
+
+$declare(AOs::Philo_ctor)
+$declare(AOs::AO_Philo[N_PHILO])
+
+$declare(AOs::Table_ctor)
+$declare(AOs::AO_Table)
+
+#ifdef QXK_H
+ void Test1_ctor(void);
+ extern QXThread * const XT_Test1;
+ void Test2_ctor(void);
+ extern QXThread * const XT_Test2;
+#endif /* QXK_H */
+
+#endif /* DPP_H */
+</text>
+ </file>
+ <!--${src::philo.c}-->+ <file name="philo.c">
+ <text>#include "qpc.h"
+#include "dpp.h"
+#include "bsp.h"
+
+Q_DEFINE_THIS_FILE
+
+/* Active object class -----------------------------------------------------*/
+$declare${AOs::Philo}+
+#define THINK_TIME \
+ (QTimeEvtCtr)((BSP_random() % BSP_TICKS_PER_SEC) + (BSP_TICKS_PER_SEC/2U))
+#define EAT_TIME \
+ (QTimeEvtCtr)((BSP_random() % BSP_TICKS_PER_SEC) + BSP_TICKS_PER_SEC)
+
+/* helper macro to provide the ID of Philo "me_" */
+#define PHILO_ID(me_) ((uint8_t)((me_) - &Philo_inst[0]))
+
+$define${AOs::AO_Philo[N_PHILO]}+$define${AOs::Philo_ctor}+$define${AOs::Philo}</text>+ </file>
+ <!--${src::table.c}-->+ <file name="table.c">
+ <text>#include "qpc.h"
+#include "dpp.h"
+#include "bsp.h"
+
+Q_DEFINE_THIS_FILE
+
+/* Active object class -----------------------------------------------------*/
+$declare${AOs::Table}+
+#define RIGHT(n_) ((uint8_t)(((n_) + (N_PHILO - 1U)) % N_PHILO))
+#define LEFT(n_) ((uint8_t)(((n_) + 1U) % N_PHILO))
+#define FREE ((uint8_t)0)
+#define USED ((uint8_t)1)
+
+$define${AOs::AO_Table}+$define${AOs::Table_ctor}+$define${AOs::Table}</text>+ </file>
+ </directory>
+</model>
binary files /dev/null b/img/qp-zephyr.jpg differ
--- /dev/null
+++ b/prj.conf
@@ -1,0 +1,32 @@
+# QPC Zephyr application
+# SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-QL-commercial
+
+# need the QPC Zephyr module
+CONFIG_QPC=y
+
+CONFIG_NUM_COOP_PRIORITIES=29
+CONFIG_NUM_PREEMPT_PRIORITIES=40
+CONFIG_THREAD_NAME=y
+CONFIG_REBOOT=y
+
+# for QSPY...
+CONFIG_SERIAL=y
+CONFIG_UART_INTERRUPT_DRIVEN=y
+
+# for the OLED, etc...
+CONFIG_I2C=y
+CONFIG_DISPLAY=y
+CONFIG_SSD1306=y
+CONFIG_SSD1306_DEFAULT=y
+CONFIG_SSD1306_DEFAULT_CONTRAST=128
+CONFIG_LOG=y
+
+CONFIG_CHARACTER_FRAMEBUFFER=y
+
+CONFIG_SSD1306_REVERSE_MODE=y
+
+# LoRa:
+
+CONFIG_SPI=y
+CONFIG_LORA=y
+CONFIG_LORA_SX127X=y