/*      $NetBSD: OsdInterrupt.c,v 1.9 2018/03/20 12:14:52 bouyer Exp $  */

/*
* Copyright 2001 Wasabi Systems, Inc.
* All rights reserved.
*
* Written by Jason R. Thorpe for Wasabi Systems, Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
*    must display the following acknowledgement:
*      This product includes software developed for the NetBSD Project by
*      Wasabi Systems, Inc.
* 4. The name of Wasabi Systems, Inc. may not be used to endorse
*    or promote products derived from this software without specific prior
*    written permission.
*
* THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/

/*
* OS Services Layer
*
* 6.5: Interrupt Handling
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: OsdInterrupt.c,v 1.9 2018/03/20 12:14:52 bouyer Exp $");

#include <sys/param.h>
#include <sys/malloc.h>
#include <sys/mutex.h>
#include <sys/queue.h>

#include <dev/acpi/acpica.h>

#include <machine/acpi_machdep.h>

#define _COMPONENT      ACPI_OS_SERVICES
ACPI_MODULE_NAME("INTERRUPT")

MALLOC_DEFINE(M_ACPI, "acpi", "Advanced Configuration and Power Interface");

/*
* We're lucky -- ACPI uses the same convention for interrupt service
* routine return values at NetBSD does -- so we can just ask MD code
* to hook it up directly (ACPI interrupts are always level triggered
* and shareable, and return 0 for "not handled" and 1 for "handled").
*/

struct acpi_interrupt_handler {
       LIST_ENTRY(acpi_interrupt_handler) aih_list;
       UINT32 aih_intrnum;
       ACPI_OSD_HANDLER aih_func;
       void *aih_ih;
};

static LIST_HEAD(, acpi_interrupt_handler) acpi_interrupt_list =
   LIST_HEAD_INITIALIZER(&acpi_interrupt_list);

kmutex_t acpi_interrupt_list_mtx;

/*
* AcpiOsInstallInterruptHandler:
*
*      Install a handler for a hardware interrupt level.
*/
ACPI_STATUS
AcpiOsInstallInterruptHandler(UINT32 InterruptNumber,
   ACPI_OSD_HANDLER ServiceRoutine, void *Context)
{
       return AcpiOsInstallInterruptHandler_xname(InterruptNumber,
           ServiceRoutine, Context, "acpi SCI");
}

ACPI_STATUS
AcpiOsInstallInterruptHandler_xname(UINT32 InterruptNumber,
   ACPI_OSD_HANDLER ServiceRoutine, void *Context, const char *xname)
{
       struct acpi_interrupt_handler *aih;
       ACPI_STATUS rv;

       if (InterruptNumber > 255)
               return AE_BAD_PARAMETER;
       if (ServiceRoutine == NULL)
               return AE_BAD_PARAMETER;

       aih = malloc(sizeof(*aih), M_ACPI, M_NOWAIT);
       if (aih == NULL)
               return AE_NO_MEMORY;

       aih->aih_intrnum = InterruptNumber;
       aih->aih_func = ServiceRoutine;

       rv = acpi_md_OsInstallInterruptHandler(InterruptNumber,
           ServiceRoutine, Context, &aih->aih_ih, xname);
       if (rv == AE_OK) {
               mutex_enter(&acpi_interrupt_list_mtx);
               LIST_INSERT_HEAD(&acpi_interrupt_list, aih, aih_list);
               mutex_exit(&acpi_interrupt_list_mtx);
       } else
               free(aih, M_ACPI);

       return rv;
}

/*
* AcpiOsRemoveInterruptHandler:
*
*      Remove an interrupt handler.
*/
ACPI_STATUS
AcpiOsRemoveInterruptHandler(UINT32 InterruptNumber,
   ACPI_OSD_HANDLER ServiceRoutine)
{
       struct acpi_interrupt_handler *aih;

       if (InterruptNumber > 255)
               return AE_BAD_PARAMETER;
       if (ServiceRoutine == NULL)
               return AE_BAD_PARAMETER;

       mutex_enter(&acpi_interrupt_list_mtx);
       LIST_FOREACH(aih, &acpi_interrupt_list, aih_list) {
               if (aih->aih_intrnum == InterruptNumber &&
                   aih->aih_func == ServiceRoutine) {
                       LIST_REMOVE(aih, aih_list);
                       mutex_exit(&acpi_interrupt_list_mtx);
                       acpi_md_OsRemoveInterruptHandler(aih->aih_ih);
                       free(aih, M_ACPI);
                       return AE_OK;
               }
       }
       mutex_exit(&acpi_interrupt_list_mtx);
       return AE_NOT_EXIST;
}