git.sur5r.net Git - freertos/blob - Demo/CORTEX_LM3S102_Rowley/hw_include/sysctl.h

   1 //*****************************************************************************\r
   2 //\r
   3 // sysctl.h - Prototypes for the system control driver.\r
   4 //\r
   5 // Copyright (c) 2005,2006 Luminary Micro, Inc.  All rights reserved.\r
   6 //\r
   7 // Software License Agreement\r
   8 //\r
   9 // Luminary Micro, Inc. (LMI) is supplying this software for use solely and\r
  10 // exclusively on LMI's Stellaris Family of microcontroller products.\r
  11 //\r
  12 // The software is owned by LMI and/or its suppliers, and is protected under\r
  13 // applicable copyright laws.  All rights are reserved.  Any use in violation\r
  14 // of the foregoing restrictions may subject the user to criminal sanctions\r
  15 // under applicable laws, as well as to civil liability for the breach of the\r
  16 // terms and conditions of this license.\r
  17 //\r
  18 // THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED\r
  19 // OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF\r
  20 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.\r
  21 // LMI SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR\r
  22 // CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.\r
  23 //\r
  24 // This is part of revision 523 of the Stellaris Driver Library.\r
  25 //\r
  26 //*****************************************************************************\r
  27 \r
  28 #ifndef __SYSCTL_H__\r
  29 #define __SYSCTL_H__\r
  30 \r
  31 #ifdef __cplusplus\r
  32 extern "C"\r
  33 {\r
  34 #endif\r
  35 \r
  36 //*****************************************************************************\r
  37 //\r
  38 // The following are values that can be passed to the\r
  39 // SysCtlPeripheralPresent(), SysCtlPeripheralEnable(),\r
  40 // SysCtlPeripheralDisable(), and SysCtlPeripheralReset() APIs as the\r
  41 // ulPeripheral parameter.  The peripherals in the fourth group (upper nibble\r
  42 // is 3) can only be used with the SysCtlPeripheralPresent() API.\r
  43 //\r
  44 //*****************************************************************************\r
  45 #define SYSCTL_PERIPH_WDOG      0x00000008  // Watchdog\r
  46 #define SYSCTL_PERIPH_UART0     0x10000001  // UART 0\r
  47 #define SYSCTL_PERIPH_SSI       0x10000010  // SSI\r
  48 #define SYSCTL_PERIPH_I2C       0x10001000  // I2C\r
  49 #define SYSCTL_PERIPH_TIMER0    0x10010000  // Timer 0\r
  50 #define SYSCTL_PERIPH_TIMER1    0x10020000  // Timer 1\r
  51 #define SYSCTL_PERIPH_COMP0     0x11000000  // Analog comparator 0\r
  52 #define SYSCTL_PERIPH_COMP1     0x12000000  // Analog comparator 1\r
  53 #define SYSCTL_PERIPH_GPIOA     0x20000001  // GPIO A\r
  54 #define SYSCTL_PERIPH_GPIOB     0x20000002  // GPIO B\r
  55 #define SYSCTL_PERIPH_GPIOC     0x20000004  // GPIO C\r
  56 #define SYSCTL_PERIPH_PLL       0x30000010  // PLL\r
  57 \r
  58 //*****************************************************************************\r
  59 //\r
  60 // The following are values that can be passed to the SysCtlPinPresent() API\r
  61 // as the ulPin parameter.\r
  62 //\r
  63 //*****************************************************************************\r
  64 #define SYSCTL_PIN_C0MINUS      0x00000040  // C0- pin\r
  65 #define SYSCTL_PIN_C0PLUS       0x00000080  // C0+ pin\r
  66 #define SYSCTL_PIN_C0O          0x00000100  // C0o pin\r
  67 #define SYSCTL_PIN_C1MINUS      0x00000200  // C1- pin\r
  68 #define SYSCTL_PIN_CCP0         0x01000000  // CCP0 pin\r
  69 #define SYSCTL_PIN_CCP1         0x02000000  // CCP1 pin\r
  70 #define SYSCTL_PIN_32KHZ        0x80000000  // 32kHz pin\r
  71 \r
  72 //*****************************************************************************\r
  73 //\r
  74 // The following are values that can be passed to the SysCtlLDOSet() API as\r
  75 // the ulVoltage value, or returned by the SysCtlLDOGet() API.\r
  76 //\r
  77 //*****************************************************************************\r
  78 #define SYSCTL_LDO_2_25V        0x00000005  // LDO output of 2.25V\r
  79 #define SYSCTL_LDO_2_30V        0x00000004  // LDO output of 2.30V\r
  80 #define SYSCTL_LDO_2_35V        0x00000003  // LDO output of 2.35V\r
  81 #define SYSCTL_LDO_2_40V        0x00000002  // LDO output of 2.40V\r
  82 #define SYSCTL_LDO_2_45V        0x00000001  // LDO output of 2.45V\r
  83 #define SYSCTL_LDO_2_50V        0x00000000  // LDO output of 2.50V\r
  84 #define SYSCTL_LDO_2_55V        0x0000001f  // LDO output of 2.55V\r
  85 #define SYSCTL_LDO_2_60V        0x0000001e  // LDO output of 2.60V\r
  86 #define SYSCTL_LDO_2_65V        0x0000001d  // LDO output of 2.65V\r
  87 #define SYSCTL_LDO_2_70V        0x0000001c  // LDO output of 2.70V\r
  88 #define SYSCTL_LDO_2_75V        0x0000001b  // LDO output of 2.75V\r
  89 \r
  90 //*****************************************************************************\r
  91 //\r
  92 // The following are values that can be passed to the SysCtlLDOConfigSet() API.\r
  93 //\r
  94 //*****************************************************************************\r
  95 #define SYSCTL_LDOCFG_ARST      0x00000001  // Allow LDO failure to reset\r
  96 #define SYSCTL_LDOCFG_NORST     0x00000000  // Do not reset on LDO failure\r
  97 \r
  98 //*****************************************************************************\r
  99 //\r
 100 // The following are values that can be passed to the SysCtlIntEnable(),\r
 101 // SysCtlIntDisable(), and SysCtlIntClear() APIs, or returned in the bit mask\r
 102 // by the SysCtlIntStatus() API.\r
 103 //\r
 104 //*****************************************************************************\r
 105 #define SYSCTL_INT_PLL_LOCK     0x00000040  // PLL lock interrupt\r
 106 #define SYSCTL_INT_CUR_LIMIT    0x00000020  // Current limit interrupt\r
 107 #define SYSCTL_INT_BOSC_FAIL    0x00000010  // Boot oscillator failure int\r
 108 #define SYSCTL_INT_MOSC_FAIL    0x00000008  // Main oscillator failure int\r
 109 #define SYSCTL_INT_POR          0x00000004  // Power on reset interrupt\r
 110 #define SYSCTL_INT_BOR          0x00000002  // Brown out interrupt\r
 111 #define SYSCTL_INT_PLL_FAIL     0x00000001  // PLL failure interrupt\r
 112 \r
 113 //*****************************************************************************\r
 114 //\r
 115 // The following are values that can be passed to the SysCtlResetCauseClear()\r
 116 // API or returned by the SysCtlResetCauseGet() API.\r
 117 //\r
 118 //*****************************************************************************\r
 119 #define SYSCTL_CAUSE_LDO        0x00000020  // LDO power not OK reset\r
 120 #define SYSCTL_CAUSE_SW         0x00000010  // Software reset\r
 121 #define SYSCTL_CAUSE_WDOG       0x00000008  // Watchdog reset\r
 122 #define SYSCTL_CAUSE_BOR        0x00000004  // Brown-out reset\r
 123 #define SYSCTL_CAUSE_POR        0x00000002  // Power on reset\r
 124 #define SYSCTL_CAUSE_EXT        0x00000001  // External reset\r
 125 \r
 126 //*****************************************************************************\r
 127 //\r
 128 // The following are values that can be passed to the SysCtlBrownOutConfigSet()\r
 129 // API as the ulConfig parameter.\r
 130 //\r
 131 //*****************************************************************************\r
 132 #define SYSCTL_BOR_RESET        0x00000002  // Reset instead of interrupting\r
 133 #define SYSCTL_BOR_RESAMPLE     0x00000001  // Resample BOR before asserting\r
 134 \r
 135 //*****************************************************************************\r
 136 //\r
 137 // The following are values that can be passed to the SysCtlClockSet() API as\r
 138 // the ulConfig parameter.\r
 139 //\r
 140 //*****************************************************************************\r
 141 #define SYSCTL_SYSDIV_1         0x07800000  // Processor clock is osc/pll /1\r
 142 #define SYSCTL_SYSDIV_2         0x00C00000  // Processor clock is osc/pll /2\r
 143 #define SYSCTL_SYSDIV_3         0x01400000  // Processor clock is osc/pll /3\r
 144 #define SYSCTL_SYSDIV_4         0x01C00000  // Processor clock is osc/pll /4\r
 145 #define SYSCTL_SYSDIV_5         0x02400000  // Processor clock is osc/pll /5\r
 146 #define SYSCTL_SYSDIV_6         0x02C00000  // Processor clock is osc/pll /6\r
 147 #define SYSCTL_SYSDIV_7         0x03400000  // Processor clock is osc/pll /7\r
 148 #define SYSCTL_SYSDIV_8         0x03C00000  // Processor clock is osc/pll /8\r
 149 #define SYSCTL_SYSDIV_9         0x04400000  // Processor clock is osc/pll /9\r
 150 #define SYSCTL_SYSDIV_10        0x04C00000  // Processor clock is osc/pll /10\r
 151 #define SYSCTL_SYSDIV_11        0x05400000  // Processor clock is osc/pll /11\r
 152 #define SYSCTL_SYSDIV_12        0x05C00000  // Processor clock is osc/pll /12\r
 153 #define SYSCTL_SYSDIV_13        0x06400000  // Processor clock is osc/pll /13\r
 154 #define SYSCTL_SYSDIV_14        0x06C00000  // Processor clock is osc/pll /14\r
 155 #define SYSCTL_SYSDIV_15        0x07400000  // Processor clock is osc/pll /15\r
 156 #define SYSCTL_SYSDIV_16        0x07C00000  // Processor clock is osc/pll /16\r
 157 #define SYSCTL_USE_PLL          0x00000000  // System clock is the PLL clock\r
 158 #define SYSCTL_USE_OSC          0x00003800  // System clock is the osc clock\r
 159 #define SYSCTL_XTAL_3_57MHZ     0x00000100  // External crystal is 3.579545MHz\r
 160 #define SYSCTL_XTAL_3_68MHZ     0x00000140  // External crystal is 3.6864MHz\r
 161 #define SYSCTL_XTAL_4MHZ        0x00000180  // External crystal is 4MHz\r
 162 #define SYSCTL_XTAL_4_09MHZ     0x000001C0  // External crystal is 4.096MHz\r
 163 #define SYSCTL_XTAL_4_91MHZ     0x00000200  // External crystal is 4.9152MHz\r
 164 #define SYSCTL_XTAL_5MHZ        0x00000240  // External crystal is 5MHz\r
 165 #define SYSCTL_XTAL_5_12MHZ     0x00000280  // External crystal is 5.12MHz\r
 166 #define SYSCTL_XTAL_6MHZ        0x000002C0  // External crystal is 6MHz\r
 167 #define SYSCTL_XTAL_6_14MHZ     0x00000300  // External crystal is 6.144MHz\r
 168 #define SYSCTL_XTAL_7_37MHZ     0x00000340  // External crystal is 7.3728MHz\r
 169 #define SYSCTL_XTAL_8MHZ        0x00000380  // External crystal is 8MHz\r
 170 #define SYSCTL_XTAL_8_19MHZ     0x000003C0  // External crystal is 8.192MHz\r
 171 #define SYSCTL_OSC_MAIN         0x00000000  // Oscillator source is main osc\r
 172 #define SYSCTL_OSC_BOOT         0x00000010  // Oscillator source is boot osc\r
 173 #define SYSCTL_OSC_BOOT4        0x00000020  // Oscillator source is boot osc /4\r
 174 #define SYSCTL_BOOT_OSC_DIS     0x00000002  // Disable boot oscillator\r
 175 #define SYSCTL_MAIN_OSC_DIS     0x00000001  // Disable main oscillator\r
 176 \r
 177 //*****************************************************************************\r
 178 //\r
 179 // Prototypes for the APIs.\r
 180 //\r
 181 //*****************************************************************************\r
 182 extern unsigned long SysCtlSRAMSizeGet(void);\r
 183 extern unsigned long SysCtlFlashSizeGet(void);\r
 184 extern tBoolean SysCtlPinPresent(unsigned long ulPin);\r
 185 extern tBoolean SysCtlPeripheralPresent(unsigned long ulPeripheral);\r
 186 extern void SysCtlPeripheralReset(unsigned long ulPeripheral);\r
 187 extern void SysCtlPeripheralEnable(unsigned long ulPeripheral);\r
 188 extern void SysCtlPeripheralDisable(unsigned long ulPeripheral);\r
 189 extern void SysCtlPeripheralSleepEnable(unsigned long ulPeripheral);\r
 190 extern void SysCtlPeripheralSleepDisable(unsigned long ulPeripheral);\r
 191 extern void SysCtlPeripheralDeepSleepEnable(unsigned long ulPeripheral);\r
 192 extern void SysCtlPeripheralDeepSleepDisable(unsigned long ulPeripheral);\r
 193 extern void SysCtlPeripheralClockGating(tBoolean bEnable);\r
 194 extern void SysCtlIntRegister(void (*pfnHandler)(void));\r
 195 extern void SysCtlIntUnregister(void);\r
 196 extern void SysCtlIntEnable(unsigned long ulInts);\r
 197 extern void SysCtlIntDisable(unsigned long ulInts);\r
 198 extern void SysCtlIntClear(unsigned long ulInts);\r
 199 extern unsigned long SysCtlIntStatus(tBoolean bMasked);\r
 200 extern void SysCtlLDOSet(unsigned long ulVoltage);\r
 201 extern unsigned long SysCtlLDOGet(void);\r
 202 extern void SysCtlLDOConfigSet(unsigned long ulConfig);\r
 203 extern void SysCtlReset(void);\r
 204 extern void SysCtlSleep(void);\r
 205 extern void SysCtlDeepSleep(void);\r
 206 extern unsigned long SysCtlResetCauseGet(void);\r
 207 extern void SysCtlResetCauseClear(unsigned long ulCauses);\r
 208 extern void SysCtlBrownOutConfigSet(unsigned long ulConfig,\r
 209                                     unsigned long ulDelay);\r
 210 extern void SysCtlClockSet(unsigned long ulConfig);\r
 211 extern unsigned long SysCtlClockGet(void);\r
 212 extern void SysCtlBOSCVerificationSet(tBoolean bEnable);\r
 213 extern void SysCtlMOSCVerificationSet(tBoolean bEnable);\r
 214 extern void SysCtlPLLVerificationSet(tBoolean bEnable);\r
 215 extern void SysCtlClkVerificationClear(void);\r
 216 \r
 217 #ifdef __cplusplus\r
 218 }\r
 219 #endif\r
 220 \r
 221 #endif // __SYSCTL_H__\r