History

clkdev: add managed clkdev lookup registration

Clkdev registration lacks of managed registration functions and it seems few drivers do not drop clkdev lookups at exit. Add devm_clk_hw_register_clkdev and devm_clk_release_clkdev to ease lookup releasing at exit.

Matti Vaittinen committed 7 years ago

Commit 3eee6c71 parent bfeffd13 files · +93 −23Browse files

Unified · Split

3 files
  1. Documentation/driver-model/devres.txt +1 −0
  2. drivers/clk/clkdev.c +88 −23
  3. include/linux/clkdev.h +4 −0
Documentation/driver-model/devres.txt+1−0
@@ -245,6 +245,7 @@ CLOCK · 244 unmodified lines
245245 devm_clk_put()
246246 devm_clk_hw_register()
247247 devm_of_clk_add_hw_provider()
248+ devm_clk_hw_register_clkdev()
248249
249250 DMA
250251 dmaenginem_async_device_register()
drivers/clk/clkdev.c+88−23
@@ -401,6 +401,23 @@ static struct clk_lookup *__clk_register_clkdev(struct clk_hw *hw, · 400 unmodified lines
401401 return cl;
402402 }
403403
404+static int do_clk_register_clkdev(struct clk_hw *hw,
405+ struct clk_lookup **cl, const char *con_id, const char *dev_id)
406+{
407+ if (IS_ERR(hw))
408+ return PTR_ERR(hw);
409+ /*
410+ * Since dev_id can be NULL, and NULL is handled specially, we must
411+ * pass it as either a NULL format string, or with "%s".
412+ */
413+ if (dev_id)
414+ *cl = __clk_register_clkdev(hw, con_id, "%s", dev_id);
415+ else
416+ *cl = __clk_register_clkdev(hw, con_id, NULL);
417+
418+ return *cl ? 0 : -ENOMEM;
419+}
420+
404421 /**
405422 * clk_register_clkdev - register one clock lookup for a struct clk
406423 * @clk: struct clk to associate with all clk_lookups
@@ -423,17 +440,8 @@ int clk_register_clkdev(struct clk *clk, const char *con_id, · 16 unmodified lines
423440 if (IS_ERR(clk))
424441 return PTR_ERR(clk);
425442
426− /*
427− * Since dev_id can be NULL, and NULL is handled specially, we must
428− * pass it as either a NULL format string, or with "%s".
429− */
430− if (dev_id)
431− cl = __clk_register_clkdev(__clk_get_hw(clk), con_id, "%s",
432− dev_id);
433− else
434− cl = __clk_register_clkdev(__clk_get_hw(clk), con_id, NULL);
435−
436− return cl ? 0 : -ENOMEM;
443+ return do_clk_register_clkdev(__clk_get_hw(clk), &cl, con_id,
444+ dev_id);
437445 }
438446 EXPORT_SYMBOL(clk_register_clkdev);
439447
@@ -456,18 +464,75 @@ int clk_hw_register_clkdev(struct clk_hw *hw, const char *con_id, · 16 unmodified lines
456464 {
457465 struct clk_lookup *cl;
458466
459− if (IS_ERR(hw))
460− return PTR_ERR(hw);
467+ return do_clk_register_clkdev(hw, &cl, con_id, dev_id);
468+}
469+EXPORT_SYMBOL(clk_hw_register_clkdev);
461470
462− /*
463− * Since dev_id can be NULL, and NULL is handled specially, we must
464− * pass it as either a NULL format string, or with "%s".
465− */
466− if (dev_id)
467− cl = __clk_register_clkdev(hw, con_id, "%s", dev_id);
468− else
469− cl = __clk_register_clkdev(hw, con_id, NULL);
471+static void devm_clkdev_release(struct device *dev, void *res)
472+{
473+ clkdev_drop(*(struct clk_lookup **)res);
474+}
470475
471− return cl ? 0 : -ENOMEM;
476+static int devm_clk_match_clkdev(struct device *dev, void *res, void *data)
477+{
478+ struct clk_lookup **l = res;
479+
480+ return *l == data;
472481 }
473−EXPORT_SYMBOL(clk_hw_register_clkdev);
482+
483+/**
484+ * devm_clk_release_clkdev - Resource managed clkdev lookup release
485+ * @dev: device this lookup is bound
486+ * @con_id: connection ID string on device
487+ * @dev_id: format string describing device name
488+ *
489+ * Drop the clkdev lookup created with devm_clk_hw_register_clkdev.
490+ * Normally this function will not need to be called and the resource
491+ * management code will ensure that the resource is freed.
492+ */
493+void devm_clk_release_clkdev(struct device *dev, const char *con_id,
494+ const char *dev_id)
495+{
496+ struct clk_lookup *cl;
497+ int rval;
498+
499+ cl = clk_find(dev_id, con_id);
500+ WARN_ON(!cl);
501+ rval = devres_release(dev, devm_clkdev_release,
502+ devm_clk_match_clkdev, cl);
503+ WARN_ON(rval);
504+}
505+EXPORT_SYMBOL(devm_clk_release_clkdev);
506+
507+/**
508+ * devm_clk_hw_register_clkdev - managed clk lookup registration for clk_hw
509+ * @dev: device this lookup is bound
510+ * @hw: struct clk_hw to associate with all clk_lookups
511+ * @con_id: connection ID string on device
512+ * @dev_id: format string describing device name
513+ *
514+ * con_id or dev_id may be NULL as a wildcard, just as in the rest of
515+ * clkdev.
516+ *
517+ * To make things easier for mass registration, we detect error clk_hws
518+ * from a previous clk_hw_register_*() call, and return the error code for
519+ * those. This is to permit this function to be called immediately
520+ * after clk_hw_register_*().
521+ */
522+int devm_clk_hw_register_clkdev(struct device *dev, struct clk_hw *hw,
523+ const char *con_id, const char *dev_id)
524+{
525+ int rval = -ENOMEM;
526+ struct clk_lookup **cl;
527+
528+ cl = devres_alloc(devm_clkdev_release, sizeof(*cl), GFP_KERNEL);
529+ if (cl) {
530+ rval = do_clk_register_clkdev(hw, cl, con_id, dev_id);
531+ if (!rval)
532+ devres_add(dev, cl);
533+ else
534+ devres_free(cl);
535+ }
536+ return rval;
537+}
538+EXPORT_SYMBOL(devm_clk_hw_register_clkdev);
include/linux/clkdev.h+4−0
@@ -52,4 +52,8 @@ int clk_add_alias(const char *, const char *, const char *, struct device *); · 51 unmodified lines
5252 int clk_register_clkdev(struct clk *, const char *, const char *);
5353 int clk_hw_register_clkdev(struct clk_hw *, const char *, const char *);
5454
55+int devm_clk_hw_register_clkdev(struct device *dev, struct clk_hw *hw,
56+ const char *con_id, const char *dev_id);
57+void devm_clk_release_clkdev(struct device *dev, const char *con_id,
58+ const char *dev_id);
5559 #endif

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t