-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
SoftWire.cpp
245 lines (215 loc) · 6.21 KB
/
SoftWire.cpp
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
/******************************************************************************
* The MIT License
*
* Copyright (c) 2010 LeafLabs LLC.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use, copy,
* modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*****************************************************************************/
/**
* @file SoftWire.cpp
* @author Trystan Jones <crenn6977@gmail.com>
* @brief Wire library, uses the WireBase to create the primary interface
* while keeping low level interactions invisible to the user.
*/
/*
* Library updated by crenn to follow new Wire system.
* Code was derived from the original Wire for maple code by leaflabs and the
* modifications by gke and ala42.
*/
/*
* Updated by Roger Clark. 20141111. Fixed issue when process() returned because of missing ACK (often caused by invalid device address being used), caused SCL to be left
* LOW so that in the next call to process() , the first clock pulse was not sent, because SCL was LOW when it should have been high.
*/
/*
* Updated by Brandon Green. 20172306. Implementing the repeated start functionality.
*/
#include "SoftWire.h"
#define I2C_WRITE 0
#define I2C_READ 1
/* low level conventions:
* - SDA/SCL idle high (expected high)
* - always start with i2c_delay rather than end
*/
void SoftWire::set_scl(bool state) {
I2C_DELAY(this->i2c_delay);
gpio_write_bit(sclDevice,sclBit, state);
//Allow for clock stretching - dangerous currently
if (state == HIGH) {
while (gpio_read_bit(sclDevice,sclBit) == 0);
}
}
void SoftWire::set_sda(bool state) {
I2C_DELAY(this->i2c_delay);
gpio_write_bit(sdaDevice,sdaBit, state);
}
void SoftWire::i2c_start() {
set_sda(LOW);
set_scl(LOW);
}
void SoftWire::i2c_stop() {
set_sda(LOW);
set_scl(HIGH);
set_sda(HIGH);
}
void SoftWire::i2c_repeated_start() {
set_sda(HIGH);
set_scl(HIGH);
set_sda(LOW);
}
bool SoftWire::i2c_get_ack() {
set_scl(LOW);
set_sda(HIGH);
set_scl(HIGH);
bool ret = (gpio_read_bit(sdaDevice, sdaBit) == 0);
set_scl(LOW);
return ret;
}
void SoftWire::i2c_send_ack() {
set_sda(LOW);
set_scl(HIGH);
set_scl(LOW);
}
void SoftWire::i2c_send_nack() {
set_sda(HIGH);
set_scl(HIGH);
set_scl(LOW);
}
uint8 SoftWire::i2c_shift_in() {
uint8 data = 0;
set_sda(HIGH);
int i;
for (i = 0; i < 8; i++) {
set_scl(HIGH);
data |= gpio_read_bit(sdaDevice, sdaBit) ? (1 << (7-i)) : 0;
set_scl(LOW);
}
return data;
}
void SoftWire::i2c_shift_out(uint8 val) {
int i;
for (i = 0; i < 8; i++) {
set_sda(!!(val & (1 << (7 - i)) ) );
set_scl(HIGH);
set_scl(LOW);
}
}
//process needs to be updated for repeated start.
uint8 SoftWire::process(uint8 stop) {
itc_msg.xferred = 0;
uint8 sla_addr = (itc_msg.addr << 1);
if (itc_msg.flags == I2C_MSG_READ) {
sla_addr |= I2C_READ;
}
i2c_start();
// shift out the address we're transmitting to
i2c_shift_out(sla_addr);
if (!i2c_get_ack())
{
i2c_stop();// Roger Clark. 20141110 added to set clock high again, as it will be left in a low state otherwise
return ENACKADDR;
}
// Recieving
if (itc_msg.flags == I2C_MSG_READ) {
while (itc_msg.xferred < itc_msg.length) {
itc_msg.data[itc_msg.xferred++] = i2c_shift_in();
if (itc_msg.xferred < itc_msg.length)
{
i2c_send_ack();
}
else
{
i2c_send_nack();
}
}
}
// Sending
else {
for (uint8 i = 0; i < itc_msg.length; i++) {
i2c_shift_out(itc_msg.data[i]);
if (!i2c_get_ack())
{
i2c_stop();// Roger Clark. 20141110 added to set clock high again, as it will be left in a low state otherwise
return ENACKTRNS;
}
itc_msg.xferred++;
}
}
if(stop == true)
i2c_stop();
else i2c_repeated_start();
return SUCCESS;
}
// For compatibility with legacy code
uint8 SoftWire::process(){
return process(true);
}
// TODO: Add in Error Handling if pins is out of range for other Maples
// TODO: Make delays more capable
SoftWire::SoftWire(uint8 scl, uint8 sda, uint8 delay) : i2c_delay(delay) {
this->scl_pin=scl;
this->sda_pin=sda;
}
void SoftWire::begin(uint8 self_addr) {
(void)self_addr;
tx_buf_idx = 0;
tx_buf_overflow = false;
rx_buf_idx = 0;
rx_buf_len = 0;
pinMode(this->scl_pin, OUTPUT_OPEN_DRAIN);
pinMode(this->sda_pin, OUTPUT_OPEN_DRAIN);
sclDevice = PIN_MAP[this->scl_pin].gpio_device;
sclBit = PIN_MAP[this->scl_pin].gpio_bit;
sdaDevice = PIN_MAP[this->sda_pin].gpio_device;
sdaBit = PIN_MAP[this->sda_pin].gpio_bit;
set_scl(HIGH);
set_sda(HIGH);
}
void SoftWire::end()
{
if (this->scl_pin)
{
pinMode(this->scl_pin, INPUT);
}
if (this->sda_pin)
{
pinMode(this->sda_pin, INPUT);
}
}
void SoftWire::setClock(uint32_t frequencyHz)
{
switch(frequencyHz)
{
case 400000:
i2c_delay = SOFT_FAST;
break;
case 100000:
default:
i2c_delay = SOFT_STANDARD;
break;
}
}
SoftWire::~SoftWire() {
this->scl_pin=0;
this->sda_pin=0;
}
// Declare the instance that the users of the library can use
//SoftWire Wire(SCL, SDA, SOFT_STANDARD);
//SoftWire Wire(PB6, PB7, SOFT_FAST);