Commit f680b284 authored by Guenter Roeck's avatar Guenter Roeck

hwmon: (core) Clarify when read and write callbacks are mandatory

The callback descrption in hwmon.h was misleading and stated that read and
write callbacks would be optional. More accurate is is that the callbacks
are mandatory if readable / writeable attributes are present.
Signed-off-by: default avatarGuenter Roeck <linux@roeck-us.net>
parent a2a0c3c5
...@@ -298,8 +298,7 @@ enum hwmon_pwm_attributes { ...@@ -298,8 +298,7 @@ enum hwmon_pwm_attributes {
* Channel number * Channel number
* The function returns the file permissions. * The function returns the file permissions.
* If the return value is 0, no attribute will be created. * If the return value is 0, no attribute will be created.
* @read: Read callback. Optional. If not provided, attributes * @read: Read callback. Mandatory if readable attributes are present.
* will not be readable.
* Parameters are: * Parameters are:
* @dev: Pointer to hardware monitoring device * @dev: Pointer to hardware monitoring device
* @type: Sensor type * @type: Sensor type
...@@ -308,8 +307,7 @@ enum hwmon_pwm_attributes { ...@@ -308,8 +307,7 @@ enum hwmon_pwm_attributes {
* Channel number * Channel number
* @val: Pointer to returned value * @val: Pointer to returned value
* The function returns 0 on success or a negative error number. * The function returns 0 on success or a negative error number.
* @write: Write callback. Optional. If not provided, attributes * @write: Write callback. Mandatory if writeable attributes are present.
* will not be writable.
* Parameters are: * Parameters are:
* @dev: Pointer to hardware monitoring device * @dev: Pointer to hardware monitoring device
* @type: Sensor type * @type: Sensor type
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment