lib for working with ltc2991s
Fork of ltc2991_test by
LT_I2C.h
- Committer:
- bdk9
- Date:
- 2017-01-19
- Revision:
- 8:c0ae66611a12
- Parent:
- 2:c9e727dcd00e
File content as of revision 8:c0ae66611a12:
/*! LT_I2C: Routines to communicate with ATmega328P's hardware I2C port. REVISION HISTORY $Revision: 3659 $ $Date: 2015-07-01 10:19:20 -0700 (Wed, 01 Jul 2015) $ Copyright (c) 2013, Linear Technology Corp.(LTC) All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. 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. 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 OWNER 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. The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of Linear Technology Corp. The Linear Technology Linduino is not affiliated with the official Arduino team. However, the Linduino is only possible because of the Arduino team's commitment to the open-source community. Please, visit http://www.arduino.cc and http://store.arduino.cc , and consider a purchase that will help fund their ongoing work. */ /*! @file @ingroup LT_I2C Library Header File for LT_I2C: Routines to communicate with ATmega328P's hardware I2C port. */ #ifndef LT_I2C_H #define LT_I2C_H #include <stdint.h> //#include <Wire.h> //! @name HARDWARE I2C PRESCALER VALUES //! @{ #define HARDWARE_I2C_PRESCALER_1 0 #define HARDWARE_I2C_PRESCALER_4 1 #define HARDWARE_I2C_PRESCALER_16 2 #define HARDWARE_I2C_PRESCALER_64 3 //! @} //! @name I2C READ and WRITE BITS //! @{ //! Eighth bit (LSB) of I2C address indicates a "read" or "write". //! (The first seven bits are the 7-bit I2C address.) #define I2C_READ_BIT 0x01 #define I2C_WRITE_BIT 0x00 //! @} //! @name STATUS BITS //! @{ #define STATUS_START 0x08 #define STATUS_REPEATED_START 0x10 #define STATUS_ADDRESS_WRITE_ACK 0x18 #define STATUS_ADDRESS_WRITE_NACK 0x20 #define STATUS_WRITE_ACK 0x28 #define STATUS_WRITE_NACK 0x30 #define STATUS_ARBITRATION_LOST 0x38 #define STATUS_ADDRESS_READ_ACK 0x40 #define STATUS_ADDRESS_READ_NACK 0x48 #define STATUS_READ_ACK 0x50 #define STATUS_READ_NACK 0x58 //! @} //! @name TIMEOUT AND DELAY IN US //! @{ #define HW_I2C_DELAY 1 #define HW_I2C_TIMEOUT 20000 //! @} //! @name ACK OR NACK PARAMETER PASSED TO I2C_READ //! @{ #define WITH_ACK 0 //!< Use with i2c_read(WITH_ACK) to read with an acknowledge #define WITH_NACK 1 //!< Use with i2c_read(WITH_NACK) to read without an acknowledge. Normally used after the last byte of a multi-byte read. //! @} //! @name OPTIONAL I2C Address MACRO //! @{ #define I2C_8ADDR(address) (address >> 1) //!< Use to convert an 8-bit I2C address to 7 bits. //! @} #include "mbed.h" class LT_I2C { private: I2C *i2c; PinName sda; PinName scl; public: LT_I2C(); LT_I2C(PinName sda_, PinName scl_); //! Read a byte of data at register specified by "command", store in "value" //! @return 0 on success, 1 on failure int8_t i2c_read_byte_data(uint8_t address, //!< 7-bit I2C address uint8_t command, //!< Command byte uint8_t *value //!< Byte to be read ); //! Write a byte of data to register specified by "command" //! @return 0 on success, 1 on failure int8_t i2c_write_byte_data(uint8_t address, //!< 7-bit I2C address uint8_t command, //!< Command byte uint8_t value //!< Byte to be written ); //! Read a 16-bit word of data from register specified by "command" //! @return 0 on success, 1 on failure int8_t i2c_read_word_data(uint8_t address, //!< 7-bit I2C address uint8_t command, //!< Command byte uint16_t *value //!< Word to be read ); //! Write a 16-bit word of data to register specified by "command" //! @return 0 on success, 1 on failure int8_t i2c_write_word_data(uint8_t address, //!< 7-bit I2C address uint8_t command, //!< Command byte uint16_t value //!< Word to be written ); }; #endif // LT_I2C_H