Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Thu, 14 Jul 2022 07:54:00 -0700
From:   Ira Weiny <ira.weiny@intel.com>
To:     Matthew Wilcox <willy@infradead.org>
CC:     Dan Williams <dan.j.williams@intel.com>,
        Bjorn Helgaas <bhelgaas@google.com>,
        Jonathan Cameron <Jonathan.Cameron@huawei.com>,
        "Li, Ming" <ming4.li@intel.com>,
        Bjorn Helgaas <helgaas@kernel.org>,
        Lukas Wunner <lukas@wunner.de>,
        Alison Schofield <alison.schofield@intel.com>,
        "Vishal Verma" <vishal.l.verma@intel.com>,
        Dave Jiang <dave.jiang@intel.com>,
        "Ben Widawsky" <bwidawsk@kernel.org>,
        <linux-kernel@vger.kernel.org>, <linux-cxl@vger.kernel.org>,
        <linux-pci@vger.kernel.org>
Subject: Re: [PATCH V13.1] PCI/DOE: Add DOE mailbox support functions
Message-ID: <YtAuCLg2iEePyK9q@iweiny-desk3>
References: <20220705154932.2141021-4-ira.weiny@intel.com>
 <20220711222748.470340-1-ira.weiny@intel.com>
 <Ysyog0OFUu+5MIxT@casper.infradead.org>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <Ysyog0OFUu+5MIxT@casper.infradead.org>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?fhezgeJy1ai6GmsCAbO2VPoW+ss1ycZ33/k+ekG6IwyygPJc9tZJOf7u54oc?=
 =?us-ascii?Q?P+6MtLYAQaa6/NYGeLGgCoepn7wRfvUFxHqma3LzzH7bXJclSeZFXc1u2C0T?=
 =?us-ascii?Q?fd0Nkewqib99QmTGDPNQgckIOn8smCNqX/wYTFHqtfutjHGNViVqm2oQ2Idv?=
 =?us-ascii?Q?fxoaxEhNjE3DItaf347BKukTEc+sLi9nIUA+zEsmCjj13W8NidO9SUuzESIE?=
 =?us-ascii?Q?Ox6ZW6+zvA/MvAeO6bfWNijWQV+i7fXv5WqyZ+kZmo1RO5te5DFmgolcpWqz?=
 =?us-ascii?Q?O5QhIeJF6Jp3BwjZT5GeiEqwSEYcQn0Uv5BRr/h17gcHrenBdx6kx65sOxvN?=
 =?us-ascii?Q?5pOC7gyZJNvq0veR+08RlKr4Z9UmSH+KPHY7xIBnCKDSEtDiIo4zqd/Nu3GK?=
 =?us-ascii?Q?3i/Yoeus7WpHIWNRoc7UnM1b97l1Lq5BNTCWBZ+LoyuHB4glG0IloLWbLE9/?=
 =?us-ascii?Q?Ub/I5gpkitPe52DgBmSehES9Q+7DnQ8QETBmbXp9T02XoJgUTMGZhIt4+w+m?=
 =?us-ascii?Q?/KDo09GL1IisLVedHPl7AKm28o/6wwMveVUKQsTBo+56sIqBbYyshj/aJ9Nv?=
 =?us-ascii?Q?734kgImMzSjz6Vz64qVyiAjD2v7L62Rm+o8gafvNB1wwlmp8DrPG+qwc5uuO?=
 =?us-ascii?Q?M/W8wK1ilm31cg+oeWprJcjR0V6ReBPjPIwODNMK4dqmguAhGPzXhHeCSdJ5?=
 =?us-ascii?Q?nR/QCeo0ncGwU+tPOL8BKeDdE5/7OAxFI5HOK2fWfs5qoL8H66Dr8bp6yRfH?=
 =?us-ascii?Q?pvlemaCvMiR+Q37O3nfC1tDxHuhIOxHDmoS+auoO8rsAz75xXzQXzxtqjWaU?=
 =?us-ascii?Q?DFO4wsPqyLjmtLss4nO62wMbAvmGeUazHakl1B3mUCZ2TtRZUokmVNS7aEnV?=
 =?us-ascii?Q?NCHo9T/9a/A3Ig8Ps0JV55Xh8DOSNqQ21U7uvWXGaYtGYt7cOeebUKuShvZ+?=
 =?us-ascii?Q?mMSPsr9XPoj8/yv/Chg6NxVBRX1O1mkEgrnTFdYETTIztA2onjYgpJclUM4W?=
 =?us-ascii?Q?fZDWjtRLTccVsqGKiX3Ga8dJJoUjAinnteqGldU61qGpDyfNYjxh5eSzhhKe?=
 =?us-ascii?Q?zk0I0WYTjRMciLwFT2FtbBjJpU1DzAQk/ATS0plCL1GOUwqHkHPGjSb3XAYQ?=
 =?us-ascii?Q?a38s3dapJwtT6Fdens5yxux/u6Canrev2paRJr4VhTmzkVEUlk+d1f/C1G25?=
 =?us-ascii?Q?7ZBqHzPY+OsdJ7uN0Rq7zkcxwbD0s/pIsrmgrxxM1Da/Gw5JNx2rAbSn181N?=
 =?us-ascii?Q?0Cmgjho87SgqjDRqmJal937XFueP0Rn/jfpCMEHxGp/YEajRsWKjgLbZNOmd?=
 =?us-ascii?Q?UWx0QNm3O4ZnLA7abxAv9iW1ztjmtjvGBIvF8n+b/zoWJEot+BAIVc4VZJLR?=
 =?us-ascii?Q?JF4nMnM7bLo6126isjHTTcxPf8VuAWsvR2ygccZeq+QMBsbHgX58isP5gfkn?=
 =?us-ascii?Q?/K+F6NGzwt3/X3GvLGpZfA+J6tQ9uv1472RUSWmu9S8XseTygL3oYXalYDoJ?=
 =?us-ascii?Q?ZuejmLd2PxhCQiel5H+wgLGCUP8kOK03p3VtHCHzexwPJm4jUKRIhAQhPdSS?=
 =?us-ascii?Q?sP3vIUw2njlpsInzduen7r9nfZ55MYLtwNeP9ATVDyEc1R5noWoPzxiOTQNP?=
 =?us-ascii?Q?n26M5W6sYRVsPDH0qthTpr0+HtD/dJ/A1xX81yrdl0yw?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 25bf0d3e-c7ab-4856-7f6b-08da65a8b489
X-MS-Exchange-CrossTenant-AuthSource: DM4PR11MB6311.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Jul 2022 14:54:08.6835
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: kxWTIyAFLM1ptpKtzZJjEiN1j4lP3wbeKA0pgsuXlNW612u8Sk+enHK1r1XU1LaT8VKymCRzbU+IcFPEe/G8zw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR11MB1718
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-7.7 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_HI,
        RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_NONE,
        T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Mon, Jul 11, 2022 at 11:47:31PM +0100, Matthew Wilcox wrote:
> On Mon, Jul 11, 2022 at 03:27:48PM -0700, ira.weiny@intel.com wrote:
> > +/**
> > + * struct pci_doe_mb - State for a single DOE mailbox
> > + *
> > + * This state is used to manage a single DOE mailbox capability.  All fields
> > + * should be considered opaque to the consumers and the structure passed into
> > + * the helpers below after being created by devm_pci_doe_create()
> > + *
> > + * @pdev: PCI device this mailbox belongs to
> > + * @cap_offset: Capability offset
> > + * @prots: Array of protocols supported (encoded as long values)
> > + * @wq: Wait queue for work item
> > + * @work_queue: Queue of pci_doe_work items
> > + * @flags: Bit array of PCI_DOE_FLAG_* flags
> > + *
> > + * Note: @prots can't be allocated with struct size because the number of
> > + * protocols is not known until after this structure is in use.  However, the
> > + * single discovery protocol is always required to query for the number of
> > + * protocols.
> > + */
> 
> Can you add at least stub documentation in Documentation/PCI/doe.rst
> and include the kernel-doc from both pci-doe.c and pci-doe.h?

Yes that is a good idea, thanks.

> 
> > +static int pci_doe_abort(struct pci_doe_mb *doe_mb)
> > +{
> > +	struct pci_dev *pdev = doe_mb->pdev;
> > +	int offset = doe_mb->cap_offset;
> > +	unsigned long timeout_jiffies;
> > +
> > +	pci_dbg(pdev, "[%x] Issuing Abort\n", offset);
> 
> "Issuing DOE abort", perhaps?

I've set dev_fmt to prefix with "DOE: ".  So I think that should be ok.

Thanks for the review!
Ira