Contiki-Inga 3.x
i2cmaster.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010, Swedish Institute of Computer Science.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * This file is part of the Contiki operating system.
30  *
31  */
32 
33 /**
34  * \file
35  * I2C communication device driver header file for Zolertia Z1 sensor node.
36  * \author
37  * Enric Calvo, Zolertia <ecalvo@zolertia.com>
38  * Marcus Lundén, SICS <mlunden@sics.se>
39  */
40 
41 #ifndef I2CMASTER_H_
42 #define I2CMASTER_H_
43 
44 #include "contiki.h"
45 
46 void i2c_enable(void);
47 void i2c_disable(void);
48 
49 void i2c_receiveinit(uint8_t slave_address);
50 uint8_t i2c_receive_n(uint8_t byte_ctr, uint8_t *rx_buf);
51 
52 void i2c_transmitinit(uint8_t slave_address);
53 void i2c_transmit_n(uint8_t byte_ctr, uint8_t *tx_buf);
54 
55 uint8_t i2c_busy(void);
56 
57 //XXX Should these defines be in the contiki-conf.h to make it more platform-independent?
58 #define I2C_PxDIR P5DIR
59 #define I2C_PxIN P5IN
60 #define I2C_PxOUT P5OUT
61 #define I2C_PxSEL P5SEL
62 #define I2C_PxSEL2 P5SEL2
63 #define I2C_PxREN P5REN
64 
65 
66 #define I2C_SDA (1 << 1) //SDA == P5.1
67 #define I2C_SCL (1 << 2) //SCL == P5.2
68 #define I2C_PRESC_1KHZ_LSB 0x00
69 #define I2C_PRESC_1KHZ_MSB 0x20
70 #define I2C_PRESC_100KHZ_LSB 0x50
71 #define I2C_PRESC_100KHZ_MSB 0x00
72 #define I2C_PRESC_400KHZ_LSB 0x14
73 #define I2C_PRESC_400KHZ_MSB 0x00
74 
75 // I2C configuration with RX interrupts
76 #ifdef I2C_CONF_RX_WITH_INTERRUPT
77 #define I2C_RX_WITH_INTERRUPT I2C_CONF_RX_WITH_INTERRUPT // XXX Move I2C_CONF_RX_WITH_INTERRUPT to contiki-conf.h or platform-conf.h
78 #else /* I2C_CONF_RX_WITH_INTERRUPT */
79 #define I2C_RX_WITH_INTERRUPT 1
80 #endif /* I2C_CONF_RX_WITH_INTERRUPT */
81 
82 
83 #if 0
84 #include <stdio.h>
85 #define PRINTFDEBUG(...) printf(__VA_ARGS__)
86 #else
87 #define PRINTFDEBUG(...)
88 #endif
89 
90 #endif /* #ifdef I2CMASTER_H_ */