summaryrefslogtreecommitdiff
path: root/arch/arm/mach-tegra/odm_kit/adaptations/tmon/adt7461/nvodm_tmon_adt7461.h
blob: ffe4bf15dbec5412a20ddd30199d07f01539d0fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/*
 * Copyright (c) 2009 NVIDIA Corporation.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * Neither the name of the NVIDIA Corporation nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */
 
#ifndef INCLUDED_NVODM_TMON_ADT7461_H
#define INCLUDED_NVODM_TMON_ADT7461_H

#include "nvodm_tmon.h"
#include "nvodm_tmon_adt7461_reg.h"
#include "nvodm_tmon_adt7461_channel.h"

#if defined(__cplusplus)
extern "C"
{
#endif

typedef struct ADT7461RegisterInfoRec
{
    NvU8 RdAddr;            // Invalid if WO
    NvU8 WrAddr;            // Invalid if RO
} ADT7461RegisterInfo;

typedef struct ADT7461ChannelOdmPolicyRec
{
    NvBool RateOdmProtected;
    NvBool IntrLimitsOdmProtected;
    NvBool HwLimitCritOdmProtected;
} ADT7461ChannelOdmPolicy;

typedef struct ADT7461ChannelInfoRec
{
    // TMON device conversion channel ID
    ADT7461ChannelID  ChannelId;

    // ODM channel policy
    ADT7461ChannelOdmPolicy ChannelPolicy;

    // Alert Interrupt limits registers
    ADT7461RegisterInfo IntrLimitHigh;
    ADT7461RegisterInfo IntrLimitLow;

    // Thermal comparator limit register
    ADT7461RegisterInfo ComparatorLimit;

    // Temperature measurement offset
    ADT7461RegisterInfo Toffset;

    // Temperature Data register
    ADT7461RegisterInfo Tdata;
} ADT7461ChannelInfo;

typedef struct ADT7461InfoRec
{
    // TMON device conversion channels
    ADT7461ChannelInfo  Channels[ADT7461ChannelID_Num];

    // Chip status register
    ADT7461RegisterInfo Status;

    // Common configration controls
    ADT7461RegisterInfo Config;

    // Common conversion rate
    ADT7461RegisterInfo Rate;

    // One-shot trigger register
    ADT7461RegisterInfo OneShot;

    // Common comparator hysteresis 
    ADT7461RegisterInfo ComparatorHysteresis;

    // Number of consecutive limit violation before
    // interrupt is generated
    ADT7461RegisterInfo IntrCntDelay;
} ADT7461Info;

typedef struct ADT7461PrivDataRec
{
    // ADT7461 device registers descriptors
    const ADT7461Info* pDeviceInfo;

    // ADT7461 I2C device Address
    NvU32 DeviceI2cAddr;

    // The handle to the I2C controller
    NvOdmServicesI2cHandle hOdmI2C;

    // The odm pmu service handle
    NvOdmServicesPmuHandle hOdmPmuSevice;

    // Zone => Channel map
    ADT7461ChannelID ConnectivityMap[NvOdmTmonZoneID_Num];

    // ADR7461 run mode reference count 
    NvU32 RunRefCount;

    // Shadow of ADT7461 internal configuration register
    NvU8 ShadowConfig;

    // Shadow of ADT7461 internal rate settings
    NvU8 ShadowRate;

    // Shadow of ADT7461 internal address pointer
    NvU8 ShadowRegPtr;

    // The odm GPIO service handle
    NvOdmServicesGpioHandle hGpio;

    // SoC GPIO dedicated for ADT7461 out of limit interrupt
    NvOdmGpioPinHandle hGpioPin;

    // The ADT7461 interrupt handle
    NvOdmServicesGpioIntrHandle hGpioIntr;

    // The ADT7461 interrupt callback
    NvOdmInterruptHandler Callback;

    // The ADT7461 interrupt callback context
    void* CallbackArg;
} ADT7461PrivData;

NvBool Adt7461Init(NvOdmTmonDeviceHandle hTmon);
void Adt7461Deinit(NvOdmTmonDeviceHandle hTmon);
NvBool Adt7461Run(NvOdmTmonDeviceHandle hTmon, NvOdmTmonZoneID ZoneId);
NvBool Adt7461Stop(NvOdmTmonDeviceHandle hTmon, NvOdmTmonZoneID ZoneId);

NvBool 
Adt7461TemperatureGet(
    NvOdmTmonDeviceHandle hTmon,
    NvOdmTmonZoneID ZoneId,
    NvS32* pDegreesC);

void 
Adt7461CapabilitiesGet(
    NvOdmTmonDeviceHandle hTmon,
    NvOdmTmonZoneID ZoneId,
    NvOdmTmonCapabilities* pCaps);

void
Adt7461ParameterCapsGet(
    NvOdmTmonDeviceHandle hTmon,
    NvOdmTmonZoneID ZoneId,
    NvOdmTmonConfigParam ParamId,
    NvOdmTmonParameterCaps* pCaps);

NvBool
Adt7461ParameterConfig(
    NvOdmTmonDeviceHandle hTmon,
    NvOdmTmonZoneID ZoneId,
    NvOdmTmonConfigParam ParamId,
    NvS32* pSetting);

NvOdmTmonIntrHandle
Adt7461IntrRegister(
    NvOdmTmonDeviceHandle hTmon,
    NvOdmTmonZoneID ZoneId,
    NvOdmInterruptHandler Callback,
    void* arg);

void
Adt7461IntrUnregister(
    NvOdmTmonDeviceHandle hTmon,
    NvOdmTmonZoneID ZoneId,
    NvOdmTmonIntrHandle hIntr);

#if defined(__cplusplus)
}
#endif

#endif //INCLUDED_NVODM_TMON_ADT7461_H