[net-next,0/7] net: ipa: header hygiene

Message

Alex Elder April 16, 2024, 11:10 p.m. UTC

The end result of this series is that the list of files included in
every IPA source file will be maintained in sorted order.  This
imposes some consistency that was previously not possible.

If an IPA header file requires a symbol or type declared in another
header, that other header must be included.  E.g., if bool or u32
type is used in a function declaration in an IPA header file, the
IPA header must include <linux/types.h>.

If a type used is just a struct or union *pointer* or enum type (and
no members within these types are needed), then these types only need
to be *declared* within the header that uses it.

This is sufficient, but in addition, this series removes includes of
files that aren't necessary, as well as unneeded type declarations.

					-Alex

Alex Elder (7):
  net: ipa: include some standard header files
  net: ipa: remove unneeded standard includes
  net: ipa: include "ipa_interrupt.h" where needed
  net: ipa: add some needed struct declarations
  net: ipa: eliminate unneeded struct declarations
  net: ipa: more include file cleanup
  net: ipa: sort all includes

 drivers/net/ipa/data/ipa_data-v3.1.c   |  5 +++--
 drivers/net/ipa/data/ipa_data-v3.5.1.c |  5 +++--
 drivers/net/ipa/data/ipa_data-v4.11.c  |  5 +++--
 drivers/net/ipa/data/ipa_data-v4.2.c   |  5 +++--
 drivers/net/ipa/data/ipa_data-v4.5.c   |  5 +++--
 drivers/net/ipa/data/ipa_data-v4.7.c   |  5 +++--
 drivers/net/ipa/data/ipa_data-v4.9.c   |  5 +++--
 drivers/net/ipa/data/ipa_data-v5.0.c   |  5 +++--
 drivers/net/ipa/data/ipa_data-v5.5.c   |  5 +++--
 drivers/net/ipa/gsi.c                  | 18 ++++++++---------
 drivers/net/ipa/gsi.h                  | 10 +++-------
 drivers/net/ipa/gsi_private.h          |  7 ++++---
 drivers/net/ipa/gsi_reg.c              |  6 +++---
 drivers/net/ipa/gsi_trans.c            | 12 ++++++------
 drivers/net/ipa/gsi_trans.h            |  9 ++++-----
 drivers/net/ipa/ipa.h                  | 15 +++++---------
 drivers/net/ipa/ipa_cmd.c              | 13 +++++++------
 drivers/net/ipa/ipa_cmd.h              | 10 +++-------
 drivers/net/ipa/ipa_data.h             |  4 ++--
 drivers/net/ipa/ipa_endpoint.c         | 19 ++++++++++--------
 drivers/net/ipa/ipa_endpoint.h         |  4 ++--
 drivers/net/ipa/ipa_gsi.c              |  7 ++++---
 drivers/net/ipa/ipa_interrupt.c        | 10 +++++-----
 drivers/net/ipa/ipa_interrupt.h        |  6 ++++--
 drivers/net/ipa/ipa_main.c             | 27 +++++++++++++-------------
 drivers/net/ipa/ipa_mem.c              | 15 +++++++-------
 drivers/net/ipa/ipa_mem.h              |  4 +++-
 drivers/net/ipa/ipa_modem.c            | 14 ++++++-------
 drivers/net/ipa/ipa_modem.h            |  5 +++--
 drivers/net/ipa/ipa_power.c            |  8 ++++----
 drivers/net/ipa/ipa_power.h            |  5 +++--
 drivers/net/ipa/ipa_qmi.c              | 10 +++-------
 drivers/net/ipa/ipa_qmi.h              |  4 +++-
 drivers/net/ipa/ipa_qmi_msg.c          |  3 ++-
 drivers/net/ipa/ipa_qmi_msg.h          |  3 ++-
 drivers/net/ipa/ipa_reg.c              |  4 ++--
 drivers/net/ipa/ipa_reg.h              |  6 +-----
 drivers/net/ipa/ipa_resource.c         |  3 +--
 drivers/net/ipa/ipa_smp2p.c            | 10 +++++-----
 drivers/net/ipa/ipa_sysfs.c            |  7 +++----
 drivers/net/ipa/ipa_sysfs.h            |  4 +---
 drivers/net/ipa/ipa_table.c            | 19 ++++++++----------
 drivers/net/ipa/ipa_uc.c               | 10 ++++++----
 drivers/net/ipa/ipa_uc.h               |  3 +--
 drivers/net/ipa/ipa_version.h          |  4 +++-
 drivers/net/ipa/reg.h                  |  8 +++++---
 drivers/net/ipa/reg/gsi_reg-v3.1.c     |  8 +++++---
 drivers/net/ipa/reg/gsi_reg-v3.5.1.c   |  8 +++++---
 drivers/net/ipa/reg/gsi_reg-v4.0.c     |  8 +++++---
 drivers/net/ipa/reg/gsi_reg-v4.11.c    |  8 +++++---
 drivers/net/ipa/reg/gsi_reg-v4.5.c     |  8 +++++---
 drivers/net/ipa/reg/gsi_reg-v4.9.c     |  8 +++++---
 drivers/net/ipa/reg/gsi_reg-v5.0.c     |  8 +++++---
 drivers/net/ipa/reg/ipa_reg-v3.1.c     |  6 ++++--
 drivers/net/ipa/reg/ipa_reg-v3.5.1.c   |  6 ++++--
 drivers/net/ipa/reg/ipa_reg-v4.11.c    |  6 ++++--
 drivers/net/ipa/reg/ipa_reg-v4.2.c     |  6 ++++--
 drivers/net/ipa/reg/ipa_reg-v4.5.c     |  6 ++++--
 drivers/net/ipa/reg/ipa_reg-v4.7.c     |  6 ++++--
 drivers/net/ipa/reg/ipa_reg-v4.9.c     |  6 ++++--
 drivers/net/ipa/reg/ipa_reg-v5.0.c     |  6 ++++--
 drivers/net/ipa/reg/ipa_reg-v5.5.c     |  6 +++---
 62 files changed, 253 insertions(+), 228 deletions(-)

Comments

[e-mail] April 18, 2024, 11:10 a.m. UTC | #1

Hello:

This series was applied to netdev/net-next.git (main)
by Paolo Abeni <[e-mail]>:

On Tue, 16 Apr 2024 18:10:11 -0500 you wrote:
> The end result of this series is that the list of files included in
> every IPA source file will be maintained in sorted order.  This
> imposes some consistency that was previously not possible.
> 
> If an IPA header file requires a symbol or type declared in another
> header, that other header must be included.  E.g., if bool or u32
> type is used in a function declaration in an IPA header file, the
> IPA header must include <linux/types.h>.
> 
> [...]

Here is the summary with links:
  - [net-next,1/7] net: ipa: include some standard header files
    https://git.kernel.org/netdev/net-next/c/ff39eefde76a
  - [net-next,2/7] net: ipa: remove unneeded standard includes
    https://git.kernel.org/netdev/net-next/c/8c044024e608
  - [net-next,3/7] net: ipa: include "ipa_interrupt.h" where needed
    https://git.kernel.org/netdev/net-next/c/a53c85f35258
  - [net-next,4/7] net: ipa: add some needed struct declarations
    https://git.kernel.org/netdev/net-next/c/81186959917a
  - [net-next,5/7] net: ipa: eliminate unneeded struct declarations
    https://git.kernel.org/netdev/net-next/c/116061962d88
  - [net-next,6/7] net: ipa: more include file cleanup
    https://git.kernel.org/netdev/net-next/c/f60e5fb6dfaf
  - [net-next,7/7] net: ipa: sort all includes
    https://git.kernel.org/netdev/net-next/c/884122775e67

You are awesome, thank you!