src/inc/utils.h

   1 /*      Copyright 2008 Fred Cooke
   2
   3         This file is part of the FreeEMS project.
   4
   5         FreeEMS software is free software: you can redistribute it and/or modify
   6         it under the terms of the GNU General Public License as published by
   7         the Free Software Foundation, either version 3 of the License, or
   8         (at your option) any later version.
   9
  10         FreeEMS software is distributed in the hope that it will be useful,
  11         but WITHOUT ANY WARRANTY; without even the implied warranty of
  12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13         GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with any FreeEMS software.  If not, see http://www.gnu.org/licenses/
  17
  18         We ask that if you make any changes to this file you email them upstream to
  19         us at admin(at)diyefi(dot)org or, even better, fork the code on github.com!
  20
  21         Thank you for choosing FreeEMS to run your engine! */
  22
  23
  24 /**     @file utils.h
  25  * @ingroup allHeaders
  26  */
  27
  28
  29 /* Header file multiple inclusion protection courtesy eclipse Header Template   */
  30 /* and http://gcc.gnu.org/onlinedocs/gcc-3.1.1/cpp/ C pre processor manual              */
  31 #ifndef FILE_UTILS_H_SEEN
  32 #define FILE_UTILS_H_SEEN
  33
  34
  35 #ifdef EXTERN
  36 #warning "EXTERN already defined by another header, please sort it out!"
  37 #undef EXTERN /* If fail on warning is off, remove the definition such that we can redefine correctly. */
  38 #endif
  39
  40
  41 #ifdef UTILS_C
  42 #define EXTERN
  43 #else
  44 #define EXTERN extern
  45 #endif
  46
  47
  48 EXTERN void sleep(unsigned short) FPAGE_FE;
  49 EXTERN void sleepMicro(unsigned short) FPAGE_FE;
  50
  51 EXTERN void adjustPWM(void) FPAGE_FE;
  52 EXTERN void setupPagedRAM(unsigned char) FPAGE_F8;
  53 EXTERN void resetToNonRunningState(void) FPAGE_F8;
  54
  55 EXTERN void sampleEachADC(ADCArray*) FPAGE_F8;
  56 EXTERN void sampleBlockADC(ADCArray*) FPAGE_F8;
  57
  58 EXTERN unsigned char checksum(unsigned char *, unsigned short) FPAGE_F8;
  59 EXTERN unsigned short stringCopy(unsigned char*, unsigned char*) FPAGE_F8;
  60
  61
  62 #undef EXTERN
  63
  64
  65 #else
  66         /* let us know if we are being untidy with headers */
  67         #warning "Header file UTILS_H seen before, sort it out!"
  68 /* end of the wrapper ifdef from the very top */
  69 #endif