src/main/doxy/directories.h

   1 /* FreeEMS - the open source engine management system
   2  *
   3  * Copyright 2014 Fred Cooke
   4  *
   5  * This file is part of the FreeEMS project.
   6  *
   7  * FreeEMS software is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * FreeEMS software is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with any FreeEMS software.  If not, see http://www.gnu.org/licenses/
  19  *
  20  * We ask that if you make any changes to this file you email them upstream to
  21  * us at admin(at)diyefi(dot)org or, even better, fork the code on github.com!
  22  *
  23  * Thank you for choosing FreeEMS to run your engine!
  24  */
  25
  26
  27 /** @file directories.h
  28  *
  29  * @ingroup doxygenDocFiles
  30  * @brief Doxygen directory documentation definitions
  31  */
  32
  33
  34 /** @dir src/main
  35  *
  36  * The home of all source files used to build FreeEMS firmware. Groups of related
  37  * files are stored in sub-directories within this directory and general files
  38  * such as main.c and init.c etc are stored at this level.
  39  */
  40
  41
  42 /** @dir src/main/assemblyhand
  43  *
  44  * The very small amount of hand-written S12X assembly used in the project lives
  45  * here. All assembly files generated during the build process live in a temporary
  46  * directory called assembly.
  47  */
  48
  49
  50 /** @dir src/main/assemblyxgate
  51  *
  52  * Assembly source files for the XGATE coprocessor are stored in this directory.
  53  * All XGATE assembly source files are hand written as it does not make sense to
  54  * use a C compiler to generate code for this device.
  55  */
  56
  57
  58 /** @dir src/main/data
  59  *
  60  * This directory contains no actual code, just data used to initialise various
  61  * blocks of memory such as structs and arrays etc. These files get pulled into
  62  * files in src/initialisers/ and built into data objects.
  63  */
  64
  65
  66 /** @dir src/main/data/tables
  67  *
  68  * This directory contains the various data components that make up tables.
  69  */
  70
  71
  72 /** @dir src/main/data/tables/axis
  73  *
  74  * This directory has the axis data for the RPM and Load axes in it.
  75  */
  76
  77
  78 /** @dir src/main/data/tables/ign
  79  *
  80  * This directory has the ignition timing table data in it.
  81  */
  82
  83
  84 /** @dir src/main/data/tables/lambda
  85  *
  86  * This directory has the integral lambda table data in it.
  87  */
  88
  89
  90 /** @dir src/main/data/tables/ve
  91  *
  92  * This directory has the volumetric efficiency table data in it.
  93  */
  94
  95
  96 /** @dir src/main/data/thermistors
  97  *
  98  * This directory contains a library of data files for common combinations of
  99  * bias resistor and thermistors for three main types of sensor and six commonly
 100  * used resistor values.
 101  */
 102
 103
 104 /** @dir src/main/decoders
 105  *
 106  * The RPM/position decoder directory contains ISR code for various types of RPM
 107  * and position sensor combinations. Buildable files can be found at this level.
 108  * Files that are included into buildable files are found in sub-directories.
 109  */
 110
 111
 112 /** @dir src/main/decoders/code
 113  *
 114  * Code that is re-used across multiple build configurations lives here.
 115  */
 116
 117
 118 /** @dir src/main/decoders/inc
 119  *
 120  * Header files for decoder ISRs are stored here, whether one-off or re-used.
 121  */
 122
 123
 124 /** @dir src/main/doxy
 125  *
 126  * Files such as the source of this directory documentation which are purely
 127  * present for Doxygen to parse and display are stored here.
 128  */
 129
 130
 131 /** @dir src/main/inc
 132  *
 133  * Normal header files of global or single file use nature live here.
 134  */
 135
 136
 137 /** @dir src/main/initialisers
 138  *
 139  * Files that are purely data initialisers and contain no logic code live here.
 140  */