From patchwork Sat Mar 19 02:11:32 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bob Copeland X-Patchwork-Id: 8624641 X-Patchwork-Delegate: johannes@sipsolutions.net Return-Path: X-Original-To: patchwork-linux-wireless@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork1.web.kernel.org (Postfix) with ESMTP id B504E9F758 for ; Sat, 19 Mar 2016 02:11:59 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id C5BEE20426 for ; Sat, 19 Mar 2016 02:11:58 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id BC81720425 for ; Sat, 19 Mar 2016 02:11:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754499AbcCSCLw (ORCPT ); Fri, 18 Mar 2016 22:11:52 -0400 Received: from mail-qg0-f67.google.com ([209.85.192.67]:33972 "EHLO mail-qg0-f67.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754357AbcCSCLn (ORCPT ); Fri, 18 Mar 2016 22:11:43 -0400 Received: by mail-qg0-f67.google.com with SMTP id j92so6595966qgj.1 for ; Fri, 18 Mar 2016 19:11:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bobcopeland-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=dCY6Z17F2xKCO+giR5kr1l8+Ur+CoOsSELTSNFJbMIU=; b=2JBSMcNKCAVn56L9vjehXZkXIl+0lVtrGCe/po5zwhjtf0omZAZL7fW7Hk7UwnLClC ET2lqpOciui9VCQh4sw7neqwY4zcBGAgWzT+oxgq9q0OzEIYqCGZ2tdGPdl+OAIvFKmJ xsT4vGya8xO8Ruv4DsYlcQTCu79/8InMSvb3hBmZmogvR0HdKVxtXhf97xOnk+k6uoaP jVwjEvisCNDpg9vcqZv//fyCO/HpLDSYCLmalN7IyW79RklYvYXBwPB6mQKdp10ga8QP HpwhpYdpbZB0glPIw2mfZtiMilogE3hLjaGaB321FoAChCXuZc0XbTu8tgJ0sbGCmGUW L8sg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=dCY6Z17F2xKCO+giR5kr1l8+Ur+CoOsSELTSNFJbMIU=; b=JtYynCPm0TuGgeOSa9xnABhFozzviU9jjJhNEW/zuT/prMAXKTOk3Et27faGCXiKRh iWlYjw8l9lLhJjmuIts3ISuk7RGW0jFucr9G6ryYg0MCXP8HPJ5jlPu6Lb1+wRtklI/k jgyDd4nlJHjSKCzGh3UWxxn7XOeg5Cz20N3VxglWr0myb84KWrseukC8ZVIaEhBQg0/s 9e43Mz2ikdBNtsPnyO3WdqIAB3SEF9PEHY9RN++Vh1KD8O9H7drEyrQPfn+VpKu1Rx2u KJGfp+ZuTrlP+/6hmoaEDzH68J/RpfkGaPJq8mrW1f4YWU0ZocBNU8QCDvTQEtewdkwy MDxw== X-Gm-Message-State: AD7BkJIo7RsCNSDUaysrcdNOO7q7HXzFVdqxJv4zbNGI56dMh9PEdB6NAlrq727yquD2TA== X-Received: by 10.140.20.183 with SMTP id 52mr26546894qgj.38.1458353502708; Fri, 18 Mar 2016 19:11:42 -0700 (PDT) Received: from hash ([2001:470:1d:6db:230:48ff:fe9d:9c89]) by smtp.gmail.com with ESMTPSA id x189sm7248687qhb.43.2016.03.18.19.11.40 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 18 Mar 2016 19:11:41 -0700 (PDT) Received: from glass.lan ([192.168.1.51] helo=glass) by hash with esmtp (Exim 4.84_2) (envelope-from ) id 1ah6MS-000548-I6; Fri, 18 Mar 2016 22:11:28 -0400 Received: from bob by glass with local (Exim 4.86) (envelope-from ) id 1ah6Md-0002Gi-NR; Fri, 18 Mar 2016 22:11:39 -0400 From: Bob Copeland To: Johannes Berg Cc: linux-wireless@vger.kernel.org, Bob Copeland Subject: [PATCH 5/5] mac80211: mesh: fix mesh path kerneldoc Date: Fri, 18 Mar 2016 22:11:32 -0400 Message-Id: <1458353492-8654-6-git-send-email-me@bobcopeland.com> X-Mailer: git-send-email 2.6.1 In-Reply-To: <1458353492-8654-1-git-send-email-me@bobcopeland.com> References: <1458353492-8654-1-git-send-email-me@bobcopeland.com> Sender: linux-wireless-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-wireless@vger.kernel.org X-Spam-Status: No, score=-6.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI,RP_MATCHES_RCVD,T_DKIM_INVALID,UNPARSEABLE_RELAY autolearn=ham version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Several of the mesh path fields are undocumented and some of the documentation is no longer correct or relevant after the switch to rhashtable. Clean up the kernel doc accordingly and reorder some fields to match the structure layout. Signed-off-by: Bob Copeland --- net/mac80211/mesh.h | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/net/mac80211/mesh.h b/net/mac80211/mesh.h index 4a59c034cc6d..f298987228c9 100644 --- a/net/mac80211/mesh.h +++ b/net/mac80211/mesh.h @@ -21,8 +21,6 @@ /** * enum mesh_path_flags - mac80211 mesh path flags * - * - * * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence @@ -70,12 +68,16 @@ enum mesh_deferred_task_flags { * struct mesh_path - mac80211 mesh path structure * * @dst: mesh path destination mac address + * @mpp: mesh proxy mac address + * @rhash: rhashtable list pointer + * @gate_list: list pointer for known gates list * @sdata: mesh subif * @next_hop: mesh neighbor to which frames for this destination will be * forwarded * @timer: mesh path discovery timer * @frame_queue: pending queue for frames sent to this destination while the * path is unresolved + * @rcu: rcu head for freeing mesh path * @sn: target sequence number * @metric: current metric to this destination * @hop_count: hops to destination @@ -94,10 +96,10 @@ enum mesh_deferred_task_flags { * @is_gate: the destination station of this path is a mesh gate * * - * The combination of dst and sdata is unique in the mesh path table. Since the - * next_hop STA is only protected by RCU as well, deleting the STA must also - * remove/substitute the mesh_path structure and wait until that is no longer - * reachable before destroying the STA completely. + * The dst address is unique in the mesh path table. Since the mesh_path is + * protected by RCU, deleting the next_hop STA must remove / substitute the + * mesh_path structure and wait until that is no longer reachable before + * destroying the STA completely. */ struct mesh_path { u8 dst[ETH_ALEN]; @@ -127,10 +129,11 @@ struct mesh_path { /** * struct mesh_table * - * @entries: number of entries in the table * @known_gates: list of known mesh gates and their mpaths by the station. The * gate's mpath may or may not be resolved and active. - * @rhash: the rhashtable containing struct mesh_paths, keyed by dest addr + * @gates_lock: protects updates to known_gates + * @rhead: the rhashtable containing struct mesh_paths, keyed by dest addr + * @entries: number of entries in the table */ struct mesh_table { struct hlist_head known_gates; @@ -151,6 +154,7 @@ struct mesh_table { * @seqnum: mesh sequence number of the frame * @exp_time: expiration time of the entry, in jiffies * @sa: source address of the frame + * @list: hashtable list pointer * * The Recent Multicast Cache keeps track of the latest multicast frames that * have been received by a mesh interface and discards received multicast frames