aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/src/icu.c
blob: c73ea5106fec340e09c8e66f0ad5f4af581037d7 (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
/*
    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
                 2011 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file    icu.c
 * @brief   ICU Driver code.
 *
 * @addtogroup ICU
 * @{
 */

#include "ch.h"
#include "hal.h"

#if HAL_USE_ICU || defined(__DOXYGEN__)

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

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

/*===========================================================================*/
/* Driver local variables.                                                   */
/*===========================================================================*/

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

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

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

  icu_lld_init();
}

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

  icup->state  = ICU_STOP;
  icup->config = NULL;
}

/**
 * @brief   Configures and activates the ICU peripheral.
 *
 * @param[in] icup      pointer to the @p ICUDriver object
 * @param[in] config    pointer to the @p ICUConfig object
 *
 * @api
 */
void icuStart(ICUDriver *icup, const ICUConfig *config) {

  chDbgCheck((icup != NULL) && (config != NULL), "icuStart");

  chSysLock();
  chDbgAssert((icup->state == ICU_STOP) || (icup->state == ICU_READY),
              "icuStart(), #1", "invalid state");
  icup->config = config;
  icu_lld_start(icup);
  icup->state = ICU_READY;
  chSysUnlock();
}

/**
 * @brief   Deactivates the ICU peripheral.
 *
 * @param[in] icup      pointer to the @p ICUDriver object
 *
 * @api
 */
void icuStop(ICUDriver *icup) {

  chDbgCheck(icup != NULL, "icuStop");

  chSysLock();
  chDbgAssert((icup->state == ICU_STOP) || (icup->state == ICU_READY),
              "icuStop(), #1", "invalid state");
  icu_lld_stop(icup);
  icup->state = ICU_STOP;
  chSysUnlock();
}

/**
 * @brief   Enables the input capture.
 *
 * @param[in] icup      pointer to the @p ICUDriver object
 *
 * @api
 */
void icuEnable(ICUDriver *icup) {

  chDbgCheck(icup != NULL, "icuEnable");

  chSysLock();
  chDbgAssert(icup->state == ICU_READY, "icuEnable(), #1", "invalid state");
  icu_lld_enable(icup);
  icup->state = ICU_WAITING;
  chSysUnlock();
}

/**
 * @brief   Disables the input capture.
 *
 * @param[in] icup      pointer to the @p ICUDriver object
 *
 * @api
 */
void icuDisable(ICUDriver *icup) {

  chDbgCheck(icup != NULL, "icuDisable");

  chSysLock();
  chDbgAssert((icup->state == ICU_READY) || (icup->state == ICU_WAITING) ||
              (icup->state == ICU_ACTIVE) || (icup->state == ICU_IDLE),
              "icuDisable(), #1", "invalid state");
  icu_lld_disable(icup);
  icup->state = ICU_READY;
  chSysUnlock();
}

#endif /* HAL_USE_ICU */

/** @} */