/****************************************************************************
 * include/nuttx/irq.h
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 ****************************************************************************/

#ifndef __INCLUDE_NUTTX_IRQ_H
#define __INCLUDE_NUTTX_IRQ_H

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>

#ifndef __ASSEMBLY__
#  include <stdint.h>
#  include <stdbool.h>
#endif

/* Now include architecture-specific types */

#include <arch/irq.h>

/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/

/* IRQ detach is a convenience definition, it detach all the handlers
 * sharing the same IRQ. Detaching an interrupt handler is equivalent to
 * setting a NULL interrupt handler.
 */

#define irq_detach(irq) irq_attach(irq, NULL, NULL)
#define irq_detach_wqueue(irq) irq_attach_wqueue(irq, NULL, NULL, NULL, 0)
#define irq_detach_thread(irq) irq_attach_thread(irq, NULL, NULL, NULL, 0, 0)

/* Maximum/minimum values of IRQ integer types */

#if NR_IRQS <= 256
#  define IRQT_MAX UINT8_MAX
#elif NR_IRQS <= 65536
#  define IRQT_MAX UINT16_MAX
#else
#  define IRQT_MAX UINT32_MAX
#endif

#ifdef CONFIG_ARCH_MINIMAL_VECTORTABLE
#  if CONFIG_ARCH_NUSER_INTERRUPTS <= 256
#    define IRQMAPPED_MAX UINT8_MAX
#  elif CONFIG_ARCH_NUSER_INTERRUPTS <= 65536
#    define IRQMAPPED_MAX UINT16_MAX
#  else
#    define IRQMAPPED_MAX UINT32_MAX
#  endif
#endif

#if defined(CONFIG_ARCH_MINIMAL_VECTORTABLE) && \
    !defined(CONFIG_ARCH_NUSER_INTERRUPTS)
#  error CONFIG_ARCH_NUSER_INTERRUPTS is not defined
#endif

#if defined(CONFIG_ARCH_MINIMAL_VECTORTABLE_DYNAMIC)
#  if defined(CONFIG_ARCH_IRQ_TO_NDX)
#    define IRQ_TO_NDX(irq) \
       ((irq) < 0 || (irq) >= NR_IRQS ? -EINVAL : up_irq_to_ndx(irq))
#  else
#    define IRQ_TO_NDX(irq) \
       ((irq) < 0 || (irq) >= NR_IRQS ? -EINVAL : \
        (g_irqmap[irq] ? g_irqmap[irq] : irq_to_ndx(irq)))
#  endif
#  define NDX_TO_IRQ(ndx) g_irqrevmap[ndx]
#elif defined(CONFIG_ARCH_MINIMAL_VECTORTABLE)
#  define IRQ_TO_NDX(irq) \
     ((irq) < 0 || (irq) >= NR_IRQS ? -EINVAL : \
      (g_irqmap[(irq)] < CONFIG_ARCH_NUSER_INTERRUPTS ? g_irqmap[(irq)] : -EINVAL))
#  define NDX_TO_IRQ(ndx) ndx_to_irq(ndx)
#else
#  define IRQ_TO_NDX(irq) ((irq) < 0 || (irq) >= NR_IRQS ? -EINVAL : (irq))
#  define NDX_TO_IRQ(ndx) (ndx)
#endif

#ifdef CONFIG_SMP
#  define cpu_irqlock_clear() \
  do \
    { \
      g_cpu_irqset = 0; \
      spin_unlock_notrace(&g_cpu_irqlock); \
    } \
  while (0)
#endif

/* Stack alignment macros */

#ifdef CONFIG_TLS_ALIGNED
#  define STACK_ALIGNMENT        TLS_STACK_ALIGN
#else
#  define STACK_ALIGNMENT        STACKFRAME_ALIGN
#endif

#define STACK_ALIGN_MASK         (STACK_ALIGNMENT - 1)
#define STACK_ALIGN_DOWN(a)      ((a) & ~STACK_ALIGN_MASK)
#define STACK_ALIGN_UP(a)        (((a) + STACK_ALIGN_MASK) & ~STACK_ALIGN_MASK)

#define STACKFRAME_ALIGN_MASK    (STACKFRAME_ALIGN - 1)
#define STACKFRAME_ALIGN_DOWN(a) ((a) & ~STACKFRAME_ALIGN_MASK)
#define STACKFRAME_ALIGN_UP(a)   (((a) + STACKFRAME_ALIGN_MASK) & ~STACKFRAME_ALIGN_MASK)

/* Aligned size of the kernel stack */

#ifdef CONFIG_ARCH_KERNEL_STACK
#  define ARCH_KERNEL_STACKSIZE STACKFRAME_ALIGN_UP(CONFIG_ARCH_KERNEL_STACKSIZE)
#endif

/* Interrupt was handled by this device */

#define IRQ_HANDLED     0

/* Handler requests to wake the handler thread */

#define IRQ_WAKE_THREAD 1

/* Scheduling monitor */

#ifndef CONFIG_SCHED_CRITMONITOR_MAXTIME_THREAD
#  define CONFIG_SCHED_CRITMONITOR_MAXTIME_THREAD -1
#endif

#ifndef CONFIG_SCHED_CRITMONITOR_MAXTIME_WQUEUE
#  define CONFIG_SCHED_CRITMONITOR_MAXTIME_WQUEUE -1
#endif

#ifndef CONFIG_SCHED_CRITMONITOR_MAXTIME_PREEMPTION
#  define CONFIG_SCHED_CRITMONITOR_MAXTIME_PREEMPTION -1
#endif

#ifndef CONFIG_SCHED_CRITMONITOR_MAXTIME_CSECTION
#  define CONFIG_SCHED_CRITMONITOR_MAXTIME_CSECTION -1
#endif

#ifndef CONFIG_SCHED_CRITMONITOR_MAXTIME_BUSYWAIT
#  define CONFIG_SCHED_CRITMONITOR_MAXTIME_BUSYWAIT -1
#endif

#ifndef CONFIG_SCHED_CRITMONITOR_MAXTIME_IRQ
#  define CONFIG_SCHED_CRITMONITOR_MAXTIME_IRQ -1
#endif

#ifndef CONFIG_SCHED_CRITMONITOR_MAXTIME_WDOG
#  define CONFIG_SCHED_CRITMONITOR_MAXTIME_WDOG -1
#endif

/****************************************************************************
 * Public Types
 ****************************************************************************/

#ifndef __ASSEMBLY__
/* This type is an unsigned integer type large enough to hold the largest
 * IRQ number.
 */

#if NR_IRQS <= 256
typedef uint8_t irq_t;
#elif NR_IRQS <= 65536
typedef uint16_t irq_t;
#else
typedef uint32_t irq_t;
#endif

/* This type is an unsigned integer type large enough to hold the largest
 * mapped vector table index.
 */

#ifdef CONFIG_ARCH_MINIMAL_VECTORTABLE
#if CONFIG_ARCH_NUSER_INTERRUPTS <= 256
typedef uint8_t irq_mapped_t;
#elif CONFIG_ARCH_NUSER_INTERRUPTS <= 65536
typedef uint16_t irq_mapped_t;
#else
typedef uint32_t irq_mapped_t;
#endif
#endif /* CONFIG_ARCH_MINIMAL_VECTORTABLE */

/* This struct defines the form of an interrupt service routine */

typedef CODE int (*xcpt_t)(int irq, FAR void *context, FAR void *arg);
#endif /* __ASSEMBLY__ */

/****************************************************************************
 * Public Data
 ****************************************************************************/

#ifndef __ASSEMBLY__
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif

/* This is the interrupt vector mapping table.  This must be provided by
 * architecture specific logic if CONFIG_ARCH_MINIMAL_VECTORTABLE is define
 * in the configuration.
 *
 * REVISIT: Currently declared in sched/irq/irq.h.  This declaration here
 * introduces a circular dependency since it depends on NR_IRQS which is
 * defined in arch/irq.h but arch/irq.h includes nuttx/irq.h and we get
 * here with NR_IRQS undefined.
 */

#if defined(CONFIG_ARCH_MINIMAL_VECTORTABLE_DYNAMIC)
#  if !defined(CONFIG_ARCH_IRQ_TO_NDX)
extern irq_mapped_t g_irqmap[];
#  endif
extern int g_irqrevmap[];
int irq_to_ndx(int irq);
#elif defined(CONFIG_ARCH_MINIMAL_VECTORTABLE)
extern const irq_mapped_t g_irqmap[];
int ndx_to_irq(int ndx);
#endif

/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/

/****************************************************************************
 * Name: irq_attach
 *
 * Description:
 *   Configure the IRQ subsystem so that IRQ number 'irq' is dispatched to
 *   'isr' with argument 'arg'
 *
 ****************************************************************************/

int irq_attach(int irq, xcpt_t isr, FAR void *arg);

/****************************************************************************
 * Name: irq_attach_thread
 *
 * Description:
 *   Configure the IRQ subsystem so that IRQ number 'irq' is dispatched to
 *   'isrthread'
 *
 * Input Parameters:
 *   irq - Irq num
 *   isr - Function to be called when the IRQ occurs, called in interrupt
 *   context.
 *   If isr is NULL the default handler is installed(irq_default_handler).
 *   isrthread - called in thread context, If the isrthread is NULL,
 *   then the ISR is being detached.
 *   arg - privdate data
 *   priority   - Priority of the new task
 *   stack_size - size (in bytes) of the stack needed
 *
 * Returned Value:
 *   Zero on success; a negated errno value on failure.
 *
 ****************************************************************************/

int irq_attach_thread(int irq, xcpt_t isr, xcpt_t isrthread, FAR void *arg,
                      int priority, int stack_size);

/****************************************************************************
 * Name: irq_attach_wqueue
 *
 * Description:
 *   Configure the IRQ subsystem so that IRQ number 'irq' is dispatched to
 *   'wqueue'
 *
 * Input Parameters:
 *   irq - Irq num
 *   isr - Function to be called when the IRQ occurs, called in interrupt
 *   context.
 *   If isr is NULL the default handler is installed(irq_default_handler).
 *   isrwork - called in thread context, If the isrwork is NULL,
 *   then the ISR is being detached.
 *   arg - privdate data
 *   priority - isrwork pri
 *
 * Returned Value:
 *   Zero on success; a negated errno value on failure.
 *
 ****************************************************************************/

int irq_attach_wqueue(int irq, xcpt_t isr, xcpt_t isrwork,
                      FAR void *arg, int priority);

#ifdef CONFIG_IRQCHAIN
int irqchain_detach(int irq, xcpt_t isr, FAR void *arg);
#else
#  define irqchain_detach(irq, isr, arg) irq_detach(irq)
#endif

/****************************************************************************
 * Name: enter_critical_section
 *
 * Description:
 *   If thread-specific IRQ counter is enabled (for SMP or other
 *   instrumentation):
 *
 *     Take the CPU IRQ lock and disable interrupts on all CPUs.  A thread-
 *     specific counter is incremented to indicate that the thread has IRQs
 *     disabled and to support nested calls to enter_critical_section().
 *
 *     NOTE: Most architectures do not support disabling all CPUs from one
 *     CPU.  ARM is an example.  In such cases, logic in
 *     enter_critical_section() will still manage entrance into the
 *     protected logic using spinlocks.
 *
 *   If thread-specific IRQ counter is not enabled:
 *
 *     This function is equivalent to up_irq_save().
 *
 * Input Parameters:
 *   None
 *
 * Returned Value:
 *   An opaque, architecture-specific value that represents the state of
 *   the interrupts prior to the call to enter_critical_section();
 *
 ****************************************************************************/

#ifdef CONFIG_IRQCOUNT
#  if CONFIG_SCHED_CRITMONITOR_MAXTIME_CSECTION >= 0 || \
      CONFIG_SCHED_CRITMONITOR_MAXTIME_BUSYWAIT >= 0 || \
      defined(CONFIG_SCHED_INSTRUMENTATION_CSECTION)
irqstate_t enter_critical_section(void) noinstrument_function;
#  else
#    define enter_critical_section() enter_critical_section_notrace()
#  endif

irqstate_t enter_critical_section_notrace(void) noinstrument_function;
#else
#  define enter_critical_section() up_irq_save()
#  define enter_critical_section_notrace() up_irq_save()
#endif

/****************************************************************************
 * Name: leave_critical_section
 *
 * Description:
 *   If thread-specific IRQ counter is enabled (for SMP or other
 *   instrumentation):
 *
 *     Decrement the IRQ lock count and if it decrements to zero then release
 *     the spinlock and restore the interrupt state as it was prior to the
 *     previous call to enter_critical_section().
 *
 *   If thread-specific IRQ counter is not enabled:
 *
 *     This function is equivalent to up_irq_restore().
 *
 * Input Parameters:
 *   flags - The architecture-specific value that represents the state of
 *           the interrupts prior to the call to enter_critical_section();
 *
 * Returned Value:
 *   None
 *
 ****************************************************************************/

#ifdef CONFIG_IRQCOUNT
#  if CONFIG_SCHED_CRITMONITOR_MAXTIME_CSECTION >= 0 || \
      defined(CONFIG_SCHED_INSTRUMENTATION_CSECTION)
void leave_critical_section(irqstate_t flags) noinstrument_function;
#  else
#    define leave_critical_section(f) leave_critical_section_notrace(f)
#  endif

void leave_critical_section_notrace(irqstate_t flags) noinstrument_function;
#else
#  define leave_critical_section(f) up_irq_restore(f)
#  define leave_critical_section_notrace(f) up_irq_restore(f)
#endif

/****************************************************************************
 * Name: restore_critical_section
 *
 * Description:
 *   Restore the critical_section
 *
 * Input Parameters:
 *   None
 *
 * Returned Value:
 *   None
 *
 ****************************************************************************/

#ifdef CONFIG_SMP
#  define restore_critical_section(tcb, cpu) \
   do { \
       if (tcb->irqcount <= 0) \
         {\
           if ((g_cpu_irqset & (1 << cpu)) != 0) \
             { \
               cpu_irqlock_clear(); \
             } \
         } \
    } while (0)
#else
#  define restore_critical_section(tcb, cpu)
#endif

#undef EXTERN
#ifdef __cplusplus
}
#endif

#endif /* __ASSEMBLY__ */
#endif /* __INCLUDE_NUTTX_IRQ_H */
