bitfield initial refactor within nova-core
Subsystems (4)
v7 cover bitfield initial refactor within nova-core
These patches implement the initial refactoring and few improvements to the register and bitfield macros. Rebased on drm-rust-next.
Main difference from the previous series [1] is dropped the moving out of nova-core pending BoundedInt changes:
https://lore.kernel.org/all/[email protected]/
Other than that, added tags, resolved conflict with kernel::fmt changes and rebased on drm-rust-next.
Alexandre Courbot (1):
gpu: nova-core: register: use field type for Into implementation
Joel Fernandes (3):
gpu: nova-core: bitfield: Move bitfield-specific code from register!
into new macro
gpu: nova-core: bitfield: Add support for different storage widths
gpu: nova-core: bitfield: Add support for custom visiblity
drivers/gpu/nova-core/bitfield.rs | 333 +++++++++++++++++++++++++++ drivers/gpu/nova-core/falcon.rs | 38 ++- drivers/gpu/nova-core/nova_core.rs | 3 + drivers/gpu/nova-core/regs/macros.rs | 259 +-------------------- 4 files changed, 373 insertions(+), 260 deletions(-) create mode 100644 drivers/gpu/nova-core/bitfield.rs
base-commit: 1d5cffebd930d61588c32198f85fbe541ab97b8f
Signature · 1 line
2.34.1
PATCH v7 1/4 gpu: nova-core: register: use field type for Into implementation
From: Alexandre Courbot <[email protected]>
The getter method of a field works with the field type, but its setter expects the type of the register. This leads to an asymmetry in the From/Into implementations required for a field with a dedicated type. For instance, a field declared as
pub struct ControlReg(u32) {
3:0 mode as u8 ?=> Mode;
...
}currently requires the following implementations:
impl TryFrom<u8> for Mode {
...
}
impl From<Mode> for u32 {
...
}Change this so the From<Mode> now needs to be implemented for u8, i.e. the primitive type of the field. This is more consistent, and will become a requirement once we start using the TryFrom/Into derive macros to implement these automatically.
--- drivers/gpu/nova-core/falcon.rs | 38 ++++++++++++++++++++-------- drivers/gpu/nova-core/regs/macros.rs | 10 ++++---- 2 files changed, 32 insertions(+), 16 deletions(-)
drivers/gpu/nova-core/falcon.rs +27 -11
@@ -22,11 +22,11 @@pub (crate )mod sec2;// TODO[FPRI]: Replace with `ToPrimitive`. -macro_rules! impl_from_enum_to_u32 { +macro_rules! impl_from_enum_to_u8 { ($enum_type:ty) => { -impl From <$enum_type>for u32 { +impl From <$enum_type>for u8 {fn from (value: $enum_type) ->Self { - valueas u32 + valueas u8 } } };
@@ -46,7 +46,7 @@ pub(crate) enum FalconCoreRev { Rev6 = 6, Rev7 = 7, } -impl_from_enum_to_u32! (FalconCoreRev ); +impl_from_enum_to_u8! (FalconCoreRev );// TODO[FPRI]: replace with `FromPrimitive`. impl TryFrom <u8 >for FalconCoreRev {
@@ -81,7 +81,7 @@ pub(crate) enum FalconCoreRevSubversion { Subversion2 = 2, Subversion3 = 3, } -impl_from_enum_to_u32! (FalconCoreRevSubversion ); +impl_from_enum_to_u8! (FalconCoreRevSubversion );// TODO[FPRI]: replace with `FromPrimitive`. impl TryFrom <u8 >for FalconCoreRevSubversion {
@@ -125,7 +125,7 @@ pub(crate) enum FalconSecurityModel {/// Also known as High-Secure, Privilege Level 3 or PL3. Heavy = 3, } -impl_from_enum_to_u32! (FalconSecurityModel ); +impl_from_enum_to_u8! (FalconSecurityModel );// TODO[FPRI]: replace with `FromPrimitive`. impl TryFrom <u8 >for FalconSecurityModel {
@@ -157,7 +157,7 @@ pub(crate) enum FalconModSelAlgo {#[default] Rsa3k = 1, } -impl_from_enum_to_u32! (FalconModSelAlgo ); +impl_from_enum_to_u8! (FalconModSelAlgo );// TODO[FPRI]: replace with `FromPrimitive`. impl TryFrom <u8 >for FalconModSelAlgo {
@@ -179,7 +179,7 @@ pub(crate) enum DmaTrfCmdSize {#[default] Size256B = 0x6, } -impl_from_enum_to_u32! (DmaTrfCmdSize ); +impl_from_enum_to_u8! (DmaTrfCmdSize );// TODO[FPRI]: replace with `FromPrimitive`. impl TryFrom <u8 >for DmaTrfCmdSize {
@@ -202,7 +202,6 @@ pub(crate) enum PeregrineCoreSelect {/// RISC-V core is active. Riscv = 1, } -impl_from_enum_to_u32! (PeregrineCoreSelect );impl From <bool >for PeregrineCoreSelect {fn from (value:bool ) ->Self {
@@ -213,6 +212,15 @@ fn from(value: bool) -> Self { } } +impl From <PeregrineCoreSelect >for bool { +fn from (value:PeregrineCoreSelect ) ->Self { +match value { +PeregrineCoreSelect ::Falcon =>false , +PeregrineCoreSelect ::Riscv =>true , + } + } +} +/// Different types of memory present in a falcon core. #[derive( Debug , Clone , Copy , PartialEq , Eq )] pub (crate )enum FalconMem {
@@ -236,7 +244,7 @@ pub(crate) enum FalconFbifTarget {/// Non-coherent system memory (System DRAM). NoncoherentSysmem = 2, } -impl_from_enum_to_u32! (FalconFbifTarget ); +impl_from_enum_to_u8! (FalconFbifTarget );// TODO[FPRI]: replace with `FromPrimitive`. impl TryFrom <u8 >for FalconFbifTarget {
@@ -263,7 +271,6 @@ pub(crate) enum FalconFbifMemType {/// Physical memory addresses. Physical = 1, } -impl_from_enum_to_u32! (FalconFbifMemType );/// Conversion from a single-bit register field. impl From <bool >for FalconFbifMemType {
@@ -275,6 +282,15 @@ fn from(value: bool) -> Self { } } +impl From <FalconFbifMemType >for bool { +fn from (value:FalconFbifMemType ) ->Self { +match value { +FalconFbifMemType ::Virtual =>false , +FalconFbifMemType ::Physical =>true , + } + } +} +/// Type used to represent the `PFALCON` registers address base for a given falcon engine. pub (crate )struct PFalconBase (());
drivers/gpu/nova-core/regs/macros.rs +5 -5
@@ -482,7 +482,7 @@ impl $name {register! ( @leaf_accessor $name $hi:$lo $field { |f| <$into_type>::from (if f !=0 {true }else {false }) } - $into_type => $into_type $(, $comment)?; +bool $into_type => $into_type $(, $comment)?; ); };
@@ -499,7 +499,7 @@ impl $name { $(, $comment:literal)?; ) => {register! (@leaf_accessor $name $hi:$lo $field - { |f| <$try_into_type>::try_from (fas $type ) } $try_into_type => + { |f| <$try_into_type>::try_from (fas $type ) } $type $try_into_type => ::core::result::Result < $try_into_type, <$try_into_typeas ::core::convert::TryFrom <$type >>::Error
@@ -513,7 +513,7 @@ impl $name { $(, $comment:literal)?; ) => {register! (@leaf_accessor $name $hi:$lo $field - { |f| <$into_type>::from (fas $type ) } $into_type => $into_type $(, $comment)?;); + { |f| <$into_type>::from (fas $type ) } $type $into_type => $into_type $(, $comment)?;); };// Shortcut for non-boolean fields defined without the `=>` or `?=>` syntax.
@@ -527,7 +527,7 @@ impl $name {// Generates the accessor methods for a single field. ( @leaf_accessor $name:ident $hi:tt:$lo:tt $field:ident - { $process:expr } $to_type:ty => $res_type:ty $(, $comment:literal)?; + { $process:expr } $prim_type:tt $to_type:ty => $res_type:ty $(, $comment:literal)?; ) => { ::kernel::macros::paste!(const [<$field:upper_RANGE >]: ::core::ops::RangeInclusive <u8 > = $lo..=$hi;
@@ -559,7 +559,7 @@ pub(crate) fn $field(self) -> $res_type { pub(crate) fn [<set_ $field>](mut self, value: $to_type) -> Self { const MASK: u32 = $name::[<$field:upper _MASK>]; const SHIFT: u32 = $name::[<$field:upper _SHIFT>]; -let value = (u32::from (value) <<SHIFT ) &MASK ; +let value = (u32::from ($prim_type::from (value)) <<SHIFT ) &MASK ; self.0 = (self.0 & !MASK ) | value; self
Signature · 1 line
2.34.1
Re: [PATCH v7 1/4] gpu: nova-core: register: use field type for Into implementation
Quoted 22 lines · Joel Fernandes
From: Alexandre Courbot <[email protected]>
The getter method of a field works with the field type, but its setter expects the type of the register. This leads to an asymmetry in the From/Into implementations required for a field with a dedicated type. For instance, a field declared as
pub struct ControlReg(u32) { 3:0 mode as u8 ?=> Mode; ... }currently requires the following implementations:
impl TryFrom<u8> for Mode { ... } impl From<Mode> for u32 { ... }
Quoted 7 lines
Change this so the
From<Mode>now needs to be implemented foru8, i.e. the primitive type of the field. This is more consistent, and will become a requirement once we start using the TryFrom/Into derive macros to implement these automatically.Reviewed-by Joel Fernandes <[email protected]>Signed-off-by Alexandre Courbot <[email protected]>
Uff, my SOB is missing.
Alex, do you mind adding it to the patch when applying?
thanks,
- Joel
PATCH v7 2/4 gpu: nova-core: bitfield: Move bitfield-specific code from register! into new macro
In reply to Joel FernandesThe bitfield-specific into new macro. This will be used to define structs with bitfields, similar to C language.
--- drivers/gpu/nova-core/bitfield.rs | 319 +++++++++++++++++++++++++++ drivers/gpu/nova-core/nova_core.rs | 3 + drivers/gpu/nova-core/regs/macros.rs | 259 +--------------------- 3 files changed, 332 insertions(+), 249 deletions(-) create mode 100644 drivers/gpu/nova-core/bitfield.rs
drivers/gpu/nova-core/bitfield.rs new file +319 -0
@@ -0,0 +1,319 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! Bitfield library for Rust structures +//! +//! Support for defining bitfields in Rust structures. Also used by the [`register!`] macro. + +/// Defines a struct with accessors to access bits within an inner unsigned integer. +/// +/// # Syntax +/// +/// ```rust +/// use nova_core::bitfield; +/// +/// #[derive(Debug, Clone, Copy, Default)] +/// enum Mode { +/// #[default] +/// Low = 0, +/// High = 1, +/// Auto = 2, +/// } +/// +/// impl TryFrom<u8> for Mode { +/// type Error = u8; +/// fn try_from(value: u8) -> Result<Self, Self::Error> { +/// match value { +/// 0 => Ok(Mode::Low), +/// 1 => Ok(Mode::High), +/// 2 => Ok(Mode::Auto), +/// _ => Err(value), +/// } +/// } +/// } +/// +/// impl From<Mode> for u8 { +/// fn from(mode: Mode) -> u8 { +/// mode as u8 +/// } +/// } +/// +/// #[derive(Debug, Clone, Copy, Default)] +/// enum State { +/// #[default] +/// Inactive = 0, +/// Active = 1, +/// } +/// +/// impl From<bool> for State { +/// fn from(value: bool) -> Self { +/// if value { State::Active } else { State::Inactive } +/// } +/// } +/// +/// impl From<State> for bool { +/// fn from(state: State) -> bool { +/// match state { +/// State::Inactive => false, +/// State::Active => true, +/// } +/// } +/// } +/// +/// bitfield! { +/// struct ControlReg { +/// 3:0 mode as u8 ?=> Mode; +/// 7:7 state as bool => State; +/// } +/// } +/// ``` +/// +/// This generates a struct with: +/// - Field accessors: `mode()`, `state()`, etc. +/// - Field setters: `set_mode()`, `set_state()`, etc. (supports chaining with builder pattern). +/// - Debug and Default implementations. +/// +/// Fields are defined as follows: +/// +/// - `as <type>` simply returns the field value casted to <type>, typically `u32`, `u16`, `u8` or +/// `bool`. Note that `bool` fields must have a range of 1 bit. +/// - `as <type> => <into_type>` calls `<into_type>`'s `From::<<type>>` implementation and returns +/// the result. +/// - `as <type> ?=> <try_into_type>` calls `<try_into_type>`'s `TryFrom::<<type>>` implementation +/// and returns the result. This is useful with fields for which not all values are valid. +macro_rules! bitfield { +// Main entry point - defines the bitfield struct with fields + (struct $name:ident $(, $comment:literal)? { $($fields:tt)* }) => { +bitfield! (@core $name $(, $comment)? { $($fields)* }); + }; + +// All rules below are helpers. + +// Defines the wrapper `$name` type, as well as its relevant implementations (`Debug`, +// `Default`, `BitOr`, and conversion to the value type) and field accessor methods. + (@core $name:ident $(, $comment:literal)? { $($fields:tt)* }) => { + $( +#[doc=$comment] + )? +#[repr(transparent)] +#[derive( Clone , Copy )] +pub (crate )struct $name(u32 ); + +impl ::core::ops::BitOr for $name { +type Output =Self ; + +fn bitor (self, rhs:Self ) ->Self ::Output { +Self (self.0 | rhs.0 ) + } + } + +impl ::core::convert::From <$name>for u32 { +fn from (val: $name) ->u32 { + val.0 + } + } + +bitfield! (@fields_dispatcher $name { $($fields)* }); + }; + +// Captures the fields and passes them to all the implementers that require field information. +// +// Used to simplify the matching rules for implementers, so they don't need to match the entire +// complex fields rule even though they only make use of part of it. + (@fields_dispatcher $name:ident { + $($hi:tt:$lo:tt $field:identas $type:tt + $(?=> $try_into_type:ty)? + $(=> $into_type:ty)? + $(, $comment:literal)? + ; + )* + } + ) => { +bitfield! (@field_accessors $name { + $( + $hi:$lo $fieldas $type + $(?=> $try_into_type)? + $(=> $into_type)? + $(, $comment)? + ; + )* + }); +bitfield! (@debug $name { $($field;)* }); +bitfield! (@default $name { $($field;)* }); + }; + +// Defines all the field getter/setter methods for `$name`. + ( + @field_accessors $name:ident { + $($hi:tt:$lo:tt $field:identas $type:tt + $(?=> $try_into_type:ty)? + $(=> $into_type:ty)? + $(, $comment:literal)? + ; + )* + } + ) => { + $( +bitfield! (@check_field_bounds $hi:$lo $fieldas $type ); + )* + +#[allow(dead_code)] +impl $name { + $( +bitfield! (@field_accessor $name $hi:$lo $fieldas $type + $(?=> $try_into_type)? + $(=> $into_type)? + $(, $comment)? + ; + ); + )* + } + }; + +// Boolean fields must have `$hi == $lo`. + (@check_field_bounds $hi:tt:$lo:tt $field:identas bool ) => { +#[allow(clippy::eq_op)] +const _: () = { + ::kernel::build_assert!( + $hi == $lo, +concat! ("boolean field `" ,stringify! ($field),"` covers more than one bit" ) + ); + }; + }; + +// Non-boolean fields must have `$hi >= $lo`. + (@check_field_bounds $hi:tt:$lo:tt $field:identas $type:tt) => { +#[allow(clippy::eq_op)] +const _: () = { + ::kernel::build_assert!( + $hi >= $lo, +concat! ("field `" ,stringify! ($field),"`'s MSB is smaller than its LSB" ) + ); + }; + }; + +// Catches fields defined as `bool` and convert them into a boolean value. + ( + @field_accessor $name:ident $hi:tt:$lo:tt $field:identas bool => $into_type:ty + $(, $comment:literal)?; + ) => { +bitfield! ( + @leaf_accessor $name $hi:$lo $field + { |f| <$into_type>::from (if f !=0 {true }else {false }) } +bool $into_type => $into_type $(, $comment)?; + ); + }; + +// Shortcut for fields defined as `bool` without the `=>` syntax. + ( + @field_accessor $name:ident $hi:tt:$lo:tt $field:identas bool $(, $comment:literal)?; + ) => { +bitfield! (@field_accessor $name $hi:$lo $fieldas bool =>bool $(, $comment)?;); + }; + +// Catches the `?=>` syntax for non-boolean fields. + ( + @field_accessor $name:ident $hi:tt:$lo:tt $field:identas $type:tt ?=> $try_into_type:ty + $(, $comment:literal)?; + ) => { +bitfield! (@leaf_accessor $name $hi:$lo $field + { |f| <$try_into_type>::try_from (fas $type ) } $type $try_into_type => + ::core::result::Result < + $try_into_type, + <$try_into_typeas ::core::convert::TryFrom <$type >>::Error + > + $(, $comment)?;); + }; + +// Catches the `=>` syntax for non-boolean fields. + ( + @field_accessor $name:ident $hi:tt:$lo:tt $field:identas $type:tt => $into_type:ty + $(, $comment:literal)?; + ) => { +bitfield! (@leaf_accessor $name $hi:$lo $field + { |f| <$into_type>::from (fas $type ) } $type $into_type => $into_type $(, $comment)?;); + }; + +// Shortcut for non-boolean fields defined without the `=>` or `?=>` syntax. + ( + @field_accessor $name:ident $hi:tt:$lo:tt $field:identas $type:tt + $(, $comment:literal)?; + ) => { +bitfield! (@field_accessor $name $hi:$lo $fieldas $type => $type $(, $comment)?;); + }; + +// Generates the accessor methods for a single field. + ( + @leaf_accessor $name:ident $hi:tt:$lo:tt $field:ident + { $process:expr } $prim_type:tt $to_type:ty => $res_type:ty $(, $comment:literal)?; + ) => { + ::kernel::macros::paste!( +const [<$field:upper_RANGE >]: ::core::ops::RangeInclusive <u8 > = $lo..=$hi; +const [<$field:upper _MASK>]:u32 = ((((1 << $hi) -1 ) <<1 ) +1 ) - ((1 << $lo) -1 ); +const [<$field:upper_SHIFT >]:u32 =Self ::[<$field:upper _MASK>].trailing_zeros (); + ); + + $( +#[doc= "Returns the value of this field:" ] +#[doc=$comment] + )? +#[inline(always)] +pub (crate )fn $field(self) -> $res_type { + ::kernel::macros::paste!( +const MASK :u32 = $name::[<$field:upper _MASK>]; +const SHIFT :u32 = $name::[<$field:upper_SHIFT >]; + ); +let field = ((self.0 &MASK ) >>SHIFT ); + + $process(field) + } + + ::kernel::macros::paste!( + $( +#[doc= "Sets the value of this field:" ] +#[doc=$comment] + )? +#[inline(always)] +pub (crate )fn [<set_ $field>](mut self, value: $to_type) ->Self { +const MASK :u32 = $name::[<$field:upper _MASK>]; +const SHIFT :u32 = $name::[<$field:upper_SHIFT >]; +let value = (u32 ::from ($prim_type::from (value)) <<SHIFT ) &MASK ; + self.0 = (self.0 & !MASK ) | value; + + self + } + ); + }; + +// Generates the `Debug` implementation for `$name`. + (@debug $name:ident { $($field:ident;)* }) => { +impl ::kernel::fmt::Debug for $name { +fn fmt (&self, f: &mut ::kernel::fmt::Formatter <'_>) -> ::kernel::fmt::Result { + f.debug_struct (stringify! ($name)) + .field ("<raw>" , &::kernel::prelude::fmt!("{:#x}" , &self.0 )) + $( + .field (stringify! ($field), &self.$field()) + )* + .finish () + } + } + }; + +// Generates the `Default` implementation for `$name`. + (@default $name:ident { $($field:ident;)* }) => { +/// Returns a value for the bitfield where all fields are set to their default value. +impl ::core::default ::Default for $name { +fn default () ->Self { +#[allow(unused_mut)] +let mut value =Self (Default ::default ()); + + ::kernel::macros::paste!( + $( + value.[<set_ $field>](Default ::default ()); + )* + ); + + value + } + } + }; +}
drivers/gpu/nova-core/nova_core.rs +3 -0
@@ -2,6 +2,9 @@//! Nova Core GPU Driver +#[macro_use] +mod bitfield; +mod dma;mod driver;mod falcon;
drivers/gpu/nova-core/regs/macros.rs +10 -249
319 lines not on this page · raw message
Signature · 1 line
2.34.1
PATCH v7 3/4 gpu: nova-core: bitfield: Add support for different storage widths
In reply to Joel FernandesPreviously, bitfields were hardcoded to use u32 as the underlying storage type. Add support for different storage types (u8, u16, u32, u64) to the bitfield macro.
New syntax is: struct Name(<type ex., u32>) { ... }
--- drivers/gpu/nova-core/bitfield.rs | 65 ++++++++++++++++------------ drivers/gpu/nova-core/regs/macros.rs | 16 +++---- 2 files changed, 46 insertions(+), 35 deletions(-)
drivers/gpu/nova-core/bitfield.rs +38 -27
@@ -60,7 +60,7 @@/// } /// /// bitfield! { -/// struct ControlReg { +/// struct ControlReg(u32) { /// 3:0 mode as u8 ?=> Mode; /// 7:7 state as bool => State; /// }
@@ -70,6 +70,8 @@/// This generates a struct with: /// - Field accessors: `mode()`, `state()`, etc. /// - Field setters: `set_mode()`, `set_state()`, etc. (supports chaining with builder pattern). +/// Note that the compiler will error out if the size of the setter's arg exceeds the +/// struct's storage size. /// - Debug and Default implementations. /// /// Fields are defined as follows:
@@ -82,21 +84,21 @@/// and returns the result. This is useful with fields for which not all values are valid. macro_rules! bitfield {// Main entry point - defines the bitfield struct with fields - (struct $name:ident $(, $comment:literal)? { $($fields:tt)* }) => { -bitfield! (@core $name $(, $comment)? { $($fields)* }); + (struct $name:ident($storage:ty) $(, $comment:literal)? { $($fields:tt)* }) => { +bitfield! (@core $name $storage $(, $comment)? { $($fields)* }); };// All rules below are helpers. // Defines the wrapper `$name` type, as well as its relevant implementations (`Debug`, // `Default`, `BitOr`, and conversion to the value type) and field accessor methods. - (@core $name:ident $(, $comment:literal)? { $($fields:tt)* }) => { + (@core $name:ident $storage:ty $(, $comment:literal)? { $($fields:tt)* }) => { $(#[doc=$comment] )?#[repr(transparent)] #[derive( Clone , Copy )] -pub (crate )struct $name(u32 ); +pub (crate )struct $name($storage);impl ::core::ops::BitOr for $name {type Output =Self ;
@@ -106,20 +108,20 @@ fn bitor(self, rhs: Self) -> Self::Output { } } -impl ::core::convert::From <$name>for u32 { -fn from (val: $name) ->u32 { +impl ::core::convert::From <$name>for $storage { +fn from (val: $name) -> $storage { val.0 } } -bitfield! (@fields_dispatcher $name { $($fields)* }); +bitfield! (@fields_dispatcher $name $storage { $($fields)* }); };// Captures the fields and passes them to all the implementers that require field information. // // Used to simplify the matching rules for implementers, so they don't need to match the entire // complex fields rule even though they only make use of part of it. - (@fields_dispatcher $name:ident { + (@fields_dispatcher $name:ident $storage:ty { $($hi:tt:$lo:tt $field:ident as $type:tt $(?=> $try_into_type:ty)? $(=> $into_type:ty)?
@@ -128,7 +130,7 @@ fn from(val: $name) -> u32 { )* } ) => { - bitfield!(@field_accessors $name { + bitfield!(@field_accessors $name $storage { $( $hi:$lo $field as $type $(?=> $try_into_type)?
@@ -143,7 +145,7 @@ fn from(val: $name) -> u32 {// Defines all the field getter/setter methods for `$name`. ( - @field_accessors $name:ident { + @field_accessors $name:ident $storage:ty { $($hi:tt:$lo:tt $field:ident as $type:tt $(?=> $try_into_type:ty)? $(=> $into_type:ty)?
@@ -159,7 +161,7 @@ fn from(val: $name) -> u32 {#[allow(dead_code)] impl $name { $( -bitfield! (@field_accessor $name $hi:$lo $fieldas $type +bitfield! (@field_accessor $name $storage, $hi:$lo $fieldas $type $(?=> $try_into_type)? $(=> $into_type)? $(, $comment)?
@@ -193,11 +195,11 @@ impl $name {// Catches fields defined as `bool` and convert them into a boolean value. ( - @field_accessor $name:ident $hi:tt:$lo:tt $field:ident as bool => $into_type:ty + @field_accessor $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as bool => $into_type:ty $(, $comment:literal)?; ) => {bitfield! ( - @leaf_accessor $name $hi:$lo $field + @leaf_accessor $name $storage, $hi:$lo $field { |f| <$into_type>::from (if f !=0 {true }else {false }) }bool $into_type => $into_type $(, $comment)?; );
@@ -205,17 +207,17 @@ impl $name {// Shortcut for fields defined as `bool` without the `=>` syntax. ( - @field_accessor $name:ident $hi:tt:$lo:tt $field:ident as bool $(, $comment:literal)?; + @field_accessor $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as bool $(, $comment:literal)?; ) => { -bitfield! (@field_accessor $name $hi:$lo $fieldas bool =>bool $(, $comment)?;); +bitfield! (@field_accessor $name $storage, $hi:$lo $fieldas bool =>bool $(, $comment)?;); };// Catches the `?=>` syntax for non-boolean fields. ( - @field_accessor $name:ident $hi:tt:$lo:tt $field:ident as $type:tt ?=> $try_into_type:ty + @field_accessor $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as $type:tt ?=> $try_into_type:ty $(, $comment:literal)?; ) => { -bitfield! (@leaf_accessor $name $hi:$lo $field +bitfield! (@leaf_accessor $name $storage, $hi:$lo $field { |f| <$try_into_type>::try_from (fas $type ) } $type $try_into_type => ::core::result::Result < $try_into_type,
@@ -226,29 +228,38 @@ impl $name {// Catches the `=>` syntax for non-boolean fields. ( - @field_accessor $name:ident $hi:tt:$lo:tt $field:ident as $type:tt => $into_type:ty + @field_accessor $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as $type:tt => $into_type:ty $(, $comment:literal)?; ) => { -bitfield! (@leaf_accessor $name $hi:$lo $field +bitfield! (@leaf_accessor $name $storage, $hi:$lo $field { |f| <$into_type>::from (fas $type ) } $type $into_type => $into_type $(, $comment)?;); };// Shortcut for non-boolean fields defined without the `=>` or `?=>` syntax. ( - @field_accessor $name:ident $hi:tt:$lo:tt $field:ident as $type:tt + @field_accessor $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as $type:tt $(, $comment:literal)?; ) => { -bitfield! (@field_accessor $name $hi:$lo $fieldas $type => $type $(, $comment)?;); +bitfield! (@field_accessor $name $storage, $hi:$lo $fieldas $type => $type $(, $comment)?;); };// Generates the accessor methods for a single field. ( - @leaf_accessor $name:ident $hi:tt:$lo:tt $field:ident + @leaf_accessor $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident { $process:expr } $prim_type:tt $to_type:ty => $res_type:ty $(, $comment:literal)?; ) => { ::kernel::macros::paste!(const [<$field:upper_RANGE >]: ::core::ops::RangeInclusive <u8 > = $lo..=$hi; -const [<$field:upper _MASK>]:u32 = ((((1 << $hi) -1 ) <<1 ) +1 ) - ((1 << $lo) -1 ); +const [<$field:upper _MASK>]: $storage = { +// Generate mask for shifting +match ::core::mem::size_of ::<$storage>() { +1 => ::kernel::bits::genmask_u8 ($lo..=$hi)as $storage, +2 => ::kernel::bits::genmask_u16 ($lo..=$hi)as $storage, +4 => ::kernel::bits::genmask_u32 ($lo..=$hi)as $storage, +8 => ::kernel::bits::genmask_u64 ($lo..=$hi)as $storage, + _ => ::kernel::build_error!("Unsupported storage type size" ) + } + };const [<$field:upper_SHIFT >]:u32 =Self ::[<$field:upper _MASK>].trailing_zeros (); );
@@ -259,7 +270,7 @@ impl $name {#[inline(always)] pub (crate )fn $field(self) -> $res_type { ::kernel::macros::paste!( -const MASK :u32 = $name::[<$field:upper _MASK>]; +const MASK : $storage = $name::[<$field:upper _MASK>];const SHIFT :u32 = $name::[<$field:upper_SHIFT >]; );let field = ((self.0 &MASK ) >>SHIFT );
@@ -274,9 +285,9 @@ pub(crate) fn $field(self) -> $res_type { )?#[inline(always)] pub(crate) fn [<set_ $field>](mut self, value: $to_type) -> Self { - const MASK: u32 = $name::[<$field:upper _MASK>]; + const MASK: $storage = $name::[<$field:upper _MASK>]; const SHIFT: u32 = $name::[<$field:upper _SHIFT>]; -let value = (u32::from ($prim_type::from (value)) <<SHIFT ) &MASK ; +let value = ($storage::from ($prim_type::from (value)) <<SHIFT ) &MASK ; self.0 = (self.0 & !MASK ) | value; self
drivers/gpu/nova-core/regs/macros.rs +8 -8
@@ -276,25 +276,25 @@ pub(crate) trait RegisterBase<T> {macro_rules! register {// Creates a register at a fixed offset of the MMIO space. ($name:ident @ $offset:literal $(, $comment:literal)? { $($fields:tt)* } ) => { - bitfield!(struct $name $(, $comment)? { $($fields)* } ); + bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } );register! (@io_fixed $name @ $offset); };// Creates an alias register of fixed offset register `alias` with its own fields. ($name:ident => $alias:ident $(, $comment:literal)? { $($fields:tt)* } ) => { - bitfield!(struct $name $(, $comment)? { $($fields)* } ); + bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } );register! (@io_fixed $name @ $alias::OFFSET ); };// Creates a register at a relative offset from a base address provider. ($name:ident @ $base:ty [ $offset:literal ] $(, $comment:literal)? { $($fields:tt)* } ) => { - bitfield!(struct $name $(, $comment)? { $($fields)* } ); + bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } );register! (@io_relative $name @ $base [ $offset ]); };// Creates an alias register of relative offset register `alias` with its own fields. ($name:ident => $base:ty [ $alias:ident ] $(, $comment:literal)? { $($fields:tt)* }) => { - bitfield!(struct $name $(, $comment)? { $($fields)* } ); + bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } );register! (@io_relative $name @ $base [ $alias::OFFSET ]); };
@@ -305,7 +305,7 @@ macro_rules! register { } ) => {static_assert! (::core::mem::size_of ::<u32 >() <= $stride); - bitfield!(struct $name $(, $comment)? { $($fields)* } ); + bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } );register! (@io_array $name @ $offset [ $size ; $stride ]); };
@@ -326,7 +326,7 @@ macro_rules! register { $(, $comment:literal)? { $($fields:tt)* } ) => {static_assert! (::core::mem::size_of ::<u32 >() <= $stride); - bitfield!(struct $name $(, $comment)? { $($fields)* } ); + bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } );register! (@io_relative_array $name @ $base [ $offset [ $size ; $stride ] ]); };
@@ -348,7 +348,7 @@ macro_rules! register { } ) => {static_assert! ($idx < $alias::SIZE ); - bitfield!(struct $name $(, $comment)? { $($fields)* } ); + bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } );register! (@io_relative $name @ $base [ $alias::OFFSET + $idx * $alias::STRIDE ] ); };
@@ -357,7 +357,7 @@ macro_rules! register {// to avoid it being interpreted in place of the relative register array alias rule. ($name:ident => $alias:ident [ $idx:expr ] $(, $comment:literal)? { $($fields:tt)* }) => {static_assert! ($idx < $alias::SIZE ); - bitfield!(struct $name $(, $comment)? { $($fields)* } ); + bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } );register! (@io_fixed $name @ $alias::OFFSET + $idx * $alias::STRIDE ); };
Signature · 1 line
2.34.1
PATCH v7 4/4 gpu: nova-core: bitfield: Add support for custom visiblity
In reply to Joel FernandesAdd support for custom visiblity to allow for users to control visibility
of the structure and helpers.
--- drivers/gpu/nova-core/bitfield.rs | 49 +++++++++++++++------------- drivers/gpu/nova-core/regs/macros.rs | 16 ++++----- 2 files changed, 34 insertions(+), 31 deletions(-)
drivers/gpu/nova-core/bitfield.rs +26 -23
@@ -60,7 +60,7 @@/// } /// /// bitfield! { -/// struct ControlReg(u32) { +/// pub struct ControlReg(u32) { /// 3:0 mode as u8 ?=> Mode; /// 7:7 state as bool => State; /// }
@@ -74,6 +74,9 @@/// struct's storage size. /// - Debug and Default implementations. /// +/// Note: Field accessors and setters inherit the same visibility as the struct itself. +/// In the example above, both `mode()` and `set_mode()` methods will be `pub`. +/// /// Fields are defined as follows: /// /// - `as <type>` simply returns the field value casted to <type>, typically `u32`, `u16`, `u8` or
@@ -84,21 +87,21 @@/// and returns the result. This is useful with fields for which not all values are valid. macro_rules! bitfield {// Main entry point - defines the bitfield struct with fields - (struct $name:ident($storage:ty) $(, $comment:literal)? { $($fields:tt)* }) => { -bitfield! (@core $name $storage $(, $comment)? { $($fields)* }); + ($vis:visstruct $name:ident($storage:ty) $(, $comment:literal)? { $($fields:tt)* }) => { +bitfield! (@core $vis $name $storage $(, $comment)? { $($fields)* }); };// All rules below are helpers. // Defines the wrapper `$name` type, as well as its relevant implementations (`Debug`, // `Default`, `BitOr`, and conversion to the value type) and field accessor methods. - (@core $name:ident $storage:ty $(, $comment:literal)? { $($fields:tt)* }) => { + (@core $vis:vis $name:ident $storage:ty $(, $comment:literal)? { $($fields:tt)* }) => { $(#[doc=$comment] )?#[repr(transparent)] #[derive( Clone , Copy )] -pub (crate )struct $name($storage); + $visstruct $name($storage);impl ::core::ops::BitOr for $name {type Output =Self ;
@@ -114,14 +117,14 @@ fn from(val: $name) -> $storage { } } -bitfield! (@fields_dispatcher $name $storage { $($fields)* }); +bitfield! (@fields_dispatcher $vis $name $storage { $($fields)* }); };// Captures the fields and passes them to all the implementers that require field information. // // Used to simplify the matching rules for implementers, so they don't need to match the entire // complex fields rule even though they only make use of part of it. - (@fields_dispatcher $name:ident $storage:ty { + (@fields_dispatcher $vis:vis $name:ident $storage:ty { $($hi:tt:$lo:tt $field:ident as $type:tt $(?=> $try_into_type:ty)? $(=> $into_type:ty)?
@@ -130,7 +133,7 @@ fn from(val: $name) -> $storage { )* } ) => { - bitfield!(@field_accessors $name $storage { + bitfield!(@field_accessors $vis $name $storage { $( $hi:$lo $field as $type $(?=> $try_into_type)?
@@ -145,7 +148,7 @@ fn from(val: $name) -> $storage {// Defines all the field getter/setter methods for `$name`. ( - @field_accessors $name:ident $storage:ty { + @field_accessors $vis:vis $name:ident $storage:ty { $($hi:tt:$lo:tt $field:ident as $type:tt $(?=> $try_into_type:ty)? $(=> $into_type:ty)?
@@ -161,7 +164,7 @@ fn from(val: $name) -> $storage {#[allow(dead_code)] impl $name { $( -bitfield! (@field_accessor $name $storage, $hi:$lo $fieldas $type +bitfield! (@field_accessor $vis $name $storage, $hi:$lo $fieldas $type $(?=> $try_into_type)? $(=> $into_type)? $(, $comment)?
@@ -195,11 +198,11 @@ impl $name {// Catches fields defined as `bool` and convert them into a boolean value. ( - @field_accessor $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as bool => $into_type:ty + @field_accessor $vis:vis $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as bool => $into_type:ty $(, $comment:literal)?; ) => {bitfield! ( - @leaf_accessor $name $storage, $hi:$lo $field + @leaf_accessor $vis $name $storage, $hi:$lo $field { |f| <$into_type>::from (if f !=0 {true }else {false }) }bool $into_type => $into_type $(, $comment)?; );
@@ -207,17 +210,17 @@ impl $name {// Shortcut for fields defined as `bool` without the `=>` syntax. ( - @field_accessor $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as bool $(, $comment:literal)?; + @field_accessor $vis:vis $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as bool $(, $comment:literal)?; ) => { -bitfield! (@field_accessor $name $storage, $hi:$lo $fieldas bool =>bool $(, $comment)?;); +bitfield! (@field_accessor $vis $name $storage, $hi:$lo $fieldas bool =>bool $(, $comment)?;); };// Catches the `?=>` syntax for non-boolean fields. ( - @field_accessor $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as $type:tt ?=> $try_into_type:ty + @field_accessor $vis:vis $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as $type:tt ?=> $try_into_type:ty $(, $comment:literal)?; ) => { -bitfield! (@leaf_accessor $name $storage, $hi:$lo $field +bitfield! (@leaf_accessor $vis $name $storage, $hi:$lo $field { |f| <$try_into_type>::try_from (fas $type ) } $type $try_into_type => ::core::result::Result < $try_into_type,
@@ -228,24 +231,24 @@ impl $name {// Catches the `=>` syntax for non-boolean fields. ( - @field_accessor $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as $type:tt => $into_type:ty + @field_accessor $vis:vis $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as $type:tt => $into_type:ty $(, $comment:literal)?; ) => { -bitfield! (@leaf_accessor $name $storage, $hi:$lo $field +bitfield! (@leaf_accessor $vis $name $storage, $hi:$lo $field { |f| <$into_type>::from (fas $type ) } $type $into_type => $into_type $(, $comment)?;); };// Shortcut for non-boolean fields defined without the `=>` or `?=>` syntax. ( - @field_accessor $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as $type:tt + @field_accessor $vis:vis $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident as $type:tt $(, $comment:literal)?; ) => { -bitfield! (@field_accessor $name $storage, $hi:$lo $fieldas $type => $type $(, $comment)?;); +bitfield! (@field_accessor $vis $name $storage, $hi:$lo $fieldas $type => $type $(, $comment)?;); };// Generates the accessor methods for a single field. ( - @leaf_accessor $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident + @leaf_accessor $vis:vis $name:ident $storage:ty, $hi:tt:$lo:tt $field:ident { $process:expr } $prim_type:tt $to_type:ty => $res_type:ty $(, $comment:literal)?; ) => { ::kernel::macros::paste!(
@@ -268,7 +271,7 @@ impl $name {#[doc=$comment] )?#[inline(always)] -pub (crate )fn $field(self) -> $res_type { + $vis fn $field(self) -> $res_type { ::kernel::macros::paste!(const MASK : $storage = $name::[<$field:upper _MASK>];const SHIFT :u32 = $name::[<$field:upper_SHIFT >];
@@ -284,7 +287,7 @@ pub(crate) fn $field(self) -> $res_type {#[doc=$comment] )?#[inline(always)] - pub(crate) fn [<set_ $field>](mut self, value: $to_type) -> Self { + $vis fn [<set_ $field>](mut self, value: $to_type) -> Self { const MASK: $storage = $name::[<$field:upper _MASK>]; const SHIFT: u32 = $name::[<$field:upper _SHIFT>]; let value = ($storage::from($prim_type::from(value)) << SHIFT) & MASK;
drivers/gpu/nova-core/regs/macros.rs +8 -8
@@ -276,25 +276,25 @@ pub(crate) trait RegisterBase<T> {macro_rules! register {// Creates a register at a fixed offset of the MMIO space. ($name:ident @ $offset:literal $(, $comment:literal)? { $($fields:tt)* } ) => { - bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } ); +bitfield! (pub (crate )struct $name(u32 ) $(, $comment)? { $($fields)* } );register! (@io_fixed $name @ $offset); };// Creates an alias register of fixed offset register `alias` with its own fields. ($name:ident => $alias:ident $(, $comment:literal)? { $($fields:tt)* } ) => { - bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } ); +bitfield! (pub (crate )struct $name(u32 ) $(, $comment)? { $($fields)* } );register! (@io_fixed $name @ $alias::OFFSET ); };// Creates a register at a relative offset from a base address provider. ($name:ident @ $base:ty [ $offset:literal ] $(, $comment:literal)? { $($fields:tt)* } ) => { - bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } ); +bitfield! (pub (crate )struct $name(u32 ) $(, $comment)? { $($fields)* } );register! (@io_relative $name @ $base [ $offset ]); };// Creates an alias register of relative offset register `alias` with its own fields. ($name:ident => $base:ty [ $alias:ident ] $(, $comment:literal)? { $($fields:tt)* }) => { - bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } ); +bitfield! (pub (crate )struct $name(u32 ) $(, $comment)? { $($fields)* } );register! (@io_relative $name @ $base [ $alias::OFFSET ]); };
@@ -305,7 +305,7 @@ macro_rules! register { } ) => {static_assert! (::core::mem::size_of ::<u32 >() <= $stride); - bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } ); +bitfield! (pub (crate )struct $name(u32 ) $(, $comment)? { $($fields)* } );register! (@io_array $name @ $offset [ $size ; $stride ]); };
@@ -326,7 +326,7 @@ macro_rules! register { $(, $comment:literal)? { $($fields:tt)* } ) => {static_assert! (::core::mem::size_of ::<u32 >() <= $stride); - bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } ); +bitfield! (pub (crate )struct $name(u32 ) $(, $comment)? { $($fields)* } );register! (@io_relative_array $name @ $base [ $offset [ $size ; $stride ] ]); };
@@ -348,7 +348,7 @@ macro_rules! register { } ) => {static_assert! ($idx < $alias::SIZE ); - bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } ); +bitfield! (pub (crate )struct $name(u32 ) $(, $comment)? { $($fields)* } );register! (@io_relative $name @ $base [ $alias::OFFSET + $idx * $alias::STRIDE ] ); };
@@ -357,7 +357,7 @@ macro_rules! register {// to avoid it being interpreted in place of the relative register array alias rule. ($name:ident => $alias:ident [ $idx:expr ] $(, $comment:literal)? { $($fields:tt)* }) => {static_assert! ($idx < $alias::SIZE ); - bitfield!(struct $name(u32) $(, $comment)? { $($fields)* } ); +bitfield! (pub (crate )struct $name(u32 ) $(, $comment)? { $($fields)* } );register! (@io_fixed $name @ $alias::OFFSET + $idx * $alias::STRIDE ); };
Signature · 1 line
2.34.1