git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_AT91SAM3U256_IAR/AT91Lib/peripherals/slcdc/slcdc.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         ATMEL Microcontroller Software Support \r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2008, Atmel Corporation\r
   5  *\r
   6  * All rights reserved.\r
   7  *\r
   8  * Redistribution and use in source and binary forms, with or without\r
   9  * modification, are permitted provided that the following conditions are met:\r
  10  *\r
  11  * - Redistributions of source code must retain the above copyright notice,\r
  12  * this list of conditions and the disclaimer below.\r
  13  *\r
  14  * Atmel's name may not be used to endorse or promote products derived from\r
  15  * this software without specific prior written permission.\r
  16  *\r
  17  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR\r
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  20  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\r
  23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\r
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
  26  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  27  * ----------------------------------------------------------------------------\r
  28  */\r
  29 \r
  30 //------------------------------------------------------------------------------\r
  31 /// \unit\r
  32 ///\r
  33 /// !Purpose\r
  34 ///\r
  35 /// Interface for configuration the Segment LCD Controller (SLCDC) peripheral.\r
  36 ///\r
  37 /// !Usage\r
  38 ///\r
  39 /// -# Initializes the Segment LCD controller using SLCDC_Configure().\r
  40 /// -# Clears the SLCD display buffer using SLCDC_Clear().\r
  41 /// -# Enable & disable SLCD controller using SLCDC_Enable() and SLCDC_Disable().\r
  42 /// -# Enables & disable the SLCD low power mode using SLCDC_EnableLowPowerMode () \r
  43 /// and SLCDC_DisableLowPowerMode().   \r
  44 /// -# Adjusts the frame frequency using SLCDC_SetFrameFreq().\r
  45 /// -# Sets the display mode (normal/force off/force on/blinking) using \r
  46 /// SLCDC_SetDisplayMode().\r
  47 /// -# Adjusts the display blinking frequency using SLCDC_SetBlinkFreq().\r
  48 /// -# Enables & disable the selected SLCDC interrupt sources using\r
  49 /// SLCDC_EnableInterrupts() and SLCDC_DisableInterrupts().\r
  50 //------------------------------------------------------------------------------\r
  51 \r
  52 #ifndef SLCDC_H\r
  53 #define SLCDC_H\r
  54 \r
  55 //------------------------------------------------------------------------------\r
  56 //         Global definitions\r
  57 //------------------------------------------------------------------------------\r
  58 \r
  59 /// Number of segments in SLCD.\r
  60 #define S7LEKLCD_NUM_SEGMENTS       40\r
  61 /// Number of commons in SLCD.\r
  62 #define S7LEKLCD_NUM_COMMONS        10\r
  63 \r
  64 //------------------------------------------------------------------------------\r
  65 //         Global functions\r
  66 //------------------------------------------------------------------------------\r
  67 \r
  68 extern void SLCDC_Configure(\r
  69     unsigned int commons,\r
  70     unsigned int segments,\r
  71     unsigned int bias,\r
  72     unsigned int timeSetting);\r
  73 \r
  74 extern void SLCDC_Clear(void);\r
  75 \r
  76 extern void SLCDC_Enable(void);\r
  77 \r
  78 extern void SLCDC_Disable(void);\r
  79 \r
  80 extern void SLCDC_SetFrameFreq(\r
  81     unsigned int prescalerValue,\r
  82     unsigned int dividerValue);\r
  83 \r
  84 extern void SLCDC_SetDisplayMode(unsigned int mode);\r
  85 \r
  86 extern void SLCDC_SetBlinkFreq(unsigned int frequency);\r
  87 \r
  88 extern void SLCDC_EnableInterrupts(unsigned int sources);\r
  89 \r
  90 extern void SLCDC_DisableInterrupts(unsigned int sources);\r
  91 \r
  92 #endif //#ifndef SLCDC_H\r
  93 \r