diff mbox series

[net-next,v1] net: stmmac: Move extern declarations from common.h to hwif.h

Message ID 20241207070248.4049877-1-0x1207@gmail.com (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series [net-next,v1] net: stmmac: Move extern declarations from common.h to hwif.h | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers warning 1 maintainers not CCed: richardcochran@gmail.com
netdev/build_clang success Errors and warnings before: 0 this patch: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 11 this patch: 11
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 46 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest pending net-next-2024-12-07--09-00 (tests: 0)

Commit Message

Furong Xu Dec. 7, 2024, 7:02 a.m. UTC
These extern declarations are referenced in hwif.c only.
Move them to hwif.h just like the other extern declarations.

Compile tested only.
No functional change intended.

Signed-off-by: Furong Xu <0x1207@gmail.com>
---
 drivers/net/ethernet/stmicro/stmmac/common.h | 14 --------------
 drivers/net/ethernet/stmicro/stmmac/hwif.h   | 14 ++++++++++++++
 2 files changed, 14 insertions(+), 14 deletions(-)

Comments

Russell King (Oracle) Dec. 7, 2024, 10:13 a.m. UTC | #1
On Sat, Dec 07, 2024 at 03:02:48PM +0800, Furong Xu wrote:
> These extern declarations are referenced in hwif.c only.
> Move them to hwif.h just like the other extern declarations.

We normally have declarations in a header file that corresponds to their
definition, rather than where they are used.

> Compile tested only.
> No functional change intended.
> 
> Signed-off-by: Furong Xu <0x1207@gmail.com>
> ---
>  drivers/net/ethernet/stmicro/stmmac/common.h | 14 --------------
>  drivers/net/ethernet/stmicro/stmmac/hwif.h   | 14 ++++++++++++++
>  2 files changed, 14 insertions(+), 14 deletions(-)
> 
> diff --git a/drivers/net/ethernet/stmicro/stmmac/common.h b/drivers/net/ethernet/stmicro/stmmac/common.h
> index 1367fa5c9b8e..fbcf07d201cf 100644
> --- a/drivers/net/ethernet/stmicro/stmmac/common.h
> +++ b/drivers/net/ethernet/stmicro/stmmac/common.h
> @@ -543,18 +543,8 @@ struct dma_features {
>  #define STMMAC_VLAN_INSERT	0x2
>  #define STMMAC_VLAN_REPLACE	0x3
>  
> -extern const struct stmmac_desc_ops enh_desc_ops;

Defined in enh_desc.c, but no header for it, so either common.h or
hwif.h seems sensible.

> -extern const struct stmmac_desc_ops ndesc_ops;

Defined in norm_desc.c, same situation as previous one.

> -
>  struct mac_device_info;
>  
> -extern const struct stmmac_hwtimestamp stmmac_ptp;

Defined in stmmac_hwtstamp.c, same as above.

> -extern const struct stmmac_hwtimestamp dwmac1000_ptp;

Ditto.

> -extern const struct stmmac_mode_ops dwmac4_ring_mode_ops;

Defined in dwmac4_descs.c, maybe dwmac4_descs.h or dwmac4.h would make
more sense than hwif.c ?

> -
> -extern const struct ptp_clock_info stmmac_ptp_clock_ops;

Defined in stmmac_ptp.c, and there is stmmac_ptp.h which contains a
number of function declarations, so maybe moving that there would
make more sense?

> -extern const struct ptp_clock_info dwmac1000_ptp_clock_ops;

Same as stmmac_ptp_clock_ops.

> -
>  struct mac_link {
>  	u32 caps;
>  	u32 speed_mask;
> @@ -641,8 +631,4 @@ void stmmac_dwmac4_set_mac(void __iomem *ioaddr, bool enable);
>  
>  void dwmac_dma_flush_tx_fifo(void __iomem *ioaddr);
>  
> -extern const struct stmmac_mode_ops ring_mode_ops;

Defined in ring_mode.c, same as enh_desc_ops.

> -extern const struct stmmac_mode_ops chain_mode_ops;

Defined in chain_mode.c, same as enh_desc_ops.

> -extern const struct stmmac_desc_ops dwmac4_desc_ops;

Defined in dwmac4_descs.c, similar situation to dwmac4_ring_mode_ops
above.


So I think rather than bulk moving these to hwif.h, where some of them
remain out of place, maybe placing some in a more appropriate header
would be better.
Furong Xu Dec. 7, 2024, 10:39 a.m. UTC | #2
On Sat, 7 Dec 2024 10:13:14 +0000, "Russell King (Oracle)" <linux@armlinux.org.uk> wrote:

> 
> So I think rather than bulk moving these to hwif.h, where some of them
> remain out of place, maybe placing some in a more appropriate header
> would be better.
> 

Totally agree.
I am going to rework this patch into a bigger one.

pw-bot: changes-requested
diff mbox series

Patch

diff --git a/drivers/net/ethernet/stmicro/stmmac/common.h b/drivers/net/ethernet/stmicro/stmmac/common.h
index 1367fa5c9b8e..fbcf07d201cf 100644
--- a/drivers/net/ethernet/stmicro/stmmac/common.h
+++ b/drivers/net/ethernet/stmicro/stmmac/common.h
@@ -543,18 +543,8 @@  struct dma_features {
 #define STMMAC_VLAN_INSERT	0x2
 #define STMMAC_VLAN_REPLACE	0x3
 
-extern const struct stmmac_desc_ops enh_desc_ops;
-extern const struct stmmac_desc_ops ndesc_ops;
-
 struct mac_device_info;
 
-extern const struct stmmac_hwtimestamp stmmac_ptp;
-extern const struct stmmac_hwtimestamp dwmac1000_ptp;
-extern const struct stmmac_mode_ops dwmac4_ring_mode_ops;
-
-extern const struct ptp_clock_info stmmac_ptp_clock_ops;
-extern const struct ptp_clock_info dwmac1000_ptp_clock_ops;
-
 struct mac_link {
 	u32 caps;
 	u32 speed_mask;
@@ -641,8 +631,4 @@  void stmmac_dwmac4_set_mac(void __iomem *ioaddr, bool enable);
 
 void dwmac_dma_flush_tx_fifo(void __iomem *ioaddr);
 
-extern const struct stmmac_mode_ops ring_mode_ops;
-extern const struct stmmac_mode_ops chain_mode_ops;
-extern const struct stmmac_desc_ops dwmac4_desc_ops;
-
 #endif /* __COMMON_H__ */
diff --git a/drivers/net/ethernet/stmicro/stmmac/hwif.h b/drivers/net/ethernet/stmicro/stmmac/hwif.h
index 64f8ed67dcc4..58a962e0b768 100644
--- a/drivers/net/ethernet/stmicro/stmmac/hwif.h
+++ b/drivers/net/ethernet/stmicro/stmmac/hwif.h
@@ -665,6 +665,20 @@  struct stmmac_regs_off {
 	u32 est_off;
 };
 
+extern const struct stmmac_desc_ops ndesc_ops;
+extern const struct stmmac_desc_ops enh_desc_ops;
+extern const struct stmmac_desc_ops dwmac4_desc_ops;
+
+extern const struct stmmac_hwtimestamp stmmac_ptp;
+extern const struct stmmac_hwtimestamp dwmac1000_ptp;
+
+extern const struct ptp_clock_info stmmac_ptp_clock_ops;
+extern const struct ptp_clock_info dwmac1000_ptp_clock_ops;
+
+extern const struct stmmac_mode_ops ring_mode_ops;
+extern const struct stmmac_mode_ops chain_mode_ops;
+extern const struct stmmac_mode_ops dwmac4_ring_mode_ops;
+
 extern const struct stmmac_ops dwmac100_ops;
 extern const struct stmmac_dma_ops dwmac100_dma_ops;
 extern const struct stmmac_ops dwmac1000_ops;