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
|
/*
ChibiOS/RT - Copyright (C) 2014 Uladzimir Pylinsky aka barthess
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 onewire.h
* @brief 1-wire Driver macros and structures.
*
* @addtogroup onewire
* @{
*/
#ifndef _ONEWIRE_H_
#define _ONEWIRE_H_
#if HAL_USE_ONEWIRE || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/**
* @brief Enable synthetic test for 'search ROM' procedure.
* @note Only for debugging/testing!
*/
#define ONEWIRE_SYNTH_SEARCH_TEST FALSE
/**
* @brief Aliases for 1-wire protocol.
*/
#define ONEWIRE_CMD_READ_ROM 0x33
#define ONEWIRE_CMD_SEARCH_ROM 0xF0
#define ONEWIRE_CMD_MATCH_ROM 0x55
#define ONEWIRE_CMD_SKIP_ROM 0xCC
#define ONEWIRE_CMD_CONVERT_TEMP 0x44
#define ONEWIRE_CMD_READ_SCRATCHPAD 0xBE
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if !HAL_USE_PWM
#error "1-wire Driver requires HAL_USE_PWM"
#endif
#if !HAL_USE_PAL
#error "1-wire Driver requires HAL_USE_PAL"
#endif
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief 1-wire strong pull up assert callback type.
*/
typedef void (*onewire_pullup_assert_t)(void);
/**
* @brief 1-wire strong pull up release callback type.
*/
typedef void (*onewire_pullup_release_t)(void);
/**
* @brief 1-wire read bit callback type.
*
* @return Bit acquired directly from pin (0 or 1)
*/
typedef uint_fast8_t (*onewire_read_bit_t)(void);
/**
* @brief Driver state machine possible states.
*/
typedef enum {
ONEWIRE_UNINIT = 0, /**< Not initialized. */
ONEWIRE_STOP = 1, /**< Stopped. */
ONEWIRE_READY = 2, /**< Ready. */
#if ONEWIRE_USE_STRONG_PULLUP
ONEWIRE_PULL_UP /**< Pull up asserted. */
#endif
} onewire_state_t;
/**
* @brief Search ROM procedure possible state.
*/
typedef enum {
ONEWIRE_SEARCH_ROM_SUCCESS = 0, /**< ROM successfully discovered. */
ONEWIRE_SEARCH_ROM_LAST = 1, /**< Last ROM successfully discovered. */
ONEWIRE_SEARCH_ROM_ERROR = 2 /**< Error happened during search. */
} search_rom_result_t;
/**
* @brief Search ROM procedure iteration enum.
*/
typedef enum {
ONEWIRE_SEARCH_ROM_FIRST = 0, /**< First search run. */
ONEWIRE_SEARCH_ROM_NEXT = 1 /**< Next search run. */
} search_iteration_t;
/**
* @brief Driver configuration structure.
*/
typedef struct {
/**
* @brief Pointer to @p PWM driver used for communication.
*/
PWMDriver *pwmd;
/**
* @brief Number of PWM channel used as master pulse generator.
*/
size_t master_channel;
/**
* @brief Number of PWM channel used as sample interrupt generator.
*/
size_t sample_channel;
/**
* @brief Pointer to function performing read of single bit.
* @note It must be callable from any context.
*/
onewire_read_bit_t readBitX;
#if ONEWIRE_USE_STRONG_PULLUP
/**
* @brief Pointer to function asserting of strong pull up.
*/
onewire_pullup_assert_t pullup_assert;
/**
* @brief Pointer to function releasing of strong pull up.
*/
onewire_pullup_release_t pullup_release;
#endif
} onewireConfig;
/**
* @brief Search ROM registry. Contains small variables used
* in 'search ROM' procedure.
*/
typedef struct {
/**
* @brief Bool flag. If @p true than only bus has only one slave device.
*/
uint32_t single_device: 1;
/**
* @brief Search iteration (@p search_iteration_t enum).
*/
uint32_t search_iter: 1;
/**
* @brief Result of discovery procedure (@p search_rom_result_t enum).
*/
uint32_t result: 2;
/**
* @brief One of 3 steps of bit discovery.
* @details 0 - direct, 1 - complemented, 2 - generated by master.
*/
uint32_t bit_step: 2;
/**
* @brief Values acquired during bit discovery.
*/
uint32_t bit_buf: 2;
/**
* @brief Currently processing ROM bit.
* @note Must be big enough to store number 64.
*/
uint32_t rombit: 7;
/**
* @brief Total device count discovered on bus.
* @note Maximum 256.
*/
uint32_t devices_found: 8;
} search_rom_reg_t;
/**
* @brief Helper structure for 'search ROM' procedure
*/
typedef struct {
/**
* @brief Search ROM registry.
*/
search_rom_reg_t reg;
/**
* @brief Pointer to buffer with currently discovering ROM
*/
uint8_t *retbuf;
/**
* @brief Previously discovered ROM.
*/
uint8_t prev_path[8];
/**
* @brief Last zero turn branch.
* @note Negative values use to point out of device tree's root.
*/
int8_t last_zero_branch;
/**
* @brief Previous zero turn branch.
* @note Negative values use to point out of device tree's root.
*/
int8_t prev_zero_branch;
} onewire_search_rom_t;
/**
* @brief Onewire registry. Some small variables combined
* in single machine word to save RAM.
*/
typedef struct {
#if ONEWIRE_USE_STRONG_PULLUP
/**
* @brief This flag will be asserted by driver to signalizes
* ISR part when strong pull up needed.
*/
uint32_t need_pullup: 1;
#endif
/**
* @brief Bool flag. If @p true than at least one device presence on bus.
*/
uint32_t slave_present: 1;
/**
* @brief Driver internal state (@p onewire_state_t enum).
*/
uint32_t state: 2;
/**
* @brief Bit number in currently receiving/sending byte.
* @note Must be big enough to store 8.
*/
uint32_t bit: 4;
/**
* @brief Bool flag for premature timer stop prevention.
*/
uint32_t final_timeslot: 1;
/**
* @brief Bytes number to be processing in current transaction.
*/
uint32_t bytes: 16;
} onewire_reg_t;
/**
* @brief Structure representing an 1-wire driver.
*/
typedef struct {
/**
* @brief Onewire registry.
*/
onewire_reg_t reg;
/**
* @brief Onewire config.
*/
const onewireConfig *config;
/**
* @brief Config for underlying PWM driver.
*/
PWMConfig pwmcfg;
/**
* @brief Pointer to I/O data buffer.
*/
uint8_t *buf;
/**
* @brief Search ROM helper structure.
*/
onewire_search_rom_t search_rom;
/**
* @brief Thread waiting for I/O completion.
*/
thread_reference_t thread;
} onewireDriver;
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
extern onewireDriver OWD1;
#ifdef __cplusplus
extern "C" {
#endif
void onewireInit(void);
void onewireObjectInit(onewireDriver *owp);
void onewireStart(onewireDriver *owp, const onewireConfig *config);
void onewireStop(onewireDriver *owp);
bool onewireReset(onewireDriver *owp);
void onewireRead(onewireDriver *owp, uint8_t *rxbuf, size_t rxbytes);
void onewireWrite(onewireDriver *owp,
uint8_t *txbuf,
size_t txbytes,
systime_t pullup_time);
size_t onewireSearchRom(onewireDriver *owp,
uint8_t *result,
size_t max_rom_cnt);
uint8_t onewireCRC(const uint8_t *buf, size_t len);
#if ONEWIRE_SYNTH_SEARCH_TEST
void _synth_ow_write_bit(onewireDriver *owp, uint8_t bit);
uint_fast8_t _synth_ow_read_bit(void);
void synthSearchRomTest(onewireDriver *owp);
#endif /* ONEWIRE_SYNTH_SEARCH_TEST */
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_ONEWIRE */
#endif /* _ONEWIRE_H_ */
/** @} */
|
