interface/vcos/vcos_legacy_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 - legacy (Nucleus) IRQ support
  30 =============================================================================*/
  31
  32 #ifndef VCOS_LEGACY_ISR_H
  33 #define VCOS_LEGACY_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 /** \file vcos_legacy_isr.h
  43   *
  44   * API for dispatching interrupts the Nucleus way, via a LISR and HISR.
  45   * New code should use the single-dispatch scheme - the LISR/HISR
  46   * distinction is not necessary.
  47   *
  48   * Under ThreadX, a HISR is implemented as a high-priority thread which
  49   * waits on a counting semaphore to call the HISR function. Although this
  50   * provides a good approximation to the Nucleus semantics, it is potentially
  51   * slow if all you are trying to do is to wake a thread from LISR context.
  52   */
  53
  54 /** Register a LISR. This is identical to the NU_Register_LISR API.
  55   */
  56 VCOS_INLINE_DECL
  57 VCOS_STATUS_T vcos_register_legacy_lisr(VCOS_UNSIGNED vecnum,
  58                                         void (*lisr)(VCOS_INT),
  59                                         void (**old_lisr)(VCOS_INT));
  60
  61 VCOS_INLINE_DECL
  62 VCOS_STATUS_T vcos_legacy_hisr_create(VCOS_HISR_T *hisr, const char *name,
  63                                       void (*entry)(void),
  64                                       VCOS_UNSIGNED pri,
  65                                       void *stack, VCOS_UNSIGNED stack_size);
  66
  67 /** Activate a HISR. On an OS which has no distinction between a HISR and LISR,
  68   * this may use some kind of emulation, which could well be less efficient than
  69   * a normal ISR.`
  70   *
  71   * @param hisr HISR to activate.
  72   */
  73 VCOS_INLINE_DECL
  74 void vcos_legacy_hisr_activate(VCOS_HISR_T *hisr);
  75
  76 /** Delete a HISR.
  77   *
  78   * @param hisr HISR to delete.
  79   */
  80 VCOS_INLINE_DECL
  81 void vcos_legacy_hisr_delete(VCOS_HISR_T *hisr);
  82
  83 /** Are we in a legacy LISR?
  84   *
  85   * @return On Nucleus, non-zero if in a LISR. On other platforms, non-zero if
  86   * in an interrupt.
  87   */
  88 VCOS_INLINE_DECL
  89 int vcos_in_legacy_lisr(void);
  90
  91 /** Is the current thread actually a fake HISR thread? Only implemented
  92   * on platforms that fake up HISRs.
  93   */
  94
  95 #ifndef VCOS_LISRS_NEED_HISRS
  96 VCOSPRE_ int VCOSPOST_ vcos_current_thread_is_fake_hisr_thread(VCOS_HISR_T *);
  97 #endif
  98
  99 #ifdef __cplusplus
 100 }
 101 #endif
 102 #endif