git.sur5r.net Git - freertos/blob - Demo/Common/drivers/LuminaryMicro/sysctl.h

   1 //*****************************************************************************\r
   2 //\r
   3 // sysctl.h - Prototypes for the system control driver.\r
   4 //\r
   5 // Copyright (c) 2005-2007 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 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 1582 of the Stellaris Peripheral 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_PWM       0x00100010  // PWM\r
  46 #define SYSCTL_PERIPH_ADC       0x00100001  // ADC\r
  47 #define SYSCTL_PERIPH_HIBERNATE 0x00000040  // Hibernation module\r
  48 #define SYSCTL_PERIPH_WDOG      0x00000008  // Watchdog\r
  49 #define SYSCTL_PERIPH_CAN0      0x00100100  // CAN 0\r
  50 #define SYSCTL_PERIPH_CAN1      0x00100200  // CAN 1\r
  51 #define SYSCTL_PERIPH_CAN2      0x00100400  // CAN 2\r
  52 #define SYSCTL_PERIPH_UART0     0x10000001  // UART 0\r
  53 #define SYSCTL_PERIPH_UART1     0x10000002  // UART 1\r
  54 #define SYSCTL_PERIPH_UART2     0x10000004  // UART 2\r
  55 #define SYSCTL_PERIPH_SSI       0x10000010  // SSI\r
  56 #define SYSCTL_PERIPH_SSI0      0x10000010  // SSI 0\r
  57 #define SYSCTL_PERIPH_SSI1      0x10000020  // SSI 1\r
  58 #define SYSCTL_PERIPH_QEI       0x10000100  // QEI\r
  59 #define SYSCTL_PERIPH_QEI0      0x10000100  // QEI 0\r
  60 #define SYSCTL_PERIPH_QEI1      0x10000200  // QEI 1\r
  61 #define SYSCTL_PERIPH_I2C       0x10001000  // I2C\r
  62 #define SYSCTL_PERIPH_I2C0      0x10001000  // I2C 0\r
  63 #define SYSCTL_PERIPH_I2C1      0x10004000  // I2C 1\r
  64 #define SYSCTL_PERIPH_TIMER0    0x10100001  // Timer 0\r
  65 #define SYSCTL_PERIPH_TIMER1    0x10100002  // Timer 1\r
  66 #define SYSCTL_PERIPH_TIMER2    0x10100004  // Timer 2\r
  67 #define SYSCTL_PERIPH_TIMER3    0x10100008  // Timer 3\r
  68 #define SYSCTL_PERIPH_COMP0     0x10100100  // Analog comparator 0\r
  69 #define SYSCTL_PERIPH_COMP1     0x10100200  // Analog comparator 1\r
  70 #define SYSCTL_PERIPH_COMP2     0x10100400  // Analog comparator 2\r
  71 #define SYSCTL_PERIPH_GPIOA     0x20000001  // GPIO A\r
  72 #define SYSCTL_PERIPH_GPIOB     0x20000002  // GPIO B\r
  73 #define SYSCTL_PERIPH_GPIOC     0x20000004  // GPIO C\r
  74 #define SYSCTL_PERIPH_GPIOD     0x20000008  // GPIO D\r
  75 #define SYSCTL_PERIPH_GPIOE     0x20000010  // GPIO E\r
  76 #define SYSCTL_PERIPH_GPIOF     0x20000020  // GPIO F\r
  77 #define SYSCTL_PERIPH_GPIOG     0x20000040  // GPIO G\r
  78 #define SYSCTL_PERIPH_GPIOH     0x20000080  // GPIO H\r
  79 #define SYSCTL_PERIPH_ETH       0x20105000  // ETH\r
  80 #define SYSCTL_PERIPH_MPU       0x30000080  // Cortex M3 MPU\r
  81 #define SYSCTL_PERIPH_TEMP      0x30000020  // Temperature sensor\r
  82 #define SYSCTL_PERIPH_PLL       0x30000010  // PLL\r
  83 \r
  84 //*****************************************************************************\r
  85 //\r
  86 // The following are values that can be passed to the SysCtlPinPresent() API\r
  87 // as the ulPin parameter.\r
  88 //\r
  89 //*****************************************************************************\r
  90 #define SYSCTL_PIN_PWM0         0x00000001  // PWM0 pin\r
  91 #define SYSCTL_PIN_PWM1         0x00000002  // PWM1 pin\r
  92 #define SYSCTL_PIN_PWM2         0x00000004  // PWM2 pin\r
  93 #define SYSCTL_PIN_PWM3         0x00000008  // PWM3 pin\r
  94 #define SYSCTL_PIN_PWM4         0x00000010  // PWM4 pin\r
  95 #define SYSCTL_PIN_PWM5         0x00000020  // PWM5 pin\r
  96 #define SYSCTL_PIN_C0MINUS      0x00000040  // C0- pin\r
  97 #define SYSCTL_PIN_C0PLUS       0x00000080  // C0+ pin\r
  98 #define SYSCTL_PIN_C0O          0x00000100  // C0o pin\r
  99 #define SYSCTL_PIN_C1MINUS      0x00000200  // C1- pin\r
 100 #define SYSCTL_PIN_C1PLUS       0x00000400  // C1+ pin\r
 101 #define SYSCTL_PIN_C1O          0x00000800  // C1o pin\r
 102 #define SYSCTL_PIN_C2MINUS      0x00001000  // C2- pin\r
 103 #define SYSCTL_PIN_C2PLUS       0x00002000  // C2+ pin\r
 104 #define SYSCTL_PIN_C2O          0x00004000  // C2o pin\r
 105 #define SYSCTL_PIN_MC_FAULT0    0x00008000  // MC0 Fault pin\r
 106 #define SYSCTL_PIN_ADC0         0x00010000  // ADC0 pin\r
 107 #define SYSCTL_PIN_ADC1         0x00020000  // ADC1 pin\r
 108 #define SYSCTL_PIN_ADC2         0x00040000  // ADC2 pin\r
 109 #define SYSCTL_PIN_ADC3         0x00080000  // ADC3 pin\r
 110 #define SYSCTL_PIN_ADC4         0x00100000  // ADC4 pin\r
 111 #define SYSCTL_PIN_ADC5         0x00200000  // ADC5 pin\r
 112 #define SYSCTL_PIN_ADC6         0x00400000  // ADC6 pin\r
 113 #define SYSCTL_PIN_ADC7         0x00800000  // ADC7 pin\r
 114 #define SYSCTL_PIN_CCP0         0x01000000  // CCP0 pin\r
 115 #define SYSCTL_PIN_CCP1         0x02000000  // CCP1 pin\r
 116 #define SYSCTL_PIN_CCP2         0x04000000  // CCP2 pin\r
 117 #define SYSCTL_PIN_CCP3         0x08000000  // CCP3 pin\r
 118 #define SYSCTL_PIN_CCP4         0x10000000  // CCP4 pin\r
 119 #define SYSCTL_PIN_CCP5         0x20000000  // CCP5 pin\r
 120 #define SYSCTL_PIN_32KHZ        0x80000000  // 32kHz pin\r
 121 \r
 122 //*****************************************************************************\r
 123 //\r
 124 // The following are values that can be passed to the SysCtlLDOSet() API as\r
 125 // the ulVoltage value, or returned by the SysCtlLDOGet() API.\r
 126 //\r
 127 //*****************************************************************************\r
 128 #define SYSCTL_LDO_2_25V        0x00000005  // LDO output of 2.25V\r
 129 #define SYSCTL_LDO_2_30V        0x00000004  // LDO output of 2.30V\r
 130 #define SYSCTL_LDO_2_35V        0x00000003  // LDO output of 2.35V\r
 131 #define SYSCTL_LDO_2_40V        0x00000002  // LDO output of 2.40V\r
 132 #define SYSCTL_LDO_2_45V        0x00000001  // LDO output of 2.45V\r
 133 #define SYSCTL_LDO_2_50V        0x00000000  // LDO output of 2.50V\r
 134 #define SYSCTL_LDO_2_55V        0x0000001f  // LDO output of 2.55V\r
 135 #define SYSCTL_LDO_2_60V        0x0000001e  // LDO output of 2.60V\r
 136 #define SYSCTL_LDO_2_65V        0x0000001d  // LDO output of 2.65V\r
 137 #define SYSCTL_LDO_2_70V        0x0000001c  // LDO output of 2.70V\r
 138 #define SYSCTL_LDO_2_75V        0x0000001b  // LDO output of 2.75V\r
 139 \r
 140 //*****************************************************************************\r
 141 //\r
 142 // The following are values that can be passed to the SysCtlLDOConfigSet() API.\r
 143 //\r
 144 //*****************************************************************************\r
 145 #define SYSCTL_LDOCFG_ARST      0x00000001  // Allow LDO failure to reset\r
 146 #define SYSCTL_LDOCFG_NORST     0x00000000  // Do not reset on LDO failure\r
 147 \r
 148 //*****************************************************************************\r
 149 //\r
 150 // The following are values that can be passed to the SysCtlIntEnable(),\r
 151 // SysCtlIntDisable(), and SysCtlIntClear() APIs, or returned in the bit mask\r
 152 // by the SysCtlIntStatus() API.\r
 153 //\r
 154 //*****************************************************************************\r
 155 #define SYSCTL_INT_PLL_LOCK     0x00000040  // PLL lock interrupt\r
 156 #define SYSCTL_INT_CUR_LIMIT    0x00000020  // Current limit interrupt\r
 157 #define SYSCTL_INT_IOSC_FAIL    0x00000010  // Internal oscillator failure int\r
 158 #define SYSCTL_INT_MOSC_FAIL    0x00000008  // Main oscillator failure int\r
 159 #define SYSCTL_INT_POR          0x00000004  // Power on reset interrupt\r
 160 #define SYSCTL_INT_BOR          0x00000002  // Brown out interrupt\r
 161 #define SYSCTL_INT_PLL_FAIL     0x00000001  // PLL failure interrupt\r
 162 \r
 163 //*****************************************************************************\r
 164 //\r
 165 // The following are values that can be passed to the SysCtlResetCauseClear()\r
 166 // API or returned by the SysCtlResetCauseGet() API.\r
 167 //\r
 168 //*****************************************************************************\r
 169 #define SYSCTL_CAUSE_LDO        0x00000020  // LDO power not OK reset\r
 170 #define SYSCTL_CAUSE_SW         0x00000010  // Software reset\r
 171 #define SYSCTL_CAUSE_WDOG       0x00000008  // Watchdog reset\r
 172 #define SYSCTL_CAUSE_BOR        0x00000004  // Brown-out reset\r
 173 #define SYSCTL_CAUSE_POR        0x00000002  // Power on reset\r
 174 #define SYSCTL_CAUSE_EXT        0x00000001  // External reset\r
 175 \r
 176 //*****************************************************************************\r
 177 //\r
 178 // The following are values that can be passed to the SysCtlBrownOutConfigSet()\r
 179 // API as the ulConfig parameter.\r
 180 //\r
 181 //*****************************************************************************\r
 182 #define SYSCTL_BOR_RESET        0x00000002  // Reset instead of interrupting\r
 183 #define SYSCTL_BOR_RESAMPLE     0x00000001  // Resample BOR before asserting\r
 184 \r
 185 //*****************************************************************************\r
 186 //\r
 187 // The following are values that can be passed to the SysCtlPWMClockSet() API\r
 188 // as the ulConfig parameter, and can be returned by the SysCtlPWMClockGet()\r
 189 // API.\r
 190 //\r
 191 //*****************************************************************************\r
 192 #define SYSCTL_PWMDIV_1         0x00000000  // PWM clock is processor clock /1\r
 193 #define SYSCTL_PWMDIV_2         0x00100000  // PWM clock is processor clock /2\r
 194 #define SYSCTL_PWMDIV_4         0x00120000  // PWM clock is processor clock /4\r
 195 #define SYSCTL_PWMDIV_8         0x00140000  // PWM clock is processor clock /8\r
 196 #define SYSCTL_PWMDIV_16        0x00160000  // PWM clock is processor clock /16\r
 197 #define SYSCTL_PWMDIV_32        0x00180000  // PWM clock is processor clock /32\r
 198 #define SYSCTL_PWMDIV_64        0x001A0000  // PWM clock is processor clock /64\r
 199 \r
 200 //*****************************************************************************\r
 201 //\r
 202 // The following are values that can be passed to the SysCtlADCSpeedSet() API\r
 203 // as the ulSpeed parameter, and can be returned by the SyCtlADCSpeedGet()\r
 204 // API.\r
 205 //\r
 206 //*****************************************************************************\r
 207 #define SYSCTL_ADCSPEED_1MSPS   0x00000300  // 1,000,000 samples per second\r
 208 #define SYSCTL_ADCSPEED_500KSPS 0x00000200  // 500,000 samples per second\r
 209 #define SYSCTL_ADCSPEED_250KSPS 0x00000100  // 250,000 samples per second\r
 210 #define SYSCTL_ADCSPEED_125KSPS 0x00000000  // 125,000 samples per second\r
 211 \r
 212 //*****************************************************************************\r
 213 //\r
 214 // The following are values that can be passed to the SysCtlClockSet() API as\r
 215 // the ulConfig parameter.\r
 216 //\r
 217 //*****************************************************************************\r
 218 #define SYSCTL_SYSDIV_1         0x07800000  // Processor clock is osc/pll /1\r
 219 #define SYSCTL_SYSDIV_2         0x00C00000  // Processor clock is osc/pll /2\r
 220 #define SYSCTL_SYSDIV_3         0x01400000  // Processor clock is osc/pll /3\r
 221 #define SYSCTL_SYSDIV_4         0x01C00000  // Processor clock is osc/pll /4\r
 222 #define SYSCTL_SYSDIV_5         0x02400000  // Processor clock is osc/pll /5\r
 223 #define SYSCTL_SYSDIV_6         0x02C00000  // Processor clock is osc/pll /6\r
 224 #define SYSCTL_SYSDIV_7         0x03400000  // Processor clock is osc/pll /7\r
 225 #define SYSCTL_SYSDIV_8         0x03C00000  // Processor clock is osc/pll /8\r
 226 #define SYSCTL_SYSDIV_9         0x04400000  // Processor clock is osc/pll /9\r
 227 #define SYSCTL_SYSDIV_10        0x04C00000  // Processor clock is osc/pll /10\r
 228 #define SYSCTL_SYSDIV_11        0x05400000  // Processor clock is osc/pll /11\r
 229 #define SYSCTL_SYSDIV_12        0x05C00000  // Processor clock is osc/pll /12\r
 230 #define SYSCTL_SYSDIV_13        0x06400000  // Processor clock is osc/pll /13\r
 231 #define SYSCTL_SYSDIV_14        0x06C00000  // Processor clock is osc/pll /14\r
 232 #define SYSCTL_SYSDIV_15        0x07400000  // Processor clock is osc/pll /15\r
 233 #define SYSCTL_SYSDIV_16        0x07C00000  // Processor clock is osc/pll /16\r
 234 #define SYSCTL_USE_PLL          0x00000000  // System clock is the PLL clock\r
 235 #define SYSCTL_USE_OSC          0x00003800  // System clock is the osc clock\r
 236 #define SYSCTL_XTAL_1MHZ        0x00000000  // External crystal is 1MHz\r
 237 #define SYSCTL_XTAL_1_84MHZ     0x00000040  // External crystal is 1.8432MHz\r
 238 #define SYSCTL_XTAL_2MHZ        0x00000080  // External crystal is 2MHz\r
 239 #define SYSCTL_XTAL_2_45MHZ     0x000000C0  // External crystal is 2.4576MHz\r
 240 #define SYSCTL_XTAL_3_57MHZ     0x00000100  // External crystal is 3.579545MHz\r
 241 #define SYSCTL_XTAL_3_68MHZ     0x00000140  // External crystal is 3.6864MHz\r
 242 #define SYSCTL_XTAL_4MHZ        0x00000180  // External crystal is 4MHz\r
 243 #define SYSCTL_XTAL_4_09MHZ     0x000001C0  // External crystal is 4.096MHz\r
 244 #define SYSCTL_XTAL_4_91MHZ     0x00000200  // External crystal is 4.9152MHz\r
 245 #define SYSCTL_XTAL_5MHZ        0x00000240  // External crystal is 5MHz\r
 246 #define SYSCTL_XTAL_5_12MHZ     0x00000280  // External crystal is 5.12MHz\r
 247 #define SYSCTL_XTAL_6MHZ        0x000002C0  // External crystal is 6MHz\r
 248 #define SYSCTL_XTAL_6_14MHZ     0x00000300  // External crystal is 6.144MHz\r
 249 #define SYSCTL_XTAL_7_37MHZ     0x00000340  // External crystal is 7.3728MHz\r
 250 #define SYSCTL_XTAL_8MHZ        0x00000380  // External crystal is 8MHz\r
 251 #define SYSCTL_XTAL_8_19MHZ     0x000003C0  // External crystal is 8.192MHz\r
 252 #define SYSCTL_OSC_MAIN         0x00000000  // Oscillator source is main osc\r
 253 #define SYSCTL_OSC_INT          0x00000010  // Oscillator source is int. osc\r
 254 #define SYSCTL_OSC_INT4         0x00000020  // Oscillator source is int. osc /4\r
 255 #define SYSCTL_INT_OSC_DIS      0x00000002  // Disable internal oscillator\r
 256 #define SYSCTL_MAIN_OSC_DIS     0x00000001  // Disable main oscillator\r
 257 \r
 258 //*****************************************************************************\r
 259 //\r
 260 // Prototypes for the APIs.\r
 261 //\r
 262 //*****************************************************************************\r
 263 extern unsigned long SysCtlSRAMSizeGet(void);\r
 264 extern unsigned long SysCtlFlashSizeGet(void);\r
 265 extern tBoolean SysCtlPinPresent(unsigned long ulPin);\r
 266 extern tBoolean SysCtlPeripheralPresent(unsigned long ulPeripheral);\r
 267 extern void SysCtlPeripheralReset(unsigned long ulPeripheral);\r
 268 extern void SysCtlPeripheralEnable(unsigned long ulPeripheral);\r
 269 extern void SysCtlPeripheralDisable(unsigned long ulPeripheral);\r
 270 extern void SysCtlPeripheralSleepEnable(unsigned long ulPeripheral);\r
 271 extern void SysCtlPeripheralSleepDisable(unsigned long ulPeripheral);\r
 272 extern void SysCtlPeripheralDeepSleepEnable(unsigned long ulPeripheral);\r
 273 extern void SysCtlPeripheralDeepSleepDisable(unsigned long ulPeripheral);\r
 274 extern void SysCtlPeripheralClockGating(tBoolean bEnable);\r
 275 extern void SysCtlIntRegister(void (*pfnHandler)(void));\r
 276 extern void SysCtlIntUnregister(void);\r
 277 extern void SysCtlIntEnable(unsigned long ulInts);\r
 278 extern void SysCtlIntDisable(unsigned long ulInts);\r
 279 extern void SysCtlIntClear(unsigned long ulInts);\r
 280 extern unsigned long SysCtlIntStatus(tBoolean bMasked);\r
 281 extern void SysCtlLDOSet(unsigned long ulVoltage);\r
 282 extern unsigned long SysCtlLDOGet(void);\r
 283 extern void SysCtlLDOConfigSet(unsigned long ulConfig);\r
 284 extern void SysCtlReset(void);\r
 285 extern void SysCtlSleep(void);\r
 286 extern void SysCtlDeepSleep(void);\r
 287 extern unsigned long SysCtlResetCauseGet(void);\r
 288 extern void SysCtlResetCauseClear(unsigned long ulCauses);\r
 289 extern void SysCtlBrownOutConfigSet(unsigned long ulConfig,\r
 290                                     unsigned long ulDelay);\r
 291 extern void SysCtlClockSet(unsigned long ulConfig);\r
 292 extern unsigned long SysCtlClockGet(void);\r
 293 extern void SysCtlPWMClockSet(unsigned long ulConfig);\r
 294 extern unsigned long SysCtlPWMClockGet(void);\r
 295 extern void SysCtlADCSpeedSet(unsigned long ulSpeed);\r
 296 extern unsigned long SysCtlADCSpeedGet(void);\r
 297 extern void SysCtlIOSCVerificationSet(tBoolean bEnable);\r
 298 extern void SysCtlMOSCVerificationSet(tBoolean bEnable);\r
 299 extern void SysCtlPLLVerificationSet(tBoolean bEnable);\r
 300 extern void SysCtlClkVerificationClear(void);\r
 301 \r
 302 #ifdef __cplusplus\r
 303 }\r
 304 #endif\r
 305 \r
 306 #endif // __SYSCTL_H__\r