1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
//! Pointer device access.
use crate::proto::Protocol;
use crate::{unsafe_guid, Event, Result, Status};
use core::mem::MaybeUninit;
/// Provides information about a pointer device.
#[repr(C)]
#[unsafe_guid("31878c87-0b75-11d5-9a4f-0090273fc14d")]
#[derive(Protocol)]
pub struct Pointer<'boot> {
reset: extern "efiapi" fn(this: &mut Pointer, ext_verif: bool) -> Status,
get_state: extern "efiapi" fn(this: &Pointer, state: *mut PointerState) -> Status,
wait_for_input: Event,
mode: &'boot PointerMode,
}
impl<'boot> Pointer<'boot> {
/// Resets the pointer device hardware.
///
/// The `extended_verification` parameter is used to request that UEFI
/// performs an extended check and reset of the input device.
///
/// # Errors
///
/// - `DeviceError` if the device is malfunctioning and cannot be reset.
pub fn reset(&mut self, extended_verification: bool) -> Result {
(self.reset)(self, extended_verification).into()
}
/// Retrieves the pointer device's current state, if a state change occured
/// since the last time this function was called.
///
/// Use `wait_for_input_event()` with the `BootServices::wait_for_event()`
/// interface in order to wait for input from the pointer device.
///
/// # Errors
/// - `DeviceError` if there was an issue with the pointer device.
pub fn read_state(&mut self) -> Result<Option<PointerState>> {
let mut pointer_state = MaybeUninit::<PointerState>::uninit();
match (self.get_state)(self, pointer_state.as_mut_ptr()) {
Status::NOT_READY => Ok(None.into()),
other => other.into_with_val(|| unsafe { Some(pointer_state.assume_init()) }),
}
}
/// Event to be used with `BootServices::wait_for_event()` in order to wait
/// for input from the pointer device
pub fn wait_for_input_event(&self) -> &Event {
&self.wait_for_input
}
/// Returns a reference to the pointer device information.
pub fn mode(&self) -> &PointerMode {
self.mode
}
}
/// Information about this pointer device.
#[derive(Debug, Copy, Clone)]
#[repr(C)]
pub struct PointerMode {
/// The pointer device's resolution on the X/Y/Z axis in counts/mm.
/// If a value is 0, then the device does _not_ support that axis.
pub resolution: (u64, u64, u64),
/// Whether the devices has a left button / right button.
pub has_button: (bool, bool),
}
/// The relative change in the pointer's state.
#[derive(Debug, Copy, Clone)]
#[repr(C)]
pub struct PointerState {
/// The relative movement on the X/Y/Z axis.
///
/// If `PointerMode` indicates an axis is not supported, it must be ignored.
pub relative_movement: (i32, i32, i32),
/// Whether the left / right mouse button is currently pressed.
///
/// If `PointerMode` indicates a button is not supported, it must be ignored.
pub button: (bool, bool),
}