systemConfig.h

Go to the documentation of this file.

/* FreeEMS - the open source engine management system
 *
 * Copyright 2012-2014 Fred Cooke
 *
 * This file is part of the FreeEMS project.
 *
 * FreeEMS software is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * FreeEMS software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with any FreeEMS software.  If not, see http://www.gnu.org/licenses/
 *
 * We ask that if you make any changes to this file you email them upstream to
 * us at admin(at)diyefi(dot)org or, even better, fork the code on github.com!
 *
 * Thank you for choosing FreeEMS to run your engine!
 */


/** @file
 *
 * @ingroup allHeaders
 * @ingroup globalHeaders
 *
 * @brief System configuration defines
 *
 * This holds various hash defined configuration constants and literals.
 */


/* Header file multiple inclusion protection courtesy eclipse Header Template    */
/* and http://gcc.gnu.org/onlinedocs/gcc-3.1.1/cpp/ C pre processor manual       */
#ifndef FILE_SYSTEM_CONFIG_H_SEEN
#define FILE_SYSTEM_CONFIG_H_SEEN


// Custom builds config setup, makes usage more clear and robust

// Vehicle IDs to avoid typos
#define DEFAULT_ID       1 // RIP original Volvo! (should have been 1)
#define TRUCK_ID         2 // Won't be in use for some time!
#define HOTEL_ID         3 // So reliable, we've not heard from him in months
#define PRESTO_ID        4 // Lost in service
#define SEANKLT1_ID      5 // Driven yearly, maybe
//efine MARCOS_ID        6 // Only idled for one minute, never since. No config available for this vehicle. http://forum.diyefi.org/viewtopic.php?f=55&t=1303
#define SNOTROCKET_ID    7 // Another one that's too reliable
#define SPUDMN_ID        8 // Occasionally comes out of the garage to race
#define SLATER_ID        9 // Occasionally comes out of the garage to do burnouts
#define PETERJSERIES_ID 10 // Winter thrasher, works so well he refuses to whinge
#define DEUCECOUPE_ID   11 // Work in progress, ignition not setup yet
#define PETERTRUCK_ID   12 // Work horse vehicle, about to get boosted
//efine PIOLIN_ID       13 // Project unlucky
//efine MIKEC383_ID     14 // Mike's 1987 383 V8 Camaro
#define SCAVENGER_ID    15 // Hacked up Miata turbo from the south!
#define DEUCES10_ID     16 // Work in progress
//efine SEANKR1_ID      17 // Sean's R1 Turbo powered desert rail
//efine HOTCAT_ID       18 // HotCat's Citroen ZX
//efine ELITH_ER12_ID   19 // Elith Racing's 2006 CBR600F engine
//efine ELITH_ER13_ID   20 // Elith Racing's 2007 CBR600RR powered FSAE car
//efine ONIONMOBILE_ID  21 // MrOnion's MK2 Golf GTI
//efine VOLVERC_ID      22 // Em-knaps' 1994 B5234T Volvo engine
//efine TOXICTACOMA_ID  23 // Jeff's 2003 Toyota Tacoma
//efine AITOR51_ID      24 // Aitor's 1992 Sierra XR4i 2.0 Turbo
//efine MATTHIJS309T_ID 25 // Matthijs' Peugeot 309 2.0 Turbo
//efine WIKISPEEDR18_ID 26 // WikiSpeed's first car with R18A1 Honda
//efine JOSHSB18MINI_ID 27 // Josh's LS-VTEC powered Mini
//efine BMSTBO_ID       28 // Piimae's E7 Corolla w/ 4A-GE 16V turbo


// Convert labels into IDs for use in code and set the ID string
#ifdef CONFIG
#warning "CONFIG variable already defined! Manual use not advised!"
#elif defined DEFAULT
#define CONFIG DEFAULT_ID
#define PRELIM_CONFIG "Default"
#elif defined TRUCK
#define CONFIG TRUCK_ID
#define PRELIM_CONFIG "TRUCK"
#elif defined HOTEL
#define CONFIG HOTEL_ID
#define PRELIM_CONFIG "HOTEL"
#elif defined PRESTO
#define CONFIG PRESTO_ID
#define PRELIM_CONFIG "PRESTO"
#elif defined SEANKLT1
#define CONFIG SEANKLT1_ID
#define PRELIM_CONFIG "SEANKLT1"
#elif defined SNOTROCKET
#define CONFIG SNOTROCKET_ID
#define PRELIM_CONFIG "SNOTROCKET"
#elif defined SPUDMN
#define CONFIG SPUDMN_ID
#define PRELIM_CONFIG "SPUDMN"
#elif defined SLATER
#define CONFIG SLATER_ID
#define PRELIM_CONFIG "SLATER"
#elif defined PETERJSERIES
#define CONFIG PETERJSERIES_ID
#define PRELIM_CONFIG "PETERJSERIES"
#elif defined DEUCECOUPE
#define CONFIG DEUCECOUPE_ID
#define PRELIM_CONFIG "DEUCECOUPE"
#elif defined PETERTRUCK
#define CONFIG PETERTRUCK_ID
#define PRELIM_CONFIG "PETERTRUCK"
#elif defined PIOLIN
#define CONFIG PIOLIN_ID
#define PRELIM_CONFIG "PIOLIN"
#elif defined MIKEC383
#define CONFIG MIKEC383_ID
#define PRELIM_CONFIG "MIKEC383"
#elif defined SCAVENGER
#define CONFIG SCAVENGER_ID
#define PRELIM_CONFIG "SCAVENGER"
#elif defined DEUCES10
#define CONFIG DEUCES10_ID
#define PRELIM_CONFIG "DEUCES10"
#elif defined SEANKR1
#define CONFIG SEANKR1_ID
#define PRELIM_CONFIG "SEANKR1"
#elif defined HOTCAT
#define CONFIG HOTCAT_ID
#define PRELIM_CONFIG "HOTCAT"
#elif defined ELITH_ER12
#define CONFIG ELITH_ER12_ID
#define PRELIM_CONFIG "ELITH_ER12"
#elif defined ELITH_ER13
#define CONFIG ELITH_ER13_ID
#define PRELIM_CONFIG "ELITH_ER13"
#elif defined ONIONMOBILE
#define CONFIG ONIONMOBILE_ID
#define PRELIM_CONFIG "ONIONMOBILE"
#elif defined VOLVERC
#define CONFIG VOLVERC_ID
#define PRELIM_CONFIG "VOLVERC"
#elif defined TOXICTACOMA
#define CONFIG TOXICTACOMA_ID
#define PRELIM_CONFIG "TOXICTACOMA"
#elif defined AITOR51
#define CONFIG AITOR51_ID
#define PRELIM_CONFIG "AITOR51"
#elif defined MATTHIJS309T
#define CONFIG MATTHIJS309T_ID
#define PRELIM_CONFIG "MATTHIJS309T"
#elif defined WIKISPEEDR18
#define CONFIG WIKISPEEDR18_ID
#define PRELIM_CONFIG "WIKISPEEDR18"
#elif defined JOSHSB18MINI
#define CONFIG JOSHSB18MINI_ID
#define PRELIM_CONFIG "JOSHSB18MINI"
#elif defined BMSTBO
#define CONFIG BMSTBO_ID
#define PRELIM_CONFIG "BMSTBO"
#elif defined CLIFLAGS && !(defined XGATE)
#error "CLIFLAGS defined, but no build matched! Not allowing config to fall back to default!"
#define CONFIG -1
#else
#define CONFIG DEFAULT_ID
#define PRELIM_CONFIG "Default"
#endif

// Ensure we didn't end up with config undefined or defined as zero
#if CONFIG == 0
#warning "CONFIG variable has value of zero, which it has without being defined, this is not allowed!"
#endif


// Make sure people know what they're getting themselves in for
#ifdef XGATE
#warning "XGATE is currently not recommended, nor thoroughly tested! Use at your own risk and without support! goo.gl/LCOMR" // Remove this line to build. See http://forum.diyefi.org/viewtopic.php?f=8&t=1700
#define BUILD_CONFIG PRELIM_CONFIG "-XGATE"

#else
#define BUILD_CONFIG PRELIM_CONFIG
#endif


// Scheduling stuff used in configuration and scheduler
#define MAX_NUMBER_OF_OUTPUT_EVENTS 24
#define ECT_CHANNELS  6    /* How many ECT channels the code should support */

/* The TX and RX buffers are slightly larger than 2k because the RX buffer */
/* needs to also receive a header, checksum and attributes for the data    */
/* involved and the TX buffer needs to handle all of those two fold.       */
#define TX_BUFFER_SIZE       0x0820 ///< 2k of data plus double maximum header overhead for echo
#define RX_BUFFER_SIZE       0x0810 ///< 2k of data plus maximum header overhead

// ADC values
#define ADC_NUMBER_OF_VALUES                1024 ///< Number of distinct values in 10 bit ADC units
#define ADC_DIVISIONS (ADC_NUMBER_OF_VALUES - 1) ///< The number of gaps between the values
#define ADC_MAX_VALUE (ADC_NUMBER_OF_VALUES - 1) ///< The highest value used in our mode


#else
    /* let us know if we are being untidy with headers */
    #warning "Header file SYSTEM_CONFIG_H seen before, sort it out!"
/* end of the wrapper ifdef from the very top */
#endif