Contiki 2.5
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 <stdio.h>
45 #include "contiki.h"
46 #include <dev/spi.h>
47 #include <dev/leds.h>
48 
49 
50 
51 void i2c_enable(void);
52 
53 void i2c_receiveinit(u8_t slave_address);
54 u8_t i2c_receive_n(u8_t byte_ctr, u8_t *rx_buf);
55 
56 void i2c_transmitinit(u8_t slave_address);
57 void i2c_transmit_n(u8_t byte_ctr, u8_t *tx_buf);
58 
59 u8_t i2c_busy(void);
60 
61 //XXX Temporary place for defines that are lacking in mspgcc4's gpio.h
62 #ifdef __GNUC__
63 #ifndef P5SEL2_
64  #define P5SEL2_ 0x0045 /* Port 5 Selection 2*/
65  sfrb(P5SEL2, P5SEL2_);
66 #endif
67 #endif
68 #ifdef __IAR_SYSTEMS_ICC__
69 #define P5SEL2_ (0x0045u) /* Port 5 Selection 2*/
70 DEFC( P5SEL2 , P5SEL2_)
71 #endif
72 
73 //XXX Should these defines be in the contiki-conf.h to make it more platform-independent?
74 #define I2C_PxDIR P5DIR
75 #define I2C_PxIN P5IN
76 #define I2C_PxOUT P5OUT
77 #define I2C_PxSEL P5SEL
78 #define I2C_PxSEL2 P5SEL2
79 #define I2C_PxREN P5REN
80 
81 
82 #define I2C_SDA (1 << 1) //SDA == P5.1
83 #define I2C_SCL (1 << 2) //SCL == P5.2
84 #define I2C_PRESC_1KHZ_LSB 0x00
85 #define I2C_PRESC_1KHZ_MSB 0x20
86 #define I2C_PRESC_100KHZ_LSB 0x50
87 #define I2C_PRESC_100KHZ_MSB 0x00
88 #define I2C_PRESC_400KHZ_LSB 0x14
89 #define I2C_PRESC_400KHZ_MSB 0x00
90 
91 // I2C configuration with RX interrupts
92 #ifdef I2C_CONF_RX_WITH_INTERRUPT
93 #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
94 #else /* I2C_CONF_RX_WITH_INTERRUPT */
95 #define I2C_RX_WITH_INTERRUPT 1
96 #endif /* I2C_CONF_RX_WITH_INTERRUPT */
97 
98 
99 #if 0
100 #define PRINTFDEBUG(...) printf(__VA_ARGS__)
101 #else
102 #define PRINTFDEBUG(...)
103 #endif
104 
105 #endif /* #ifdef __I2CMASTER_H__ */