Skip to main content

gpio_port_pin_is_supported

Function gpio_port_pin_is_supported 

Source
pub unsafe extern "C" fn gpio_port_pin_is_supported(
    port_pin_mask: u32,
    pin: u8,
) -> bool
Expand description

@brief Check whether a pin is in range and supported by a GPIO controller.

@note @p pin is checked against @ref GPIO_MAX_PINS_PER_PORT before it is used as a shift count. Drivers must use this helper instead of testing port_pin_mask & BIT(pin) directly, as @p pin may originate from an untrusted caller.

@param port_pin_mask Mask identifying the pins supported by the controller, i.e. @ref gpio_driver_config.port_pin_mask. @param pin Pin number to check.

@retval true If @p pin is in range and supported by the controller. @retval false Otherwise.