/*
 * Copyright (c) 2025 Ian Marco Moffett and L5 engineers
 * All rights reserved.
 *
 * 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. Neither the name of the project nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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.
 */

#ifndef _MACHINE_IOAPIC_H_
#define _MACHINE_IOAPIC_H_ 1

/* Mask arguments for ioapic_gsi_mask() */
#define IOAPIC_PIN_MASK     1
#define IOAPIC_PIN_UNMASK   0

/*
 * Initialize the I/O APIC into a basic state,
 * all interrupts will be masked.
 */
void ioapic_init(void);

/*
 * Mask or unmask a global system interrupt by index
 *
 * @gsi: Global system interrupt to mask
 * @mask: 1->masked,0->unmasked
 */
void ioapic_gsi_mask(uint8_t gsi, uint8_t mask);

/*
 * Route an IRQ number to a system interrupt vector
 * via the internal redirection table
 *
 * @irq: Global system interrupt to route
 * @vector: Vector this GSI should map to
 */
void ioapic_route_vec(uint8_t irq, uint8_t vector);

#endif  /* !_MACHINE_IOAPIC_H_ */