xref: /rk3399_rockchip-uboot/drivers/mtd/mtdcore.c (revision 300aab2ac13af6f60ecc5d02fc13aeef614e7d66)
1e29c22f5SKyungmin Park /*
2e29c22f5SKyungmin Park  * Core registration and callback routines for MTD
3e29c22f5SKyungmin Park  * drivers and users.
4e29c22f5SKyungmin Park  *
5ff94bc40SHeiko Schocher  * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
6ff94bc40SHeiko Schocher  * Copyright © 2006      Red Hat UK Limited
7ff94bc40SHeiko Schocher  *
8ff94bc40SHeiko Schocher  * SPDX-License-Identifier:	GPL-2.0+
9ff94bc40SHeiko Schocher  *
10e29c22f5SKyungmin Park  */
11e29c22f5SKyungmin Park 
12ff94bc40SHeiko Schocher #ifndef __UBOOT__
13ff94bc40SHeiko Schocher #include <linux/module.h>
14ff94bc40SHeiko Schocher #include <linux/kernel.h>
15ff94bc40SHeiko Schocher #include <linux/ptrace.h>
16ff94bc40SHeiko Schocher #include <linux/seq_file.h>
17ff94bc40SHeiko Schocher #include <linux/string.h>
18ff94bc40SHeiko Schocher #include <linux/timer.h>
19ff94bc40SHeiko Schocher #include <linux/major.h>
20ff94bc40SHeiko Schocher #include <linux/fs.h>
21ff94bc40SHeiko Schocher #include <linux/err.h>
22ff94bc40SHeiko Schocher #include <linux/ioctl.h>
23ff94bc40SHeiko Schocher #include <linux/init.h>
24ff94bc40SHeiko Schocher #include <linux/proc_fs.h>
25ff94bc40SHeiko Schocher #include <linux/idr.h>
26ff94bc40SHeiko Schocher #include <linux/backing-dev.h>
27ff94bc40SHeiko Schocher #include <linux/gfp.h>
28ff94bc40SHeiko Schocher #include <linux/slab.h>
29ff94bc40SHeiko Schocher #else
30ff94bc40SHeiko Schocher #include <linux/err.h>
31e29c22f5SKyungmin Park #include <ubi_uboot.h>
32ff94bc40SHeiko Schocher #endif
33e29c22f5SKyungmin Park 
34f8fdb81fSFabio Estevam #include <linux/log2.h>
35ff94bc40SHeiko Schocher #include <linux/mtd/mtd.h>
36ff94bc40SHeiko Schocher #include <linux/mtd/partitions.h>
37ff94bc40SHeiko Schocher 
38ff94bc40SHeiko Schocher #include "mtdcore.h"
39ff94bc40SHeiko Schocher 
40ff94bc40SHeiko Schocher #ifndef __UBOOT__
41ff94bc40SHeiko Schocher /*
42ff94bc40SHeiko Schocher  * backing device capabilities for non-mappable devices (such as NAND flash)
43ff94bc40SHeiko Schocher  * - permits private mappings, copies are taken of the data
44ff94bc40SHeiko Schocher  */
45ff94bc40SHeiko Schocher static struct backing_dev_info mtd_bdi_unmappable = {
46ff94bc40SHeiko Schocher 	.capabilities	= BDI_CAP_MAP_COPY,
47ff94bc40SHeiko Schocher };
48ff94bc40SHeiko Schocher 
49ff94bc40SHeiko Schocher /*
50ff94bc40SHeiko Schocher  * backing device capabilities for R/O mappable devices (such as ROM)
51ff94bc40SHeiko Schocher  * - permits private mappings, copies are taken of the data
52ff94bc40SHeiko Schocher  * - permits non-writable shared mappings
53ff94bc40SHeiko Schocher  */
54ff94bc40SHeiko Schocher static struct backing_dev_info mtd_bdi_ro_mappable = {
55ff94bc40SHeiko Schocher 	.capabilities	= (BDI_CAP_MAP_COPY | BDI_CAP_MAP_DIRECT |
56ff94bc40SHeiko Schocher 			   BDI_CAP_EXEC_MAP | BDI_CAP_READ_MAP),
57ff94bc40SHeiko Schocher };
58ff94bc40SHeiko Schocher 
59ff94bc40SHeiko Schocher /*
60ff94bc40SHeiko Schocher  * backing device capabilities for writable mappable devices (such as RAM)
61ff94bc40SHeiko Schocher  * - permits private mappings, copies are taken of the data
62ff94bc40SHeiko Schocher  * - permits non-writable shared mappings
63ff94bc40SHeiko Schocher  */
64ff94bc40SHeiko Schocher static struct backing_dev_info mtd_bdi_rw_mappable = {
65ff94bc40SHeiko Schocher 	.capabilities	= (BDI_CAP_MAP_COPY | BDI_CAP_MAP_DIRECT |
66ff94bc40SHeiko Schocher 			   BDI_CAP_EXEC_MAP | BDI_CAP_READ_MAP |
67ff94bc40SHeiko Schocher 			   BDI_CAP_WRITE_MAP),
68ff94bc40SHeiko Schocher };
69ff94bc40SHeiko Schocher 
70ff94bc40SHeiko Schocher static int mtd_cls_suspend(struct device *dev, pm_message_t state);
71ff94bc40SHeiko Schocher static int mtd_cls_resume(struct device *dev);
72ff94bc40SHeiko Schocher 
73ff94bc40SHeiko Schocher static struct class mtd_class = {
74ff94bc40SHeiko Schocher 	.name = "mtd",
75ff94bc40SHeiko Schocher 	.owner = THIS_MODULE,
76ff94bc40SHeiko Schocher 	.suspend = mtd_cls_suspend,
77ff94bc40SHeiko Schocher 	.resume = mtd_cls_resume,
78ff94bc40SHeiko Schocher };
79ff94bc40SHeiko Schocher #else
80e29c22f5SKyungmin Park struct mtd_info *mtd_table[MAX_MTD_DEVICES];
81e29c22f5SKyungmin Park 
82ff94bc40SHeiko Schocher #define MAX_IDR_ID	64
83ff94bc40SHeiko Schocher 
84ff94bc40SHeiko Schocher struct idr_layer {
85ff94bc40SHeiko Schocher 	int	used;
86ff94bc40SHeiko Schocher 	void	*ptr;
87ff94bc40SHeiko Schocher };
88ff94bc40SHeiko Schocher 
89ff94bc40SHeiko Schocher struct idr {
90ff94bc40SHeiko Schocher 	struct idr_layer id[MAX_IDR_ID];
91ff94bc40SHeiko Schocher };
92ff94bc40SHeiko Schocher 
93ff94bc40SHeiko Schocher #define DEFINE_IDR(name)	struct idr name;
94ff94bc40SHeiko Schocher 
95ff94bc40SHeiko Schocher void idr_remove(struct idr *idp, int id)
96ff94bc40SHeiko Schocher {
97ff94bc40SHeiko Schocher 	if (idp->id[id].used)
98ff94bc40SHeiko Schocher 		idp->id[id].used = 0;
99ff94bc40SHeiko Schocher 
100ff94bc40SHeiko Schocher 	return;
101ff94bc40SHeiko Schocher }
102ff94bc40SHeiko Schocher void *idr_find(struct idr *idp, int id)
103ff94bc40SHeiko Schocher {
104ff94bc40SHeiko Schocher 	if (idp->id[id].used)
105ff94bc40SHeiko Schocher 		return idp->id[id].ptr;
106ff94bc40SHeiko Schocher 
107ff94bc40SHeiko Schocher 	return NULL;
108ff94bc40SHeiko Schocher }
109ff94bc40SHeiko Schocher 
110ff94bc40SHeiko Schocher void *idr_get_next(struct idr *idp, int *next)
111ff94bc40SHeiko Schocher {
112ff94bc40SHeiko Schocher 	void *ret;
113ff94bc40SHeiko Schocher 	int id = *next;
114ff94bc40SHeiko Schocher 
115ff94bc40SHeiko Schocher 	ret = idr_find(idp, id);
116ff94bc40SHeiko Schocher 	if (ret) {
117ff94bc40SHeiko Schocher 		id ++;
118ff94bc40SHeiko Schocher 		if (!idp->id[id].used)
119ff94bc40SHeiko Schocher 			id = 0;
120ff94bc40SHeiko Schocher 		*next = id;
121ff94bc40SHeiko Schocher 	} else {
122ff94bc40SHeiko Schocher 		*next = 0;
123ff94bc40SHeiko Schocher 	}
124ff94bc40SHeiko Schocher 
125ff94bc40SHeiko Schocher 	return ret;
126ff94bc40SHeiko Schocher }
127ff94bc40SHeiko Schocher 
128ff94bc40SHeiko Schocher int idr_alloc(struct idr *idp, void *ptr, int start, int end, gfp_t gfp_mask)
129ff94bc40SHeiko Schocher {
130ff94bc40SHeiko Schocher 	struct idr_layer *idl;
131ff94bc40SHeiko Schocher 	int i = 0;
132ff94bc40SHeiko Schocher 
133ff94bc40SHeiko Schocher 	while (i < MAX_IDR_ID) {
134ff94bc40SHeiko Schocher 		idl = &idp->id[i];
135ff94bc40SHeiko Schocher 		if (idl->used == 0) {
136ff94bc40SHeiko Schocher 			idl->used = 1;
137ff94bc40SHeiko Schocher 			idl->ptr = ptr;
138ff94bc40SHeiko Schocher 			return i;
139ff94bc40SHeiko Schocher 		}
140ff94bc40SHeiko Schocher 		i++;
141ff94bc40SHeiko Schocher 	}
142ff94bc40SHeiko Schocher 	return -ENOSPC;
143ff94bc40SHeiko Schocher }
144ff94bc40SHeiko Schocher #endif
145ff94bc40SHeiko Schocher 
146ff94bc40SHeiko Schocher static DEFINE_IDR(mtd_idr);
147ff94bc40SHeiko Schocher 
148ff94bc40SHeiko Schocher /* These are exported solely for the purpose of mtd_blkdevs.c. You
149ff94bc40SHeiko Schocher    should not use them for _anything_ else */
150ff94bc40SHeiko Schocher DEFINE_MUTEX(mtd_table_mutex);
151ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_table_mutex);
152ff94bc40SHeiko Schocher 
153ff94bc40SHeiko Schocher struct mtd_info *__mtd_next_device(int i)
154ff94bc40SHeiko Schocher {
155ff94bc40SHeiko Schocher 	return idr_get_next(&mtd_idr, &i);
156ff94bc40SHeiko Schocher }
157ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(__mtd_next_device);
158ff94bc40SHeiko Schocher 
159ff94bc40SHeiko Schocher #ifndef __UBOOT__
160ff94bc40SHeiko Schocher static LIST_HEAD(mtd_notifiers);
161ff94bc40SHeiko Schocher 
162ff94bc40SHeiko Schocher 
163ff94bc40SHeiko Schocher #define MTD_DEVT(index) MKDEV(MTD_CHAR_MAJOR, (index)*2)
164ff94bc40SHeiko Schocher 
165ff94bc40SHeiko Schocher /* REVISIT once MTD uses the driver model better, whoever allocates
166ff94bc40SHeiko Schocher  * the mtd_info will probably want to use the release() hook...
167ff94bc40SHeiko Schocher  */
168ff94bc40SHeiko Schocher static void mtd_release(struct device *dev)
169ff94bc40SHeiko Schocher {
170ff94bc40SHeiko Schocher 	struct mtd_info __maybe_unused *mtd = dev_get_drvdata(dev);
171ff94bc40SHeiko Schocher 	dev_t index = MTD_DEVT(mtd->index);
172ff94bc40SHeiko Schocher 
173ff94bc40SHeiko Schocher 	/* remove /dev/mtdXro node if needed */
174ff94bc40SHeiko Schocher 	if (index)
175ff94bc40SHeiko Schocher 		device_destroy(&mtd_class, index + 1);
176ff94bc40SHeiko Schocher }
177ff94bc40SHeiko Schocher 
178ff94bc40SHeiko Schocher static int mtd_cls_suspend(struct device *dev, pm_message_t state)
179ff94bc40SHeiko Schocher {
180ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
181ff94bc40SHeiko Schocher 
182ff94bc40SHeiko Schocher 	return mtd ? mtd_suspend(mtd) : 0;
183ff94bc40SHeiko Schocher }
184ff94bc40SHeiko Schocher 
185ff94bc40SHeiko Schocher static int mtd_cls_resume(struct device *dev)
186ff94bc40SHeiko Schocher {
187ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
188ff94bc40SHeiko Schocher 
189ff94bc40SHeiko Schocher 	if (mtd)
190ff94bc40SHeiko Schocher 		mtd_resume(mtd);
191ff94bc40SHeiko Schocher 	return 0;
192ff94bc40SHeiko Schocher }
193ff94bc40SHeiko Schocher 
194ff94bc40SHeiko Schocher static ssize_t mtd_type_show(struct device *dev,
195ff94bc40SHeiko Schocher 		struct device_attribute *attr, char *buf)
196ff94bc40SHeiko Schocher {
197ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
198ff94bc40SHeiko Schocher 	char *type;
199ff94bc40SHeiko Schocher 
200ff94bc40SHeiko Schocher 	switch (mtd->type) {
201ff94bc40SHeiko Schocher 	case MTD_ABSENT:
202ff94bc40SHeiko Schocher 		type = "absent";
203ff94bc40SHeiko Schocher 		break;
204ff94bc40SHeiko Schocher 	case MTD_RAM:
205ff94bc40SHeiko Schocher 		type = "ram";
206ff94bc40SHeiko Schocher 		break;
207ff94bc40SHeiko Schocher 	case MTD_ROM:
208ff94bc40SHeiko Schocher 		type = "rom";
209ff94bc40SHeiko Schocher 		break;
210ff94bc40SHeiko Schocher 	case MTD_NORFLASH:
211ff94bc40SHeiko Schocher 		type = "nor";
212ff94bc40SHeiko Schocher 		break;
213ff94bc40SHeiko Schocher 	case MTD_NANDFLASH:
214ff94bc40SHeiko Schocher 		type = "nand";
215ff94bc40SHeiko Schocher 		break;
216ff94bc40SHeiko Schocher 	case MTD_DATAFLASH:
217ff94bc40SHeiko Schocher 		type = "dataflash";
218ff94bc40SHeiko Schocher 		break;
219ff94bc40SHeiko Schocher 	case MTD_UBIVOLUME:
220ff94bc40SHeiko Schocher 		type = "ubi";
221ff94bc40SHeiko Schocher 		break;
222ff94bc40SHeiko Schocher 	case MTD_MLCNANDFLASH:
223ff94bc40SHeiko Schocher 		type = "mlc-nand";
224ff94bc40SHeiko Schocher 		break;
225ff94bc40SHeiko Schocher 	default:
226ff94bc40SHeiko Schocher 		type = "unknown";
227ff94bc40SHeiko Schocher 	}
228ff94bc40SHeiko Schocher 
229ff94bc40SHeiko Schocher 	return snprintf(buf, PAGE_SIZE, "%s\n", type);
230ff94bc40SHeiko Schocher }
231ff94bc40SHeiko Schocher static DEVICE_ATTR(type, S_IRUGO, mtd_type_show, NULL);
232ff94bc40SHeiko Schocher 
233ff94bc40SHeiko Schocher static ssize_t mtd_flags_show(struct device *dev,
234ff94bc40SHeiko Schocher 		struct device_attribute *attr, char *buf)
235ff94bc40SHeiko Schocher {
236ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
237ff94bc40SHeiko Schocher 
238ff94bc40SHeiko Schocher 	return snprintf(buf, PAGE_SIZE, "0x%lx\n", (unsigned long)mtd->flags);
239ff94bc40SHeiko Schocher 
240ff94bc40SHeiko Schocher }
241ff94bc40SHeiko Schocher static DEVICE_ATTR(flags, S_IRUGO, mtd_flags_show, NULL);
242ff94bc40SHeiko Schocher 
243ff94bc40SHeiko Schocher static ssize_t mtd_size_show(struct device *dev,
244ff94bc40SHeiko Schocher 		struct device_attribute *attr, char *buf)
245ff94bc40SHeiko Schocher {
246ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
247ff94bc40SHeiko Schocher 
248ff94bc40SHeiko Schocher 	return snprintf(buf, PAGE_SIZE, "%llu\n",
249ff94bc40SHeiko Schocher 		(unsigned long long)mtd->size);
250ff94bc40SHeiko Schocher 
251ff94bc40SHeiko Schocher }
252ff94bc40SHeiko Schocher static DEVICE_ATTR(size, S_IRUGO, mtd_size_show, NULL);
253ff94bc40SHeiko Schocher 
254ff94bc40SHeiko Schocher static ssize_t mtd_erasesize_show(struct device *dev,
255ff94bc40SHeiko Schocher 		struct device_attribute *attr, char *buf)
256ff94bc40SHeiko Schocher {
257ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
258ff94bc40SHeiko Schocher 
259ff94bc40SHeiko Schocher 	return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->erasesize);
260ff94bc40SHeiko Schocher 
261ff94bc40SHeiko Schocher }
262ff94bc40SHeiko Schocher static DEVICE_ATTR(erasesize, S_IRUGO, mtd_erasesize_show, NULL);
263ff94bc40SHeiko Schocher 
264ff94bc40SHeiko Schocher static ssize_t mtd_writesize_show(struct device *dev,
265ff94bc40SHeiko Schocher 		struct device_attribute *attr, char *buf)
266ff94bc40SHeiko Schocher {
267ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
268ff94bc40SHeiko Schocher 
269ff94bc40SHeiko Schocher 	return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->writesize);
270ff94bc40SHeiko Schocher 
271ff94bc40SHeiko Schocher }
272ff94bc40SHeiko Schocher static DEVICE_ATTR(writesize, S_IRUGO, mtd_writesize_show, NULL);
273ff94bc40SHeiko Schocher 
274ff94bc40SHeiko Schocher static ssize_t mtd_subpagesize_show(struct device *dev,
275ff94bc40SHeiko Schocher 		struct device_attribute *attr, char *buf)
276ff94bc40SHeiko Schocher {
277ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
278ff94bc40SHeiko Schocher 	unsigned int subpagesize = mtd->writesize >> mtd->subpage_sft;
279ff94bc40SHeiko Schocher 
280ff94bc40SHeiko Schocher 	return snprintf(buf, PAGE_SIZE, "%u\n", subpagesize);
281ff94bc40SHeiko Schocher 
282ff94bc40SHeiko Schocher }
283ff94bc40SHeiko Schocher static DEVICE_ATTR(subpagesize, S_IRUGO, mtd_subpagesize_show, NULL);
284ff94bc40SHeiko Schocher 
285ff94bc40SHeiko Schocher static ssize_t mtd_oobsize_show(struct device *dev,
286ff94bc40SHeiko Schocher 		struct device_attribute *attr, char *buf)
287ff94bc40SHeiko Schocher {
288ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
289ff94bc40SHeiko Schocher 
290ff94bc40SHeiko Schocher 	return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->oobsize);
291ff94bc40SHeiko Schocher 
292ff94bc40SHeiko Schocher }
293ff94bc40SHeiko Schocher static DEVICE_ATTR(oobsize, S_IRUGO, mtd_oobsize_show, NULL);
294ff94bc40SHeiko Schocher 
295ff94bc40SHeiko Schocher static ssize_t mtd_numeraseregions_show(struct device *dev,
296ff94bc40SHeiko Schocher 		struct device_attribute *attr, char *buf)
297ff94bc40SHeiko Schocher {
298ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
299ff94bc40SHeiko Schocher 
300ff94bc40SHeiko Schocher 	return snprintf(buf, PAGE_SIZE, "%u\n", mtd->numeraseregions);
301ff94bc40SHeiko Schocher 
302ff94bc40SHeiko Schocher }
303ff94bc40SHeiko Schocher static DEVICE_ATTR(numeraseregions, S_IRUGO, mtd_numeraseregions_show,
304ff94bc40SHeiko Schocher 	NULL);
305ff94bc40SHeiko Schocher 
306ff94bc40SHeiko Schocher static ssize_t mtd_name_show(struct device *dev,
307ff94bc40SHeiko Schocher 		struct device_attribute *attr, char *buf)
308ff94bc40SHeiko Schocher {
309ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
310ff94bc40SHeiko Schocher 
311ff94bc40SHeiko Schocher 	return snprintf(buf, PAGE_SIZE, "%s\n", mtd->name);
312ff94bc40SHeiko Schocher 
313ff94bc40SHeiko Schocher }
314ff94bc40SHeiko Schocher static DEVICE_ATTR(name, S_IRUGO, mtd_name_show, NULL);
315ff94bc40SHeiko Schocher 
316ff94bc40SHeiko Schocher static ssize_t mtd_ecc_strength_show(struct device *dev,
317ff94bc40SHeiko Schocher 				     struct device_attribute *attr, char *buf)
318ff94bc40SHeiko Schocher {
319ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
320ff94bc40SHeiko Schocher 
321ff94bc40SHeiko Schocher 	return snprintf(buf, PAGE_SIZE, "%u\n", mtd->ecc_strength);
322ff94bc40SHeiko Schocher }
323ff94bc40SHeiko Schocher static DEVICE_ATTR(ecc_strength, S_IRUGO, mtd_ecc_strength_show, NULL);
324ff94bc40SHeiko Schocher 
325ff94bc40SHeiko Schocher static ssize_t mtd_bitflip_threshold_show(struct device *dev,
326ff94bc40SHeiko Schocher 					  struct device_attribute *attr,
327ff94bc40SHeiko Schocher 					  char *buf)
328ff94bc40SHeiko Schocher {
329ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
330ff94bc40SHeiko Schocher 
331ff94bc40SHeiko Schocher 	return snprintf(buf, PAGE_SIZE, "%u\n", mtd->bitflip_threshold);
332ff94bc40SHeiko Schocher }
333ff94bc40SHeiko Schocher 
334ff94bc40SHeiko Schocher static ssize_t mtd_bitflip_threshold_store(struct device *dev,
335ff94bc40SHeiko Schocher 					   struct device_attribute *attr,
336ff94bc40SHeiko Schocher 					   const char *buf, size_t count)
337ff94bc40SHeiko Schocher {
338ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
339ff94bc40SHeiko Schocher 	unsigned int bitflip_threshold;
340ff94bc40SHeiko Schocher 	int retval;
341ff94bc40SHeiko Schocher 
342ff94bc40SHeiko Schocher 	retval = kstrtouint(buf, 0, &bitflip_threshold);
343ff94bc40SHeiko Schocher 	if (retval)
344ff94bc40SHeiko Schocher 		return retval;
345ff94bc40SHeiko Schocher 
346ff94bc40SHeiko Schocher 	mtd->bitflip_threshold = bitflip_threshold;
347ff94bc40SHeiko Schocher 	return count;
348ff94bc40SHeiko Schocher }
349ff94bc40SHeiko Schocher static DEVICE_ATTR(bitflip_threshold, S_IRUGO | S_IWUSR,
350ff94bc40SHeiko Schocher 		   mtd_bitflip_threshold_show,
351ff94bc40SHeiko Schocher 		   mtd_bitflip_threshold_store);
352ff94bc40SHeiko Schocher 
353ff94bc40SHeiko Schocher static ssize_t mtd_ecc_step_size_show(struct device *dev,
354ff94bc40SHeiko Schocher 		struct device_attribute *attr, char *buf)
355ff94bc40SHeiko Schocher {
356ff94bc40SHeiko Schocher 	struct mtd_info *mtd = dev_get_drvdata(dev);
357ff94bc40SHeiko Schocher 
358ff94bc40SHeiko Schocher 	return snprintf(buf, PAGE_SIZE, "%u\n", mtd->ecc_step_size);
359ff94bc40SHeiko Schocher 
360ff94bc40SHeiko Schocher }
361ff94bc40SHeiko Schocher static DEVICE_ATTR(ecc_step_size, S_IRUGO, mtd_ecc_step_size_show, NULL);
362ff94bc40SHeiko Schocher 
363ff94bc40SHeiko Schocher static struct attribute *mtd_attrs[] = {
364ff94bc40SHeiko Schocher 	&dev_attr_type.attr,
365ff94bc40SHeiko Schocher 	&dev_attr_flags.attr,
366ff94bc40SHeiko Schocher 	&dev_attr_size.attr,
367ff94bc40SHeiko Schocher 	&dev_attr_erasesize.attr,
368ff94bc40SHeiko Schocher 	&dev_attr_writesize.attr,
369ff94bc40SHeiko Schocher 	&dev_attr_subpagesize.attr,
370ff94bc40SHeiko Schocher 	&dev_attr_oobsize.attr,
371ff94bc40SHeiko Schocher 	&dev_attr_numeraseregions.attr,
372ff94bc40SHeiko Schocher 	&dev_attr_name.attr,
373ff94bc40SHeiko Schocher 	&dev_attr_ecc_strength.attr,
374ff94bc40SHeiko Schocher 	&dev_attr_ecc_step_size.attr,
375ff94bc40SHeiko Schocher 	&dev_attr_bitflip_threshold.attr,
376ff94bc40SHeiko Schocher 	NULL,
377ff94bc40SHeiko Schocher };
378ff94bc40SHeiko Schocher ATTRIBUTE_GROUPS(mtd);
379ff94bc40SHeiko Schocher 
380ff94bc40SHeiko Schocher static struct device_type mtd_devtype = {
381ff94bc40SHeiko Schocher 	.name		= "mtd",
382ff94bc40SHeiko Schocher 	.groups		= mtd_groups,
383ff94bc40SHeiko Schocher 	.release	= mtd_release,
384ff94bc40SHeiko Schocher };
385ff94bc40SHeiko Schocher #endif
386ff94bc40SHeiko Schocher 
387ff94bc40SHeiko Schocher /**
388ff94bc40SHeiko Schocher  *	add_mtd_device - register an MTD device
389ff94bc40SHeiko Schocher  *	@mtd: pointer to new MTD device info structure
390ff94bc40SHeiko Schocher  *
391ff94bc40SHeiko Schocher  *	Add a device to the list of MTD devices present in the system, and
392ff94bc40SHeiko Schocher  *	notify each currently active MTD 'user' of its arrival. Returns
393ff94bc40SHeiko Schocher  *	zero on success or 1 on failure, which currently will only happen
394ff94bc40SHeiko Schocher  *	if there is insufficient memory or a sysfs error.
395ff94bc40SHeiko Schocher  */
396ff94bc40SHeiko Schocher 
397e29c22f5SKyungmin Park int add_mtd_device(struct mtd_info *mtd)
398e29c22f5SKyungmin Park {
399ff94bc40SHeiko Schocher #ifndef __UBOOT__
400ff94bc40SHeiko Schocher 	struct mtd_notifier *not;
401ff94bc40SHeiko Schocher #endif
402ff94bc40SHeiko Schocher 	int i, error;
403ff94bc40SHeiko Schocher 
404ff94bc40SHeiko Schocher #ifndef __UBOOT__
405ff94bc40SHeiko Schocher 	if (!mtd->backing_dev_info) {
406ff94bc40SHeiko Schocher 		switch (mtd->type) {
407ff94bc40SHeiko Schocher 		case MTD_RAM:
408ff94bc40SHeiko Schocher 			mtd->backing_dev_info = &mtd_bdi_rw_mappable;
409ff94bc40SHeiko Schocher 			break;
410ff94bc40SHeiko Schocher 		case MTD_ROM:
411ff94bc40SHeiko Schocher 			mtd->backing_dev_info = &mtd_bdi_ro_mappable;
412ff94bc40SHeiko Schocher 			break;
413ff94bc40SHeiko Schocher 		default:
414ff94bc40SHeiko Schocher 			mtd->backing_dev_info = &mtd_bdi_unmappable;
415ff94bc40SHeiko Schocher 			break;
416ff94bc40SHeiko Schocher 		}
417ff94bc40SHeiko Schocher 	}
418ff94bc40SHeiko Schocher #endif
419e29c22f5SKyungmin Park 
420e29c22f5SKyungmin Park 	BUG_ON(mtd->writesize == 0);
421ff94bc40SHeiko Schocher 	mutex_lock(&mtd_table_mutex);
422e29c22f5SKyungmin Park 
423ff94bc40SHeiko Schocher 	i = idr_alloc(&mtd_idr, mtd, 0, 0, GFP_KERNEL);
424ff94bc40SHeiko Schocher 	if (i < 0)
425ff94bc40SHeiko Schocher 		goto fail_locked;
426ff94bc40SHeiko Schocher 
427e29c22f5SKyungmin Park 	mtd->index = i;
428e29c22f5SKyungmin Park 	mtd->usecount = 0;
429e29c22f5SKyungmin Park 
430dfe64e2cSSergey Lapin 	/* default value if not set by driver */
431dfe64e2cSSergey Lapin 	if (mtd->bitflip_threshold == 0)
432dfe64e2cSSergey Lapin 		mtd->bitflip_threshold = mtd->ecc_strength;
433dfe64e2cSSergey Lapin 
434ff94bc40SHeiko Schocher 	if (is_power_of_2(mtd->erasesize))
435ff94bc40SHeiko Schocher 		mtd->erasesize_shift = ffs(mtd->erasesize) - 1;
436ff94bc40SHeiko Schocher 	else
437ff94bc40SHeiko Schocher 		mtd->erasesize_shift = 0;
438dfe64e2cSSergey Lapin 
439ff94bc40SHeiko Schocher 	if (is_power_of_2(mtd->writesize))
440ff94bc40SHeiko Schocher 		mtd->writesize_shift = ffs(mtd->writesize) - 1;
441ff94bc40SHeiko Schocher 	else
442ff94bc40SHeiko Schocher 		mtd->writesize_shift = 0;
443ff94bc40SHeiko Schocher 
444ff94bc40SHeiko Schocher 	mtd->erasesize_mask = (1 << mtd->erasesize_shift) - 1;
445ff94bc40SHeiko Schocher 	mtd->writesize_mask = (1 << mtd->writesize_shift) - 1;
446ff94bc40SHeiko Schocher 
447ff94bc40SHeiko Schocher 	/* Some chips always power up locked. Unlock them now */
448ff94bc40SHeiko Schocher 	if ((mtd->flags & MTD_WRITEABLE) && (mtd->flags & MTD_POWERUP_LOCK)) {
449ff94bc40SHeiko Schocher 		error = mtd_unlock(mtd, 0, mtd->size);
450ff94bc40SHeiko Schocher 		if (error && error != -EOPNOTSUPP)
451ff94bc40SHeiko Schocher 			printk(KERN_WARNING
452ff94bc40SHeiko Schocher 			       "%s: unlock failed, writes may not work\n",
453ff94bc40SHeiko Schocher 			       mtd->name);
454ff94bc40SHeiko Schocher 	}
455ff94bc40SHeiko Schocher 
456ff94bc40SHeiko Schocher #ifndef __UBOOT__
457ff94bc40SHeiko Schocher 	/* Caller should have set dev.parent to match the
458ff94bc40SHeiko Schocher 	 * physical device.
459ff94bc40SHeiko Schocher 	 */
460ff94bc40SHeiko Schocher 	mtd->dev.type = &mtd_devtype;
461ff94bc40SHeiko Schocher 	mtd->dev.class = &mtd_class;
462ff94bc40SHeiko Schocher 	mtd->dev.devt = MTD_DEVT(i);
463ff94bc40SHeiko Schocher 	dev_set_name(&mtd->dev, "mtd%d", i);
464ff94bc40SHeiko Schocher 	dev_set_drvdata(&mtd->dev, mtd);
465ff94bc40SHeiko Schocher 	if (device_register(&mtd->dev) != 0)
466ff94bc40SHeiko Schocher 		goto fail_added;
467ff94bc40SHeiko Schocher 
468ff94bc40SHeiko Schocher 	if (MTD_DEVT(i))
469ff94bc40SHeiko Schocher 		device_create(&mtd_class, mtd->dev.parent,
470ff94bc40SHeiko Schocher 			      MTD_DEVT(i) + 1,
471ff94bc40SHeiko Schocher 			      NULL, "mtd%dro", i);
472ff94bc40SHeiko Schocher 
473ff94bc40SHeiko Schocher 	pr_debug("mtd: Giving out device %d to %s\n", i, mtd->name);
474e29c22f5SKyungmin Park 	/* No need to get a refcount on the module containing
475e29c22f5SKyungmin Park 	   the notifier, since we hold the mtd_table_mutex */
476ff94bc40SHeiko Schocher 	list_for_each_entry(not, &mtd_notifiers, list)
477ff94bc40SHeiko Schocher 		not->add(mtd);
478ddf7bcfaSHeiko Schocher #else
479ddf7bcfaSHeiko Schocher 	pr_debug("mtd: Giving out device %d to %s\n", i, mtd->name);
480ff94bc40SHeiko Schocher #endif
481e29c22f5SKyungmin Park 
482ff94bc40SHeiko Schocher 	mutex_unlock(&mtd_table_mutex);
483e29c22f5SKyungmin Park 	/* We _know_ we aren't being removed, because
484e29c22f5SKyungmin Park 	   our caller is still holding us here. So none
485e29c22f5SKyungmin Park 	   of this try_ nonsense, and no bitching about it
486e29c22f5SKyungmin Park 	   either. :) */
487ff94bc40SHeiko Schocher 	__module_get(THIS_MODULE);
488e29c22f5SKyungmin Park 	return 0;
489e29c22f5SKyungmin Park 
490ff94bc40SHeiko Schocher #ifndef __UBOOT__
491ff94bc40SHeiko Schocher fail_added:
492ff94bc40SHeiko Schocher 	idr_remove(&mtd_idr, i);
493ff94bc40SHeiko Schocher #endif
494ff94bc40SHeiko Schocher fail_locked:
495ff94bc40SHeiko Schocher 	mutex_unlock(&mtd_table_mutex);
496e29c22f5SKyungmin Park 	return 1;
497e29c22f5SKyungmin Park }
498e29c22f5SKyungmin Park 
499e29c22f5SKyungmin Park /**
500e29c22f5SKyungmin Park  *	del_mtd_device - unregister an MTD device
501e29c22f5SKyungmin Park  *	@mtd: pointer to MTD device info structure
502e29c22f5SKyungmin Park  *
503e29c22f5SKyungmin Park  *	Remove a device from the list of MTD devices present in the system,
504e29c22f5SKyungmin Park  *	and notify each currently active MTD 'user' of its departure.
505e29c22f5SKyungmin Park  *	Returns zero on success or 1 on failure, which currently will happen
506e29c22f5SKyungmin Park  *	if the requested device does not appear to be present in the list.
507e29c22f5SKyungmin Park  */
508ff94bc40SHeiko Schocher 
509e29c22f5SKyungmin Park int del_mtd_device(struct mtd_info *mtd)
510e29c22f5SKyungmin Park {
511e29c22f5SKyungmin Park 	int ret;
512ff94bc40SHeiko Schocher #ifndef __UBOOT__
513ff94bc40SHeiko Schocher 	struct mtd_notifier *not;
514ff94bc40SHeiko Schocher #endif
515e29c22f5SKyungmin Park 
516ff94bc40SHeiko Schocher 	mutex_lock(&mtd_table_mutex);
517ff94bc40SHeiko Schocher 
518ff94bc40SHeiko Schocher 	if (idr_find(&mtd_idr, mtd->index) != mtd) {
519e29c22f5SKyungmin Park 		ret = -ENODEV;
520ff94bc40SHeiko Schocher 		goto out_error;
521ff94bc40SHeiko Schocher 	}
522ff94bc40SHeiko Schocher 
523ff94bc40SHeiko Schocher #ifndef __UBOOT__
524ff94bc40SHeiko Schocher 	/* No need to get a refcount on the module containing
525ff94bc40SHeiko Schocher 		the notifier, since we hold the mtd_table_mutex */
526ff94bc40SHeiko Schocher 	list_for_each_entry(not, &mtd_notifiers, list)
527ff94bc40SHeiko Schocher 		not->remove(mtd);
528ff94bc40SHeiko Schocher #endif
529ff94bc40SHeiko Schocher 
530ff94bc40SHeiko Schocher 	if (mtd->usecount) {
531ff94bc40SHeiko Schocher 		printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
532e29c22f5SKyungmin Park 		       mtd->index, mtd->name, mtd->usecount);
533e29c22f5SKyungmin Park 		ret = -EBUSY;
534e29c22f5SKyungmin Park 	} else {
535ff94bc40SHeiko Schocher #ifndef __UBOOT__
536ff94bc40SHeiko Schocher 		device_unregister(&mtd->dev);
537ff94bc40SHeiko Schocher #endif
538e29c22f5SKyungmin Park 
539ff94bc40SHeiko Schocher 		idr_remove(&mtd_idr, mtd->index);
540ff94bc40SHeiko Schocher 
541ff94bc40SHeiko Schocher 		module_put(THIS_MODULE);
542e29c22f5SKyungmin Park 		ret = 0;
543e29c22f5SKyungmin Park 	}
544e29c22f5SKyungmin Park 
545ff94bc40SHeiko Schocher out_error:
546ff94bc40SHeiko Schocher 	mutex_unlock(&mtd_table_mutex);
547e29c22f5SKyungmin Park 	return ret;
548e29c22f5SKyungmin Park }
549e29c22f5SKyungmin Park 
550ff94bc40SHeiko Schocher #ifndef __UBOOT__
551ff94bc40SHeiko Schocher /**
552ff94bc40SHeiko Schocher  * mtd_device_parse_register - parse partitions and register an MTD device.
553ff94bc40SHeiko Schocher  *
554ff94bc40SHeiko Schocher  * @mtd: the MTD device to register
555ff94bc40SHeiko Schocher  * @types: the list of MTD partition probes to try, see
556ff94bc40SHeiko Schocher  *         'parse_mtd_partitions()' for more information
557ff94bc40SHeiko Schocher  * @parser_data: MTD partition parser-specific data
558ff94bc40SHeiko Schocher  * @parts: fallback partition information to register, if parsing fails;
559ff94bc40SHeiko Schocher  *         only valid if %nr_parts > %0
560ff94bc40SHeiko Schocher  * @nr_parts: the number of partitions in parts, if zero then the full
561ff94bc40SHeiko Schocher  *            MTD device is registered if no partition info is found
562ff94bc40SHeiko Schocher  *
563ff94bc40SHeiko Schocher  * This function aggregates MTD partitions parsing (done by
564ff94bc40SHeiko Schocher  * 'parse_mtd_partitions()') and MTD device and partitions registering. It
565ff94bc40SHeiko Schocher  * basically follows the most common pattern found in many MTD drivers:
566ff94bc40SHeiko Schocher  *
567ff94bc40SHeiko Schocher  * * It first tries to probe partitions on MTD device @mtd using parsers
568ff94bc40SHeiko Schocher  *   specified in @types (if @types is %NULL, then the default list of parsers
569ff94bc40SHeiko Schocher  *   is used, see 'parse_mtd_partitions()' for more information). If none are
570ff94bc40SHeiko Schocher  *   found this functions tries to fallback to information specified in
571ff94bc40SHeiko Schocher  *   @parts/@nr_parts.
572ff94bc40SHeiko Schocher  * * If any partitioning info was found, this function registers the found
573ff94bc40SHeiko Schocher  *   partitions.
574ff94bc40SHeiko Schocher  * * If no partitions were found this function just registers the MTD device
575ff94bc40SHeiko Schocher  *   @mtd and exits.
576ff94bc40SHeiko Schocher  *
577ff94bc40SHeiko Schocher  * Returns zero in case of success and a negative error code in case of failure.
578ff94bc40SHeiko Schocher  */
579ff94bc40SHeiko Schocher int mtd_device_parse_register(struct mtd_info *mtd, const char * const *types,
580ff94bc40SHeiko Schocher 			      struct mtd_part_parser_data *parser_data,
581ff94bc40SHeiko Schocher 			      const struct mtd_partition *parts,
582ff94bc40SHeiko Schocher 			      int nr_parts)
583ff94bc40SHeiko Schocher {
584ff94bc40SHeiko Schocher 	int err;
585ff94bc40SHeiko Schocher 	struct mtd_partition *real_parts;
586ff94bc40SHeiko Schocher 
587ff94bc40SHeiko Schocher 	err = parse_mtd_partitions(mtd, types, &real_parts, parser_data);
588ff94bc40SHeiko Schocher 	if (err <= 0 && nr_parts && parts) {
589ff94bc40SHeiko Schocher 		real_parts = kmemdup(parts, sizeof(*parts) * nr_parts,
590ff94bc40SHeiko Schocher 				     GFP_KERNEL);
591ff94bc40SHeiko Schocher 		if (!real_parts)
592ff94bc40SHeiko Schocher 			err = -ENOMEM;
593ff94bc40SHeiko Schocher 		else
594ff94bc40SHeiko Schocher 			err = nr_parts;
595ff94bc40SHeiko Schocher 	}
596ff94bc40SHeiko Schocher 
597ff94bc40SHeiko Schocher 	if (err > 0) {
598ff94bc40SHeiko Schocher 		err = add_mtd_partitions(mtd, real_parts, err);
599ff94bc40SHeiko Schocher 		kfree(real_parts);
600ff94bc40SHeiko Schocher 	} else if (err == 0) {
601ff94bc40SHeiko Schocher 		err = add_mtd_device(mtd);
602ff94bc40SHeiko Schocher 		if (err == 1)
603ff94bc40SHeiko Schocher 			err = -ENODEV;
604ff94bc40SHeiko Schocher 	}
605ff94bc40SHeiko Schocher 
606ff94bc40SHeiko Schocher 	return err;
607ff94bc40SHeiko Schocher }
608ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_device_parse_register);
609ff94bc40SHeiko Schocher 
610ff94bc40SHeiko Schocher /**
611ff94bc40SHeiko Schocher  * mtd_device_unregister - unregister an existing MTD device.
612ff94bc40SHeiko Schocher  *
613ff94bc40SHeiko Schocher  * @master: the MTD device to unregister.  This will unregister both the master
614ff94bc40SHeiko Schocher  *          and any partitions if registered.
615ff94bc40SHeiko Schocher  */
616ff94bc40SHeiko Schocher int mtd_device_unregister(struct mtd_info *master)
617ff94bc40SHeiko Schocher {
618ff94bc40SHeiko Schocher 	int err;
619ff94bc40SHeiko Schocher 
620ff94bc40SHeiko Schocher 	err = del_mtd_partitions(master);
621ff94bc40SHeiko Schocher 	if (err)
622ff94bc40SHeiko Schocher 		return err;
623ff94bc40SHeiko Schocher 
624ff94bc40SHeiko Schocher 	if (!device_is_registered(&master->dev))
625ff94bc40SHeiko Schocher 		return 0;
626ff94bc40SHeiko Schocher 
627ff94bc40SHeiko Schocher 	return del_mtd_device(master);
628ff94bc40SHeiko Schocher }
629ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_device_unregister);
630ff94bc40SHeiko Schocher 
631ff94bc40SHeiko Schocher /**
632ff94bc40SHeiko Schocher  *	register_mtd_user - register a 'user' of MTD devices.
633ff94bc40SHeiko Schocher  *	@new: pointer to notifier info structure
634ff94bc40SHeiko Schocher  *
635ff94bc40SHeiko Schocher  *	Registers a pair of callbacks function to be called upon addition
636ff94bc40SHeiko Schocher  *	or removal of MTD devices. Causes the 'add' callback to be immediately
637ff94bc40SHeiko Schocher  *	invoked for each MTD device currently present in the system.
638ff94bc40SHeiko Schocher  */
639ff94bc40SHeiko Schocher void register_mtd_user (struct mtd_notifier *new)
640ff94bc40SHeiko Schocher {
641ff94bc40SHeiko Schocher 	struct mtd_info *mtd;
642ff94bc40SHeiko Schocher 
643ff94bc40SHeiko Schocher 	mutex_lock(&mtd_table_mutex);
644ff94bc40SHeiko Schocher 
645ff94bc40SHeiko Schocher 	list_add(&new->list, &mtd_notifiers);
646ff94bc40SHeiko Schocher 
647ff94bc40SHeiko Schocher 	__module_get(THIS_MODULE);
648ff94bc40SHeiko Schocher 
649ff94bc40SHeiko Schocher 	mtd_for_each_device(mtd)
650ff94bc40SHeiko Schocher 		new->add(mtd);
651ff94bc40SHeiko Schocher 
652ff94bc40SHeiko Schocher 	mutex_unlock(&mtd_table_mutex);
653ff94bc40SHeiko Schocher }
654ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(register_mtd_user);
655ff94bc40SHeiko Schocher 
656ff94bc40SHeiko Schocher /**
657ff94bc40SHeiko Schocher  *	unregister_mtd_user - unregister a 'user' of MTD devices.
658ff94bc40SHeiko Schocher  *	@old: pointer to notifier info structure
659ff94bc40SHeiko Schocher  *
660ff94bc40SHeiko Schocher  *	Removes a callback function pair from the list of 'users' to be
661ff94bc40SHeiko Schocher  *	notified upon addition or removal of MTD devices. Causes the
662ff94bc40SHeiko Schocher  *	'remove' callback to be immediately invoked for each MTD device
663ff94bc40SHeiko Schocher  *	currently present in the system.
664ff94bc40SHeiko Schocher  */
665ff94bc40SHeiko Schocher int unregister_mtd_user (struct mtd_notifier *old)
666ff94bc40SHeiko Schocher {
667ff94bc40SHeiko Schocher 	struct mtd_info *mtd;
668ff94bc40SHeiko Schocher 
669ff94bc40SHeiko Schocher 	mutex_lock(&mtd_table_mutex);
670ff94bc40SHeiko Schocher 
671ff94bc40SHeiko Schocher 	module_put(THIS_MODULE);
672ff94bc40SHeiko Schocher 
673ff94bc40SHeiko Schocher 	mtd_for_each_device(mtd)
674ff94bc40SHeiko Schocher 		old->remove(mtd);
675ff94bc40SHeiko Schocher 
676ff94bc40SHeiko Schocher 	list_del(&old->list);
677ff94bc40SHeiko Schocher 	mutex_unlock(&mtd_table_mutex);
678ff94bc40SHeiko Schocher 	return 0;
679ff94bc40SHeiko Schocher }
680ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(unregister_mtd_user);
681ff94bc40SHeiko Schocher #endif
682ff94bc40SHeiko Schocher 
683e29c22f5SKyungmin Park /**
684e29c22f5SKyungmin Park  *	get_mtd_device - obtain a validated handle for an MTD device
685e29c22f5SKyungmin Park  *	@mtd: last known address of the required MTD device
686e29c22f5SKyungmin Park  *	@num: internal device number of the required MTD device
687e29c22f5SKyungmin Park  *
688e29c22f5SKyungmin Park  *	Given a number and NULL address, return the num'th entry in the device
689e29c22f5SKyungmin Park  *	table, if any.	Given an address and num == -1, search the device table
690e29c22f5SKyungmin Park  *	for a device with that address and return if it's still present. Given
691e29c22f5SKyungmin Park  *	both, return the num'th driver only if its address matches. Return
692e29c22f5SKyungmin Park  *	error code if not.
693e29c22f5SKyungmin Park  */
694e29c22f5SKyungmin Park struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
695e29c22f5SKyungmin Park {
696ff94bc40SHeiko Schocher 	struct mtd_info *ret = NULL, *other;
697ff94bc40SHeiko Schocher 	int err = -ENODEV;
698ff94bc40SHeiko Schocher 
699ff94bc40SHeiko Schocher 	mutex_lock(&mtd_table_mutex);
700e29c22f5SKyungmin Park 
701e29c22f5SKyungmin Park 	if (num == -1) {
702ff94bc40SHeiko Schocher 		mtd_for_each_device(other) {
703ff94bc40SHeiko Schocher 			if (other == mtd) {
704ff94bc40SHeiko Schocher 				ret = mtd;
705ff94bc40SHeiko Schocher 				break;
706ff94bc40SHeiko Schocher 			}
707ff94bc40SHeiko Schocher 		}
708ff94bc40SHeiko Schocher 	} else if (num >= 0) {
709ff94bc40SHeiko Schocher 		ret = idr_find(&mtd_idr, num);
710e29c22f5SKyungmin Park 		if (mtd && mtd != ret)
711e29c22f5SKyungmin Park 			ret = NULL;
712e29c22f5SKyungmin Park 	}
713e29c22f5SKyungmin Park 
714ff94bc40SHeiko Schocher 	if (!ret) {
715ff94bc40SHeiko Schocher 		ret = ERR_PTR(err);
716ff94bc40SHeiko Schocher 		goto out;
717e29c22f5SKyungmin Park 	}
718e29c22f5SKyungmin Park 
719ff94bc40SHeiko Schocher 	err = __get_mtd_device(ret);
720ff94bc40SHeiko Schocher 	if (err)
721ff94bc40SHeiko Schocher 		ret = ERR_PTR(err);
722ff94bc40SHeiko Schocher out:
723ff94bc40SHeiko Schocher 	mutex_unlock(&mtd_table_mutex);
724ff94bc40SHeiko Schocher 	return ret;
725ff94bc40SHeiko Schocher }
726ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(get_mtd_device);
727ff94bc40SHeiko Schocher 
728ff94bc40SHeiko Schocher 
729ff94bc40SHeiko Schocher int __get_mtd_device(struct mtd_info *mtd)
730ff94bc40SHeiko Schocher {
731ff94bc40SHeiko Schocher 	int err;
732ff94bc40SHeiko Schocher 
733ff94bc40SHeiko Schocher 	if (!try_module_get(mtd->owner))
734ff94bc40SHeiko Schocher 		return -ENODEV;
735ff94bc40SHeiko Schocher 
736ff94bc40SHeiko Schocher 	if (mtd->_get_device) {
737ff94bc40SHeiko Schocher 		err = mtd->_get_device(mtd);
738ff94bc40SHeiko Schocher 
739ff94bc40SHeiko Schocher 		if (err) {
740ff94bc40SHeiko Schocher 			module_put(mtd->owner);
741ff94bc40SHeiko Schocher 			return err;
742ff94bc40SHeiko Schocher 		}
743ff94bc40SHeiko Schocher 	}
744ff94bc40SHeiko Schocher 	mtd->usecount++;
745ff94bc40SHeiko Schocher 	return 0;
746ff94bc40SHeiko Schocher }
747ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(__get_mtd_device);
748ff94bc40SHeiko Schocher 
749e29c22f5SKyungmin Park /**
750e29c22f5SKyungmin Park  *	get_mtd_device_nm - obtain a validated handle for an MTD device by
751e29c22f5SKyungmin Park  *	device name
752e29c22f5SKyungmin Park  *	@name: MTD device name to open
753e29c22f5SKyungmin Park  *
754e29c22f5SKyungmin Park  * 	This function returns MTD device description structure in case of
755e29c22f5SKyungmin Park  * 	success and an error code in case of failure.
756e29c22f5SKyungmin Park  */
757e29c22f5SKyungmin Park struct mtd_info *get_mtd_device_nm(const char *name)
758e29c22f5SKyungmin Park {
759ff94bc40SHeiko Schocher 	int err = -ENODEV;
760ff94bc40SHeiko Schocher 	struct mtd_info *mtd = NULL, *other;
761e29c22f5SKyungmin Park 
762ff94bc40SHeiko Schocher 	mutex_lock(&mtd_table_mutex);
763ff94bc40SHeiko Schocher 
764ff94bc40SHeiko Schocher 	mtd_for_each_device(other) {
765ff94bc40SHeiko Schocher 		if (!strcmp(name, other->name)) {
766ff94bc40SHeiko Schocher 			mtd = other;
767e29c22f5SKyungmin Park 			break;
768e29c22f5SKyungmin Park 		}
769e29c22f5SKyungmin Park 	}
770e29c22f5SKyungmin Park 
771e29c22f5SKyungmin Park 	if (!mtd)
772e29c22f5SKyungmin Park 		goto out_unlock;
773e29c22f5SKyungmin Park 
774ff94bc40SHeiko Schocher 	err = __get_mtd_device(mtd);
775ff94bc40SHeiko Schocher 	if (err)
776ff94bc40SHeiko Schocher 		goto out_unlock;
777ff94bc40SHeiko Schocher 
778ff94bc40SHeiko Schocher 	mutex_unlock(&mtd_table_mutex);
779e29c22f5SKyungmin Park 	return mtd;
780e29c22f5SKyungmin Park 
781e29c22f5SKyungmin Park out_unlock:
782ff94bc40SHeiko Schocher 	mutex_unlock(&mtd_table_mutex);
783e29c22f5SKyungmin Park 	return ERR_PTR(err);
784e29c22f5SKyungmin Park }
785ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(get_mtd_device_nm);
7864ba692fbSBen Gardiner 
7874ba692fbSBen Gardiner #if defined(CONFIG_CMD_MTDPARTS_SPREAD)
7884ba692fbSBen Gardiner /**
7894ba692fbSBen Gardiner  * mtd_get_len_incl_bad
7904ba692fbSBen Gardiner  *
7914ba692fbSBen Gardiner  * Check if length including bad blocks fits into device.
7924ba692fbSBen Gardiner  *
7934ba692fbSBen Gardiner  * @param mtd an MTD device
7944ba692fbSBen Gardiner  * @param offset offset in flash
7954ba692fbSBen Gardiner  * @param length image length
7964ba692fbSBen Gardiner  * @return image length including bad blocks in *len_incl_bad and whether or not
7974ba692fbSBen Gardiner  *         the length returned was truncated in *truncated
7984ba692fbSBen Gardiner  */
7994ba692fbSBen Gardiner void mtd_get_len_incl_bad(struct mtd_info *mtd, uint64_t offset,
8004ba692fbSBen Gardiner 			  const uint64_t length, uint64_t *len_incl_bad,
8014ba692fbSBen Gardiner 			  int *truncated)
8024ba692fbSBen Gardiner {
8034ba692fbSBen Gardiner 	*truncated = 0;
8044ba692fbSBen Gardiner 	*len_incl_bad = 0;
8054ba692fbSBen Gardiner 
8065da163d6Smaxin.john@enea.com 	if (!mtd->_block_isbad) {
8074ba692fbSBen Gardiner 		*len_incl_bad = length;
8084ba692fbSBen Gardiner 		return;
8094ba692fbSBen Gardiner 	}
8104ba692fbSBen Gardiner 
8114ba692fbSBen Gardiner 	uint64_t len_excl_bad = 0;
8124ba692fbSBen Gardiner 	uint64_t block_len;
8134ba692fbSBen Gardiner 
8144ba692fbSBen Gardiner 	while (len_excl_bad < length) {
81536650ca9SScott Wood 		if (offset >= mtd->size) {
81636650ca9SScott Wood 			*truncated = 1;
81736650ca9SScott Wood 			return;
81836650ca9SScott Wood 		}
81936650ca9SScott Wood 
8204ba692fbSBen Gardiner 		block_len = mtd->erasesize - (offset & (mtd->erasesize - 1));
8214ba692fbSBen Gardiner 
8225da163d6Smaxin.john@enea.com 		if (!mtd->_block_isbad(mtd, offset & ~(mtd->erasesize - 1)))
8234ba692fbSBen Gardiner 			len_excl_bad += block_len;
8244ba692fbSBen Gardiner 
8254ba692fbSBen Gardiner 		*len_incl_bad += block_len;
8264ba692fbSBen Gardiner 		offset       += block_len;
8274ba692fbSBen Gardiner 	}
8284ba692fbSBen Gardiner }
8294ba692fbSBen Gardiner #endif /* defined(CONFIG_CMD_MTDPARTS_SPREAD) */
830dfe64e2cSSergey Lapin 
831ff94bc40SHeiko Schocher void put_mtd_device(struct mtd_info *mtd)
832ff94bc40SHeiko Schocher {
833ff94bc40SHeiko Schocher 	mutex_lock(&mtd_table_mutex);
834ff94bc40SHeiko Schocher 	__put_mtd_device(mtd);
835ff94bc40SHeiko Schocher 	mutex_unlock(&mtd_table_mutex);
836ff94bc40SHeiko Schocher 
837ff94bc40SHeiko Schocher }
838ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(put_mtd_device);
839ff94bc40SHeiko Schocher 
840ff94bc40SHeiko Schocher void __put_mtd_device(struct mtd_info *mtd)
841ff94bc40SHeiko Schocher {
842ff94bc40SHeiko Schocher 	--mtd->usecount;
843ff94bc40SHeiko Schocher 	BUG_ON(mtd->usecount < 0);
844ff94bc40SHeiko Schocher 
845ff94bc40SHeiko Schocher 	if (mtd->_put_device)
846ff94bc40SHeiko Schocher 		mtd->_put_device(mtd);
847ff94bc40SHeiko Schocher 
848ff94bc40SHeiko Schocher 	module_put(mtd->owner);
849ff94bc40SHeiko Schocher }
850ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(__put_mtd_device);
851ff94bc40SHeiko Schocher 
852dfe64e2cSSergey Lapin /*
853dfe64e2cSSergey Lapin  * Erase is an asynchronous operation.  Device drivers are supposed
854dfe64e2cSSergey Lapin  * to call instr->callback() whenever the operation completes, even
855dfe64e2cSSergey Lapin  * if it completes with a failure.
856dfe64e2cSSergey Lapin  * Callers are supposed to pass a callback function and wait for it
857dfe64e2cSSergey Lapin  * to be called before writing to the block.
858dfe64e2cSSergey Lapin  */
859dfe64e2cSSergey Lapin int mtd_erase(struct mtd_info *mtd, struct erase_info *instr)
860dfe64e2cSSergey Lapin {
861dfe64e2cSSergey Lapin 	if (instr->addr > mtd->size || instr->len > mtd->size - instr->addr)
862dfe64e2cSSergey Lapin 		return -EINVAL;
863dfe64e2cSSergey Lapin 	if (!(mtd->flags & MTD_WRITEABLE))
864dfe64e2cSSergey Lapin 		return -EROFS;
865dfe64e2cSSergey Lapin 	instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
866dfe64e2cSSergey Lapin 	if (!instr->len) {
867dfe64e2cSSergey Lapin 		instr->state = MTD_ERASE_DONE;
868dfe64e2cSSergey Lapin 		mtd_erase_callback(instr);
869dfe64e2cSSergey Lapin 		return 0;
870dfe64e2cSSergey Lapin 	}
871dfe64e2cSSergey Lapin 	return mtd->_erase(mtd, instr);
872dfe64e2cSSergey Lapin }
873ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_erase);
874ff94bc40SHeiko Schocher 
875ff94bc40SHeiko Schocher #ifndef __UBOOT__
876ff94bc40SHeiko Schocher /*
877ff94bc40SHeiko Schocher  * This stuff for eXecute-In-Place. phys is optional and may be set to NULL.
878ff94bc40SHeiko Schocher  */
879ff94bc40SHeiko Schocher int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
880ff94bc40SHeiko Schocher 	      void **virt, resource_size_t *phys)
881ff94bc40SHeiko Schocher {
882ff94bc40SHeiko Schocher 	*retlen = 0;
883ff94bc40SHeiko Schocher 	*virt = NULL;
884ff94bc40SHeiko Schocher 	if (phys)
885ff94bc40SHeiko Schocher 		*phys = 0;
886ff94bc40SHeiko Schocher 	if (!mtd->_point)
887ff94bc40SHeiko Schocher 		return -EOPNOTSUPP;
888ff94bc40SHeiko Schocher 	if (from < 0 || from > mtd->size || len > mtd->size - from)
889ff94bc40SHeiko Schocher 		return -EINVAL;
890ff94bc40SHeiko Schocher 	if (!len)
891ff94bc40SHeiko Schocher 		return 0;
892ff94bc40SHeiko Schocher 	return mtd->_point(mtd, from, len, retlen, virt, phys);
893ff94bc40SHeiko Schocher }
894ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_point);
895ff94bc40SHeiko Schocher 
896ff94bc40SHeiko Schocher /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
897ff94bc40SHeiko Schocher int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len)
898ff94bc40SHeiko Schocher {
899ff94bc40SHeiko Schocher 	if (!mtd->_point)
900ff94bc40SHeiko Schocher 		return -EOPNOTSUPP;
901ff94bc40SHeiko Schocher 	if (from < 0 || from > mtd->size || len > mtd->size - from)
902ff94bc40SHeiko Schocher 		return -EINVAL;
903ff94bc40SHeiko Schocher 	if (!len)
904ff94bc40SHeiko Schocher 		return 0;
905ff94bc40SHeiko Schocher 	return mtd->_unpoint(mtd, from, len);
906ff94bc40SHeiko Schocher }
907ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_unpoint);
908ff94bc40SHeiko Schocher #endif
909ff94bc40SHeiko Schocher 
910ff94bc40SHeiko Schocher /*
911ff94bc40SHeiko Schocher  * Allow NOMMU mmap() to directly map the device (if not NULL)
912ff94bc40SHeiko Schocher  * - return the address to which the offset maps
913ff94bc40SHeiko Schocher  * - return -ENOSYS to indicate refusal to do the mapping
914ff94bc40SHeiko Schocher  */
915ff94bc40SHeiko Schocher unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
916ff94bc40SHeiko Schocher 				    unsigned long offset, unsigned long flags)
917ff94bc40SHeiko Schocher {
918ff94bc40SHeiko Schocher 	if (!mtd->_get_unmapped_area)
919ff94bc40SHeiko Schocher 		return -EOPNOTSUPP;
920ff94bc40SHeiko Schocher 	if (offset > mtd->size || len > mtd->size - offset)
921ff94bc40SHeiko Schocher 		return -EINVAL;
922ff94bc40SHeiko Schocher 	return mtd->_get_unmapped_area(mtd, len, offset, flags);
923ff94bc40SHeiko Schocher }
924ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_get_unmapped_area);
925dfe64e2cSSergey Lapin 
926dfe64e2cSSergey Lapin int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
927dfe64e2cSSergey Lapin 	     u_char *buf)
928dfe64e2cSSergey Lapin {
92940462e54SPaul Burton 	int ret_code;
930ff94bc40SHeiko Schocher 	*retlen = 0;
931dfe64e2cSSergey Lapin 	if (from < 0 || from > mtd->size || len > mtd->size - from)
932dfe64e2cSSergey Lapin 		return -EINVAL;
933dfe64e2cSSergey Lapin 	if (!len)
934dfe64e2cSSergey Lapin 		return 0;
93540462e54SPaul Burton 
93640462e54SPaul Burton 	/*
93740462e54SPaul Burton 	 * In the absence of an error, drivers return a non-negative integer
93840462e54SPaul Burton 	 * representing the maximum number of bitflips that were corrected on
93940462e54SPaul Burton 	 * any one ecc region (if applicable; zero otherwise).
94040462e54SPaul Burton 	 */
941042673efSBoris Brezillon 	if (mtd->_read) {
94240462e54SPaul Burton 		ret_code = mtd->_read(mtd, from, len, retlen, buf);
943042673efSBoris Brezillon 	} else if (mtd->_read_oob) {
944042673efSBoris Brezillon 		struct mtd_oob_ops ops = {
945042673efSBoris Brezillon 			.len = len,
946042673efSBoris Brezillon 			.datbuf = buf,
947042673efSBoris Brezillon 		};
948042673efSBoris Brezillon 
949042673efSBoris Brezillon 		ret_code = mtd->_read_oob(mtd, from, &ops);
950042673efSBoris Brezillon 		*retlen = ops.retlen;
951042673efSBoris Brezillon 	} else {
952042673efSBoris Brezillon 		return -ENOTSUPP;
953042673efSBoris Brezillon 	}
954042673efSBoris Brezillon 
95540462e54SPaul Burton 	if (unlikely(ret_code < 0))
95640462e54SPaul Burton 		return ret_code;
95740462e54SPaul Burton 	if (mtd->ecc_strength == 0)
95840462e54SPaul Burton 		return 0;	/* device lacks ecc */
95940462e54SPaul Burton 	return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0;
960dfe64e2cSSergey Lapin }
961ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_read);
962dfe64e2cSSergey Lapin 
963dfe64e2cSSergey Lapin int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
964dfe64e2cSSergey Lapin 	      const u_char *buf)
965dfe64e2cSSergey Lapin {
966dfe64e2cSSergey Lapin 	*retlen = 0;
967dfe64e2cSSergey Lapin 	if (to < 0 || to > mtd->size || len > mtd->size - to)
968dfe64e2cSSergey Lapin 		return -EINVAL;
969042673efSBoris Brezillon 	if ((!mtd->_write && !mtd->_write_oob) ||
970042673efSBoris Brezillon 	    !(mtd->flags & MTD_WRITEABLE))
971dfe64e2cSSergey Lapin 		return -EROFS;
972dfe64e2cSSergey Lapin 	if (!len)
973dfe64e2cSSergey Lapin 		return 0;
974042673efSBoris Brezillon 
975042673efSBoris Brezillon 	if (!mtd->_write) {
976042673efSBoris Brezillon 		struct mtd_oob_ops ops = {
977042673efSBoris Brezillon 			.len = len,
978042673efSBoris Brezillon 			.datbuf = (u8 *)buf,
979042673efSBoris Brezillon 		};
980042673efSBoris Brezillon 		int ret;
981042673efSBoris Brezillon 
982042673efSBoris Brezillon 		ret = mtd->_write_oob(mtd, to, &ops);
983042673efSBoris Brezillon 		*retlen = ops.retlen;
984042673efSBoris Brezillon 		return ret;
985042673efSBoris Brezillon 	}
986042673efSBoris Brezillon 
987dfe64e2cSSergey Lapin 	return mtd->_write(mtd, to, len, retlen, buf);
988dfe64e2cSSergey Lapin }
989ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_write);
990dfe64e2cSSergey Lapin 
991dfe64e2cSSergey Lapin /*
992dfe64e2cSSergey Lapin  * In blackbox flight recorder like scenarios we want to make successful writes
993dfe64e2cSSergey Lapin  * in interrupt context. panic_write() is only intended to be called when its
994dfe64e2cSSergey Lapin  * known the kernel is about to panic and we need the write to succeed. Since
995dfe64e2cSSergey Lapin  * the kernel is not going to be running for much longer, this function can
996dfe64e2cSSergey Lapin  * break locks and delay to ensure the write succeeds (but not sleep).
997dfe64e2cSSergey Lapin  */
998dfe64e2cSSergey Lapin int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
999dfe64e2cSSergey Lapin 		    const u_char *buf)
1000dfe64e2cSSergey Lapin {
1001dfe64e2cSSergey Lapin 	*retlen = 0;
1002dfe64e2cSSergey Lapin 	if (!mtd->_panic_write)
1003dfe64e2cSSergey Lapin 		return -EOPNOTSUPP;
1004dfe64e2cSSergey Lapin 	if (to < 0 || to > mtd->size || len > mtd->size - to)
1005dfe64e2cSSergey Lapin 		return -EINVAL;
1006dfe64e2cSSergey Lapin 	if (!(mtd->flags & MTD_WRITEABLE))
1007dfe64e2cSSergey Lapin 		return -EROFS;
1008dfe64e2cSSergey Lapin 	if (!len)
1009dfe64e2cSSergey Lapin 		return 0;
1010dfe64e2cSSergey Lapin 	return mtd->_panic_write(mtd, to, len, retlen, buf);
1011dfe64e2cSSergey Lapin }
1012ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_panic_write);
1013dfe64e2cSSergey Lapin 
1014*300aab2aSBoris Brezillon static int mtd_check_oob_ops(struct mtd_info *mtd, loff_t offs,
1015*300aab2aSBoris Brezillon 			     struct mtd_oob_ops *ops)
1016*300aab2aSBoris Brezillon {
1017*300aab2aSBoris Brezillon 	/*
1018*300aab2aSBoris Brezillon 	 * Some users are setting ->datbuf or ->oobbuf to NULL, but are leaving
1019*300aab2aSBoris Brezillon 	 * ->len or ->ooblen uninitialized. Force ->len and ->ooblen to 0 in
1020*300aab2aSBoris Brezillon 	 *  this case.
1021*300aab2aSBoris Brezillon 	 */
1022*300aab2aSBoris Brezillon 	if (!ops->datbuf)
1023*300aab2aSBoris Brezillon 		ops->len = 0;
1024*300aab2aSBoris Brezillon 
1025*300aab2aSBoris Brezillon 	if (!ops->oobbuf)
1026*300aab2aSBoris Brezillon 		ops->ooblen = 0;
1027*300aab2aSBoris Brezillon 
1028*300aab2aSBoris Brezillon 	if (offs < 0 || offs + ops->len > mtd->size)
1029*300aab2aSBoris Brezillon 		return -EINVAL;
1030*300aab2aSBoris Brezillon 
1031*300aab2aSBoris Brezillon 	if (ops->ooblen) {
1032*300aab2aSBoris Brezillon 		u64 maxooblen;
1033*300aab2aSBoris Brezillon 
1034*300aab2aSBoris Brezillon 		if (ops->ooboffs >= mtd_oobavail(mtd, ops))
1035*300aab2aSBoris Brezillon 			return -EINVAL;
1036*300aab2aSBoris Brezillon 
1037*300aab2aSBoris Brezillon 		maxooblen = ((mtd_div_by_ws(mtd->size, mtd) -
1038*300aab2aSBoris Brezillon 			      mtd_div_by_ws(offs, mtd)) *
1039*300aab2aSBoris Brezillon 			     mtd_oobavail(mtd, ops)) - ops->ooboffs;
1040*300aab2aSBoris Brezillon 		if (ops->ooblen > maxooblen)
1041*300aab2aSBoris Brezillon 			return -EINVAL;
1042*300aab2aSBoris Brezillon 	}
1043*300aab2aSBoris Brezillon 
1044*300aab2aSBoris Brezillon 	return 0;
1045*300aab2aSBoris Brezillon }
1046*300aab2aSBoris Brezillon 
1047dfe64e2cSSergey Lapin int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops)
1048dfe64e2cSSergey Lapin {
1049ff94bc40SHeiko Schocher 	int ret_code;
1050dfe64e2cSSergey Lapin 	ops->retlen = ops->oobretlen = 0;
1051dfe64e2cSSergey Lapin 	if (!mtd->_read_oob)
1052dfe64e2cSSergey Lapin 		return -EOPNOTSUPP;
1053*300aab2aSBoris Brezillon 
1054*300aab2aSBoris Brezillon 	ret_code = mtd_check_oob_ops(mtd, from, ops);
1055*300aab2aSBoris Brezillon 	if (ret_code)
1056*300aab2aSBoris Brezillon 		return ret_code;
1057*300aab2aSBoris Brezillon 
1058ff94bc40SHeiko Schocher 	/*
1059ff94bc40SHeiko Schocher 	 * In cases where ops->datbuf != NULL, mtd->_read_oob() has semantics
1060ff94bc40SHeiko Schocher 	 * similar to mtd->_read(), returning a non-negative integer
1061ff94bc40SHeiko Schocher 	 * representing max bitflips. In other cases, mtd->_read_oob() may
1062ff94bc40SHeiko Schocher 	 * return -EUCLEAN. In all cases, perform similar logic to mtd_read().
1063ff94bc40SHeiko Schocher 	 */
1064ff94bc40SHeiko Schocher 	ret_code = mtd->_read_oob(mtd, from, ops);
1065ff94bc40SHeiko Schocher 	if (unlikely(ret_code < 0))
1066ff94bc40SHeiko Schocher 		return ret_code;
1067ff94bc40SHeiko Schocher 	if (mtd->ecc_strength == 0)
1068ff94bc40SHeiko Schocher 		return 0;	/* device lacks ecc */
1069ff94bc40SHeiko Schocher 	return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0;
1070dfe64e2cSSergey Lapin }
1071ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_read_oob);
1072dfe64e2cSSergey Lapin 
107386db6a45SEzequiel Garcia int mtd_write_oob(struct mtd_info *mtd, loff_t to,
107486db6a45SEzequiel Garcia 				struct mtd_oob_ops *ops)
107586db6a45SEzequiel Garcia {
1076*300aab2aSBoris Brezillon 	int ret;
1077*300aab2aSBoris Brezillon 
107886db6a45SEzequiel Garcia 	ops->retlen = ops->oobretlen = 0;
107986db6a45SEzequiel Garcia 	if (!mtd->_write_oob)
108086db6a45SEzequiel Garcia 		return -EOPNOTSUPP;
108186db6a45SEzequiel Garcia 	if (!(mtd->flags & MTD_WRITEABLE))
108286db6a45SEzequiel Garcia 		return -EROFS;
1083*300aab2aSBoris Brezillon 
1084*300aab2aSBoris Brezillon 	ret = mtd_check_oob_ops(mtd, to, ops);
1085*300aab2aSBoris Brezillon 	if (ret)
1086*300aab2aSBoris Brezillon 		return ret;
1087*300aab2aSBoris Brezillon 
108886db6a45SEzequiel Garcia 	return mtd->_write_oob(mtd, to, ops);
108986db6a45SEzequiel Garcia }
109086db6a45SEzequiel Garcia EXPORT_SYMBOL_GPL(mtd_write_oob);
109186db6a45SEzequiel Garcia 
1092c44c4cceSBoris Brezillon /**
1093c44c4cceSBoris Brezillon  * mtd_ooblayout_ecc - Get the OOB region definition of a specific ECC section
1094c44c4cceSBoris Brezillon  * @mtd: MTD device structure
1095c44c4cceSBoris Brezillon  * @section: ECC section. Depending on the layout you may have all the ECC
1096c44c4cceSBoris Brezillon  *	     bytes stored in a single contiguous section, or one section
1097c44c4cceSBoris Brezillon  *	     per ECC chunk (and sometime several sections for a single ECC
1098c44c4cceSBoris Brezillon  *	     ECC chunk)
1099c44c4cceSBoris Brezillon  * @oobecc: OOB region struct filled with the appropriate ECC position
1100c44c4cceSBoris Brezillon  *	    information
1101c44c4cceSBoris Brezillon  *
1102c44c4cceSBoris Brezillon  * This function returns ECC section information in the OOB area. If you want
1103c44c4cceSBoris Brezillon  * to get all the ECC bytes information, then you should call
1104c44c4cceSBoris Brezillon  * mtd_ooblayout_ecc(mtd, section++, oobecc) until it returns -ERANGE.
1105c44c4cceSBoris Brezillon  *
1106c44c4cceSBoris Brezillon  * Returns zero on success, a negative error code otherwise.
1107c44c4cceSBoris Brezillon  */
1108c44c4cceSBoris Brezillon int mtd_ooblayout_ecc(struct mtd_info *mtd, int section,
1109c44c4cceSBoris Brezillon 		      struct mtd_oob_region *oobecc)
1110c44c4cceSBoris Brezillon {
1111c44c4cceSBoris Brezillon 	memset(oobecc, 0, sizeof(*oobecc));
1112c44c4cceSBoris Brezillon 
1113c44c4cceSBoris Brezillon 	if (!mtd || section < 0)
1114c44c4cceSBoris Brezillon 		return -EINVAL;
1115c44c4cceSBoris Brezillon 
1116c44c4cceSBoris Brezillon 	if (!mtd->ooblayout || !mtd->ooblayout->ecc)
1117c44c4cceSBoris Brezillon 		return -ENOTSUPP;
1118c44c4cceSBoris Brezillon 
1119c44c4cceSBoris Brezillon 	return mtd->ooblayout->ecc(mtd, section, oobecc);
1120c44c4cceSBoris Brezillon }
1121c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_ecc);
1122c44c4cceSBoris Brezillon 
1123c44c4cceSBoris Brezillon /**
1124c44c4cceSBoris Brezillon  * mtd_ooblayout_free - Get the OOB region definition of a specific free
1125c44c4cceSBoris Brezillon  *			section
1126c44c4cceSBoris Brezillon  * @mtd: MTD device structure
1127c44c4cceSBoris Brezillon  * @section: Free section you are interested in. Depending on the layout
1128c44c4cceSBoris Brezillon  *	     you may have all the free bytes stored in a single contiguous
1129c44c4cceSBoris Brezillon  *	     section, or one section per ECC chunk plus an extra section
1130c44c4cceSBoris Brezillon  *	     for the remaining bytes (or other funky layout).
1131c44c4cceSBoris Brezillon  * @oobfree: OOB region struct filled with the appropriate free position
1132c44c4cceSBoris Brezillon  *	     information
1133c44c4cceSBoris Brezillon  *
1134c44c4cceSBoris Brezillon  * This function returns free bytes position in the OOB area. If you want
1135c44c4cceSBoris Brezillon  * to get all the free bytes information, then you should call
1136c44c4cceSBoris Brezillon  * mtd_ooblayout_free(mtd, section++, oobfree) until it returns -ERANGE.
1137c44c4cceSBoris Brezillon  *
1138c44c4cceSBoris Brezillon  * Returns zero on success, a negative error code otherwise.
1139c44c4cceSBoris Brezillon  */
1140c44c4cceSBoris Brezillon int mtd_ooblayout_free(struct mtd_info *mtd, int section,
1141c44c4cceSBoris Brezillon 		       struct mtd_oob_region *oobfree)
1142c44c4cceSBoris Brezillon {
1143c44c4cceSBoris Brezillon 	memset(oobfree, 0, sizeof(*oobfree));
1144c44c4cceSBoris Brezillon 
1145c44c4cceSBoris Brezillon 	if (!mtd || section < 0)
1146c44c4cceSBoris Brezillon 		return -EINVAL;
1147c44c4cceSBoris Brezillon 
1148c44c4cceSBoris Brezillon 	if (!mtd->ooblayout || !mtd->ooblayout->free)
1149c44c4cceSBoris Brezillon 		return -ENOTSUPP;
1150c44c4cceSBoris Brezillon 
1151c44c4cceSBoris Brezillon 	return mtd->ooblayout->free(mtd, section, oobfree);
1152c44c4cceSBoris Brezillon }
1153c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_free);
1154c44c4cceSBoris Brezillon 
1155c44c4cceSBoris Brezillon /**
1156c44c4cceSBoris Brezillon  * mtd_ooblayout_find_region - Find the region attached to a specific byte
1157c44c4cceSBoris Brezillon  * @mtd: mtd info structure
1158c44c4cceSBoris Brezillon  * @byte: the byte we are searching for
1159c44c4cceSBoris Brezillon  * @sectionp: pointer where the section id will be stored
1160c44c4cceSBoris Brezillon  * @oobregion: used to retrieve the ECC position
1161c44c4cceSBoris Brezillon  * @iter: iterator function. Should be either mtd_ooblayout_free or
1162c44c4cceSBoris Brezillon  *	  mtd_ooblayout_ecc depending on the region type you're searching for
1163c44c4cceSBoris Brezillon  *
1164c44c4cceSBoris Brezillon  * This function returns the section id and oobregion information of a
1165c44c4cceSBoris Brezillon  * specific byte. For example, say you want to know where the 4th ECC byte is
1166c44c4cceSBoris Brezillon  * stored, you'll use:
1167c44c4cceSBoris Brezillon  *
1168c44c4cceSBoris Brezillon  * mtd_ooblayout_find_region(mtd, 3, &section, &oobregion, mtd_ooblayout_ecc);
1169c44c4cceSBoris Brezillon  *
1170c44c4cceSBoris Brezillon  * Returns zero on success, a negative error code otherwise.
1171c44c4cceSBoris Brezillon  */
1172c44c4cceSBoris Brezillon static int mtd_ooblayout_find_region(struct mtd_info *mtd, int byte,
1173c44c4cceSBoris Brezillon 				int *sectionp, struct mtd_oob_region *oobregion,
1174c44c4cceSBoris Brezillon 				int (*iter)(struct mtd_info *,
1175c44c4cceSBoris Brezillon 					    int section,
1176c44c4cceSBoris Brezillon 					    struct mtd_oob_region *oobregion))
1177c44c4cceSBoris Brezillon {
1178c44c4cceSBoris Brezillon 	int pos = 0, ret, section = 0;
1179c44c4cceSBoris Brezillon 
1180c44c4cceSBoris Brezillon 	memset(oobregion, 0, sizeof(*oobregion));
1181c44c4cceSBoris Brezillon 
1182c44c4cceSBoris Brezillon 	while (1) {
1183c44c4cceSBoris Brezillon 		ret = iter(mtd, section, oobregion);
1184c44c4cceSBoris Brezillon 		if (ret)
1185c44c4cceSBoris Brezillon 			return ret;
1186c44c4cceSBoris Brezillon 
1187c44c4cceSBoris Brezillon 		if (pos + oobregion->length > byte)
1188c44c4cceSBoris Brezillon 			break;
1189c44c4cceSBoris Brezillon 
1190c44c4cceSBoris Brezillon 		pos += oobregion->length;
1191c44c4cceSBoris Brezillon 		section++;
1192c44c4cceSBoris Brezillon 	}
1193c44c4cceSBoris Brezillon 
1194c44c4cceSBoris Brezillon 	/*
1195c44c4cceSBoris Brezillon 	 * Adjust region info to make it start at the beginning at the
1196c44c4cceSBoris Brezillon 	 * 'start' ECC byte.
1197c44c4cceSBoris Brezillon 	 */
1198c44c4cceSBoris Brezillon 	oobregion->offset += byte - pos;
1199c44c4cceSBoris Brezillon 	oobregion->length -= byte - pos;
1200c44c4cceSBoris Brezillon 	*sectionp = section;
1201c44c4cceSBoris Brezillon 
1202c44c4cceSBoris Brezillon 	return 0;
1203c44c4cceSBoris Brezillon }
1204c44c4cceSBoris Brezillon 
1205c44c4cceSBoris Brezillon /**
1206c44c4cceSBoris Brezillon  * mtd_ooblayout_find_eccregion - Find the ECC region attached to a specific
1207c44c4cceSBoris Brezillon  *				  ECC byte
1208c44c4cceSBoris Brezillon  * @mtd: mtd info structure
1209c44c4cceSBoris Brezillon  * @eccbyte: the byte we are searching for
1210c44c4cceSBoris Brezillon  * @sectionp: pointer where the section id will be stored
1211c44c4cceSBoris Brezillon  * @oobregion: OOB region information
1212c44c4cceSBoris Brezillon  *
1213c44c4cceSBoris Brezillon  * Works like mtd_ooblayout_find_region() except it searches for a specific ECC
1214c44c4cceSBoris Brezillon  * byte.
1215c44c4cceSBoris Brezillon  *
1216c44c4cceSBoris Brezillon  * Returns zero on success, a negative error code otherwise.
1217c44c4cceSBoris Brezillon  */
1218c44c4cceSBoris Brezillon int mtd_ooblayout_find_eccregion(struct mtd_info *mtd, int eccbyte,
1219c44c4cceSBoris Brezillon 				 int *section,
1220c44c4cceSBoris Brezillon 				 struct mtd_oob_region *oobregion)
1221c44c4cceSBoris Brezillon {
1222c44c4cceSBoris Brezillon 	return mtd_ooblayout_find_region(mtd, eccbyte, section, oobregion,
1223c44c4cceSBoris Brezillon 					 mtd_ooblayout_ecc);
1224c44c4cceSBoris Brezillon }
1225c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_find_eccregion);
1226c44c4cceSBoris Brezillon 
1227c44c4cceSBoris Brezillon /**
1228c44c4cceSBoris Brezillon  * mtd_ooblayout_get_bytes - Extract OOB bytes from the oob buffer
1229c44c4cceSBoris Brezillon  * @mtd: mtd info structure
1230c44c4cceSBoris Brezillon  * @buf: destination buffer to store OOB bytes
1231c44c4cceSBoris Brezillon  * @oobbuf: OOB buffer
1232c44c4cceSBoris Brezillon  * @start: first byte to retrieve
1233c44c4cceSBoris Brezillon  * @nbytes: number of bytes to retrieve
1234c44c4cceSBoris Brezillon  * @iter: section iterator
1235c44c4cceSBoris Brezillon  *
1236c44c4cceSBoris Brezillon  * Extract bytes attached to a specific category (ECC or free)
1237c44c4cceSBoris Brezillon  * from the OOB buffer and copy them into buf.
1238c44c4cceSBoris Brezillon  *
1239c44c4cceSBoris Brezillon  * Returns zero on success, a negative error code otherwise.
1240c44c4cceSBoris Brezillon  */
1241c44c4cceSBoris Brezillon static int mtd_ooblayout_get_bytes(struct mtd_info *mtd, u8 *buf,
1242c44c4cceSBoris Brezillon 				const u8 *oobbuf, int start, int nbytes,
1243c44c4cceSBoris Brezillon 				int (*iter)(struct mtd_info *,
1244c44c4cceSBoris Brezillon 					    int section,
1245c44c4cceSBoris Brezillon 					    struct mtd_oob_region *oobregion))
1246c44c4cceSBoris Brezillon {
1247c44c4cceSBoris Brezillon 	struct mtd_oob_region oobregion;
1248c44c4cceSBoris Brezillon 	int section, ret;
1249c44c4cceSBoris Brezillon 
1250c44c4cceSBoris Brezillon 	ret = mtd_ooblayout_find_region(mtd, start, &section,
1251c44c4cceSBoris Brezillon 					&oobregion, iter);
1252c44c4cceSBoris Brezillon 
1253c44c4cceSBoris Brezillon 	while (!ret) {
1254c44c4cceSBoris Brezillon 		int cnt;
1255c44c4cceSBoris Brezillon 
1256c44c4cceSBoris Brezillon 		cnt = min_t(int, nbytes, oobregion.length);
1257c44c4cceSBoris Brezillon 		memcpy(buf, oobbuf + oobregion.offset, cnt);
1258c44c4cceSBoris Brezillon 		buf += cnt;
1259c44c4cceSBoris Brezillon 		nbytes -= cnt;
1260c44c4cceSBoris Brezillon 
1261c44c4cceSBoris Brezillon 		if (!nbytes)
1262c44c4cceSBoris Brezillon 			break;
1263c44c4cceSBoris Brezillon 
1264c44c4cceSBoris Brezillon 		ret = iter(mtd, ++section, &oobregion);
1265c44c4cceSBoris Brezillon 	}
1266c44c4cceSBoris Brezillon 
1267c44c4cceSBoris Brezillon 	return ret;
1268c44c4cceSBoris Brezillon }
1269c44c4cceSBoris Brezillon 
1270c44c4cceSBoris Brezillon /**
1271c44c4cceSBoris Brezillon  * mtd_ooblayout_set_bytes - put OOB bytes into the oob buffer
1272c44c4cceSBoris Brezillon  * @mtd: mtd info structure
1273c44c4cceSBoris Brezillon  * @buf: source buffer to get OOB bytes from
1274c44c4cceSBoris Brezillon  * @oobbuf: OOB buffer
1275c44c4cceSBoris Brezillon  * @start: first OOB byte to set
1276c44c4cceSBoris Brezillon  * @nbytes: number of OOB bytes to set
1277c44c4cceSBoris Brezillon  * @iter: section iterator
1278c44c4cceSBoris Brezillon  *
1279c44c4cceSBoris Brezillon  * Fill the OOB buffer with data provided in buf. The category (ECC or free)
1280c44c4cceSBoris Brezillon  * is selected by passing the appropriate iterator.
1281c44c4cceSBoris Brezillon  *
1282c44c4cceSBoris Brezillon  * Returns zero on success, a negative error code otherwise.
1283c44c4cceSBoris Brezillon  */
1284c44c4cceSBoris Brezillon static int mtd_ooblayout_set_bytes(struct mtd_info *mtd, const u8 *buf,
1285c44c4cceSBoris Brezillon 				u8 *oobbuf, int start, int nbytes,
1286c44c4cceSBoris Brezillon 				int (*iter)(struct mtd_info *,
1287c44c4cceSBoris Brezillon 					    int section,
1288c44c4cceSBoris Brezillon 					    struct mtd_oob_region *oobregion))
1289c44c4cceSBoris Brezillon {
1290c44c4cceSBoris Brezillon 	struct mtd_oob_region oobregion;
1291c44c4cceSBoris Brezillon 	int section, ret;
1292c44c4cceSBoris Brezillon 
1293c44c4cceSBoris Brezillon 	ret = mtd_ooblayout_find_region(mtd, start, &section,
1294c44c4cceSBoris Brezillon 					&oobregion, iter);
1295c44c4cceSBoris Brezillon 
1296c44c4cceSBoris Brezillon 	while (!ret) {
1297c44c4cceSBoris Brezillon 		int cnt;
1298c44c4cceSBoris Brezillon 
1299c44c4cceSBoris Brezillon 		cnt = min_t(int, nbytes, oobregion.length);
1300c44c4cceSBoris Brezillon 		memcpy(oobbuf + oobregion.offset, buf, cnt);
1301c44c4cceSBoris Brezillon 		buf += cnt;
1302c44c4cceSBoris Brezillon 		nbytes -= cnt;
1303c44c4cceSBoris Brezillon 
1304c44c4cceSBoris Brezillon 		if (!nbytes)
1305c44c4cceSBoris Brezillon 			break;
1306c44c4cceSBoris Brezillon 
1307c44c4cceSBoris Brezillon 		ret = iter(mtd, ++section, &oobregion);
1308c44c4cceSBoris Brezillon 	}
1309c44c4cceSBoris Brezillon 
1310c44c4cceSBoris Brezillon 	return ret;
1311c44c4cceSBoris Brezillon }
1312c44c4cceSBoris Brezillon 
1313c44c4cceSBoris Brezillon /**
1314c44c4cceSBoris Brezillon  * mtd_ooblayout_count_bytes - count the number of bytes in a OOB category
1315c44c4cceSBoris Brezillon  * @mtd: mtd info structure
1316c44c4cceSBoris Brezillon  * @iter: category iterator
1317c44c4cceSBoris Brezillon  *
1318c44c4cceSBoris Brezillon  * Count the number of bytes in a given category.
1319c44c4cceSBoris Brezillon  *
1320c44c4cceSBoris Brezillon  * Returns a positive value on success, a negative error code otherwise.
1321c44c4cceSBoris Brezillon  */
1322c44c4cceSBoris Brezillon static int mtd_ooblayout_count_bytes(struct mtd_info *mtd,
1323c44c4cceSBoris Brezillon 				int (*iter)(struct mtd_info *,
1324c44c4cceSBoris Brezillon 					    int section,
1325c44c4cceSBoris Brezillon 					    struct mtd_oob_region *oobregion))
1326c44c4cceSBoris Brezillon {
1327c44c4cceSBoris Brezillon 	struct mtd_oob_region oobregion;
1328c44c4cceSBoris Brezillon 	int section = 0, ret, nbytes = 0;
1329c44c4cceSBoris Brezillon 
1330c44c4cceSBoris Brezillon 	while (1) {
1331c44c4cceSBoris Brezillon 		ret = iter(mtd, section++, &oobregion);
1332c44c4cceSBoris Brezillon 		if (ret) {
1333c44c4cceSBoris Brezillon 			if (ret == -ERANGE)
1334c44c4cceSBoris Brezillon 				ret = nbytes;
1335c44c4cceSBoris Brezillon 			break;
1336c44c4cceSBoris Brezillon 		}
1337c44c4cceSBoris Brezillon 
1338c44c4cceSBoris Brezillon 		nbytes += oobregion.length;
1339c44c4cceSBoris Brezillon 	}
1340c44c4cceSBoris Brezillon 
1341c44c4cceSBoris Brezillon 	return ret;
1342c44c4cceSBoris Brezillon }
1343c44c4cceSBoris Brezillon 
1344c44c4cceSBoris Brezillon /**
1345c44c4cceSBoris Brezillon  * mtd_ooblayout_get_eccbytes - extract ECC bytes from the oob buffer
1346c44c4cceSBoris Brezillon  * @mtd: mtd info structure
1347c44c4cceSBoris Brezillon  * @eccbuf: destination buffer to store ECC bytes
1348c44c4cceSBoris Brezillon  * @oobbuf: OOB buffer
1349c44c4cceSBoris Brezillon  * @start: first ECC byte to retrieve
1350c44c4cceSBoris Brezillon  * @nbytes: number of ECC bytes to retrieve
1351c44c4cceSBoris Brezillon  *
1352c44c4cceSBoris Brezillon  * Works like mtd_ooblayout_get_bytes(), except it acts on ECC bytes.
1353c44c4cceSBoris Brezillon  *
1354c44c4cceSBoris Brezillon  * Returns zero on success, a negative error code otherwise.
1355c44c4cceSBoris Brezillon  */
1356c44c4cceSBoris Brezillon int mtd_ooblayout_get_eccbytes(struct mtd_info *mtd, u8 *eccbuf,
1357c44c4cceSBoris Brezillon 			       const u8 *oobbuf, int start, int nbytes)
1358c44c4cceSBoris Brezillon {
1359c44c4cceSBoris Brezillon 	return mtd_ooblayout_get_bytes(mtd, eccbuf, oobbuf, start, nbytes,
1360c44c4cceSBoris Brezillon 				       mtd_ooblayout_ecc);
1361c44c4cceSBoris Brezillon }
1362c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_get_eccbytes);
1363c44c4cceSBoris Brezillon 
1364c44c4cceSBoris Brezillon /**
1365c44c4cceSBoris Brezillon  * mtd_ooblayout_set_eccbytes - set ECC bytes into the oob buffer
1366c44c4cceSBoris Brezillon  * @mtd: mtd info structure
1367c44c4cceSBoris Brezillon  * @eccbuf: source buffer to get ECC bytes from
1368c44c4cceSBoris Brezillon  * @oobbuf: OOB buffer
1369c44c4cceSBoris Brezillon  * @start: first ECC byte to set
1370c44c4cceSBoris Brezillon  * @nbytes: number of ECC bytes to set
1371c44c4cceSBoris Brezillon  *
1372c44c4cceSBoris Brezillon  * Works like mtd_ooblayout_set_bytes(), except it acts on ECC bytes.
1373c44c4cceSBoris Brezillon  *
1374c44c4cceSBoris Brezillon  * Returns zero on success, a negative error code otherwise.
1375c44c4cceSBoris Brezillon  */
1376c44c4cceSBoris Brezillon int mtd_ooblayout_set_eccbytes(struct mtd_info *mtd, const u8 *eccbuf,
1377c44c4cceSBoris Brezillon 			       u8 *oobbuf, int start, int nbytes)
1378c44c4cceSBoris Brezillon {
1379c44c4cceSBoris Brezillon 	return mtd_ooblayout_set_bytes(mtd, eccbuf, oobbuf, start, nbytes,
1380c44c4cceSBoris Brezillon 				       mtd_ooblayout_ecc);
1381c44c4cceSBoris Brezillon }
1382c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_set_eccbytes);
1383c44c4cceSBoris Brezillon 
1384c44c4cceSBoris Brezillon /**
1385c44c4cceSBoris Brezillon  * mtd_ooblayout_get_databytes - extract data bytes from the oob buffer
1386c44c4cceSBoris Brezillon  * @mtd: mtd info structure
1387c44c4cceSBoris Brezillon  * @databuf: destination buffer to store ECC bytes
1388c44c4cceSBoris Brezillon  * @oobbuf: OOB buffer
1389c44c4cceSBoris Brezillon  * @start: first ECC byte to retrieve
1390c44c4cceSBoris Brezillon  * @nbytes: number of ECC bytes to retrieve
1391c44c4cceSBoris Brezillon  *
1392c44c4cceSBoris Brezillon  * Works like mtd_ooblayout_get_bytes(), except it acts on free bytes.
1393c44c4cceSBoris Brezillon  *
1394c44c4cceSBoris Brezillon  * Returns zero on success, a negative error code otherwise.
1395c44c4cceSBoris Brezillon  */
1396c44c4cceSBoris Brezillon int mtd_ooblayout_get_databytes(struct mtd_info *mtd, u8 *databuf,
1397c44c4cceSBoris Brezillon 				const u8 *oobbuf, int start, int nbytes)
1398c44c4cceSBoris Brezillon {
1399c44c4cceSBoris Brezillon 	return mtd_ooblayout_get_bytes(mtd, databuf, oobbuf, start, nbytes,
1400c44c4cceSBoris Brezillon 				       mtd_ooblayout_free);
1401c44c4cceSBoris Brezillon }
1402c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_get_databytes);
1403c44c4cceSBoris Brezillon 
1404c44c4cceSBoris Brezillon /**
1405c44c4cceSBoris Brezillon  * mtd_ooblayout_get_eccbytes - set data bytes into the oob buffer
1406c44c4cceSBoris Brezillon  * @mtd: mtd info structure
1407c44c4cceSBoris Brezillon  * @eccbuf: source buffer to get data bytes from
1408c44c4cceSBoris Brezillon  * @oobbuf: OOB buffer
1409c44c4cceSBoris Brezillon  * @start: first ECC byte to set
1410c44c4cceSBoris Brezillon  * @nbytes: number of ECC bytes to set
1411c44c4cceSBoris Brezillon  *
1412c44c4cceSBoris Brezillon  * Works like mtd_ooblayout_get_bytes(), except it acts on free bytes.
1413c44c4cceSBoris Brezillon  *
1414c44c4cceSBoris Brezillon  * Returns zero on success, a negative error code otherwise.
1415c44c4cceSBoris Brezillon  */
1416c44c4cceSBoris Brezillon int mtd_ooblayout_set_databytes(struct mtd_info *mtd, const u8 *databuf,
1417c44c4cceSBoris Brezillon 				u8 *oobbuf, int start, int nbytes)
1418c44c4cceSBoris Brezillon {
1419c44c4cceSBoris Brezillon 	return mtd_ooblayout_set_bytes(mtd, databuf, oobbuf, start, nbytes,
1420c44c4cceSBoris Brezillon 				       mtd_ooblayout_free);
1421c44c4cceSBoris Brezillon }
1422c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_set_databytes);
1423c44c4cceSBoris Brezillon 
1424c44c4cceSBoris Brezillon /**
1425c44c4cceSBoris Brezillon  * mtd_ooblayout_count_freebytes - count the number of free bytes in OOB
1426c44c4cceSBoris Brezillon  * @mtd: mtd info structure
1427c44c4cceSBoris Brezillon  *
1428c44c4cceSBoris Brezillon  * Works like mtd_ooblayout_count_bytes(), except it count free bytes.
1429c44c4cceSBoris Brezillon  *
1430c44c4cceSBoris Brezillon  * Returns zero on success, a negative error code otherwise.
1431c44c4cceSBoris Brezillon  */
1432c44c4cceSBoris Brezillon int mtd_ooblayout_count_freebytes(struct mtd_info *mtd)
1433c44c4cceSBoris Brezillon {
1434c44c4cceSBoris Brezillon 	return mtd_ooblayout_count_bytes(mtd, mtd_ooblayout_free);
1435c44c4cceSBoris Brezillon }
1436c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_count_freebytes);
1437c44c4cceSBoris Brezillon 
1438c44c4cceSBoris Brezillon /**
1439c44c4cceSBoris Brezillon  * mtd_ooblayout_count_freebytes - count the number of ECC bytes in OOB
1440c44c4cceSBoris Brezillon  * @mtd: mtd info structure
1441c44c4cceSBoris Brezillon  *
1442c44c4cceSBoris Brezillon  * Works like mtd_ooblayout_count_bytes(), except it count ECC bytes.
1443c44c4cceSBoris Brezillon  *
1444c44c4cceSBoris Brezillon  * Returns zero on success, a negative error code otherwise.
1445c44c4cceSBoris Brezillon  */
1446c44c4cceSBoris Brezillon int mtd_ooblayout_count_eccbytes(struct mtd_info *mtd)
1447c44c4cceSBoris Brezillon {
1448c44c4cceSBoris Brezillon 	return mtd_ooblayout_count_bytes(mtd, mtd_ooblayout_ecc);
1449c44c4cceSBoris Brezillon }
1450c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_count_eccbytes);
1451c44c4cceSBoris Brezillon 
1452dfe64e2cSSergey Lapin /*
1453dfe64e2cSSergey Lapin  * Method to access the protection register area, present in some flash
1454dfe64e2cSSergey Lapin  * devices. The user data is one time programmable but the factory data is read
1455dfe64e2cSSergey Lapin  * only.
1456dfe64e2cSSergey Lapin  */
14574e67c571SHeiko Schocher int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
14584e67c571SHeiko Schocher 			   struct otp_info *buf)
1459dfe64e2cSSergey Lapin {
1460dfe64e2cSSergey Lapin 	if (!mtd->_get_fact_prot_info)
1461dfe64e2cSSergey Lapin 		return -EOPNOTSUPP;
1462dfe64e2cSSergey Lapin 	if (!len)
1463dfe64e2cSSergey Lapin 		return 0;
14644e67c571SHeiko Schocher 	return mtd->_get_fact_prot_info(mtd, len, retlen, buf);
1465dfe64e2cSSergey Lapin }
1466ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_get_fact_prot_info);
1467dfe64e2cSSergey Lapin 
1468dfe64e2cSSergey Lapin int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
1469dfe64e2cSSergey Lapin 			   size_t *retlen, u_char *buf)
1470dfe64e2cSSergey Lapin {
1471dfe64e2cSSergey Lapin 	*retlen = 0;
1472dfe64e2cSSergey Lapin 	if (!mtd->_read_fact_prot_reg)
1473dfe64e2cSSergey Lapin 		return -EOPNOTSUPP;
1474dfe64e2cSSergey Lapin 	if (!len)
1475dfe64e2cSSergey Lapin 		return 0;
1476dfe64e2cSSergey Lapin 	return mtd->_read_fact_prot_reg(mtd, from, len, retlen, buf);
1477dfe64e2cSSergey Lapin }
1478ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_read_fact_prot_reg);
1479dfe64e2cSSergey Lapin 
14804e67c571SHeiko Schocher int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
14814e67c571SHeiko Schocher 			   struct otp_info *buf)
1482dfe64e2cSSergey Lapin {
1483dfe64e2cSSergey Lapin 	if (!mtd->_get_user_prot_info)
1484dfe64e2cSSergey Lapin 		return -EOPNOTSUPP;
1485dfe64e2cSSergey Lapin 	if (!len)
1486dfe64e2cSSergey Lapin 		return 0;
14874e67c571SHeiko Schocher 	return mtd->_get_user_prot_info(mtd, len, retlen, buf);
1488dfe64e2cSSergey Lapin }
1489ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_get_user_prot_info);
1490dfe64e2cSSergey Lapin 
1491dfe64e2cSSergey Lapin int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
1492dfe64e2cSSergey Lapin 			   size_t *retlen, u_char *buf)
1493dfe64e2cSSergey Lapin {
1494dfe64e2cSSergey Lapin 	*retlen = 0;
1495dfe64e2cSSergey Lapin 	if (!mtd->_read_user_prot_reg)
1496dfe64e2cSSergey Lapin 		return -EOPNOTSUPP;
1497dfe64e2cSSergey Lapin 	if (!len)
1498dfe64e2cSSergey Lapin 		return 0;
1499dfe64e2cSSergey Lapin 	return mtd->_read_user_prot_reg(mtd, from, len, retlen, buf);
1500dfe64e2cSSergey Lapin }
1501ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_read_user_prot_reg);
1502dfe64e2cSSergey Lapin 
1503dfe64e2cSSergey Lapin int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
1504dfe64e2cSSergey Lapin 			    size_t *retlen, u_char *buf)
1505dfe64e2cSSergey Lapin {
15064e67c571SHeiko Schocher 	int ret;
15074e67c571SHeiko Schocher 
1508dfe64e2cSSergey Lapin 	*retlen = 0;
1509dfe64e2cSSergey Lapin 	if (!mtd->_write_user_prot_reg)
1510dfe64e2cSSergey Lapin 		return -EOPNOTSUPP;
1511dfe64e2cSSergey Lapin 	if (!len)
1512dfe64e2cSSergey Lapin 		return 0;
15134e67c571SHeiko Schocher 	ret = mtd->_write_user_prot_reg(mtd, to, len, retlen, buf);
15144e67c571SHeiko Schocher 	if (ret)
15154e67c571SHeiko Schocher 		return ret;
15164e67c571SHeiko Schocher 
15174e67c571SHeiko Schocher 	/*
15184e67c571SHeiko Schocher 	 * If no data could be written at all, we are out of memory and
15194e67c571SHeiko Schocher 	 * must return -ENOSPC.
15204e67c571SHeiko Schocher 	 */
15214e67c571SHeiko Schocher 	return (*retlen) ? 0 : -ENOSPC;
1522dfe64e2cSSergey Lapin }
1523ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_write_user_prot_reg);
1524dfe64e2cSSergey Lapin 
1525dfe64e2cSSergey Lapin int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len)
1526dfe64e2cSSergey Lapin {
1527dfe64e2cSSergey Lapin 	if (!mtd->_lock_user_prot_reg)
1528dfe64e2cSSergey Lapin 		return -EOPNOTSUPP;
1529dfe64e2cSSergey Lapin 	if (!len)
1530dfe64e2cSSergey Lapin 		return 0;
1531dfe64e2cSSergey Lapin 	return mtd->_lock_user_prot_reg(mtd, from, len);
1532dfe64e2cSSergey Lapin }
1533ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_lock_user_prot_reg);
1534dfe64e2cSSergey Lapin 
1535dfe64e2cSSergey Lapin /* Chip-supported device locking */
1536dfe64e2cSSergey Lapin int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
1537dfe64e2cSSergey Lapin {
1538dfe64e2cSSergey Lapin 	if (!mtd->_lock)
1539dfe64e2cSSergey Lapin 		return -EOPNOTSUPP;
1540dfe64e2cSSergey Lapin 	if (ofs < 0 || ofs > mtd->size || len > mtd->size - ofs)
1541dfe64e2cSSergey Lapin 		return -EINVAL;
1542dfe64e2cSSergey Lapin 	if (!len)
1543dfe64e2cSSergey Lapin 		return 0;
1544dfe64e2cSSergey Lapin 	return mtd->_lock(mtd, ofs, len);
1545dfe64e2cSSergey Lapin }
1546ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_lock);
1547dfe64e2cSSergey Lapin 
1548dfe64e2cSSergey Lapin int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
1549dfe64e2cSSergey Lapin {
1550dfe64e2cSSergey Lapin 	if (!mtd->_unlock)
1551dfe64e2cSSergey Lapin 		return -EOPNOTSUPP;
1552dfe64e2cSSergey Lapin 	if (ofs < 0 || ofs > mtd->size || len > mtd->size - ofs)
1553dfe64e2cSSergey Lapin 		return -EINVAL;
1554dfe64e2cSSergey Lapin 	if (!len)
1555dfe64e2cSSergey Lapin 		return 0;
1556dfe64e2cSSergey Lapin 	return mtd->_unlock(mtd, ofs, len);
1557dfe64e2cSSergey Lapin }
1558ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_unlock);
1559ff94bc40SHeiko Schocher 
1560ff94bc40SHeiko Schocher int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len)
1561ff94bc40SHeiko Schocher {
1562ff94bc40SHeiko Schocher 	if (!mtd->_is_locked)
1563ff94bc40SHeiko Schocher 		return -EOPNOTSUPP;
1564ff94bc40SHeiko Schocher 	if (ofs < 0 || ofs > mtd->size || len > mtd->size - ofs)
1565ff94bc40SHeiko Schocher 		return -EINVAL;
1566ff94bc40SHeiko Schocher 	if (!len)
1567ff94bc40SHeiko Schocher 		return 0;
1568ff94bc40SHeiko Schocher 	return mtd->_is_locked(mtd, ofs, len);
1569ff94bc40SHeiko Schocher }
1570ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_is_locked);
1571dfe64e2cSSergey Lapin 
157286a720aaSEzequiel Garcia int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs)
1573dfe64e2cSSergey Lapin {
1574dfe64e2cSSergey Lapin 	if (ofs < 0 || ofs > mtd->size)
1575dfe64e2cSSergey Lapin 		return -EINVAL;
157686a720aaSEzequiel Garcia 	if (!mtd->_block_isreserved)
157786a720aaSEzequiel Garcia 		return 0;
157886a720aaSEzequiel Garcia 	return mtd->_block_isreserved(mtd, ofs);
157986a720aaSEzequiel Garcia }
158086a720aaSEzequiel Garcia EXPORT_SYMBOL_GPL(mtd_block_isreserved);
158186a720aaSEzequiel Garcia 
158286a720aaSEzequiel Garcia int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs)
158386a720aaSEzequiel Garcia {
158486a720aaSEzequiel Garcia 	if (ofs < 0 || ofs > mtd->size)
158586a720aaSEzequiel Garcia 		return -EINVAL;
158686a720aaSEzequiel Garcia 	if (!mtd->_block_isbad)
158786a720aaSEzequiel Garcia 		return 0;
1588dfe64e2cSSergey Lapin 	return mtd->_block_isbad(mtd, ofs);
1589dfe64e2cSSergey Lapin }
1590ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_block_isbad);
1591dfe64e2cSSergey Lapin 
1592dfe64e2cSSergey Lapin int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs)
1593dfe64e2cSSergey Lapin {
1594dfe64e2cSSergey Lapin 	if (!mtd->_block_markbad)
1595dfe64e2cSSergey Lapin 		return -EOPNOTSUPP;
1596dfe64e2cSSergey Lapin 	if (ofs < 0 || ofs > mtd->size)
1597dfe64e2cSSergey Lapin 		return -EINVAL;
1598dfe64e2cSSergey Lapin 	if (!(mtd->flags & MTD_WRITEABLE))
1599dfe64e2cSSergey Lapin 		return -EROFS;
1600dfe64e2cSSergey Lapin 	return mtd->_block_markbad(mtd, ofs);
1601dfe64e2cSSergey Lapin }
1602ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_block_markbad);
1603ff94bc40SHeiko Schocher 
1604ff94bc40SHeiko Schocher #ifndef __UBOOT__
1605ff94bc40SHeiko Schocher /*
1606ff94bc40SHeiko Schocher  * default_mtd_writev - the default writev method
1607ff94bc40SHeiko Schocher  * @mtd: mtd device description object pointer
1608ff94bc40SHeiko Schocher  * @vecs: the vectors to write
1609ff94bc40SHeiko Schocher  * @count: count of vectors in @vecs
1610ff94bc40SHeiko Schocher  * @to: the MTD device offset to write to
1611ff94bc40SHeiko Schocher  * @retlen: on exit contains the count of bytes written to the MTD device.
1612ff94bc40SHeiko Schocher  *
1613ff94bc40SHeiko Schocher  * This function returns zero in case of success and a negative error code in
1614ff94bc40SHeiko Schocher  * case of failure.
1615ff94bc40SHeiko Schocher  */
1616ff94bc40SHeiko Schocher static int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
1617ff94bc40SHeiko Schocher 			      unsigned long count, loff_t to, size_t *retlen)
1618ff94bc40SHeiko Schocher {
1619ff94bc40SHeiko Schocher 	unsigned long i;
1620ff94bc40SHeiko Schocher 	size_t totlen = 0, thislen;
1621ff94bc40SHeiko Schocher 	int ret = 0;
1622ff94bc40SHeiko Schocher 
1623ff94bc40SHeiko Schocher 	for (i = 0; i < count; i++) {
1624ff94bc40SHeiko Schocher 		if (!vecs[i].iov_len)
1625ff94bc40SHeiko Schocher 			continue;
1626ff94bc40SHeiko Schocher 		ret = mtd_write(mtd, to, vecs[i].iov_len, &thislen,
1627ff94bc40SHeiko Schocher 				vecs[i].iov_base);
1628ff94bc40SHeiko Schocher 		totlen += thislen;
1629ff94bc40SHeiko Schocher 		if (ret || thislen != vecs[i].iov_len)
1630ff94bc40SHeiko Schocher 			break;
1631ff94bc40SHeiko Schocher 		to += vecs[i].iov_len;
1632ff94bc40SHeiko Schocher 	}
1633ff94bc40SHeiko Schocher 	*retlen = totlen;
1634ff94bc40SHeiko Schocher 	return ret;
1635ff94bc40SHeiko Schocher }
1636ff94bc40SHeiko Schocher 
1637ff94bc40SHeiko Schocher /*
1638ff94bc40SHeiko Schocher  * mtd_writev - the vector-based MTD write method
1639ff94bc40SHeiko Schocher  * @mtd: mtd device description object pointer
1640ff94bc40SHeiko Schocher  * @vecs: the vectors to write
1641ff94bc40SHeiko Schocher  * @count: count of vectors in @vecs
1642ff94bc40SHeiko Schocher  * @to: the MTD device offset to write to
1643ff94bc40SHeiko Schocher  * @retlen: on exit contains the count of bytes written to the MTD device.
1644ff94bc40SHeiko Schocher  *
1645ff94bc40SHeiko Schocher  * This function returns zero in case of success and a negative error code in
1646ff94bc40SHeiko Schocher  * case of failure.
1647ff94bc40SHeiko Schocher  */
1648ff94bc40SHeiko Schocher int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
1649ff94bc40SHeiko Schocher 	       unsigned long count, loff_t to, size_t *retlen)
1650ff94bc40SHeiko Schocher {
1651ff94bc40SHeiko Schocher 	*retlen = 0;
1652ff94bc40SHeiko Schocher 	if (!(mtd->flags & MTD_WRITEABLE))
1653ff94bc40SHeiko Schocher 		return -EROFS;
1654ff94bc40SHeiko Schocher 	if (!mtd->_writev)
1655ff94bc40SHeiko Schocher 		return default_mtd_writev(mtd, vecs, count, to, retlen);
1656ff94bc40SHeiko Schocher 	return mtd->_writev(mtd, vecs, count, to, retlen);
1657ff94bc40SHeiko Schocher }
1658ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_writev);
1659ff94bc40SHeiko Schocher 
1660ff94bc40SHeiko Schocher /**
1661ff94bc40SHeiko Schocher  * mtd_kmalloc_up_to - allocate a contiguous buffer up to the specified size
1662ff94bc40SHeiko Schocher  * @mtd: mtd device description object pointer
1663ff94bc40SHeiko Schocher  * @size: a pointer to the ideal or maximum size of the allocation, points
1664ff94bc40SHeiko Schocher  *        to the actual allocation size on success.
1665ff94bc40SHeiko Schocher  *
1666ff94bc40SHeiko Schocher  * This routine attempts to allocate a contiguous kernel buffer up to
1667ff94bc40SHeiko Schocher  * the specified size, backing off the size of the request exponentially
1668ff94bc40SHeiko Schocher  * until the request succeeds or until the allocation size falls below
1669ff94bc40SHeiko Schocher  * the system page size. This attempts to make sure it does not adversely
1670ff94bc40SHeiko Schocher  * impact system performance, so when allocating more than one page, we
1671ff94bc40SHeiko Schocher  * ask the memory allocator to avoid re-trying, swapping, writing back
1672ff94bc40SHeiko Schocher  * or performing I/O.
1673ff94bc40SHeiko Schocher  *
1674ff94bc40SHeiko Schocher  * Note, this function also makes sure that the allocated buffer is aligned to
1675ff94bc40SHeiko Schocher  * the MTD device's min. I/O unit, i.e. the "mtd->writesize" value.
1676ff94bc40SHeiko Schocher  *
1677ff94bc40SHeiko Schocher  * This is called, for example by mtd_{read,write} and jffs2_scan_medium,
1678ff94bc40SHeiko Schocher  * to handle smaller (i.e. degraded) buffer allocations under low- or
1679ff94bc40SHeiko Schocher  * fragmented-memory situations where such reduced allocations, from a
1680ff94bc40SHeiko Schocher  * requested ideal, are allowed.
1681ff94bc40SHeiko Schocher  *
1682ff94bc40SHeiko Schocher  * Returns a pointer to the allocated buffer on success; otherwise, NULL.
1683ff94bc40SHeiko Schocher  */
1684ff94bc40SHeiko Schocher void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size)
1685ff94bc40SHeiko Schocher {
1686ff94bc40SHeiko Schocher 	gfp_t flags = __GFP_NOWARN | __GFP_WAIT |
1687ff94bc40SHeiko Schocher 		       __GFP_NORETRY | __GFP_NO_KSWAPD;
1688ff94bc40SHeiko Schocher 	size_t min_alloc = max_t(size_t, mtd->writesize, PAGE_SIZE);
1689ff94bc40SHeiko Schocher 	void *kbuf;
1690ff94bc40SHeiko Schocher 
1691ff94bc40SHeiko Schocher 	*size = min_t(size_t, *size, KMALLOC_MAX_SIZE);
1692ff94bc40SHeiko Schocher 
1693ff94bc40SHeiko Schocher 	while (*size > min_alloc) {
1694ff94bc40SHeiko Schocher 		kbuf = kmalloc(*size, flags);
1695ff94bc40SHeiko Schocher 		if (kbuf)
1696ff94bc40SHeiko Schocher 			return kbuf;
1697ff94bc40SHeiko Schocher 
1698ff94bc40SHeiko Schocher 		*size >>= 1;
1699ff94bc40SHeiko Schocher 		*size = ALIGN(*size, mtd->writesize);
1700ff94bc40SHeiko Schocher 	}
1701ff94bc40SHeiko Schocher 
1702ff94bc40SHeiko Schocher 	/*
1703ff94bc40SHeiko Schocher 	 * For the last resort allocation allow 'kmalloc()' to do all sorts of
1704ff94bc40SHeiko Schocher 	 * things (write-back, dropping caches, etc) by using GFP_KERNEL.
1705ff94bc40SHeiko Schocher 	 */
1706ff94bc40SHeiko Schocher 	return kmalloc(*size, GFP_KERNEL);
1707ff94bc40SHeiko Schocher }
1708ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_kmalloc_up_to);
1709ff94bc40SHeiko Schocher #endif
1710ff94bc40SHeiko Schocher 
1711ff94bc40SHeiko Schocher #ifdef CONFIG_PROC_FS
1712ff94bc40SHeiko Schocher 
1713ff94bc40SHeiko Schocher /*====================================================================*/
1714ff94bc40SHeiko Schocher /* Support for /proc/mtd */
1715ff94bc40SHeiko Schocher 
1716ff94bc40SHeiko Schocher static int mtd_proc_show(struct seq_file *m, void *v)
1717ff94bc40SHeiko Schocher {
1718ff94bc40SHeiko Schocher 	struct mtd_info *mtd;
1719ff94bc40SHeiko Schocher 
1720ff94bc40SHeiko Schocher 	seq_puts(m, "dev:    size   erasesize  name\n");
1721ff94bc40SHeiko Schocher 	mutex_lock(&mtd_table_mutex);
1722ff94bc40SHeiko Schocher 	mtd_for_each_device(mtd) {
1723ff94bc40SHeiko Schocher 		seq_printf(m, "mtd%d: %8.8llx %8.8x \"%s\"\n",
1724ff94bc40SHeiko Schocher 			   mtd->index, (unsigned long long)mtd->size,
1725ff94bc40SHeiko Schocher 			   mtd->erasesize, mtd->name);
1726ff94bc40SHeiko Schocher 	}
1727ff94bc40SHeiko Schocher 	mutex_unlock(&mtd_table_mutex);
1728ff94bc40SHeiko Schocher 	return 0;
1729ff94bc40SHeiko Schocher }
1730ff94bc40SHeiko Schocher 
1731ff94bc40SHeiko Schocher static int mtd_proc_open(struct inode *inode, struct file *file)
1732ff94bc40SHeiko Schocher {
1733ff94bc40SHeiko Schocher 	return single_open(file, mtd_proc_show, NULL);
1734ff94bc40SHeiko Schocher }
1735ff94bc40SHeiko Schocher 
1736ff94bc40SHeiko Schocher static const struct file_operations mtd_proc_ops = {
1737ff94bc40SHeiko Schocher 	.open		= mtd_proc_open,
1738ff94bc40SHeiko Schocher 	.read		= seq_read,
1739ff94bc40SHeiko Schocher 	.llseek		= seq_lseek,
1740ff94bc40SHeiko Schocher 	.release	= single_release,
1741ff94bc40SHeiko Schocher };
1742ff94bc40SHeiko Schocher #endif /* CONFIG_PROC_FS */
1743ff94bc40SHeiko Schocher 
1744ff94bc40SHeiko Schocher /*====================================================================*/
1745ff94bc40SHeiko Schocher /* Init code */
1746ff94bc40SHeiko Schocher 
1747ff94bc40SHeiko Schocher #ifndef __UBOOT__
1748ff94bc40SHeiko Schocher static int __init mtd_bdi_init(struct backing_dev_info *bdi, const char *name)
1749ff94bc40SHeiko Schocher {
1750ff94bc40SHeiko Schocher 	int ret;
1751ff94bc40SHeiko Schocher 
1752ff94bc40SHeiko Schocher 	ret = bdi_init(bdi);
1753ff94bc40SHeiko Schocher 	if (!ret)
1754ff94bc40SHeiko Schocher 		ret = bdi_register(bdi, NULL, "%s", name);
1755ff94bc40SHeiko Schocher 
1756ff94bc40SHeiko Schocher 	if (ret)
1757ff94bc40SHeiko Schocher 		bdi_destroy(bdi);
1758ff94bc40SHeiko Schocher 
1759ff94bc40SHeiko Schocher 	return ret;
1760ff94bc40SHeiko Schocher }
1761ff94bc40SHeiko Schocher 
1762ff94bc40SHeiko Schocher static struct proc_dir_entry *proc_mtd;
1763ff94bc40SHeiko Schocher 
1764ff94bc40SHeiko Schocher static int __init init_mtd(void)
1765ff94bc40SHeiko Schocher {
1766ff94bc40SHeiko Schocher 	int ret;
1767ff94bc40SHeiko Schocher 
1768ff94bc40SHeiko Schocher 	ret = class_register(&mtd_class);
1769ff94bc40SHeiko Schocher 	if (ret)
1770ff94bc40SHeiko Schocher 		goto err_reg;
1771ff94bc40SHeiko Schocher 
1772ff94bc40SHeiko Schocher 	ret = mtd_bdi_init(&mtd_bdi_unmappable, "mtd-unmap");
1773ff94bc40SHeiko Schocher 	if (ret)
1774ff94bc40SHeiko Schocher 		goto err_bdi1;
1775ff94bc40SHeiko Schocher 
1776ff94bc40SHeiko Schocher 	ret = mtd_bdi_init(&mtd_bdi_ro_mappable, "mtd-romap");
1777ff94bc40SHeiko Schocher 	if (ret)
1778ff94bc40SHeiko Schocher 		goto err_bdi2;
1779ff94bc40SHeiko Schocher 
1780ff94bc40SHeiko Schocher 	ret = mtd_bdi_init(&mtd_bdi_rw_mappable, "mtd-rwmap");
1781ff94bc40SHeiko Schocher 	if (ret)
1782ff94bc40SHeiko Schocher 		goto err_bdi3;
1783ff94bc40SHeiko Schocher 
1784ff94bc40SHeiko Schocher 	proc_mtd = proc_create("mtd", 0, NULL, &mtd_proc_ops);
1785ff94bc40SHeiko Schocher 
1786ff94bc40SHeiko Schocher 	ret = init_mtdchar();
1787ff94bc40SHeiko Schocher 	if (ret)
1788ff94bc40SHeiko Schocher 		goto out_procfs;
1789ff94bc40SHeiko Schocher 
1790ff94bc40SHeiko Schocher 	return 0;
1791ff94bc40SHeiko Schocher 
1792ff94bc40SHeiko Schocher out_procfs:
1793ff94bc40SHeiko Schocher 	if (proc_mtd)
1794ff94bc40SHeiko Schocher 		remove_proc_entry("mtd", NULL);
1795ff94bc40SHeiko Schocher err_bdi3:
1796ff94bc40SHeiko Schocher 	bdi_destroy(&mtd_bdi_ro_mappable);
1797ff94bc40SHeiko Schocher err_bdi2:
1798ff94bc40SHeiko Schocher 	bdi_destroy(&mtd_bdi_unmappable);
1799ff94bc40SHeiko Schocher err_bdi1:
1800ff94bc40SHeiko Schocher 	class_unregister(&mtd_class);
1801ff94bc40SHeiko Schocher err_reg:
1802ff94bc40SHeiko Schocher 	pr_err("Error registering mtd class or bdi: %d\n", ret);
1803ff94bc40SHeiko Schocher 	return ret;
1804ff94bc40SHeiko Schocher }
1805ff94bc40SHeiko Schocher 
1806ff94bc40SHeiko Schocher static void __exit cleanup_mtd(void)
1807ff94bc40SHeiko Schocher {
1808ff94bc40SHeiko Schocher 	cleanup_mtdchar();
1809ff94bc40SHeiko Schocher 	if (proc_mtd)
1810ff94bc40SHeiko Schocher 		remove_proc_entry("mtd", NULL);
1811ff94bc40SHeiko Schocher 	class_unregister(&mtd_class);
1812ff94bc40SHeiko Schocher 	bdi_destroy(&mtd_bdi_unmappable);
1813ff94bc40SHeiko Schocher 	bdi_destroy(&mtd_bdi_ro_mappable);
1814ff94bc40SHeiko Schocher 	bdi_destroy(&mtd_bdi_rw_mappable);
1815ff94bc40SHeiko Schocher }
1816ff94bc40SHeiko Schocher 
1817ff94bc40SHeiko Schocher module_init(init_mtd);
1818ff94bc40SHeiko Schocher module_exit(cleanup_mtd);
1819ff94bc40SHeiko Schocher #endif
1820ff94bc40SHeiko Schocher 
1821ff94bc40SHeiko Schocher MODULE_LICENSE("GPL");
1822ff94bc40SHeiko Schocher MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1823ff94bc40SHeiko Schocher MODULE_DESCRIPTION("Core MTD registration and access routines");
1824