mbed library sources
Fork of mbed-src by
Diff: cpp/I2C.h
- Revision:
- 2:143cac498751
- Parent:
- 0:fd0d7bdfcdc2
diff -r 62685faffa05 -r 143cac498751 cpp/I2C.h --- a/cpp/I2C.h Thu Nov 29 15:41:14 2012 +0000 +++ b/cpp/I2C.h Mon Feb 18 11:44:18 2013 +0000 @@ -1,23 +1,17 @@ /* mbed Microcontroller Library - * Copyright (c) 2006-2012 ARM Limited + * Copyright (c) 2006-2013 ARM Limited * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. + * http://www.apache.org/licenses/LICENSE-2.0 * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ #ifndef MBED_I2C_H #define MBED_I2C_H @@ -81,14 +75,14 @@ * the address is forced to 1 to indicate a read. * * @param address 8-bit I2C slave address [ addr | 1 ] - * @param data Pointer to the byte-array to read data in to + * @param data Pointer to the byte-array to read data in to * @param length Number of bytes to read * @param repeated Repeated start, true - don't send stop at end * * @returns * 0 on success (ack), * non-0 on failure (nack) - */ + */ int read(int address, char *data, int length, bool repeated = false); /** Read a single byte from the I2C bus @@ -106,14 +100,14 @@ * the address is forced to 0 to indicate a write. * * @param address 8-bit I2C slave address [ addr | 0 ] - * @param data Pointer to the byte-array data to send + * @param data Pointer to the byte-array data to send * @param length Number of bytes to send * @param repeated Repeated start, true - do not send stop at end * * @returns * 0 on success (ack), * non-0 on failure (nack) - */ + */ int write(int address, const char *data, int length, bool repeated = false); /** Write single byte out on the I2C bus @@ -137,7 +131,7 @@ protected: void aquire(); - + i2c_t _i2c; static I2C *_owner; int _hz;