begriffs open source - cmsis-freertos/blob - Demo/CORTEX_LM3S811_KEIL/LuminaryCode/src/comp.h

   1 //*****************************************************************************
   2 //
   3 // comp.h - Prototypes for the analog comparator driver.
   4 //
   5 // Copyright (c) 2005,2006 Luminary Micro, Inc.  All rights reserved.
   6 //
   7 // Software License Agreement
   8 //
   9 // Luminary Micro, Inc. (LMI) is supplying this software for use solely and
  10 // exclusively on LMI's Stellaris Family of microcontroller products.
  11 //
  12 // The software is owned by LMI and/or its suppliers, and is protected under
  13 // applicable copyright laws.  All rights are reserved.  Any use in violation
  14 // of the foregoing restrictions may subject the user to criminal sanctions
  15 // under applicable laws, as well as to civil liability for the breach of the
  16 // terms and conditions of this license.
  17 //
  18 // THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
  19 // OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
  20 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
  21 // LMI SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
  22 // CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
  23 //
  24 // This is part of revision 816 of the Stellaris Driver Library.
  25 //
  26 //*****************************************************************************
  27
  28 #ifndef __COMP_H__
  29 #define __COMP_H__
  30
  31 #ifdef __cplusplus
  32 extern "C"
  33 {
  34 #endif
  35
  36 //*****************************************************************************
  37 //
  38 // Values that can be passed to ComparatorConfigure() as the ulConfig
  39 // parameter.  For each group (i.e. COMP_TRIG_xxx, COMP_INT_xxx, etc.), one of
  40 // the values may be selected and ORed together will values from the other
  41 // groups.
  42 //
  43 //*****************************************************************************
  44 #define COMP_TRIG_NONE          0x00000000  // No ADC trigger
  45 #define COMP_TRIG_HIGH          0x00000880  // Trigger when high
  46 #define COMP_TRIG_LOW           0x00000800  // Trigger when low
  47 #define COMP_TRIG_FALL          0x00000820  // Trigger on falling edge
  48 #define COMP_TRIG_RISE          0x00000840  // Trigger on rising edge
  49 #define COMP_TRIG_BOTH          0x00000860  // Trigger on both edges
  50 #define COMP_INT_HIGH           0x00000010  // Interrupt when high
  51 #define COMP_INT_LOW            0x00000000  // Interrupt when low
  52 #define COMP_INT_FALL           0x00000004  // Interrupt on falling edge
  53 #define COMP_INT_RISE           0x00000008  // Interrupt on rising edge
  54 #define COMP_INT_BOTH           0x0000000C  // Interrupt on both edges
  55 #define COMP_ASRCP_PIN          0x00000000  // Dedicated Comp+ pin
  56 #define COMP_ASRCP_PIN0         0x00000200  // Comp0+ pin
  57 #define COMP_ASRCP_REF          0x00000400  // Internal voltage reference
  58 #define COMP_OUTPUT_NONE        0x00000000  // No comparator output
  59 #define COMP_OUTPUT_NORMAL      0x00000100  // Comparator output normal
  60 #define COMP_OUTPUT_INVERT      0x00000102  // Comparator output inverted
  61
  62 //*****************************************************************************
  63 //
  64 // Values that can be passed to ComparatorSetRef() as the ulRef parameter.
  65 //
  66 //*****************************************************************************
  67 #define COMP_REF_OFF            0x00000000  // Turn off the internal reference
  68 #define COMP_REF_0V             0x00000300  // Internal reference of 0V
  69 #define COMP_REF_0_1375V        0x00000301  // Internal reference of 0.1375V
  70 #define COMP_REF_0_275V         0x00000302  // Internal reference of 0.275V
  71 #define COMP_REF_0_4125V        0x00000303  // Internal reference of 0.4125V
  72 #define COMP_REF_0_55V          0x00000304  // Internal reference of 0.55V
  73 #define COMP_REF_0_6875V        0x00000305  // Internal reference of 0.6875V
  74 #define COMP_REF_0_825V         0x00000306  // Internal reference of 0.825V
  75 #define COMP_REF_0_928125V      0x00000201  // Internal reference of 0.928125V
  76 #define COMP_REF_0_9625V        0x00000307  // Internal reference of 0.9625V
  77 #define COMP_REF_1_03125V       0x00000202  // Internal reference of 1.03125V
  78 #define COMP_REF_1_134375V      0x00000203  // Internal reference of 1.134375V
  79 #define COMP_REF_1_1V           0x00000308  // Internal reference of 1.1V
  80 #define COMP_REF_1_2375V        0x00000309  // Internal reference of 1.2375V
  81 #define COMP_REF_1_340625V      0x00000205  // Internal reference of 1.340625V
  82 #define COMP_REF_1_375V         0x0000030A  // Internal reference of 1.375V
  83 #define COMP_REF_1_44375V       0x00000206  // Internal reference of 1.44375V
  84 #define COMP_REF_1_5125V        0x0000030B  // Internal reference of 1.5125V
  85 #define COMP_REF_1_546875V      0x00000207  // Internal reference of 1.546875V
  86 #define COMP_REF_1_65V          0x0000030C  // Internal reference of 1.65V
  87 #define COMP_REF_1_753125V      0x00000209  // Internal reference of 1.753125V
  88 #define COMP_REF_1_7875V        0x0000030D  // Internal reference of 1.7875V
  89 #define COMP_REF_1_85625V       0x0000020A  // Internal reference of 1.85625V
  90 #define COMP_REF_1_925V         0x0000030E  // Internal reference of 1.925V
  91 #define COMP_REF_1_959375V      0x0000020B  // Internal reference of 1.959375V
  92 #define COMP_REF_2_0625V        0x0000030F  // Internal reference of 2.0625V
  93 #define COMP_REF_2_165625V      0x0000020D  // Internal reference of 2.165625V
  94 #define COMP_REF_2_26875V       0x0000020E  // Internal reference of 2.26875V
  95 #define COMP_REF_2_371875V      0x0000020F  // Internal reference of 2.371875V
  96
  97 //*****************************************************************************
  98 //
  99 // Prototypes for the APIs.
 100 //
 101 //*****************************************************************************
 102 extern void ComparatorConfigure(unsigned long ulBase, unsigned long ulComp,
 103                                 unsigned long ulConfig);
 104 extern void ComparatorRefSet(unsigned long ulBase, unsigned long ulRef);
 105 extern tBoolean ComparatorValueGet(unsigned long ulBase, unsigned long ulComp);
 106 extern void ComparatorIntRegister(unsigned long ulBase, unsigned long ulComp,
 107                                   void (*pfnHandler)(void));
 108 extern void ComparatorIntUnregister(unsigned long ulBase,
 109                                     unsigned long ulComp);
 110 extern void ComparatorIntEnable(unsigned long ulBase, unsigned long ulComp);
 111 extern void ComparatorIntDisable(unsigned long ulBase, unsigned long ulComp);
 112 extern tBoolean ComparatorIntStatus(unsigned long ulBase, unsigned long ulComp,
 113                                     tBoolean bMasked);
 114 extern void ComparatorIntClear(unsigned long ulBase, unsigned long ulComp);
 115
 116 #ifdef __cplusplus
 117 }
 118 #endif
 119
 120 #endif // __COMP_H__