xref: /openbmc/linux/drivers/mtd/chips/map_ram.c (revision 2612e3bbc0386368a850140a6c9b990cd496a5ec)
1*87194abaSLinus Walleij // SPDX-License-Identifier: GPL-2.0
21da177e4SLinus Torvalds /*
31da177e4SLinus Torvalds  * Common code to handle map devices which are simple RAM
4*87194abaSLinus Walleij  * (C) 2000 Red Hat.
51da177e4SLinus Torvalds  */
61da177e4SLinus Torvalds 
71da177e4SLinus Torvalds #include <linux/module.h>
81da177e4SLinus Torvalds #include <linux/types.h>
91da177e4SLinus Torvalds #include <linux/kernel.h>
101da177e4SLinus Torvalds #include <asm/io.h>
111da177e4SLinus Torvalds #include <asm/byteorder.h>
121da177e4SLinus Torvalds #include <linux/errno.h>
131da177e4SLinus Torvalds #include <linux/slab.h>
141da177e4SLinus Torvalds #include <linux/init.h>
151da177e4SLinus Torvalds #include <linux/mtd/mtd.h>
161da177e4SLinus Torvalds #include <linux/mtd/map.h>
171da177e4SLinus Torvalds 
181da177e4SLinus Torvalds 
191da177e4SLinus Torvalds static int mapram_read (struct mtd_info *, loff_t, size_t, size_t *, u_char *);
201da177e4SLinus Torvalds static int mapram_write (struct mtd_info *, loff_t, size_t, size_t *, const u_char *);
211da177e4SLinus Torvalds static int mapram_erase (struct mtd_info *, struct erase_info *);
221da177e4SLinus Torvalds static void mapram_nop (struct mtd_info *);
231da177e4SLinus Torvalds static struct mtd_info *map_ram_probe(struct map_info *map);
242caaf2d8SNicolas Pitre static int mapram_point (struct mtd_info *mtd, loff_t from, size_t len,
252caaf2d8SNicolas Pitre 			 size_t *retlen, void **virt, resource_size_t *phys);
262caaf2d8SNicolas Pitre static int mapram_unpoint(struct mtd_info *mtd, loff_t from, size_t len);
271da177e4SLinus Torvalds 
281da177e4SLinus Torvalds 
291da177e4SLinus Torvalds static struct mtd_chip_driver mapram_chipdrv = {
301da177e4SLinus Torvalds 	.probe	= map_ram_probe,
311da177e4SLinus Torvalds 	.name	= "map_ram",
321da177e4SLinus Torvalds 	.module	= THIS_MODULE
331da177e4SLinus Torvalds };
341da177e4SLinus Torvalds 
map_ram_probe(struct map_info * map)351da177e4SLinus Torvalds static struct mtd_info *map_ram_probe(struct map_info *map)
361da177e4SLinus Torvalds {
371da177e4SLinus Torvalds 	struct mtd_info *mtd;
381da177e4SLinus Torvalds 
391da177e4SLinus Torvalds 	/* Check the first byte is RAM */
401da177e4SLinus Torvalds #if 0
411da177e4SLinus Torvalds 	map_write8(map, 0x55, 0);
421da177e4SLinus Torvalds 	if (map_read8(map, 0) != 0x55)
431da177e4SLinus Torvalds 		return NULL;
441da177e4SLinus Torvalds 
451da177e4SLinus Torvalds 	map_write8(map, 0xAA, 0);
461da177e4SLinus Torvalds 	if (map_read8(map, 0) != 0xAA)
471da177e4SLinus Torvalds 		return NULL;
481da177e4SLinus Torvalds 
491da177e4SLinus Torvalds 	/* Check the last byte is RAM */
501da177e4SLinus Torvalds 	map_write8(map, 0x55, map->size-1);
511da177e4SLinus Torvalds 	if (map_read8(map, map->size-1) != 0x55)
521da177e4SLinus Torvalds 		return NULL;
531da177e4SLinus Torvalds 
541da177e4SLinus Torvalds 	map_write8(map, 0xAA, map->size-1);
551da177e4SLinus Torvalds 	if (map_read8(map, map->size-1) != 0xAA)
561da177e4SLinus Torvalds 		return NULL;
571da177e4SLinus Torvalds #endif
581da177e4SLinus Torvalds 	/* OK. It seems to be RAM. */
591da177e4SLinus Torvalds 
6095b93a0cSBurman Yan 	mtd = kzalloc(sizeof(*mtd), GFP_KERNEL);
611da177e4SLinus Torvalds 	if (!mtd)
621da177e4SLinus Torvalds 		return NULL;
631da177e4SLinus Torvalds 
641da177e4SLinus Torvalds 	map->fldrv = &mapram_chipdrv;
651da177e4SLinus Torvalds 	mtd->priv = map;
661da177e4SLinus Torvalds 	mtd->name = map->name;
6721c8db9eSDavid Woodhouse 	mtd->type = MTD_RAM;
681da177e4SLinus Torvalds 	mtd->size = map->size;
693c3c10bbSArtem Bityutskiy 	mtd->_erase = mapram_erase;
703c3c10bbSArtem Bityutskiy 	mtd->_read = mapram_read;
713c3c10bbSArtem Bityutskiy 	mtd->_write = mapram_write;
72106effbeSAlessio Igor Bogani 	mtd->_panic_write = mapram_write;
732caaf2d8SNicolas Pitre 	mtd->_point = mapram_point;
743c3c10bbSArtem Bityutskiy 	mtd->_sync = mapram_nop;
752caaf2d8SNicolas Pitre 	mtd->_unpoint = mapram_unpoint;
76a6c591edSJörn Engel 	mtd->flags = MTD_CAP_RAM;
7717ffc7baSArtem B. Bityutskiy 	mtd->writesize = 1;
781da177e4SLinus Torvalds 
791da177e4SLinus Torvalds 	mtd->erasesize = PAGE_SIZE;
801da177e4SLinus Torvalds  	while(mtd->size & (mtd->erasesize - 1))
811da177e4SLinus Torvalds 		mtd->erasesize >>= 1;
821da177e4SLinus Torvalds 
831da177e4SLinus Torvalds 	__module_get(THIS_MODULE);
841da177e4SLinus Torvalds 	return mtd;
851da177e4SLinus Torvalds }
861da177e4SLinus Torvalds 
mapram_point(struct mtd_info * mtd,loff_t from,size_t len,size_t * retlen,void ** virt,resource_size_t * phys)872caaf2d8SNicolas Pitre static int mapram_point(struct mtd_info *mtd, loff_t from, size_t len,
882caaf2d8SNicolas Pitre 			size_t *retlen, void **virt, resource_size_t *phys)
892caaf2d8SNicolas Pitre {
902caaf2d8SNicolas Pitre 	struct map_info *map = mtd->priv;
912caaf2d8SNicolas Pitre 
922caaf2d8SNicolas Pitre 	if (!map->virt)
932caaf2d8SNicolas Pitre 		return -EINVAL;
942caaf2d8SNicolas Pitre 	*virt = map->virt + from;
952caaf2d8SNicolas Pitre 	if (phys)
962caaf2d8SNicolas Pitre 		*phys = map->phys + from;
972caaf2d8SNicolas Pitre 	*retlen = len;
982caaf2d8SNicolas Pitre 	return 0;
992caaf2d8SNicolas Pitre }
1002caaf2d8SNicolas Pitre 
mapram_unpoint(struct mtd_info * mtd,loff_t from,size_t len)1012caaf2d8SNicolas Pitre static int mapram_unpoint(struct mtd_info *mtd, loff_t from, size_t len)
1022caaf2d8SNicolas Pitre {
1032caaf2d8SNicolas Pitre 	return 0;
1042caaf2d8SNicolas Pitre }
1052caaf2d8SNicolas Pitre 
mapram_read(struct mtd_info * mtd,loff_t from,size_t len,size_t * retlen,u_char * buf)1061da177e4SLinus Torvalds static int mapram_read (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf)
1071da177e4SLinus Torvalds {
1081da177e4SLinus Torvalds 	struct map_info *map = mtd->priv;
1091da177e4SLinus Torvalds 
1101da177e4SLinus Torvalds 	map_copy_from(map, buf, from, len);
1111da177e4SLinus Torvalds 	*retlen = len;
1121da177e4SLinus Torvalds 	return 0;
1131da177e4SLinus Torvalds }
1141da177e4SLinus Torvalds 
mapram_write(struct mtd_info * mtd,loff_t to,size_t len,size_t * retlen,const u_char * buf)1151da177e4SLinus Torvalds static int mapram_write (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf)
1161da177e4SLinus Torvalds {
1171da177e4SLinus Torvalds 	struct map_info *map = mtd->priv;
1181da177e4SLinus Torvalds 
1191da177e4SLinus Torvalds 	map_copy_to(map, to, buf, len);
1201da177e4SLinus Torvalds 	*retlen = len;
1211da177e4SLinus Torvalds 	return 0;
1221da177e4SLinus Torvalds }
1231da177e4SLinus Torvalds 
mapram_erase(struct mtd_info * mtd,struct erase_info * instr)1241da177e4SLinus Torvalds static int mapram_erase (struct mtd_info *mtd, struct erase_info *instr)
1251da177e4SLinus Torvalds {
1261da177e4SLinus Torvalds 	/* Yeah, it's inefficient. Who cares? It's faster than a _real_
1271da177e4SLinus Torvalds 	   flash erase. */
1281da177e4SLinus Torvalds 	struct map_info *map = mtd->priv;
1291da177e4SLinus Torvalds 	map_word allff;
1301da177e4SLinus Torvalds 	unsigned long i;
1311da177e4SLinus Torvalds 
1321da177e4SLinus Torvalds 	allff = map_word_ff(map);
1331da177e4SLinus Torvalds 	for (i=0; i<instr->len; i += map_bankwidth(map))
1341da177e4SLinus Torvalds 		map_write(map, allff, instr->addr + i);
1351da177e4SLinus Torvalds 	return 0;
1361da177e4SLinus Torvalds }
1371da177e4SLinus Torvalds 
mapram_nop(struct mtd_info * mtd)1381da177e4SLinus Torvalds static void mapram_nop(struct mtd_info *mtd)
1391da177e4SLinus Torvalds {
1401da177e4SLinus Torvalds 	/* Nothing to see here */
1411da177e4SLinus Torvalds }
1421da177e4SLinus Torvalds 
map_ram_init(void)1431da177e4SLinus Torvalds static int __init map_ram_init(void)
1441da177e4SLinus Torvalds {
1451da177e4SLinus Torvalds 	register_mtd_chip_driver(&mapram_chipdrv);
1461da177e4SLinus Torvalds 	return 0;
1471da177e4SLinus Torvalds }
1481da177e4SLinus Torvalds 
map_ram_exit(void)1491da177e4SLinus Torvalds static void __exit map_ram_exit(void)
1501da177e4SLinus Torvalds {
1511da177e4SLinus Torvalds 	unregister_mtd_chip_driver(&mapram_chipdrv);
1521da177e4SLinus Torvalds }
1531da177e4SLinus Torvalds 
1541da177e4SLinus Torvalds module_init(map_ram_init);
1551da177e4SLinus Torvalds module_exit(map_ram_exit);
1561da177e4SLinus Torvalds 
1571da177e4SLinus Torvalds MODULE_LICENSE("GPL");
1581da177e4SLinus Torvalds MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1591da177e4SLinus Torvalds MODULE_DESCRIPTION("MTD chip driver for RAM chips");
160