11a59d1b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later 299f2a8aeSBen Dooks /* drivers/mtd/maps/plat-ram.c 399f2a8aeSBen Dooks * 499f2a8aeSBen Dooks * (c) 2004-2005 Simtec Electronics 599f2a8aeSBen Dooks * http://www.simtec.co.uk/products/SWLINUX/ 699f2a8aeSBen Dooks * Ben Dooks <ben@simtec.co.uk> 799f2a8aeSBen Dooks * 8947af294SStefan Weil * Generic platform device based RAM map 999f2a8aeSBen Dooks */ 1099f2a8aeSBen Dooks 1199f2a8aeSBen Dooks #include <linux/module.h> 1299f2a8aeSBen Dooks #include <linux/types.h> 1399f2a8aeSBen Dooks #include <linux/kernel.h> 1499f2a8aeSBen Dooks #include <linux/string.h> 1599f2a8aeSBen Dooks #include <linux/ioport.h> 1699f2a8aeSBen Dooks #include <linux/device.h> 174e57b681STim Schmielau #include <linux/slab.h> 18d052d1beSRussell King #include <linux/platform_device.h> 1999f2a8aeSBen Dooks 2099f2a8aeSBen Dooks #include <linux/mtd/mtd.h> 2199f2a8aeSBen Dooks #include <linux/mtd/map.h> 2299f2a8aeSBen Dooks #include <linux/mtd/partitions.h> 2399f2a8aeSBen Dooks #include <linux/mtd/plat-ram.h> 2499f2a8aeSBen Dooks 2599f2a8aeSBen Dooks #include <asm/io.h> 2699f2a8aeSBen Dooks 2799f2a8aeSBen Dooks /* private structure for each mtd platform ram device created */ 2899f2a8aeSBen Dooks 2999f2a8aeSBen Dooks struct platram_info { 3099f2a8aeSBen Dooks struct device *dev; 3199f2a8aeSBen Dooks struct mtd_info *mtd; 3299f2a8aeSBen Dooks struct map_info map; 3399f2a8aeSBen Dooks struct platdata_mtd_ram *pdata; 3499f2a8aeSBen Dooks }; 3599f2a8aeSBen Dooks 3699f2a8aeSBen Dooks /* to_platram_info() 3799f2a8aeSBen Dooks * 3899f2a8aeSBen Dooks * device private data to struct platram_info conversion 3999f2a8aeSBen Dooks */ 4099f2a8aeSBen Dooks 413ae5eaecSRussell King static inline struct platram_info *to_platram_info(struct platform_device *dev) 4299f2a8aeSBen Dooks { 4314ac0785SJingoo Han return platform_get_drvdata(dev); 4499f2a8aeSBen Dooks } 4599f2a8aeSBen Dooks 4699f2a8aeSBen Dooks /* platram_setrw 4799f2a8aeSBen Dooks * 4899f2a8aeSBen Dooks * call the platform device's set rw/ro control 4999f2a8aeSBen Dooks * 5099f2a8aeSBen Dooks * to = 0 => read-only 5199f2a8aeSBen Dooks * = 1 => read-write 5299f2a8aeSBen Dooks */ 5399f2a8aeSBen Dooks 5499f2a8aeSBen Dooks static inline void platram_setrw(struct platram_info *info, int to) 5599f2a8aeSBen Dooks { 5699f2a8aeSBen Dooks if (info->pdata == NULL) 5799f2a8aeSBen Dooks return; 5899f2a8aeSBen Dooks 5999f2a8aeSBen Dooks if (info->pdata->set_rw != NULL) 6099f2a8aeSBen Dooks (info->pdata->set_rw)(info->dev, to); 6199f2a8aeSBen Dooks } 6299f2a8aeSBen Dooks 6399f2a8aeSBen Dooks /* platram_remove 6499f2a8aeSBen Dooks * 6599f2a8aeSBen Dooks * called to remove the device from the driver's control 6699f2a8aeSBen Dooks */ 6799f2a8aeSBen Dooks 683ae5eaecSRussell King static int platram_remove(struct platform_device *pdev) 6999f2a8aeSBen Dooks { 703ae5eaecSRussell King struct platram_info *info = to_platram_info(pdev); 7199f2a8aeSBen Dooks 723ae5eaecSRussell King dev_dbg(&pdev->dev, "removing device\n"); 7399f2a8aeSBen Dooks 7499f2a8aeSBen Dooks if (info == NULL) 7599f2a8aeSBen Dooks return 0; 7699f2a8aeSBen Dooks 7799f2a8aeSBen Dooks if (info->mtd) { 78095dd500SJamie Iles mtd_device_unregister(info->mtd); 7999f2a8aeSBen Dooks map_destroy(info->mtd); 8099f2a8aeSBen Dooks } 8199f2a8aeSBen Dooks 8299f2a8aeSBen Dooks /* ensure ram is left read-only */ 8399f2a8aeSBen Dooks 8499f2a8aeSBen Dooks platram_setrw(info, PLATRAM_RO); 8599f2a8aeSBen Dooks 8699f2a8aeSBen Dooks kfree(info); 8799f2a8aeSBen Dooks 8899f2a8aeSBen Dooks return 0; 8999f2a8aeSBen Dooks } 9099f2a8aeSBen Dooks 9199f2a8aeSBen Dooks /* platram_probe 9299f2a8aeSBen Dooks * 9399f2a8aeSBen Dooks * called from device drive system when a device matching our 9499f2a8aeSBen Dooks * driver is found. 9599f2a8aeSBen Dooks */ 9699f2a8aeSBen Dooks 973ae5eaecSRussell King static int platram_probe(struct platform_device *pdev) 9899f2a8aeSBen Dooks { 9999f2a8aeSBen Dooks struct platdata_mtd_ram *pdata; 10099f2a8aeSBen Dooks struct platram_info *info; 10199f2a8aeSBen Dooks struct resource *res; 10299f2a8aeSBen Dooks int err = 0; 10399f2a8aeSBen Dooks 1043ae5eaecSRussell King dev_dbg(&pdev->dev, "probe entered\n"); 10599f2a8aeSBen Dooks 106d20d5a57SJingoo Han if (dev_get_platdata(&pdev->dev) == NULL) { 1073ae5eaecSRussell King dev_err(&pdev->dev, "no platform data supplied\n"); 10899f2a8aeSBen Dooks err = -ENOENT; 10999f2a8aeSBen Dooks goto exit_error; 11099f2a8aeSBen Dooks } 11199f2a8aeSBen Dooks 112d20d5a57SJingoo Han pdata = dev_get_platdata(&pdev->dev); 11399f2a8aeSBen Dooks 11495b93a0cSBurman Yan info = kzalloc(sizeof(*info), GFP_KERNEL); 11599f2a8aeSBen Dooks if (info == NULL) { 11699f2a8aeSBen Dooks err = -ENOMEM; 11799f2a8aeSBen Dooks goto exit_error; 11899f2a8aeSBen Dooks } 11999f2a8aeSBen Dooks 1203ae5eaecSRussell King platform_set_drvdata(pdev, info); 12199f2a8aeSBen Dooks 1223ae5eaecSRussell King info->dev = &pdev->dev; 12399f2a8aeSBen Dooks info->pdata = pdata; 12499f2a8aeSBen Dooks 12599f2a8aeSBen Dooks /* get the resource for the memory mapping */ 1263ae5eaecSRussell King res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 1272e442aebSAnton Vasilyev info->map.virt = devm_ioremap_resource(&pdev->dev, res); 1282e442aebSAnton Vasilyev if (IS_ERR(info->map.virt)) { 1292e442aebSAnton Vasilyev err = PTR_ERR(info->map.virt); 1302e442aebSAnton Vasilyev dev_err(&pdev->dev, "failed to ioremap() region\n"); 13199f2a8aeSBen Dooks goto exit_free; 13299f2a8aeSBen Dooks } 13399f2a8aeSBen Dooks 13406d63cc5SRandy Dunlap dev_dbg(&pdev->dev, "got platform resource %p (0x%llx)\n", res, 13506d63cc5SRandy Dunlap (unsigned long long)res->start); 13699f2a8aeSBen Dooks 13799f2a8aeSBen Dooks /* setup map parameters */ 13899f2a8aeSBen Dooks 13999f2a8aeSBen Dooks info->map.phys = res->start; 14076d6a479SWolfram Sang info->map.size = resource_size(res); 14175757006SFlorian Fainelli info->map.name = pdata->mapname != NULL ? 14275757006SFlorian Fainelli (char *)pdata->mapname : (char *)pdev->name; 14399f2a8aeSBen Dooks info->map.bankwidth = pdata->bankwidth; 14499f2a8aeSBen Dooks 1453ae5eaecSRussell King dev_dbg(&pdev->dev, "virt %p, %lu bytes\n", info->map.virt, info->map.size); 14699f2a8aeSBen Dooks 14799f2a8aeSBen Dooks simple_map_init(&info->map); 14899f2a8aeSBen Dooks 1493ae5eaecSRussell King dev_dbg(&pdev->dev, "initialised map, probing for mtd\n"); 15099f2a8aeSBen Dooks 15175757006SFlorian Fainelli /* probe for the right mtd map driver 15275757006SFlorian Fainelli * supplied by the platform_data struct */ 15399f2a8aeSBen Dooks 154a01e035eSHarvey Harrison if (pdata->map_probes) { 155d50dcb1dSArtem Bityutskiy const char * const *map_probes = pdata->map_probes; 15675757006SFlorian Fainelli 15775757006SFlorian Fainelli for ( ; !info->mtd && *map_probes; map_probes++) 15875757006SFlorian Fainelli info->mtd = do_map_probe(*map_probes , &info->map); 15975757006SFlorian Fainelli } 16075757006SFlorian Fainelli /* fallback to map_ram */ 16175757006SFlorian Fainelli else 16299f2a8aeSBen Dooks info->mtd = do_map_probe("map_ram", &info->map); 16375757006SFlorian Fainelli 16499f2a8aeSBen Dooks if (info->mtd == NULL) { 1653ae5eaecSRussell King dev_err(&pdev->dev, "failed to probe for map_ram\n"); 16699f2a8aeSBen Dooks err = -ENOMEM; 16799f2a8aeSBen Dooks goto exit_free; 16899f2a8aeSBen Dooks } 16999f2a8aeSBen Dooks 17087f39f04SDavid Brownell info->mtd->dev.parent = &pdev->dev; 17199f2a8aeSBen Dooks 17299f2a8aeSBen Dooks platram_setrw(info, PLATRAM_RW); 17399f2a8aeSBen Dooks 17448fc7f7eSAdam Buchbinder /* check to see if there are any available partitions, or whether 17599f2a8aeSBen Dooks * to add this device whole */ 17699f2a8aeSBen Dooks 17742d7fbe2SArtem Bityutskiy err = mtd_device_parse_register(info->mtd, pdata->probes, NULL, 17842d7fbe2SArtem Bityutskiy pdata->partitions, 17942d7fbe2SArtem Bityutskiy pdata->nr_partitions); 18075757006SFlorian Fainelli if (!err) 1813ae5eaecSRussell King dev_info(&pdev->dev, "registered mtd device\n"); 18275757006SFlorian Fainelli 183c3298791SIlya Yanok if (pdata->nr_partitions) { 184095dd500SJamie Iles /* add the whole device. */ 185095dd500SJamie Iles err = mtd_device_register(info->mtd, NULL, 0); 186c3298791SIlya Yanok if (err) { 187c3298791SIlya Yanok dev_err(&pdev->dev, 188c3298791SIlya Yanok "failed to register the entire device\n"); 189c3298791SIlya Yanok } 190c3298791SIlya Yanok } 191095dd500SJamie Iles 19299f2a8aeSBen Dooks return err; 19399f2a8aeSBen Dooks 19499f2a8aeSBen Dooks exit_free: 1953ae5eaecSRussell King platram_remove(pdev); 19699f2a8aeSBen Dooks exit_error: 19799f2a8aeSBen Dooks return err; 19899f2a8aeSBen Dooks } 19999f2a8aeSBen Dooks 20099f2a8aeSBen Dooks /* device driver info */ 20199f2a8aeSBen Dooks 20241d867c9SKay Sievers /* work with hotplug and coldplug */ 20341d867c9SKay Sievers MODULE_ALIAS("platform:mtd-ram"); 20441d867c9SKay Sievers 2053ae5eaecSRussell King static struct platform_driver platram_driver = { 20699f2a8aeSBen Dooks .probe = platram_probe, 20799f2a8aeSBen Dooks .remove = platram_remove, 2083ae5eaecSRussell King .driver = { 2093ae5eaecSRussell King .name = "mtd-ram", 2103ae5eaecSRussell King }, 21199f2a8aeSBen Dooks }; 21299f2a8aeSBen Dooks 21398a7c747SSachin Kamat module_platform_driver(platram_driver); 21499f2a8aeSBen Dooks 21599f2a8aeSBen Dooks MODULE_LICENSE("GPL"); 21699f2a8aeSBen Dooks MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>"); 21799f2a8aeSBen Dooks MODULE_DESCRIPTION("MTD platform RAM map driver"); 218