Re: [PATCH net-next v3 02/14] docs: networking: Add PPE driver documentation for Qualcomm IPQ9574 SoC

[Bagas Sanjaya <bagasdotme@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 1922 bytes --]

On Sun, Feb 09, 2025 at 10:29:36PM +0800, Luo Jie wrote:
> +The Ethernet functionality in the PPE (Packet Process Engine) is comprised of three
> +components: the switch core, port wrapper and Ethernet DMA.
> +
> +The Switch core in the IPQ9574 PPE has maximum of 6 front panel ports and two FIFO
> +interfaces. One of the two FIFO interfaces is used for Ethernet port to host CPU
> +communication using Ethernet DMA. The other is used communicating to the EIP engine
                                    "The other one is used ..."
> +which is used for IPsec offload. On the IPQ9574, the PPE includes 6 GMAC/XGMACs that
> +can be connected with external Ethernet PHY. Switch core also includes BM (Buffer
> +Management), QM (Queue Management) and SCH (Scheduler) modules for supporting the
> +packet processing.
> +
> <snipped>...
> +The PPE driver files in drivers/net/ethernet/qualcomm/ppe/ are listed as below:
> +
> +- Makefile
> +- ppe.c
> +- ppe.h
> +- ppe_config.c
> +- ppe_config.h
> +- ppe_debugfs.c
> +- ppe_debugfs.h
> +- ppe_regs.h

If somehow new source files were added, should the list above be updated to
keep up?

> +Enabling the Driver
> +===================
> +
> +The driver is located in the menu structure at:
> +
> +  -> Device Drivers
> +    -> Network device support (NETDEVICES [=y])
> +      -> Ethernet driver support
> +        -> Qualcomm devices
> +          -> Qualcomm Technologies, Inc. PPE Ethernet support

Literal code block should format above nicer, but plain paragraph is fine.

> +
> +If this driver is built as a module, we can use below commands to install and remove it:
> +
> +- insmod qcom-ppe.ko
> +- rmmod qcom-ppe.ko

"If the driver is built as a module, the module will be called qcom-ppe."
(I assume that readers know how to insert/remove modules).

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]