From patchwork Sun Sep 20 17:16:58 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Lunn X-Patchwork-Id: 260531 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI, SPF_HELO_NONE, SPF_PASS, USER_AGENT_GIT autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5B45DC43463 for ; Sun, 20 Sep 2020 17:17:24 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 176CB20866 for ; Sun, 20 Sep 2020 17:17:24 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726406AbgITRRX (ORCPT ); Sun, 20 Sep 2020 13:17:23 -0400 Received: from vps0.lunn.ch ([185.16.172.187]:46144 "EHLO vps0.lunn.ch" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726314AbgITRRX (ORCPT ); Sun, 20 Sep 2020 13:17:23 -0400 Received: from andrew by vps0.lunn.ch with local (Exim 4.94) (envelope-from ) id 1kK2xi-00FUYa-LT; Sun, 20 Sep 2020 19:17:18 +0200 From: Andrew Lunn To: David Miller Cc: netdev , Florian Fainelli , Heiner Kallweit , Andrew Lunn Subject: [PATCH net-next 0/5] PHY subsystem kernel doc Date: Sun, 20 Sep 2020 19:16:58 +0200 Message-Id: <20200920171703.3692328-1-andrew@lunn.ch> X-Mailer: git-send-email 2.27.0 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org The first two patches just fixed warnings seen while trying to work on PHY documentation. The following patches then first fix existing warnings in the kerneldoc for the PHY subsystem, and then extend the kernel documentation for the major structures and functions in the PHY subsystem. Andrew Lunn (5): net: netdevice.h: Document proto_down_reason net: netdevice.h: Document xdp_state net: phy: Fixup kernel doc net: phy: Document core PHY structures net: mdio: Add kerneldoc for main data structures and some functions Documentation/networking/kapi.rst | 24 ++ drivers/net/phy/mdio_bus.c | 37 +++ drivers/net/phy/mdio_device.c | 21 ++ drivers/net/phy/phy-core.c | 30 +++ drivers/net/phy/phy.c | 69 ++++- include/linux/mdio.h | 91 ++++++- include/linux/netdevice.h | 3 + include/linux/phy.h | 414 +++++++++++++++++++++--------- 8 files changed, 554 insertions(+), 135 deletions(-) Reviewed-by: Randy Dunlap Reviewed-by: Florian Fainelli Reviewed-by: Florian Fainelli