Struct lpc8xx_hal::gpio::GPIO

pub struct GPIO<State = Enabled> { /* fields omitted */ }

Interface to the GPIO peripheral

Controls the GPIO peripheral. Can be used to enable, disable, or free the peripheral. For GPIO-functionality directly related to pins, please refer to Pin.

Use Peripherals to gain access to an instance of this struct.

Please refer to the module documentation for more information.

Methods

impl GPIO<Enabled>

pub unsafe fn new_enabled(gpio: GPIO) -> Self

Create an enabled gpio peripheral

This method creates an GPIO instance that it assumes is already in the Enabled state. It's up to the caller to verify this assumption.

impl GPIO<Disabled>

pub fn new(gpio: GPIO) -> Self

Create an disabled gpio peripheral

This method creates an GPIO instance that it assumes is in the Disabled state. As it's only possible to enable a Disabled GPIO instance, it's also safe to pass an already Enabled instance.

pub fn enable(self, syscon: &mut Handle) -> GPIO<Enabled>

Enable the GPIO peripheral

This method is only available, if GPIO is in the Disabled state. Code that attempts to call this method when the peripheral is already enabled will not compile.

Consumes this instance of GPIO and returns another instance that has its State type parameter set to Enabled.

impl GPIO<Enabled>

pub fn disable(self, syscon: &mut Handle) -> GPIO<Disabled>

Disable the GPIO peripheral

This method is only available, if GPIO is in the Enabled state. Code that attempts to call this method when the peripheral is already disabled will not compile.

Consumes this instance of GPIO and returns another instance that has its State type parameter set to Disabled.

impl<State> GPIO<State>

pub fn free(self) -> GPIO

Return the raw peripheral

This method serves as an escape hatch from the HAL API. It returns the raw peripheral, allowing you to do whatever you want with it, without limitations imposed by the API.

If you are using this method because a feature you need is missing from the HAL API, please open an issue or, if an issue for your feature request already exists, comment on the existing issue, so we can prioritize it accordingly.