aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/src/hal_qei.c
blob: eb6223e0ffad956cca759d003b25363279b82be4 (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
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
/*
    ChibiOS - Copyright (C) 2006..2016 Martino Migliavacca

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

/**
 * @file    hal_qei.c
 * @brief   QEI Driver code.
 *
 * @addtogroup QEI
 * @{
 */

#include "hal.h"

#if (HAL_USE_QEI == TRUE) || defined(__DOXYGEN__)

/*===========================================================================*/
/* Driver local definitions.                                                 */
/*===========================================================================*/

/*===========================================================================*/
/* Driver exported variables.                                                */
/*===========================================================================*/

/*===========================================================================*/
/* Driver local variables and types.                                         */
/*===========================================================================*/

/*===========================================================================*/
/* Driver local functions.                                                   */
/*===========================================================================*/

/**
 * @brief   Helper for correclty handling overflow/underflow
 *
 * @details Underflow/overflow will be handled according to mode:
 *          QEI_OVERFLOW_WRAP:    counter value will wrap around.
 *          QEI_OVERFLOW_DISCARD: counter will not change
 *          QEI_OVERFLOW_MINMAX:  counter will be updated upto min or max.
 *
 * @note    This function is for use by low level driver.
 *
 * @param[in,out] count counter value
 * @param[in,out] delta adjustment value
 * @param[in]     min   minimum allowed value for counter
 * @param[in]     max   maximum allowed value for counter
 * @param[in]     mode  how to handle overflow
 *
 * @return        true if counter underflow/overflow occured or
 *                was due to occur
 *
 */
static inline
bool qei_adjust_count(qeicnt_t *count, qeidelta_t *delta,
		      qeicnt_t min, qeicnt_t max, qeioverflow_t mode) {
  /* For information on signed integer overflow see:
   * https://www.securecoding.cert.org/confluence/x/RgE
   */

  /* Get values */
  const qeicnt_t   _count = *count;
  const qeidelta_t _delta = *delta;

  /* Overflow operation
   */
  if ((_delta > 0) && (_count > (max - _delta))) {
    switch(mode) {
    case QEI_OVERFLOW_WRAP:
      *delta = 0;
      *count = (min + (_count - (max - _delta))) - 1;
      break;
#if QEI_USE_OVERFLOW_DISCARD == TRUE
    case QEI_OVERFLOW_DISCARD:
      *delta = _delta;
      *count = _count;
      break;
#endif
#if QEI_USE_OVERFLOW_MINMAX == TRUE
    case QEI_OVERFLOW_MINMAX:
      *delta = _count - (max - _delta);
      *count = max;
      break;
#endif
    }
    return true;
    
 /* Underflow operation
  */
  } else if ((_delta < 0) && (_count < (min - _delta))) {
    switch(mode) {
    case QEI_OVERFLOW_WRAP:
      *delta = 0;
      *count = (max + (_count - (min - _delta))) + 1;
    break;
#if QEI_USE_OVERFLOW_DISCARD == TRUE
    case QEI_OVERFLOW_DISCARD:
      *delta = _delta;
      *count = _count;
      break;
#endif
#if QEI_USE_OVERFLOW_MINMAX == TRUE
    case QEI_OVERFLOW_MINMAX:
      *delta = _count - (min - _delta);
      *count = min;
      break;
#endif
    }
    return true;

  /* Normal operation
   */
  } else {
    *delta = 0;
    *count = _count + _delta;
    return false;
  }
}

/*===========================================================================*/
/* Driver exported functions.                                                */
/*===========================================================================*/

/**
 * @brief   QEI Driver initialization.
 * @note    This function is implicitly invoked by @p halInit(), there is
 *          no need to explicitly initialize the driver.
 *
 * @init
 */
void qeiInit(void) {

  qei_lld_init();
}

/**
 * @brief   Initializes the standard part of a @p QEIDriver structure.
 *
 * @param[out] qeip     pointer to the @p QEIDriver object
 *
 * @init
 */
void qeiObjectInit(QEIDriver *qeip) {

  qeip->state = QEI_STOP;
  qeip->last = 0;
  qeip->config = NULL;
}

/**
 * @brief   Configures and activates the QEI peripheral.
 *
 * @param[in] qeip      pointer to the @p QEIDriver object
 * @param[in] config    pointer to the @p QEIConfig object
 *
 * @api
 */
void qeiStart(QEIDriver *qeip, const QEIConfig *config) {

  osalDbgCheck((qeip != NULL) && (config != NULL));

  osalSysLock();
  osalDbgAssert((qeip->state == QEI_STOP) || (qeip->state == QEI_READY),
                "invalid state");
  qeip->config = config;
  qei_lld_start(qeip);
  qeip->state = QEI_READY;
  osalSysUnlock();
}

/**
 * @brief   Deactivates the QEI peripheral.
 *
 * @param[in] qeip      pointer to the @p QEIDriver object
 *
 * @api
 */
void qeiStop(QEIDriver *qeip) {

  osalDbgCheck(qeip != NULL);

  osalSysLock();
  osalDbgAssert((qeip->state == QEI_STOP) || (qeip->state == QEI_READY),
                "invalid state");
  qei_lld_stop(qeip);
  qeip->state = QEI_STOP;
  osalSysUnlock();
}

/**
 * @brief   Enables the quadrature encoder interface.
 *
 * @param[in] qeip      pointer to the @p QEIDriver object
 *
 * @api
 */
void qeiEnable(QEIDriver *qeip) {

  osalDbgCheck(qeip != NULL);

  osalSysLock();
  osalDbgAssert(qeip->state == QEI_READY, "invalid state");
  qei_lld_enable(qeip);
  qeip->state = QEI_ACTIVE;
  osalSysUnlock();
}

/**
 * @brief   Disables the quadrature encoder interface.
 *
 * @param[in] qeip      pointer to the @p QEIDriver object
 *
 * @api
 */
void qeiDisable(QEIDriver *qeip) {

  osalDbgCheck(qeip != NULL);

  osalSysLock();
  osalDbgAssert((qeip->state == QEI_READY) || (qeip->state == QEI_ACTIVE),
                "invalid state");
  qei_lld_disable(qeip);
  qeip->state = QEI_READY;
  osalSysUnlock();
}

/**
 * @brief   Returns the counter value.
 *
 * @param[in] qeip      pointer to the @p QEIDriver object
 * @return              The current counter value.
 *
 * @api
 */
qeicnt_t qeiGetCount(QEIDriver *qeip) {
  qeicnt_t cnt;

  osalSysLock();
  cnt = qeiGetCountI(qeip);
  osalSysUnlock();

  return cnt;
}

/**
 * @brief   Set counter value.
 *
 * @param[in] qeip      pointer to the @p QEIDriver object.
 * @param[in] value     the new counter value.
 *
 * @api
 */
void qeiSetCount(QEIDriver *qeip, qeicnt_t value) {
  osalDbgCheck(qeip != NULL);
  osalDbgAssert((qeip->state == QEI_READY) || (qeip->state == QEI_ACTIVE),
		"invalid state");

  osalSysLock();
  qei_lld_set_count(qeip, value);
  osalSysUnlock();
}

/**
 * @brief   Adjust the counter by delta.
 *
 * @param[in] qeip      pointer to the @p QEIDriver object.
 * @param[in] delta     the adjustement value.
 * @return              the remaining delta (can occur during overflow).
 *
 * @api
 */
qeidelta_t qeiAdjust(QEIDriver *qeip, qeidelta_t delta) {
  osalDbgCheck(qeip != NULL);
  osalDbgAssert((qeip->state == QEI_ACTIVE), "invalid state");

  osalSysLock();
  delta = qeiAdjustI(qeip, delta);
  osalSysUnlock();

  return delta;
}

/**
 * @brief   Adjust the counter by delta.
 *
 * @param[in] qeip      pointer to the @p QEIDriver object.
 * @param[in] delta     the adjustement value.
 * @return              the remaining delta (can occur during overflow).
 *
 * @api
 */
qeidelta_t qeiAdjustI(QEIDriver *qeip, qeidelta_t delta) {
  /* Get boundaries */
  qeicnt_t min = QEI_COUNT_MIN;
  qeicnt_t max = QEI_COUNT_MAX;
  if (qeip->config->min != qeip->config->max) {
    min = qeip->config->min;
    max = qeip->config->max;
  }

  /* Get counter */
  qeicnt_t count = qei_lld_get_count(qeip);
  
  /* Adjust counter value */
  bool overflowed = qei_adjust_count(&count, &delta,
				     min, max, qeip->config->overflow);

  /* Notify for value change */
  qei_lld_set_count(qeip, count);

  /* Notify for overflow (passing the remaining delta) */
  if (overflowed && qeip->config->overflow_cb)
    qeip->config->overflow_cb(qeip, delta);

  /* Remaining delta */
  return delta;
}


/**
 * @brief   Returns the counter delta from last reading.
 *
 * @param[in] qeip      pointer to the @p QEIDriver object
 * @return              The delta from last read.
 *
 * @api
 */
qeidelta_t qeiUpdate(QEIDriver *qeip) {
  qeidelta_t diff;

  osalSysLock();
  diff = qeiUpdateI(qeip);
  osalSysUnlock();

  return diff;
}

/**
 * @brief   Returns the counter delta from last reading.
 *
 * @param[in] qeip      pointer to the @p QEIDriver object
 * @return              The delta from last read.
 *
 * @iclass
 */
qeidelta_t qeiUpdateI(QEIDriver *qeip) {
  qeicnt_t cnt;
  qeidelta_t delta;

  osalDbgCheckClassI();
  osalDbgCheck(qeip != NULL);
  osalDbgAssert((qeip->state == QEI_READY) || (qeip->state == QEI_ACTIVE),
                "invalid state");

  cnt = qei_lld_get_count(qeip);
  delta = cnt - qeip->last;
  qeip->last = cnt;

  return delta;
}

#endif /* HAL_USE_QEI == TRUE */

/** @} */