flipperzero-sys 0.16.0

Rust for Flipper Zero
Documentation 
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

//! Inlines for Furi HAL GPIO interface.
//!
//! See: [`furi_hal_gpio.h`][1]
//!
//! [1]: https://github.com/flipperdevices/flipperzero-firmware/blob/release/firmware/targets/f7/furi_hal/furi_hal_gpio.h

use crate as sys;

/// Number of GPIO on one port.
pub const GPIO_NUMBER: usize = 16;

/// GPIO write pin.
///
/// # Safety
///
/// `gpio` must be non-null, and the memory it points to must be initialized.
#[inline]
pub unsafe extern "C" fn furi_hal_gpio_write(gpio: *const sys::GpioPin, state: bool) {
    let gpio = unsafe { *gpio };
    let port = gpio.port;
    let pin = gpio.pin;

    unsafe { furi_hal_gpio_write_port_pin(port, pin, state) }
}

/// GPIO write pin.
///
/// # Safety
///
/// `port` must be non-null, and the memory it points to must be initialized.
#[inline]
pub unsafe extern "C" fn furi_hal_gpio_write_port_pin(
    port: *mut sys::GPIO_TypeDef,
    pin: u16,
    state: bool,
) {
    // writing to BSSR is an atomic operation
    unsafe {
        core::ptr::write_volatile(
            &mut (*port).BSRR,
            (pin as u32) << if state { 0 } else { GPIO_NUMBER },
        );
    }
}

/// GPIO read pin.
///
/// # Safety
///
/// `gpio` must be non-null, and the memory it points to must be initialized.
#[inline]
pub unsafe extern "C" fn furi_hal_gpio_read(gpio: *const sys::GpioPin) -> bool {
    let gpio = unsafe { *gpio };
    let port = gpio.port;
    let pin = gpio.pin;

    unsafe { furi_hal_gpio_read_port_pin(port, pin) }
}

/// GPIO read pin.
///
/// # Safety
///
/// `port` must be non-null, and the memory it points to must be initialized.
#[inline]
pub unsafe extern "C" fn furi_hal_gpio_read_port_pin(
    port: *mut sys::GPIO_TypeDef,
    pin: u16,
) -> bool {
    let port = unsafe { *port };
    let input_data_register_value = unsafe { core::ptr::read_volatile(&port.IDR) };
    input_data_register_value & pin as u32 != 0x00
}