From patchwork Tue Nov 16 18:04:33 2010 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: tristan.lelong@blunderer.org X-Patchwork-Id: 71533 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from theia.denx.de (theia.denx.de [85.214.87.163]) by ozlabs.org (Postfix) with ESMTP id 309B3B718A for ; Wed, 17 Nov 2010 20:21:41 +1100 (EST) Received: from localhost (localhost [127.0.0.1]) by theia.denx.de (Postfix) with ESMTP id 324D7284D1; Wed, 17 Nov 2010 10:21:36 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at theia.denx.de Received: from theia.denx.de ([127.0.0.1]) by localhost (theia.denx.de [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id N6vt0L83pblC; Wed, 17 Nov 2010 10:21:35 +0100 (CET) Received: from theia.denx.de (localhost [127.0.0.1]) by theia.denx.de (Postfix) with ESMTP id 07E1528510; Wed, 17 Nov 2010 10:21:33 +0100 (CET) Received: from localhost (localhost [127.0.0.1]) by theia.denx.de (Postfix) with ESMTP id 295F9284F8 for ; Wed, 17 Nov 2010 10:21:30 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at theia.denx.de Received: from theia.denx.de ([127.0.0.1]) by localhost (theia.denx.de [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id albQjxxEAeyF for ; Wed, 17 Nov 2010 10:21:28 +0100 (CET) X-Greylist: delayed 55012 seconds by postgrey-1.27 at theia; Wed, 17 Nov 2010 10:21:26 CET X-policyd-weight: IN_SBL_XBL_SPAMHAUS=4.35 NOT_IN_SPAMCOP=-1.5 NOT_IN_BL_NJABL=-1.5 (only DNSBL check requested) Received: from wunderer (LPuteaux-156-15-47-90.w82-127.abo.wanadoo.fr [82.127.74.90]) by theia.denx.de (Postfix) with ESMTPS id 07D92284D1 for ; Wed, 17 Nov 2010 10:21:26 +0100 (CET) Received: from tristan by wunderer with local (Exim 4.72) (envelope-from ) id 1PIPtR-0004GF-LU; Tue, 16 Nov 2010 19:04:33 +0100 From: tristan.lelong@blunderer.org To: u-boot@lists.denx.de Date: Tue, 16 Nov 2010 19:04:33 +0100 Message-Id: <94165dbbab23af1ae7ff311d09c042221ab7b151.1289929762.git.blunderer@blunderer.org> X-Mailer: git-send-email 1.7.2.3 In-Reply-To: References: In-Reply-To: References: Subject: [U-Boot] [PATCH 3/3] Add the NBC + netconsole corresponding documentation X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.9 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: u-boot-bounces@lists.denx.de Errors-To: u-boot-bounces@lists.denx.de From: Tristan Lelong Signed-off-by: Tristan Lelong --- doc/README.netconsole | 66 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 66 insertions(+), 0 deletions(-) create mode 100644 doc/README.netconsole diff --git a/doc/README.netconsole b/doc/README.netconsole new file mode 100644 index 0000000..167f523 --- /dev/null +++ b/doc/README.netconsole @@ -0,0 +1,66 @@ +NETCONSOLE & NBC README + +# (C) Copyright 2010 +# Tristan Lelong, tristan.lelong@blunderer.org +# +# See file CREDITS for list of people who contributed to this +# project. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation; either version 2 of +# the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, +# MA 02111-1307 USA + +Configuration Options: + + CONFIG_NETCONSOLE + This enable the netconsole. Netconsole provide a remote access to + u-boot command line thru udp stream. + basically, you just set some environment variables like: + - stdin, stdout, and stderr to "nc" + - ncip to + and you can connect to the board ip, port 6666 (default) using + "tools/netconsole " + + CONFIG_CMD_NBC + This enable the Net Boot Controller feature that will listen for + NBC magic packet at boot time. If one of NBC packet is received, + u-boot reconfigure itself automagically to use the netconsole + and interrupt the autoboot. + The NBC packet contains the new board IP and the remote ip. + It can also target special boards using filters on hostname and/or ethaddr + To broadcast NBC packets just use: + "tools/sendnbc -i [options]" + Two environment variable will allow to protect your board from receiving + NBC interruptions: + - nbcsource: only this remote IP can interrupt autoboot using NBC + - nbcinhibit: if this variable is present, NBC is fully inhibited + + +NOTE: + NBC packet has the following format: + +One header + - NBC header (5 bytes): + - magical number 1 byte '0xD3' + - ASCII header 3 bytes "NBC" + - packet size 1 byte 'X' + +Several Data Chunks + - NBC data chunks (X-5 bytes) + - chunk name 4 bytes "IP\0\0" | "MAC\0" | "HOST" + - chunk size 1 byte 'Y' + - chunk data Y bytes "xxxx" + +The IP chunk is mandatory, other are optional +