summaryrefslogtreecommitdiffstats
path: root/Documentation/hwmon/hwmon-kernel-api.txt
Commit message (Collapse)AuthorAgeFilesLines
* docs: hwmon: Add an index file and rename docs to *.rstMauro Carvalho Chehab2019-04-171-386/+0Star
| | | | | | | | Now that all files were converted to ReST format, rename them and add an index. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* docs: hwmon: convert remaining files to ReST formatMauro Carvalho Chehab2019-04-171-157/+189
| | | | | | | | Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: Documentation: Add usage example for HWMON_CHANNEL_INFOGuenter Roeck2019-04-161-0/+13
| | | | | | | | The new HWMON_CHANNEL_INFO macro simplifies the code, reduces the likelihood of errors, and makes the code easier to read. Add a usage example to help driver writers to actually use it. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: Introduce SENSOR_DEVICE_ATTR_{RO, RW, WO} and variantsGuenter Roeck2018-12-171-8/+16
| | | | | | | | | Introduce SENSOR_DEVICE_ATTR_{RO,RW,WO} and SENSOR_DEVICE_ATTR_2_{RO,RW,WO} as simplified variants of SENSOR_DEVICE_ATTR and SENSOR_DEVICE_ATTR_2 to simplify the source code, improve readbility, and reduce the chance of inconsistencies. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: (core) check parent dev != NULL when chip != NULLLucas Magasweran2018-05-211-1/+2
| | | | | | | | | | hwmon_device_register_with_info() registration API requires a non-NULL parent device when chip is non-NULL. This commit adds a check and documents this requirement. Signed-off-by: Lucas Magasweran <lucas.magasweran@ieee.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: Update documentation to clarify rules for the 'name' attributeGuenter Roeck2017-01-251-0/+4
| | | | | | | | | Clarify that the name attribute must report a valid name, and the rules for valid names. Also clarify that the name parameter must be provided for all supported API functions. Reviewed-by: Jean Delvare <jdelvare@suse.de> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: (core) Rename groups parameter in API to extra_groupsGuenter Roeck2016-12-101-11/+11
| | | | | | | | | The 'groups' parameter of hwmon_device_register_with_info() and devm_hwmon_device_register_with_info() is only necessary if extra non-standard attributes need to be provided. Rename the parameter to extra_groups and clarify the documentation. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: (core) Deprecate hwmon_device_register()Guenter Roeck2016-12-101-20/+14Star
| | | | | | | | | | | Inform the user that hwmon_device_register() is deprecated, and suggest conversion to the newest API. Also remove hwmon_device_register() from the kernel API documentation. Note that hwmon_device_register() is not marked as __deprecated() since doing so might result in build errors. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: (core) Clarify use of chip attributesGuenter Roeck2016-12-101-1/+1
| | | | | | | | | | | | Describing chip attributes as "attributes which apply to the entire chip" is confusing. Rephrase to "attributes which are not bound to a specific input or output". Also rename hwmon_chip_attr_templates[] to hwmon_chip_attrs[] to indicate that the respective strings strings are not templates but actual attribute names. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: (core) Add basic pwm attribute support to new APIGuenter Roeck2016-09-091-0/+2
| | | | | | | Add basic pwm attribute support (no auto attributes) to new API. Reviewed-by: Jonathan Cameron <jic23@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: (core) Document new kernel APIGuenter Roeck2016-09-091-2/+227
| | | | | | | | | Describe the new registration API function as well as the data structures it requires. Acked-by: Punit Agrawal <punit.agrawal@arm.com> Reviewed-by: Jonathan Cameron <jic23@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: Document hwmon kernel APIGuenter Roeck2014-05-221-0/+107
The hwmon subsystem has been around for a while. Time to document its kernel API. Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>