From patchwork Thu Apr 9 19:27:17 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 1268751 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming-netdev@ozlabs.org Delivered-To: patchwork-incoming-netdev@ozlabs.org Authentication-Results: ozlabs.org; spf=none (no SPF record) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=infradead.org header.i=@infradead.org header.a=rsa-sha256 header.s=bombadil.20170209 header.b=ZgCNo4Sb; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 48yrl108kzz9sRN for ; Fri, 10 Apr 2020 05:27:40 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726708AbgDIT1V (ORCPT ); Thu, 9 Apr 2020 15:27:21 -0400 Received: from bombadil.infradead.org ([198.137.202.133]:38006 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725970AbgDIT1V (ORCPT ); Thu, 9 Apr 2020 15:27:21 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Content-Transfer-Encoding: Content-Type:In-Reply-To:MIME-Version:Date:Message-ID:References:Cc:To:From: Subject:Sender:Reply-To:Content-ID:Content-Description; bh=+5HMUCNkBVOds9Hf/9KeHJiap771cuhlz8kud+ZiLWY=; b=ZgCNo4SbLps0p9NgnX6jSERIJy hDuO1WRGovf9VWVNfN2o58uSYQWFO4bBWZWzhNqlcCEYmqiaeWHMZSbrCwn/ra2EeJoyzJgKCiyGZ y7lNcbnCMFk+ZGSqPdUxxIOEO8sztcfkB/cOdtj4siwHTn2y8dGUu/6EHYdvu5sSi01VNMqes1QHR 3RakVPS5YeiNaS8vtrrmbR1nQ+FgzVCmuq4r1DvnMNzkgDXQvtNI9LDUyiBGe6kjZmKJJVyevmtpt i64gLnyTl9SZahWCTGDnBfS18fVDx1DGGtzJjxp0zXoYMA3omYHndtoqLQyLb2PqyfitR2fxvuOnc 28vGbA2Q==; Received: from [2601:1c0:6280:3f0::19c2] by bombadil.infradead.org with esmtpsa (Exim 4.92.3 #3 (Red Hat Linux)) id 1jMcpa-0005Ge-SY; Thu, 09 Apr 2020 19:27:18 +0000 Subject: [PATCH net] docs: networking: add full DIM API From: Randy Dunlap To: Jakub Kicinski , davem@davemloft.net Cc: netdev@vger.kernel.org, kernel-team@fb.com, talgi@mellanox.com, leon@kernel.org, jacob.e.keller@intel.com References: <20200409175704.305241-1-kuba@kernel.org> Message-ID: Date: Thu, 9 Apr 2020 12:27:17 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.6.0 MIME-Version: 1.0 In-Reply-To: Content-Language: en-US Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org From: Randy Dunlap Add the full net DIM API to the net_dim.rst file. Signed-off-by: Randy Dunlap Cc: davem@davemloft.net Cc: Jakub Kicinski Cc: netdev@vger.kernel.org, talgi@mellanox.com, leon@kernel.org, jacob.e.keller@intel.com --- Applies on top of Jakub's patch: [PATCH net] docs: networking: convert DIM to RST I do have patches similar to Jakub's patch, but I haven't sent them yet. Anyway, the only significant difference it this small [optional] change. Documentation/networking/net_dim.rst | 6 ++++++ 1 file changed, 6 insertions(+) --- linux-next-20200409.orig/Documentation/networking/net_dim.rst +++ linux-next-20200409/Documentation/networking/net_dim.rst @@ -178,3 +178,9 @@ usage is not complete but it should make INIT_WORK(&my_entity->dim.work, my_driver_do_dim_work); ... } + +Dynamic Interrupt Moderation (DIM) library API +============================================== + +.. kernel-doc:: include/linux/dim.h + :internal: