From patchwork Tue Oct 12 10:45:46 2010 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sven Eckelmann X-Patchwork-Id: 504 Return-Path: Received: from mail.gmx.net (mailout-de.gmx.net [213.165.64.22]) by open-mesh.org (Postfix) with SMTP id C26AF1545BD for ; Tue, 12 Oct 2010 12:45:30 +0200 (CEST) Received: (qmail invoked by alias); 12 Oct 2010 10:45:29 -0000 Received: from unknown (EHLO sven-desktop.lazhur.ath.cx) [89.246.206.155] by mail.gmx.net (mp016) with SMTP; 12 Oct 2010 12:45:29 +0200 X-Authenticated: #15668376 X-Provags-ID: V01U2FsdGVkX19d+ihJfGNdLrJMpa39z6QrChQ+7l8C5mPNpiAscp P0hefFDeaJa6tT From: Sven Eckelmann To: b.a.t.m.a.n@lists.open-mesh.org Date: Tue, 12 Oct 2010 12:45:46 +0200 Message-Id: <1286880346-21477-1-git-send-email-sven.eckelmann@gmx.de> X-Mailer: git-send-email 1.7.2.3 X-Y-GMX-Trusted: 0 Subject: [B.A.T.M.A.N.] [PATCH] batman-adv: Add batman-adv sysfs ABI documentation X-BeenThere: b.a.t.m.a.n@lists.open-mesh.org X-Mailman-Version: 2.1.11 Precedence: list Reply-To: The list for a Better Approach To Mobile Ad-hoc Networking List-Id: The list for a Better Approach To Mobile Ad-hoc Networking List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 12 Oct 2010 10:45:30 -0000 The kernel requires to have all files in /sys documented and updated when new files are added. batman-adv has two important classes of files: one class for each mesh device and one for a directory in all normal netdevice folders. Signed-off-by: Sven Eckelmann --- Following files needs to be documented: * fragmentation * gw_mode batman-adv/sysfs-class-net-batman-adv | 14 ++++++++++++++ batman-adv/sysfs-class-net-mesh | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 0 deletions(-) create mode 100644 batman-adv/sysfs-class-net-batman-adv create mode 100644 batman-adv/sysfs-class-net-mesh diff --git a/batman-adv/sysfs-class-net-batman-adv b/batman-adv/sysfs-class-net-batman-adv new file mode 100644 index 0000000..38dd762 --- /dev/null +++ b/batman-adv/sysfs-class-net-batman-adv @@ -0,0 +1,14 @@ + +What: /sys/class/net//batman-adv/mesh_iface +Date: May 2010 +Contact: Marek Lindner +Description: + The /sys/class/net//batman-adv/mesh_iface file + displays the batman mesh interface this + currently is associated with. + +What: /sys/class/net//batman-adv/iface_status +Date: May 2010 +Contact: Marek Lindner +Description: + Indicates the status of as it is seen by batman. diff --git a/batman-adv/sysfs-class-net-mesh b/batman-adv/sysfs-class-net-mesh new file mode 100644 index 0000000..5aa1912 --- /dev/null +++ b/batman-adv/sysfs-class-net-mesh @@ -0,0 +1,33 @@ + +What: /sys/class/net//mesh/aggregated_ogms +Date: May 2010 +Contact: Marek Lindner +Description: + Indicates whether the batman protocol messages of the + mesh shall be aggregated or not. + +What: /sys/class/net//mesh/bonding +Date: June 2010 +Contact: Simon Wunderlich +Description: + Indicates whether the data traffic going through the + mesh will be sent using multiple interfaces at the + same time (if available). + +What: /sys/class/net//mesh/orig_interval +Date: May 2010 +Contact: Marek Lindner +Description: + Defines the interval in milliseconds in which batman + sends its protocol messages. + +What: /sys/class/net//mesh/vis_mode +Date: May 2010 +Contact: Marek Lindner +Description: + Each batman node only maintains information about its + own local neighborhood, therefore generating graphs + showing the topology of the entire mesh is not easily + feasible without having a central instance to collect + the local topologies from all nodes. This file allows + to activate the collecting (server) mode.