[MTD] phram: Allow short reads.
[linux-2.6.git] / drivers / mtd / devices / phram.c
1 /**
2  * $Id: phram.c,v 1.14 2005/03/07 21:43:38 joern Exp $
3  *
4  * Copyright (c) ????           Jochen Schäuble <psionic@psionic.de>
5  * Copyright (c) 2003-2004      Jörn Engel <joern@wh.fh-wedel.de>
6  *
7  * Usage:
8  *
9  * one commend line parameter per device, each in the form:
10  *   phram=<name>,<start>,<len>
11  * <name> may be up to 63 characters.
12  * <start> and <len> can be octal, decimal or hexadecimal.  If followed
13  * by "ki", "Mi" or "Gi", the numbers will be interpreted as kilo, mega or
14  * gigabytes.
15  *
16  * Example:
17  *      phram=swap,64Mi,128Mi phram=test,900Mi,1Mi
18  */
19 #include <asm/io.h>
20 #include <linux/init.h>
21 #include <linux/kernel.h>
22 #include <linux/list.h>
23 #include <linux/module.h>
24 #include <linux/moduleparam.h>
25 #include <linux/mtd/mtd.h>
26
27 #define ERROR(fmt, args...) printk(KERN_ERR "phram: " fmt , ## args)
28
29 struct phram_mtd_list {
30         struct mtd_info mtd;
31         struct list_head list;
32 };
33
34 static LIST_HEAD(phram_list);
35
36
37 static int phram_erase(struct mtd_info *mtd, struct erase_info *instr)
38 {
39         u_char *start = mtd->priv;
40
41         if (instr->addr + instr->len > mtd->size)
42                 return -EINVAL;
43         
44         memset(start + instr->addr, 0xff, instr->len);
45
46         /* This'll catch a few races. Free the thing before returning :) 
47          * I don't feel at all ashamed. This kind of thing is possible anyway
48          * with flash, but unlikely.
49          */
50
51         instr->state = MTD_ERASE_DONE;
52
53         mtd_erase_callback(instr);
54
55         return 0;
56 }
57
58 static int phram_point(struct mtd_info *mtd, loff_t from, size_t len,
59                 size_t *retlen, u_char **mtdbuf)
60 {
61         u_char *start = mtd->priv;
62
63         if (from + len > mtd->size)
64                 return -EINVAL;
65         
66         *mtdbuf = start + from;
67         *retlen = len;
68         return 0;
69 }
70
71 static void phram_unpoint(struct mtd_info *mtd, u_char *addr, loff_t from,
72                 size_t len)
73 {
74 }
75
76 static int phram_read(struct mtd_info *mtd, loff_t from, size_t len,
77                 size_t *retlen, u_char *buf)
78 {
79         u_char *start = mtd->priv;
80
81         if (from >= mtd->size)
82                 return -EINVAL;
83
84         if (len > mtd->size - from)
85                 len = mtd->size - from;
86         
87         memcpy(buf, start + from, len);
88
89         *retlen = len;
90         return 0;
91 }
92
93 static int phram_write(struct mtd_info *mtd, loff_t to, size_t len,
94                 size_t *retlen, const u_char *buf)
95 {
96         u_char *start = mtd->priv;
97
98         if (to >= mtd->size)
99                 return -EINVAL;
100
101         if (len > mtd->size - to)
102                 len = mtd->size - to;
103         
104         memcpy(start + to, buf, len);
105
106         *retlen = len;
107         return 0;
108 }
109
110
111
112 static void unregister_devices(void)
113 {
114         struct phram_mtd_list *this, *safe;
115
116         list_for_each_entry_safe(this, safe, &phram_list, list) {
117                 del_mtd_device(&this->mtd);
118                 iounmap(this->mtd.priv);
119                 kfree(this);
120         }
121 }
122
123 static int register_device(char *name, unsigned long start, unsigned long len)
124 {
125         struct phram_mtd_list *new;
126         int ret = -ENOMEM;
127
128         new = kmalloc(sizeof(*new), GFP_KERNEL);
129         if (!new)
130                 goto out0;
131
132         memset(new, 0, sizeof(*new));
133
134         ret = -EIO;
135         new->mtd.priv = ioremap(start, len);
136         if (!new->mtd.priv) {
137                 ERROR("ioremap failed\n");
138                 goto out1;
139         }
140
141
142         new->mtd.name = name;
143         new->mtd.size = len;
144         new->mtd.flags = MTD_CAP_RAM | MTD_ERASEABLE | MTD_VOLATILE;
145         new->mtd.erase = phram_erase;
146         new->mtd.point = phram_point;
147         new->mtd.unpoint = phram_unpoint;
148         new->mtd.read = phram_read;
149         new->mtd.write = phram_write;
150         new->mtd.owner = THIS_MODULE;
151         new->mtd.type = MTD_RAM;
152         new->mtd.erasesize = PAGE_SIZE;
153
154         ret = -EAGAIN;
155         if (add_mtd_device(&new->mtd)) {
156                 ERROR("Failed to register new device\n");
157                 goto out2;
158         }
159
160         list_add_tail(&new->list, &phram_list);
161         return 0;       
162
163 out2:
164         iounmap(new->mtd.priv);
165 out1:
166         kfree(new);
167 out0:
168         return ret;
169 }
170
171 static int ustrtoul(const char *cp, char **endp, unsigned int base)
172 {
173         unsigned long result = simple_strtoul(cp, endp, base);
174
175         switch (**endp) {
176         case 'G':
177                 result *= 1024;
178         case 'M':
179                 result *= 1024;
180         case 'k':
181                 result *= 1024;
182         /* By dwmw2 editorial decree, "ki", "Mi" or "Gi" are to be used. */
183                 if ((*endp)[1] == 'i')
184                         (*endp) += 2;
185         }
186         return result;
187 }
188
189 static int parse_num32(uint32_t *num32, const char *token)
190 {
191         char *endp;
192         unsigned long n;
193
194         n = ustrtoul(token, &endp, 0);
195         if (*endp)
196                 return -EINVAL;
197
198         *num32 = n;
199         return 0;
200 }
201
202 static int parse_name(char **pname, const char *token)
203 {
204         size_t len;
205         char *name;
206
207         len = strlen(token) + 1;
208         if (len > 64)
209                 return -ENOSPC;
210
211         name = kmalloc(len, GFP_KERNEL);
212         if (!name)
213                 return -ENOMEM;
214
215         strcpy(name, token);
216
217         *pname = name;
218         return 0;
219 }
220
221
222 static inline void kill_final_newline(char *str)
223 {
224         char *newline = strrchr(str, '\n');
225         if (newline && !newline[1])
226                 *newline = 0;
227 }
228
229
230 #define parse_err(fmt, args...) do {    \
231         ERROR(fmt , ## args);   \
232         return 0;               \
233 } while (0)
234
235 static int phram_setup(const char *val, struct kernel_param *kp)
236 {
237         char buf[64+12+12], *str = buf;
238         char *token[3];
239         char *name;
240         uint32_t start;
241         uint32_t len;
242         int i, ret;
243
244         if (strnlen(val, sizeof(buf)) >= sizeof(buf))
245                 parse_err("parameter too long\n");
246
247         strcpy(str, val);
248         kill_final_newline(str);
249
250         for (i=0; i<3; i++)
251                 token[i] = strsep(&str, ",");
252
253         if (str)
254                 parse_err("too many arguments\n");
255
256         if (!token[2])
257                 parse_err("not enough arguments\n");
258
259         ret = parse_name(&name, token[0]);
260         if (ret == -ENOMEM)
261                 parse_err("out of memory\n");
262         if (ret == -ENOSPC)
263                 parse_err("name too long\n");
264         if (ret)
265                 return 0;
266
267         ret = parse_num32(&start, token[1]);
268         if (ret)
269                 parse_err("illegal start address\n");
270
271         ret = parse_num32(&len, token[2]);
272         if (ret)
273                 parse_err("illegal device length\n");
274
275         register_device(name, start, len);
276
277         return 0;
278 }
279
280 module_param_call(phram, phram_setup, NULL, NULL, 000);
281 MODULE_PARM_DESC(phram,"Memory region to map. \"map=<name>,<start>,<length>\"");
282
283
284 static int __init init_phram(void)
285 {
286         return 0;
287 }
288
289 static void __exit cleanup_phram(void)
290 {
291         unregister_devices();
292 }
293
294 module_init(init_phram);
295 module_exit(cleanup_phram);
296
297 MODULE_LICENSE("GPL");
298 MODULE_AUTHOR("Jörn Engel <joern@wh.fh-wedel.de>");
299 MODULE_DESCRIPTION("MTD driver for physical RAM");