Struct rstubs::arch::int::idt::EntryOptions

source ·

#[repr(transparent)]
pub struct EntryOptions(u16);

Expand description

Represents the options field of an IDT entry.

Tuple Fields§

§0: u16

Implementations§

source §

impl EntryOptions

source

pub const fn new() -> Self

Creates a new default initialized bitfield.

source

pub const fn from_bits(bits: u16) -> Self

Convert from bits.

source

pub const fn into_bits(self) -> u16

Convert into bits.

source

const STACK_IDX_BITS: usize = 3usize

source

const STACK_IDX_OFFSET: usize = 0usize

source

const fn stack_idx(&self) -> u16

Index of an interrupt stack

Bits: 0..3

source

const fn with_stack_idx(self, value: u16) -> Self

Index of an interrupt stack

Bits: 0..3

source

fn set_stack_idx(&mut self, value: u16)

Index of an interrupt stack

Bits: 0..3

source

const GATE_BITS: usize = 3usize

source

const GATE_OFFSET: usize = 8usize

source

pub const fn gate(&self) -> Gate

Gate type

Bits: 8..11

source

pub const fn with_gate(self, value: Gate) -> Self

Gate type

Bits: 8..11

source

pub fn set_gate(&mut self, value: Gate)

Gate type

Bits: 8..11

source

const GATE_32_BITS: usize = 1usize

source

const GATE_32_OFFSET: usize = 11usize

source

pub const fn gate_32(&self) -> bool

If this is a 32 bit entry

Bits: 11..12

source

pub const fn with_gate_32(self, value: bool) -> Self

If this is a 32 bit entry

Bits: 11..12

source

pub fn set_gate_32(&mut self, value: bool)

If this is a 32 bit entry

Bits: 11..12

source

const PRIVILEGE_LEVEL_BITS: usize = 2usize

source

const PRIVILEGE_LEVEL_OFFSET: usize = 13usize

source

pub const fn privilege_level(&self) -> Ring

Set the required privilege level (DPL) for invoking the handler. The DPL can be 0 or 3, the default is 0. If CPL < DPL, a general protection fault occurs.

Bits: 13..15

source

pub const fn with_privilege_level(self, value: Ring) -> Self

Set the required privilege level (DPL) for invoking the handler. The DPL can be 0 or 3, the default is 0. If CPL < DPL, a general protection fault occurs.

Bits: 13..15

source

pub fn set_privilege_level(&mut self, value: Ring)

Set the required privilege level (DPL) for invoking the handler. The DPL can be 0 or 3, the default is 0. If CPL < DPL, a general protection fault occurs.

Bits: 13..15

source

const PRESENT_BITS: usize = 1usize

source

const PRESENT_OFFSET: usize = 15usize

source

pub const fn present(&self) -> bool

Has to be true for valid entries.

Bits: 15..16

source

pub const fn with_present(self, value: bool) -> Self

Has to be true for valid entries.

Bits: 15..16

source

pub fn set_present(&mut self, value: bool)

Has to be true for valid entries.

Bits: 15..16

source §

impl EntryOptions

source

const fn minimal() -> Self

Creates a minimal options field with all the must-be-one bits set.

source

pub const unsafe fn with_stack(self, index: u16) -> Self

Assigns a Interrupt Stack Table (IST) stack to this handler. The CPU will then always switch to the specified stack before the handler is invoked. This allows kernels to recover from corrupt stack pointers (e.g., on kernel stack overflow).

An IST stack is specified by an IST index between 0 and 6 (inclusive). Using the same stack for multiple interrupts can be dangerous when nested interrupts are possible.

This function panics if the index is not in the range 0..7.

§Safety

This function is unsafe because the caller must ensure that the passed stack index is valid and not used by other interrupts. Otherwise, memory safety violations are possible.