linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Huacai Chen <chenhuacai@gmail.com>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Huacai Chen <chenhuacai@loongson.cn>,
	Arnd Bergmann <arnd@arndb.de>, Andy Lutomirski <luto@kernel.org>,
	Thomas Gleixner <tglx@linutronix.de>,
	Peter Zijlstra <peterz@infradead.org>,
	Andrew Morton <akpm@linux-foundation.org>,
	David Airlie <airlied@linux.ie>, Jonathan Corbet <corbet@lwn.net>,
	Linus Torvalds <torvalds@linux-foundation.org>,
	linux-arch <linux-arch@vger.kernel.org>,
	"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
	LKML <linux-kernel@vger.kernel.org>,
	Xuefeng Li <lixuefeng@loongson.cn>,
	Yanteng Si <siyanteng@loongson.cn>, Guo Ren <guoren@kernel.org>,
	Xuerui Wang <kernel@xen0n.name>,
	Jiaxun Yang <jiaxun.yang@flygoat.com>,
	Stephen Rothwell <sfr@canb.auug.org.au>,
	WANG Xuerui <git@xen0n.name>
Subject: Re: [PATCH V14 03/24] Documentation: LoongArch: Add basic documentations
Date: Fri, 3 Jun 2022 13:27:00 +0800	[thread overview]
Message-ID: <CAAhV-H5Hi_gYvrO6DAGGA=OVExunCubNpDBdkRBxFxiP1APAKw@mail.gmail.com> (raw)
In-Reply-To: <YplnruNz++gABlU0@debian.me>

Hi, Bagas,

On Fri, Jun 3, 2022 at 9:45 AM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>
> On Thu, Jun 02, 2022 at 07:51:20PM +0800, Huacai Chen wrote:
> > +Legacy IRQ model
> > +================
> > +
> > +In this model, IPI (Inter-Processor Interrupt) and CPU Local Timer interrupt go
> > +to CPUINTC directly, CPU UARTS interrupts go to LIOINTC, while all other devices
> > +interrupts go to PCH-PIC/PCH-LPC/PCH-MSI and gathered by HTVECINTC, and then go
> > +to LIOINTC, and then CPUINTC.
> > +
> > + +---------------------------------------------+
> > + |::                                           |
> > + |                                             |
> > + |    +-----+     +---------+     +-------+    |
> > + |    | IPI | --> | CPUINTC | <-- | Timer |    |
> > + |    +-----+     +---------+     +-------+    |
> > + |                     ^                       |
> > + |                     |                       |
> > + |                +---------+     +-------+    |
> > + |                | LIOINTC | <-- | UARTs |    |
> > + |                +---------+     +-------+    |
> > + |                     ^                       |
> > + |                     |                       |
> > + |               +-----------+                 |
> > + |               | HTVECINTC |                 |
> > + |               +-----------+                 |
> > + |                ^         ^                  |
> > + |                |         |                  |
> > + |          +---------+ +---------+            |
> > + |          | PCH-PIC | | PCH-MSI |            |
> > + |          +---------+ +---------+            |
> > + |            ^     ^           ^              |
> > + |            |     |           |              |
> > + |    +---------+ +---------+ +---------+      |
> > + |    | PCH-LPC | | Devices | | Devices |      |
> > + |    +---------+ +---------+ +---------+      |
> > + |         ^                                   |
> > + |         |                                   |
> > + |    +---------+                              |
> > + |    | Devices |                              |
> > + |    +---------+                              |
> > + |                                             |
> > + |                                             |
> > + +---------------------------------------------+
> > +
> > +Extended IRQ model
> > +==================
> > +
> > +In this model, IPI (Inter-Processor Interrupt) and CPU Local Timer interrupt go
> > +to CPUINTC directly, CPU UARTS interrupts go to LIOINTC, while all other devices
> > +interrupts go to PCH-PIC/PCH-LPC/PCH-MSI and gathered by EIOINTC, and then go to
> > +to CPUINTC directly.
> > +
> > + +--------------------------------------------------------+
> > + |::                                                      |
> > + |                                                        |
> > + |         +-----+     +---------+     +-------+          |
> > + |         | IPI | --> | CPUINTC | <-- | Timer |          |
> > + |         +-----+     +---------+     +-------+          |
> > + |                      ^       ^                         |
> > + |                      |       |                         |
> > + |               +---------+ +---------+     +-------+    |
> > + |               | EIOINTC | | LIOINTC | <-- | UARTs |    |
> > + |               +---------+ +---------+     +-------+    |
> > + |                ^       ^                               |
> > + |                |       |                               |
> > + |         +---------+ +---------+                        |
> > + |         | PCH-PIC | | PCH-MSI |                        |
> > + |         +---------+ +---------+                        |
> > + |           ^     ^           ^                          |
> > + |           |     |           |                          |
> > + |   +---------+ +---------+ +---------+                  |
> > + |   | PCH-LPC | | Devices | | Devices |                  |
> > + |   +---------+ +---------+ +---------+                  |
> > + |        ^                                               |
> > + |        |                                               |
> > + |   +---------+                                          |
> > + |   | Devices |                                          |
> > + |   +---------+                                          |
> > + |                                                        |
> > + |                                                        |
> > + +--------------------------------------------------------+
> > +
>
> I think for consistency with other diagrams in Documentation/, just use
> literal code block, like:
>
> diff --git a/Documentation/loongarch/irq-chip-model.rst b/Documentation/loongarch/irq-chip-model.rst
> index 35c962991283ff..3cfd528021de05 100644
> --- a/Documentation/loongarch/irq-chip-model.rst
> +++ b/Documentation/loongarch/irq-chip-model.rst
> @@ -24,40 +24,38 @@ to CPUINTC directly, CPU UARTS interrupts go to LIOINTC, while all other devices
>  interrupts go to PCH-PIC/PCH-LPC/PCH-MSI and gathered by HTVECINTC, and then go
>  to LIOINTC, and then CPUINTC.
>
> - +---------------------------------------------+
> - |::                                           |
> - |                                             |
> - |    +-----+     +---------+     +-------+    |
> - |    | IPI | --> | CPUINTC | <-- | Timer |    |
> - |    +-----+     +---------+     +-------+    |
> - |                     ^                       |
> - |                     |                       |
> - |                +---------+     +-------+    |
> - |                | LIOINTC | <-- | UARTs |    |
> - |                +---------+     +-------+    |
> - |                     ^                       |
> - |                     |                       |
> - |               +-----------+                 |
> - |               | HTVECINTC |                 |
> - |               +-----------+                 |
> - |                ^         ^                  |
> - |                |         |                  |
> - |          +---------+ +---------+            |
> - |          | PCH-PIC | | PCH-MSI |            |
> - |          +---------+ +---------+            |
> - |            ^     ^           ^              |
> - |            |     |           |              |
> - |    +---------+ +---------+ +---------+      |
> - |    | PCH-LPC | | Devices | | Devices |      |
> - |    +---------+ +---------+ +---------+      |
> - |         ^                                   |
> - |         |                                   |
> - |    +---------+                              |
> - |    | Devices |                              |
> - |    +---------+                              |
> - |                                             |
> - |                                             |
> - +---------------------------------------------+
> + ::
> +
> +     +-----+     +---------+     +-------+
> +     | IPI | --> | CPUINTC | <-- | Timer |
> +     +-----+     +---------+     +-------+
> +                      ^
> +                      |
> +                 +---------+     +-------+
> +                 | LIOINTC | <-- | UARTs |
> +                 +---------+     +-------+
> +                      ^
> +                      |
> +                +-----------+
> +                | HTVECINTC |
> +                +-----------+
> +                 ^         ^
> +                 |         |
> +           +---------+ +---------+
> +           | PCH-PIC | | PCH-MSI |
> +           +---------+ +---------+
> +             ^     ^           ^
> +             |     |           |
> +     +---------+ +---------+ +---------+
> +     | PCH-LPC | | Devices | | Devices |
> +     +---------+ +---------+ +---------+
> +          ^
> +          |
> +     +---------+
> +     | Devices |
> +     +---------+
> +
> +
>
>  Extended IRQ model
>  ==================
> @@ -67,35 +65,33 @@ to CPUINTC directly, CPU UARTS interrupts go to LIOINTC, while all other devices
>  interrupts go to PCH-PIC/PCH-LPC/PCH-MSI and gathered by EIOINTC, and then go to
>  to CPUINTC directly.
>
> - +--------------------------------------------------------+
> - |::                                                      |
> - |                                                        |
> - |         +-----+     +---------+     +-------+          |
> - |         | IPI | --> | CPUINTC | <-- | Timer |          |
> - |         +-----+     +---------+     +-------+          |
> - |                      ^       ^                         |
> - |                      |       |                         |
> - |               +---------+ +---------+     +-------+    |
> - |               | EIOINTC | | LIOINTC | <-- | UARTs |    |
> - |               +---------+ +---------+     +-------+    |
> - |                ^       ^                               |
> - |                |       |                               |
> - |         +---------+ +---------+                        |
> - |         | PCH-PIC | | PCH-MSI |                        |
> - |         +---------+ +---------+                        |
> - |           ^     ^           ^                          |
> - |           |     |           |                          |
> - |   +---------+ +---------+ +---------+                  |
> - |   | PCH-LPC | | Devices | | Devices |                  |
> - |   +---------+ +---------+ +---------+                  |
> - |        ^                                               |
> - |        |                                               |
> - |   +---------+                                          |
> - |   | Devices |                                          |
> - |   +---------+                                          |
> - |                                                        |
> - |                                                        |
> - +--------------------------------------------------------+
> + ::
> +
> +          +-----+     +---------+     +-------+
> +          | IPI | --> | CPUINTC | <-- | Timer |
> +          +-----+     +---------+     +-------+
> +                       ^       ^
> +                       |       |
> +                +---------+ +---------+     +-------+
> +                | EIOINTC | | LIOINTC | <-- | UARTs |
> +                +---------+ +---------+     +-------+
> +                 ^       ^
> +                 |       |
> +          +---------+ +---------+
> +          | PCH-PIC | | PCH-MSI |
> +          +---------+ +---------+
> +            ^     ^           ^
> +            |     |           |
> +    +---------+ +---------+ +---------+
> +    | PCH-LPC | | Devices | | Devices |
> +    +---------+ +---------+ +---------+
> +         ^
> +         |
> +    +---------+
> +    | Devices |
> +    +---------+
> +
> +
>
>  ACPI-related definitions
>  ========================
>
> Otherwise, htmldocs builds successfully without any new warnings related
> to this patch series.
Thank you for your testing. In my environment (sphinx_2.4.4), with or
without the border both have no warnings. :)
And I think these are more pretty if we keep the border, especially
when formatted into PDF. How do you think?

Huacai
>
> Tested-by: Bagas Sanjaya <bagasdotme@gmail.com>
>
> --
> An old man doll... just what I always wanted! - Clara

  reply	other threads:[~2022-06-03  5:27 UTC|newest]

Thread overview: 40+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-02 11:51 [PATCH V14 00/24] arch: Add basic LoongArch support Huacai Chen
2022-06-02 11:51 ` [PATCH V14 01/24] irqchip: Adjust Kconfig for Loongson Huacai Chen
2022-06-02 13:25   ` Marc Zyngier
2022-06-02 16:34   ` Randy Dunlap
2022-06-03  5:04     ` Huacai Chen
2022-06-02 11:51 ` [PATCH V14 02/24] irqchip/loongson-liointc: Fix build error for LoongArch Huacai Chen
2022-06-02 13:24   ` Marc Zyngier
2022-06-02 11:51 ` [PATCH V14 03/24] Documentation: LoongArch: Add basic documentations Huacai Chen
2022-06-03  1:45   ` Bagas Sanjaya
2022-06-03  5:27     ` Huacai Chen [this message]
2022-06-03  7:35       ` Bagas Sanjaya
2022-06-03 13:01         ` Huacai Chen
2022-06-02 11:51 ` [PATCH V14 04/24] Documentation/zh_CN: Add basic LoongArch documentations Huacai Chen
2022-06-02 11:51 ` [PATCH V14 05/24] LoongArch: Add ELF-related definitions Huacai Chen
2022-06-02 11:51 ` [PATCH V14 06/24] LoongArch: Add writecombine support for drm Huacai Chen
2022-06-02 11:51 ` [PATCH V14 07/24] LoongArch: Add build infrastructure Huacai Chen
2022-06-02 11:51 ` [PATCH V14 08/24] LoongArch: Add CPU definition headers Huacai Chen
2022-06-02 11:51 ` [PATCH V14 09/24] LoongArch: Add atomic/locking headers Huacai Chen
2022-06-02 11:51 ` [PATCH V14 10/24] LoongArch: Add other common headers Huacai Chen
2022-06-02 11:51 ` [PATCH V14 11/24] LoongArch: Add boot and setup routines Huacai Chen
2022-06-02 14:09   ` Steps forward for the LoongArch UEFI bringup patch? (was: Re: [PATCH V14 11/24] LoongArch: Add boot and setup routines) WANG Xuerui
2022-06-02 16:14     ` Ard Biesheuvel
2022-06-02 16:29       ` Arnd Bergmann
2022-06-03  5:13         ` Huacai Chen
2022-06-03  9:32     ` Xi Ruoyao
2022-06-03  9:48       ` WANG Xuerui
2022-06-03 10:08         ` Arnd Bergmann
2022-06-02 11:51 ` [PATCH V14 12/24] LoongArch: Add exception/interrupt handling Huacai Chen
2022-06-02 11:51 ` [PATCH V14 13/24] LoongArch: Add process management Huacai Chen
2022-06-02 11:51 ` [PATCH V14 14/24] LoongArch: Add memory management Huacai Chen
2022-06-02 11:51 ` [PATCH V14 15/24] LoongArch: Add system call support Huacai Chen
2022-06-02 11:51 ` [PATCH V14 16/24] LoongArch: Add signal handling support Huacai Chen
2022-06-02 11:51 ` [PATCH V14 17/24] LoongArch: Add ELF and module support Huacai Chen
2022-06-02 11:51 ` [PATCH V14 18/24] LoongArch: Add misc common routines Huacai Chen
2022-06-02 11:51 ` [PATCH V14 19/24] LoongArch: Add some library functions Huacai Chen
2022-06-02 11:51 ` [PATCH V14 20/24] LoongArch: Add VDSO and VSYSCALL support Huacai Chen
2022-06-02 11:51 ` [PATCH V14 21/24] LoongArch: Add multi-processor (SMP) support Huacai Chen
2022-06-02 11:51 ` [PATCH V14 22/24] LoongArch: Add Non-Uniform Memory Access (NUMA) support Huacai Chen
2022-06-02 11:51 ` [PATCH V14 23/24] LoongArch: Add Loongson-3 default config file Huacai Chen
2022-06-02 11:51 ` [PATCH V14 24/24] MAINTAINERS: Add maintainer information for LoongArch Huacai Chen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAAhV-H5Hi_gYvrO6DAGGA=OVExunCubNpDBdkRBxFxiP1APAKw@mail.gmail.com' \
    --to=chenhuacai@gmail.com \
    --cc=airlied@linux.ie \
    --cc=akpm@linux-foundation.org \
    --cc=arnd@arndb.de \
    --cc=bagasdotme@gmail.com \
    --cc=chenhuacai@loongson.cn \
    --cc=corbet@lwn.net \
    --cc=git@xen0n.name \
    --cc=guoren@kernel.org \
    --cc=jiaxun.yang@flygoat.com \
    --cc=kernel@xen0n.name \
    --cc=linux-arch@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lixuefeng@loongson.cn \
    --cc=luto@kernel.org \
    --cc=peterz@infradead.org \
    --cc=sfr@canb.auug.org.au \
    --cc=siyanteng@loongson.cn \
    --cc=tglx@linutronix.de \
    --cc=torvalds@linux-foundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).