doc: fix broken references
[linux-2.6.git] / include / linux / platform_data / ntc_thermistor.h
1 /*
2  * ntc_thermistor.h - NTC Thermistors
3  *
4  *  Copyright (C) 2010 Samsung Electronics
5  *  MyungJoo Ham <myungjoo.ham@samsung.com>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21 #ifndef _LINUX_NTC_H
22 #define _LINUX_NTC_H
23
24 enum ntc_thermistor_type {
25         TYPE_NCPXXWB473,
26         TYPE_NCPXXWL333,
27 };
28
29 struct ntc_thermistor_platform_data {
30         /*
31          * One (not both) of read_uV and read_ohm should be provided and only
32          * one of the two should be provided.
33          * Both functions should return negative value for an error case.
34          *
35          * pullup_uV, pullup_ohm, pulldown_ohm, and connect are required to use
36          * read_uV()
37          *
38          * How to setup pullup_ohm, pulldown_ohm, and connect is
39          * described at Documentation/hwmon/ntc_thermistor
40          *
41          * pullup/down_ohm: 0 for infinite / not-connected
42          */
43         int (*read_uV)(void);
44         unsigned int pullup_uV;
45
46         unsigned int pullup_ohm;
47         unsigned int pulldown_ohm;
48         enum { NTC_CONNECTED_POSITIVE, NTC_CONNECTED_GROUND } connect;
49
50         int (*read_ohm)(void);
51 };
52
53 #endif /* _LINUX_NTC_H */