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 */ 94140462e54SPaul Burton ret_code = mtd->_read(mtd, from, len, retlen, buf); 94240462e54SPaul Burton if (unlikely(ret_code < 0)) 94340462e54SPaul Burton return ret_code; 94440462e54SPaul Burton if (mtd->ecc_strength == 0) 94540462e54SPaul Burton return 0; /* device lacks ecc */ 94640462e54SPaul Burton return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0; 947dfe64e2cSSergey Lapin } 948ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_read); 949dfe64e2cSSergey Lapin 950dfe64e2cSSergey Lapin int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, 951dfe64e2cSSergey Lapin const u_char *buf) 952dfe64e2cSSergey Lapin { 953dfe64e2cSSergey Lapin *retlen = 0; 954dfe64e2cSSergey Lapin if (to < 0 || to > mtd->size || len > mtd->size - to) 955dfe64e2cSSergey Lapin return -EINVAL; 956dfe64e2cSSergey Lapin if (!mtd->_write || !(mtd->flags & MTD_WRITEABLE)) 957dfe64e2cSSergey Lapin return -EROFS; 958dfe64e2cSSergey Lapin if (!len) 959dfe64e2cSSergey Lapin return 0; 960dfe64e2cSSergey Lapin return mtd->_write(mtd, to, len, retlen, buf); 961dfe64e2cSSergey Lapin } 962ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_write); 963dfe64e2cSSergey Lapin 964dfe64e2cSSergey Lapin /* 965dfe64e2cSSergey Lapin * In blackbox flight recorder like scenarios we want to make successful writes 966dfe64e2cSSergey Lapin * in interrupt context. panic_write() is only intended to be called when its 967dfe64e2cSSergey Lapin * known the kernel is about to panic and we need the write to succeed. Since 968dfe64e2cSSergey Lapin * the kernel is not going to be running for much longer, this function can 969dfe64e2cSSergey Lapin * break locks and delay to ensure the write succeeds (but not sleep). 970dfe64e2cSSergey Lapin */ 971dfe64e2cSSergey Lapin int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, 972dfe64e2cSSergey Lapin const u_char *buf) 973dfe64e2cSSergey Lapin { 974dfe64e2cSSergey Lapin *retlen = 0; 975dfe64e2cSSergey Lapin if (!mtd->_panic_write) 976dfe64e2cSSergey Lapin return -EOPNOTSUPP; 977dfe64e2cSSergey Lapin if (to < 0 || to > mtd->size || len > mtd->size - to) 978dfe64e2cSSergey Lapin return -EINVAL; 979dfe64e2cSSergey Lapin if (!(mtd->flags & MTD_WRITEABLE)) 980dfe64e2cSSergey Lapin return -EROFS; 981dfe64e2cSSergey Lapin if (!len) 982dfe64e2cSSergey Lapin return 0; 983dfe64e2cSSergey Lapin return mtd->_panic_write(mtd, to, len, retlen, buf); 984dfe64e2cSSergey Lapin } 985ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_panic_write); 986dfe64e2cSSergey Lapin 987dfe64e2cSSergey Lapin int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops) 988dfe64e2cSSergey Lapin { 989ff94bc40SHeiko Schocher int ret_code; 990dfe64e2cSSergey Lapin ops->retlen = ops->oobretlen = 0; 991dfe64e2cSSergey Lapin if (!mtd->_read_oob) 992dfe64e2cSSergey Lapin return -EOPNOTSUPP; 993ff94bc40SHeiko Schocher /* 994ff94bc40SHeiko Schocher * In cases where ops->datbuf != NULL, mtd->_read_oob() has semantics 995ff94bc40SHeiko Schocher * similar to mtd->_read(), returning a non-negative integer 996ff94bc40SHeiko Schocher * representing max bitflips. In other cases, mtd->_read_oob() may 997ff94bc40SHeiko Schocher * return -EUCLEAN. In all cases, perform similar logic to mtd_read(). 998ff94bc40SHeiko Schocher */ 999ff94bc40SHeiko Schocher ret_code = mtd->_read_oob(mtd, from, ops); 1000ff94bc40SHeiko Schocher if (unlikely(ret_code < 0)) 1001ff94bc40SHeiko Schocher return ret_code; 1002ff94bc40SHeiko Schocher if (mtd->ecc_strength == 0) 1003ff94bc40SHeiko Schocher return 0; /* device lacks ecc */ 1004ff94bc40SHeiko Schocher return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0; 1005dfe64e2cSSergey Lapin } 1006ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_read_oob); 1007dfe64e2cSSergey Lapin 1008*c44c4cceSBoris Brezillon /** 1009*c44c4cceSBoris Brezillon * mtd_ooblayout_ecc - Get the OOB region definition of a specific ECC section 1010*c44c4cceSBoris Brezillon * @mtd: MTD device structure 1011*c44c4cceSBoris Brezillon * @section: ECC section. Depending on the layout you may have all the ECC 1012*c44c4cceSBoris Brezillon * bytes stored in a single contiguous section, or one section 1013*c44c4cceSBoris Brezillon * per ECC chunk (and sometime several sections for a single ECC 1014*c44c4cceSBoris Brezillon * ECC chunk) 1015*c44c4cceSBoris Brezillon * @oobecc: OOB region struct filled with the appropriate ECC position 1016*c44c4cceSBoris Brezillon * information 1017*c44c4cceSBoris Brezillon * 1018*c44c4cceSBoris Brezillon * This function returns ECC section information in the OOB area. If you want 1019*c44c4cceSBoris Brezillon * to get all the ECC bytes information, then you should call 1020*c44c4cceSBoris Brezillon * mtd_ooblayout_ecc(mtd, section++, oobecc) until it returns -ERANGE. 1021*c44c4cceSBoris Brezillon * 1022*c44c4cceSBoris Brezillon * Returns zero on success, a negative error code otherwise. 1023*c44c4cceSBoris Brezillon */ 1024*c44c4cceSBoris Brezillon int mtd_ooblayout_ecc(struct mtd_info *mtd, int section, 1025*c44c4cceSBoris Brezillon struct mtd_oob_region *oobecc) 1026*c44c4cceSBoris Brezillon { 1027*c44c4cceSBoris Brezillon memset(oobecc, 0, sizeof(*oobecc)); 1028*c44c4cceSBoris Brezillon 1029*c44c4cceSBoris Brezillon if (!mtd || section < 0) 1030*c44c4cceSBoris Brezillon return -EINVAL; 1031*c44c4cceSBoris Brezillon 1032*c44c4cceSBoris Brezillon if (!mtd->ooblayout || !mtd->ooblayout->ecc) 1033*c44c4cceSBoris Brezillon return -ENOTSUPP; 1034*c44c4cceSBoris Brezillon 1035*c44c4cceSBoris Brezillon return mtd->ooblayout->ecc(mtd, section, oobecc); 1036*c44c4cceSBoris Brezillon } 1037*c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_ecc); 1038*c44c4cceSBoris Brezillon 1039*c44c4cceSBoris Brezillon /** 1040*c44c4cceSBoris Brezillon * mtd_ooblayout_free - Get the OOB region definition of a specific free 1041*c44c4cceSBoris Brezillon * section 1042*c44c4cceSBoris Brezillon * @mtd: MTD device structure 1043*c44c4cceSBoris Brezillon * @section: Free section you are interested in. Depending on the layout 1044*c44c4cceSBoris Brezillon * you may have all the free bytes stored in a single contiguous 1045*c44c4cceSBoris Brezillon * section, or one section per ECC chunk plus an extra section 1046*c44c4cceSBoris Brezillon * for the remaining bytes (or other funky layout). 1047*c44c4cceSBoris Brezillon * @oobfree: OOB region struct filled with the appropriate free position 1048*c44c4cceSBoris Brezillon * information 1049*c44c4cceSBoris Brezillon * 1050*c44c4cceSBoris Brezillon * This function returns free bytes position in the OOB area. If you want 1051*c44c4cceSBoris Brezillon * to get all the free bytes information, then you should call 1052*c44c4cceSBoris Brezillon * mtd_ooblayout_free(mtd, section++, oobfree) until it returns -ERANGE. 1053*c44c4cceSBoris Brezillon * 1054*c44c4cceSBoris Brezillon * Returns zero on success, a negative error code otherwise. 1055*c44c4cceSBoris Brezillon */ 1056*c44c4cceSBoris Brezillon int mtd_ooblayout_free(struct mtd_info *mtd, int section, 1057*c44c4cceSBoris Brezillon struct mtd_oob_region *oobfree) 1058*c44c4cceSBoris Brezillon { 1059*c44c4cceSBoris Brezillon memset(oobfree, 0, sizeof(*oobfree)); 1060*c44c4cceSBoris Brezillon 1061*c44c4cceSBoris Brezillon if (!mtd || section < 0) 1062*c44c4cceSBoris Brezillon return -EINVAL; 1063*c44c4cceSBoris Brezillon 1064*c44c4cceSBoris Brezillon if (!mtd->ooblayout || !mtd->ooblayout->free) 1065*c44c4cceSBoris Brezillon return -ENOTSUPP; 1066*c44c4cceSBoris Brezillon 1067*c44c4cceSBoris Brezillon return mtd->ooblayout->free(mtd, section, oobfree); 1068*c44c4cceSBoris Brezillon } 1069*c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_free); 1070*c44c4cceSBoris Brezillon 1071*c44c4cceSBoris Brezillon /** 1072*c44c4cceSBoris Brezillon * mtd_ooblayout_find_region - Find the region attached to a specific byte 1073*c44c4cceSBoris Brezillon * @mtd: mtd info structure 1074*c44c4cceSBoris Brezillon * @byte: the byte we are searching for 1075*c44c4cceSBoris Brezillon * @sectionp: pointer where the section id will be stored 1076*c44c4cceSBoris Brezillon * @oobregion: used to retrieve the ECC position 1077*c44c4cceSBoris Brezillon * @iter: iterator function. Should be either mtd_ooblayout_free or 1078*c44c4cceSBoris Brezillon * mtd_ooblayout_ecc depending on the region type you're searching for 1079*c44c4cceSBoris Brezillon * 1080*c44c4cceSBoris Brezillon * This function returns the section id and oobregion information of a 1081*c44c4cceSBoris Brezillon * specific byte. For example, say you want to know where the 4th ECC byte is 1082*c44c4cceSBoris Brezillon * stored, you'll use: 1083*c44c4cceSBoris Brezillon * 1084*c44c4cceSBoris Brezillon * mtd_ooblayout_find_region(mtd, 3, §ion, &oobregion, mtd_ooblayout_ecc); 1085*c44c4cceSBoris Brezillon * 1086*c44c4cceSBoris Brezillon * Returns zero on success, a negative error code otherwise. 1087*c44c4cceSBoris Brezillon */ 1088*c44c4cceSBoris Brezillon static int mtd_ooblayout_find_region(struct mtd_info *mtd, int byte, 1089*c44c4cceSBoris Brezillon int *sectionp, struct mtd_oob_region *oobregion, 1090*c44c4cceSBoris Brezillon int (*iter)(struct mtd_info *, 1091*c44c4cceSBoris Brezillon int section, 1092*c44c4cceSBoris Brezillon struct mtd_oob_region *oobregion)) 1093*c44c4cceSBoris Brezillon { 1094*c44c4cceSBoris Brezillon int pos = 0, ret, section = 0; 1095*c44c4cceSBoris Brezillon 1096*c44c4cceSBoris Brezillon memset(oobregion, 0, sizeof(*oobregion)); 1097*c44c4cceSBoris Brezillon 1098*c44c4cceSBoris Brezillon while (1) { 1099*c44c4cceSBoris Brezillon ret = iter(mtd, section, oobregion); 1100*c44c4cceSBoris Brezillon if (ret) 1101*c44c4cceSBoris Brezillon return ret; 1102*c44c4cceSBoris Brezillon 1103*c44c4cceSBoris Brezillon if (pos + oobregion->length > byte) 1104*c44c4cceSBoris Brezillon break; 1105*c44c4cceSBoris Brezillon 1106*c44c4cceSBoris Brezillon pos += oobregion->length; 1107*c44c4cceSBoris Brezillon section++; 1108*c44c4cceSBoris Brezillon } 1109*c44c4cceSBoris Brezillon 1110*c44c4cceSBoris Brezillon /* 1111*c44c4cceSBoris Brezillon * Adjust region info to make it start at the beginning at the 1112*c44c4cceSBoris Brezillon * 'start' ECC byte. 1113*c44c4cceSBoris Brezillon */ 1114*c44c4cceSBoris Brezillon oobregion->offset += byte - pos; 1115*c44c4cceSBoris Brezillon oobregion->length -= byte - pos; 1116*c44c4cceSBoris Brezillon *sectionp = section; 1117*c44c4cceSBoris Brezillon 1118*c44c4cceSBoris Brezillon return 0; 1119*c44c4cceSBoris Brezillon } 1120*c44c4cceSBoris Brezillon 1121*c44c4cceSBoris Brezillon /** 1122*c44c4cceSBoris Brezillon * mtd_ooblayout_find_eccregion - Find the ECC region attached to a specific 1123*c44c4cceSBoris Brezillon * ECC byte 1124*c44c4cceSBoris Brezillon * @mtd: mtd info structure 1125*c44c4cceSBoris Brezillon * @eccbyte: the byte we are searching for 1126*c44c4cceSBoris Brezillon * @sectionp: pointer where the section id will be stored 1127*c44c4cceSBoris Brezillon * @oobregion: OOB region information 1128*c44c4cceSBoris Brezillon * 1129*c44c4cceSBoris Brezillon * Works like mtd_ooblayout_find_region() except it searches for a specific ECC 1130*c44c4cceSBoris Brezillon * byte. 1131*c44c4cceSBoris Brezillon * 1132*c44c4cceSBoris Brezillon * Returns zero on success, a negative error code otherwise. 1133*c44c4cceSBoris Brezillon */ 1134*c44c4cceSBoris Brezillon int mtd_ooblayout_find_eccregion(struct mtd_info *mtd, int eccbyte, 1135*c44c4cceSBoris Brezillon int *section, 1136*c44c4cceSBoris Brezillon struct mtd_oob_region *oobregion) 1137*c44c4cceSBoris Brezillon { 1138*c44c4cceSBoris Brezillon return mtd_ooblayout_find_region(mtd, eccbyte, section, oobregion, 1139*c44c4cceSBoris Brezillon mtd_ooblayout_ecc); 1140*c44c4cceSBoris Brezillon } 1141*c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_find_eccregion); 1142*c44c4cceSBoris Brezillon 1143*c44c4cceSBoris Brezillon /** 1144*c44c4cceSBoris Brezillon * mtd_ooblayout_get_bytes - Extract OOB bytes from the oob buffer 1145*c44c4cceSBoris Brezillon * @mtd: mtd info structure 1146*c44c4cceSBoris Brezillon * @buf: destination buffer to store OOB bytes 1147*c44c4cceSBoris Brezillon * @oobbuf: OOB buffer 1148*c44c4cceSBoris Brezillon * @start: first byte to retrieve 1149*c44c4cceSBoris Brezillon * @nbytes: number of bytes to retrieve 1150*c44c4cceSBoris Brezillon * @iter: section iterator 1151*c44c4cceSBoris Brezillon * 1152*c44c4cceSBoris Brezillon * Extract bytes attached to a specific category (ECC or free) 1153*c44c4cceSBoris Brezillon * from the OOB buffer and copy them into buf. 1154*c44c4cceSBoris Brezillon * 1155*c44c4cceSBoris Brezillon * Returns zero on success, a negative error code otherwise. 1156*c44c4cceSBoris Brezillon */ 1157*c44c4cceSBoris Brezillon static int mtd_ooblayout_get_bytes(struct mtd_info *mtd, u8 *buf, 1158*c44c4cceSBoris Brezillon const u8 *oobbuf, int start, int nbytes, 1159*c44c4cceSBoris Brezillon int (*iter)(struct mtd_info *, 1160*c44c4cceSBoris Brezillon int section, 1161*c44c4cceSBoris Brezillon struct mtd_oob_region *oobregion)) 1162*c44c4cceSBoris Brezillon { 1163*c44c4cceSBoris Brezillon struct mtd_oob_region oobregion; 1164*c44c4cceSBoris Brezillon int section, ret; 1165*c44c4cceSBoris Brezillon 1166*c44c4cceSBoris Brezillon ret = mtd_ooblayout_find_region(mtd, start, §ion, 1167*c44c4cceSBoris Brezillon &oobregion, iter); 1168*c44c4cceSBoris Brezillon 1169*c44c4cceSBoris Brezillon while (!ret) { 1170*c44c4cceSBoris Brezillon int cnt; 1171*c44c4cceSBoris Brezillon 1172*c44c4cceSBoris Brezillon cnt = min_t(int, nbytes, oobregion.length); 1173*c44c4cceSBoris Brezillon memcpy(buf, oobbuf + oobregion.offset, cnt); 1174*c44c4cceSBoris Brezillon buf += cnt; 1175*c44c4cceSBoris Brezillon nbytes -= cnt; 1176*c44c4cceSBoris Brezillon 1177*c44c4cceSBoris Brezillon if (!nbytes) 1178*c44c4cceSBoris Brezillon break; 1179*c44c4cceSBoris Brezillon 1180*c44c4cceSBoris Brezillon ret = iter(mtd, ++section, &oobregion); 1181*c44c4cceSBoris Brezillon } 1182*c44c4cceSBoris Brezillon 1183*c44c4cceSBoris Brezillon return ret; 1184*c44c4cceSBoris Brezillon } 1185*c44c4cceSBoris Brezillon 1186*c44c4cceSBoris Brezillon /** 1187*c44c4cceSBoris Brezillon * mtd_ooblayout_set_bytes - put OOB bytes into the oob buffer 1188*c44c4cceSBoris Brezillon * @mtd: mtd info structure 1189*c44c4cceSBoris Brezillon * @buf: source buffer to get OOB bytes from 1190*c44c4cceSBoris Brezillon * @oobbuf: OOB buffer 1191*c44c4cceSBoris Brezillon * @start: first OOB byte to set 1192*c44c4cceSBoris Brezillon * @nbytes: number of OOB bytes to set 1193*c44c4cceSBoris Brezillon * @iter: section iterator 1194*c44c4cceSBoris Brezillon * 1195*c44c4cceSBoris Brezillon * Fill the OOB buffer with data provided in buf. The category (ECC or free) 1196*c44c4cceSBoris Brezillon * is selected by passing the appropriate iterator. 1197*c44c4cceSBoris Brezillon * 1198*c44c4cceSBoris Brezillon * Returns zero on success, a negative error code otherwise. 1199*c44c4cceSBoris Brezillon */ 1200*c44c4cceSBoris Brezillon static int mtd_ooblayout_set_bytes(struct mtd_info *mtd, const u8 *buf, 1201*c44c4cceSBoris Brezillon u8 *oobbuf, int start, int nbytes, 1202*c44c4cceSBoris Brezillon int (*iter)(struct mtd_info *, 1203*c44c4cceSBoris Brezillon int section, 1204*c44c4cceSBoris Brezillon struct mtd_oob_region *oobregion)) 1205*c44c4cceSBoris Brezillon { 1206*c44c4cceSBoris Brezillon struct mtd_oob_region oobregion; 1207*c44c4cceSBoris Brezillon int section, ret; 1208*c44c4cceSBoris Brezillon 1209*c44c4cceSBoris Brezillon ret = mtd_ooblayout_find_region(mtd, start, §ion, 1210*c44c4cceSBoris Brezillon &oobregion, iter); 1211*c44c4cceSBoris Brezillon 1212*c44c4cceSBoris Brezillon while (!ret) { 1213*c44c4cceSBoris Brezillon int cnt; 1214*c44c4cceSBoris Brezillon 1215*c44c4cceSBoris Brezillon cnt = min_t(int, nbytes, oobregion.length); 1216*c44c4cceSBoris Brezillon memcpy(oobbuf + oobregion.offset, buf, cnt); 1217*c44c4cceSBoris Brezillon buf += cnt; 1218*c44c4cceSBoris Brezillon nbytes -= cnt; 1219*c44c4cceSBoris Brezillon 1220*c44c4cceSBoris Brezillon if (!nbytes) 1221*c44c4cceSBoris Brezillon break; 1222*c44c4cceSBoris Brezillon 1223*c44c4cceSBoris Brezillon ret = iter(mtd, ++section, &oobregion); 1224*c44c4cceSBoris Brezillon } 1225*c44c4cceSBoris Brezillon 1226*c44c4cceSBoris Brezillon return ret; 1227*c44c4cceSBoris Brezillon } 1228*c44c4cceSBoris Brezillon 1229*c44c4cceSBoris Brezillon /** 1230*c44c4cceSBoris Brezillon * mtd_ooblayout_count_bytes - count the number of bytes in a OOB category 1231*c44c4cceSBoris Brezillon * @mtd: mtd info structure 1232*c44c4cceSBoris Brezillon * @iter: category iterator 1233*c44c4cceSBoris Brezillon * 1234*c44c4cceSBoris Brezillon * Count the number of bytes in a given category. 1235*c44c4cceSBoris Brezillon * 1236*c44c4cceSBoris Brezillon * Returns a positive value on success, a negative error code otherwise. 1237*c44c4cceSBoris Brezillon */ 1238*c44c4cceSBoris Brezillon static int mtd_ooblayout_count_bytes(struct mtd_info *mtd, 1239*c44c4cceSBoris Brezillon int (*iter)(struct mtd_info *, 1240*c44c4cceSBoris Brezillon int section, 1241*c44c4cceSBoris Brezillon struct mtd_oob_region *oobregion)) 1242*c44c4cceSBoris Brezillon { 1243*c44c4cceSBoris Brezillon struct mtd_oob_region oobregion; 1244*c44c4cceSBoris Brezillon int section = 0, ret, nbytes = 0; 1245*c44c4cceSBoris Brezillon 1246*c44c4cceSBoris Brezillon while (1) { 1247*c44c4cceSBoris Brezillon ret = iter(mtd, section++, &oobregion); 1248*c44c4cceSBoris Brezillon if (ret) { 1249*c44c4cceSBoris Brezillon if (ret == -ERANGE) 1250*c44c4cceSBoris Brezillon ret = nbytes; 1251*c44c4cceSBoris Brezillon break; 1252*c44c4cceSBoris Brezillon } 1253*c44c4cceSBoris Brezillon 1254*c44c4cceSBoris Brezillon nbytes += oobregion.length; 1255*c44c4cceSBoris Brezillon } 1256*c44c4cceSBoris Brezillon 1257*c44c4cceSBoris Brezillon return ret; 1258*c44c4cceSBoris Brezillon } 1259*c44c4cceSBoris Brezillon 1260*c44c4cceSBoris Brezillon /** 1261*c44c4cceSBoris Brezillon * mtd_ooblayout_get_eccbytes - extract ECC bytes from the oob buffer 1262*c44c4cceSBoris Brezillon * @mtd: mtd info structure 1263*c44c4cceSBoris Brezillon * @eccbuf: destination buffer to store ECC bytes 1264*c44c4cceSBoris Brezillon * @oobbuf: OOB buffer 1265*c44c4cceSBoris Brezillon * @start: first ECC byte to retrieve 1266*c44c4cceSBoris Brezillon * @nbytes: number of ECC bytes to retrieve 1267*c44c4cceSBoris Brezillon * 1268*c44c4cceSBoris Brezillon * Works like mtd_ooblayout_get_bytes(), except it acts on ECC bytes. 1269*c44c4cceSBoris Brezillon * 1270*c44c4cceSBoris Brezillon * Returns zero on success, a negative error code otherwise. 1271*c44c4cceSBoris Brezillon */ 1272*c44c4cceSBoris Brezillon int mtd_ooblayout_get_eccbytes(struct mtd_info *mtd, u8 *eccbuf, 1273*c44c4cceSBoris Brezillon const u8 *oobbuf, int start, int nbytes) 1274*c44c4cceSBoris Brezillon { 1275*c44c4cceSBoris Brezillon return mtd_ooblayout_get_bytes(mtd, eccbuf, oobbuf, start, nbytes, 1276*c44c4cceSBoris Brezillon mtd_ooblayout_ecc); 1277*c44c4cceSBoris Brezillon } 1278*c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_get_eccbytes); 1279*c44c4cceSBoris Brezillon 1280*c44c4cceSBoris Brezillon /** 1281*c44c4cceSBoris Brezillon * mtd_ooblayout_set_eccbytes - set ECC bytes into the oob buffer 1282*c44c4cceSBoris Brezillon * @mtd: mtd info structure 1283*c44c4cceSBoris Brezillon * @eccbuf: source buffer to get ECC bytes from 1284*c44c4cceSBoris Brezillon * @oobbuf: OOB buffer 1285*c44c4cceSBoris Brezillon * @start: first ECC byte to set 1286*c44c4cceSBoris Brezillon * @nbytes: number of ECC bytes to set 1287*c44c4cceSBoris Brezillon * 1288*c44c4cceSBoris Brezillon * Works like mtd_ooblayout_set_bytes(), except it acts on ECC bytes. 1289*c44c4cceSBoris Brezillon * 1290*c44c4cceSBoris Brezillon * Returns zero on success, a negative error code otherwise. 1291*c44c4cceSBoris Brezillon */ 1292*c44c4cceSBoris Brezillon int mtd_ooblayout_set_eccbytes(struct mtd_info *mtd, const u8 *eccbuf, 1293*c44c4cceSBoris Brezillon u8 *oobbuf, int start, int nbytes) 1294*c44c4cceSBoris Brezillon { 1295*c44c4cceSBoris Brezillon return mtd_ooblayout_set_bytes(mtd, eccbuf, oobbuf, start, nbytes, 1296*c44c4cceSBoris Brezillon mtd_ooblayout_ecc); 1297*c44c4cceSBoris Brezillon } 1298*c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_set_eccbytes); 1299*c44c4cceSBoris Brezillon 1300*c44c4cceSBoris Brezillon /** 1301*c44c4cceSBoris Brezillon * mtd_ooblayout_get_databytes - extract data bytes from the oob buffer 1302*c44c4cceSBoris Brezillon * @mtd: mtd info structure 1303*c44c4cceSBoris Brezillon * @databuf: destination buffer to store ECC bytes 1304*c44c4cceSBoris Brezillon * @oobbuf: OOB buffer 1305*c44c4cceSBoris Brezillon * @start: first ECC byte to retrieve 1306*c44c4cceSBoris Brezillon * @nbytes: number of ECC bytes to retrieve 1307*c44c4cceSBoris Brezillon * 1308*c44c4cceSBoris Brezillon * Works like mtd_ooblayout_get_bytes(), except it acts on free bytes. 1309*c44c4cceSBoris Brezillon * 1310*c44c4cceSBoris Brezillon * Returns zero on success, a negative error code otherwise. 1311*c44c4cceSBoris Brezillon */ 1312*c44c4cceSBoris Brezillon int mtd_ooblayout_get_databytes(struct mtd_info *mtd, u8 *databuf, 1313*c44c4cceSBoris Brezillon const u8 *oobbuf, int start, int nbytes) 1314*c44c4cceSBoris Brezillon { 1315*c44c4cceSBoris Brezillon return mtd_ooblayout_get_bytes(mtd, databuf, oobbuf, start, nbytes, 1316*c44c4cceSBoris Brezillon mtd_ooblayout_free); 1317*c44c4cceSBoris Brezillon } 1318*c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_get_databytes); 1319*c44c4cceSBoris Brezillon 1320*c44c4cceSBoris Brezillon /** 1321*c44c4cceSBoris Brezillon * mtd_ooblayout_get_eccbytes - set data bytes into the oob buffer 1322*c44c4cceSBoris Brezillon * @mtd: mtd info structure 1323*c44c4cceSBoris Brezillon * @eccbuf: source buffer to get data bytes from 1324*c44c4cceSBoris Brezillon * @oobbuf: OOB buffer 1325*c44c4cceSBoris Brezillon * @start: first ECC byte to set 1326*c44c4cceSBoris Brezillon * @nbytes: number of ECC bytes to set 1327*c44c4cceSBoris Brezillon * 1328*c44c4cceSBoris Brezillon * Works like mtd_ooblayout_get_bytes(), except it acts on free bytes. 1329*c44c4cceSBoris Brezillon * 1330*c44c4cceSBoris Brezillon * Returns zero on success, a negative error code otherwise. 1331*c44c4cceSBoris Brezillon */ 1332*c44c4cceSBoris Brezillon int mtd_ooblayout_set_databytes(struct mtd_info *mtd, const u8 *databuf, 1333*c44c4cceSBoris Brezillon u8 *oobbuf, int start, int nbytes) 1334*c44c4cceSBoris Brezillon { 1335*c44c4cceSBoris Brezillon return mtd_ooblayout_set_bytes(mtd, databuf, oobbuf, start, nbytes, 1336*c44c4cceSBoris Brezillon mtd_ooblayout_free); 1337*c44c4cceSBoris Brezillon } 1338*c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_set_databytes); 1339*c44c4cceSBoris Brezillon 1340*c44c4cceSBoris Brezillon /** 1341*c44c4cceSBoris Brezillon * mtd_ooblayout_count_freebytes - count the number of free bytes in OOB 1342*c44c4cceSBoris Brezillon * @mtd: mtd info structure 1343*c44c4cceSBoris Brezillon * 1344*c44c4cceSBoris Brezillon * Works like mtd_ooblayout_count_bytes(), except it count free bytes. 1345*c44c4cceSBoris Brezillon * 1346*c44c4cceSBoris Brezillon * Returns zero on success, a negative error code otherwise. 1347*c44c4cceSBoris Brezillon */ 1348*c44c4cceSBoris Brezillon int mtd_ooblayout_count_freebytes(struct mtd_info *mtd) 1349*c44c4cceSBoris Brezillon { 1350*c44c4cceSBoris Brezillon return mtd_ooblayout_count_bytes(mtd, mtd_ooblayout_free); 1351*c44c4cceSBoris Brezillon } 1352*c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_count_freebytes); 1353*c44c4cceSBoris Brezillon 1354*c44c4cceSBoris Brezillon /** 1355*c44c4cceSBoris Brezillon * mtd_ooblayout_count_freebytes - count the number of ECC bytes in OOB 1356*c44c4cceSBoris Brezillon * @mtd: mtd info structure 1357*c44c4cceSBoris Brezillon * 1358*c44c4cceSBoris Brezillon * Works like mtd_ooblayout_count_bytes(), except it count ECC bytes. 1359*c44c4cceSBoris Brezillon * 1360*c44c4cceSBoris Brezillon * Returns zero on success, a negative error code otherwise. 1361*c44c4cceSBoris Brezillon */ 1362*c44c4cceSBoris Brezillon int mtd_ooblayout_count_eccbytes(struct mtd_info *mtd) 1363*c44c4cceSBoris Brezillon { 1364*c44c4cceSBoris Brezillon return mtd_ooblayout_count_bytes(mtd, mtd_ooblayout_ecc); 1365*c44c4cceSBoris Brezillon } 1366*c44c4cceSBoris Brezillon EXPORT_SYMBOL_GPL(mtd_ooblayout_count_eccbytes); 1367*c44c4cceSBoris Brezillon 1368dfe64e2cSSergey Lapin /* 1369dfe64e2cSSergey Lapin * Method to access the protection register area, present in some flash 1370dfe64e2cSSergey Lapin * devices. The user data is one time programmable but the factory data is read 1371dfe64e2cSSergey Lapin * only. 1372dfe64e2cSSergey Lapin */ 13734e67c571SHeiko Schocher int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen, 13744e67c571SHeiko Schocher struct otp_info *buf) 1375dfe64e2cSSergey Lapin { 1376dfe64e2cSSergey Lapin if (!mtd->_get_fact_prot_info) 1377dfe64e2cSSergey Lapin return -EOPNOTSUPP; 1378dfe64e2cSSergey Lapin if (!len) 1379dfe64e2cSSergey Lapin return 0; 13804e67c571SHeiko Schocher return mtd->_get_fact_prot_info(mtd, len, retlen, buf); 1381dfe64e2cSSergey Lapin } 1382ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_get_fact_prot_info); 1383dfe64e2cSSergey Lapin 1384dfe64e2cSSergey Lapin int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, 1385dfe64e2cSSergey Lapin size_t *retlen, u_char *buf) 1386dfe64e2cSSergey Lapin { 1387dfe64e2cSSergey Lapin *retlen = 0; 1388dfe64e2cSSergey Lapin if (!mtd->_read_fact_prot_reg) 1389dfe64e2cSSergey Lapin return -EOPNOTSUPP; 1390dfe64e2cSSergey Lapin if (!len) 1391dfe64e2cSSergey Lapin return 0; 1392dfe64e2cSSergey Lapin return mtd->_read_fact_prot_reg(mtd, from, len, retlen, buf); 1393dfe64e2cSSergey Lapin } 1394ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_read_fact_prot_reg); 1395dfe64e2cSSergey Lapin 13964e67c571SHeiko Schocher int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen, 13974e67c571SHeiko Schocher struct otp_info *buf) 1398dfe64e2cSSergey Lapin { 1399dfe64e2cSSergey Lapin if (!mtd->_get_user_prot_info) 1400dfe64e2cSSergey Lapin return -EOPNOTSUPP; 1401dfe64e2cSSergey Lapin if (!len) 1402dfe64e2cSSergey Lapin return 0; 14034e67c571SHeiko Schocher return mtd->_get_user_prot_info(mtd, len, retlen, buf); 1404dfe64e2cSSergey Lapin } 1405ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_get_user_prot_info); 1406dfe64e2cSSergey Lapin 1407dfe64e2cSSergey Lapin int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, 1408dfe64e2cSSergey Lapin size_t *retlen, u_char *buf) 1409dfe64e2cSSergey Lapin { 1410dfe64e2cSSergey Lapin *retlen = 0; 1411dfe64e2cSSergey Lapin if (!mtd->_read_user_prot_reg) 1412dfe64e2cSSergey Lapin return -EOPNOTSUPP; 1413dfe64e2cSSergey Lapin if (!len) 1414dfe64e2cSSergey Lapin return 0; 1415dfe64e2cSSergey Lapin return mtd->_read_user_prot_reg(mtd, from, len, retlen, buf); 1416dfe64e2cSSergey Lapin } 1417ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_read_user_prot_reg); 1418dfe64e2cSSergey Lapin 1419dfe64e2cSSergey Lapin int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len, 1420dfe64e2cSSergey Lapin size_t *retlen, u_char *buf) 1421dfe64e2cSSergey Lapin { 14224e67c571SHeiko Schocher int ret; 14234e67c571SHeiko Schocher 1424dfe64e2cSSergey Lapin *retlen = 0; 1425dfe64e2cSSergey Lapin if (!mtd->_write_user_prot_reg) 1426dfe64e2cSSergey Lapin return -EOPNOTSUPP; 1427dfe64e2cSSergey Lapin if (!len) 1428dfe64e2cSSergey Lapin return 0; 14294e67c571SHeiko Schocher ret = mtd->_write_user_prot_reg(mtd, to, len, retlen, buf); 14304e67c571SHeiko Schocher if (ret) 14314e67c571SHeiko Schocher return ret; 14324e67c571SHeiko Schocher 14334e67c571SHeiko Schocher /* 14344e67c571SHeiko Schocher * If no data could be written at all, we are out of memory and 14354e67c571SHeiko Schocher * must return -ENOSPC. 14364e67c571SHeiko Schocher */ 14374e67c571SHeiko Schocher return (*retlen) ? 0 : -ENOSPC; 1438dfe64e2cSSergey Lapin } 1439ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_write_user_prot_reg); 1440dfe64e2cSSergey Lapin 1441dfe64e2cSSergey Lapin int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len) 1442dfe64e2cSSergey Lapin { 1443dfe64e2cSSergey Lapin if (!mtd->_lock_user_prot_reg) 1444dfe64e2cSSergey Lapin return -EOPNOTSUPP; 1445dfe64e2cSSergey Lapin if (!len) 1446dfe64e2cSSergey Lapin return 0; 1447dfe64e2cSSergey Lapin return mtd->_lock_user_prot_reg(mtd, from, len); 1448dfe64e2cSSergey Lapin } 1449ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_lock_user_prot_reg); 1450dfe64e2cSSergey Lapin 1451dfe64e2cSSergey Lapin /* Chip-supported device locking */ 1452dfe64e2cSSergey Lapin int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len) 1453dfe64e2cSSergey Lapin { 1454dfe64e2cSSergey Lapin if (!mtd->_lock) 1455dfe64e2cSSergey Lapin return -EOPNOTSUPP; 1456dfe64e2cSSergey Lapin if (ofs < 0 || ofs > mtd->size || len > mtd->size - ofs) 1457dfe64e2cSSergey Lapin return -EINVAL; 1458dfe64e2cSSergey Lapin if (!len) 1459dfe64e2cSSergey Lapin return 0; 1460dfe64e2cSSergey Lapin return mtd->_lock(mtd, ofs, len); 1461dfe64e2cSSergey Lapin } 1462ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_lock); 1463dfe64e2cSSergey Lapin 1464dfe64e2cSSergey Lapin int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len) 1465dfe64e2cSSergey Lapin { 1466dfe64e2cSSergey Lapin if (!mtd->_unlock) 1467dfe64e2cSSergey Lapin return -EOPNOTSUPP; 1468dfe64e2cSSergey Lapin if (ofs < 0 || ofs > mtd->size || len > mtd->size - ofs) 1469dfe64e2cSSergey Lapin return -EINVAL; 1470dfe64e2cSSergey Lapin if (!len) 1471dfe64e2cSSergey Lapin return 0; 1472dfe64e2cSSergey Lapin return mtd->_unlock(mtd, ofs, len); 1473dfe64e2cSSergey Lapin } 1474ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_unlock); 1475ff94bc40SHeiko Schocher 1476ff94bc40SHeiko Schocher int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len) 1477ff94bc40SHeiko Schocher { 1478ff94bc40SHeiko Schocher if (!mtd->_is_locked) 1479ff94bc40SHeiko Schocher return -EOPNOTSUPP; 1480ff94bc40SHeiko Schocher if (ofs < 0 || ofs > mtd->size || len > mtd->size - ofs) 1481ff94bc40SHeiko Schocher return -EINVAL; 1482ff94bc40SHeiko Schocher if (!len) 1483ff94bc40SHeiko Schocher return 0; 1484ff94bc40SHeiko Schocher return mtd->_is_locked(mtd, ofs, len); 1485ff94bc40SHeiko Schocher } 1486ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_is_locked); 1487dfe64e2cSSergey Lapin 148886a720aaSEzequiel Garcia int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs) 1489dfe64e2cSSergey Lapin { 1490dfe64e2cSSergey Lapin if (ofs < 0 || ofs > mtd->size) 1491dfe64e2cSSergey Lapin return -EINVAL; 149286a720aaSEzequiel Garcia if (!mtd->_block_isreserved) 149386a720aaSEzequiel Garcia return 0; 149486a720aaSEzequiel Garcia return mtd->_block_isreserved(mtd, ofs); 149586a720aaSEzequiel Garcia } 149686a720aaSEzequiel Garcia EXPORT_SYMBOL_GPL(mtd_block_isreserved); 149786a720aaSEzequiel Garcia 149886a720aaSEzequiel Garcia int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs) 149986a720aaSEzequiel Garcia { 150086a720aaSEzequiel Garcia if (ofs < 0 || ofs > mtd->size) 150186a720aaSEzequiel Garcia return -EINVAL; 150286a720aaSEzequiel Garcia if (!mtd->_block_isbad) 150386a720aaSEzequiel Garcia return 0; 1504dfe64e2cSSergey Lapin return mtd->_block_isbad(mtd, ofs); 1505dfe64e2cSSergey Lapin } 1506ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_block_isbad); 1507dfe64e2cSSergey Lapin 1508dfe64e2cSSergey Lapin int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs) 1509dfe64e2cSSergey Lapin { 1510dfe64e2cSSergey Lapin if (!mtd->_block_markbad) 1511dfe64e2cSSergey Lapin return -EOPNOTSUPP; 1512dfe64e2cSSergey Lapin if (ofs < 0 || ofs > mtd->size) 1513dfe64e2cSSergey Lapin return -EINVAL; 1514dfe64e2cSSergey Lapin if (!(mtd->flags & MTD_WRITEABLE)) 1515dfe64e2cSSergey Lapin return -EROFS; 1516dfe64e2cSSergey Lapin return mtd->_block_markbad(mtd, ofs); 1517dfe64e2cSSergey Lapin } 1518ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_block_markbad); 1519ff94bc40SHeiko Schocher 1520ff94bc40SHeiko Schocher #ifndef __UBOOT__ 1521ff94bc40SHeiko Schocher /* 1522ff94bc40SHeiko Schocher * default_mtd_writev - the default writev method 1523ff94bc40SHeiko Schocher * @mtd: mtd device description object pointer 1524ff94bc40SHeiko Schocher * @vecs: the vectors to write 1525ff94bc40SHeiko Schocher * @count: count of vectors in @vecs 1526ff94bc40SHeiko Schocher * @to: the MTD device offset to write to 1527ff94bc40SHeiko Schocher * @retlen: on exit contains the count of bytes written to the MTD device. 1528ff94bc40SHeiko Schocher * 1529ff94bc40SHeiko Schocher * This function returns zero in case of success and a negative error code in 1530ff94bc40SHeiko Schocher * case of failure. 1531ff94bc40SHeiko Schocher */ 1532ff94bc40SHeiko Schocher static int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, 1533ff94bc40SHeiko Schocher unsigned long count, loff_t to, size_t *retlen) 1534ff94bc40SHeiko Schocher { 1535ff94bc40SHeiko Schocher unsigned long i; 1536ff94bc40SHeiko Schocher size_t totlen = 0, thislen; 1537ff94bc40SHeiko Schocher int ret = 0; 1538ff94bc40SHeiko Schocher 1539ff94bc40SHeiko Schocher for (i = 0; i < count; i++) { 1540ff94bc40SHeiko Schocher if (!vecs[i].iov_len) 1541ff94bc40SHeiko Schocher continue; 1542ff94bc40SHeiko Schocher ret = mtd_write(mtd, to, vecs[i].iov_len, &thislen, 1543ff94bc40SHeiko Schocher vecs[i].iov_base); 1544ff94bc40SHeiko Schocher totlen += thislen; 1545ff94bc40SHeiko Schocher if (ret || thislen != vecs[i].iov_len) 1546ff94bc40SHeiko Schocher break; 1547ff94bc40SHeiko Schocher to += vecs[i].iov_len; 1548ff94bc40SHeiko Schocher } 1549ff94bc40SHeiko Schocher *retlen = totlen; 1550ff94bc40SHeiko Schocher return ret; 1551ff94bc40SHeiko Schocher } 1552ff94bc40SHeiko Schocher 1553ff94bc40SHeiko Schocher /* 1554ff94bc40SHeiko Schocher * mtd_writev - the vector-based MTD write method 1555ff94bc40SHeiko Schocher * @mtd: mtd device description object pointer 1556ff94bc40SHeiko Schocher * @vecs: the vectors to write 1557ff94bc40SHeiko Schocher * @count: count of vectors in @vecs 1558ff94bc40SHeiko Schocher * @to: the MTD device offset to write to 1559ff94bc40SHeiko Schocher * @retlen: on exit contains the count of bytes written to the MTD device. 1560ff94bc40SHeiko Schocher * 1561ff94bc40SHeiko Schocher * This function returns zero in case of success and a negative error code in 1562ff94bc40SHeiko Schocher * case of failure. 1563ff94bc40SHeiko Schocher */ 1564ff94bc40SHeiko Schocher int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, 1565ff94bc40SHeiko Schocher unsigned long count, loff_t to, size_t *retlen) 1566ff94bc40SHeiko Schocher { 1567ff94bc40SHeiko Schocher *retlen = 0; 1568ff94bc40SHeiko Schocher if (!(mtd->flags & MTD_WRITEABLE)) 1569ff94bc40SHeiko Schocher return -EROFS; 1570ff94bc40SHeiko Schocher if (!mtd->_writev) 1571ff94bc40SHeiko Schocher return default_mtd_writev(mtd, vecs, count, to, retlen); 1572ff94bc40SHeiko Schocher return mtd->_writev(mtd, vecs, count, to, retlen); 1573ff94bc40SHeiko Schocher } 1574ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_writev); 1575ff94bc40SHeiko Schocher 1576ff94bc40SHeiko Schocher /** 1577ff94bc40SHeiko Schocher * mtd_kmalloc_up_to - allocate a contiguous buffer up to the specified size 1578ff94bc40SHeiko Schocher * @mtd: mtd device description object pointer 1579ff94bc40SHeiko Schocher * @size: a pointer to the ideal or maximum size of the allocation, points 1580ff94bc40SHeiko Schocher * to the actual allocation size on success. 1581ff94bc40SHeiko Schocher * 1582ff94bc40SHeiko Schocher * This routine attempts to allocate a contiguous kernel buffer up to 1583ff94bc40SHeiko Schocher * the specified size, backing off the size of the request exponentially 1584ff94bc40SHeiko Schocher * until the request succeeds or until the allocation size falls below 1585ff94bc40SHeiko Schocher * the system page size. This attempts to make sure it does not adversely 1586ff94bc40SHeiko Schocher * impact system performance, so when allocating more than one page, we 1587ff94bc40SHeiko Schocher * ask the memory allocator to avoid re-trying, swapping, writing back 1588ff94bc40SHeiko Schocher * or performing I/O. 1589ff94bc40SHeiko Schocher * 1590ff94bc40SHeiko Schocher * Note, this function also makes sure that the allocated buffer is aligned to 1591ff94bc40SHeiko Schocher * the MTD device's min. I/O unit, i.e. the "mtd->writesize" value. 1592ff94bc40SHeiko Schocher * 1593ff94bc40SHeiko Schocher * This is called, for example by mtd_{read,write} and jffs2_scan_medium, 1594ff94bc40SHeiko Schocher * to handle smaller (i.e. degraded) buffer allocations under low- or 1595ff94bc40SHeiko Schocher * fragmented-memory situations where such reduced allocations, from a 1596ff94bc40SHeiko Schocher * requested ideal, are allowed. 1597ff94bc40SHeiko Schocher * 1598ff94bc40SHeiko Schocher * Returns a pointer to the allocated buffer on success; otherwise, NULL. 1599ff94bc40SHeiko Schocher */ 1600ff94bc40SHeiko Schocher void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size) 1601ff94bc40SHeiko Schocher { 1602ff94bc40SHeiko Schocher gfp_t flags = __GFP_NOWARN | __GFP_WAIT | 1603ff94bc40SHeiko Schocher __GFP_NORETRY | __GFP_NO_KSWAPD; 1604ff94bc40SHeiko Schocher size_t min_alloc = max_t(size_t, mtd->writesize, PAGE_SIZE); 1605ff94bc40SHeiko Schocher void *kbuf; 1606ff94bc40SHeiko Schocher 1607ff94bc40SHeiko Schocher *size = min_t(size_t, *size, KMALLOC_MAX_SIZE); 1608ff94bc40SHeiko Schocher 1609ff94bc40SHeiko Schocher while (*size > min_alloc) { 1610ff94bc40SHeiko Schocher kbuf = kmalloc(*size, flags); 1611ff94bc40SHeiko Schocher if (kbuf) 1612ff94bc40SHeiko Schocher return kbuf; 1613ff94bc40SHeiko Schocher 1614ff94bc40SHeiko Schocher *size >>= 1; 1615ff94bc40SHeiko Schocher *size = ALIGN(*size, mtd->writesize); 1616ff94bc40SHeiko Schocher } 1617ff94bc40SHeiko Schocher 1618ff94bc40SHeiko Schocher /* 1619ff94bc40SHeiko Schocher * For the last resort allocation allow 'kmalloc()' to do all sorts of 1620ff94bc40SHeiko Schocher * things (write-back, dropping caches, etc) by using GFP_KERNEL. 1621ff94bc40SHeiko Schocher */ 1622ff94bc40SHeiko Schocher return kmalloc(*size, GFP_KERNEL); 1623ff94bc40SHeiko Schocher } 1624ff94bc40SHeiko Schocher EXPORT_SYMBOL_GPL(mtd_kmalloc_up_to); 1625ff94bc40SHeiko Schocher #endif 1626ff94bc40SHeiko Schocher 1627ff94bc40SHeiko Schocher #ifdef CONFIG_PROC_FS 1628ff94bc40SHeiko Schocher 1629ff94bc40SHeiko Schocher /*====================================================================*/ 1630ff94bc40SHeiko Schocher /* Support for /proc/mtd */ 1631ff94bc40SHeiko Schocher 1632ff94bc40SHeiko Schocher static int mtd_proc_show(struct seq_file *m, void *v) 1633ff94bc40SHeiko Schocher { 1634ff94bc40SHeiko Schocher struct mtd_info *mtd; 1635ff94bc40SHeiko Schocher 1636ff94bc40SHeiko Schocher seq_puts(m, "dev: size erasesize name\n"); 1637ff94bc40SHeiko Schocher mutex_lock(&mtd_table_mutex); 1638ff94bc40SHeiko Schocher mtd_for_each_device(mtd) { 1639ff94bc40SHeiko Schocher seq_printf(m, "mtd%d: %8.8llx %8.8x \"%s\"\n", 1640ff94bc40SHeiko Schocher mtd->index, (unsigned long long)mtd->size, 1641ff94bc40SHeiko Schocher mtd->erasesize, mtd->name); 1642ff94bc40SHeiko Schocher } 1643ff94bc40SHeiko Schocher mutex_unlock(&mtd_table_mutex); 1644ff94bc40SHeiko Schocher return 0; 1645ff94bc40SHeiko Schocher } 1646ff94bc40SHeiko Schocher 1647ff94bc40SHeiko Schocher static int mtd_proc_open(struct inode *inode, struct file *file) 1648ff94bc40SHeiko Schocher { 1649ff94bc40SHeiko Schocher return single_open(file, mtd_proc_show, NULL); 1650ff94bc40SHeiko Schocher } 1651ff94bc40SHeiko Schocher 1652ff94bc40SHeiko Schocher static const struct file_operations mtd_proc_ops = { 1653ff94bc40SHeiko Schocher .open = mtd_proc_open, 1654ff94bc40SHeiko Schocher .read = seq_read, 1655ff94bc40SHeiko Schocher .llseek = seq_lseek, 1656ff94bc40SHeiko Schocher .release = single_release, 1657ff94bc40SHeiko Schocher }; 1658ff94bc40SHeiko Schocher #endif /* CONFIG_PROC_FS */ 1659ff94bc40SHeiko Schocher 1660ff94bc40SHeiko Schocher /*====================================================================*/ 1661ff94bc40SHeiko Schocher /* Init code */ 1662ff94bc40SHeiko Schocher 1663ff94bc40SHeiko Schocher #ifndef __UBOOT__ 1664ff94bc40SHeiko Schocher static int __init mtd_bdi_init(struct backing_dev_info *bdi, const char *name) 1665ff94bc40SHeiko Schocher { 1666ff94bc40SHeiko Schocher int ret; 1667ff94bc40SHeiko Schocher 1668ff94bc40SHeiko Schocher ret = bdi_init(bdi); 1669ff94bc40SHeiko Schocher if (!ret) 1670ff94bc40SHeiko Schocher ret = bdi_register(bdi, NULL, "%s", name); 1671ff94bc40SHeiko Schocher 1672ff94bc40SHeiko Schocher if (ret) 1673ff94bc40SHeiko Schocher bdi_destroy(bdi); 1674ff94bc40SHeiko Schocher 1675ff94bc40SHeiko Schocher return ret; 1676ff94bc40SHeiko Schocher } 1677ff94bc40SHeiko Schocher 1678ff94bc40SHeiko Schocher static struct proc_dir_entry *proc_mtd; 1679ff94bc40SHeiko Schocher 1680ff94bc40SHeiko Schocher static int __init init_mtd(void) 1681ff94bc40SHeiko Schocher { 1682ff94bc40SHeiko Schocher int ret; 1683ff94bc40SHeiko Schocher 1684ff94bc40SHeiko Schocher ret = class_register(&mtd_class); 1685ff94bc40SHeiko Schocher if (ret) 1686ff94bc40SHeiko Schocher goto err_reg; 1687ff94bc40SHeiko Schocher 1688ff94bc40SHeiko Schocher ret = mtd_bdi_init(&mtd_bdi_unmappable, "mtd-unmap"); 1689ff94bc40SHeiko Schocher if (ret) 1690ff94bc40SHeiko Schocher goto err_bdi1; 1691ff94bc40SHeiko Schocher 1692ff94bc40SHeiko Schocher ret = mtd_bdi_init(&mtd_bdi_ro_mappable, "mtd-romap"); 1693ff94bc40SHeiko Schocher if (ret) 1694ff94bc40SHeiko Schocher goto err_bdi2; 1695ff94bc40SHeiko Schocher 1696ff94bc40SHeiko Schocher ret = mtd_bdi_init(&mtd_bdi_rw_mappable, "mtd-rwmap"); 1697ff94bc40SHeiko Schocher if (ret) 1698ff94bc40SHeiko Schocher goto err_bdi3; 1699ff94bc40SHeiko Schocher 1700ff94bc40SHeiko Schocher proc_mtd = proc_create("mtd", 0, NULL, &mtd_proc_ops); 1701ff94bc40SHeiko Schocher 1702ff94bc40SHeiko Schocher ret = init_mtdchar(); 1703ff94bc40SHeiko Schocher if (ret) 1704ff94bc40SHeiko Schocher goto out_procfs; 1705ff94bc40SHeiko Schocher 1706ff94bc40SHeiko Schocher return 0; 1707ff94bc40SHeiko Schocher 1708ff94bc40SHeiko Schocher out_procfs: 1709ff94bc40SHeiko Schocher if (proc_mtd) 1710ff94bc40SHeiko Schocher remove_proc_entry("mtd", NULL); 1711ff94bc40SHeiko Schocher err_bdi3: 1712ff94bc40SHeiko Schocher bdi_destroy(&mtd_bdi_ro_mappable); 1713ff94bc40SHeiko Schocher err_bdi2: 1714ff94bc40SHeiko Schocher bdi_destroy(&mtd_bdi_unmappable); 1715ff94bc40SHeiko Schocher err_bdi1: 1716ff94bc40SHeiko Schocher class_unregister(&mtd_class); 1717ff94bc40SHeiko Schocher err_reg: 1718ff94bc40SHeiko Schocher pr_err("Error registering mtd class or bdi: %d\n", ret); 1719ff94bc40SHeiko Schocher return ret; 1720ff94bc40SHeiko Schocher } 1721ff94bc40SHeiko Schocher 1722ff94bc40SHeiko Schocher static void __exit cleanup_mtd(void) 1723ff94bc40SHeiko Schocher { 1724ff94bc40SHeiko Schocher cleanup_mtdchar(); 1725ff94bc40SHeiko Schocher if (proc_mtd) 1726ff94bc40SHeiko Schocher remove_proc_entry("mtd", NULL); 1727ff94bc40SHeiko Schocher class_unregister(&mtd_class); 1728ff94bc40SHeiko Schocher bdi_destroy(&mtd_bdi_unmappable); 1729ff94bc40SHeiko Schocher bdi_destroy(&mtd_bdi_ro_mappable); 1730ff94bc40SHeiko Schocher bdi_destroy(&mtd_bdi_rw_mappable); 1731ff94bc40SHeiko Schocher } 1732ff94bc40SHeiko Schocher 1733ff94bc40SHeiko Schocher module_init(init_mtd); 1734ff94bc40SHeiko Schocher module_exit(cleanup_mtd); 1735ff94bc40SHeiko Schocher #endif 1736ff94bc40SHeiko Schocher 1737ff94bc40SHeiko Schocher MODULE_LICENSE("GPL"); 1738ff94bc40SHeiko Schocher MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>"); 1739ff94bc40SHeiko Schocher MODULE_DESCRIPTION("Core MTD registration and access routines"); 1740