1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00
RIOT/drivers/include/periph
Marian Buschsieweke 00cb9668ae
drivers/periph_gpio_ll: Improve documentation
The documentation on the state `GPIO_DISCONNECT` was a bit vague. The
API doc said it should disconnect the GPIO from all peripherals, the
test also tested them for being electrically disconnected.

The documentation in both the test and the API is extended to point out
that a GPIO indeed SHOULD be in high impedance state, but that user
MUST NOT expect that this requested is honored by every implementation
and for every GPIO pin.

In the test it is also pointed out that failing the test for a GPIO
in the `GPIO_DISCONNECT` state being electrically disconnected is for
some pins expected, and that the test should be just run again with
different GPIOs. The test intentionally tests for a feature not provided
by every GPIO pin rather than warning on a failure: The effort to just
flash and run the test again with different GPIOs is relatively low, but
it does confirm correct behavior of the API.
2024-01-22 10:28:35 +01:00
..
pio cpu/rpx0xx: Add PIO I2C implementation 2023-05-23 08:49:37 +02:00
adc.h periph/adc: introduce periph_adc_continous 2023-11-10 12:10:49 +01:00
can.h tests/conn_can: build stm32 CAN drivers 2019-04-03 11:12:46 +02:00
cpuid.h drivers/periph/cpuid: Fix typo in doc 2020-05-14 16:53:05 +02:00
dac.h drivers/periph: use uint_fast8_t as default type 2021-11-18 10:29:50 +01:00
doc.txt drivers/periph: Add documentation on thread safety and initialization 2023-09-05 09:40:12 +02:00
eeprom.h drivers/include/periph/eeprom: Changed uint8_t* to void* in API 2019-08-09 17:27:32 +02:00
flashpage.h periph/flashpage: deprecate *_free functions 2022-03-31 17:59:54 +02:00
freqm.h drivers/include: add header definition for freqm 2023-11-23 20:37:52 +01:00
gpio_ll_irq.h drivers/periph/gpio_ll: small doc fixes 2023-02-04 11:33:44 +01:00
gpio_ll.h drivers/periph_gpio_ll: Improve documentation 2024-01-22 10:28:35 +01:00
gpio_util.h periph: fix periph/gpio_util.h header guards 2019-11-23 22:39:40 +01:00
gpio.h drivers/periph/gpio: state that interrupt callback must not be NULL 2021-10-19 21:26:50 +02:00
hwrng.h many typo fixes 2019-11-23 22:39:07 +01:00
i2c.h drivers/periph/i2c: i2c_acquire() returns void 2021-11-29 06:35:25 +01:00
init.h drivers/periph: Add documentation on thread safety and initialization 2023-09-05 09:40:12 +02:00
pio.h cpu/rpx0xx: Add PIO implementation 2023-05-23 08:49:37 +02:00
pm.h drivers/*: remove unused assert.h include 2020-10-22 11:29:27 +02:00
ptp.h drivers/periph_ptp: fix adjustment API 2021-02-10 09:55:52 +01:00
pwm.h boards,sys/arduino: major clean up 2023-06-26 17:24:07 +02:00
qdec.h drivers/periph: use uint_fast8_t as default type 2021-11-18 10:29:50 +01:00
rtc_mem.h drivers/periph: define periph_rtc_mem 2021-09-03 11:43:42 +02:00
rtc.h drivers/periph/rtc: improve doc on rtc_set_alarm 2023-05-30 17:41:36 +02:00
rtt.h sys/ztimer: add 'ztimer_no_periph_rtt' 2021-12-02 07:54:38 +01:00
spi.h drivers/periph/spi: move DMA threshold to common code 2023-12-23 17:35:29 +01:00
timer.h drivers/periph: Add timer_poll feature and timer_poll_channel function 2023-12-19 11:13:41 +01:00
uart.h drivers/periph: introduce CONFIG_UART_DMA_THRESHOLD_BYTES 2024-01-04 17:33:51 +01:00
usbdev.h drivers/periph_usbdev: define USBDEV_SET_ADDR_AFTER_STATUS 2023-04-16 17:14:08 +02:00
vbat.h drivers/periph: add VBAT interface 2022-02-20 13:43:19 +01:00
wdt.h sys/auto_init: add auto_init_wdt_{event, thread} modules 2023-02-13 15:06:24 +01:00