1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00
RIOT/drivers/include
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
..
at25xxx
can
net drivers/net/netdev: extend netopt request/result for Wi-Fi 2023-08-19 23:23:10 +02:00
periph drivers/periph_gpio_ll: Improve documentation 2024-01-22 10:28:35 +01:00
saul
sdmmc tree-wide: fix typos in doc and comments 2023-10-16 12:17:48 +02:00
ad7746.h
adcxx1c.h
ads101x.h
adt7310.h treewide: replace occurrences of tests/driver_ with new path 2023-05-06 15:38:21 +02:00
adxl345.h
aip31068.h
apa102.h
apds99xx.h
arduino_pinmap.h boards,sys/arduino: major clean up 2023-06-26 17:24:07 +02:00
at24cxxx.h drivers/at24cxxx: merge mtd driver with at24cxxx.c 2023-02-17 10:55:21 +01:00
at24mac.h
at25xxx.h
at30tse75x.h codespell: fix remaining issues 2022-09-16 14:00:35 +02:00
at86rf2xx.h tree-wide: fix typos in doc and comments 2023-10-16 12:17:48 +02:00
at86rf215.h doc: fix unbalaced grouping 2022-09-14 15:05:25 +02:00
at.h drivers/at: fix URC collision with command response 2023-11-10 15:26:47 +01:00
ata8520e.h
atwinc15x0.h drivers/atwinc15x0: support network scanning and dynamic connection 2023-08-19 23:23:10 +02:00
bh1750fvi.h
bh1900nux.h
bme680.h tree-wide: fix typos in doc and comments 2023-10-16 12:17:48 +02:00
bmp180.h
bmx055.h
bmx280.h
bq2429x.h
candev_mcp2515.h drivers/mcp2515: use ztimer 2022-04-20 09:23:50 +02:00
cc1xxx_common.h
cc110x.h
cc2420.h
ccs811.h
cst816s.h drivers/cst816s: add touch_dev interface 2022-04-14 11:31:35 +02:00
dac_dds.h
dcf77.h
dfplayer.h drivers/dfplayer: fix bug in utility function 2023-05-19 21:51:44 +02:00
dht.h drivers/dht: busy wait reimplementation 2023-06-20 12:07:48 +02:00
diskio.h
disp_dev.h drivers/disp_dev: use struct to store display area coordinates 2022-04-13 12:49:58 +02:00
dose.h drivers/dose: make RX buffer size configurable 2022-05-15 14:43:47 +02:00
ds18.h
ds75lx.h
ds1307.h
ds3231.h drivers/ds3231 fix docs, alarms are supported 2022-12-27 17:21:55 +01:00
ds3234.h
dsp0401.h
dynamixel.h
edbg_eui.h
enc28j60.h
encx24j600.h drivers/encx24j600: introduce setup function with index 2022-03-24 09:32:10 +01:00
epd_bw_spi_disp_dev.h epd_bw_spi: add implementation for disp_dev 2023-01-31 19:50:11 +01:00
epd_bw_spi.h epd_bw_spi: add implementation for disp_dev 2023-01-31 19:50:11 +01:00
ethos.h doc: sort all stdio implementations into sys_stdio group 2023-01-13 11:08:22 +01:00
feetech.h
ft5x06.h drivers/ft5x06: introduce coordinate conversions 2023-08-26 17:49:29 +02:00
fxos8700.h
gp2y10xx.h
grove_ledbar.h
hd44780.h
hdc1000.h
hih6130.h drivers/hih6130: avoid using floats 2023-06-08 14:33:38 +02:00
hm330x.h
hmc5883l.h
hsc.h
hts221.h
ili9341.h drivers/lcd: rework rotation modes and enable it with st7735 2022-04-19 16:22:10 +02:00
ina2xx.h
ina3221.h
io1_xplained.h
ir_nec.h drivers/ir_nec: ir remote implementation 2022-05-31 17:58:39 +02:00
isl29020.h
isl29125.h treewide: replace occurrences of tests/driver_ with new path 2023-05-06 15:38:21 +02:00
itg320x.h
jc42.h
kw2xrf.h drivers/kw2xrf: remove unused kw2xrf_setup function 2022-08-25 15:44:34 +02:00
kw41zrf.h
l3g4200d.h
l3gxxxx.h tree-wide: fix typos in doc and comments 2023-10-16 12:17:48 +02:00
lc709203f.h
lcd.h drivers/lcd: add MCU-driven low-level parallel interface 2023-09-23 08:03:16 +02:00
led.h
lis2dh12.h
lis3dh.h
lis3mdl.h
lm75.h doc: fix unbalaced grouping 2022-09-14 15:05:25 +02:00
lpd8808.h
lpsxxx.h driver/lpsxxx: adding lps22ch support 2022-03-09 15:23:51 +01:00
lsm6dsl.h
lsm303dlhc.h
ltc4150.h
mag3110.h
matrix_keypad.h matrix_keypad: Move documentation to doxygen group 2023-02-23 11:39:11 +01:00
mcp47xx.h treewide: replace occurrences of tests/driver_ with new path 2023-05-06 15:38:21 +02:00
mfrc522.h drivers/mfrc522: add new driver 2023-01-31 21:05:07 +01:00
mhz19.h
mii.h drivers/mii: add Interrupt Control/Status register 2023-06-05 12:46:08 +02:00
mma8x5x.h
mma7660.h
motor_driver.h
mpl3115a2.h
mpu9x50.h
mq3.h drivers/mq3: avoid use of floats 2023-06-01 16:52:26 +02:00
mrf24j40.h drivers/mrf24j40: add note about missing wake pin handling 2023-06-07 15:10:33 +02:00
mtd_at24cxxx.h
mtd_default.h drivers/mtd_default: remove extern mtd_dev_t * declarations 2023-12-07 15:32:49 +01:00
mtd_emulated.h drivers/mtd: improve doc consistency for MTDs 2023-12-14 17:27:13 +01:00
mtd_flashpage.h drivers/mtd: improve doc consistency for MTDs 2023-12-14 17:27:13 +01:00
mtd_mapper.h drivers/mtd_mapper: Add write_size 2022-03-31 10:58:52 +02:00
mtd_sdcard.h drivers/mtd: improve doc consistency for MTDs 2023-12-14 17:27:13 +01:00
mtd_sdmmc.h drivers/mtd: improve doc consistency for MTDs 2023-12-14 17:27:13 +01:00
mtd_spi_nor.h drivers/mtd_spi_nor: drop addr_width from mtd_spi_nor_params_t 2022-02-04 12:17:17 +01:00
mtd.h Merge pull request #20180 from benpicco/mtd_sdmmc-erase 2023-12-14 13:42:33 +00:00
my9221.h
ncv7356.h
nrf24l01p_ng.h tree wide: fix typos in comments found by codespell 2023-05-02 09:52:06 +02:00
nrf24l01p.h tree-wide: fix typos in doc and comments 2023-10-16 12:17:48 +02:00
nvram-spi.h
nvram.h
opt3001.h
pca9633.h
pca9685.h treewide: replace occurrences of tests/driver_ with new path 2023-05-06 15:38:21 +02:00
pcd8544.h
pcf857x.h drivers/pcf857x: use errno code for error reporting 2023-11-22 10:29:33 +01:00
ph_oem.h
pir.h
pn532.h
pulse_counter.h
qmc5883l.h
rgbled.h
rn2xx3.h
rtt_rtc.h
saul.h drivers/saul: use flash_utils 2023-02-27 12:31:04 +01:00
scd30.h
screen_dev.h
sdcard_spi.h drivers/sdcard_spi: small changes in doc for consistency 2023-12-14 17:26:29 +01:00
sdp3x.h
sds011.h
seesaw_soil.h
servo.h treewide: replace occurrences of tests/driver_ with new path 2023-05-06 15:38:21 +02:00
sgp30.h
sht1x.h drivers/sht1x: fix doccheck 2022-09-16 11:12:27 +02:00
sht2x.h drivers/sht2x: fix measurement duration 2022-12-14 21:47:32 +01:00
sht3x.h
shtcx.h tree-wide: fix typos in doc and comments 2023-10-16 12:17:48 +02:00
si70xx.h
si114x.h
si1133.h
slipdev.h drivers/slipdev: make use of chunked ringbuffer 2024-01-02 14:41:11 +01:00
sm_pwm_01c.h
soft_spi.h
soft_uart.h
sps30.h
srf02.h
srf04.h
srf08.h
st77xx.h Merge #19914 #19915 2023-09-20 15:55:34 +00:00
stm32_eth.h
stmpe811.h drivers/stmpe811: introduce coordinate conversion 2023-09-02 17:01:46 +02:00
sx126x.h
sx127x.h
sx1280.h drivers/sx1280: initial import 2022-05-18 17:06:12 +02:00
tcs37727.h
tja1042.h
tmp00x.h doc: fix unbalaced grouping 2022-09-14 15:05:25 +02:00
touch_dev_gestures.h drivers: add gesture recognition for touch devices 2023-08-31 20:12:33 +02:00
touch_dev.h drivers/touch_dev: add a function to get the maximum number of touches 2023-08-14 18:26:08 +02:00
tps6274x.h
tsl2561.h
tsl4531x.h
usbdev_mock.h doc: fix unbalaced grouping 2022-09-14 15:05:25 +02:00
usbdev_synopsys_dwc2.h drivers/usbdev_synopsys_dwc2: set USBDEV_SET_ADDR_AFTER_STATUS 2023-04-16 17:14:08 +02:00
vcnl40x0.h
veml6070.h
vl6180x.h treewide: replace occurrences of tests/driver_ with new path 2023-05-06 15:38:21 +02:00
w5100.h doc: fix unbalaced grouping 2022-09-14 15:05:25 +02:00
ws281x.h
xbee.h codespell: fix remaining issues 2022-09-16 14:00:35 +02:00