gpu: nova-core: register: fix documentation and indentation

Fix a few documentation inconsistencies, and harmonize indentation where
possible.

Reviewed-by: Daniel Almeida <daniel.almeida@collabora.com>
Reviewed-by: Lyude Paul <lyude@redhat.com>
Link: https://lore.kernel.org/r/20250718-nova-regs-v2-8-7b6a762aa1cd@nvidia.com
Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>
This commit is contained in:
Alexandre Courbot 2025-07-18 16:26:13 +09:00
parent 036c5fa250
commit e40d2b2616

View File

@ -87,44 +87,28 @@
/// providing its own `completed` field.
macro_rules! register {
// Creates a register at a fixed offset of the MMIO space.
(
$name:ident @ $offset:literal $(, $comment:literal)? {
$($fields:tt)*
}
) => {
($name:ident @ $offset:literal $(, $comment:literal)? { $($fields:tt)* } ) => {
register!(@common $name $(, $comment)?);
register!(@field_accessors $name { $($fields)* });
register!(@io $name @ $offset);
};
// Creates a alias register of fixed offset register `alias` with its own fields.
(
$name:ident => $alias:ident $(, $comment:literal)? {
$($fields:tt)*
}
) => {
// Creates an alias register of fixed offset register `alias` with its own fields.
($name:ident => $alias:ident $(, $comment:literal)? { $($fields:tt)* } ) => {
register!(@common $name $(, $comment)?);
register!(@field_accessors $name { $($fields)* });
register!(@io $name @ $alias::OFFSET);
};
// Creates a register at a relative offset from a base address.
(
$name:ident @ + $offset:literal $(, $comment:literal)? {
$($fields:tt)*
}
) => {
($name:ident @ + $offset:literal $(, $comment:literal)? { $($fields:tt)* } ) => {
register!(@common $name $(, $comment)?);
register!(@field_accessors $name { $($fields)* });
register!(@io $name @ + $offset);
};
// Creates a alias register of relative offset register `alias` with its own fields.
(
$name:ident => + $alias:ident $(, $comment:literal)? {
$($fields:tt)*
}
) => {
// Creates an alias register of relative offset register `alias` with its own fields.
($name:ident => + $alias:ident $(, $comment:literal)? { $($fields:tt)* } ) => {
register!(@common $name $(, $comment)?);
register!(@field_accessors $name { $($fields)* });
register!(@io $name @ + $alias::OFFSET);
@ -259,7 +243,7 @@ impl $name {
{ |f| <$into_type>::from(f as $type) } $into_type => $into_type $(, $comment)?;);
};
// Shortcut for fields defined as non-`bool` without the `=>` or `?=>` syntax.
// Shortcut for non-boolean fields defined without the `=>` or `?=>` syntax.
(
@field_accessor $name:ident $hi:tt:$lo:tt $field:ident as $type:tt
$(, $comment:literal)?;
@ -310,7 +294,7 @@ pub(crate) fn [<set_ $field>](mut self, value: $to_type) -> Self {
);
};
// Creates the IO accessors for a fixed offset register.
// Generates the IO accessors for a fixed offset register.
(@io $name:ident @ $offset:expr) => {
#[allow(dead_code)]
impl $name {
@ -344,7 +328,7 @@ pub(crate) fn alter<const SIZE: usize, T, F>(
}
};
// Create the IO accessors for a relative offset register.
// Generates the IO accessors for a relative offset register.
(@io $name:ident @ + $offset:literal) => {
#[allow(dead_code)]
impl $name {