Commit 99a0378d authored by Vivien Didelot's avatar Vivien Didelot Committed by Guenter Roeck

hwmon: (sht15) general code clean-up

* Add a documentation file for the device.
* Respect a bit more the kernel-doc syntax.
* Rename some variables for clarity.
* Use bool type for flags.
* Use an enum for states (actions being done).
Signed-off-by: default avatarVivien Didelot <vivien.didelot@savoirfairelinux.com>
Acked-by: default avatarJonathan Cameron <jic23@cam.ac.uk>
Signed-off-by: default avatarGuenter Roeck <guenter.roeck@ericsson.com>
parent 83bffbce
Kernel driver sht15
===================
Authors:
* Wouter Horre
* Jonathan Cameron
Supported chips:
* Sensirion SHT10
Prefix: 'sht10'
* Sensirion SHT11
Prefix: 'sht11'
* Sensirion SHT15
Prefix: 'sht15'
* Sensirion SHT71
Prefix: 'sht71'
* Sensirion SHT75
Prefix: 'sht75'
Datasheet: Publicly available at the Sensirion website
http://www.sensirion.ch/en/pdf/product_information/Datasheet-humidity-sensor-SHT1x.pdf
Description
-----------
The SHT10, SHT11, SHT15, SHT71, and SHT75 are humidity and temperature
sensors.
The devices communicate using two GPIO lines and use the default
resolution settings of 14 bits for temperature and 12 bits for humidity.
Note: The regulator supply name is set to "vcc".
Sysfs interface
---------------
* temp1_input: temperature input
* humidity1_input: humidity input
This diff is collapsed.
...@@ -8,14 +8,18 @@ ...@@ -8,14 +8,18 @@
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as * it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation. * published by the Free Software Foundation.
*
* For further information, see the Documentation/hwmon/sht15 file.
*/ */
/** /**
* struct sht15_platform_data - sht15 connectivity info * struct sht15_platform_data - sht15 connectivity info
* @gpio_data: no. of gpio to which bidirectional data line is connected * @gpio_data: no. of gpio to which bidirectional data line is
* @gpio_sck: no. of gpio to which the data clock is connected. * connected.
* @supply_mv: supply voltage in mv. Overridden by regulator if available. * @gpio_sck: no. of gpio to which the data clock is connected.
**/ * @supply_mv: supply voltage in mv. Overridden by regulator if
* available.
*/
struct sht15_platform_data { struct sht15_platform_data {
int gpio_data; int gpio_data;
int gpio_sck; int gpio_sck;
......
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