2 * Copyright 2011-2012, Meador Inge, Mentor Graphics Corporation.
4 * Some ideas based on un-pushed work done by Vivek Mahajan, Jason Jin, and
5 * Mingkai Hu from Freescale Semiconductor, Inc.
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; version 2 of the
14 #include <linux/list.h>
15 #include <linux/of_platform.h>
16 #include <linux/errno.h>
18 #include <asm/hw_irq.h>
19 #include <asm/ppc-pci.h>
20 #include <asm/mpic_msgr.h>
22 #define MPIC_MSGR_REGISTERS_PER_BLOCK 4
23 #define MPIC_MSGR_STRIDE 0x10
24 #define MPIC_MSGR_MER_OFFSET 0x100
28 static struct mpic_msgr **mpic_msgrs;
29 static unsigned int mpic_msgr_count;
30 static DEFINE_RAW_SPINLOCK(msgrs_lock);
32 static inline void _mpic_msgr_mer_write(struct mpic_msgr *msgr, u32 value)
34 out_be32(msgr->mer, value);
37 static inline u32 _mpic_msgr_mer_read(struct mpic_msgr *msgr)
39 return in_be32(msgr->mer);
42 static inline void _mpic_msgr_disable(struct mpic_msgr *msgr)
44 u32 mer = _mpic_msgr_mer_read(msgr);
46 _mpic_msgr_mer_write(msgr, mer & ~(1 << msgr->num));
49 struct mpic_msgr *mpic_msgr_get(unsigned int reg_num)
52 struct mpic_msgr *msgr;
54 /* Assume busy until proven otherwise. */
55 msgr = ERR_PTR(-EBUSY);
57 if (reg_num >= mpic_msgr_count)
58 return ERR_PTR(-ENODEV);
60 raw_spin_lock_irqsave(&msgrs_lock, flags);
61 msgr = mpic_msgrs[reg_num];
62 if (msgr->in_use == MSGR_FREE)
63 msgr->in_use = MSGR_INUSE;
64 raw_spin_unlock_irqrestore(&msgrs_lock, flags);
68 EXPORT_SYMBOL_GPL(mpic_msgr_get);
70 void mpic_msgr_put(struct mpic_msgr *msgr)
74 raw_spin_lock_irqsave(&msgr->lock, flags);
75 msgr->in_use = MSGR_FREE;
76 _mpic_msgr_disable(msgr);
77 raw_spin_unlock_irqrestore(&msgr->lock, flags);
79 EXPORT_SYMBOL_GPL(mpic_msgr_put);
81 void mpic_msgr_enable(struct mpic_msgr *msgr)
86 raw_spin_lock_irqsave(&msgr->lock, flags);
87 mer = _mpic_msgr_mer_read(msgr);
88 _mpic_msgr_mer_write(msgr, mer | (1 << msgr->num));
89 raw_spin_unlock_irqrestore(&msgr->lock, flags);
91 EXPORT_SYMBOL_GPL(mpic_msgr_enable);
93 void mpic_msgr_disable(struct mpic_msgr *msgr)
97 raw_spin_lock_irqsave(&msgr->lock, flags);
98 _mpic_msgr_disable(msgr);
99 raw_spin_unlock_irqrestore(&msgr->lock, flags);
101 EXPORT_SYMBOL_GPL(mpic_msgr_disable);
103 /* The following three functions are used to compute the order and number of
104 * the message register blocks. They are clearly very inefficent. However,
105 * they are called *only* a few times during device initialization.
107 static unsigned int mpic_msgr_number_of_blocks(void)
110 struct device_node *aliases;
113 aliases = of_find_node_by_name(NULL, "aliases");
119 snprintf(buf, sizeof(buf), "mpic-msgr-block%d", count);
120 if (!of_find_property(aliases, buf, NULL))
130 static unsigned int mpic_msgr_number_of_registers(void)
132 return mpic_msgr_number_of_blocks() * MPIC_MSGR_REGISTERS_PER_BLOCK;
135 static int mpic_msgr_block_number(struct device_node *node)
137 struct device_node *aliases;
138 unsigned int index, number_of_blocks;
141 number_of_blocks = mpic_msgr_number_of_blocks();
142 aliases = of_find_node_by_name(NULL, "aliases");
146 for (index = 0; index < number_of_blocks; ++index) {
147 struct property *prop;
149 snprintf(buf, sizeof(buf), "mpic-msgr-block%d", index);
150 prop = of_find_property(aliases, buf, NULL);
151 if (node == of_find_node_by_path(prop->value))
155 return index == number_of_blocks ? -1 : index;
158 /* The probe function for a single message register block.
160 static __devinit int mpic_msgr_probe(struct platform_device *dev)
162 void __iomem *msgr_block_addr;
164 struct resource rsrc;
166 unsigned int irq_index;
167 struct device_node *np = dev->dev.of_node;
168 unsigned int receive_mask;
169 const unsigned int *prop;
172 dev_err(&dev->dev, "Device OF-Node is NULL");
176 /* Allocate the message register array upon the first device
180 mpic_msgr_count = mpic_msgr_number_of_registers();
181 dev_info(&dev->dev, "Found %d message registers\n",
184 mpic_msgrs = kzalloc(sizeof(struct mpic_msgr) * mpic_msgr_count,
188 "No memory for message register blocks\n");
192 dev_info(&dev->dev, "Of-device full name %s\n", np->full_name);
194 /* IO map the message register block. */
195 of_address_to_resource(np, 0, &rsrc);
196 msgr_block_addr = ioremap(rsrc.start, rsrc.end - rsrc.start);
197 if (!msgr_block_addr) {
198 dev_err(&dev->dev, "Failed to iomap MPIC message registers");
202 /* Ensure the block has a defined order. */
203 block_number = mpic_msgr_block_number(np);
204 if (block_number < 0) {
206 "Failed to find message register block alias\n");
209 dev_info(&dev->dev, "Setting up message register block %d\n",
212 /* Grab the receive mask which specifies what registers can receive
215 prop = of_get_property(np, "mpic-msgr-receive-mask", NULL);
216 receive_mask = (prop) ? *prop : 0xF;
218 /* Build up the appropriate message register data structures. */
219 for (i = 0, irq_index = 0; i < MPIC_MSGR_REGISTERS_PER_BLOCK; ++i) {
220 struct mpic_msgr *msgr;
221 unsigned int reg_number;
223 msgr = kzalloc(sizeof(struct mpic_msgr), GFP_KERNEL);
225 dev_err(&dev->dev, "No memory for message register\n");
229 reg_number = block_number * MPIC_MSGR_REGISTERS_PER_BLOCK + i;
230 msgr->base = msgr_block_addr + i * MPIC_MSGR_STRIDE;
231 msgr->mer = (u32 *)((u8 *)msgr->base + MPIC_MSGR_MER_OFFSET);
232 msgr->in_use = MSGR_FREE;
234 raw_spin_lock_init(&msgr->lock);
236 if (receive_mask & (1 << i)) {
239 if (of_irq_to_resource(np, irq_index, &irq) == NO_IRQ) {
241 "Missing interrupt specifier");
245 msgr->irq = irq.start;
251 mpic_msgrs[reg_number] = msgr;
252 mpic_msgr_disable(msgr);
253 dev_info(&dev->dev, "Register %d initialized: irq %d\n",
254 reg_number, msgr->irq);
261 static const struct of_device_id mpic_msgr_ids[] = {
263 .compatible = "fsl,mpic-v3.1-msgr",
269 static struct platform_driver mpic_msgr_driver = {
272 .owner = THIS_MODULE,
273 .of_match_table = mpic_msgr_ids,
275 .probe = mpic_msgr_probe,
278 static __init int mpic_msgr_init(void)
280 return platform_driver_register(&mpic_msgr_driver);
282 subsys_initcall(mpic_msgr_init);