1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-or-later
2*4882a593Smuzhiyun /* MTD-based superblock management
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * Copyright © 2001-2007 Red Hat, Inc. All Rights Reserved.
5*4882a593Smuzhiyun * Copyright © 2001-2010 David Woodhouse <dwmw2@infradead.org>
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * Written by: David Howells <dhowells@redhat.com>
8*4882a593Smuzhiyun * David Woodhouse <dwmw2@infradead.org>
9*4882a593Smuzhiyun */
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun #include <linux/mtd/super.h>
12*4882a593Smuzhiyun #include <linux/namei.h>
13*4882a593Smuzhiyun #include <linux/export.h>
14*4882a593Smuzhiyun #include <linux/ctype.h>
15*4882a593Smuzhiyun #include <linux/slab.h>
16*4882a593Smuzhiyun #include <linux/major.h>
17*4882a593Smuzhiyun #include <linux/backing-dev.h>
18*4882a593Smuzhiyun #include <linux/fs_context.h>
19*4882a593Smuzhiyun #include "mtdcore.h"
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun /*
22*4882a593Smuzhiyun * compare superblocks to see if they're equivalent
23*4882a593Smuzhiyun * - they are if the underlying MTD device is the same
24*4882a593Smuzhiyun */
mtd_test_super(struct super_block * sb,struct fs_context * fc)25*4882a593Smuzhiyun static int mtd_test_super(struct super_block *sb, struct fs_context *fc)
26*4882a593Smuzhiyun {
27*4882a593Smuzhiyun struct mtd_info *mtd = fc->sget_key;
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun if (sb->s_mtd == fc->sget_key) {
30*4882a593Smuzhiyun pr_debug("MTDSB: Match on device %d (\"%s\")\n",
31*4882a593Smuzhiyun mtd->index, mtd->name);
32*4882a593Smuzhiyun return 1;
33*4882a593Smuzhiyun }
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun pr_debug("MTDSB: No match, device %d (\"%s\"), device %d (\"%s\")\n",
36*4882a593Smuzhiyun sb->s_mtd->index, sb->s_mtd->name, mtd->index, mtd->name);
37*4882a593Smuzhiyun return 0;
38*4882a593Smuzhiyun }
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun /*
41*4882a593Smuzhiyun * mark the superblock by the MTD device it is using
42*4882a593Smuzhiyun * - set the device number to be the correct MTD block device for pesuperstence
43*4882a593Smuzhiyun * of NFS exports
44*4882a593Smuzhiyun */
mtd_set_super(struct super_block * sb,struct fs_context * fc)45*4882a593Smuzhiyun static int mtd_set_super(struct super_block *sb, struct fs_context *fc)
46*4882a593Smuzhiyun {
47*4882a593Smuzhiyun sb->s_mtd = fc->sget_key;
48*4882a593Smuzhiyun sb->s_dev = MKDEV(MTD_BLOCK_MAJOR, sb->s_mtd->index);
49*4882a593Smuzhiyun sb->s_bdi = bdi_get(mtd_bdi);
50*4882a593Smuzhiyun return 0;
51*4882a593Smuzhiyun }
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun /*
54*4882a593Smuzhiyun * get a superblock on an MTD-backed filesystem
55*4882a593Smuzhiyun */
mtd_get_sb(struct fs_context * fc,struct mtd_info * mtd,int (* fill_super)(struct super_block *,struct fs_context *))56*4882a593Smuzhiyun static int mtd_get_sb(struct fs_context *fc,
57*4882a593Smuzhiyun struct mtd_info *mtd,
58*4882a593Smuzhiyun int (*fill_super)(struct super_block *,
59*4882a593Smuzhiyun struct fs_context *))
60*4882a593Smuzhiyun {
61*4882a593Smuzhiyun struct super_block *sb;
62*4882a593Smuzhiyun int ret;
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun fc->sget_key = mtd;
65*4882a593Smuzhiyun sb = sget_fc(fc, mtd_test_super, mtd_set_super);
66*4882a593Smuzhiyun if (IS_ERR(sb))
67*4882a593Smuzhiyun return PTR_ERR(sb);
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun if (sb->s_root) {
70*4882a593Smuzhiyun /* new mountpoint for an already mounted superblock */
71*4882a593Smuzhiyun pr_debug("MTDSB: Device %d (\"%s\") is already mounted\n",
72*4882a593Smuzhiyun mtd->index, mtd->name);
73*4882a593Smuzhiyun put_mtd_device(mtd);
74*4882a593Smuzhiyun } else {
75*4882a593Smuzhiyun /* fresh new superblock */
76*4882a593Smuzhiyun pr_debug("MTDSB: New superblock for device %d (\"%s\")\n",
77*4882a593Smuzhiyun mtd->index, mtd->name);
78*4882a593Smuzhiyun
79*4882a593Smuzhiyun ret = fill_super(sb, fc);
80*4882a593Smuzhiyun if (ret < 0)
81*4882a593Smuzhiyun goto error_sb;
82*4882a593Smuzhiyun
83*4882a593Smuzhiyun sb->s_flags |= SB_ACTIVE;
84*4882a593Smuzhiyun }
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun BUG_ON(fc->root);
87*4882a593Smuzhiyun fc->root = dget(sb->s_root);
88*4882a593Smuzhiyun return 0;
89*4882a593Smuzhiyun
90*4882a593Smuzhiyun error_sb:
91*4882a593Smuzhiyun deactivate_locked_super(sb);
92*4882a593Smuzhiyun return ret;
93*4882a593Smuzhiyun }
94*4882a593Smuzhiyun
95*4882a593Smuzhiyun /*
96*4882a593Smuzhiyun * get a superblock on an MTD-backed filesystem by MTD device number
97*4882a593Smuzhiyun */
mtd_get_sb_by_nr(struct fs_context * fc,int mtdnr,int (* fill_super)(struct super_block *,struct fs_context *))98*4882a593Smuzhiyun static int mtd_get_sb_by_nr(struct fs_context *fc, int mtdnr,
99*4882a593Smuzhiyun int (*fill_super)(struct super_block *,
100*4882a593Smuzhiyun struct fs_context *))
101*4882a593Smuzhiyun {
102*4882a593Smuzhiyun struct mtd_info *mtd;
103*4882a593Smuzhiyun
104*4882a593Smuzhiyun mtd = get_mtd_device(NULL, mtdnr);
105*4882a593Smuzhiyun if (IS_ERR(mtd)) {
106*4882a593Smuzhiyun errorf(fc, "MTDSB: Device #%u doesn't appear to exist\n", mtdnr);
107*4882a593Smuzhiyun return PTR_ERR(mtd);
108*4882a593Smuzhiyun }
109*4882a593Smuzhiyun
110*4882a593Smuzhiyun return mtd_get_sb(fc, mtd, fill_super);
111*4882a593Smuzhiyun }
112*4882a593Smuzhiyun
113*4882a593Smuzhiyun /**
114*4882a593Smuzhiyun * get_tree_mtd - Get a superblock based on a single MTD device
115*4882a593Smuzhiyun * @fc: The filesystem context holding the parameters
116*4882a593Smuzhiyun * @fill_super: Helper to initialise a new superblock
117*4882a593Smuzhiyun */
get_tree_mtd(struct fs_context * fc,int (* fill_super)(struct super_block * sb,struct fs_context * fc))118*4882a593Smuzhiyun int get_tree_mtd(struct fs_context *fc,
119*4882a593Smuzhiyun int (*fill_super)(struct super_block *sb,
120*4882a593Smuzhiyun struct fs_context *fc))
121*4882a593Smuzhiyun {
122*4882a593Smuzhiyun #ifdef CONFIG_BLOCK
123*4882a593Smuzhiyun struct block_device *bdev;
124*4882a593Smuzhiyun int ret, major;
125*4882a593Smuzhiyun #endif
126*4882a593Smuzhiyun int mtdnr;
127*4882a593Smuzhiyun
128*4882a593Smuzhiyun if (!fc->source)
129*4882a593Smuzhiyun return invalf(fc, "No source specified");
130*4882a593Smuzhiyun
131*4882a593Smuzhiyun pr_debug("MTDSB: dev_name \"%s\"\n", fc->source);
132*4882a593Smuzhiyun
133*4882a593Smuzhiyun /* the preferred way of mounting in future; especially when
134*4882a593Smuzhiyun * CONFIG_BLOCK=n - we specify the underlying MTD device by number or
135*4882a593Smuzhiyun * by name, so that we don't require block device support to be present
136*4882a593Smuzhiyun * in the kernel.
137*4882a593Smuzhiyun */
138*4882a593Smuzhiyun if (fc->source[0] == 'm' &&
139*4882a593Smuzhiyun fc->source[1] == 't' &&
140*4882a593Smuzhiyun fc->source[2] == 'd') {
141*4882a593Smuzhiyun if (fc->source[3] == ':') {
142*4882a593Smuzhiyun struct mtd_info *mtd;
143*4882a593Smuzhiyun
144*4882a593Smuzhiyun /* mount by MTD device name */
145*4882a593Smuzhiyun pr_debug("MTDSB: mtd:%%s, name \"%s\"\n",
146*4882a593Smuzhiyun fc->source + 4);
147*4882a593Smuzhiyun
148*4882a593Smuzhiyun mtd = get_mtd_device_nm(fc->source + 4);
149*4882a593Smuzhiyun if (!IS_ERR(mtd))
150*4882a593Smuzhiyun return mtd_get_sb(fc, mtd, fill_super);
151*4882a593Smuzhiyun
152*4882a593Smuzhiyun errorf(fc, "MTD: MTD device with name \"%s\" not found",
153*4882a593Smuzhiyun fc->source + 4);
154*4882a593Smuzhiyun
155*4882a593Smuzhiyun } else if (isdigit(fc->source[3])) {
156*4882a593Smuzhiyun /* mount by MTD device number name */
157*4882a593Smuzhiyun char *endptr;
158*4882a593Smuzhiyun
159*4882a593Smuzhiyun mtdnr = simple_strtoul(fc->source + 3, &endptr, 0);
160*4882a593Smuzhiyun if (!*endptr) {
161*4882a593Smuzhiyun /* It was a valid number */
162*4882a593Smuzhiyun pr_debug("MTDSB: mtd%%d, mtdnr %d\n", mtdnr);
163*4882a593Smuzhiyun return mtd_get_sb_by_nr(fc, mtdnr, fill_super);
164*4882a593Smuzhiyun }
165*4882a593Smuzhiyun }
166*4882a593Smuzhiyun }
167*4882a593Smuzhiyun
168*4882a593Smuzhiyun #ifdef CONFIG_BLOCK
169*4882a593Smuzhiyun /* try the old way - the hack where we allowed users to mount
170*4882a593Smuzhiyun * /dev/mtdblock$(n) but didn't actually _use_ the blockdev
171*4882a593Smuzhiyun */
172*4882a593Smuzhiyun bdev = lookup_bdev(fc->source);
173*4882a593Smuzhiyun if (IS_ERR(bdev)) {
174*4882a593Smuzhiyun ret = PTR_ERR(bdev);
175*4882a593Smuzhiyun errorf(fc, "MTD: Couldn't look up '%s': %d", fc->source, ret);
176*4882a593Smuzhiyun return ret;
177*4882a593Smuzhiyun }
178*4882a593Smuzhiyun pr_debug("MTDSB: lookup_bdev() returned 0\n");
179*4882a593Smuzhiyun
180*4882a593Smuzhiyun major = MAJOR(bdev->bd_dev);
181*4882a593Smuzhiyun mtdnr = MINOR(bdev->bd_dev);
182*4882a593Smuzhiyun bdput(bdev);
183*4882a593Smuzhiyun
184*4882a593Smuzhiyun if (major == MTD_BLOCK_MAJOR)
185*4882a593Smuzhiyun return mtd_get_sb_by_nr(fc, mtdnr, fill_super);
186*4882a593Smuzhiyun
187*4882a593Smuzhiyun #endif /* CONFIG_BLOCK */
188*4882a593Smuzhiyun
189*4882a593Smuzhiyun if (!(fc->sb_flags & SB_SILENT))
190*4882a593Smuzhiyun errorf(fc, "MTD: Attempt to mount non-MTD device \"%s\"",
191*4882a593Smuzhiyun fc->source);
192*4882a593Smuzhiyun return -EINVAL;
193*4882a593Smuzhiyun }
194*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(get_tree_mtd);
195*4882a593Smuzhiyun
196*4882a593Smuzhiyun /*
197*4882a593Smuzhiyun * destroy an MTD-based superblock
198*4882a593Smuzhiyun */
kill_mtd_super(struct super_block * sb)199*4882a593Smuzhiyun void kill_mtd_super(struct super_block *sb)
200*4882a593Smuzhiyun {
201*4882a593Smuzhiyun generic_shutdown_super(sb);
202*4882a593Smuzhiyun put_mtd_device(sb->s_mtd);
203*4882a593Smuzhiyun sb->s_mtd = NULL;
204*4882a593Smuzhiyun }
205*4882a593Smuzhiyun
206*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(kill_mtd_super);
207