[5.10.y-cip,42/61] ravb: update "undocumented" annotations

Message ID	20220110122331.24114-43-prabhakar.mahadev-lad.rj@bp.renesas.com (mailing list archive)
State	Accepted
Delegated to:	Pavel Machek
Headers	show Return-Path: <prabhakar.mahadev-lad.rj@bp.renesas.com> ip: 210.160.252.172, mailfrom: prabhakar.mahadev-lad.rj@bp.renesas.com) From: Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com> To: cip-dev@lists.cip-project.org, Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp>, Pavel Machek <pavel@denx.de> Cc: Biju Das <biju.das.jz@bp.renesas.com> Subject: [PATCH 5.10.y-cip 42/61] ravb: update "undocumented" annotations Date: Mon, 10 Jan 2022 12:23:12 +0000 Message-Id: <20220110122331.24114-43-prabhakar.mahadev-lad.rj@bp.renesas.com> In-Reply-To: <20220110122331.24114-1-prabhakar.mahadev-lad.rj@bp.renesas.com> References: <20220110122331.24114-1-prabhakar.mahadev-lad.rj@bp.renesas.com>
Series	Add Ethernet support to RZ/G2L \| expand [5.10.y-cip,00/61] Add Ethernet support to RZ/G2L [5.10.y-cip,01/61] dt-bindings: net: renesas,etheravb: Add additional clocks [5.10.y-cip,02/61] dt-bindings: net: renesas,etheravb: Fix optional second clock name [5.10.y-cip,03/61] dt-bindings: net: renesas,etheravb: Document Gigabit Ethernet IP [5.10.y-cip,04/61] dt-bindings: net: renesas,etheravb: Drop "int_" prefix and "_n" suffix from inte… [5.10.y-cip,05/61] net: ethernet: ravb: Enable optional refclk [5.10.y-cip,06/61] net: ethernet: ravb: Fix release of refclk [5.10.y-cip,07/61] net: ethernet: ravb: Use devm_platform_get_and_ioremap_resource() [5.10.y-cip,08/61] ravb: Fix a typo in comment [5.10.y-cip,09/61] ravb: Remove checks for unsupported internal delay modes [5.10.y-cip,10/61] ravb: Use unsigned int for num_tx_desc variable in struct ravb_private [5.10.y-cip,11/61] ravb: Add struct ravb_hw_info to driver data [5.10.y-cip,12/61] ravb: Add aligned_tx to struct ravb_hw_info [5.10.y-cip,13/61] ravb: Add max_rx_len to struct ravb_hw_info [5.10.y-cip,14/61] ravb: Add stats_len to struct ravb_hw_info [5.10.y-cip,15/61] ravb: Add gstrings_stats and gstrings_size to struct ravb_hw_info [5.10.y-cip,16/61] ravb: Add net_features and net_hw_features to struct ravb_hw_info [5.10.y-cip,17/61] ravb: Add internal delay hw feature to struct ravb_hw_info [5.10.y-cip,18/61] ravb: Add tx_counters to struct ravb_hw_info [5.10.y-cip,19/61] ravb: Remove the macros NUM_TX_DESC_GEN[23] [5.10.y-cip,20/61] ravb: Add multi_irq to struct ravb_hw_info [5.10.y-cip,21/61] ravb: Add no_ptp_cfg_active to struct ravb_hw_info [5.10.y-cip,22/61] ravb: Add ptp_cfg_active to struct ravb_hw_info [5.10.y-cip,23/61] ravb: Factorise ravb_ring_free function [5.10.y-cip,24/61] ravb: Factorise ravb_ring_format function [5.10.y-cip,25/61] ravb: Factorise ravb_ring_init function [5.10.y-cip,26/61] ravb: Factorise ravb_rx function [5.10.y-cip,27/61] ravb: Factorise ravb_adjust_link function [5.10.y-cip,28/61] ravb: Factorise ravb_set_features [5.10.y-cip,29/61] ravb: Factorise ravb_dmac_init function [5.10.y-cip,30/61] ravb: Factorise ravb_emac_init function [5.10.y-cip,31/61] ravb: Add reset support [5.10.y-cip,32/61] ravb: Rename "ravb_set_features_rx_csum" function to "ravb_set_features_rcar" [5.10.y-cip,33/61] ravb: Rename "no_ptp_cfg_active" and "ptp_cfg_active" variables [5.10.y-cip,34/61] ravb: Add nc_queue to struct ravb_hw_info [5.10.y-cip,35/61] ravb: Add support for RZ/G2L SoC [5.10.y-cip,36/61] ravb: Initialize GbEthernet DMAC [5.10.y-cip,37/61] ravb: remove APSR_DM [5.10.y-cip,38/61] ravb: Exclude gPTP feature support for RZ/G2L [5.10.y-cip,39/61] ravb: Add tsrq to struct ravb_hw_info [5.10.y-cip,40/61] ravb: Add magic_pkt to struct ravb_hw_info [5.10.y-cip,41/61] ravb: Add half_duplex to struct ravb_hw_info [5.10.y-cip,42/61] ravb: update "undocumented" annotations [5.10.y-cip,43/61] ravb: Remove extra TAB [5.10.y-cip,44/61] ravb: Initialize GbEthernet E-MAC [5.10.y-cip,45/61] ravb: Add rx_max_buf_size to struct ravb_hw_info [5.10.y-cip,46/61] ravb: Use ALIGN macro for max_rx_len [5.10.y-cip,47/61] ravb: Fillup ravb_alloc_rx_desc_gbeth() stub [5.10.y-cip,48/61] ravb: Fillup ravb_rx_ring_free_gbeth() stub [5.10.y-cip,49/61] ravb: Fillup ravb_rx_ring_format_gbeth() stub [5.10.y-cip,50/61] ravb: Fillup ravb_rx_gbeth() stub [5.10.y-cip,51/61] ravb: Add carrier_counters to struct ravb_hw_info [5.10.y-cip,52/61] ravb: Add support to retrieve stats for GbEthernet [5.10.y-cip,53/61] ravb: Rename "tsrq" variable [5.10.y-cip,54/61] ravb: Optimize ravb_emac_init_gbeth function [5.10.y-cip,55/61] ravb: Rename "nc_queue" feature bit [5.10.y-cip,56/61] ravb: Update ravb_emac_init_gbeth() [5.10.y-cip,57/61] ravb: Fix typo AVB->DMAC [5.10.y-cip,58/61] clk: renesas: r9a07g044: Add ethernet clock sources [5.10.y-cip,59/61] clk: renesas: r9a07g044: Add GbEthernet clock/reset [5.10.y-cip,60/61] arm64: dts: renesas: r9a07g044: Add GbEthernet nodes [5.10.y-cip,61/61] arm64: dts: renesas: rzg2l-smarc-som: Enable Ethernet

Message ID

20220110122331.24114-43-prabhakar.mahadev-lad.rj@bp.renesas.com (mailing list archive)

State

Accepted

Delegated to:

Pavel Machek

Headers

From: Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com>
To: cip-dev@lists.cip-project.org,
	Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp>,
	Pavel Machek <pavel@denx.de>
Cc: Biju Das <biju.das.jz@bp.renesas.com>
Subject: [PATCH 5.10.y-cip 42/61] ravb: update "undocumented" annotations
Date: Mon, 10 Jan 2022 12:23:12 +0000
Message-Id: <20220110122331.24114-43-prabhakar.mahadev-lad.rj@bp.renesas.com>
In-Reply-To: <20220110122331.24114-1-prabhakar.mahadev-lad.rj@bp.renesas.com>
References: <20220110122331.24114-1-prabhakar.mahadev-lad.rj@bp.renesas.com>

Series

Add Ethernet support to RZ/G2L | expand

Commit Message

Lad Prabhakar Jan. 10, 2022, 12:23 p.m. UTC

From: Sergey Shtylyov <s.shtylyov@omprussia.ru>

commit 360a794323a8c29addae398fcaca40d8859c0743 upstream.

The "undocumented" annotations in the EtherAVB driver were done against
the R-Car gen2 manuals; most of these registers/bits were then described
in the R-Car gen3 manuals -- reflect  this fact in the annotations (note
that ECSIPR.LCHNGIP was documented in the recent R-Car gen2 manual)...

Signed-off-by: Sergey Shtylyov <s.shtylyov@omprussia.ru>
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Signed-off-by: Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com>
---
 drivers/net/ethernet/renesas/ravb.h | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/drivers/net/ethernet/renesas/ravb.h b/drivers/net/ethernet/renesas/ravb.h
index 00f234acb274..887e229b5fbd 100644
--- a/drivers/net/ethernet/renesas/ravb.h
+++ b/drivers/net/ethernet/renesas/ravb.h
@@ -166,7 +166,7 @@  enum ravb_reg {
 	GTO2	= 0x03A8,
 	GIC	= 0x03AC,
 	GIS	= 0x03B0,
-	GCPT	= 0x03B4,	/* Undocumented? */
+	GCPT	= 0x03B4,	/* Documented for R-Car Gen3 only */
 	GCT0	= 0x03B8,
 	GCT1	= 0x03BC,
 	GCT2	= 0x03C0,
@@ -226,7 +226,7 @@  enum CSR_BIT {
 	CSR_OPS_RESET	= 0x00000001,
 	CSR_OPS_CONFIG	= 0x00000002,
 	CSR_OPS_OPERATION = 0x00000004,
-	CSR_OPS_STANDBY	= 0x00000008,	/* Undocumented? */
+	CSR_OPS_STANDBY	= 0x00000008,	/* Documented for R-Car Gen3 only */
 	CSR_DTS		= 0x00000100,
 	CSR_TPO0	= 0x00010000,
 	CSR_TPO1	= 0x00020000,
@@ -530,16 +530,16 @@  enum RIS2_BIT {
 
 /* TIC */
 enum TIC_BIT {
-	TIC_FTE0	= 0x00000001,	/* Undocumented? */
-	TIC_FTE1	= 0x00000002,	/* Undocumented? */
+	TIC_FTE0	= 0x00000001,	/* Documented for R-Car Gen3 only */
+	TIC_FTE1	= 0x00000002,	/* Documented for R-Car Gen3 only */
 	TIC_TFUE	= 0x00000100,
 	TIC_TFWE	= 0x00000200,
 };
 
 /* TIS */
 enum TIS_BIT {
-	TIS_FTF0	= 0x00000001,	/* Undocumented? */
-	TIS_FTF1	= 0x00000002,	/* Undocumented? */
+	TIS_FTF0	= 0x00000001,	/* Documented for R-Car Gen3 only */
+	TIS_FTF1	= 0x00000002,	/* Documented for R-Car Gen3 only */
 	TIS_TFUF	= 0x00000100,
 	TIS_TFWF	= 0x00000200,
 	TIS_RESERVED	= (GENMASK(31, 20) | GENMASK(15, 12) | GENMASK(7, 4))
@@ -547,8 +547,8 @@  enum TIS_BIT {
 
 /* ISS */
 enum ISS_BIT {
-	ISS_FRS		= 0x00000001,	/* Undocumented? */
-	ISS_FTS		= 0x00000004,	/* Undocumented? */
+	ISS_FRS		= 0x00000001,	/* Documented for R-Car Gen3 only */
+	ISS_FTS		= 0x00000004,	/* Documented for R-Car Gen3 only */
 	ISS_ES		= 0x00000040,
 	ISS_MS		= 0x00000080,
 	ISS_TFUS	= 0x00000100,
@@ -608,13 +608,13 @@  enum GTI_BIT {
 
 /* GIC */
 enum GIC_BIT {
-	GIC_PTCE	= 0x00000001,	/* Undocumented? */
+	GIC_PTCE	= 0x00000001,	/* Documented for R-Car Gen3 only */
 	GIC_PTME	= 0x00000004,
 };
 
 /* GIS */
 enum GIS_BIT {
-	GIS_PTCF	= 0x00000001,	/* Undocumented? */
+	GIS_PTCF	= 0x00000001,	/* Documented for R-Car Gen3 only */
 	GIS_PTMF	= 0x00000004,
 	GIS_RESERVED	= GENMASK(15, 10),
 };
@@ -808,10 +808,10 @@  enum ECMR_BIT {
 	ECMR_TE		= 0x00000020,
 	ECMR_RE		= 0x00000040,
 	ECMR_MPDE	= 0x00000200,
-	ECMR_TXF	= 0x00010000,	/* Undocumented? */
+	ECMR_TXF	= 0x00010000,	/* Documented for R-Car Gen3 only */
 	ECMR_RXF	= 0x00020000,
 	ECMR_PFR	= 0x00040000,
-	ECMR_ZPF	= 0x00080000,	/* Undocumented? */
+	ECMR_ZPF	= 0x00080000,	/* Documented for R-Car Gen3 only */
 	ECMR_RZPF	= 0x00100000,
 	ECMR_DPAD	= 0x00200000,
 	ECMR_RCSC	= 0x00800000,
@@ -830,7 +830,7 @@  enum ECSR_BIT {
 enum ECSIPR_BIT {
 	ECSIPR_ICDIP	= 0x00000001,
 	ECSIPR_MPDIP	= 0x00000002,
-	ECSIPR_LCHNGIP	= 0x00000004,	/* Undocumented? */
+	ECSIPR_LCHNGIP	= 0x00000004,
 };
 
 /* PIR */

[5.10.y-cip,42/61] ravb: update "undocumented" annotations

Commit Message

Patch