2 * Copyright (c) 2014-2015 Hisilicon Limited.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
10 #include <linux/dma-mapping.h>
11 #include <linux/interrupt.h>
13 #include <linux/skbuff.h>
14 #include <linux/slab.h>
17 #define cls_to_ae_dev(dev) container_of(dev, struct hnae_ae_dev, cls_dev)
19 static struct class *hnae_class;
22 hnae_list_add(spinlock_t *lock, struct list_head *node, struct list_head *head)
26 spin_lock_irqsave(lock, flags);
27 list_add_tail_rcu(node, head);
28 spin_unlock_irqrestore(lock, flags);
31 static void hnae_list_del(spinlock_t *lock, struct list_head *node)
35 spin_lock_irqsave(lock, flags);
37 spin_unlock_irqrestore(lock, flags);
40 static int hnae_alloc_buffer(struct hnae_ring *ring, struct hnae_desc_cb *cb)
42 unsigned int order = hnae_page_order(ring);
43 struct page *p = dev_alloc_pages(order);
51 cb->buf = page_address(p);
52 cb->length = hnae_page_size(ring);
53 cb->type = DESC_TYPE_PAGE;
58 static void hnae_free_buffer(struct hnae_ring *ring, struct hnae_desc_cb *cb)
60 if (unlikely(!cb->priv))
63 if (cb->type == DESC_TYPE_SKB)
64 dev_kfree_skb_any((struct sk_buff *)cb->priv);
65 else if (unlikely(is_rx_ring(ring)))
66 put_page((struct page *)cb->priv);
71 static int hnae_map_buffer(struct hnae_ring *ring, struct hnae_desc_cb *cb)
73 cb->dma = dma_map_page(ring_to_dev(ring), cb->priv, 0,
74 cb->length, ring_to_dma_dir(ring));
76 if (dma_mapping_error(ring_to_dev(ring), cb->dma))
82 static void hnae_unmap_buffer(struct hnae_ring *ring, struct hnae_desc_cb *cb)
84 if (cb->type == DESC_TYPE_SKB)
85 dma_unmap_single(ring_to_dev(ring), cb->dma, cb->length,
86 ring_to_dma_dir(ring));
88 dma_unmap_page(ring_to_dev(ring), cb->dma, cb->length,
89 ring_to_dma_dir(ring));
92 static struct hnae_buf_ops hnae_bops = {
93 .alloc_buffer = hnae_alloc_buffer,
94 .free_buffer = hnae_free_buffer,
95 .map_buffer = hnae_map_buffer,
96 .unmap_buffer = hnae_unmap_buffer,
99 static int __ae_match(struct device *dev, const void *data)
101 struct hnae_ae_dev *hdev = cls_to_ae_dev(dev);
103 if (dev_of_node(hdev->dev))
104 return (data == &hdev->dev->of_node->fwnode);
105 else if (is_acpi_node(hdev->dev->fwnode))
106 return (data == hdev->dev->fwnode);
108 dev_err(dev, "__ae_match cannot read cfg data from OF or acpi\n");
112 static struct hnae_ae_dev *find_ae(const struct fwnode_handle *fwnode)
118 dev = class_find_device(hnae_class, NULL, fwnode, __ae_match);
120 return dev ? cls_to_ae_dev(dev) : NULL;
123 static void hnae_free_buffers(struct hnae_ring *ring)
127 for (i = 0; i < ring->desc_num; i++)
128 hnae_free_buffer_detach(ring, i);
131 /* Allocate memory for raw pkg, and map with dma */
132 static int hnae_alloc_buffers(struct hnae_ring *ring)
136 for (i = 0; i < ring->desc_num; i++) {
137 ret = hnae_alloc_buffer_attach(ring, i);
139 goto out_buffer_fail;
145 for (j = i - 1; j >= 0; j--)
146 hnae_free_buffer_detach(ring, j);
150 /* free desc along with its attached buffer */
151 static void hnae_free_desc(struct hnae_ring *ring)
153 dma_unmap_single(ring_to_dev(ring), ring->desc_dma_addr,
154 ring->desc_num * sizeof(ring->desc[0]),
155 ring_to_dma_dir(ring));
156 ring->desc_dma_addr = 0;
161 /* alloc desc, without buffer attached */
162 static int hnae_alloc_desc(struct hnae_ring *ring)
164 int size = ring->desc_num * sizeof(ring->desc[0]);
166 ring->desc = kzalloc(size, GFP_KERNEL);
170 ring->desc_dma_addr = dma_map_single(ring_to_dev(ring),
171 ring->desc, size, ring_to_dma_dir(ring));
172 if (dma_mapping_error(ring_to_dev(ring), ring->desc_dma_addr)) {
173 ring->desc_dma_addr = 0;
182 /* fini ring, also free the buffer for the ring */
183 static void hnae_fini_ring(struct hnae_ring *ring)
185 if (is_rx_ring(ring))
186 hnae_free_buffers(ring);
188 hnae_free_desc(ring);
189 kfree(ring->desc_cb);
190 ring->desc_cb = NULL;
191 ring->next_to_clean = 0;
192 ring->next_to_use = 0;
195 /* init ring, and with buffer for rx ring */
197 hnae_init_ring(struct hnae_queue *q, struct hnae_ring *ring, int flags)
201 if (ring->desc_num <= 0 || ring->buf_size <= 0)
206 spin_lock_init(&ring->lock);
207 ring->coal_param = q->handle->coal_param;
208 assert(!ring->desc && !ring->desc_cb && !ring->desc_dma_addr);
210 /* not matter for tx or rx ring, the ntc and ntc start from 0 */
211 assert(ring->next_to_use == 0);
212 assert(ring->next_to_clean == 0);
214 ring->desc_cb = kcalloc(ring->desc_num, sizeof(ring->desc_cb[0]),
216 if (!ring->desc_cb) {
221 ret = hnae_alloc_desc(ring);
223 goto out_with_desc_cb;
225 if (is_rx_ring(ring)) {
226 ret = hnae_alloc_buffers(ring);
234 hnae_free_desc(ring);
236 kfree(ring->desc_cb);
237 ring->desc_cb = NULL;
242 static int hnae_init_queue(struct hnae_handle *h, struct hnae_queue *q,
243 struct hnae_ae_dev *dev)
250 ret = hnae_init_ring(q, &q->tx_ring, q->tx_ring.flags | RINGF_DIR);
254 ret = hnae_init_ring(q, &q->rx_ring, q->rx_ring.flags & ~RINGF_DIR);
256 goto out_with_tx_ring;
258 if (dev->ops->init_queue)
259 dev->ops->init_queue(q);
264 hnae_fini_ring(&q->tx_ring);
269 static void hnae_fini_queue(struct hnae_queue *q)
271 if (q->dev->ops->fini_queue)
272 q->dev->ops->fini_queue(q);
274 hnae_fini_ring(&q->tx_ring);
275 hnae_fini_ring(&q->rx_ring);
279 * ae_chain - define ae chain head
281 static RAW_NOTIFIER_HEAD(ae_chain);
283 int hnae_register_notifier(struct notifier_block *nb)
285 return raw_notifier_chain_register(&ae_chain, nb);
287 EXPORT_SYMBOL(hnae_register_notifier);
289 void hnae_unregister_notifier(struct notifier_block *nb)
291 if (raw_notifier_chain_unregister(&ae_chain, nb))
292 dev_err(NULL, "notifier chain unregister fail\n");
294 EXPORT_SYMBOL(hnae_unregister_notifier);
296 int hnae_reinit_handle(struct hnae_handle *handle)
301 for (i = 0; i < handle->q_num; i++) /* free ring*/
302 hnae_fini_queue(handle->qs[i]);
304 if (handle->dev->ops->reset)
305 handle->dev->ops->reset(handle);
307 for (i = 0; i < handle->q_num; i++) {/* reinit ring*/
308 ret = hnae_init_queue(handle, handle->qs[i], handle->dev);
310 goto out_when_init_queue;
314 for (j = i - 1; j >= 0; j--)
315 hnae_fini_queue(handle->qs[j]);
318 EXPORT_SYMBOL(hnae_reinit_handle);
320 /* hnae_get_handle - get a handle from the AE
321 * @owner_dev: the dev use this handle
322 * @ae_id: the id of the ae to be used
323 * @ae_opts: the options set for the handle
324 * @bops: the callbacks for buffer management
326 * return handle ptr or ERR_PTR
328 struct hnae_handle *hnae_get_handle(struct device *owner_dev,
329 const struct fwnode_handle *fwnode,
331 struct hnae_buf_ops *bops)
333 struct hnae_ae_dev *dev;
334 struct hnae_handle *handle;
338 dev = find_ae(fwnode);
340 return ERR_PTR(-ENODEV);
342 handle = dev->ops->get_handle(dev, port_id);
343 if (IS_ERR(handle)) {
344 put_device(&dev->cls_dev);
349 handle->owner_dev = owner_dev;
350 handle->bops = bops ? bops : &hnae_bops;
351 handle->eport_id = port_id;
353 for (i = 0; i < handle->q_num; i++) {
354 ret = hnae_init_queue(handle, handle->qs[i], dev);
356 goto out_when_init_queue;
359 __module_get(dev->owner);
361 hnae_list_add(&dev->lock, &handle->node, &dev->handle_list);
366 for (j = i - 1; j >= 0; j--)
367 hnae_fini_queue(handle->qs[j]);
369 put_device(&dev->cls_dev);
371 return ERR_PTR(-ENOMEM);
373 EXPORT_SYMBOL(hnae_get_handle);
375 void hnae_put_handle(struct hnae_handle *h)
377 struct hnae_ae_dev *dev = h->dev;
380 for (i = 0; i < h->q_num; i++)
381 hnae_fini_queue(h->qs[i]);
383 if (h->dev->ops->reset)
384 h->dev->ops->reset(h);
386 hnae_list_del(&dev->lock, &h->node);
388 if (dev->ops->put_handle)
389 dev->ops->put_handle(h);
391 module_put(dev->owner);
393 put_device(&dev->cls_dev);
395 EXPORT_SYMBOL(hnae_put_handle);
397 static void hnae_release(struct device *dev)
402 * hnae_ae_register - register a AE engine to hnae framework
403 * @hdev: the hnae ae engine device
404 * @owner: the module who provides this dev
405 * NOTE: the duplicated name will not be checked
407 int hnae_ae_register(struct hnae_ae_dev *hdev, struct module *owner)
409 static atomic_t id = ATOMIC_INIT(-1);
415 if (!hdev->ops || !hdev->ops->get_handle ||
416 !hdev->ops->toggle_ring_irq ||
417 !hdev->ops->get_status || !hdev->ops->adjust_link)
421 hdev->id = (int)atomic_inc_return(&id);
422 hdev->cls_dev.parent = hdev->dev;
423 hdev->cls_dev.class = hnae_class;
424 hdev->cls_dev.release = hnae_release;
425 (void)dev_set_name(&hdev->cls_dev, "hnae%d", hdev->id);
426 ret = device_register(&hdev->cls_dev);
428 put_device(&hdev->cls_dev);
432 __module_get(THIS_MODULE);
434 INIT_LIST_HEAD(&hdev->handle_list);
435 spin_lock_init(&hdev->lock);
437 ret = raw_notifier_call_chain(&ae_chain, HNAE_AE_REGISTER, NULL);
440 "has not notifier for AE: %s\n", hdev->name);
444 EXPORT_SYMBOL(hnae_ae_register);
447 * hnae_ae_unregister - unregisters a HNAE AE engine
448 * @cdev: the device to unregister
450 void hnae_ae_unregister(struct hnae_ae_dev *hdev)
452 device_unregister(&hdev->cls_dev);
453 module_put(THIS_MODULE);
455 EXPORT_SYMBOL(hnae_ae_unregister);
457 static int __init hnae_init(void)
459 hnae_class = class_create(THIS_MODULE, "hnae");
460 return PTR_ERR_OR_ZERO(hnae_class);
463 static void __exit hnae_exit(void)
465 class_destroy(hnae_class);
468 subsys_initcall(hnae_init);
469 module_exit(hnae_exit);
471 MODULE_AUTHOR("Hisilicon, Inc.");
472 MODULE_LICENSE("GPL");
473 MODULE_DESCRIPTION("Hisilicon Network Acceleration Engine Framework");
475 /* vi: set tw=78 noet: */