shared/irq/irq-entry-remove.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSImplClassicIntr
0007  *
0008  * @brief This source file contains the implementation of
0009  *   rtems_interrupt_entry_remove() and bsp_interrupt_entry_remove().
0010  */
0011
0012 /*
0013  * Copyright (C) 2021 embedded brains GmbH & Co. KG
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #include <bsp/irq-generic.h>
0038
0039 void bsp_interrupt_entry_remove(
0040   rtems_vector_number     vector,
0041   rtems_interrupt_entry  *entry,
0042   rtems_interrupt_entry **previous_next
0043 )
0044 {
0045   rtems_vector_number    index;
0046   rtems_interrupt_entry *first;
0047   rtems_interrupt_entry *entry_next;
0048
0049   index = bsp_interrupt_dispatch_index( vector );
0050   first = *bsp_interrupt_get_dispatch_table_slot( index );
0051   entry_next = entry->next;
0052
0053   if ( entry == first && entry_next == NULL ) {
0054     /* We remove the last installed entry */
0055     bsp_interrupt_vector_disable( vector );
0056 #if defined(bsp_interrupt_vector_remove)
0057     bsp_interrupt_vector_remove( vector );
0058 #else
0059     bsp_interrupt_vector_disable( vector );
0060 #endif
0061     bsp_interrupt_set_handler_unique( index, false );
0062 #if defined(BSP_INTERRUPT_USE_INDEX_TABLE)
0063     bsp_interrupt_dispatch_index_table[ vector ] = 0;
0064 #endif
0065   }
0066
0067   bsp_interrupt_entry_store_release( previous_next, entry_next );
0068 }
0069
0070 static rtems_status_code bsp_interrupt_entry_do_remove(
0071   rtems_vector_number     vector,
0072   rtems_interrupt_entry  *entry
0073 )
0074 {
0075   rtems_interrupt_entry  *installed;
0076   rtems_interrupt_entry **previous_next;
0077
0078   installed = bsp_interrupt_entry_find(
0079     vector,
0080     entry->handler,
0081     entry->arg,
0082     &previous_next
0083   );
0084
0085   if ( installed != entry ) {
0086     return RTEMS_UNSATISFIED;
0087   }
0088
0089   bsp_interrupt_entry_remove( vector, entry, previous_next );
0090
0091   return RTEMS_SUCCESSFUL;
0092 }
0093
0094 rtems_status_code rtems_interrupt_entry_remove(
0095   rtems_vector_number    vector,
0096   rtems_interrupt_entry *entry
0097 )
0098 {
0099   rtems_status_code sc;
0100
0101   if ( entry == NULL ) {
0102     return RTEMS_INVALID_ADDRESS;
0103   }
0104
0105   sc = bsp_interrupt_check_and_lock( vector, entry->handler );
0106
0107   if ( sc != RTEMS_SUCCESSFUL ) {
0108     return sc;
0109   }
0110
0111   sc = bsp_interrupt_entry_do_remove( vector, entry );
0112   bsp_interrupt_unlock();
0113
0114   return sc;
0115 }