2 * -------------------------------------------
3 * MSP432 DriverLib - v3_10_00_09
4 * -------------------------------------------
6 * --COPYRIGHT--,BSD,BSD
7 * Copyright (c) 2014, Texas Instruments Incorporated
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
14 * * Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
17 * * Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
21 * * Neither the name of Texas Instruments Incorporated nor the names of
22 * its contributors may be used to endorse or promote products derived
23 * from this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
27 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
29 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
32 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
33 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
34 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
35 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 #ifndef __INTERRUPT_H__
38 #define __INTERRUPT_H__
40 //*****************************************************************************
42 //! \addtogroup interrupt_api
45 //*****************************************************************************
48 //*****************************************************************************
50 // If building with a C++ compiler, make all of the definitions in this header
53 //*****************************************************************************
63 /******************************************************************************
65 ******************************************************************************/
66 /* System exceptions */
67 #define FAULT_NMI ( 2) /* NMI fault */
68 #define FAULT_HARD ( 3) /* Hard fault */
69 #define FAULT_MPU ( 4) /* MPU fault */
70 #define FAULT_BUS ( 5) /* Bus fault */
71 #define FAULT_USAGE ( 6) /* Usage fault */
72 #define FAULT_SVCALL (11) /* SVCall */
73 #define FAULT_DEBUG (12) /* Debug monitor */
74 #define FAULT_PENDSV (14) /* PendSV */
75 #define FAULT_SYSTICK (15) /* System Tick */
77 /* External interrupts */
78 #define INT_PSS (16) /* PSS IRQ */
79 #define INT_CS (17) /* CS IRQ */
80 #define INT_PCM (18) /* PCM IRQ */
81 #define INT_WDT_A (19) /* WDT_A IRQ */
82 #define INT_FPU (20) /* FPU IRQ */
83 #define INT_FLCTL (21) /* FLCTL IRQ */
84 #define INT_COMP_E0 (22) /* COMP_E0 IRQ */
85 #define INT_COMP_E1 (23) /* COMP_E1 IRQ */
86 #define INT_TA0_0 (24) /* TA0_0 IRQ */
87 #define INT_TA0_N (25) /* TA0_N IRQ */
88 #define INT_TA1_0 (26) /* TA1_0 IRQ */
89 #define INT_TA1_N (27) /* TA1_N IRQ */
90 #define INT_TA2_0 (28) /* TA2_0 IRQ */
91 #define INT_TA2_N (29) /* TA2_N IRQ */
92 #define INT_TA3_0 (30) /* TA3_0 IRQ */
93 #define INT_TA3_N (31) /* TA3_N IRQ */
94 #define INT_EUSCIA0 (32) /* EUSCIA0 IRQ */
95 #define INT_EUSCIA1 (33) /* EUSCIA1 IRQ */
96 #define INT_EUSCIA2 (34) /* EUSCIA2 IRQ */
97 #define INT_EUSCIA3 (35) /* EUSCIA3 IRQ */
98 #define INT_EUSCIB0 (36) /* EUSCIB0 IRQ */
99 #define INT_EUSCIB1 (37) /* EUSCIB1 IRQ */
100 #define INT_EUSCIB2 (38) /* EUSCIB2 IRQ */
101 #define INT_EUSCIB3 (39) /* EUSCIB3 IRQ */
102 #define INT_ADC14 (40) /* ADC14 IRQ */
103 #define INT_T32_INT1 (41) /* T32_INT1 IRQ */
104 #define INT_T32_INT2 (42) /* T32_INT2 IRQ */
105 #define INT_T32_INTC (43) /* T32_INTC IRQ */
106 #define INT_AES256 (44) /* AES256 IRQ */
107 #define INT_RTC_C (45) /* RTC_C IRQ */
108 #define INT_DMA_ERR (46) /* DMA_ERR IRQ */
109 #define INT_DMA_INT3 (47) /* DMA_INT3 IRQ */
110 #define INT_DMA_INT2 (48) /* DMA_INT2 IRQ */
111 #define INT_DMA_INT1 (49) /* DMA_INT1 IRQ */
112 #define INT_DMA_INT0 (50) /* DMA_INT0 IRQ */
113 #define INT_PORT1 (51) /* PORT1 IRQ */
114 #define INT_PORT2 (52) /* PORT2 IRQ */
115 #define INT_PORT3 (53) /* PORT3 IRQ */
116 #define INT_PORT4 (54) /* PORT4 IRQ */
117 #define INT_PORT5 (55) /* PORT5 IRQ */
118 #define INT_PORT6 (56) /* PORT6 IRQ */
120 #define NUM_INTERRUPTS (56)
121 //*****************************************************************************
123 // Macro to generate an interrupt priority mask based on the number of bits
124 // of priority supported by the hardware.
126 //*****************************************************************************
127 #define INT_PRIORITY_MASK ((0xFF << (8 - NUM_PRIORITY_BITS)) & 0xFF)
128 #define NUM_PRIORITY 8
130 #define NVIC_APINT_PRIGROUP_M 0x00000700 // Interrupt Priority Grouping
131 #define NVIC_APINT_PRIGROUP_7_1 0x00000000 // Priority group 7.1 split
132 #define NVIC_APINT_PRIGROUP_6_2 0x00000100 // Priority group 6.2 split
133 #define NVIC_APINT_PRIGROUP_5_3 0x00000200 // Priority group 5.3 split
134 #define NVIC_APINT_PRIGROUP_4_4 0x00000300 // Priority group 4.4 split
135 #define NVIC_APINT_PRIGROUP_3_5 0x00000400 // Priority group 3.5 split
136 #define NVIC_APINT_PRIGROUP_2_6 0x00000500 // Priority group 2.6 split
137 #define NVIC_APINT_PRIGROUP_1_7 0x00000600 // Priority group 1.7 split
138 #define NVIC_APINT_PRIGROUP_0_8 0x00000700 // Priority group 0.8 split
139 #define NVIC_SYS_PRI1_R 0xE000ED18 // System Handler Priority 1
140 #define NVIC_SYS_PRI2_R 0xE000ED1C // System Handler Priority 2
141 #define NVIC_SYS_PRI3_R 0xE000ED20 // System Handler Priority 3
142 #define NVIC_PRI0_R 0xE000E400 // Interrupt 0-3 Priority
143 #define NVIC_PRI1_R 0xE000E404 // Interrupt 4-7 Priority
144 #define NVIC_PRI2_R 0xE000E408 // Interrupt 8-11 Priority
145 #define NVIC_PRI3_R 0xE000E40C // Interrupt 12-15 Priority
146 #define NVIC_PRI4_R 0xE000E410 // Interrupt 16-19 Priority
147 #define NVIC_PRI5_R 0xE000E414 // Interrupt 20-23 Priority
148 #define NVIC_PRI6_R 0xE000E418 // Interrupt 24-27 Priority
149 #define NVIC_PRI7_R 0xE000E41C // Interrupt 28-31 Priority
150 #define NVIC_PRI8_R 0xE000E420 // Interrupt 32-35 Priority
151 #define NVIC_PRI9_R 0xE000E424 // Interrupt 36-39 Priority
152 #define NVIC_PRI10_R 0xE000E428 // Interrupt 40-43 Priority
153 #define NVIC_PRI11_R 0xE000E42C // Interrupt 44-47 Priority
154 #define NVIC_PRI12_R 0xE000E430 // Interrupt 48-51 Priority
155 #define NVIC_PRI13_R 0xE000E434 // Interrupt 52-55 Priority
156 #define NVIC_PRI14_R 0xE000E438 // Interrupt 56-59 Priority
157 #define NVIC_PRI15_R 0xE000E43C // Interrupt 60-63 Priority
158 #define NVIC_EN0_R 0xE000E100 // Interrupt 0-31 Set Enable
159 #define NVIC_EN1_R 0xE000E104 // Interrupt 32-54 Set Enable
160 #define NVIC_DIS0_R 0xE000E180 // Interrupt 0-31 Clear Enable
161 #define NVIC_DIS1_R 0xE000E184 // Interrupt 32-54 Clear Enable
162 #define NVIC_PEND0_R 0xE000E200 // Interrupt 0-31 Set Pending
163 #define NVIC_PEND1_R 0xE000E204 // Interrupt 32-54 Set Pending
164 #define NVIC_UNPEND0_R 0xE000E280 // Interrupt 0-31 Clear Pending
165 #define NVIC_UNPEND1_R 0xE000E284 // Interrupt 32-54 Clear Pending
166 //*****************************************************************************
168 // Prototypes for the APIs.
170 //*****************************************************************************
172 //*****************************************************************************
174 //! Enables the processor interrupt.
176 //! This function allows the processor to respond to interrupts. This function
177 //! does not affect the set of interrupts enabled in the interrupt controller;
178 //! it just gates the single interrupt from the controller to the processor.
180 //! \return Returns \b true if interrupts were disabled when the function was
181 //! called or \b false if they were initially enabled.
183 //*****************************************************************************
184 extern bool Interrupt_enableMaster(void);
186 //*****************************************************************************
188 //! Disables the processor interrupt.
190 //! This function prevents the processor from receiving interrupts. This
191 //! function does not affect the set of interrupts enabled in the interrupt
192 //! controller; it just gates the single interrupt from the controller to the
195 //! \return Returns \b true if interrupts were already disabled when the
196 //! function was called or \b false if they were initially enabled.
198 //*****************************************************************************
199 extern bool Interrupt_disableMaster(void);
201 //*****************************************************************************
203 //! Registers a function to be called when an interrupt occurs.
205 //! \param interruptNumber specifies the interrupt in question.
206 //! \param intHandler is a pointer to the function to be called.
208 //! \note The use of this function (directly or indirectly via a peripheral
209 //! driver interrupt register function) moves the interrupt vector table from
210 //! flash to SRAM. Therefore, care must be taken when linking the application
211 //! to ensure that the SRAM vector table is located at the beginning of SRAM;
212 //! otherwise the NVIC does not look in the correct portion of memory for the
213 //! vector table (it requires the vector table be on a 1 kB memory alignment).
214 //! Normally, the SRAM vector table is so placed via the use of linker scripts.
215 //! See the discussion of compile-time versus run-time interrupt handler
216 //! registration in the introduction to this chapter.
218 //! \note This function is only used if the customer wants to specify the
219 //! interrupt handler at run time. In most cases, this is done through means
220 //! of the user setting the ISR function pointer in the startup file. Refer
221 //! Refer to the Module Operation section for more details.
223 //! See \link Interrupt_enableInterrupt \endlink for details about the interrupt
228 //*****************************************************************************
229 extern void Interrupt_registerInterrupt(uint32_t interruptNumber,
230 void (*intHandler)(void));
232 //*****************************************************************************
234 //! Unregisters the function to be called when an interrupt occurs.
236 //! \param interruptNumber specifies the interrupt in question.
238 //! This function is used to indicate that no handler should be called when the
239 //! given interrupt is asserted to the processor. The interrupt source is
240 //! automatically disabled (via Interrupt_disableInterrupt()) if necessary.
242 //! \sa Interrupt_registerInterrupt() for important information about
243 //! registering interrupt handlers.
245 //! See \link Interrupt_enableInterrupt \endlink for details about the interrupt
250 //*****************************************************************************
251 extern void Interrupt_unregisterInterrupt(uint32_t interruptNumber);
253 //*****************************************************************************
255 //! Sets the priority grouping of the interrupt controller.
257 //! \param bits specifies the number of bits of preemptable priority.
259 //! This function specifies the split between preemptable priority levels and
260 //! sub-priority levels in the interrupt priority specification. The range of
261 //! the grouping values are dependent upon the hardware implementation; on
262 //! the MSP432 family, three bits are available for hardware interrupt
263 //! prioritization and therefore priority grouping values of three through
264 //! seven have the same effect.
268 //*****************************************************************************
269 extern void Interrupt_setPriorityGrouping(uint32_t bits);
271 //*****************************************************************************
273 //! Gets the priority grouping of the interrupt controller.
275 //! This function returns the split between preemptable priority levels and
276 //! sub-priority levels in the interrupt priority specification.
278 //! \return The number of bits of preemptable priority.
280 //*****************************************************************************
281 extern uint32_t Interrupt_getPriorityGrouping(void);
283 //*****************************************************************************
285 //! Sets the priority of an interrupt.
287 //! \param interruptNumber specifies the interrupt in question.
288 //! \param priority specifies the priority of the interrupt.
290 //! This function is used to set the priority of an interrupt. When multiple
291 //! interrupts are asserted simultaneously, the ones with the highest priority
292 //! are processed before the lower priority interrupts. Smaller numbers
293 //! correspond to higher interrupt priorities; priority 0 is the highest
294 //! interrupt priority.
296 //! The hardware priority mechanism only looks at the upper N bits of the
297 //! priority level (where N is 3 for the MSP432 family), so any
298 //! prioritization must be performed in those bits. The remaining bits can be
299 //! used to sub-prioritize the interrupt sources, and may be used by the
300 //! hardware priority mechanism on a future part. This arrangement allows
301 //! priorities to migrate to different NVIC implementations without changing
302 //! the gross prioritization of the interrupts.
304 //! See \link Interrupt_enableInterrupt \endlink for details about the interrupt
309 //*****************************************************************************
310 extern void Interrupt_setPriority(uint32_t interruptNumber, uint8_t priority);
312 //*****************************************************************************
314 //! Gets the priority of an interrupt.
316 //! \param interruptNumber specifies the interrupt in question.
318 //! This function gets the priority of an interrupt. See
319 //! Interrupt_setPriority() for a definition of the priority value.
321 //! See \link Interrupt_enableInterrupt \endlink for details about the interrupt
324 //! \return Returns the interrupt priority, or -1 if an invalid interrupt was
327 //*****************************************************************************
328 extern uint8_t Interrupt_getPriority(uint32_t interruptNumber);
330 //*****************************************************************************
332 //! Enables an interrupt.
334 //! \param interruptNumber specifies the interrupt to be enabled.
336 //! The specified interrupt is enabled in the interrupt controller. Other
337 //! enables for the interrupt (such as at the peripheral level) are unaffected
338 //! by this function.
340 //! Valid values will vary from part to part, so it is important to check the
341 //! device specific datasheet, however for MSP432 101 the following values can
348 //! - \b FAULT_SVCALL
350 //! - \b FAULT_PENDSV
351 //! - \b FAULT_SYSTICK
377 //! - \b INT_T32_INT1
378 //! - \b INT_T32_INT2
379 //! - \b INT_T32_INTC
383 //! - \b INT_DMA_INT3
384 //! - \b INT_DMA_INT2
385 //! - \b INT_DMA_INT1
386 //! - \b INT_DMA_INT0
396 //*****************************************************************************
397 extern void Interrupt_enableInterrupt(uint32_t interruptNumber);
399 //*****************************************************************************
401 //! Disables an interrupt.
403 //! \param interruptNumber specifies the interrupt to be disabled.
405 //! The specified interrupt is disabled in the interrupt controller. Other
406 //! enables for the interrupt (such as at the peripheral level) are unaffected
407 //! by this function.
409 //! See \link Interrupt_enableInterrupt \endlink for details about the interrupt
414 //*****************************************************************************
415 extern void Interrupt_disableInterrupt(uint32_t interruptNumber);
417 //*****************************************************************************
419 //! Returns if a peripheral interrupt is enabled.
421 //! \param interruptNumber specifies the interrupt to check.
423 //! This function checks if the specified interrupt is enabled in the interrupt
426 //! See \link Interrupt_enableInterrupt \endlink for details about the interrupt
429 //! \return A non-zero value if the interrupt is enabled.
431 //*****************************************************************************
432 extern bool Interrupt_isEnabled(uint32_t interruptNumber);
434 //*****************************************************************************
436 //! Pends an interrupt.
438 //! \param interruptNumber specifies the interrupt to be pended.
440 //! The specified interrupt is pended in the interrupt controller. Pending an
441 //! interrupt causes the interrupt controller to execute the corresponding
442 //! interrupt handler at the next available time, based on the current
443 //! interrupt state priorities. For example, if called by a higher priority
444 //! interrupt handler, the specified interrupt handler is not called until
445 //! after the current interrupt handler has completed execution. The interrupt
446 //! must have been enabled for it to be called.
448 //! See \link Interrupt_enableInterrupt \endlink for details about the interrupt
453 //*****************************************************************************
454 extern void Interrupt_pendInterrupt(uint32_t interruptNumber);
456 //*****************************************************************************
458 //! Un-pends an interrupt.
460 //! \param interruptNumber specifies the interrupt to be un-pended.
462 //! The specified interrupt is un-pended in the interrupt controller. This
463 //! will cause any previously generated interrupts that have not been handled
464 //! yet (due to higher priority interrupts or the interrupt no having been
465 //! enabled yet) to be discarded.
467 //! See \link Interrupt_enableInterrupt \endlink for details about the interrupt
472 //*****************************************************************************
473 extern void Interrupt_unpendInterrupt(uint32_t interruptNumber);
475 //*****************************************************************************
477 //! Sets the priority masking level
479 //! \param priorityMask is the priority level that is masked.
481 //! This function sets the interrupt priority masking level so that all
482 //! interrupts at the specified or lesser priority level are masked. Masking
483 //! interrupts can be used to globally disable a set of interrupts with
484 //! priority below a predetermined threshold. A value of 0 disables priority
487 //! Smaller numbers correspond to higher interrupt priorities. So for example
488 //! a priority level mask of 4 allows interrupts of priority level 0-3,
489 //! and interrupts with a numerical priority of 4 and greater are blocked.
491 //! The hardware priority mechanism only looks at the upper N bits of the
492 //! priority level (where N is 3 for the MSP432 family), so any
493 //! prioritization must be performed in those bits.
497 //*****************************************************************************
498 extern void Interrupt_setPriorityMask(uint8_t priorityMask);
500 //*****************************************************************************
502 //! Gets the priority masking level
504 //! This function gets the current setting of the interrupt priority masking
505 //! level. The value returned is the priority level such that all interrupts
506 //! of that and lesser priority are masked. A value of 0 means that priority
507 //! masking is disabled.
509 //! Smaller numbers correspond to higher interrupt priorities. So for example
510 //! a priority level mask of 4 allows interrupts of priority level 0-3,
511 //! and interrupts with a numerical priority of 4 and greater are blocked.
513 //! The hardware priority mechanism only looks at the upper N bits of the
514 //! priority level (where N is 3 for the MSP432 family), so any
515 //! prioritization must be performed in those bits.
517 //! \return Returns the value of the interrupt priority level mask.
519 //*****************************************************************************
520 extern uint8_t Interrupt_getPriorityMask(void);
522 //*****************************************************************************
524 //! Sets the address of the vector table. This function is for advanced users
525 //! who might want to switch between multiple instances of vector tables
526 //! (perhaps between flash/ram).
528 //! \param addr is the new address of the vector table.
532 //*****************************************************************************
533 extern void Interrupt_setVectorTableAddress(uint32_t addr);
535 //*****************************************************************************
537 //! Returns the address of the interrupt vector table.
539 //! \return Address of the vector table.
541 //*****************************************************************************
542 extern uint32_t Interrupt_getVectorTableAddress(void);
544 //*****************************************************************************
546 //! Enables the processor to sleep when exiting an ISR. For low power operation,
547 //! this is ideal as power cycles are not wasted with the processing required
548 //! for waking up from an ISR and going back to sleep.
552 //*****************************************************************************
553 extern void Interrupt_enableSleepOnIsrExit(void);
555 //*****************************************************************************
557 //! Disables the processor to sleep when exiting an ISR.
561 //*****************************************************************************
562 extern void Interrupt_disableSleepOnIsrExit(void);
564 //*****************************************************************************
566 // Mark the end of the C bindings section for C++ compilers.
568 //*****************************************************************************
573 //*****************************************************************************
575 // Close the Doxygen group.
578 //*****************************************************************************
580 #endif // __INTERRUPT_H__