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
|
/*
ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
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_pal.c
* @brief I/O Ports Abstraction Layer code.
*
* @addtogroup PAL
* @{
*/
#include "hal.h"
#if (HAL_USE_PAL == TRUE) || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver local definitions. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver exported variables. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver local variables and types. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver local functions. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver exported functions. */
/*===========================================================================*/
/**
* @brief Read from an I/O bus.
* @note The operation is not guaranteed to be atomic on all the
* architectures, for atomicity and/or portability reasons you may
* need to enclose port I/O operations between @p osalSysLock() and
* @p osalSysUnlock().
* @note The function internally uses the @p palReadGroup() macro. The use
* of this function is preferred when you value code size, readability
* and error checking over speed.
* @note The function can be called from any context.
*
* @param[in] bus the I/O bus, pointer to a @p IOBus structure
* @return The bus logical states.
*
* @special
*/
ioportmask_t palReadBus(const IOBus *bus) {
osalDbgCheck((bus != NULL) && (bus->offset < PAL_IOPORTS_WIDTH));
return palReadGroup(bus->portid, bus->mask, bus->offset);
}
/**
* @brief Write to an I/O bus.
* @note The operation is not guaranteed to be atomic on all the
* architectures, for atomicity and/or portability reasons you may
* need to enclose port I/O operations between @p osalSysLock() and
* @p osalSysUnlock().
* @note The default implementation is non atomic and not necessarily
* optimal. Low level drivers may optimize the function by using
* specific hardware or coding.
* @note The function can be called from any context.
*
* @param[in] bus the I/O bus, pointer to a @p IOBus structure
* @param[in] bits the bits to be written on the I/O bus. Values exceeding
* the bus width are masked so most significant bits are
* lost.
*
* @special
*/
void palWriteBus(const IOBus *bus, ioportmask_t bits) {
osalDbgCheck((bus != NULL) && (bus->offset < PAL_IOPORTS_WIDTH));
palWriteGroup(bus->portid, bus->mask, bus->offset, bits);
}
/**
* @brief Programs a bus with the specified mode.
* @note The operation is not guaranteed to be atomic on all the
* architectures, for atomicity and/or portability reasons you may
* need to enclose port I/O operations between @p osalSysLock() and
* @p osalSysUnlock().
* @note The default implementation is non atomic and not necessarily
* optimal. Low level drivers may optimize the function by using
* specific hardware or coding.
* @note The function can be called from any context.
*
* @param[in] bus the I/O bus, pointer to a @p IOBus structure
* @param[in] mode the mode
*
* @special
*/
void palSetBusMode(const IOBus *bus, iomode_t mode) {
osalDbgCheck((bus != NULL) && (bus->offset < PAL_IOPORTS_WIDTH));
palSetGroupMode(bus->portid, bus->mask, bus->offset, mode);
}
#if (PAL_USE_CALLBACKS == TRUE) || defined(__DOXYGEN__)
/**
* @brief Associates a callback to a port/pad.
*
* @param[in] port port identifier
* @param[in] pad pad number within the port
* @param[in] cb event callback function
* @param[in] arg callback argument
*
* @api
*/
void palSetPadCallbackI(ioportid_t port, iopadid_t pad,
palcallback_t cb, void *arg) {
palevent_t *pep = pal_lld_get_pad_event(port, pad);
pep->cb = cb;
pep->arg = arg;
}
/**
* @brief Associates a callback to a line.
*
* @param[in] line line identifier
* @param[in] cb event callback function
* @param[in] arg callback argument
*
* @api
*/
void palSetLineCallbackI(ioline_t line, palcallback_t cb, void *arg) {
palevent_t *pep = pal_lld_get_line_event(line);
pep->cb = cb;
pep->arg = arg;
}
#endif /* PAL_USE_CALLBACKS == TRUE */
#if (PAL_USE_WAIT == TRUE) || defined(__DOXYGEN__)
/**
* @brief Waits for an edge on the specified port/pad.
*
* @param[in] port port identifier
* @param[in] pad pad number within the port
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout.
* - @a TIME_INFINITE no timeout.
* .
* @returns The operation state.
* @retval MSG_OK if an edge has been detected.
* @retval MSG_TIMEOUT if a timeout occurred before an edge could be detected.
* @retval MSG_RESET if the event has been disabled while the thread was
* waiting for an edge.
*
* @sclass
*/
msg_t palWaitPadTimeoutS(ioportid_t port,
iopadid_t pad,
sysinterval_t timeout) {
palevent_t *pep = pal_lld_get_pad_event(port, pad);
return osalThreadEnqueueTimeoutS(&pep->threads, timeout);
}
/**
* @brief Waits for an edge on the specified port/pad.
*
* @param[in] port port identifier
* @param[in] pad pad number within the port
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout.
* - @a TIME_INFINITE no timeout.
* .
* @returns The operation state.
* @retval MSG_OK if an edge has been detected.
* @retval MSG_TIMEOUT if a timeout occurred before an edge cound be detected.
* @retval MSG_RESET if the event has been disabled while the thread was
* waiting for an edge.
*
* @api
*/
msg_t palWaitPadTimeout(ioportid_t port,
iopadid_t pad,
sysinterval_t timeout) {
msg_t msg;
osalSysLock();
msg = palWaitPadTimeoutS(port, pad, timeout);
osalSysUnlock();
return msg;
}
/**
* @brief Waits for an edge on the specified line.
*
* @param[in] line line identifier
* @param[in] timeout operation timeout
* @returns The operation state.
* @retval MSG_OK if an edge has been detected.
* @retval MSG_TIMEOUT if a timeout occurred before an edge could be detected.
* @retval MSG_RESET if the event has been disabled while the thread was
* waiting for an edge.
*
* @sclass
*/
msg_t palWaitLineTimeoutS(ioline_t line,
sysinterval_t timeout) {
palevent_t *pep = pal_lld_get_line_event(line);
return osalThreadEnqueueTimeoutS(&pep->threads, timeout);
}
/**
* @brief Waits for an edge on the specified line.
*
* @param[in] line line identifier
* @param[in] timeout operation timeout
* @returns The operation state.
* @retval MSG_OK if an edge has been detected.
* @retval MSG_TIMEOUT if a timeout occurred before an edge cound be detected.
* @retval MSG_RESET if the event has been disabled while the thread was
* waiting for an edge.
*
* @api
*/
msg_t palWaitLineTimeout(ioline_t line, sysinterval_t timeout) {
msg_t msg;
osalSysLock();
msg= palWaitLineTimeoutS(line, timeout);
osalSysUnlock();
return msg;
}
#endif /* PAL_USE_WAIT == TRUE */
#endif /* HAL_USE_PAL == TRUE */
/** @} */
|
