diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..f206389 Binary files /dev/null and b/.DS_Store differ diff --git a/OrginalSourceRepo/.DS_Store b/OrginalSourceRepo/.DS_Store new file mode 100644 index 0000000..adcb452 Binary files /dev/null and b/OrginalSourceRepo/.DS_Store differ diff --git a/OrginalSourceRepo/OpENer-master/.clang-format b/OrginalSourceRepo/OpENer-master/.clang-format new file mode 100644 index 0000000..d2c090d --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/.clang-format @@ -0,0 +1,64 @@ +--- +# Based on the Google C++ Style Guide, with user-specific overrides. +BasedOnStyle: Google + +# --- User Overrides from Uncrustify Config --- + +# 1. Indentation +# Google Style default is 2, but we keep the explicit setting just in case. +# Uncrustify: indent_columns=2 +IndentWidth: 2 + +# 2. Tabs +# Google Style default is Never, but explicitly set here. +# Uncrustify: indent_with_tabs=0 +UseTab: Never + +# 3. Column Width +# Uncrustify: code_width=80 +ColumnLimit: 80 + +# 4. Brace Wrapping +# The Google Style default is already to attach braces to the line end +# (e.g., `if (x) { ... }`). +# Uncrustify: nl_class_brace=remove, nl_fdef_brace=remove +# We keep the default: BreakBeforeBraces: Attach + +# 5. Assignment Alignment +# This is a key deviation from the Google default, which is usually 'None'. +# Uncrustify: indent_align_assign=true +AlignConsecutiveAssignments: true + +# 6. Function Parameter Packing (Google default is to pack) +# Uncrustify: nl_func_def_args=add (Suggests placing each arg on a new line) +BinPackArguments: false +BinPackParameters: false # Applies to declarations + +# 7. Pointer Alignment +# Google Style prefers the star next to the type ('int* foo'). +# Uncrustify: sp_before_ptr_star=add (e.g. 'int * a;') +# We stick to the Google default: PointerAlignment: Left (or None, which often results in Left). +PointerAlignment: Left + +# 8. Namespace Indentation +# Google Style default is false, matching: +# Uncrustify: indent_namespace=false +IndentNamespace: false + +# 9. Case Label Indentation +# Google Style default is to indent `case` labels. +# Uncrustify: indent_switch_case=2 (Suggests indenting case labels) +IndentCaseLabels: true + +# 10. Operator Alignment +# Uncrustify: align_left_shift=true +AlignOperands: Align + +# 11. Newlines/Block Handling +# Uncrustify: mod_full_brace_if=add, mod_full_brace_for=add, etc. +# These are generally handled by Google's requirement for braces, even for single statements. +AllowShortBlocksOnASingleLine: Never +AllowShortIfStatementsOnASingleLine: Never +AllowShortCaseLabelsOnASingleLine: Never +AllowShortFunctionsOnASingleLine: Empty +... \ No newline at end of file diff --git a/OrginalSourceRepo/OpENer-master/AUTHORS b/OrginalSourceRepo/OpENer-master/AUTHORS new file mode 100644 index 0000000..c36a547 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/AUTHORS @@ -0,0 +1,4 @@ +Kurt Schweiger +Rene Smodic +Alois Zoitl +Jonathan Engdahl \ No newline at end of file diff --git a/OrginalSourceRepo/OpENer-master/README.md b/OrginalSourceRepo/OpENer-master/README.md new file mode 100644 index 0000000..b11de48 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/README.md @@ -0,0 +1,221 @@ +OpENer Version 2.3.0 +==================== + +Welcome to OpENer! +------------------ + +OpENer is an EtherNet/IP™ stack for I/O adapter devices; supports multiple +I/O and explicit connections; includes objects and services to make EtherNet/IP™- +compliant products defined in THE ETHERNET/IP SPECIFICATION and published by +ODVA (http://www.odva.org). + +Participate! +------------ +Users and developers of OpENer can join the respective Google Groups in order to exchange experience, discuss the usage of OpENer, and to suggest new features and CIP objects, which would be useful for the community. + +Developers mailing list: https://groups.google.com/forum/#!forum/eip-stack-group-opener-developers + +Users mailing list: https://groups.google.com/forum/#!forum/eip-stack-group-opener-users + +Requirements: +------------- +OpENer has been developed to be highly portable. The default version targets PCs +with a POSIX operating system and a BSD-socket network interface. To test this +version we recommend a Linux PC or Windows with Cygwin (http://www.cygwin.com) +installed. You will need to have the following installed: + +* CMake +* gcc +* make +* binutils +* the development library of libcap (libcap-dev or equivalient) + +for normal building. These should be installed on most Linux installations and +are part of the development packages of Cygwin. + +If you want to run the unit tests you will also have to download CppUTest via +https://github.com/cpputest/cpputest + +For configuring the project we recommend the use of a CMake GUI (e.g., the +cmake-gui package on Linux, or the Installer for Windows available at [CMake](https://cmake.org/)) + +Compile for Linux/POSIX: +---------------- +1. Make sure all the needed tools are available (CMake, make, gcc, binutils) +2. Change to the /bin/posix +3. For a standard configuration invoke ``setup_posix.sh`` + 1. Invoke the ``make`` command + 2. Invoking OpENer: + + ``./src/ports/POSIX/OpENer `` + + e.g. ``./src/ports/POSIX/OpENer eth1`` + +OpENer also now has a real-time capable POSIX startup via the OpENer_RT option, which requires that the used kernel has the full preemptive RT patches applied and activated. +If you want to use OpENer_RT, prior to step 2, execute ``sudo setcap cap_ipc_lock,cap_sys_nice+ep ./src/ports/POSIX/OpENer +`` to grant OpENEr ``CAP_SYS_NICE``, and the ``CAP_IPC_LOCK`` capabilities, which are needed for the RT mode + +OpENer can also be built and installed as a library by setting the CMake flag `-DOPENER_INSTALL_AS_LIB`. To build a shared library, +the global option `-DBUILD_SHARED_LIBS=ON` should also be set. It has only been tested under Linux/POSIX platform. + + +Compile for Windows XP/7/8 via Visual Studio: +--------------------------------------------- +1. Invoke setup_windows.bat or configure via CMake +2. Open Visual Studio solution OpENer.sln in bin/win32 +3. Compile OpENer by chosing ``Build All`` in Visual Studio +4. For invoking OpENer type from the command line: + 1. Change to \bin\win32\src\ports\WIN32\ + 2. Depending if you chose the ``Debug`` or ``Release`` configuration in Visual Studio, your executable will either show up in the subfolder Debug or Release + 3. Invoke OpENer via + + ``OpENer `` + + e.g. ``OpENer 3`` + +In order to get the correct interface index enter the command ``route print`` in a command promt and search for the MAC address of your chosen network interface at the beginning of the output. The leftmost number is the corresponding interface index. + +Compile for Windows XP/7/8/10 via Cygwin: +-------------------------------------- +The POSIX setup file can be reused for Cygwin. Please note, that you cannot use RT mode and you will have to remove the code responsible for checking and getting the needed capabilities, as libcap is not available in Cygwin. The easier and more supported way to build OpENer for Windows is to either use MinGW or Visual Studio. + +Compile for MinGW on Windows XP/7/8/10 +------------------------------- +1. Make sure 64 bit mingw is installed. (Test with gcc --version, should show x86_64-posix-seh-rev1) +2. Make sure CMake is installed. (Test with cmake --version, should be version 3.xx) +3. Change to /bin/mingw +4. Run the command `setup_mingw.bat` in a dos command line. (Not a bash shell). If tracing is desired, +use the following (where the cmake parameter must be enclosed in quotes) or change the ./source/CMakeList.txt file. + ``` + setup_mingw.bat "-DOpENer_TRACES:BOOL=TRUE" + ``` +5. Run the command "make" from the same directory (./bin/mingw) +6. The opener.exe is now found in \bin\mingw\src\ports\MINGW +7. Start it like this: "opener 192.168.250.22", where the ip address is the local computer's address on the nettwork you want to use. + +Directory structure: +-------------------- +- bin ... The resulting binaries and make files for different ports +- doc ... Doxygen generated documentation (has to be generated for the SVN version) and Coding rules +- data ... EDS file for the default application +- source + - src ... the production source code + - cip ... the CIP layer of the stack + - cip_objects ... additional CIP objects + - enet_encap ... the Ethernet encapsulation layer + - ports ... the platform specific code + - utils ... utility functions + - tests ... the test source code + - enet_encap ... tests for Ethernet encapsulation layer + - utils ... tests for utility functions + +Documentation: +-------------- +The documentation of the functions of OpENer is part of the source code. The source +packages contain the generated documentation in the directory doc/api_doc. If you +use the GIT version you will need the program Doxygen for generating the HTML +documentation. You can generate the documentation by invoking doxygen from the +command line in the opener main directory. + + +Fuzzing +-------------- +### Intro +Fuzzing is an automated testing method that directs varying input data to a program in +order to monitor output. It is a way to test for overall reliability as well as identify +potential security bugs. + +The fuzzer we are using is AFL, a fuzzer that uses runtime guided techniques to create input for the tested program. From a high-level prespective AFL works as follows: +- Forks the fuzzed process +- Genereates a new test case based on a predefined input +- Feeds the fuzzed process with the test case through STDIN +- Monitors the execution and registers which paths are reachable + +![Alt text](fuzz/imgs/fuzz.png "AFL Fuzzing") + +### Compile +To start fuzzing this project with AFL you'll need to compile it with AFL. +First make sure you have AFL installed: +``` +sudo apt install build-essential +wget http://lcamtuf.coredump.cx/afl/releases/afl-latest.tgz +tar xzf afl-latest.tgz +cd afl* +make && sudo make install +echo "AFL is ready at: $(which afl-fuzz)" + +``` + +Then, compile OpENer with AFL: +1. Change to the ``OpENer/bin/posix`` directory +2. Compile OpENer with AFL ``./setup_posix_fuzz_afl.sh`` +3. Run ``make`` + +### Fuzz +Finally, generate some test cases and start AFL: +``` +# Generate inputs +mkdir inputs +echo 630000000000000000000000000000000000000000000000 | xxd -r -p > ./inputs/enip_req_list_identity +# You can also use the inputs we prepared from OpENer/fuzz/inputs +# Finally, let's fuzz! +afl-fuzz -i inputs -o findings ./src/ports/POSIX/OpENer +``` + +### Reproduce a crash +Usually to reproduce a crash it's enough to retransmit the testcase using ``cat testcase | nc IP_ADDR 44818`` +However, since CIP runs over the EtherNet/IP layer, it must first register a valid session. Therefore, we need to use a dedicated script: +`python fuzz/scripts/send_testcase.py IP testcase_path` + +Running an OpENer "swarm": +-------------------------- + +1. Create a macvlan network for this purpose and tie it to the desired eth port. +Specify the IP range and use aux address to exclude the addresses used by other devices in the subnet such as the IP of the EIP scanner PC, network bridge, etc.: +docker network create -d macvlan --subnet=192.168.135.253/24 --ip-range=192.168.135.100/24 --aux-address="PC1=192.168.135.250" --aux-address="VM=192.168.135.252" --aux-address="BR=192.168.135.253" -o parent=eth2 mac_vlan_network + +Check the network you created with: docker network inspect mac_vlan_network + +The network will assign IP's to the docker containers and an external scanner will be able to communicate with them. To access the containers from inside the docker host, you will have to create a bridge. + +2. Create a Dockerfile. +This uses Ubuntu as the base image. It will copy OpENer to the image root and install the required packages. Lastly run OpENer on eth0 of the image: +#Filename: Dockerfile +FROM ubuntu:20.04 +ADD ./bin/posix/src/ports/POSIX/OpENer / +RUN apt-get update && apt-get install -y --no-install-recommends libcap-dev nmap +ENTRYPOINT ["./OpENer", "eth0"] + +3. Create a docker-compose.yml that will let you connect the macvlan network to the containers and easily build them and tear them down: +version: "3.3" +services: +dockerimagename: +network_mode: mac_vlan_network +image: dockeruser/dockerimagename + +Note that to login to a running container, you have to expose a port in the dockerfile and dockercompose files and set up a network bridge. + +Docker commands to start and stop multiple instances of the OpENer containers: +Start up 128 docker image instances: docker-compose up --scale dockerimagename=128 -d +Shut down all the instances: docker-compose down + +Porting OpENer: +--------------- +For porting OpENer to new platforms please see the porting section in the +Doxygen documentation. + +Contributing to OpENer: +----------------------- +The easiest way is to fork the repository, then create a feature/bugfix branch. +After finishing your feature/bugfix create a pull request and explain your changes. +Also, please update and/or add doxygen comments to the provided code sections. +Please stick to the coding conventions, as defined in source/doc/coding_rules +The easiest way to conform to the indenting convertion is to set uncrustify as git filter in the OpENer repository, which can be done with the following to commands: + +``` +git config filter.uncrustify.clean "/path/to/uncrustify/uncrustify -c uncrustify.cfg --mtime --no-backup" + +git config filter.uncrustify.smudge "cat" +``` + + diff --git a/OrginalSourceRepo/OpENer-master/bin/mingw/setup_mingw.bat b/OrginalSourceRepo/OpENer-master/bin/mingw/setup_mingw.bat new file mode 100644 index 0000000..31bc727 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/bin/mingw/setup_mingw.bat @@ -0,0 +1 @@ +cmake -G "MinGW Makefiles" -DCMAKE_INSTALL_PREFIX:PATH="C:/Program Files (x86)/OpENer" -DOpENer_PLATFORM:STRING="MINGW" ../../source \ No newline at end of file diff --git a/OrginalSourceRepo/OpENer-master/bin/posix/setup_posix.sh b/OrginalSourceRepo/OpENer-master/bin/posix/setup_posix.sh new file mode 100755 index 0000000..e0bbff5 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/bin/posix/setup_posix.sh @@ -0,0 +1,2 @@ +cmake -DCMAKE_C_COMPILER=gcc -DOpENer_PLATFORM:STRING="POSIX" -DCMAKE_BUILD_TYPE:STRING="" -DBUILD_SHARED_LIBS:BOOL=OFF ../../source + diff --git a/OrginalSourceRepo/OpENer-master/bin/posix/setup_posix_fuzz_afl.sh b/OrginalSourceRepo/OpENer-master/bin/posix/setup_posix_fuzz_afl.sh new file mode 100755 index 0000000..4f3a309 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/bin/posix/setup_posix_fuzz_afl.sh @@ -0,0 +1,2 @@ +cmake -DCMAKE_C_COMPILER=afl-clang-fast -DUSE_FUZZ_AFL=ON -DOpENer_PLATFORM:STRING="POSIX" -DCMAKE_BUILD_TYPE:STRING="" -DBUILD_SHARED_LIBS:BOOL=OFF ../../source + diff --git a/OrginalSourceRepo/OpENer-master/bin/win32/setup_windows.bat b/OrginalSourceRepo/OpENer-master/bin/win32/setup_windows.bat new file mode 100644 index 0000000..e79194e --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/bin/win32/setup_windows.bat @@ -0,0 +1 @@ +cmake -DCMAKE_INSTALL_PREFIX:PATH="C:/Program Files (x86)/OpENer" -DOpENer_PLATFORM:STRING="WIN32" ../../source diff --git a/OrginalSourceRepo/OpENer-master/branding/OpENer.gpl b/OrginalSourceRepo/OpENer-master/branding/OpENer.gpl new file mode 100644 index 0000000..8492470 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/branding/OpENer.gpl @@ -0,0 +1,42 @@ +GIMP Palette +Name: OpENer +Columns: 5 +# Primary and supporting colors for OpENer branding + +# Steel Blue Shades +22 58 86 Steel Blue Dark +31 78 121 Steel Blue Base +74 108 147 Steel Blue Light +123 145 176 Steel Blue Lighter +176 192 209 Steel Blue Pale + +# Teal Shades +43 127 128 Teal Dark +59 175 169 Teal Base +91 190 192 Teal Light +132 209 211 Teal Lighter +179 227 226 Teal Pale + +# Neutral Gray Shades +76 89 102 Neutral Gray Dark +107 124 140 Neutral Gray Base +136 147 160 Neutral Gray Light +163 172 184 Neutral Gray Lighter +192 200 208 Neutral Gray Pale + +# Light Gray Shades +224 227 232 Light Gray Dark +245 247 250 Light Gray Base +250 251 252 Light Gray Light +252 253 254 Light Gray Lighter +254 254 255 Light Gray Pale + +255 255 255 White + +# Amber Shades +198 143 37 Amber Dark +242 182 50 Amber Base +247 199 87 Amber Light +250 216 143 Amber Lighter +253 235 194 Amber Pale + diff --git a/OrginalSourceRepo/OpENer-master/branding/OpENer_Icon.svg b/OrginalSourceRepo/OpENer-master/branding/OpENer_Icon.svg new file mode 100644 index 0000000..e7b3d3e --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/branding/OpENer_Icon.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + + + + + + diff --git a/OrginalSourceRepo/OpENer-master/branding/OpENer_Logo.svg b/OrginalSourceRepo/OpENer-master/branding/OpENer_Logo.svg new file mode 100644 index 0000000..086d245 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/branding/OpENer_Logo.svg @@ -0,0 +1,198 @@ + + diff --git a/OrginalSourceRepo/OpENer-master/branding/license.txt b/OrginalSourceRepo/OpENer-master/branding/license.txt new file mode 100644 index 0000000..721adce --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/branding/license.txt @@ -0,0 +1,314 @@ +Creative Commons Attribution-NoDerivatives 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-NoDerivatives 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + c. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + d. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + e. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + f. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + g. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + h. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + i. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + j. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce and reproduce, but not Share, Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material, You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + For the avoidance of doubt, You do not have permission under + this Public License to Share Adapted Material. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database, provided You do not Share + Adapted Material; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. \ No newline at end of file diff --git a/OrginalSourceRepo/OpENer-master/branding/src/OpENer_Icon_src.svg b/OrginalSourceRepo/OpENer-master/branding/src/OpENer_Icon_src.svg new file mode 100644 index 0000000..bfd2250 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/branding/src/OpENer_Icon_src.svg @@ -0,0 +1,209 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/OrginalSourceRepo/OpENer-master/branding/src/OpENer_Logo_src.svg b/OrginalSourceRepo/OpENer-master/branding/src/OpENer_Logo_src.svg new file mode 100644 index 0000000..9c57bb9 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/branding/src/OpENer_Logo_src.svg @@ -0,0 +1,298 @@ + +OpENerEtherNet/IP Adapter Stack diff --git a/OrginalSourceRepo/OpENer-master/data/OpENerPC.stc b/OrginalSourceRepo/OpENer-master/data/OpENerPC.stc new file mode 100644 index 0000000..af27319 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/data/OpENerPC.stc @@ -0,0 +1,156 @@ + StcRev Data |1.25|CT17-EN|OpENerPC|1623922735| DevData |255|0|500|500|500,500|X||ENet| +[<00>]-------|OpENer PC|| + General |3.27|EtherNet/IP Vol 2, Ed 1.25||2.3|Rockwell Automation/Allen-Bradley|1|65001| + DevProfile |12|Communications Adapter|,04,05,06,07,08,09,10,11,15,16,29,30,32,33,43,55,243,244,245,246,35,67,71,72,77,84,85,86,87,69,81,68,70,82,78,79,80,83,92,256,257,258,259,260,261,262| + PhysConf ||X| |X| | | | | |0|X| | | + LEDs | | | | | | + IP MAC Set | |X| |192.168.56.101| | ||08:00:27:77:CF:56| | | | + CRate Set |X| | |X| | || + CRate Sup |X|X| |X|X| + Net Behavi | | ||| | | | | | | | + Cxn Behavi | | | |X| | | | | | ||| | |-1|1000|1000| |511| | + FO Path ||||||||||||| | + FO-IO Data | | | | | | | | | | | || | | | | | || | | | + Cfg-IO Dat |||| + Reserved || + Safety Data| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + Reserved | | + Safety IO ||||||||||||||||||||||||||||||||||| + Safety Cfg |||||||||||| | | | |||2| + Reserved | | +[<01>]-------------------------------------------------- + CAG |X|X|X| | |X|X| | | + CAS | | | | | | | | | | + CAL | | | | | | | | | | + CS |X| |X| | | | | | | | | | + CSP ||||||||||||| + IAG |X|X|X|X|X|X|X| | | | | | | | | | | | | | | | | | + IAS | | | | | | | | | | | | | | | | | | | | | | | | | + IAL | =(1)| =(12)| =(65001)| =(2.3)| | | =(OpENer PC)| | | | | | | | | | | | | | | | | | + IS |X|X|X| | | |X|X| | | | | + ISP ||0,1||||||||||| + VSA | | + OPT | | | +[<02>]-------------------------------------------------- + CAG |X|X|X| | |X|X| | | + CAS | | | | | | | | | | + CAL | | | | | | | | | | + CS |X|X| | | | | | | | | | + CSP |||||||||||| + IAG | | | | | + IAS | | | | | + IAL | | | | | + IS | |X| | | | | | | | | | | + ISP ||||||||||||| + VSA | | + OPT | | | +[<04a>]-------------------------------------------------- + CAG |X|X|X| | |X|X| | | + CAS | | | | | | | | | | + CAL | | | | | | | | | | + CS | | |X| | | | | | | | | + CSP |||||||||||| + IAG | | |X|X| | + IAS | | |X| | | + IAL | | | | | | + IS | |X|X| | | | | | | | + ISP ||||||||||| + VSA | | + OPT | | | + OPT |100| +[<04b>]-------------------------------------------------- + CAG |X|X|X| | |X|X| | | + CAS | | | | | | | | | | + CAL | | | | | | | | | | + CS | | |X| | | | | | | | | + CSP |||||||||||| + IAG | | |X|X| | + IAS | | |X| | | + IAL | | | | | | + IS | |X|X| | | | | | | | + ISP ||||||||||| + VSA | | + OPT | | | + OPT |150,152,153| +[<04d>]-------------------------------------------------- + CAG |X|X|X| | |X|X| | | + CAS | | | | | | | | | | + CAL | | | | | | | | | | + CS | | |X| | | | | | | | | + CSP |||||||||||| + IAG | | |X|X| | + IAS | | |X| | | + IAL | | | | | | + IS | |X|X| | | | | | | | + ISP ||||||||||| + VSA | | + OPT | | | + OPT |151| +[<04c>]-------------------------------------------------- + CAG |X|X|X| | |X|X| | | + CAS | | | | | | | | | | + CAL | | | | | | | | | | + CS | | |X| | | | | | | | | + CSP |||||||||||| + IAG | | |X|X| | + IAS | | |X| | | + IAL | | | | | | + IS | |X|X| | | | | | | | + ISP ||||||||||| + VSA | | + OPT | | | + OPT |154| +[<06>]-------------------------------------------------- + CAG |X|X|X| | |X|X| | | + CAS | | | | | | | | | | + CAL | | | | | | | | | | + CS |X|X| | | | | | | | | + CSP ||||||||||| + IAG | | | | | | | | | | | | | | | | | | | | + IAS | | | | | | | | | | | | | | | | | | | | + IAL | | | | | | | | | | | | | | | | | | | | + IS | | |X| |X| |X|X|X|X|X| | | | | | | | | + ISP |||||||||||||||||||| + VSA | | + OPT | | | + OPT || +[<245>]-------------------------------------------------- + CAG |X|X|X| | |X|X| | | + CAS | | | | | | | | | | + CAL | | | | | | | | | | + CS |X|X| | | | | | | | | + CSP ||||||||||| + IAG |X|X|X|X|X|X|X|X| | | |X| | | | | + IAS | | |X| | | | | | | | | | | | | | + IAL | =(1,17)| =(4)| | | | | =(1..255)| | | | | =(0..3600)| | | | | + IS |X| |X|X| | | | | | | | | | | + ISP ||||||||||||||| + VSA | | + OPT | | | +[<246>]-------------------------------------------------- + CAG |X|X|X| | |X|X| | | + CAS | | | | | | | | | | + CAL | | | | | | | | | | + CS |X|X| | | | | | | | | + CSP ||||||||||| + IAG |X|X|X| | | |X| | | |X| | | | | + IAS | | | | | | | | | | | | | | | | + IAL | =(0,10,100)| |MAC address (08:00:27:77:CF:56)| | | | | | | | | | | | | + IS |X|X| | | | | | | | | | | + ISP ||||||||||||| + VSA | | + OPT | | | +[<72>]-------------------------------------------------- + CAG |X|X|X| | |X|X| | | + CAS | | | | | | | | | | + CAL | | | | | | | | | | + CS |X|X| | | | | | | | | + CSP ||||||||||| + IAG | | | |X|X|X|X|X| + IAS | | | |X|X|X|X|X| + IAL | =(0)| =(59)| =(47)| =(55)| =(47)| =(43)| =(31)| =(27)| + IS |X|X| | | | | | | | + ISP |||||||||| + VSA | | + OPT | | | +[-------------------------------------------------------- diff --git a/OrginalSourceRepo/OpENer-master/data/opener_sample_app.eds b/OrginalSourceRepo/OpENer-master/data/opener_sample_app.eds new file mode 100644 index 0000000..a36fc25 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/data/opener_sample_app.eds @@ -0,0 +1,359 @@ +$ EZ-EDS Version 3.23.1.20171205 Generated Electronic Data Sheet + +[File] + DescText = "EDS file for the sample application of OpENer"; + CreateDate = 11-03-2009; + CreateTime = 13:15:23; + ModDate = 02-06-2018; + ModTime = 14:05:38; + Revision = 2.3; + HomeURL = "https://github.com/EIPStackGroup/OpENer"; + +[Device] + VendCode = 1; + VendName = "Rockwell Automation"; + ProdType = 12; + ProdTypeStr = "Communications Adapter"; + ProdCode = 65001; + MajRev = 2; + MinRev = 3; + ProdName = "OpENer PC"; + Catalog = "OpENer-2.x"; + +[Device Classification] + Class1 = EtherNetIP; + +[Params] + Param1 = + 0, $ reserved, shall equal 0 + ,, $ Link Path Size, Link Path + 0x0000, $ Descriptor + 0xD1, $ Data Type + 1, $ Data Size in bytes + "Input Data", $ name + "", $ units + "New Help String", $ help string + ,,0, $ min, max, default data values + ,,,, $ mult, div, base, offset scaling + ,,,, $ mult, div, base, offset links + ; $ decimal places + Param2 = + 0, $ reserved, shall equal 0 + ,, $ Link Path Size, Link Path + 0x0000, $ Descriptor + 0xD1, $ Data Type + 1, $ Data Size in bytes + "Output Data", $ name + "", $ units + "New Help String", $ help string + ,,0, $ min, max, default data values + ,,,, $ mult, div, base, offset scaling + ,,,, $ mult, div, base, offset links + ; $ decimal places + Param3 = + 0, $ reserved, shall equal 0 + ,, $ Link Path Size, Link Path + 0x0000, $ Descriptor + 0xD1, $ Data Type + 1, $ Data Size in bytes + "Config Data", $ name + "", $ units + "New Help String", $ help string + ,,0, $ min, max, default data values + ,,,, $ mult, div, base, offset scaling + ,,,, $ mult, div, base, offset links + ; $ decimal places + Param4 = + 0, $ reserved, shall equal 0 + ,, $ Link Path Size, Link Path + 0x0000, $ Descriptor + 0xC8, $ Data Type + 4, $ Data Size in bytes + "RPI", $ name + "", $ units + "New Help String", $ help string + 20000,,30000, $ min, max, default data values + ,,,, $ mult, div, base, offset scaling + ,,,, $ mult, div, base, offset links + ; $ decimal places + +[Assembly] + Object_Name = "Assembly Object"; + Object_Class_Code = 0x04; + Number_Of_Static_Instances = 6; + Assem100 = + "Input Assembly", + "", + 32, + 0x0000, + ,, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1, + 8,Param1; + Assem150 = + "Output Assembly", + "", + 32, + 0x0001, + ,, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2, + 8,Param2; + Assem151 = + "Config Assembly", + "", + 10, + 0x0001, + ,, + 8,Param3, + 8,Param3, + 8,Param3, + 8,Param3, + 8,Param3, + 8,Param3, + 8,Param3, + 8,Param3, + 8,Param3, + 8,Param3; + +[Connection Manager] + Revision = 1; + Object_Name = "Connection Manager Object"; + Object_Class_Code = 0x06; + MaxInst = 1; + Number_Of_Static_Instances = 1; + Max_Number_Of_Dynamic_Instances = 0; + Connection1 = + 0x84010002, $ 0-15 = supported transport classes + $ 16 = trigger: cyclic + $ 17 = trigger: change of state + $ 18 = trigger: application + $ 19-23 = trigger: reserved + $ 24 = transport type: listen-only + $ 25 = transport type: input-only + $ 26 = transport type: exclusive-owner + $ 27 = transport type: redundant-owner + $ 28-30 = reserved + $ 31 = Client = 0 / Server = 1 + 0x44640405, $ 0 = O->T fixed size supported + $ 1 = O->T variable size supported + $ 2 = T->O fixed size supported + $ 3 = T->O variable size supported + $ 4-5 = O->T number of bytes per slot (obsolete) + $ 6-7 = T->O number of bytes per slot (obsolete) + $ 8-10 = O->T Real time transfer format + $ 11 = reserved + $ 12-14 = T->O Real time transfer format + $ 15 = reserved + $ 16 = O->T connection type: NULL + $ 17 = O->T connection type: MULTICAST + $ 18 = O->T connection type: POINT2POINT + $ 19 = O->T connection type: reserved + $ 20 = T->O connection type: NULL + $ 21 = T->O connection type: MULTICAST + $ 22 = T->O connection type: POINT2POINT + $ 23 = T->O connection type: reserved + $ 24 = O->T priority: LOW + $ 25 = O->T priority: HIGH + $ 26 = O->T priority: SCHEDULED + $ 27 = O->T priority: reserved + $ 28 = T->O priority: LOW + $ 29 = T->O priority: HIGH + $ 30 = T->O priority: SCHEDULED + $ 31 = T->O priority: reserved + Param4,,Assem150, $ O->T RPI, size, format + Param4,,Assem100, $ T->O RPI, size, format + ,, $ config #1 size, format + ,Assem151, $ config #2 size, format + "Exlusive Owner", $ Connection Name + "", $ help string + "20 04 24 97 2C 96 2C 64"; $ Path + Connection2 = + 0x02010002, $ 0-15 = supported transport classes + $ 16 = trigger: cyclic + $ 17 = trigger: change of state + $ 18 = trigger: application + $ 19-23 = trigger: reserved + $ 24 = transport type: listen-only + $ 25 = transport type: input-only + $ 26 = transport type: exclusive-owner + $ 27 = transport type: redundant-owner + $ 28-30 = reserved + $ 31 = Client = 0 / Server = 1 + 0x44640305, $ 0 = O->T fixed size supported + $ 1 = O->T variable size supported + $ 2 = T->O fixed size supported + $ 3 = T->O variable size supported + $ 4-5 = O->T number of bytes per slot (obsolete) + $ 6-7 = T->O number of bytes per slot (obsolete) + $ 8-10 = O->T Real time transfer format + $ 11 = reserved + $ 12-14 = T->O Real time transfer format + $ 15 = reserved + $ 16 = O->T connection type: NULL + $ 17 = O->T connection type: MULTICAST + $ 18 = O->T connection type: POINT2POINT + $ 19 = O->T connection type: reserved + $ 20 = T->O connection type: NULL + $ 21 = T->O connection type: MULTICAST + $ 22 = T->O connection type: POINT2POINT + $ 23 = T->O connection type: reserved + $ 24 = O->T priority: LOW + $ 25 = O->T priority: HIGH + $ 26 = O->T priority: SCHEDULED + $ 27 = O->T priority: reserved + $ 28 = T->O priority: LOW + $ 29 = T->O priority: HIGH + $ 30 = T->O priority: SCHEDULED + $ 31 = T->O priority: reserved + Param4,0,, $ O->T RPI, size, format + Param4,32,Assem100, $ T->O RPI, size, format + ,, $ config #1 size, format + 0,, $ config #2 size, format + "Input Only", $ Connection Name + "", $ help string + "20 04 24 97 2C 98 2C 64"; $ Path + Connection3 = + 0x01010002, $ 0-15 = supported transport classes + $ 16 = trigger: cyclic + $ 17 = trigger: change of state + $ 18 = trigger: application + $ 19-23 = trigger: reserved + $ 24 = transport type: listen-only + $ 25 = transport type: input-only + $ 26 = transport type: exclusive-owner + $ 27 = transport type: redundant-owner + $ 28-30 = reserved + $ 31 = Client = 0 / Server = 1 + 0x44240305, $ 0 = O->T fixed size supported + $ 1 = O->T variable size supported + $ 2 = T->O fixed size supported + $ 3 = T->O variable size supported + $ 4-5 = O->T number of bytes per slot (obsolete) + $ 6-7 = T->O number of bytes per slot (obsolete) + $ 8-10 = O->T Real time transfer format + $ 11 = reserved + $ 12-14 = T->O Real time transfer format + $ 15 = reserved + $ 16 = O->T connection type: NULL + $ 17 = O->T connection type: MULTICAST + $ 18 = O->T connection type: POINT2POINT + $ 19 = O->T connection type: reserved + $ 20 = T->O connection type: NULL + $ 21 = T->O connection type: MULTICAST + $ 22 = T->O connection type: POINT2POINT + $ 23 = T->O connection type: reserved + $ 24 = O->T priority: LOW + $ 25 = O->T priority: HIGH + $ 26 = O->T priority: SCHEDULED + $ 27 = O->T priority: reserved + $ 28 = T->O priority: LOW + $ 29 = T->O priority: HIGH + $ 30 = T->O priority: SCHEDULED + $ 31 = T->O priority: reserved + Param4,0,, $ O->T RPI, size, format + Param4,,Assem100, $ T->O RPI, size, format + ,, $ config #1 size, format + ,, $ config #2 size, format + "Listen Only", $ Connection Name + "", $ help string + "20 04 24 97 2C 99 2C 64"; $ Path + +[Capacity] + MaxMsgConnections = 6; + MaxIOProduceConsume = 2; + MaxIOMcastProducers = 1; + MaxIOMcastConsumers = 1; + MaxConsumersPerMcast = 6; + TSpec1 = TxRx, 32, 100; + +[TCP/IP Interface Class] + Revision = 4; + Object_Name = "TCP/IP Interface Object"; + Object_Class_Code = 0xF5; + MaxInst = 1; + Number_Of_Static_Instances = 1; + Max_Number_Of_Dynamic_Instances = 0; + +[Ethernet Link Class] + Revision = 4; + Object_Name = "Ethernet Link Object"; + Object_Class_Code = 0xF6; + MaxInst = 1; + Number_Of_Static_Instances = 1; + Max_Number_Of_Dynamic_Instances = 0; + +[Identity Class] + Revision = 1; + Object_Name = "Identity Object"; + Object_Class_Code = 0x01; + MaxInst = 1; + Number_Of_Static_Instances = 1; + Max_Number_Of_Dynamic_Instances = 0; + +[QoS Class] + Revision = 1; + Object_Name = "QoS Object"; + Object_Class_Code = 0x48; + MaxInst = 1; + Number_Of_Static_Instances = 1; + Max_Number_Of_Dynamic_Instances = 0; + diff --git a/OrginalSourceRepo/OpENer-master/fuzz/imgs/fuzz.png b/OrginalSourceRepo/OpENer-master/fuzz/imgs/fuzz.png new file mode 100644 index 0000000..608af7c Binary files /dev/null and b/OrginalSourceRepo/OpENer-master/fuzz/imgs/fuzz.png differ diff --git a/OrginalSourceRepo/OpENer-master/fuzz/inputs/cip_req_forward_open b/OrginalSourceRepo/OpENer-master/fuzz/inputs/cip_req_forward_open new file mode 100644 index 0000000..51f1aba Binary files /dev/null and b/OrginalSourceRepo/OpENer-master/fuzz/inputs/cip_req_forward_open differ diff --git a/OrginalSourceRepo/OpENer-master/fuzz/inputs/cip_req_list_identity_cip b/OrginalSourceRepo/OpENer-master/fuzz/inputs/cip_req_list_identity_cip new file mode 100644 index 0000000..3d5df75 Binary files /dev/null and b/OrginalSourceRepo/OpENer-master/fuzz/inputs/cip_req_list_identity_cip differ diff --git a/OrginalSourceRepo/OpENer-master/fuzz/inputs/enip_req_list_identity b/OrginalSourceRepo/OpENer-master/fuzz/inputs/enip_req_list_identity new file mode 100644 index 0000000..fbe7839 Binary files /dev/null and b/OrginalSourceRepo/OpENer-master/fuzz/inputs/enip_req_list_identity differ diff --git a/OrginalSourceRepo/OpENer-master/fuzz/inputs/enip_req_register_session b/OrginalSourceRepo/OpENer-master/fuzz/inputs/enip_req_register_session new file mode 100644 index 0000000..168641d Binary files /dev/null and b/OrginalSourceRepo/OpENer-master/fuzz/inputs/enip_req_register_session differ diff --git a/OrginalSourceRepo/OpENer-master/fuzz/scripts/send_testcase.py b/OrginalSourceRepo/OpENer-master/fuzz/scripts/send_testcase.py new file mode 100644 index 0000000..1c1a214 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/fuzz/scripts/send_testcase.py @@ -0,0 +1,38 @@ +import sys +import socket +import struct + +if len(sys.argv) != 3: + print("python {} IP TESTCASE_PATH".format(sys.argv[0])) + sys.exit(1) + +HOST_IP = sys.argv[1] +HOST_PORT = 44818 +TESTCASE_PATH = sys.argv[2] + +ENIP_SESSION_CONTEXT = b"\x92\x83J\x0b=\x9e\x0cW" +ENIP_INIT_SESSION_PACKET = b"e\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00" + ENIP_SESSION_CONTEXT + b"\x00\x00\x00\x00\x01\x00\x00\x00" + + +print("[-] Connecting to {}:{}".format(HOST_IP, HOST_PORT)) +s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) +s.connect((HOST_IP, HOST_PORT)) + +print("[-] Init ENIP session") +s.sendall(ENIP_INIT_SESSION_PACKET) +enip_session = s.recv(1024) +session_handle = enip_session[4:8] +print("[-] Got ENIP Session Handle: {}".format(struct.unpack(" + #include + #include +- ++#include + + + #define FreeRTOS +@@ -99,6 +99,15 @@ void _exit (int status) + while (1) {} + } + ++#if REDIRECT_PRINTF_TO_SWV_ITM ++__attribute__((weak)) int _write(int file, char *ptr, int len) { ++ int DataIdx; ++ for (DataIdx = 0; DataIdx < len; DataIdx++) { ++ ITM_SendChar(*ptr++); ++ } ++ return len; ++} ++#else // standard output + int _write(int file, char *ptr, int len) + { + int DataIdx; +@@ -109,6 +118,7 @@ int _write(int file, char *ptr, int len) + } + return len; + } ++#endif // standard output + + int _close(int file) + { +diff --git a/Src/app_ethernet.c b/Src/app_ethernet.c +index e3278ac..aab6265 100644 +--- a/Src/app_ethernet.c ++++ b/Src/app_ethernet.c +@@ -28,6 +28,9 @@ + #include "lcd_log.h" + #endif + ++// for OpENer ++#include "opener.h" ++ + /* Private typedef -----------------------------------------------------------*/ + /* Private define ------------------------------------------------------------*/ + /* Private macro -------------------------------------------------------------*/ +@@ -55,6 +58,8 @@ void ethernet_link_status_updated(struct netif *netif) + uint8_t iptxt[20]; + sprintf((char *)iptxt, "%s", ip4addr_ntoa(netif_ip4_addr(netif))); + LCD_UsrLog ("Static IP address: %s\n", iptxt); ++ /* Start Ethernet/IP Stack (OpENer) */ ++ opener_init(netif); + #else + BSP_LED_On(LED1); + BSP_LED_Off(LED2); +@@ -124,6 +129,8 @@ void DHCP_Thread(void const * argument) + BSP_LED_On(LED1); + BSP_LED_Off(LED2); + #endif ++ /* Start Ethernet/IP Stack (OpENer) */ ++ opener_init(netif); + } + else + { +@@ -148,6 +155,8 @@ void DHCP_Thread(void const * argument) + BSP_LED_On(LED1); + BSP_LED_Off(LED2); + #endif ++ /* Start Ethernet/IP Stack (OpENer) */ ++ opener_init(netif); + } + } + } +diff --git a/Src/main.c b/Src/main.c +index c25dbd0..e3dda6c 100644 +--- a/Src/main.c ++++ b/Src/main.c +@@ -71,6 +71,11 @@ int main(void) + /* Configure the system clock to 200 MHz */ + SystemClock_Config(); + ++ /* For single step debug, e.g. timers with interrupts need to be stopped in Halt */ ++ HAL_DBGMCU_EnableDBGStandbyMode(); ++ HAL_DBGMCU_EnableDBGStopMode(); ++ __HAL_DBGMCU_FREEZE_TIM6(); ++ + /* Initialize LCD and LEDs */ + BSP_Config(); + +@@ -139,6 +144,8 @@ static void Netif_Config(void) + + /* Registers the default network interface. */ + netif_set_default(&gnetif); ++ /* Define the hostname, is also used by OpENer */ ++ netif_set_hostname(&gnetif,"STM32"); + + ethernet_link_status_updated(&gnetif); + +@@ -180,7 +187,7 @@ static void BSP_Config(void) + LCD_LOG_Init(); + + /* Show Header and Footer texts */ +- LCD_LOG_SetHeader((uint8_t *)"Webserver Application Netconn API"); ++ LCD_LOG_SetHeader((uint8_t *)"Webserver Application Netconn API & OpENer"); + LCD_LOG_SetFooter((uint8_t *)"STM32746G-DISCO board"); + + LCD_UsrLog ((char *)" State: Ethernet Initialization ...\n"); diff --git a/OrginalSourceRepo/OpENer-master/source/doc/STM32/OpENer STM32 Paths and Symbols.xml b/OrginalSourceRepo/OpENer-master/source/doc/STM32/OpENer STM32 Paths and Symbols.xml new file mode 100644 index 0000000..5321aa5 --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/source/doc/STM32/OpENer STM32 Paths and Symbols.xml @@ -0,0 +1,86 @@ + + +
+ + + ../../Inc + ../../Src + ../../Drivers/CMSIS/Device/ST/STM32F7xx/Include + ../../Drivers/STM32F7xx_HAL_Driver/Inc + ../../Drivers/BSP/STM32746G-Discovery + ../../Drivers/BSP/Components/Common + ../../Drivers/BSP/Components + ../../Middlewares/Third_Party/LwIP/src/include + ../../Middlewares/Third_Party/LwIP/system + ../../Middlewares/Third_Party/FreeRTOS/Source/portable/GCC/ARM_CM7/r0p1 + ../../Middlewares/Third_Party/FreeRTOS/Source + ../../Middlewares/Third_Party/FreeRTOS/Source/CMSIS_RTOS + ../../Middlewares/Third_Party/FreeRTOS/Source/include + ../../Utilities + ../../Utilities/Log + ../../Drivers/CMSIS/Include + ../../Middlewares/Third_Party/OpENer + ../../Middlewares/Third_Party/OpENer/cip + ../../Middlewares/Third_Party/OpENer/enet_encap + ../../Middlewares/Third_Party/OpENer/ports + ../../Middlewares/Third_Party/OpENer/ports/STM32 + ../../Middlewares/Third_Party/OpENer/ports/STM32/sample_application + ../../Middlewares/Third_Party/OpENer/utils + + +
+
+ + + + USE_HAL_DRIVER + + + + STM32F746xx + + + + USE_STM32746G_DISCOVERY + + + + RESTRICT + __restrict + + + STM32 + + + + _POSIX_C_SOURCE + 200112L + + + _GNU_SOURCE + + + + OPENER_TRACE_LEVEL + 15 + + + OPENER_CONSUMED_DATA_HAS_RUN_IDLE_HEADER + 1 + + + OPENER_WITH_TRACES + 1 + + + PC_OPENER_ETHERNET_BUFFER_SIZE + 512 + + + REDIRECT_PRINTF_TO_SWV_ITM + 1 + + + +
+ diff --git a/OrginalSourceRepo/OpENer-master/source/doc/STM32/OpENer STM32 Port.pdf b/OrginalSourceRepo/OpENer-master/source/doc/STM32/OpENer STM32 Port.pdf new file mode 100644 index 0000000..e8b0ec5 Binary files /dev/null and b/OrginalSourceRepo/OpENer-master/source/doc/STM32/OpENer STM32 Port.pdf differ diff --git a/OrginalSourceRepo/OpENer-master/source/doc/coding_rules/opener_coding_rules.pdf b/OrginalSourceRepo/OpENer-master/source/doc/coding_rules/opener_coding_rules.pdf new file mode 100644 index 0000000..2ae9b8e Binary files /dev/null and b/OrginalSourceRepo/OpENer-master/source/doc/coding_rules/opener_coding_rules.pdf differ diff --git a/OrginalSourceRepo/OpENer-master/source/doc/coding_rules/src/opener_coding_rules.tex b/OrginalSourceRepo/OpENer-master/source/doc/coding_rules/src/opener_coding_rules.tex new file mode 100644 index 0000000..e1d177b --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/source/doc/coding_rules/src/opener_coding_rules.tex @@ -0,0 +1,309 @@ +\documentclass[final,a4paper,10pt, oneside]{article} +\usepackage[latin1]{inputenc} +\usepackage[T1]{fontenc} + +\usepackage{a4wide} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%% important definitions at the beginning +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +\title{Coding Rules for\\ \emph{OpENer} --- Open Source EtherNet/IP$^{TM}$ Adapter Stack\\\large Version 2.0} +\author{Martin Melik Merkumians\thanks{melik-merkumians\@@acin.tuwien.ac.at}} +\date{2015-11-15} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +% Links +\usepackage{ifpdf} +\ifpdf + \usepackage[pdftex, colorlinks, pdfstartview=FitH, plainpages=false, pdfpagelabels]{hyperref} + \pdfcompresslevel=9 +\else + \usepackage[dvipdfm, colorlinks]{hyperref} +\fi + +\hypersetup{colorlinks, linkcolor=black, filecolor=black, urlcolor=black, citecolor=black, pdftitle={Coding Rules for OpENer},pdfauthor={Alois Zoitl}} + +% Font +\usepackage{mathpazo} + +\usepackage[centerlast,small,bf]{caption} %zentriert, kleiner als fliesstext, fett (gilt nur fuer 'Abbildung x:') + +% Figures +\usepackage[dvips]{graphicx} + +% Listings +\usepackage{listings} +\lstset{language=C++} +\lstset{commentstyle=\textit} +\lstset{linewidth=\textwidth} +\lstset{basicstyle=\scriptsize} + +\usepackage{fancyref} +\usepackage{hyperref} + + + +\begin{document} + +\maketitle + +\tableofcontents + +\section{Introduction} +This document describes the coding rules, which has to be used in the OpENer project. These rules are mainly the Google C++ style rules, with some extensions specific to C and the OpENer project. If something is not covered by the rules given in this document, please check the official Google C++ style guide, available at \url{http://google.github.io/styleguide/cppguide.html}. Additional code style examples can be found at \url{https://gist.github.com/davidzchen/9187878}. + +As the OpENer code style aims to be as close as possible to the established Google C++ code style, please file an issue if anything in this guide contradicts the Google C++ code style. + +\section{Comments} +A sufficient amount of comments has to be written. There are never too many comments, whereas invalid comments are worse than none --- thus invalid comments have to be removed from the source code. Comments have to be written in English. + + +Comments for function, structure, \ldots~ definitions have to follow the conventions of \emph{Doxygen} to allow the automated generation of documentation for the source code. Hereby Java-style Doxygen comments shall be used. Doxygen comments shall therefore start with slash and two starts, and use the @ symbol to indicate Doxygen keywords. For enums, variables, and strucutres inline documentation with \emph{/**<} shall be used. Autobrief behavior shall not be assumed for Doxygen comments. See the example below. +\begin{lstlisting}[frame=trbl]{} +/** @brief function, structure, enum, etc. to comment + * + * Detailed explanation, spanning multiple lines if needed. + * @param parameter1 Parameter1 description + * @return Return value description + */ +int foo(char bar) { + ... +} + +const int g_kFooBar = 1; /**< Global constant which needs documentation */ + +\end{lstlisting} + +Comments have to be meaningful, to describe to program and to be up to date. + + +\subsection{Fileheaders} +Every source-file must contain a fileheader as follows: +\begin{lstlisting}[frame=trbl]{} +/******************************************************************************* + * Copyright (c) 2009, Rockwell Automation, Inc. + * All rights reserved. + * + * Contributors: + * : , - changes + ******************************************************************************/ +\end{lstlisting} +Each author needs to explain his changes in the code. +\subsection{Revision History} +%To track changes in the source files every new file version must contain it's version information in the following form: +%\begin{center} +% @version: $<$date$>$/$<$author$>$: $<$description$>$ +%\end{center} +%An additional example is given in the appendix \ref{subsec:FileHeader} of this document. +The revision history has to be done in a style usable by Doxygen. This means that the history is independent of the files, but all classes are documented. + +\subsection{Keywords} +The following Keywords should be used in the source code to mark special comments: +\begin{itemize} + \item \textbf{TODO:} For comments about possible or needed extensions + \item \textbf{FIXME:} To be used for comments about potential (or known) bugs +\end{itemize} + +\section{Datatypes} +\Fref{tab:datatypes} contains the definitions of important standard datatypes. This is done to ensure a machine independant defintion of the bit-width of the standard data types. For \emph{OpENer}-development these definitions are in the file: \verb|src/typedefs.h| + +\begin{table}[h] +\caption{Data types used in OpENer} \label{tab:datatypes} + \centering + \begin{tabular}{lll} + defined data type & bit-width / description & used C-datatype \\ + \hline + EipByte & 8 bit unsigned & uint8\_t\\ + EipInt8 & 8 bit signed & int8\_t \\ + EipInt16 & 16 bit signed & int16\_t \\ + EipInt32 & 32 bit signed & int32\_t \\ + EipInt64 & 64 bit signed & int64\_t \\ + EipUint8 & 8 bit unsigned & uint8\_t \\ + EipUint16 & 16 bit unsigned & uint16\_t \\ + EipUint32 & 32 bit unsigned & uint32\_t \\ + EipUint64 & 64 bit unsigned & uint64\_t \\ + EipFloat & single precission IEEE float (32 bit) & float \\ + EipDfloat & double precission IEEE float (64 bit) & double \\ + EipBool8 & byte variable as boolean value & unit8\_t \\ + + CipOctet & unspecified type & uint8\_t \\ + CipBool & byte variable as boolean value & uint8\_t \\ + CipByte & 8 bit unsigned & uint8\_t \\ + CipWord & 16 bit unsigned & uint16\_t \\ + CipDword & 32 bit unsigned & uint32\_t \\ + CipUsint & 8 bit unsigned & uint8\_t \\ + CipUint & 16 bit unsigned & uint16\_t \\ + CipUdint & 32 bit unsigned & uint32\_t \\ + CipSint & 8 bit signed & int8\_t \\ + CipInt & 16 bit signed & int16\_t \\ + CipDint & 32 bit signed & int32\_t \\ + CipReal & single precission IEEE float (32 bit) & float \\ + CipLreal & double precission IEEE float (64 bit) & double \\ + + CipLint & 64 bit signed & int64\_t \\ + CipUlint & 64 bit unsigned & uint64\_t \\ + CipLword & 64 bit unsigned & uint64\_t + \end{tabular} +\end{table} + +These data types shall only be used when the bit size is important for the correct operation of the code, whereby Eip-prefixed data types shall be used for communication functions, and Cip-prefixed data types shall be used for CIP related functions and objects. If not we advice to use the type \verb|int| or \verb|unsigned int| for most variables, as this is the most efficient data type and can lead on some platforms (e.g., ARM) even to smaller code size. + +\section{Naming of Identifiers} +Every identifier has to be named in English. The first character of an identifier must not contain underscores (there are some compiler directives which start with underscores and this could lead to conflicts). Mixed case letters has to be used and the appropriate prefixes have to be inserted where necessary. + +\subsection{Pre- \& Postfixes} +The following prefixes have to be applied to identifiers:\\ +\begin{itemize} + \item \emph{"g\_"} shall be prefixed for global variables. + \item \emph{"\_"} shall be postfixed for member variables. These are usually CIP object variables with file-global scope. +\end{itemize} + +\subsection{Variables} +Variables have to be named self explanatory. The names have to be provided with the appropriate pre- or postfix and shall be all lowercase letters, and if a name consists of more than one word underscores shall be used for separating these words. The only exception are loop variables (thereby the use of i, j, k is allowed). Only one variable declaration per line is allowed. Pointer operators at the declaration have to be located in front of the variable (not after the type identifier). If possible initializations have to be done directly at the declaration. + +\paragraph{Examples} +\begin{quote} +\begin{lstlisting} +int i; +int local_variable; +CipBool boolean_flag_in_cip_object_; +\end{lstlisting} +\end{quote} + +\subsection{Constants} +The preferred way to declare constants is to define them as\emph{const} data types, if this is not possible constants shall be defined as pre-processor statements, via \emph{\#define}. +If constants are defined as C constants the name of the constant shall start with \emph{k}, followed by the constant name in Pascal case. +If a constant is defined as a pre-processor statement the constant name shall be all upper case, separating multiple words with underscored. +Avoid the using ``magic numbers'' (e.g. \verb|if (x == 3){...}|). Instead use constants. + +\paragraph{Examples} +\begin{quote} +\begin{lstlisting} +static int g_global_variable; +static const int g_kAGlobalConstant = 73: +const int kAnImportantConstant = 42; +#define DO_NOT_DO_THIS_IF_IT_IS_NOT_NECESSARY bad +\end{lstlisting} +\end{quote} + +\subsection{Functions} +Functions names shall be Pascal cased, function parameters shall be named like variables. The parameter list shall adhere to the following rules: +\begin{itemize} + \item Input parameters shall come first + \item Input parameters shall be const + \item Output parameters shall be last +\end{itemize} + +\paragraph{Examples} +\begin{quote} +\begin{lstlisting} +int FooBar(const int foo, const char* const bar, double* additional_return_value) +\end{lstlisting} +\end{quote} + +\subsection{Structs} +The default case for structs shall be, that they are defined as anonymous structs, giving them a type name via the \emph{typedef} keyword. Struct names shall be pascal cased. If a struct type is needed, before a typedef alias can be created (usually inside the same struct), the struct name shall be repeated in the struct type name, following the conventions for variable names, with all lowercase and words separated with underscores. + +The element names inside the struct are following the normal conventions for their types. + +\paragraph{Examples} +\begin{quote} +\begin{lstlisting} +typedef struct { + int foo; + char bar; +} TheDefaultCase; + +typedef the_excpetion { + struct the_exection *needed_the_struct_definition_already_here; + char other_elements; +} TheException; +\end{lstlisting} +\end{quote} + +\subsection{Enums} +Enums shall be defined anonymous and typedef'ed to a type name. As the values inside an enum are constant, the naming scheme of constants apply for enum members. As Enums do not define their own namespace, the enum type name shall be added between the initial \emph{k} and the constant name. + +\paragraph{Examples} +\begin{quote} +\begin{lstlisting} +typedef enum { + kImportantEnumConstant1 = 0, + kImportantEnumConstant2 = 1 +} ImportantEnum; +\end{lstlisting} +\end{quote} + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\section{Code Formatting} +In order to have consistent code formating the Google C++ coding style rules shall apply. When using Eclipse as development environment the coding format xml file is available at \url{https://github.com/google/styleguide}. By pressing \verb|f| the formatter will format the code according to these rules. + + +\section{Assertions} +The \lstinline!OPENER_ASSERT(e)! macro is available for traditional +assertion checks, halting the program if the expression provided as the +argument \lstinline!e! evaluates false. This macro shall \emph{only} be used +to test conditions where the only possible cause of failure is an +unquestionable bug with this program, typically leading to undefined behavior +or a crash if execution were permitted to continue. +In other words, an assertion shall \emph{never} fail +as a result of any external input, valid or invalid, +or other similar foreseeable condition, such as a memory allocation failure. +These latter type of failures must be handled by normal code execution paths +that yield responses with appropriate error codes or possibly +terminating the program with a non-zero exit code, not an assertion failure. + +The following listing of a function to set an attribute's value based +on received data is an example to help illustrate proper use of assertions. +The \lstinline!raw! and \lstinline!len! parameters +refer to the received data and length, and the \lstinline!foo! parameter +points to the target attribute; the function returns true only if the attribute +was set successfully. + +\begin{quote} +\begin{lstlisting} + bool SetAttributeFoo(const void *raw, size_t len, CipDint *foo) { + + /* + * This function should never be called with NULL pointers, regardless of + * what was received over the network, so assertions should be used to + * validate the pointer arguments. + */ + OPENER_ASSERT(NULL != raw); + OPENER_ASSERT(NULL != foo); + + /* + * Ensuring enough data was received to satisfy the target data type + * must not be done with an assertion as a malformed message containing + * insufficient data shall not halt the program. + */ + if (sizeof(CipDint) > len) { + return false; + } + + CipDint new_value = &(int *)raw; + + /* + * Here the received value is tested for conformance to acceptable values; + * assume for the sake of this example that allowable values are nonzero. + * Validating values received from external sources must not be done + * with assertions. + */ + if (0 == new_value) { + return false; + } + + *foo = new_value; + return true; + } +\end{lstlisting} +\end{quote} + +\end{document} diff --git a/OrginalSourceRepo/OpENer-master/source/doc/opener.bib b/OrginalSourceRepo/OpENer-master/source/doc/opener.bib new file mode 100644 index 0000000..e1b3c1e --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/source/doc/opener.bib @@ -0,0 +1,18 @@ +@book{CipVol1, +series = "The CIP Networks Library", +title = "Common {I}ndustrial {P}rotocol", +volume = "1", +edition = "3.3", +month = "November", +year = "2007" +} + + +@book{CipVol2, +series = "The CIP Networks Library", +title = "Ether{N}et/{IP} {A}daptation of {CIP}", +volume = "2", +edition = "1.4", +month = "November", +year = "2007" +} diff --git a/OrginalSourceRepo/OpENer-master/source/opener.doxyfile.in b/OrginalSourceRepo/OpENer-master/source/opener.doxyfile.in new file mode 100644 index 0000000..465437e --- /dev/null +++ b/OrginalSourceRepo/OpENer-master/source/opener.doxyfile.in @@ -0,0 +1,2381 @@ +# Doxyfile 1.8.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "OpENer - Open Source EtherNet/IP(TM) I/O Target Stack" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = @OpENer_Device_Major_Version@.@OpENer_Device_Minor_Version@ + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = @OpENer_BINARY_DIR@/api_doc + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = YES + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# 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. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = @OpENer_SOURCE_DIR@/../.. + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# 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 +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# 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. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# 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, +# C#, C, C++, D, PHP, Objective-C, Python, 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), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# 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. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# 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 +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = YES + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: 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 +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# 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. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = YES + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = YES + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# 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. +# +# 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 +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = @OpENer_SOURCE_DIR@/doc/opener.bib + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: 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. +# The default value is: YES. + +WARN_IF_DOC_ERROR = 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. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = @OpENer_SOURCE_DIR@/src @PROJECT_BINARY_DIR@/src/ports/devicedata.h + +# 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: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. 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, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +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 +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# 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 = */.deps @OpENer_EXCLUDE_PATTERNS@ + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = @OpENer_SOURCE_DIR@ + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: 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 +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what 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. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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 +# http://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. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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 +# 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. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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: http://developer.apple.com/tools/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 http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +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: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# 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 +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +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: http://qt-project.org/doc/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. + +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: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +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: http://qt-project.org/doc/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: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +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. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# 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. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# 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. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# 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 http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# 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 +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /