[4/4] docs/arm64: cpu-feature-registers: Documents missing visible fields

Message ID 20191003111211.483-5-julien.grall@arm.com
State New
Headers show
Series
  • arm64/cpufeature: Fix + doc update
Related show

Commit Message

Julien Grall Oct. 3, 2019, 11:12 a.m.
A couple of fields visible to userspace are not described in the
documentation. So update it.

Signed-off-by: Julien Grall <julien.grall@arm.com>

---
 Documentation/arm64/cpu-feature-registers.rst | 4 ++++
 1 file changed, 4 insertions(+)

-- 
2.11.0

Comments

Julien Grall Oct. 31, 2019, 4:48 p.m. | #1
Hi,

On 03/10/2019 12:12, Julien Grall wrote:
> A couple of fields visible to userspace are not described in the

> documentation. So update it.

> 

> Signed-off-by: Julien Grall <julien.grall@arm.com>

> ---

>   Documentation/arm64/cpu-feature-registers.rst | 4 ++++

>   1 file changed, 4 insertions(+)

> 

> diff --git a/Documentation/arm64/cpu-feature-registers.rst b/Documentation/arm64/cpu-feature-registers.rst

> index 2955287e9acc..ffcf4e2c71ef 100644

> --- a/Documentation/arm64/cpu-feature-registers.rst

> +++ b/Documentation/arm64/cpu-feature-registers.rst

> @@ -193,6 +193,10 @@ infrastructure:

>        +------------------------------+---------+---------+

>        | Name                         |  bits   | visible |

>        +------------------------------+---------+---------+

> +     | SB                           | [36-39] |    y    |

> +     +------------------------------+---------+---------+

> +     | FRINTTS                      | [32-35] |    y    |

> +     +------------------------------+---------+---------+


Will reported the bitfields were inconsistent (see [1]). Looking in more 
details, it seems that I messed up this patch when sending it (I honestly can't 
remember why I wrote like that :().

@Catalin, I saw you applied this patch to for-next/elf-hwcap-docs. Would you
mind to update the content of the patch? Or do you prefer a new version?

>        | GPI                          | [31-28] |    y    |

>        +------------------------------+---------+---------+

>        | GPA                          | [27-24] |    y    |

> 


Cheers,

[1] <20191029111517.GE11590@willie-the-truck>

-- 
Julien Grall
Catalin Marinas Oct. 31, 2019, 5:15 p.m. | #2
On Thu, Oct 31, 2019 at 04:48:18PM +0000, Julien Grall wrote:
> On 03/10/2019 12:12, Julien Grall wrote:

> > A couple of fields visible to userspace are not described in the

> > documentation. So update it.

> > 

> > Signed-off-by: Julien Grall <julien.grall@arm.com>

> > ---

> >   Documentation/arm64/cpu-feature-registers.rst | 4 ++++

> >   1 file changed, 4 insertions(+)

> > 

> > diff --git a/Documentation/arm64/cpu-feature-registers.rst b/Documentation/arm64/cpu-feature-registers.rst

> > index 2955287e9acc..ffcf4e2c71ef 100644

> > --- a/Documentation/arm64/cpu-feature-registers.rst

> > +++ b/Documentation/arm64/cpu-feature-registers.rst

> > @@ -193,6 +193,10 @@ infrastructure:

> >        +------------------------------+---------+---------+

> >        | Name                         |  bits   | visible |

> >        +------------------------------+---------+---------+

> > +     | SB                           | [36-39] |    y    |

> > +     +------------------------------+---------+---------+

> > +     | FRINTTS                      | [32-35] |    y    |

> > +     +------------------------------+---------+---------+

> 

> Will reported the bitfields were inconsistent (see [1]). Looking in more

> details, it seems that I messed up this patch when sending it (I honestly

> can't remember why I wrote like that :().

> 

> @Catalin, I saw you applied this patch to for-next/elf-hwcap-docs. Would you

> mind to update the content of the patch? Or do you prefer a new version?


Please send a fix on top of the elf-hwcap-docs branch. I'd prefer not to
rebase it.

-- 
Catalin

Patch

diff --git a/Documentation/arm64/cpu-feature-registers.rst b/Documentation/arm64/cpu-feature-registers.rst
index 2955287e9acc..ffcf4e2c71ef 100644
--- a/Documentation/arm64/cpu-feature-registers.rst
+++ b/Documentation/arm64/cpu-feature-registers.rst
@@ -193,6 +193,10 @@  infrastructure:
      +------------------------------+---------+---------+
      | Name                         |  bits   | visible |
      +------------------------------+---------+---------+
+     | SB                           | [36-39] |    y    |
+     +------------------------------+---------+---------+
+     | FRINTTS                      | [32-35] |    y    |
+     +------------------------------+---------+---------+
      | GPI                          | [31-28] |    y    |
      +------------------------------+---------+---------+
      | GPA                          | [27-24] |    y    |