From patchwork Wed Aug 16 17:35:36 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nicolas Pitre X-Patchwork-Id: 110274 Delivered-To: patch@linaro.org Received: by 10.140.95.78 with SMTP id h72csp1085925qge; Wed, 16 Aug 2017 10:38:03 -0700 (PDT) X-Received: by 10.99.103.6 with SMTP id b6mr2341499pgc.336.1502905083041; Wed, 16 Aug 2017 10:38:03 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1502905083; cv=none; d=google.com; s=arc-20160816; b=XKwFOGaGdo3M86RCQR/Xdrpf65prZi7t5ZHqDuAKbeVMZGKRdWb1aAlOKPuOeUKoh5 h62R0fJPf7nEZmd9A6qi6opYiA571ejqwhI+HroZ5LLpZIvRp/leCRdgQU/CWdm2yvG6 4Py1QKKr9rwH2lOKRYy5m+zn1T9N2ddD2Gf0OcEDsGMzAzQKMvZOEn6IEwarsLr7LdCl vGMvnjKu0DbGdDZLLF6yFdQEQ7LVXAJV3/+BB3e9RGP0L39sompYShMIQT2XA0Elak3G Nz9xhMFD/q37RznoW2bXREbLCbDNitEknwhB7bjR1dQUr/J8PerX7p1W5RBkqUw4JGE2 gcoA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:references:in-reply-to:message-id:date :subject:cc:to:from:dkim-signature:arc-authentication-results; bh=ZT9BZ33tFqIYjFLRrdSZfqH1UPZn/v0BzJz/JnRTPDE=; b=uh8bWnNdxWdTRM+85dftxiPePQG0dG+Fts1UG4rz7LsFO0Wm6DTDE59UA9NIaeOYIH u3s6MK7Tcmjn5ZcSfPAp4vmWfsUEpQg8MKfWLtOrfCkhkt5T0dGqTg78F91jlH0Qc2Zv XVp3yOnFDR86ct4pc4teRgHSuipa7z5T/eikF6VCHBFvxEFksoQPyr7szZQK8wSraMdu F/P0x/545F2+Ope1DqJJcdoG9GB4nhWWG7ZIhr0zh/pqA/nOpC8DC9nLISzTJMPvAW8+ Vpcav/DYqqDZVznIf8lvh9arUeJsyen99BjOzlOBG4IC75LMkMq124tdwpFEgFJD2Mvj XMIA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@pobox.com header.s=sasl header.b=Unk37GC2; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id p63si818382pfg.45.2017.08.16.10.38.02; Wed, 16 Aug 2017 10:38:03 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@pobox.com header.s=sasl header.b=Unk37GC2; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752715AbdHPRh1 (ORCPT + 26 others); Wed, 16 Aug 2017 13:37:27 -0400 Received: from pb-smtp2.pobox.com ([64.147.108.71]:61574 "EHLO sasl.smtp.pobox.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1751893AbdHPRf6 (ORCPT ); Wed, 16 Aug 2017 13:35:58 -0400 Received: from sasl.smtp.pobox.com (unknown [127.0.0.1]) by pb-smtp2.pobox.com (Postfix) with ESMTP id 3834AA2AC0; Wed, 16 Aug 2017 13:35:58 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=pobox.com; h=from:to:cc :subject:date:message-id:in-reply-to:references; s=sasl; bh=4LNM 4N67dUtw4Wle/S32Hi7oT/Q=; b=Unk37GC2WY2jivFyQIg8dDtmDTghlhZ/eyYg tIOq9roNv6qzdAxp49b3rsOLfdG1yTtQfyUnUZmjKLOo29Cq6KVoovijHhCBJbB+ ILVliU8Z1Xzq0w4V9xI7n7kk54OZRjOyr5yYc9WHG/m+ltmtN4m2X3LnRysNb792 yl0Byf4= Received: from pb-smtp2.nyi.icgroup.com (unknown [127.0.0.1]) by pb-smtp2.pobox.com (Postfix) with ESMTP id 2E90CA2ABE; Wed, 16 Aug 2017 13:35:58 -0400 (EDT) Received: from yoda.home (unknown [70.80.200.199]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by pb-smtp2.pobox.com (Postfix) with ESMTPSA id 9B03FA2AB9; Wed, 16 Aug 2017 13:35:57 -0400 (EDT) Received: from xanadu.home (xanadu.home [192.168.2.2]) by yoda.home (Postfix) with ESMTP id 71C762DA06DA; Wed, 16 Aug 2017 13:35:56 -0400 (EDT) From: Nicolas Pitre To: Alexander Viro Cc: linux-fsdevel@vger.kernel.org, linux-embedded@vger.kernel.org, linux-kernel@vger.kernel.org, Chris Brandt Subject: [PATCH v2 5/5] cramfs: rehabilitate it Date: Wed, 16 Aug 2017 13:35:36 -0400 Message-Id: <20170816173536.1879-6-nicolas.pitre@linaro.org> X-Mailer: git-send-email 2.9.5 In-Reply-To: <20170816173536.1879-1-nicolas.pitre@linaro.org> References: <20170816173536.1879-1-nicolas.pitre@linaro.org> X-Pobox-Relay-ID: 5CD30402-82A9-11E7-A932-9D2B0D78B957-78420484!pb-smtp2.pobox.com Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Update documentation, pointer to latest tools, appoint myself as maintainer. Given it's been unloved for so long, I don't expect anyone will protest. Signed-off-by: Nicolas Pitre --- Documentation/filesystems/cramfs.txt | 42 ++++++++++++++++++++++++++++++++++++ MAINTAINERS | 4 ++-- fs/cramfs/Kconfig | 9 +++++--- 3 files changed, 50 insertions(+), 5 deletions(-) -- 2.9.5 diff --git a/Documentation/filesystems/cramfs.txt b/Documentation/filesystems/cramfs.txt index 4006298f67..8875d306bc 100644 --- a/Documentation/filesystems/cramfs.txt +++ b/Documentation/filesystems/cramfs.txt @@ -45,6 +45,48 @@ you can just change the #define in mkcramfs.c, so long as you don't mind the filesystem becoming unreadable to future kernels. +Memory Mapped cramfs image +-------------------------- + +The CRAMFS_PHYSMEM Kconfig option adds support for loading data directly +from a physical linear memory range (usually non volatile memory like Flash) +to cramfs instead of going through the block device layer. This saves some +memory since no intermediate buffering is necessary to hold the data before +decompressing. + +And when data blocks are kept uncompressed and properly aligned, they will +automatically be mapped directly into user space whenever possible providing +eXecute-In-Place (XIP) from ROM of read-only segments. Data segments mapped +read-write (hence they have to be copied to RAM) may still be compressed in +the cramfs image in the same file along with non compressed read-only +segments. Both MMU and no-MMU systems are supported. This is particularly +handy for tiny embedded systems with very tight memory constraints. + +The filesystem type for this feature is "cramfs_physmem" to distinguish it +from the block device (or MTD) based access. The location of the cramfs +image in memory is system dependent. You must know the proper physical +address where the cramfs image is located and specify it using the +physaddr=0x******** mount option (for example, if the physical address +of the cramfs image is 0x80100000, the following command would mount it +on /mnt: + +$ mount -t cramfs_physmem -o physaddr=0x80100000 none /mnt + +To boot such an image as the root filesystem, the following kernel +commandline parameters must be provided: + + "rootfstype=cramfs_physmem rootflags=physaddr=0x80100000" + + +Tools +----- + +A version of mkcramfs that can take advantage of the latest capabilities +described above can be found here: + +https://github.com/npitre/cramfs-tools + + For /usr/share/magic -------------------- diff --git a/MAINTAINERS b/MAINTAINERS index 44cb004c76..12f8155cfe 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -3612,8 +3612,8 @@ F: drivers/cpuidle/* F: include/linux/cpuidle.h CRAMFS FILESYSTEM -W: http://sourceforge.net/projects/cramfs/ -S: Orphan / Obsolete +M: Nicolas Pitre +S: Maintained F: Documentation/filesystems/cramfs.txt F: fs/cramfs/ diff --git a/fs/cramfs/Kconfig b/fs/cramfs/Kconfig index 5eed4ad2d5..8ed27e41bd 100644 --- a/fs/cramfs/Kconfig +++ b/fs/cramfs/Kconfig @@ -1,5 +1,5 @@ config CRAMFS - tristate "Compressed ROM file system support (cramfs) (OBSOLETE)" + tristate "Compressed ROM file system support (cramfs)" select ZLIB_INFLATE help Saying Y here includes support for CramFs (Compressed ROM File @@ -15,8 +15,11 @@ config CRAMFS cramfs. Note that the root file system (the one containing the directory /) cannot be compiled as a module. - This filesystem is obsoleted by SquashFS, which is much better - in terms of performance and features. + This filesystem is limited in capabilities and performance on + purpose to remain small and low on RAM usage. It is most suitable + for small embedded systems. For a more capable compressed filesystem + you should look at SquashFS which is much better in terms of + performance and features. If unsure, say N.