i2c_api.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef MBED_I2C_API_H
00017 #define MBED_I2C_API_H
00018 
00019 #include "device.h"
00020 
00021 #if DEVICE_I2C
00022 
00023 #ifdef __cplusplus
00024 extern "C" {
00025 #endif
00026 
00027 typedef struct i2c_s i2c_t;
00028 
00029 enum {
00030   I2C_ERROR_NO_SLAVE = -1,
00031   I2C_ERROR_BUS_BUSY = -2
00032 };
00033 
00034 void i2c_init         (i2c_t *obj, PinName sda, PinName scl);
00035 void i2c_frequency    (i2c_t *obj, int hz);
00036 int  i2c_start        (i2c_t *obj);
00037 int  i2c_stop         (i2c_t *obj);
00038 int  i2c_read         (i2c_t *obj, int address, char *data, int length, int stop);
00039 int  i2c_write        (i2c_t *obj, int address, const char *data, int length, int stop);
00040 void i2c_reset        (i2c_t *obj);
00041 int  i2c_byte_read    (i2c_t *obj, int last);
00042 int  i2c_byte_write   (i2c_t *obj, int data);
00043 
00044 #if DEVICE_I2CSLAVE
00045 void i2c_slave_mode   (i2c_t *obj, int enable_slave);
00046 int  i2c_slave_receive(i2c_t *obj);
00047 int  i2c_slave_read   (i2c_t *obj, char *data, int length);
00048 int  i2c_slave_write  (i2c_t *obj, const char *data, int length);
00049 void i2c_slave_address(i2c_t *obj, int idx, uint32_t address, uint32_t mask);
00050 #endif
00051 
00052 #ifdef __cplusplus
00053 }
00054 #endif
00055 
00056 #endif
00057 
00058 #endif