#interrupt #controller #kernel #no-std

no-std pic8259

Abstractions for the 8259 and 8259A interrupt controllers

6 releases

0.11.0 Mar 11, 2024
0.10.4 Apr 13, 2023
0.10.3 Mar 9, 2023
0.10.2 Aug 22, 2021
0.10.1 May 17, 2021

#166 in Hardware support

Download history 1175/week @ 2024-08-17 1214/week @ 2024-08-24 1137/week @ 2024-08-31 1061/week @ 2024-09-07 1169/week @ 2024-09-14 1289/week @ 2024-09-21 1065/week @ 2024-09-28 650/week @ 2024-10-05 1025/week @ 2024-10-12 992/week @ 2024-10-19 1128/week @ 2024-10-26 1183/week @ 2024-11-02 660/week @ 2024-11-09 819/week @ 2024-11-16 1174/week @ 2024-11-23 1270/week @ 2024-11-30

4,114 downloads per month
Used in 10 crates (8 directly)

Apache-2.0/MIT

12KB
91 lines

pic_8259

Abstractions for 8259 and 8259A Programmable Interrupt Controllers (PICs).

This project is a fork of the pic8259_simple crate created by @emk.

Things we may not handle very well yet include:

  1. Dealing with spurious interrupts.
  2. Non-standard configurations.

This code is based on the OSDev Wiki PIC notes, but it's not a complete implementation of everything they discuss. Also note that if you want to do more sophisticated interrupt handling, especially on multiprocessor systems, you'll probably want to read about the newer APIC and IOAPIC interfaces.

Using

This is a very basic interface to the 8259 and 8259A interrupt controllers, which are used on single processor systems to pass hardware interrupts to the CPU.

To use this crate, add it to your Cargo.toml file, along with an appropriate kernel-space mutex implementation such as spin:

[dependencies]
pic8259 = "0.10.0"
spin = "0.9.0"

You can then declare a global, lockable ChainedPics object as follows:


use pic8259::ChainedPics;
use spin::Mutex;

// Map PIC interrupts to 0x20 through 0x2f.
static PICS: Mutex<ChainedPics> =
    Mutex::new(unsafe { ChainedPics::new(0x20, 0x28) });

To perform runtime PIC intialization, call initialize before enabling interrupts:

PICS.lock().initialize();

When you've finished handling an interrupt, run:

PICS.lock().notify_end_of_interrupt(interrupt_id);

It's safe to call notify_end_of_interrupt after every interrupt; the notify_end_of_interrupt function will try to figure out what it needs to do.

All public PIC interfaces are unsafe, because it's really easy to trigger undefined behavior by misconfiguring the PIC or using it incorrectly.

Crate Feature Flags

  • nightly - Uses features that are only usable on nightly Rust. Enabled by default.
  • stable - Enable this feature flag to build this crate on stable Rust. You have to add default-features = false, features = ["stable"] to your Cargo.toml.

Licensing

Licensed under the Apache License, Version 2.0 or the MIT license, at your option.

Dependencies

~575KB
~11K SLoC