Benjamin Valentin
696ddf3dbb
drivers/periph/timer: amend documentation for timer_set_periodic()
...
The function needs the `periph_timer_periodic` feature.
Add a `@note` about that to the documentation.
2020-09-13 19:06:28 +02:00
MrKevinWeiss
bdeb39576e
drivers/periph: Remove UART from dev_enums.h
2020-09-09 10:25:38 +02:00
benpicco
6f271b7d3e
Merge pull request #14903 from benpicco/drivers/include/periph/rtc-fix
...
drivers/periph_common: RTC: fix doxygen
2020-09-01 15:15:55 +02:00
Benjamin Valentin
bd57640d5b
drivers/periph_common: RTC: fix doxygen
2020-08-31 14:16:42 +02:00
Gunar Schorcht
147b79169c
drivers/periph/gpio: add comparison functions
...
The expandable GPIO API requires the comparison of structured GPIO types. This means that inline functions must be used instead of direct comparisons. For the migration process, drivers and other modules must first be changed so that they use the inline comparison functions.
2020-08-31 13:10:28 +02:00
Francisco
ad3568be87
Merge pull request #14712 from benpicco/gpio_init_int-clarify
...
periph/gpio: clarify behavior of gpio_irq_enable()
2020-08-11 11:30:05 +02:00
Benjamin Valentin
7543e714c1
drivers/periph_common: RTC: move RIOT_EPOCH to header, document it.
2020-08-07 13:22:19 +02:00
Benjamin Valentin
8c95198cbb
periph/gpio: clarify behavior of gpio_irq_enable()
...
What happens with events that occured after `gpio_irq_disable()` is
currently not defined.
If they are not cleared, they will generate an interrupt on `gpio_irq_enable()`.
This does not seem like the intended behavior, so make the documentation more
explicit.
2020-08-05 17:41:27 +02:00
benpicco
ecab75b529
Merge pull request #13632 from benpicco/cpu/sam0_common/uart-deinit
...
drivers/periph/uart: add periph_uart_reconfigure feature & implementation for sam0
2020-07-28 11:12:19 +02:00
Benjamin Valentin
3eb54179ae
drivers/periph/uart: add periph_uart_reconfigure feature
2020-07-28 10:10:15 +02:00
Benjamin Valentin
7af8a3e2d3
drivers/periph/timer: add note about TIM_FLAG_RESET_ON_MATCH
2020-07-27 17:17:08 +02:00
Francisco Molina
9dde6ec53d
drivers/rtt: overrite RTT_MAX_VALUE and RTT_FREQUENCY for mock
...
mock_rtt relies on setting mock values for RTT_MAX_VALUE and
RTT_FREQUENCY. Platforms with a rtt will already define these
values which leads to mock_rtt working with different values than
rtt_rtc.
This commit changes the ifdef logic so that when using mock_rtt
RTT_MAX_VALUE and RTT_FREQUENCY are redefined.
2020-07-22 08:52:54 +02:00
Benjamin Valentin
896fcd43b0
drivers/periph/spi: add periph_spi_reconfigure feature
2020-06-21 21:19:17 +02:00
Francisco Molina
8d329942df
drivers/periph/rtt: introduce RTT_MIN_OFFSET
2020-06-11 09:30:25 +02:00
Leandro Lanzieri
48759eccdc
drivers/wdt: Add feature to indicate a configurable warning period
...
This adds the feature `periph_wdt_warning_period` that indicates that a
platform WDT driver implementation supports a configurable
CONFIG_WDT_WARNING_PERIOD.
2020-06-02 12:54:25 +02:00
Benjamin Valentin
cd107be976
drivers/periph/timer: add timer_set_periodic()
2020-05-28 17:37:41 +02:00
Marian Buschsieweke
568404134a
drivers/periph/cpuid: Fix typo in doc
2020-05-14 16:53:05 +02:00
Francisco
cea0d1c532
Merge pull request #13421 from benpicco/cpu/sam0_common/i2c-deinit
...
drivers/periph/i2c: add periph_i2c_reconfigure feature & implementation for sam0
2020-05-05 19:09:47 +02:00
Benjamin Valentin
21958ff531
drivers/periph/i2c: add periph_i2c_reconfigure feature
...
It is often desireable to re-configure the pins of a bus back to GPIO mode,
either to save power when an external peripheral is turned off and current
would leak, or because a device may need a non-standard in-band signal to
be generated on the bus lines.
To serve those use cases, this patch introduces four new functions to the
I2C API:
- `i2c_init_pins()` equivalent to spi_init_pins(), restores I2C pin configuration
- `i2c_deinit_pins()` to switch the configuration of the I2C pins back to GPIO
mode and block access to the bus.
- `i2c_pin_sda()` to get the data pin for a given bus
- `i2c_pin_scl()` to get the clock pin for a given bus
Since it's unreasonable to expect having implementations for all platforms
already, those functions are only availiable when the periph_i2c_reconfigure
feature is availiable.
Applications should use FEATURES_REQUIRED += periph_i2c_reconfigure or
FEATURES_OPTIONAL if they want to make use of those functions.
2020-05-05 16:12:19 +02:00
Francisco Molina
0c0f8ec98f
drivers/periph/rtt.h: add RTT_FREQUENCY & RTT_MAX_VALUE doc
2020-04-23 22:11:16 +02:00
Francisco Molina
2604971753
drivers/periph/rtt.h: ensure RTT_MAX_VALUE is set
2020-04-23 19:07:18 +02:00
Leandro Lanzieri
00b71a2708
drivers/wdt: Move WDT_WARNING_PERIOD to 'CONFIG_' namespace
2020-03-31 13:39:37 +02:00
Benjamin Valentin
60cc3b8757
periph/rtt: Allow using MOCK_RTT defines from Unit Test
2020-03-19 15:25:14 +01:00
Benjamin Valentin
725311a054
periph_common/rtc: add rtc_tm_valid()
...
Add a function to verify all members of a struct tm are within
the valid range.
2020-03-03 16:26:14 +01:00
Benjamin Valentin
5b64ae4ef5
periph_common/rtc: add rtc_localtime()
...
Add function to convert a RTC timestamp (non-UNIX) to a time struct.
2020-03-03 11:01:02 +01:00
Benjamin Valentin
becff61e20
periph_common/rtc: add rtc_mktime()
...
Add a function to convert a time struct to an unsigned timestamp (non-UNIX).
2020-02-29 17:42:50 +01:00
Francisco
3e0043021b
Merge pull request #13110 from kaspar030/periph_rtt_docimp
...
periph/rtt: clarify rtt_set_alarm() documentation
2020-01-13 17:12:08 +01:00
4df2827fe1
periph/rtt: clarify rtt_set_alarm() documentation
2020-01-13 15:18:16 +01:00
Marian Buschsieweke
6e39b4d191
drivers/periph: adc_sample() now returns int32_t
...
Reasoning: This allow support for ADCs with resolution of more than 16 bits on
8 bit and 16 bit platforms.
2020-01-10 14:13:06 +01:00
c87748f563
periph: fix periph/gpio_util.h header guards
2019-11-23 22:39:40 +01:00
Francois Berder
4a31f94cfc
many typo fixes
...
Signed-off-by: Francois Berder <18538310+francois-berder@users.noreply.github.com>
2019-11-23 22:39:07 +01:00
abfa73193f
drivers/periph_pwm: define mapping struct for arduino pins
2019-11-15 17:51:45 +01:00
Benjamin Valentin
513a3a7d59
periph_common/rtc: add rtc_tm_compare()
...
Add an easy way to compare two points in time.
2019-11-05 12:52:45 +01:00
9eee6bc0a1
usbdev: Fix spelling mistakes
2019-10-23 10:36:49 +02:00
Hauke Petersen
7f419f4381
periph/uart: add doc on low power implications
2019-10-01 23:09:23 +02:00
Hauke Petersen
0cd8bb47c8
periph/timer: add doc on low power implications
2019-10-01 23:09:23 +02:00
Hauke Petersen
4914e6484a
periph/spi: add doc on low power implications
2019-10-01 23:09:23 +02:00
Hauke Petersen
44c54c2ae0
periph/rtt: add doc on low power implications
2019-10-01 23:09:23 +02:00
Hauke Petersen
bf5ad17b9d
periph/rtc: add doc on low power implications
2019-10-01 23:09:23 +02:00
Hauke Petersen
711af7cc27
periph/hwrng.h: add doc on low power implications
2019-10-01 23:09:23 +02:00
Hauke Petersen
3e9ee01103
periph/gpio: add doc on low power implications
2019-10-01 23:09:23 +02:00
Hauke Petersen
e71f0bb0c6
periph/flashpage: add doc on low power implications
2019-10-01 23:09:23 +02:00
Hauke Petersen
8ef4f0d134
periph/dac.h: add doc on low power implications
2019-10-01 23:09:23 +02:00
Hauke Petersen
348b337023
periph/cpuid: add doc on low power implications
2019-10-01 23:09:23 +02:00
Hauke Petersen
f361ebc0bd
periph/adc: add doc on low power implications
2019-10-01 23:09:23 +02:00
Gunar Schorcht
02d81b717e
Merge pull request #12063 from maribu/i2c_release
...
drivers/periph/i2c: Updated i2c_release() to return void
2019-10-01 19:50:38 +02:00
benpicco
d5c272ed86
Merge pull request #12199 from smlng/fix_timer_returns
...
periph/timer: Fix return codes of timer API
2019-09-17 23:04:46 +02:00
aed12b4853
Merge pull request #11252 from fjmolinas/pr_wdg_stm32
...
cpu/stm32_common: add watchdog for stm32
2019-09-13 09:16:18 +02:00
Dylan Laduranty
513b767694
Merge pull request #11944 from benpicco/spi_doc-fix
...
drivers/include/periph/spi: fix documentation
2019-09-12 21:28:21 +02:00
Francisco Molina
cb876297a8
drivers/periph: include periph_cpu.h in wdt.h
2019-09-12 17:45:31 +02:00
