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

Update tock-registers doc to fix mistake #2071

Merged
merged 1 commit into from Aug 14, 2020
Merged

Update tock-registers doc to fix mistake #2071

merged 1 commit into from Aug 14, 2020

Conversation

brghena
Copy link
Contributor

@brghena brghena commented Aug 13, 2020

Default is u32, and register fields in the example were greater than 8 bits in size, so we should just use 32-bits as the register size in the example.

Pull Request Overview

Modifies tock-registers README.

Testing Strategy

N/A

TODO or Help Wanted

N/A

Documentation Updated

  • Updated the relevant files in /docs, or no updates are required.

Formatting

  • [N/A] Ran make prepush.

Default is u32, and register fields in the example were greater than 8
bits in size, so we should just use 32-bits as the register size in the
example.
@brghena
Copy link
Contributor Author

brghena commented Aug 13, 2020

@alistair23 any ideas why the QEMU check is failing?

@alistair23
Copy link
Contributor

The CI should be fixed now.

@bradjc bradjc merged commit f5f0913 into master Aug 14, 2020
@bors bors bot deleted the fix-register-docs branch August 14, 2020 14:51
ppannuto added a commit that referenced this pull request Nov 11, 2020
Changes since v0.5:

 - #2095: Fix syntax errors and inconsistencies in documentation
 - #2071: Clarify bit widths in documentation examples
 - #2015: Use UnsafeCell in registers (see issue #2005)
 - #1939: Make the Field::mask and FieldValue::mask fields private
 - #1823: Allow large unsigned values as bitmasks + add bitmask! helper macro
 - #1554: Allow lifetime parameters for `register_structs! { Foo<'a> { ..`
 - #1661: Add `Aliased` register type for MMIO with differing R/W behavior

Thanks to @namyoonw, @brghena, @dabross, @gendx, @hudson-ayers, and @pfmooney
for contributions, fixes, and testing!

Closes #2138.
@ppannuto ppannuto mentioned this pull request Nov 11, 2020
2 tasks
hudson-ayers pushed a commit that referenced this pull request Mar 7, 2022
Changes since v0.5:

 - #2095: Fix syntax errors and inconsistencies in documentation
 - #2071: Clarify bit widths in documentation examples
 - #2015: Use UnsafeCell in registers (see issue #2005)
 - #1939: Make the Field::mask and FieldValue::mask fields private
 - #1823: Allow large unsigned values as bitmasks + add bitmask! helper macro
 - #1554: Allow lifetime parameters for `register_structs! { Foo<'a> { ..`
 - #1661: Add `Aliased` register type for MMIO with differing R/W behavior

Thanks to @namyoonw, @brghena, @dabross, @gendx, @hudson-ayers, and @pfmooney
for contributions, fixes, and testing!

Closes #2138.

BUG=none
TEST=make

(cherry picked from commit 72a1e1e)
Change-Id: Ia2dbf69c950e3581a43f5d6601a5cf94abace750
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants