Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

drivers/periph/rtc: improve doc on rtc_set_alarm #19610

Merged
merged 1 commit into from
May 30, 2023

Conversation

maribu
Copy link
Member

@maribu maribu commented May 17, 2023

Contribution description

  • point out behavior on denormalized time stamps
  • use errno codes to indicate errors (and adapt the few instances of actual error handling to use them)

Testing procedure

This should not really effect behavior, except for error return codes. But nobody checks them anyway 😅

Issues/PRs references

Fixes #16574

@github-actions github-actions bot added Area: cpu Area: CPU/MCU ports Area: drivers Area: Device drivers Platform: ARM Platform: This PR/issue effects ARM-based platforms Platform: native Platform: This PR/issue effects the native platform labels May 17, 2023
@benpicco benpicco added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label May 23, 2023
@riot-ci
Copy link

riot-ci commented May 23, 2023

Murdock results

✔️ PASSED

51127f6 drivers/periph/rtc: improve doc on rtc_set_alarm

Success Failures Total Runtime
6933 0 6933 14m:55s

Artifacts

@maribu maribu force-pushed the drivers/periph/rtc/doc branch 2 times, most recently from c74ec8a to b815253 Compare May 30, 2023 15:40
- point out behavior on denormalized time stamps
- use errno codes to indicate errors (and adapt the few instances of
  actual error handling to use them)
@maribu maribu force-pushed the drivers/periph/rtc/doc branch from b815253 to 51127f6 Compare May 30, 2023 15:41
@maribu
Copy link
Member Author

maribu commented May 30, 2023

bors merge

bors bot added a commit that referenced this pull request May 30, 2023
19610: drivers/periph/rtc: improve doc on rtc_set_alarm r=maribu a=maribu

### Contribution description

- point out behavior on denormalized time stamps
- use errno codes to indicate errors (and adapt the few instances of actual error handling to use them)


19670: cpu/stm32: stm32f4 BRR from BSRR r=maribu a=kfessel

### Contribution description

sometimes one wants to save one instruction :) 
just write the bits we need to write.

### Testing procedure

tests/periph/gpio_ll tests this 

### Issues/PRs references

`@maribu` might know some reference

maybe #19407

19678: gnrc_sixlowpan_iphc: fix NULL pointer dereference r=maribu a=miri64



19679: gnrc_sixlowpan_frag_sfr: fix ARQ scheduler race-condition r=maribu a=miri64



19680: gnrc_sixlowpan_frag_rb: fix OOB write in _rbuf_add r=maribu a=miri64



19681: sys/xtimer: improve documentation r=maribu a=maribu

### Contribution description

- Add a warning that xtimer is deprecated, so that new code hopefully starts using ztimer
- Add a hint that `ztimer_xtimer_compat` can be used even after `xtimer` is gone


Co-authored-by: Marian Buschsieweke <marian.buschsieweke@ovgu.de>
Co-authored-by: Karl Fessel <karl.fessel@ovgu.de>
Co-authored-by: Martine Lenders <m.lenders@fu-berlin.de>
@bors
Copy link
Contributor

bors bot commented May 30, 2023

This PR was included in a batch that was canceled, it will be automatically retried

@bors bors bot merged commit 00b5bc1 into RIOT-OS:master May 30, 2023
@bors
Copy link
Contributor

bors bot commented May 30, 2023

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

@maribu maribu deleted the drivers/periph/rtc/doc branch May 30, 2023 21:48
@maribu
Copy link
Member Author

maribu commented May 30, 2023

Thx :)

@benpicco benpicco added this to the Release 2023.07 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: cpu Area: CPU/MCU ports Area: drivers Area: Device drivers CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Platform: ARM Platform: This PR/issue effects ARM-based platforms Platform: native Platform: This PR/issue effects the native platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cpu/stm32/periph/rtc overflow error
3 participants