From: Bjorn Helgaas <helgaas@kernel.org>
To: Mika Westerberg <mika.westerberg@linux.intel.com>
Cc: Kai-Heng Feng <kai.heng.feng@canonical.com>,
Rajvi Jingar <rajvi.jingar@linux.intel.com>,
"Rafael J . Wysocki" <rafael@kernel.org>,
Koba Ko <koba.ko@canonical.com>,
"David E . Box" <david.e.box@linux.intel.com>,
Sathyanarayanan Kuppuswamy
<sathyanarayanan.kuppuswamy@linux.intel.com>,
linux-pci@vger.kernel.org, linux-pm@vger.kernel.org,
linux-kernel@vger.kernel.org, Bjorn Helgaas <bhelgaas@google.com>
Subject: Re: [PATCH v3 05/10] PCI/PTM: Add pci_disable_ptm() wrapper
Date: Wed, 7 Sep 2022 16:12:05 -0500 [thread overview]
Message-ID: <20220907211205.GA119516@bhelgaas> (raw)
In-Reply-To: <YxgsCwOeFJVvItVO@black.fi.intel.com>
On Wed, Sep 07, 2022 at 08:28:43AM +0300, Mika Westerberg wrote:
> On Tue, Sep 06, 2022 at 05:23:46PM -0500, Bjorn Helgaas wrote:
> > @@ -42,6 +42,13 @@ void pci_disable_ptm(struct pci_dev *dev)
> > pci_write_config_word(dev, ptm + PCI_PTM_CTRL, ctrl);
> > }
>
> Since you export these, I suggest adding kernel-doc to explain how these
> are supposed to be used in drivers (pre-conditions etc.).
Currently there really aren't any preconditions, so kernel-doc would
repeat the function name and parameters without adding any real
information, but I think it would be good to add a few explanatory
comments. It always seems obvious when writing it, but it's never so
obvious without all the context ;)
> > +void pci_disable_ptm(struct pci_dev *dev)
> > +{
> > + __pci_disable_ptm(dev);
> > + dev->ptm_enabled = 0;
> > +}
> > +EXPORT_SYMBOL(pci_disable_ptm);
>
> EXPORT_SYMBOL_GPL()?
I don't feel strongly either way, but am inclined to do the same as
pci_enable_ptm() and pcie_ptm_enabled(), which are both EXPORT_SYMBOL.
We could change all of them at once if it's worthwhile. Currently
there's only one caller (igc) in the tree.
Bjorn
next prev parent reply other threads:[~2022-09-07 21:12 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-06 22:23 [PATCH v3 00/10] PCI/PM: Always disable PTM for all devices during suspend Bjorn Helgaas
2022-09-06 22:23 ` [PATCH v3 01/10] PCI/PTM: Preserve PTM Root Select Bjorn Helgaas
2022-09-06 22:23 ` [PATCH v3 02/10] PCI/PTM: Cache PTM Capability offset Bjorn Helgaas
2022-09-06 23:18 ` Sathyanarayanan Kuppuswamy
2022-09-07 15:49 ` Bjorn Helgaas
2022-09-06 22:23 ` [PATCH v3 03/10] PCI/PTM: Add pci_upstream_ptm() helper Bjorn Helgaas
2022-09-06 22:23 ` [PATCH v3 04/10] PCI/PTM: Separate configuration and enable Bjorn Helgaas
2022-09-07 5:25 ` Mika Westerberg
2022-09-06 22:23 ` [PATCH v3 05/10] PCI/PTM: Add pci_disable_ptm() wrapper Bjorn Helgaas
2022-09-07 5:28 ` Mika Westerberg
2022-09-07 21:12 ` Bjorn Helgaas [this message]
2022-09-06 22:23 ` [PATCH v3 06/10] PCI/PTM: Add pci_enable_ptm() wrapper Bjorn Helgaas
2022-09-07 5:29 ` Mika Westerberg
2022-09-08 20:18 ` Sathyanarayanan Kuppuswamy
2022-09-06 22:23 ` [PATCH v3 07/10] PCI/PTM: Add suspend/resume Bjorn Helgaas
2022-09-07 5:30 ` Mika Westerberg
2022-09-07 16:44 ` Bjorn Helgaas
2022-09-06 22:23 ` [PATCH v3 08/10] PCI/PTM: Move pci_ptm_info() body into its only caller Bjorn Helgaas
2022-09-06 22:23 ` [PATCH v3 09/10] PCI/PTM: Reorder functions in logical order Bjorn Helgaas
2022-09-08 20:15 ` Sathyanarayanan Kuppuswamy
2022-09-08 20:58 ` Bjorn Helgaas
2022-09-06 22:23 ` [PATCH v3 10/10] PCI/PM: Always disable PTM for all devices during suspend Bjorn Helgaas
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=20220907211205.GA119516@bhelgaas \
--to=helgaas@kernel.org \
--cc=bhelgaas@google.com \
--cc=david.e.box@linux.intel.com \
--cc=kai.heng.feng@canonical.com \
--cc=koba.ko@canonical.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=mika.westerberg@linux.intel.com \
--cc=rafael@kernel.org \
--cc=rajvi.jingar@linux.intel.com \
--cc=sathyanarayanan.kuppuswamy@linux.intel.com \
/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).