source: rtems/c/src/lib/libbsp/shared/include/irq.h @ 2d6543d4

4.115
Last change on this file since 2d6543d4 was 2d6543d4, checked in by Daniel Ramirez <javamonn@…>, on 11/30/13 at 02:18:44

doxygen: refactored doxygen in libbsp/arm/lpc32xx

This patch refactors a lot of the existing doxygen within libbsp/arm/lpc32xx.
Much of this refactoring was just renaming of existing groups to conform to a
more consistent naming structure. With the addition of a doxygen header for
tm27.h, all files within lpc32xx belong to doxygen group now. lpc32xx should
be used a reference for adding doxygen to other bsps.

  • Property mode set to 100644
File size: 1.7 KB
Line 
1/**
2 * @file
3 *
4 * @ingroup bsp_interrupt
5 *
6 * @brief BSP interrupt support configuration template.
7 */
8
9/*
10 * Based on concepts of Pavel Pisa, Till Straumann and Eric Valette.
11 *
12 * Copyright (c) 2008, 2009, 2010
13 * embedded brains GmbH
14 * Obere Lagerstr. 30
15 * D-82178 Puchheim
16 * Germany
17 * <rtems@embedded-brains.de>
18 *
19 * The license and distribution terms for this file may be
20 * found in the file LICENSE in this distribution or at
21 * http://www.rtems.com/license/LICENSE.
22 */
23
24#ifndef LIBBSP_SHARED_IRQ_CONFIG_H
25#define LIBBSP_SHARED_IRQ_CONFIG_H
26
27#include <stdint.h>
28
29/**
30 * @brief Minimum vector number.
31 */
32#define BSP_INTERRUPT_VECTOR_MIN 0
33
34/**
35 * @brief Maximum vector number.
36 */
37#define BSP_INTERRUPT_VECTOR_MAX 0
38
39/**
40 * @brief Enables the index table.
41 *
42 * If you enable the index table, you have to define a size for the handler
43 * table (@ref BSP_INTERRUPT_HANDLER_TABLE_SIZE) and must provide an integer
44 * type capable to index the complete handler table (@ref
45 * bsp_interrupt_handler_index_type).
46 */
47#undef BSP_INTERRUPT_USE_INDEX_TABLE
48
49/**
50 * @brief Disables usage of the heap.
51 *
52 * If you define this, you have to define @ref BSP_INTERRUPT_USE_INDEX_TABLE as
53 * well.
54 */
55#undef BSP_INTERRUPT_NO_HEAP_USAGE
56
57#ifdef BSP_INTERRUPT_USE_INDEX_TABLE
58  /**
59   * @brief Size of the handler table.
60   */
61  #define BSP_INTERRUPT_HANDLER_TABLE_SIZE 0
62
63  /**
64   * @brief Integer type capable to index the complete handler table.
65   */
66  typedef uint8_t bsp_interrupt_handler_index_type;
67#endif
68
69/**
70 * @brief Enable custom vector checking
71 *
72 * If defined the BSP must implement the custom bsp_interrupt_is_valid_vector()
73 * vector validator check routine.
74 */
75#undef BSP_INTERRUPT_CUSTOM_VALID_VECTOR
76
77#endif /* LIBBSP_SHARED_IRQ_CONFIG_H */
Note: See TracBrowser for help on using the repository browser.