interface/vcos/vcos_isr.h

   1 /*
   2 Copyright (c) 2012, Broadcom Europe Ltd
   3 All rights reserved.
   4
   5 Redistribution and use in source and binary forms, with or without
   6 modification, are permitted provided that the following conditions are met:
   7     * Redistributions of source code must retain the above copyright
   8       notice, this list of conditions and the following disclaimer.
   9     * Redistributions in binary form must reproduce the above copyright
  10       notice, this list of conditions and the following disclaimer in the
  11       documentation and/or other materials provided with the distribution.
  12     * Neither the name of the copyright holder nor the
  13       names of its contributors may be used to endorse or promote products
  14       derived from this software without specific prior written permission.
  15
  16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  17 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
  20 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 */
  27
  28 /*=============================================================================
  29 VideoCore OS Abstraction Layer - IRQ support
  30 =============================================================================*/
  31
  32 #ifndef VCOS_ISR_H
  33 #define VCOS_ISR_H
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 #include "interface/vcos/vcos_types.h"
  40 #include "vcos.h"
  41
  42 /**
  43   * \file vcos_isr.h
  44   *
  45   * \section isr ISR support
  46   *
  47   * API for dispatching interrupts.
  48   */
  49
  50 /**
  51   *
  52   * Register an interrupt handler. The old handler (if any) is returned in
  53   * old_handler. The old handler should be called if the interrupt was not
  54   * for you.
  55   *
  56   * The handler function will be called in a context with interrupts disabled,
  57   * so should be written to be as short as possible. If significant processing
  58   * is needed, the handler should delegate to a thread.
  59   *
  60   * The handler function can call any OS primitive that does not block (e.g.
  61   * post a semaphore or set an event flag). Blocking operations (including memory
  62   * allocation from the system heap) are not permitted.
  63   *
  64   * To deregister an ISR, pass in NULL.
  65   *
  66   * @param vec  Vector to register for
  67   * @param handler Handler to be called
  68   * @param old_handler Updated with the old handler, or NULL.
  69   */
  70
  71 VCOS_INLINE_DECL
  72 void vcos_register_isr(VCOS_UNSIGNED vec,
  73                        VCOS_ISR_HANDLER_T handler,
  74                        VCOS_ISR_HANDLER_T *old_handler);
  75
  76 /** Disable interrupts, returning the old value (enabled/disabled) to the caller.
  77   */
  78 VCOS_INLINE_DECL
  79 VCOS_UNSIGNED vcos_int_disable(void);
  80
  81 /** Restore the previous interrupt enable/disable state.
  82   */
  83 VCOS_INLINE_DECL
  84 void vcos_int_restore(VCOS_UNSIGNED previous);
  85
  86 #ifdef __cplusplus
  87 }
  88 #endif
  89 #endif
  90