#include <cpu/cpu.h>
#include <cpu/io.h>
#include <dev/irq.h>

Data Structures
struct	x86_irq_chip
	An interrupt controller: the 8259s, or the APIC. More...

Macros
#define	X86_IRQ_NR 49
#define	X86_IRQ_TIMER 48
#define	X86_TIMER_VECTOR 0xF0
#define	X86_TLB_VECTOR 0xF1
#define	X86_WAKE_VECTOR 0xF2
#define	X86_SPURIOUS_VECTOR 0xFF

Functions
void	x86_irq_chip_set (struct x86_irq_chip *chip)
	Sets the system's interrupt controller.
const char *	x86_irq_chip_name (void)
	Returns the name of the system's interrupt controller.
void	x86_irq_gates_setup (void)
	Sets the IDT's gates for the interrupts: vectors 32 to 79, the local APIC's timer, the TLB and wake IPIs, and its spurious interrupt.
void	x86_irq_tick_switch (void)
	Asks for a thread switch once the current interrupt is done: the tick calls it.
void	x86_irq_alloc_from (unsigned first)
	Sets the first IRQ that x86_irq_alloc() may give: past the I/O APICs' last pin.
int	x86_irq_alloc (struct x86_irq_chip *chip)
	Gives a free IRQ with a controller of its own, for an MSI.
int	x86_pic_setup (struct ioaddr master, struct ioaddr slave)
	Sets up the 8259s, with every IRQ masked.
void	x86_pic_disable (void)
	Masks every IRQ of the 8259s, when the APIC brings the interrupts.
int	x86_apic_setup (void)
	Sets up the APIC to bring the interrupts, if the CPU has one, the MADT describes it, and the kernel's command line doesn't say apic=off.
uint32_t	x86_lapic_timer_setup (uint32_t period_ns, irq_handler_t handler)
	Starts the scheduler's tick with the local APIC's timer, calibrated first.
void	x86_lapic_cpu_setup (void)
	Sets up the running CPU's local APIC: enabled, with the spurious vector 0xFF, its timer off, the NMI on the LINT input the MADT says, and the other LINT (the 8259s') masked.
int	x86_apic_cpus (uint32_t *ids, int max)
	Lists the CPUs' local APIC IDs, the boot CPU's among them.
void	x86_lapic_ipi (uint32_t id, uint32_t icr)
	Sends an IPI to a CPU, and waits until it is delivered.
void	x86_lapic_eoi (void)
	Tells the running CPU's local APIC that its interrupt (an IPI) is handled.
void	x86_lapic_timer_cpu_start (void)
	Starts the running CPU's local APIC timer, with the boot CPU's calibration, once it has been done.
void	x86_smp_init (void)
	Starts the other CPUs, at boot, unless the kernel's command line says smp=off.
int	x86_clock_precise (void)
	Says whether the clock counts finer than the ticks.
void	x86_acpi_poweroff (void)
	Powers the machine off, by entering ACPI's S5 sleep state.
void *	x86_acpi_table (const char *signature)
	Finds one of ACPI's tables, by its signature.
int	x86_hpet_init (void)
	Finds the HPET and starts its counter.
uint64_t	x86_hpet_read (void)
	Reads the HPET's 64-bit counter.
uint32_t	x86_hpet_read32 (void)
	Reads the low half of the HPET's counter only: a single read, which matters because each read is slow under a hypervisor.
uint64_t	x86_hpet_period_fs (void)
	Returns the HPET counter's period.
int	x86_pit_setup (struct ioaddr *io)
	Sets where the PIT's ports are.
uint32_t	x86_pit_period_set (uint32_t period_ns)
	Makes channel 0 interrupt periodically, for the scheduler's tick.
void	x86_pit_delay (uint32_t us)
	Waits us microseconds, at most 54 ms, busy.
int	x86_cmos_setup (struct ioaddr *ioaddr)
	Sets where the CMOS's ports are.

Variables
struct x86_irq_chip	x86_pic_chip

Macro Definition Documentation

◆ X86_IRQ_NR

#define X86_IRQ_NR 49

Definition at line 12 of file misc.h.

Referenced by arch_interrupts_info(), irq_handle(), irq_install(), and irq_uninstall().

◆ X86_IRQ_TIMER

#define X86_IRQ_TIMER 48

Definition at line 13 of file misc.h.

Referenced by apic_mask(), apic_unmask(), arch_interrupts_info(), irq_handle(), irq_install(), irq_uninstall(), x86_irq_alloc(), and x86_lapic_timer_setup().

◆ X86_SPURIOUS_VECTOR

#define X86_SPURIOUS_VECTOR 0xFF

Definition at line 17 of file misc.h.

Referenced by x86_irq_gates_setup(), and x86_lapic_cpu_setup().

◆ X86_TIMER_VECTOR

#define X86_TIMER_VECTOR 0xF0

Definition at line 14 of file misc.h.

Referenced by irq_handle(), x86_irq_gates_setup(), and x86_lapic_timer_cpu_start().

◆ X86_TLB_VECTOR

#define X86_TLB_VECTOR 0xF1

Definition at line 15 of file misc.h.

Referenced by __x86_irq_handler(), tlb_shootdown(), and x86_irq_gates_setup().

◆ X86_WAKE_VECTOR

#define X86_WAKE_VECTOR 0xF2

Definition at line 16 of file misc.h.

Referenced by __x86_irq_handler(), arch_cpu_kick(), and x86_irq_gates_setup().

Function Documentation

◆ x86_acpi_poweroff()

void x86_acpi_poweroff ( void )

Powers the machine off, by entering ACPI's S5 sleep state.

It returns only if it couldn't.

Definition at line 265 of file acpi.c.

References acpi_s5(), acpi_table(), FADT_ACPI_ENABLE, FADT_DSDT, FADT_PM1A_CNT, FADT_PM1B_CNT, FADT_SMI_CMD, io_out8(), IOADDR_PORT, pm1_read(), PM1_SCI_EN, PM1_SLP_EN, pm1_write(), printk(), x86_acpi_poweroff(), and x86_acpi_table().

Referenced by arch_poweroff(), and x86_acpi_poweroff().

◆ x86_acpi_table()

void * x86_acpi_table ( const char * signature )

Finds one of ACPI's tables, by its signature.

The tables are mapped the first time.

Parameters

signature the table's signature, 4 characters ("APIC", "HPET")

Returns: the table, or NULL if there's none

Definition at line 183 of file acpi.c.

References acpi_tables(), memcmp(), NULL, acpi_sdt_header::signature, tables, tables_nr, and x86_acpi_table().

Referenced by x86_acpi_poweroff(), x86_acpi_table(), x86_apic_setup(), and x86_hpet_init().

◆ x86_apic_cpus()

int x86_apic_cpus	(	uint32_t *	ids,
		int	max )

Lists the CPUs' local APIC IDs, the boot CPU's among them.

Parameters

ids	where to put them
max	how many fit

Returns: how many there are, or 0 without the APIC

Definition at line 322 of file apic.c.

References cpu_ids, cpu_ids_nr, lapic, MIN, and x86_apic_cpus().

Referenced by x86_apic_cpus(), and x86_smp_init().

◆ x86_apic_setup()

int x86_apic_setup ( void )

Sets up the APIC to bring the interrupts, if the CPU has one, the MADT describes it, and the kernel's command line doesn't say apic=off.

Returns: 0 if the APIC brings the interrupts from now on, -ENODEV if there's no APIC to use, or -ENOMEM if its registers couldn't be mapped

Definition at line 359 of file apic.c.

References ACPI_MADT_ENABLED, ACPI_MADT_INT_SRC_OVERRIDE, ACPI_MADT_IO_APIC, ACPI_MADT_LOCAL_APIC, ACPI_MADT_LOCAL_APIC_NMI, ACPI_MPS_TRIGGER_LEVEL, ACPI_MPS_TRIGGER_MASK, acpi_madt_io_apic::address, ioapic::address, apic_chip, acpi_madt_local_apic::apic_id, arch_cpu::apic_id, cpu::arch, arch_mmio_map(), acpi_madt_override::bus, cpu_has_apic(), cpu_ids, cpu_ids_nr, cpus, CPUS_MAX, acpi_madt_local_apic::flags, acpi_madt_local_apic_nmi::flags, acpi_madt_override::flags, acpi_madt_override::gsi, acpi_madt_io_apic::gsi_base, ioapic::gsi_base, acpi_madt::header, ioapic_read(), IOAPIC_REDIR, IOAPIC_VER, ioapic_write(), ioapics, IOAPICS_MAX, ioapics_nr, isa, kargs_get(), lapic, LAPIC_ID, lapic_id, lapic_read(), acpi_sdt_header::length, acpi_madt_local_apic_nmi::lint, acpi_madt::local_apic_address, nmi_lint, NULL, ioapic::pins, printk(), REDIR_MASKED, ioapic::regs, acpi_madt_override::source, x86_acpi_table(), x86_apic_setup(), x86_irq_alloc_from(), x86_irq_chip_set(), x86_lapic_cpu_setup(), and x86_pic_disable().

Referenced by x86_apic_setup(), and x86_pc_irq_init().

◆ x86_clock_precise()

int x86_clock_precise ( void )

Says whether the clock counts finer than the ticks.

Returns: 1 with the TSC or the HPET, 0 with the ticks

Definition at line 193 of file clock.c.

References source, SOURCE_PIT, and x86_clock_precise().

Referenced by timer_calibrate(), and x86_clock_precise().

◆ x86_cmos_setup()

int x86_cmos_setup ( struct ioaddr * ioaddr )

Sets where the CMOS's ports are.

Parameters

ioaddr its index and data ports (0x70)

Returns: 0

Definition at line 139 of file cmos.c.

References ioaddr::addr, cmos, ioaddr_type_str(), printk(), and x86_cmos_setup().

Referenced by x86_cmos_setup(), and x86_pc_cmos_init().

◆ x86_hpet_init()

int x86_hpet_init ( void )

Finds the HPET and starts its counter.

Returns: 0 once it counts, -ENODEV if there's no usable HPET, or -ENOMEM if its registers couldn't be mapped

Definition at line 90 of file hpet.c.

References acpi_gas::address, acpi_hpet::address, arch_mmio_map(), CNF_ENABLE, CNF_LEGACY, acpi_hpet::header, HPET_CAP, HPET_CNF, HPET_CNT, acpi_sdt_header::length, NULL, period_fs, PERIOD_MAX_FS, printk(), reg32(), reg32_write(), regs, acpi_gas::space, x86_acpi_table(), and x86_hpet_init().

Referenced by x86_clock_init(), and x86_hpet_init().

◆ x86_hpet_period_fs()

uint64_t x86_hpet_period_fs ( void )

Returns the HPET counter's period.

Returns: the period, in femtoseconds

Definition at line 79 of file hpet.c.

References period_fs, and x86_hpet_period_fs().

Referenced by tsc_calibrate(), x86_clock_init(), and x86_hpet_period_fs().

◆ x86_hpet_read()

uint64_t x86_hpet_read ( void )

Reads the HPET's 64-bit counter.

Its two halves are read again until the high half is the same before and after, so that a carry between them can't give a wrong value.

Returns: the counter

Definition at line 51 of file hpet.c.

References HPET_CNT, reg32(), and x86_hpet_read().

Referenced by tsc_calibrate(), and x86_hpet_read().

◆ x86_hpet_read32()

uint32_t x86_hpet_read32 ( void )

Reads the low half of the HPET's counter only: a single read, which matters because each read is slow under a hypervisor.

Returns: the counter's low 32 bits

Definition at line 69 of file hpet.c.

References HPET_CNT, reg32(), and x86_hpet_read32().

Referenced by counter(), and x86_hpet_read32().

◆ x86_irq_alloc()

int x86_irq_alloc ( struct x86_irq_chip * c )

Gives a free IRQ with a controller of its own, for an MSI.

Parameters

c	the IRQ's controller

Returns: the IRQ, or -1 if there's no free one

Definition at line 99 of file irq.c.

References alloc_first, chip, handlers, irqs, x86_irq_alloc(), and X86_IRQ_TIMER.

Referenced by arch_msi_alloc(), and x86_irq_alloc().

◆ x86_irq_alloc_from()

void x86_irq_alloc_from ( unsigned first )

Sets the first IRQ that x86_irq_alloc() may give: past the I/O APICs' last pin.

Parameters

first the first IRQ

Definition at line 88 of file irq.c.

References alloc_first, and x86_irq_alloc_from().

Referenced by x86_apic_setup(), and x86_irq_alloc_from().

◆ x86_irq_chip_name()

const char * x86_irq_chip_name ( void )

Returns the name of the system's interrupt controller.

Returns: its name, or "none"

Definition at line 77 of file irq.c.

References chip, x86_irq_chip::name, and x86_irq_chip_name().

Referenced by arch_interrupts_info(), x86_irq_chip_name(), and x86_pc_irq_init().

◆ x86_irq_chip_set()

void x86_irq_chip_set ( struct x86_irq_chip * c )

Sets the system's interrupt controller.

Parameters

c	the controller: the 8259s or the APIC

Definition at line 67 of file irq.c.

References chip, and x86_irq_chip_set().

Referenced by x86_apic_setup(), x86_irq_chip_set(), and x86_pc_irq_init().

◆ x86_irq_gates_setup()

void x86_irq_gates_setup ( void )

Sets the IDT's gates for the interrupts: vectors 32 to 79, the local APIC's timer, the TLB and wake IPIs, and its spurious interrupt.

Definition at line 266 of file irq.c.

References x86_idt_gate_set(), x86_irq_gates_setup(), X86_SPURIOUS_VECTOR, X86_TIMER_VECTOR, X86_TLB_VECTOR, and X86_WAKE_VECTOR.

Referenced by x86_irq_gates_setup(), and x86_pc_irq_init().

◆ x86_irq_tick_switch()

void x86_irq_tick_switch ( void )

Asks for a thread switch once the current interrupt is done: the tick calls it.

Definition at line 169 of file irq.c.

References x86_irq_tick_switch().

Referenced by x86_irq_tick_switch(), and x86_sched_handler().

◆ x86_lapic_cpu_setup()

void x86_lapic_cpu_setup ( void )

Sets up the running CPU's local APIC: enabled, with the spurious vector 0xFF, its timer off, the NMI on the LINT input the MADT says, and the other LINT (the 8259s') masked.

Definition at line 303 of file apic.c.

References APIC_BASE, APIC_BASE_ENABLE, LAPIC_LVT_ERROR, LAPIC_LVT_LINT0, LAPIC_LVT_LINT1, LAPIC_LVT_TIMER, LAPIC_SVR, LAPIC_TPR, lapic_write(), LVT_MASKED, LVT_NMI, nmi_lint, SVR_ENABLE, x86_lapic_cpu_setup(), and X86_SPURIOUS_VECTOR.