blob: e2f878216048eed8ac69e973d5da7e9f4e668147 [file] [log] [blame]
John Crispin3c544732011-04-12 18:10:01 +02001/*
2 * This program is free software; you can redistribute it and/or modify it
3 * under the terms of the GNU General Public License version 2 as published
4 * by the Free Software Foundation.
5 *
6 * Copyright (C) 2004 Liu Peng Infineon IFAP DC COM CPE
7 * Copyright (C) 2010 John Crispin <blogic@openwrt.org>
8 */
9
Thierry Redingb0de7742013-01-21 11:09:12 +010010#include <linux/err.h>
John Crispin3c544732011-04-12 18:10:01 +020011#include <linux/module.h>
12#include <linux/types.h>
13#include <linux/kernel.h>
14#include <linux/io.h>
15#include <linux/slab.h>
John Crispin3c544732011-04-12 18:10:01 +020016#include <linux/mtd/mtd.h>
17#include <linux/mtd/map.h>
18#include <linux/mtd/partitions.h>
19#include <linux/mtd/cfi.h>
20#include <linux/platform_device.h>
21#include <linux/mtd/physmap.h>
John Crispinfa09ede2012-05-05 15:41:42 +020022#include <linux/of.h>
John Crispin3c544732011-04-12 18:10:01 +020023
24#include <lantiq_soc.h>
John Crispin3c544732011-04-12 18:10:01 +020025
26/*
27 * The NOR flash is connected to the same external bus unit (EBU) as PCI.
28 * To make PCI work we need to enable the endianness swapping for the address
29 * written to the EBU. This endianness swapping works for PCI correctly but
30 * fails for attached NOR devices. To workaround this we need to use a complex
31 * map. The workaround involves swapping all addresses whilst probing the chip.
32 * Once probing is complete we stop swapping the addresses but swizzle the
33 * unlock addresses to ensure that access to the NOR device works correctly.
34 */
35
36enum {
37 LTQ_NOR_PROBING,
38 LTQ_NOR_NORMAL
39};
40
41struct ltq_mtd {
42 struct resource *res;
43 struct mtd_info *mtd;
44 struct map_info *map;
45};
46
John Crispin02fa9612012-04-13 09:36:46 +020047static const char ltq_map_name[] = "ltq_nor";
John Crispin3c544732011-04-12 18:10:01 +020048
49static map_word
50ltq_read16(struct map_info *map, unsigned long adr)
51{
52 unsigned long flags;
53 map_word temp;
54
55 if (map->map_priv_1 == LTQ_NOR_PROBING)
56 adr ^= 2;
57 spin_lock_irqsave(&ebu_lock, flags);
58 temp.x[0] = *(u16 *)(map->virt + adr);
59 spin_unlock_irqrestore(&ebu_lock, flags);
60 return temp;
61}
62
63static void
64ltq_write16(struct map_info *map, map_word d, unsigned long adr)
65{
66 unsigned long flags;
67
68 if (map->map_priv_1 == LTQ_NOR_PROBING)
69 adr ^= 2;
70 spin_lock_irqsave(&ebu_lock, flags);
71 *(u16 *)(map->virt + adr) = d.x[0];
72 spin_unlock_irqrestore(&ebu_lock, flags);
73}
74
75/*
76 * The following 2 functions copy data between iomem and a cached memory
77 * section. As memcpy() makes use of pre-fetching we cannot use it here.
78 * The normal alternative of using memcpy_{to,from}io also makes use of
79 * memcpy() on MIPS so it is not applicable either. We are therefore stuck
80 * with having to use our own loop.
81 */
82static void
83ltq_copy_from(struct map_info *map, void *to,
84 unsigned long from, ssize_t len)
85{
86 unsigned char *f = (unsigned char *)map->virt + from;
87 unsigned char *t = (unsigned char *)to;
88 unsigned long flags;
89
90 spin_lock_irqsave(&ebu_lock, flags);
91 while (len--)
92 *t++ = *f++;
93 spin_unlock_irqrestore(&ebu_lock, flags);
94}
95
96static void
97ltq_copy_to(struct map_info *map, unsigned long to,
98 const void *from, ssize_t len)
99{
100 unsigned char *f = (unsigned char *)from;
101 unsigned char *t = (unsigned char *)map->virt + to;
102 unsigned long flags;
103
104 spin_lock_irqsave(&ebu_lock, flags);
105 while (len--)
106 *t++ = *f++;
107 spin_unlock_irqrestore(&ebu_lock, flags);
108}
109
Bill Pemberton06f25512012-11-19 13:23:07 -0500110static int
John Crispin3c544732011-04-12 18:10:01 +0200111ltq_mtd_probe(struct platform_device *pdev)
112{
John Crispin02fa9612012-04-13 09:36:46 +0200113 struct mtd_part_parser_data ppdata;
John Crispin3c544732011-04-12 18:10:01 +0200114 struct ltq_mtd *ltq_mtd;
John Crispin3c544732011-04-12 18:10:01 +0200115 struct cfi_private *cfi;
116 int err;
117
John Crispinfa09ede2012-05-05 15:41:42 +0200118 if (of_machine_is_compatible("lantiq,falcon") &&
119 (ltq_boot_select() != BS_FLASH)) {
120 dev_err(&pdev->dev, "invalid bootstrap options\n");
121 return -ENODEV;
122 }
123
Jingoo Han436bf632013-12-26 10:42:34 +0900124 ltq_mtd = devm_kzalloc(&pdev->dev, sizeof(struct ltq_mtd), GFP_KERNEL);
125 if (!ltq_mtd)
126 return -ENOMEM;
127
John Crispin3c544732011-04-12 18:10:01 +0200128 platform_set_drvdata(pdev, ltq_mtd);
129
130 ltq_mtd->res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
131 if (!ltq_mtd->res) {
John Crispin02fa9612012-04-13 09:36:46 +0200132 dev_err(&pdev->dev, "failed to get memory resource\n");
Jingoo Han436bf632013-12-26 10:42:34 +0900133 return -ENOENT;
John Crispin3c544732011-04-12 18:10:01 +0200134 }
135
Jingoo Han436bf632013-12-26 10:42:34 +0900136 ltq_mtd->map = devm_kzalloc(&pdev->dev, sizeof(struct map_info),
137 GFP_KERNEL);
138 if (!ltq_mtd->map)
139 return -ENOMEM;
140
John Crispin02fa9612012-04-13 09:36:46 +0200141 ltq_mtd->map->phys = ltq_mtd->res->start;
142 ltq_mtd->map->size = resource_size(ltq_mtd->res);
Thierry Redingb0de7742013-01-21 11:09:12 +0100143 ltq_mtd->map->virt = devm_ioremap_resource(&pdev->dev, ltq_mtd->res);
Jingoo Han436bf632013-12-26 10:42:34 +0900144 if (IS_ERR(ltq_mtd->map->virt))
145 return PTR_ERR(ltq_mtd->map->virt);
John Crispin3c544732011-04-12 18:10:01 +0200146
John Crispin3c544732011-04-12 18:10:01 +0200147 ltq_mtd->map->name = ltq_map_name;
148 ltq_mtd->map->bankwidth = 2;
149 ltq_mtd->map->read = ltq_read16;
150 ltq_mtd->map->write = ltq_write16;
151 ltq_mtd->map->copy_from = ltq_copy_from;
152 ltq_mtd->map->copy_to = ltq_copy_to;
153
154 ltq_mtd->map->map_priv_1 = LTQ_NOR_PROBING;
155 ltq_mtd->mtd = do_map_probe("cfi_probe", ltq_mtd->map);
156 ltq_mtd->map->map_priv_1 = LTQ_NOR_NORMAL;
157
158 if (!ltq_mtd->mtd) {
159 dev_err(&pdev->dev, "probing failed\n");
Jingoo Han436bf632013-12-26 10:42:34 +0900160 return -ENXIO;
John Crispin3c544732011-04-12 18:10:01 +0200161 }
162
163 ltq_mtd->mtd->owner = THIS_MODULE;
164
165 cfi = ltq_mtd->map->fldrv_priv;
166 cfi->addr_unlock1 ^= 1;
167 cfi->addr_unlock2 ^= 1;
168
John Crispin02fa9612012-04-13 09:36:46 +0200169 ppdata.of_node = pdev->dev.of_node;
Brian Norrisc3c263a2015-05-18 16:17:11 -0700170 err = mtd_device_parse_register(ltq_mtd->mtd, NULL, &ppdata, NULL, 0);
John Crispin3c544732011-04-12 18:10:01 +0200171 if (err) {
172 dev_err(&pdev->dev, "failed to add partitions\n");
173 goto err_destroy;
174 }
175
176 return 0;
177
178err_destroy:
179 map_destroy(ltq_mtd->mtd);
John Crispin3c544732011-04-12 18:10:01 +0200180 return err;
181}
182
Bill Pemberton810b7e02012-11-19 13:26:04 -0500183static int
John Crispin3c544732011-04-12 18:10:01 +0200184ltq_mtd_remove(struct platform_device *pdev)
185{
186 struct ltq_mtd *ltq_mtd = platform_get_drvdata(pdev);
187
Jingoo Han436bf632013-12-26 10:42:34 +0900188 if (ltq_mtd && ltq_mtd->mtd) {
189 mtd_device_unregister(ltq_mtd->mtd);
190 map_destroy(ltq_mtd->mtd);
John Crispin3c544732011-04-12 18:10:01 +0200191 }
192 return 0;
193}
194
John Crispin02fa9612012-04-13 09:36:46 +0200195static const struct of_device_id ltq_mtd_match[] = {
196 { .compatible = "lantiq,nor" },
197 {},
198};
199MODULE_DEVICE_TABLE(of, ltq_mtd_match);
200
John Crispin3c544732011-04-12 18:10:01 +0200201static struct platform_driver ltq_mtd_driver = {
John Crispin02fa9612012-04-13 09:36:46 +0200202 .probe = ltq_mtd_probe,
Bill Pemberton5153b882012-11-19 13:21:24 -0500203 .remove = ltq_mtd_remove,
John Crispin3c544732011-04-12 18:10:01 +0200204 .driver = {
John Crispin02fa9612012-04-13 09:36:46 +0200205 .name = "ltq-nor",
John Crispin02fa9612012-04-13 09:36:46 +0200206 .of_match_table = ltq_mtd_match,
John Crispin3c544732011-04-12 18:10:01 +0200207 },
208};
209
John Crispin02fa9612012-04-13 09:36:46 +0200210module_platform_driver(ltq_mtd_driver);
John Crispin3c544732011-04-12 18:10:01 +0200211
212MODULE_LICENSE("GPL");
213MODULE_AUTHOR("John Crispin <blogic@openwrt.org>");
214MODULE_DESCRIPTION("Lantiq SoC NOR");