2 * (C) Copyright IBM Deutschland Entwicklung GmbH 2006
4 * Author: Maxim Shchetynin <maxim@de.ibm.com>
6 * Axon DDR2 device driver.
7 * It registers one block device per Axon's DDR2 memory bank found on a system.
8 * Block devices are called axonram?, their major and minor numbers are
9 * available in /proc/devices, /proc/partitions or in /sys/block/axonram?/dev.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2, or (at your option)
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include <linux/bio.h>
27 #include <linux/blkdev.h>
28 #include <linux/buffer_head.h>
29 #include <linux/device.h>
30 #include <linux/errno.h>
32 #include <linux/genhd.h>
33 #include <linux/interrupt.h>
35 #include <linux/ioport.h>
36 #include <linux/irq.h>
37 #include <linux/irqreturn.h>
38 #include <linux/kernel.h>
40 #include <linux/mod_devicetable.h>
41 #include <linux/module.h>
42 #include <linux/slab.h>
43 #include <linux/string.h>
44 #include <linux/types.h>
45 #include <asm/of_device.h>
46 #include <asm/of_platform.h>
50 #define AXON_RAM_MODULE_NAME "axonram"
51 #define AXON_RAM_DEVICE_NAME "axonram"
52 #define AXON_RAM_MINORS_PER_DISK 16
53 #define AXON_RAM_BLOCK_SHIFT PAGE_SHIFT
54 #define AXON_RAM_BLOCK_SIZE 1 << AXON_RAM_BLOCK_SHIFT
55 #define AXON_RAM_SECTOR_SHIFT 9
56 #define AXON_RAM_SECTOR_SIZE 1 << AXON_RAM_SECTOR_SHIFT
57 #define AXON_RAM_IRQ_FLAGS IRQF_SHARED | IRQF_TRIGGER_RISING
59 struct axon_ram_bank {
60 struct of_device *device;
62 unsigned int irq_correctable;
63 unsigned int irq_uncorrectable;
64 unsigned long ph_addr;
65 unsigned long io_addr;
67 unsigned long ecc_counter;
71 axon_ram_sysfs_ecc(struct device *dev, struct device_attribute *attr, char *buf)
73 struct of_device *device = to_of_device(dev);
74 struct axon_ram_bank *bank = device->dev.platform_data;
78 return sprintf(buf, "%ld\n", bank->ecc_counter);
81 static DEVICE_ATTR(ecc, S_IRUGO, axon_ram_sysfs_ecc, NULL);
84 * axon_ram_irq_handler - interrupt handler for Axon RAM ECC
86 * @dev: pointer to of_device
89 axon_ram_irq_handler(int irq, void *dev)
91 struct of_device *device = dev;
92 struct axon_ram_bank *bank = device->dev.platform_data;
96 if (irq == bank->irq_correctable) {
97 dev_err(&device->dev, "Correctable memory error occured\n");
100 } else if (irq == bank->irq_uncorrectable) {
101 dev_err(&device->dev, "Uncorrectable memory error occured\n");
102 panic("Critical ECC error on %s", device->node->full_name);
109 * axon_ram_make_request - make_request() method for block device
110 * @queue, @bio: see blk_queue_make_request()
113 axon_ram_make_request(struct request_queue *queue, struct bio *bio)
115 struct axon_ram_bank *bank = bio->bi_bdev->bd_disk->private_data;
116 unsigned long phys_mem, phys_end;
119 unsigned int transfered;
123 phys_mem = bank->io_addr + (bio->bi_sector << AXON_RAM_SECTOR_SHIFT);
124 phys_end = bank->io_addr + bank->size;
126 bio_for_each_segment(vec, bio, idx) {
127 if (unlikely(phys_mem + vec->bv_len > phys_end)) {
128 bio_io_error(bio, bio->bi_size);
133 user_mem = page_address(vec->bv_page) + vec->bv_offset;
134 if (bio_data_dir(bio) == READ)
135 memcpy(user_mem, (void *) phys_mem, vec->bv_len);
137 memcpy((void *) phys_mem, user_mem, vec->bv_len);
139 phys_mem += vec->bv_len;
140 transfered += vec->bv_len;
142 bio_endio(bio, transfered, 0);
148 * axon_ram_direct_access - direct_access() method for block device
149 * @device, @sector, @data: see block_device_operations method
152 axon_ram_direct_access(struct block_device *device, sector_t sector,
155 struct axon_ram_bank *bank = device->bd_disk->private_data;
158 offset = sector << AXON_RAM_SECTOR_SHIFT;
159 if (offset >= bank->size) {
160 dev_err(&bank->device->dev, "Access outside of address space\n");
164 *data = bank->ph_addr + offset;
169 static struct block_device_operations axon_ram_devops = {
170 .owner = THIS_MODULE,
171 .direct_access = axon_ram_direct_access
175 * axon_ram_probe - probe() method for platform driver
176 * @device, @device_id: see of_platform_driver method
179 axon_ram_probe(struct of_device *device, const struct of_device_id *device_id)
181 static int axon_ram_bank_id = -1;
182 struct axon_ram_bank *bank;
183 struct resource resource;
188 dev_info(&device->dev, "Found memory controller on %s\n",
189 device->node->full_name);
191 bank = kzalloc(sizeof(struct axon_ram_bank), GFP_KERNEL);
193 dev_err(&device->dev, "Out of memory\n");
198 device->dev.platform_data = bank;
200 bank->device = device;
202 if (of_address_to_resource(device->node, 0, &resource) != 0) {
203 dev_err(&device->dev, "Cannot access device tree\n");
208 bank->size = resource.end - resource.start + 1;
210 if (bank->size == 0) {
211 dev_err(&device->dev, "No DDR2 memory found for %s%d\n",
212 AXON_RAM_DEVICE_NAME, axon_ram_bank_id);
217 dev_info(&device->dev, "Register DDR2 memory device %s%d with %luMB\n",
218 AXON_RAM_DEVICE_NAME, axon_ram_bank_id, bank->size >> 20);
220 bank->ph_addr = resource.start;
221 bank->io_addr = (unsigned long) ioremap_flags(
222 bank->ph_addr, bank->size, _PAGE_NO_CACHE);
223 if (bank->io_addr == 0) {
224 dev_err(&device->dev, "ioremap() failed\n");
229 bank->disk = alloc_disk(AXON_RAM_MINORS_PER_DISK);
230 if (bank->disk == NULL) {
231 dev_err(&device->dev, "Cannot register disk\n");
236 bank->disk->first_minor = 0;
237 bank->disk->fops = &axon_ram_devops;
238 bank->disk->private_data = bank;
239 bank->disk->driverfs_dev = &device->dev;
241 sprintf(bank->disk->disk_name, "%s%d",
242 AXON_RAM_DEVICE_NAME, axon_ram_bank_id);
243 bank->disk->major = register_blkdev(0, bank->disk->disk_name);
244 if (bank->disk->major < 0) {
245 dev_err(&device->dev, "Cannot register block device\n");
250 bank->disk->queue = blk_alloc_queue(GFP_KERNEL);
251 if (bank->disk->queue == NULL) {
252 dev_err(&device->dev, "Cannot register disk queue\n");
257 set_capacity(bank->disk, bank->size >> AXON_RAM_SECTOR_SHIFT);
258 blk_queue_make_request(bank->disk->queue, axon_ram_make_request);
259 blk_queue_hardsect_size(bank->disk->queue, AXON_RAM_SECTOR_SIZE);
260 add_disk(bank->disk);
262 bank->irq_correctable = irq_of_parse_and_map(device->node, 0);
263 bank->irq_uncorrectable = irq_of_parse_and_map(device->node, 1);
264 if ((bank->irq_correctable <= 0) || (bank->irq_uncorrectable <= 0)) {
265 dev_err(&device->dev, "Cannot access ECC interrupt ID\n");
270 rc = request_irq(bank->irq_correctable, axon_ram_irq_handler,
271 AXON_RAM_IRQ_FLAGS, bank->disk->disk_name, device);
273 dev_err(&device->dev, "Cannot register ECC interrupt handler\n");
274 bank->irq_correctable = bank->irq_uncorrectable = 0;
279 rc = request_irq(bank->irq_uncorrectable, axon_ram_irq_handler,
280 AXON_RAM_IRQ_FLAGS, bank->disk->disk_name, device);
282 dev_err(&device->dev, "Cannot register ECC interrupt handler\n");
283 bank->irq_uncorrectable = 0;
288 rc = device_create_file(&device->dev, &dev_attr_ecc);
290 dev_err(&device->dev, "Cannot create sysfs file\n");
299 if (bank->irq_uncorrectable > 0)
300 free_irq(bank->irq_uncorrectable, device);
301 if (bank->irq_correctable > 0)
302 free_irq(bank->irq_correctable, device);
303 if (bank->disk != NULL) {
304 if (bank->disk->queue != NULL)
305 blk_cleanup_queue(bank->disk->queue);
306 if (bank->disk->major > 0)
307 unregister_blkdev(bank->disk->major,
308 bank->disk->disk_name);
309 del_gendisk(bank->disk);
311 device->dev.platform_data = NULL;
312 if (bank->io_addr != 0)
313 iounmap((void __iomem *) bank->io_addr);
321 * axon_ram_remove - remove() method for platform driver
322 * @device: see of_platform_driver method
325 axon_ram_remove(struct of_device *device)
327 struct axon_ram_bank *bank = device->dev.platform_data;
329 BUG_ON(!bank || !bank->disk);
331 device_remove_file(&device->dev, &dev_attr_ecc);
332 free_irq(bank->irq_uncorrectable, device);
333 free_irq(bank->irq_correctable, device);
334 blk_cleanup_queue(bank->disk->queue);
335 unregister_blkdev(bank->disk->major, bank->disk->disk_name);
336 del_gendisk(bank->disk);
337 iounmap((void __iomem *) bank->io_addr);
343 static struct of_device_id axon_ram_device_id[] = {
350 static struct of_platform_driver axon_ram_driver = {
351 .owner = THIS_MODULE,
352 .name = AXON_RAM_MODULE_NAME,
353 .match_table = axon_ram_device_id,
354 .probe = axon_ram_probe,
355 .remove = axon_ram_remove
364 return of_register_platform_driver(&axon_ram_driver);
373 of_unregister_platform_driver(&axon_ram_driver);
376 module_init(axon_ram_init);
377 module_exit(axon_ram_exit);
379 MODULE_LICENSE("GPL");
380 MODULE_AUTHOR("Maxim Shchetynin <maxim@de.ibm.com>");
381 MODULE_DESCRIPTION("Axon DDR2 RAM device driver for IBM Cell BE");