blob: 835704d2c9d1251c9ce498fa443b9e5c9d0d825a (
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
|
/*
ChibiOS - Copyright (C) 2006..2017 Giovanni Di Sirio
Copyright (C) 2017 Fabien Poussin (fabien.poussin (at) google's mail)
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.
*/
#ifndef HAL_COMP_H_
#define HAL_COMP_H_
#include "hal.h"
#if (HAL_USE_COMP == TRUE) || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Driver state machine possible states.
*/
typedef enum {
COMP_UNINIT = 0, /**< Not initialized. */
COMP_STOP = 1, /**< Stopped. */
COMP_READY = 2, /**< Ready. */
COMP_ACTIVE = 3, /**< Active cycle phase. */
} compstate_t;
/**
* @brief Type of a structure representing an COMP driver.
*/
typedef struct COMPDriver COMPDriver;
/**
* @brief COMP notification callback type.
*
* @param[in] comp pointer to a @p COMPDriver object
*/
typedef void (*compcallback_t)(COMPDriver *comp);
#include "hal_comp_lld.h"
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/**
* @name Macro Functions
* @{
*/
/**
* @brief Enables the input capture.
*
* @param[in] comp pointer to the @p COMPDriver object
*
* @iclass
*/
#define compEnableI(comp) comp_lld_enable(comp)
/**
* @brief Disables the input capture.
*
* @param[in] comp pointer to the @p COMPDriver object
*
* @iclass
*/
#define compDisableI(comp) comp_lld_disable(comp)
/** @} */
/**
* @name Low Level driver helper macros
* @{
*/
/**
* @brief Common ISR code, main event.
*
* @param[in] comp pointer to the @p COMPDriver object
*
* @notapi
*/
#define _comp_isr_invoke_cb(comp) { \
(comp)->config->cb(comp); \
}
/** @} */
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
void compInit(void);
void compObjectInit(COMPDriver *comp);
void compStart(COMPDriver *comp, const COMPConfig *config);
void compStop(COMPDriver *comp);
void compEnable(COMPDriver *comp);
void compDisable(COMPDriver *comp);
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_COMP */
#endif /* HAL_COMP_H_ */
|
