gpiolib: Add comments explaining the _cansleep() WARN_ON()s
authorMark Brown <broonie@opensource.wolfsonmicro.com>
Fri, 17 Feb 2012 18:46:00 +0000 (10:46 -0800)
committerGrant Likely <grant.likely@secretlab.ca>
Mon, 5 Mar 2012 15:05:08 +0000 (08:05 -0700)
commite4e449e82871c53ef3b22bd3a50fceabc0638926
tree87e14ac729928d7e1c54e7a975b365714c50bf85
parent25553ff0756c59b617af6bdd280c94e943164184
gpiolib: Add comments explaining the _cansleep() WARN_ON()s

I've seen users getting very confused by the WARN_ON()s for can_sleep
GPIOs in the atomic-safe paths, the discoverability of the non-atomic
version of the API seems to be hampered by the fact that it's defined
in a header file not the .c file where the warnings are.

Add a couple of comments next to the warnings to help people on their
way.

Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Reviwed-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Grant Likely <grant.likely@secretlab.ca>
drivers/gpio/gpiolib.c