src/inc/commsISRs.h

   1 /*      commsISRs.h
   2
   3         Copyright 2008 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 /* Header file multiple inclusion protection courtesy eclipse Header Template   */
  26 /* and http://gcc.gnu.org/onlinedocs/gcc-3.1.1/cpp/ C pre processor manual              */
  27 #ifndef FILE_COMMS_ISRS_H_SEEN
  28 #define FILE_COMMS_ISRS_H_SEEN
  29
  30 #ifdef COMMSISRS_C
  31 #define EXTERN
  32 #else
  33 #define EXTERN extern
  34 #endif
  35
  36
  37 /* SCISR1 register fields
  38  *
  39  * From left most/most significant to right most/least significant.
  40  *
  41  * Abrev  Description                                     Actions/Meaning
  42  * TRDE - Transmit Data Register Empty  - Load with more data if there is any                   - Main Flag
  43  * TC   - Transmit Complete                             - Nothing being sent and nothing loaded ready   - unused
  44  * RDRF - Receive Data Register Full    - Store data in buffer until packet complete    - Main Flag
  45  * IDLE - Idle Line                                             - Receive line is quiet                                                 - unused
  46  * OR   - Overrun                                               - Discard partial data received and increment counter
  47  * NF   - Noise Flag                                    - Discard partial data received and increment counter
  48  * FE   - Framing Error                                 - Discard partial data received and increment counter
  49  * PF   - Parity Error                                  - Discard partial data received and increment counter
  50  *
  51  * SCISR1 flag masks */
  52 #define SCISR1_TX_REGISTER_EMPTY        BIT7
  53 #define SCISR1_TX_COMPLETE                      BIT6
  54 #define SCISR1_RX_REGISTER_FULL         BIT5
  55 #define SCISR1_RX_IDLE_LINE                     BIT4
  56 #define SCISR1_RX_OVERRUN                       BIT3
  57 #define SCISR1_RX_NOISE                         BIT2
  58 #define SCISR1_RX_FRAMING                       BIT1
  59 #define SCISR1_RX_PARITY                        BIT0
  60
  61
  62 /* TX/RX state variables */
  63 EXTERN unsigned char    TXByteEscaped;
  64 EXTERN unsigned char    RXCalculatedChecksum;
  65
  66
  67 #undef EXTERN
  68
  69 #else
  70         /* let us know if we are being untidy with headers */
  71         #warning "Header file COMMS_ISRS_H seen before, sort it out!"
  72 /* end of the wrapper ifdef from the very top */
  73 #endif