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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
/*
* Copyright (c) 2006-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.
*
*/
/**
* @file
* <b>NVIDIA Tegra ODM Kit:
* Vibrate Interface</b>
*
* @b Description: Defines the ODM interface for Vibrate devices.
*
*/
#include "nvodm_vibrate.h"
#include "nvos.h"
#include "nvassert.h"
#include "nvodm_services.h"
#include "nvodm_query_discovery.h"
#include "nvodm_pmu.h"
#define VIBRATE_DEVICE_GUID NV_ODM_GUID('v','i','b','r','a','t','o','r')
/**
* @brief Used to enable/disable debug print messages.
*/
#define NV_ODM_DEBUG 0
#if NV_ODM_DEBUG
#define NV_ODM_TRACE NvOdmOsDebugPrintf
#else
#define NV_ODM_TRACE (void)
#endif
typedef struct NvOdmVibDeviceRec
{
/* The handle to the Pmu device */
NvOdmServicesPmuHandle hOdmServicePmuDevice;
/*Pmu Vdd Rail capabilities*/
NvOdmServicesPmuVddRailCapabilities RailCaps;
/* Pmu Rail ID*/
NvU32 VddId;
} NvOdmVibDevice;
/**
* @brief Allocates a handle to the device. Configures the PWM
* control to the Vibro motor with default values. To change
* the amplitude and frequency use NvOdmVibrateSetParameter API.
* @param hOdmVibrate [IN] Opaque handle to the device.
* @return NV_TRUE on success and NV_FALSE on error
*/
NvBool
NvOdmVibOpen(NvOdmVibDeviceHandle *hOdmVibrate)
{
const NvOdmPeripheralConnectivity *pConnectivity = NULL;
NvU32 Index = 0;
NV_ASSERT(hOdmVibrate);
/* Allocate the handle */
(*hOdmVibrate) = (NvOdmVibDeviceHandle)NvOdmOsAlloc(sizeof(NvOdmVibDevice));
if (*hOdmVibrate == NULL)
{
NV_ODM_TRACE(("Error Allocating NvOdmPmuDevice. \n"));
return NV_FALSE;
}
NvOsMemset((*hOdmVibrate), 0, sizeof(NvOdmVibDevice));
/* Get the PMU handle */
(*hOdmVibrate)->hOdmServicePmuDevice = NvOdmServicesPmuOpen();
if (!(*hOdmVibrate)->hOdmServicePmuDevice)
{
NV_ODM_TRACE(("Error Opening Pmu device. \n"));
NvOdmOsFree(*hOdmVibrate);
*hOdmVibrate = NULL;
return NV_FALSE;
}
// Get the peripheral connectivity information
pConnectivity = NvOdmPeripheralGetGuid(VIBRATE_DEVICE_GUID);
if (pConnectivity == NULL)
return NV_FALSE;
// Search for the Vdd rail and set the proper volage to the rail.
for (Index = 0; Index < pConnectivity->NumAddress; ++Index)
{
if (pConnectivity->AddressList[Index].Interface == NvOdmIoModule_Vdd)
{
(*hOdmVibrate)->VddId = pConnectivity->AddressList[Index].Address;
NvOdmServicesPmuGetCapabilities((*hOdmVibrate)->hOdmServicePmuDevice, (*hOdmVibrate)->VddId, &((*hOdmVibrate)->RailCaps));
break;
}
}
return NV_TRUE;
}
/**
* @brief Closes the ODM device and destroys all allocated resources.
* @param hOdmVibrate [IN] Opaque handle to the device.
* @return None.
*/
void NvOdmVibClose(NvOdmVibDeviceHandle hOdmVibrate)
{
if (hOdmVibrate != NULL)
{
NvOdmServicesPmuClose(hOdmVibrate->hOdmServicePmuDevice);
hOdmVibrate->hOdmServicePmuDevice = NULL;
hOdmVibrate->VddId = 0;
NvOsMemset(&hOdmVibrate->RailCaps, 0, sizeof(NvOdmServicesPmuVddRailCapabilities));
NvOdmOsFree(hOdmVibrate);
hOdmVibrate = NULL;
}
}
/**
* @brief Gets capabilities of the Vibrate device.
* @param hOdmVibrate [IN] Opaque handle to the device.
* @param RequestedCaps [IN] Specifies the capability to get.
* @param pCapsValue [OUT] A pointer to the returned value.
* @return NV_TRUE on success and NV_FALSE on error
*/
NvBool
NvOdmVibGetCaps(
NvOdmVibDeviceHandle hOdmVibrate,
NvOdmVibCaps RequestedCaps,
NvU32 *pCapsValue)
{
NV_ASSERT(hOdmVibrate);
NV_ASSERT(pCapsValue);
if (!hOdmVibrate || !pCapsValue)
{
return NV_FALSE;
}
return NV_TRUE;
}
/**
* @brief The frequency to the Vibro motor can be set
* using this function. A frequency less than zero will be
* clamped to zero and a frequency value beyond the max supported value
* will be clamped to the max supported value.
* @param hOdmVibrate [IN] Opaque handle to the device.
* @param Freq [IN] Frequency in Hz
* @return NV_TRUE on success and NV_FALSE on error
*/
NvBool
NvOdmVibSetFrequency(NvOdmVibDeviceHandle hOdmVibrate, NvS32 Freq)
{
//AP20 Vibrator does'nt support setting Frequency
return NV_TRUE;
}
/**
* @brief The dutycycle of the PWM driving the Vibro motor can be set
* using this function. A dutycycle less than zero will be
* clamped to zero and value beyond the max supported value
* will be clamped to the max supported value.
* @param hOdmVibrate [IN] Opaque handle to the device.
* @param DCycle [IN] Duty Cycle value in percentage (0%-100%)
* @return NV_TRUE on success and NV_FALSE on error
*/
NvBool
NvOdmVibSetDutyCycle(NvOdmVibDeviceHandle hOdmVibrate, NvS32 DCycle)
{
//AP20 Vibrator does'nt support setting DutyCycle
return NV_TRUE;
}
/**
* @brief Starts the Vibro with the frequency and duty-cycle set using the
* Set API.
* @param hOdmVibrate [IN] Opaque handle to the device.
* @return NV_TRUE on success and NV_FALSE on error
*/
NvBool
NvOdmVibStart(NvOdmVibDeviceHandle hOdmVibrate)
{
NvU32 SettlingTime = 0;
NV_ASSERT(hOdmVibrate);
if (!hOdmVibrate)
{
return NV_FALSE;
}
if (hOdmVibrate->hOdmServicePmuDevice != NULL)
{
// Search for the Vdd rail and power Off the module
if (hOdmVibrate->VddId)
{
NvOdmServicesPmuSetVoltage(hOdmVibrate->hOdmServicePmuDevice,
hOdmVibrate->VddId, hOdmVibrate->RailCaps.requestMilliVolts, &SettlingTime);
if (SettlingTime)
NvOdmOsWaitUS(SettlingTime);
}
}
return NV_TRUE;
}
/**
* @brief Stops the Vibro motor
* @param hOdmVibrate [IN] Opaque handle to the device.
* @return NV_TRUE on success and NV_FALSE on error
*/
NvBool
NvOdmVibStop(NvOdmVibDeviceHandle hOdmVibrate)
{
NvU32 SettlingTime;
NV_ASSERT(hOdmVibrate);
if (!hOdmVibrate)
{
return NV_FALSE;
}
if (hOdmVibrate->hOdmServicePmuDevice != NULL)
{
// Search for the Vdd rail and power Off the module
if (hOdmVibrate->VddId)
{
NvOdmServicesPmuSetVoltage(hOdmVibrate->hOdmServicePmuDevice,
hOdmVibrate->VddId, NVODM_VOLTAGE_OFF, &SettlingTime);
if (SettlingTime)
NvOdmOsWaitUS(SettlingTime);
}
}
return NV_TRUE;
}
|
