RE: [PATCH 02/38] docs/system: Add hexagon CPU emulation

[<ltaylorsimpson@gmail.com>]

> -----Original Message-----
> From: Brian Cain <brian.cain@oss.qualcomm.com>
> Sent: Wednesday, March 5, 2025 2:13 PM
> To: ltaylorsimpson@gmail.com; qemu-devel@nongnu.org
> Cc: richard.henderson@linaro.org; philmd@linaro.org;
> quic_mathbern@quicinc.com; ale@rev.ng; anjo@rev.ng;
> quic_mliebel@quicinc.com; alex.bennee@linaro.org;
> quic_mburton@quicinc.com; sidneym@quicinc.com; 'Brian Cain'
> <bcain@quicinc.com>
> Subject: Re: [PATCH 02/38] docs/system: Add hexagon CPU emulation
> 
> 
> On 3/5/2025 1:36 PM, ltaylorsimpson@gmail.com wrote:
> >
> >> -----Original Message-----
> >> From: Brian Cain <brian.cain@oss.qualcomm.com>
> >> Sent: Friday, February 28, 2025 11:26 PM
> >> To: qemu-devel@nongnu.org
> >> Cc: brian.cain@oss.qualcomm.com; richard.henderson@linaro.org;
> >> philmd@linaro.org; quic_mathbern@quicinc.com; ale@rev.ng;
> >> anjo@rev.ng; quic_mliebel@quicinc.com; ltaylorsimpson@gmail.com;
> >> alex.bennee@linaro.org; quic_mburton@quicinc.com;
> >> sidneym@quicinc.com; Brian Cain <bcain@quicinc.com>
> >> Subject: [PATCH 02/38] docs/system: Add hexagon CPU emulation
> >>
> >> From: Brian Cain <bcain@quicinc.com>
> >>
> >> Signed-off-by: Brian Cain <brian.cain@oss.qualcomm.com>
> >> ---
> >>   docs/system/hexagon/emulation.rst | 16 ++++++++++++++++
> >>   docs/system/target-hexagon.rst    |  1 +
> >>   2 files changed, 17 insertions(+)
> >>   create mode 100644 docs/system/hexagon/emulation.rst
> > Add to MAINTAINERS?
> 
> 
> I will fix this.
> 
> 
> >> diff --git a/docs/system/hexagon/emulation.rst
> >> b/docs/system/hexagon/emulation.rst
> >> new file mode 100644
> >> index 0000000000..03a6092a12
> >> --- /dev/null
> >> +++ b/docs/system/hexagon/emulation.rst
> >> @@ -0,0 +1,16 @@
> >> +.. _Hexagon Emulation:
> >> +
> >> +Hexagon CPU architecture support
> >> +================================
> >> +
> >> +QEMU's TCG emulation includes support for v65, v66, v67, v68, v69,
> >> +v71,
> >> v73.
> >> +It also has support for the following architecture extensions:
> >> +
> >> +- HVX (Hexagon Vector eXtensions)
> >> +
> >> +For information on the specifics of the HVX extension, please refer
> >> +to the `Qualcomm Hexagon V69 HVX Programmer's Reference Manual
> >> +<https://docs.qualcomm.com/bundle/publicresource/80-N2040-
> >>
> 49_REV_AA_Qualcomm_Hexagon_V69_HVX_ProgrammerS_Reference_Ma
> >> nual.pdf>`_.
> > The target/hexagon/README file gives a link to the v73 version of the HVX
> PRM.  These should be consistent.
> 
> 
> The V79 PRM is newer -- I can update this to point to V79 and delete the one
> from the README, would that be acceptable?

Is v79 a typo?  I vote for pointing to the latest version that QEMU supports.

The README also has a link to the v73 scalar core document.

> 
> 
> > It would also be good to mention the README file in one of the files in docs
> as well as mentioning these files in the README.  Or is there a standard way
> the community handles this sort of thing?
> 
> 
> docs/system/hexagon/ is intended for public consumption by users (for
> example, at https://www.qemu.org/docs/master/ IIUC).  IMO the README
> reference (whose audience is QEMU developers) is not suitable there.
> However, I could make a reference from docs/devel/hexagon-sys.rst to the
> target/hexagon/README - sound good?

Agreed.  The README is for QEMU developers.

> 
> 
> >
> > Otherwise
> > Reviewed-by: Taylor Simpson <ltaylorsimpson@gmail.com>
> >