1/*
  2 * Mapping of a custom board with both AMD CFI and JEDEC flash in partitions.
  3 * Config with both CFI and JEDEC device support.
  4 *
  5 * Basically physmap.c with the addition of partitions and
  6 * an array of mapping info to accommodate more than one flash type per board.
  7 *
  8 * Copyright 2005-2007 PMC-Sierra, Inc.
  9 *
 10 *  This program is free software; you can redistribute  it and/or modify it
 11 *  under  the terms of  the GNU General  Public License as published by the
 12 *  Free Software Foundation;  either version 2 of the  License, or (at your
 13 *  option) any later version.
 14 *
 15 *  THIS  SOFTWARE  IS PROVIDED   ``AS  IS'' AND   ANY  EXPRESS OR IMPLIED
 16 *  WARRANTIES,   INCLUDING, BUT NOT  LIMITED  TO, THE IMPLIED WARRANTIES OF
 17 *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
 18 *  NO  EVENT  SHALL   THE AUTHOR  BE    LIABLE FOR ANY   DIRECT, INDIRECT,
 19 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 20 *  NOT LIMITED   TO, PROCUREMENT OF  SUBSTITUTE GOODS  OR SERVICES; LOSS OF
 21 *  USE, DATA,  OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 22 *  ANY THEORY OF LIABILITY, WHETHER IN  CONTRACT, STRICT LIABILITY, OR TORT
 23 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 24 *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 25 *
 26 *  You should have received a copy of the  GNU General Public License along
 27 *  with this program; if not, write  to the Free Software Foundation, Inc.,
 28 *  675 Mass Ave, Cambridge, MA 02139, USA.
 29 */
 30
 31#include <linux/slab.h>
 32#include <linux/module.h>
 33#include <linux/types.h>
 34#include <linux/kernel.h>
 35#include <linux/mtd/mtd.h>
 36#include <linux/mtd/map.h>
 37#include <linux/mtd/partitions.h>
 38
 39#include <asm/io.h>
 40
 41#include <msp_prom.h>
 42#include <msp_regs.h>
 43
 44
 45static struct mtd_info **msp_flash;
 46static struct mtd_partition **msp_parts;
 47static struct map_info *msp_maps;
 48static int fcnt;
 49
 50#define DEBUG_MARKER printk(KERN_NOTICE "%s[%d]\n", __func__, __LINE__)
 51
 52static int __init init_msp_flash(void)
 53{
 54	int i, j, ret = -ENOMEM;
 55	int offset, coff;
 56	char *env;
 57	int pcnt;
 58	char flash_name[] = "flash0";
 59	char part_name[] = "flash0_0";
 60	unsigned addr, size;
 61
 62	/* If ELB is disabled by "ful-mux" mode, we can't get at flash */
 63	if ((*DEV_ID_REG & DEV_ID_SINGLE_PC) &&
 64	    (*ELB_1PC_EN_REG & SINGLE_PCCARD)) {
 65		printk(KERN_NOTICE "Single PC Card mode: no flash access\n");
 66		return -ENXIO;
 67	}
 68
 69	/* examine the prom environment for flash devices */
 70	for (fcnt = 0; (env = prom_getenv(flash_name)); fcnt++)
 71		flash_name[5] = '0' + fcnt + 1;
 72
 73	if (fcnt < 1)
 74		return -ENXIO;
 75
 76	printk(KERN_NOTICE "Found %d PMC flash devices\n", fcnt);
 77
 78	msp_flash = kcalloc(fcnt, sizeof(*msp_flash), GFP_KERNEL);
 79	if (!msp_flash)
 80		return -ENOMEM;
 81
 82	msp_parts = kcalloc(fcnt, sizeof(*msp_parts), GFP_KERNEL);
 83	if (!msp_parts)
 84		goto free_msp_flash;
 85
 86	msp_maps = kcalloc(fcnt, sizeof(*msp_maps), GFP_KERNEL);
 87	if (!msp_maps)
 88		goto free_msp_parts;
 89
 90	/* loop over the flash devices, initializing each */
 91	for (i = 0; i < fcnt; i++) {
 92		/* examine the prom environment for flash partititions */
 93		part_name[5] = '0' + i;
 94		part_name[7] = '0';
 95		for (pcnt = 0; (env = prom_getenv(part_name)); pcnt++)
 96			part_name[7] = '0' + pcnt + 1;
 97
 98		if (pcnt == 0) {
 99			printk(KERN_NOTICE "Skipping flash device %d "
100				"(no partitions defined)\n", i);
101			continue;
102		}
103
104		msp_parts[i] = kcalloc(pcnt, sizeof(struct mtd_partition),
105				       GFP_KERNEL);
106		if (!msp_parts[i])
107			goto cleanup_loop;
108
109		/* now initialize the devices proper */
110		flash_name[5] = '0' + i;
111		env = prom_getenv(flash_name);
112
113		if (sscanf(env, "%x:%x", &addr, &size) < 2) {
114			ret = -ENXIO;
115			kfree(msp_parts[i]);
116			goto cleanup_loop;
117		}
118		addr = CPHYSADDR(addr);
119
120		printk(KERN_NOTICE
121			"MSP flash device \"%s\": 0x%08x at 0x%08x\n",
122			flash_name, size, addr);
123		/* This must matchs the actual size of the flash chip */
124		msp_maps[i].size = size;
125		msp_maps[i].phys = addr;
126
127		/*
128		 * Platforms have a specific limit of the size of memory
129		 * which may be mapped for flash:
130		 */
131		if (size > CONFIG_MSP_FLASH_MAP_LIMIT)
132			size = CONFIG_MSP_FLASH_MAP_LIMIT;
133
134		msp_maps[i].virt = ioremap(addr, size);
135		if (msp_maps[i].virt == NULL) {
136			ret = -ENXIO;
137			kfree(msp_parts[i]);
138			goto cleanup_loop;
139		}
140
141		msp_maps[i].bankwidth = 1;
142		msp_maps[i].name = kstrndup(flash_name, 7, GFP_KERNEL);
143		if (!msp_maps[i].name) {
144			iounmap(msp_maps[i].virt);
145			kfree(msp_parts[i]);
146			goto cleanup_loop;
147		}
148
149		for (j = 0; j < pcnt; j++) {
150			part_name[5] = '0' + i;
151			part_name[7] = '0' + j;
152
153			env = prom_getenv(part_name);
154
155			if (sscanf(env, "%x:%x:%n", &offset, &size,
156						&coff) < 2) {
157				ret = -ENXIO;
158				kfree(msp_maps[i].name);
159				iounmap(msp_maps[i].virt);
160				kfree(msp_parts[i]);
161				goto cleanup_loop;
162			}
163
164			msp_parts[i][j].size = size;
165			msp_parts[i][j].offset = offset;
166			msp_parts[i][j].name = env + coff;
167		}
168
169		/* now probe and add the device */
170		simple_map_init(&msp_maps[i]);
171		msp_flash[i] = do_map_probe("cfi_probe", &msp_maps[i]);
172		if (msp_flash[i]) {
173			msp_flash[i]->owner = THIS_MODULE;
174			mtd_device_register(msp_flash[i], msp_parts[i], pcnt);
175		} else {
176			printk(KERN_ERR "map probe failed for flash\n");
177			ret = -ENXIO;
178			kfree(msp_maps[i].name);
179			iounmap(msp_maps[i].virt);
180			kfree(msp_parts[i]);
181			goto cleanup_loop;
182		}
183	}
184
185	return 0;
186
187cleanup_loop:
188	while (i--) {
189		mtd_device_unregister(msp_flash[i]);
190		map_destroy(msp_flash[i]);
191		kfree(msp_maps[i].name);
192		iounmap(msp_maps[i].virt);
193		kfree(msp_parts[i]);
194	}
195	kfree(msp_maps);
196free_msp_parts:
197	kfree(msp_parts);
198free_msp_flash:
199	kfree(msp_flash);
200	return ret;
201}
202
203static void __exit cleanup_msp_flash(void)
204{
205	int i;
206
207	for (i = 0; i < fcnt; i++) {
208		mtd_device_unregister(msp_flash[i]);
209		map_destroy(msp_flash[i]);
210		iounmap((void *)msp_maps[i].virt);
211
212		/* free the memory */
213		kfree(msp_maps[i].name);
214		kfree(msp_parts[i]);
215	}
216
217	kfree(msp_flash);
218	kfree(msp_parts);
219	kfree(msp_maps);
220}
221
222MODULE_AUTHOR("PMC-Sierra, Inc");
223MODULE_DESCRIPTION("MTD map driver for PMC-Sierra MSP boards");
224MODULE_LICENSE("GPL");
225
226module_init(init_msp_flash);
227module_exit(cleanup_msp_flash);