device property: add description of fwnode cases
authorBard Liao <yung-chuan.liao@linux.intel.com>
Tue, 5 Jan 2021 09:11:46 +0000 (17:11 +0800)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Thu, 7 Jan 2021 16:55:55 +0000 (17:55 +0100)
commit3f7bddaf5d5a83aa2eb1e6d72db221d3ec43c813
treeafe9a44d1665d343d22ea26da000d4ca3da6a52f
parent47f4469970d8861bc06d2d4d45ac8200ff07c693
device property: add description of fwnode cases

There are only four valid fwnode cases which are
- primary --> secondary --> -ENODEV
- primary --> NULL
- secondary --> -ENODEV
- NULL

dev->fwnode should be converted between the 4 cases above no matter
how/when set_primary_fwnode() and set_secondary_fwnode() are called.
Describe it in the code so people will keep it in mind.

Signed-off-by: Bard Liao <yung-chuan.liao@linux.intel.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>
[ rjw: Comment edit ]
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
drivers/base/core.c