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
|
/******************************************************************************
* 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 WireBase.h
* @author Trystan Jones <crenn6977@gmail.com>
* @brief Wire library, following the majority of the interface from Arduino.
* Provides a 'standard' interface to I2C (two-wire) communication for
* derived classes.
*/
/*
* Library created by crenn to allow a system which would provide users the
* 'standardised' Arduino method for interfacing with I2C devices regardless of
* whether it is I2C hardware or emulating software.
*/
#ifndef _WIREBASE_H_
#define _WIREBASE_H_
#include <wirish/wirish.h>
#include <libmaple/i2c.h>
#define WIRE_BUFSIZ 32
/* return codes from endTransmission() */
#define SUCCESS 0 /* transmission was successful */
#define EDATA 1 /* too much data */
#define ENACKADDR 2 /* received nack on transmit of address */
#define ENACKTRNS 3 /* received nack on transmit of data */
#define EOTHER 4 /* other error */
class WireBase { // Abstraction is awesome!
protected:
i2c_msg itc_msg;
uint8 rx_buf[WIRE_BUFSIZ]; /* receive buffer */
uint8 rx_buf_idx; /* first unread idx in rx_buf */
uint8 rx_buf_len; /* number of bytes read */
uint8 tx_buf[WIRE_BUFSIZ]; /* transmit buffer */
uint8 tx_buf_idx; // next idx available in tx_buf, -1 overflow
boolean tx_buf_overflow;
// Force derived classes to define process function
virtual uint8 process() = 0;
public:
WireBase() {}
~WireBase() {}
/*
* Initialises the class interface
*/
// Allow derived classes to overwrite begin function
virtual void begin(uint8 = 0x00);
/*
* Sets up the transmission message to be processed
*/
void beginTransmission(uint8);
/*
* Allow only 8 bit addresses to be used
*/
void beginTransmission(int);
/*
* Call the process function to process the message if the TX
* buffer has not overflowed.
*/
uint8 endTransmission(void);
/*
* Request bytes from a slave device and process the request,
* storing into the receiving buffer.
*/
uint8 requestFrom(uint8, int);
/*
* Allow only 8 bit addresses to be used when requesting bytes
*/
uint8 requestFrom(int, int);
/*
* Stack up bytes to be sent when transmitting
*/
void send(uint8);
/*
* Stack up bytes from the array to be sent when transmitting
*/
void send(uint8*, int);
/*
* Ensure that a sending data will only be 8-bit bytes
*/
void send(int);
/*
* Ensure that an array sending data will only be 8-bit bytes
*/
void send(int*, int);
/*
* Stack up bytes from a string to be sent when transmitting
*/
void send(char*);
/*
* Return the amount of bytes that is currently in the receiving buffer
*/
uint8 available();
/*
* Return the value of byte in the receiving buffer that is currently being
* pointed to
*/
uint8 receive();
};
#endif // _WIREBASE_H_
|
