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
|
// $Id: SpiPacket.nc,v 1.8 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.
*/
/**
* SPI Packet/buffer interface for sending data over an SPI bus. This
* interface provides a split-phase send command which can be used for
* sending, receiving or both. It is a "send" command because reading
* from the SPI requires writing bytes. The send call allows NULL
* parameters for receive or send only operations. This interface is
* for buffer based transfers where the microcontroller is the master
* (clocking) device.
*
* Often, an SPI bus must first be acquired using a Resource interface
* before sending commands with SPIPacket. In the case of multiple
* devices attached to a single SPI bus, chip select pins are often also
* used.
*
* @author Philip Levis
* @author Jonathan Hui
* @author Joe Polastre
* Revision: $Revision: 1.8 $
*/
interface SpiPacket {
/**
* Send a message over the SPI bus.
*
* @param 'uint8_t* COUNT_NOK(len) txBuf' A pointer to the buffer to send over the bus. If this
* parameter is NULL, then the SPI will send zeroes.
* @param 'uint8_t* COUNT_NOK(len) rxBuf' A pointer to the buffer where received data should
* be stored. If this parameter is NULL, then the SPI will
* discard incoming bytes.
* @param len Length of the message. Note that non-NULL rxBuf and txBuf
* parameters must be AT LEAST as large as len, or the SPI
* will overflow a buffer.
*
* @return SUCCESS if the request was accepted for transfer
*/
async command error_t send( uint8_t* txBuf, uint8_t* rxBuf, uint16_t len );
/**
* Notification that the send command has completed.
*
* @param 'uint8_t* COUNT_NOK(len) txBuf' The buffer used for transmission
* @param 'uint8_t* COUNT_NOK(len) rxBuf' The buffer used for reception
* @param len The request length of the transfer, but not necessarily
* the number of bytes that were actually transferred
* @param error SUCCESS if the operation completed successfully, FAIL
* otherwise
*/
async event void sendDone( uint8_t* txBuf, uint8_t* rxBuf, uint16_t len,
error_t error );
}
|
