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
|
/**
* @author Tilen Majerle
* @email tilen@majerle.eu
* @website http://stm32f4-discovery.com
* @link http://stm32f4-discovery.com/2014/05/library-12-onewire-library-for-stm43f4xx/
* @version v2.1
* @ide Keil uVision
* @license GNU GPL v3
* @brief Onewire library for STM32F4 devices
*
@verbatim
----------------------------------------------------------------------
Copyright (C) Tilen Majerle, 2015
This program 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
any later version.
This program 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/>.
----------------------------------------------------------------------
@endverbatim
*/
#ifndef TM_ONEWIRE_H
#define TM_ONEWIRE_H 210
/* C++ detection */
#ifdef __cplusplus
extern C {
#endif
/**
* @addtogroup TM_STM32F4xx_Libraries
* @{
*/
/**
* @defgroup TM_ONEWIRE
* @brief Onewire library for STM32F4 devices - http://stm32f4-discovery.com/2014/05/library-12-onewire-library-for-stm43f4xx/
* @{
*
* As of version 2.0 you can now use more than just one one-wire "port" on STM32F4. This allows you to group devices to separate ports.
*
* Because if you have a loot devices on one port, if one device fail, everything is failed. You can prevent this by use more than just one port.
*
* To set your port and pin for OneWire protocol, you can do this when calling @ref TM_OneWire_Init function.
*
* \par Changelog
*
@verbatim
Version 2.1
- March 10, 2015
- Added support for new GPIO library
Version 2.0
- January 04, 2015
- New OneWire system
- With support for multiple OneWire ports to separate group of devices
Version 1.1
- December 06, 2014
- Added 8-bit CRC calculation for 1-Wire devices, algorithm from Dallas
Version 1.0
- First release
@endverbatim
*
* \par Dependencies
*
@verbatim
- STM32F4xx
- STM32F4xx RCC
- STM32F4xx GPIO
- TM GPIO
@endverbatim
*/
#include "stm32f4xx.h"
#include "stm32f4xx_rcc.h"
#include "stm32f4xx_gpio.h"
/**
* @defgroup TM_ONEWIRE_Macros
* @brief Library defines
* @{
*/
/* Pin settings */
#define ONEWIRE_LOW(structure) TM_GPIO_ResetBits((structure)->GPIOx, (structure)->GPIO_Pin)
#define ONEWIRE_HIGH(structure) TM_GPIO_SetBits((structure)->GPIOx, (structure)->GPIO_Pin)
#define ONEWIRE_INPUT(structure) TM_GPIO_SetPinAsInput(structure->GPIOx, (structure)->GPIO_Pin)
#define ONEWIRE_OUTPUT(structure) TM_GPIO_SetPinAsOutput(structure->GPIOx, (structure)->GPIO_Pin)
/* OneWire commands */
#define ONEWIRE_CMD_RSCRATCHPAD 0xBE
#define ONEWIRE_CMD_WSCRATCHPAD 0x4E
#define ONEWIRE_CMD_CPYSCRATCHPAD 0x48
#define ONEWIRE_CMD_RECEEPROM 0xB8
#define ONEWIRE_CMD_RPWRSUPPLY 0xB4
#define ONEWIRE_CMD_SEARCHROM 0xF0
#define ONEWIRE_CMD_READROM 0x33
#define ONEWIRE_CMD_MATCHROM 0x55
#define ONEWIRE_CMD_SKIPROM 0xCC
/**
* @}
*/
/**
* @defgroup TM_ONEWIRE_Typedefs
* @brief Library Typedefs
* @{
*/
/**
* @brief OneWire working struct
* @note Except ROM_NO member, everything is fully private and should not be touched by user
*/
typedef struct {
GPIO_TypeDef* GPIOx; /*!< GPIOx port to be used for I/O functions */
uint16_t GPIO_Pin; /*!< GPIO Pin to be used for I/O functions */
uint8_t LastDiscrepancy; /*!< Search private */
uint8_t LastFamilyDiscrepancy; /*!< Search private */
uint8_t LastDeviceFlag; /*!< Search private */
uint8_t ROM_NO[8]; /*!< 8-bytes address of last search device */
} TM_OneWire_t;
/**
* @}
*/
/**
* @defgroup TM_ONEWIRE_Functions
* @brief Library Functions
* @{
*/
/**
* @brief Initializes OneWire bus
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t empty working onewire structure
* @param *Pointer to GPIO port used for onewire channel
* @param GPIO_Pin: GPIO Pin on specific GPIOx to be used for onewire channel
* @retval None
*/
void TM_OneWire_Init(TM_OneWire_t* OneWireStruct, GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
/**
* @brief Resets OneWire bus
*
* @note Sends reset command for OneWire
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire structure
* @retval None
*/
uint8_t TM_OneWire_Reset(TM_OneWire_t* OneWireStruct);
/**
* @brief Reads byte from one wire bus
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire structure
* @retval Byte from read operation
*/
uint8_t TM_OneWire_ReadByte(TM_OneWire_t* OneWireStruct);
/**
* @brief Writes byte to bus
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire structure
* @param byte: 8-bit value to write over OneWire protocol
* @retval None
*/
void TM_OneWire_WriteByte(TM_OneWire_t* OneWireStruct, uint8_t byte);
/**
* @brief Writes single bit to onewire bus
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire structure
* @param bit: Bit value to send, 1 or 0
* @retval None
*/
void TM_OneWire_WriteBit(TM_OneWire_t* OneWireStruct, uint8_t bit);
/**
* @brief Reads single bit from one wire bus
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire structure
* @retval Bit value:
* - 0: Bit is low (zero)
* - > 0: Bit is high (one)
*/
uint8_t TM_OneWire_ReadBit(TM_OneWire_t* OneWireStruct);
/**
* @brief Searches for OneWire devices on specific Onewire port
* @note Not meant for public use. Use @ref TM_OneWire_First and @ref TM_OneWire_Next for this.
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire structure where to search
* @param Device status:
* - 0: No devices detected
* - > 0: Device detected
*/
uint8_t TM_OneWire_Search(TM_OneWire_t* OneWireStruct, uint8_t command);
/**
* @brief Resets search states
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire where to reset search values
* @retval None
*/
void TM_OneWire_ResetSearch(TM_OneWire_t* OneWireStruct);
/**
* @brief Starts search, reset states first
* @note When you want to search for ALL devices on one onewire port, you should first use this function.
@verbatim
/...Initialization before
status = TM_OneWire_First(&OneWireStruct);
while (status) {
//Save ROM number from device
TM_OneWire_GetFullROM(ROM_Array_Pointer);
//Check for new device
status = TM_OneWire_Next(&OneWireStruct);
}
@endverbatim
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire where to reset search values
* @param Device status:
* - 0: No devices detected
* - > 0: Device detected
*/
uint8_t TM_OneWire_First(TM_OneWire_t* OneWireStruct);
/**
* @brief Reads next device
* @note Use @ref TM_OneWire_First to start searching
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire
* @param Device status:
* - 0: No devices detected any more
* - > 0: New device detected
*/
uint8_t TM_OneWire_Next(TM_OneWire_t* OneWireStruct);
/**
* @brief Gets ROM number from device from search
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire
* @param index: Because each device has 8-bytes long ROm address, you have to call this 8 times, to get ROM bytes from 0 to 7
* @reetval ROM byte for index (0 to 7) at current found device
*/
uint8_t TM_OneWire_GetROM(TM_OneWire_t* OneWireStruct, uint8_t index);
/**
* @brief Gets all 8 bytes ROM value from device from search
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire
* @param *firstIndex: Pointer to first location for first byte, other bytes are automatically incremented
* @retval None
*/
void TM_OneWire_GetFullROM(TM_OneWire_t* OneWireStruct, uint8_t *firstIndex);
/**
* @brief Selects specific slave on bus
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire
* @param *addr: Pointer to first location of 8-bytes long ROM address
* @retval None
*/
void TM_OneWire_Select(TM_OneWire_t* OneWireStruct, uint8_t* addr);
/**
* @brief Selects specific slave on bus with pointer address
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working onewire
* @param *ROM: Pointer to first byte of ROM address
* @retval None
*/
void TM_OneWire_SelectWithPointer(TM_OneWire_t* OneWireStruct, uint8_t* ROM);
/**
* @brief Calculates 8-bit CRC for 1-wire devices
* @param *addr: Pointer to 8-bit array of data to calculate CRC
* @param len: Number of bytes to check
*
* @retval Calculated CRC from input data
*/
uint8_t TM_OneWire_CRC8(uint8_t* addr, uint8_t len);
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
/* C++ detection */
#ifdef __cplusplus
}
#endif
#endif
|
