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
|
// $Id: I2CPacket.nc,v 1.7 2010-06-29 22:07:46 scipio Exp $
/*
* Copyright (c) 2000-2005 The Regents of the University of California.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the
* distribution.
* - Neither the name of the copyright holders nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* I2C Packet/buffer interface for sending data over the I2C bus.
* The address, length, and buffer must be specified. The I2C bus then
* has control of that buffer and returns it when the operation has
* completed. The I2CPacket interface supports master-mode communication
* and provides for multiple repeated STARTs and multiple reads/writes
* within the same START transaction.
* The interface is typed according to the address size supported by
* the master hardware. Masters capable of supporting extended (10-bit)
* I2C addressing MUST export both types. Applications should use the
* smallest address size to ensure best portability.
*
* @param addr_size A type indicating the slave address size. Supported
* values are TI2CExtdAddr (for 10-bit addressing) and TI2CBasicAddr (7-bit
* addressing).
*
* @author Joe Polastre
* @author Phil Buonadonna <pbuonadonna@archrock.com>
* @author Jonathan Hui <jhui@archrock.com>
* @author Phil Levis <pal@cs.stanford.edu>
* Revision: $Revision: 1.7 $
*/
#include <I2C.h>
interface I2CPacket<addr_size> {
/**
* Perform an I2C read operation
*
* @param flags Flags that may be logical ORed and defined by:
* I2C_START - The START condition is transmitted at the beginning
* of the packet if set.
* I2C_STOP - The STOP condition is transmitted at the end of the
* packet if set.
* I2C_ACK_END - ACK the last byte if set. Otherwise NACK last byte. This
* flag cannot be used with the I2C_STOP flag.
* @param addr The slave device address. Only used if I2C_START is set.
* @param length Length, in bytes, to be read
* @param 'uint8_t* COUNT(length) data' A point to a data buffer to read into
*
* @return SUCCESS if bus available and request accepted.
*/
async command error_t read(i2c_flags_t flags, uint16_t addr, uint8_t length, uint8_t* data);
/**
* Perform an I2C write operation
*
* @param flags Flags that may be logical ORed and defined by:
* I2C_START - The START condition is transmitted at the beginning
* of the packet if set.
* I2C_STOP - The STOP condition is transmitted at the end of the
* packet if set.
* @param addr The slave device address. Only used if I2C_START is set.
* @param length Length, in bytes, to be read
* @param 'uint8_t* COUNT(length) data' A point to a data buffer to read into
*
* @return SUCCESS if bus available and request accepted.
*/
async command error_t write(i2c_flags_t flags, uint16_t addr, uint8_t length, uint8_t* data);
/**
* Notification that the read operation has completed
*
* @param addr The slave device address
* @param length Length, in bytes, read
* @param 'uint8_t* COUNT(length) data' Pointer to the received data buffer
* @param success SUCCESS if transfer completed without error.
*/
async event void readDone(error_t error, uint16_t addr, uint8_t length, uint8_t* data);
/**
* Notification that the write operation has completed
*
* @param addr The slave device address
* @param length Length, in bytes, written
* @param 'uint8_t* COUNT(length) data' Pointer to the data buffer written
* @param success SUCCESS if transfer completed without error.
*/
async event void writeDone(error_t error, uint16_t addr, uint8_t length, uint8_t* data);
}
|
