blob: bfbf8aa2de04295f3190b21947827bbdc62fe42a [file] [log] [blame]
Alan Tull6a8c3be2015-10-07 16:36:28 +01001/*
2 * FPGA Manager Core
3 *
4 * Copyright (C) 2013-2015 Altera Corporation
5 *
6 * With code from the mailing list:
7 * Copyright (C) 2013 Xilinx, Inc.
8 *
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms and conditions of the GNU General Public License,
11 * version 2, as published by the Free Software Foundation.
12 *
13 * This program is distributed in the hope it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * more details.
17 *
18 * You should have received a copy of the GNU General Public License along with
19 * this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21#include <linux/firmware.h>
22#include <linux/fpga/fpga-mgr.h>
23#include <linux/idr.h>
24#include <linux/module.h>
25#include <linux/of.h>
26#include <linux/mutex.h>
27#include <linux/slab.h>
28
29static DEFINE_IDA(fpga_mgr_ida);
30static struct class *fpga_mgr_class;
31
32/**
33 * fpga_mgr_buf_load - load fpga from image in buffer
34 * @mgr: fpga manager
35 * @flags: flags setting fpga confuration modes
36 * @buf: buffer contain fpga image
37 * @count: byte count of buf
38 *
39 * Step the low level fpga manager through the device-specific steps of getting
40 * an FPGA ready to be configured, writing the image to it, then doing whatever
Alan Tull92d94a72015-10-22 12:38:38 -050041 * post-configuration steps necessary. This code assumes the caller got the
42 * mgr pointer from of_fpga_mgr_get() and checked that it is not an error code.
Alan Tull6a8c3be2015-10-07 16:36:28 +010043 *
44 * Return: 0 on success, negative error code otherwise.
45 */
46int fpga_mgr_buf_load(struct fpga_manager *mgr, u32 flags, const char *buf,
47 size_t count)
48{
49 struct device *dev = &mgr->dev;
50 int ret;
51
Alan Tull6a8c3be2015-10-07 16:36:28 +010052 /*
53 * Call the low level driver's write_init function. This will do the
54 * device-specific things to get the FPGA into the state where it is
55 * ready to receive an FPGA image.
56 */
57 mgr->state = FPGA_MGR_STATE_WRITE_INIT;
58 ret = mgr->mops->write_init(mgr, flags, buf, count);
59 if (ret) {
60 dev_err(dev, "Error preparing FPGA for writing\n");
61 mgr->state = FPGA_MGR_STATE_WRITE_INIT_ERR;
62 return ret;
63 }
64
65 /*
66 * Write the FPGA image to the FPGA.
67 */
68 mgr->state = FPGA_MGR_STATE_WRITE;
69 ret = mgr->mops->write(mgr, buf, count);
70 if (ret) {
71 dev_err(dev, "Error while writing image data to FPGA\n");
72 mgr->state = FPGA_MGR_STATE_WRITE_ERR;
73 return ret;
74 }
75
76 /*
77 * After all the FPGA image has been written, do the device specific
78 * steps to finish and set the FPGA into operating mode.
79 */
80 mgr->state = FPGA_MGR_STATE_WRITE_COMPLETE;
81 ret = mgr->mops->write_complete(mgr, flags);
82 if (ret) {
83 dev_err(dev, "Error after writing image data to FPGA\n");
84 mgr->state = FPGA_MGR_STATE_WRITE_COMPLETE_ERR;
85 return ret;
86 }
87 mgr->state = FPGA_MGR_STATE_OPERATING;
88
89 return 0;
90}
91EXPORT_SYMBOL_GPL(fpga_mgr_buf_load);
92
93/**
94 * fpga_mgr_firmware_load - request firmware and load to fpga
95 * @mgr: fpga manager
96 * @flags: flags setting fpga confuration modes
97 * @image_name: name of image file on the firmware search path
98 *
99 * Request an FPGA image using the firmware class, then write out to the FPGA.
100 * Update the state before each step to provide info on what step failed if
Alan Tull92d94a72015-10-22 12:38:38 -0500101 * there is a failure. This code assumes the caller got the mgr pointer
102 * from of_fpga_mgr_get() and checked that it is not an error code.
Alan Tull6a8c3be2015-10-07 16:36:28 +0100103 *
104 * Return: 0 on success, negative error code otherwise.
105 */
106int fpga_mgr_firmware_load(struct fpga_manager *mgr, u32 flags,
107 const char *image_name)
108{
109 struct device *dev = &mgr->dev;
110 const struct firmware *fw;
111 int ret;
112
Alan Tull6a8c3be2015-10-07 16:36:28 +0100113 dev_info(dev, "writing %s to %s\n", image_name, mgr->name);
114
115 mgr->state = FPGA_MGR_STATE_FIRMWARE_REQ;
116
117 ret = request_firmware(&fw, image_name, dev);
118 if (ret) {
119 mgr->state = FPGA_MGR_STATE_FIRMWARE_REQ_ERR;
120 dev_err(dev, "Error requesting firmware %s\n", image_name);
121 return ret;
122 }
123
124 ret = fpga_mgr_buf_load(mgr, flags, fw->data, fw->size);
125 if (ret)
126 return ret;
127
128 release_firmware(fw);
129
130 return 0;
131}
132EXPORT_SYMBOL_GPL(fpga_mgr_firmware_load);
133
134static const char * const state_str[] = {
135 [FPGA_MGR_STATE_UNKNOWN] = "unknown",
136 [FPGA_MGR_STATE_POWER_OFF] = "power off",
137 [FPGA_MGR_STATE_POWER_UP] = "power up",
138 [FPGA_MGR_STATE_RESET] = "reset",
139
140 /* requesting FPGA image from firmware */
141 [FPGA_MGR_STATE_FIRMWARE_REQ] = "firmware request",
142 [FPGA_MGR_STATE_FIRMWARE_REQ_ERR] = "firmware request error",
143
144 /* Preparing FPGA to receive image */
145 [FPGA_MGR_STATE_WRITE_INIT] = "write init",
146 [FPGA_MGR_STATE_WRITE_INIT_ERR] = "write init error",
147
148 /* Writing image to FPGA */
149 [FPGA_MGR_STATE_WRITE] = "write",
150 [FPGA_MGR_STATE_WRITE_ERR] = "write error",
151
152 /* Finishing configuration after image has been written */
153 [FPGA_MGR_STATE_WRITE_COMPLETE] = "write complete",
154 [FPGA_MGR_STATE_WRITE_COMPLETE_ERR] = "write complete error",
155
156 /* FPGA reports to be in normal operating mode */
157 [FPGA_MGR_STATE_OPERATING] = "operating",
158};
159
160static ssize_t name_show(struct device *dev,
161 struct device_attribute *attr, char *buf)
162{
163 struct fpga_manager *mgr = to_fpga_manager(dev);
164
165 return sprintf(buf, "%s\n", mgr->name);
166}
167
168static ssize_t state_show(struct device *dev,
169 struct device_attribute *attr, char *buf)
170{
171 struct fpga_manager *mgr = to_fpga_manager(dev);
172
173 return sprintf(buf, "%s\n", state_str[mgr->state]);
174}
175
176static DEVICE_ATTR_RO(name);
177static DEVICE_ATTR_RO(state);
178
179static struct attribute *fpga_mgr_attrs[] = {
180 &dev_attr_name.attr,
181 &dev_attr_state.attr,
182 NULL,
183};
184ATTRIBUTE_GROUPS(fpga_mgr);
185
186static int fpga_mgr_of_node_match(struct device *dev, const void *data)
187{
188 return dev->of_node == data;
189}
190
191/**
192 * of_fpga_mgr_get - get an exclusive reference to a fpga mgr
193 * @node: device node
194 *
195 * Given a device node, get an exclusive reference to a fpga mgr.
196 *
197 * Return: fpga manager struct or IS_ERR() condition containing error code.
198 */
199struct fpga_manager *of_fpga_mgr_get(struct device_node *node)
200{
201 struct fpga_manager *mgr;
202 struct device *dev;
Alan Tull654ba4c2015-10-22 12:38:37 -0500203 int ret = -ENODEV;
Alan Tull6a8c3be2015-10-07 16:36:28 +0100204
205 dev = class_find_device(fpga_mgr_class, NULL, node,
206 fpga_mgr_of_node_match);
207 if (!dev)
208 return ERR_PTR(-ENODEV);
209
210 mgr = to_fpga_manager(dev);
Alan Tull6a8c3be2015-10-07 16:36:28 +0100211 if (!mgr)
Alan Tull654ba4c2015-10-22 12:38:37 -0500212 goto err_dev;
Alan Tull6a8c3be2015-10-07 16:36:28 +0100213
214 /* Get exclusive use of fpga manager */
Alan Tull654ba4c2015-10-22 12:38:37 -0500215 if (!mutex_trylock(&mgr->ref_mutex)) {
216 ret = -EBUSY;
217 goto err_dev;
Alan Tull6a8c3be2015-10-07 16:36:28 +0100218 }
219
Alan Tull654ba4c2015-10-22 12:38:37 -0500220 if (!try_module_get(dev->parent->driver->owner))
221 goto err_ll_mod;
222
Alan Tull6a8c3be2015-10-07 16:36:28 +0100223 return mgr;
Alan Tull654ba4c2015-10-22 12:38:37 -0500224
225err_ll_mod:
226 mutex_unlock(&mgr->ref_mutex);
227err_dev:
228 put_device(dev);
229 return ERR_PTR(ret);
Alan Tull6a8c3be2015-10-07 16:36:28 +0100230}
231EXPORT_SYMBOL_GPL(of_fpga_mgr_get);
232
233/**
234 * fpga_mgr_put - release a reference to a fpga manager
235 * @mgr: fpga manager structure
236 */
237void fpga_mgr_put(struct fpga_manager *mgr)
238{
Alan Tull654ba4c2015-10-22 12:38:37 -0500239 module_put(mgr->dev.parent->driver->owner);
240 mutex_unlock(&mgr->ref_mutex);
241 put_device(&mgr->dev);
Alan Tull6a8c3be2015-10-07 16:36:28 +0100242}
243EXPORT_SYMBOL_GPL(fpga_mgr_put);
244
245/**
246 * fpga_mgr_register - register a low level fpga manager driver
247 * @dev: fpga manager device from pdev
248 * @name: fpga manager name
249 * @mops: pointer to structure of fpga manager ops
250 * @priv: fpga manager private data
251 *
252 * Return: 0 on success, negative error code otherwise.
253 */
254int fpga_mgr_register(struct device *dev, const char *name,
255 const struct fpga_manager_ops *mops,
256 void *priv)
257{
258 struct fpga_manager *mgr;
Alan Tull6a8c3be2015-10-07 16:36:28 +0100259 int id, ret;
260
261 if (!mops || !mops->write_init || !mops->write ||
262 !mops->write_complete || !mops->state) {
263 dev_err(dev, "Attempt to register without fpga_manager_ops\n");
264 return -EINVAL;
265 }
266
267 if (!name || !strlen(name)) {
268 dev_err(dev, "Attempt to register with no name!\n");
269 return -EINVAL;
270 }
271
272 mgr = kzalloc(sizeof(*mgr), GFP_KERNEL);
273 if (!mgr)
274 return -ENOMEM;
275
276 id = ida_simple_get(&fpga_mgr_ida, 0, 0, GFP_KERNEL);
277 if (id < 0) {
278 ret = id;
279 goto error_kfree;
280 }
281
282 mutex_init(&mgr->ref_mutex);
283
284 mgr->name = name;
285 mgr->mops = mops;
286 mgr->priv = priv;
287
288 /*
289 * Initialize framework state by requesting low level driver read state
290 * from device. FPGA may be in reset mode or may have been programmed
291 * by bootloader or EEPROM.
292 */
293 mgr->state = mgr->mops->state(mgr);
294
295 device_initialize(&mgr->dev);
296 mgr->dev.class = fpga_mgr_class;
297 mgr->dev.parent = dev;
298 mgr->dev.of_node = dev->of_node;
299 mgr->dev.id = id;
300 dev_set_drvdata(dev, mgr);
301
Alan Tull07687c02015-10-29 14:39:56 -0500302 ret = dev_set_name(&mgr->dev, "fpga%d", id);
303 if (ret)
304 goto error_device;
Alan Tull6a8c3be2015-10-07 16:36:28 +0100305
306 ret = device_add(&mgr->dev);
307 if (ret)
308 goto error_device;
309
310 dev_info(&mgr->dev, "%s registered\n", mgr->name);
311
312 return 0;
313
314error_device:
315 ida_simple_remove(&fpga_mgr_ida, id);
316error_kfree:
317 kfree(mgr);
318
319 return ret;
320}
321EXPORT_SYMBOL_GPL(fpga_mgr_register);
322
323/**
324 * fpga_mgr_unregister - unregister a low level fpga manager driver
325 * @dev: fpga manager device from pdev
326 */
327void fpga_mgr_unregister(struct device *dev)
328{
329 struct fpga_manager *mgr = dev_get_drvdata(dev);
330
331 dev_info(&mgr->dev, "%s %s\n", __func__, mgr->name);
332
333 /*
334 * If the low level driver provides a method for putting fpga into
335 * a desired state upon unregister, do it.
336 */
337 if (mgr->mops->fpga_remove)
338 mgr->mops->fpga_remove(mgr);
339
340 device_unregister(&mgr->dev);
341}
342EXPORT_SYMBOL_GPL(fpga_mgr_unregister);
343
344static void fpga_mgr_dev_release(struct device *dev)
345{
346 struct fpga_manager *mgr = to_fpga_manager(dev);
347
348 ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
349 kfree(mgr);
350}
351
352static int __init fpga_mgr_class_init(void)
353{
354 pr_info("FPGA manager framework\n");
355
356 fpga_mgr_class = class_create(THIS_MODULE, "fpga_manager");
357 if (IS_ERR(fpga_mgr_class))
358 return PTR_ERR(fpga_mgr_class);
359
360 fpga_mgr_class->dev_groups = fpga_mgr_groups;
361 fpga_mgr_class->dev_release = fpga_mgr_dev_release;
362
363 return 0;
364}
365
366static void __exit fpga_mgr_class_exit(void)
367{
368 class_destroy(fpga_mgr_class);
369 ida_destroy(&fpga_mgr_ida);
370}
371
372MODULE_AUTHOR("Alan Tull <atull@opensource.altera.com>");
373MODULE_DESCRIPTION("FPGA manager framework");
374MODULE_LICENSE("GPL v2");
375
376subsys_initcall(fpga_mgr_class_init);
377module_exit(fpga_mgr_class_exit);