Struct devices::irqchip::Routes

pub struct Routes {
    routes: Vec<Vec<IrqSource>>,
}

A container for x86 IrqRoutes, grouped by GSI.

Fields

routes: Vec<Vec<IrqSource>>

A list of routes, indexed by GSI. Each GSI can map to zero or more routes, so this is a Vec of Vecs. Specifically, a GSI can map to:

• no routes; or
• one IrqSource::Msi route; or
• one or more IrqSource::Irqchip routes (PicPrimary, PicSecondary, or Ioapic)

Implementations

impl Routes

pub fn new() -> Self

Constructs a new Routes with an empty routing table.

pub fn add(&mut self, route: IrqRoute) -> Result<()>

Inserts a route, replacing any existing route that conflicts. Two routes conflict if they have the same GSI, and they’re both IrqSource::Irqchip routes with the same chip or they’re both IrqSource::Msi. Returns Err if an IrqSource::Irqchip and IrqSource::Msi route have the same GSI.

pub fn replace_all(&mut self, routes: &[IrqRoute]) -> Result<()>

Deletes all existing routes and replaces them with routes. If two routes in routes conflict with each other, the one earlier in the slice is dropped.

pub fn default_pic_ioapic_routes(ioapic_pins: usize) -> Vec<IrqRoute>

Default x86 routing table. Pins 0-7 go to primary pic and ioapic, pins 8-15 go to secondary pic and ioapic, and pins 16-23 go only to the ioapic.

pub fn get_routes(&self) -> Vec<IrqRoute>

Gets the routes as a flat Vec of IrqRoutes.

fn conflict(source: &IrqSource, other: &IrqSource) -> bool

Determines whether or not two irq routes on the same GSI conflict. Returns true if they conflict.

fn same_source(source: &IrqSource, other: &IrqSource) -> bool

Determines whether two routes have the same IrqSource variant (IrqSource::Irqchip or IrqSource::Msi).

fn get_mut(&mut self, irq: usize) -> &mut Vec<IrqSource>

Returns the routes vec for irq. If irq is past the end of self.routes, then self.routes is first resized with empty vecs.

Trait Implementations

impl Default for Routes

fn default() -> Self

Returns the “default value” for a type.

impl Index<usize> for Routes

fn index(&self, irq: usize) -> &Self::Output

Returns all routes for irq, or an empty slice if no routes registered for irq.

type Output = [IrqSource]

The returned type after indexing.