Initial Register and BitField macros #4
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adds initial macros for declaring symmetric and asymmetric registers composed of bitfields.
rauhul
requested review from
jckarter,
phausler,
kubamracek,
rokhinip,
ahoppen and
eeckstein
|
This doesn't yet have complete tests, nor does it incorporate @jckarter's suggestions. These may come in a future PR, right now I'm trying to land on a good enough API for initial users, before polishing up the internals. |
|
The protocol hierarchy also feels like a mess... |
phausler
reviewed
Sep 27, 2023
| \(declAccessLevel) init(unsafeAddress: UInt) { self.unsafeAddress = unsafeAddress } | ||
| """, | ||
| "\(declAccessLevel) var unsafeAddress: UInt", | ||
| "\(declAccessLevel) init(unsafeAddress: UInt) { self.unsafeAddress = unsafeAddress }", |
There was a problem hiding this comment.
I don't think this can be uniformly UInt some registers will be defined as UInt8, UInt16, UInt32 or Uint64
There was a problem hiding this comment.
Note: This is the address of the register, not the value of the register itself
There was a problem hiding this comment.
should it then contain the size in the initializer?
There was a problem hiding this comment.
You mean the macro arguments?
phausler
reviewed
Sep 27, 2023
| case reserved = "Reserved" | ||
| case readWrite = "ReadWrite" | ||
| case readOnly = "ReadOnly" | ||
| case writeOnly = "WriteOnly" |
There was a problem hiding this comment.
what about writeOnce and readWriteOnce types?
- Rewrite diagnostics system - Add `require` helpers methods which throw on error and emit diagnostics - Refactors macros to leverage `require` methods - Expands MacroArgumentParser to emit better diagnostics and fixits
rauhul
force-pushed
the
register-macros
branch
from
1b2dbc3
to
289fea6
Compare
rauhul
changed the title
rauhul
added a commit
that referenced
this pull request
Nov 17, 2023
Add initial Register and BitField macros Adds an initial set of macros for declaring symmetric and asymmetric registers composed of bit fields. The new `@Register` macro can be applied to a struct only containing stored properties marked with one of the new bit field macros: `@Reserved`, `@ReadWrite`, `@ReadOnly`, or `@WriteOnly`. The bit field macros take bit range argument which the register macro uses to create three views of the register. The first is a raw view which provides untyped access to the bits of the register. The second is a read view which only provides typed getters for the readable bit fields. The last is a write view which provides setters. Additional bit field macros such as `@Write1Clear` will be introduced in a future PR. Sample usage: ```swift @register(bitWidth: 32) struct Example { @readwrite(bits: 0..<1) var en: EN } var example = Register<Example>(...) example.modify { $0.en = 0x1 } ``` Miscellaneous changes Rewrites diagnostics system leveraging a new `MacroContext` type which handles prefixing diagnostics with the name of the macro which produced them. Adds helper methods prefixed by "require" to swift-syntax types which take a macro context, emit a diagnostic and throw `ExpansionError` if the requirement is not met. Adds MMIOKindMacro protocol wrappers which suppresses thrown `ExpansionErrors` to allow macros to be written as simpler straight line code e.g. `try value.requireSomething(context)`. Replaces `MacroArgumentParser` with `ParsableMacro` leveraging `MacroContext` which emits better diagnostics and fix-its.
rauhul
added a commit
that referenced
this pull request
Nov 17, 2023
Add initial Register and BitField macros Adds an initial set of macros for declaring symmetric and asymmetric registers composed of bit fields. The new `@Register` macro can be applied to a struct only containing stored properties marked with one of the new bit field macros: `@Reserved`, `@ReadWrite`, `@ReadOnly`, or `@WriteOnly`. The bit field macros take bit range argument which the register macro uses to create three views of the register. The first is a raw view which provides untyped access to the bits of the register. The second is a read view which only provides typed getters for the readable bit fields. The last is a write view which provides setters. Additional bit field macros such as `@Write1Clear` will be introduced in a future PR. Sample usage: ```swift @register(bitWidth: 32) struct Example { @readwrite(bits: 0..<1) var en: EN } var example = Register<Example>(...) example.modify { $0.en = 0x1 } ``` Miscellaneous changes Rewrites diagnostics system leveraging a new `MacroContext` type which handles prefixing diagnostics with the name of the macro which produced them. Adds helper methods prefixed by "require" to swift-syntax types which take a macro context, emit a diagnostic and throw `ExpansionError` if the requirement is not met. Adds MMIOKindMacro protocol wrappers which suppresses thrown `ExpansionErrors` to allow macros to be written as simpler straight line code e.g. `try value.requireSomething(context)`. Replaces `MacroArgumentParser` with `ParsableMacro` leveraging `MacroContext` which emits better diagnostics and fix-its.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
adds initial macros for declaring symmetric and asymmetric registers composed of bitfields.