include/bsp/irq.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*
0004  * RTEMS virtex BSP
0005  *
0006  * This file declares constants of the interrupt controller.
0007  */
0008
0009 /*
0010  * Copyright (c) 2007 embedded brains GmbH & Co. KG
0011  *
0012  * Redistribution and use in source and binary forms, with or without
0013  * modification, are permitted provided that the following conditions
0014  * are met:
0015  * 1. Redistributions of source code must retain the above copyright
0016  *    notice, this list of conditions and the following disclaimer.
0017  * 2. Redistributions in binary form must reproduce the above copyright
0018  *    notice, this list of conditions and the following disclaimer in the
0019  *    documentation and/or other materials provided with the distribution.
0020  *
0021  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0022  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0023  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0024  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0025  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0026  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0027  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0028  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0029  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0030  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0031  * POSSIBILITY OF SUCH DAMAGE.
0032  */
0033
0034 #ifndef VIRTEX4_IRQ_IRQ_H
0035 #define VIRTEX4_IRQ_IRQ_H
0036
0037 #include <rtems/irq.h>
0038 #include <bsp/irq-default.h>
0039
0040 /*
0041  * the following definitions specify the indices used
0042  * to interface the interrupt handler API
0043  */
0044
0045 /*
0046  * Peripheral IRQ handlers related definitions
0047  */
0048   /* Not supported at this level */
0049
0050 /*
0051  * Processor IRQ handlers related definitions
0052  */
0053 #define BSP_PROCESSOR_IRQ_NUMBER        3
0054 #define BSP_PROCESSOR_IRQ_LOWEST_OFFSET 0
0055 #define BSP_PROCESSOR_IRQ_MAX_OFFSET    (BSP_PROCESSOR_IRQ_LOWEST_OFFSET\
0056                                          +BSP_PROCESSOR_IRQ_NUMBER-1)
0057
0058 #define BSP_IS_PROCESSOR_IRQ(irqnum)                 \
0059   (((irqnum) >= BSP_PROCESSOR_IRQ_LOWEST_OFFSET) &&  \
0060    ((irqnum) <= BSP_PROCESSOR_IRQ_MAX_OFFSET))
0061
0062 /*
0063  * Summary
0064  */
0065 #define BSP_IRQ_NUMBER                  (BSP_PROCESSOR_IRQ_MAX_OFFSET+1)
0066 #define BSP_LOWEST_OFFSET                BSP_PROCESSOR_IRQ_LOWEST_OFFSET
0067 #define BSP_MAX_OFFSET                   BSP_PROCESSOR_IRQ_MAX_OFFSET
0068
0069 #define BSP_IS_VALID_IRQ(irqnum)        (BSP_IS_PROCESSOR_IRQ(irqnum))
0070
0071 #ifndef ASM
0072 #ifdef __cplusplus
0073 extern "C" {
0074 #endif
0075
0076 /*
0077  * index table for the module specific handlers, a few entries are only placeholders
0078  */
0079   typedef enum {
0080     BSP_EXT               = BSP_PROCESSOR_IRQ_LOWEST_OFFSET + 0,
0081     BSP_PIT               = BSP_PROCESSOR_IRQ_LOWEST_OFFSET + 1,
0082     BSP_CRIT              = BSP_PROCESSOR_IRQ_LOWEST_OFFSET + 2
0083   } rtems_irq_symbolic_name;
0084
0085   extern rtems_irq_connect_data *BSP_rtems_irq_tbl;
0086   void BSP_irqexc_on_fnc(const rtems_irq_connect_data *conn_data);
0087   void BSP_irqexc_off_fnc(const rtems_irq_connect_data *unused);
0088   void BSP_rtems_irq_mngt_init(unsigned cpuId);
0089
0090 #ifdef __cplusplus
0091 }
0092 #endif
0093 #endif /* ASM */
0094
0095 #endif /* VIRTEX4_IRQ_IRQ_H */