Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

I2C.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

UserRevisionLine numberNew contents of line
esokic 0:05aad811ea07 1 /* mbed Microcontroller Library
esokic 0:05aad811ea07 2 * Copyright (c) 2006-2013 ARM Limited
esokic 0:05aad811ea07 3 *
esokic 0:05aad811ea07 4 * Licensed under the Apache License, Version 2.0 (the "License");
esokic 0:05aad811ea07 5 * you may not use this file except in compliance with the License.
esokic 0:05aad811ea07 6 * You may obtain a copy of the License at
esokic 0:05aad811ea07 7 *
esokic 0:05aad811ea07 8 * http://www.apache.org/licenses/LICENSE-2.0
esokic 0:05aad811ea07 9 *
esokic 0:05aad811ea07 10 * Unless required by applicable law or agreed to in writing, software
esokic 0:05aad811ea07 11 * distributed under the License is distributed on an "AS IS" BASIS,
esokic 0:05aad811ea07 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
esokic 0:05aad811ea07 13 * See the License for the specific language governing permissions and
esokic 0:05aad811ea07 14 * limitations under the License.
esokic 0:05aad811ea07 15 */
esokic 0:05aad811ea07 16 #ifndef MBED_I2C_H
esokic 0:05aad811ea07 17 #define MBED_I2C_H
esokic 0:05aad811ea07 18
esokic 0:05aad811ea07 19 #include "platform.h"
esokic 0:05aad811ea07 20
esokic 0:05aad811ea07 21 #if DEVICE_I2C
esokic 0:05aad811ea07 22
esokic 0:05aad811ea07 23 #include "i2c_api.h"
esokic 0:05aad811ea07 24
esokic 0:05aad811ea07 25 namespace mbed {
esokic 0:05aad811ea07 26
esokic 0:05aad811ea07 27 /** An I2C Master, used for communicating with I2C slave devices
esokic 0:05aad811ea07 28 *
esokic 0:05aad811ea07 29 * Example:
esokic 0:05aad811ea07 30 * @code
esokic 0:05aad811ea07 31 * // Read from I2C slave at address 0x62
esokic 0:05aad811ea07 32 *
esokic 0:05aad811ea07 33 * #include "mbed.h"
esokic 0:05aad811ea07 34 *
esokic 0:05aad811ea07 35 * I2C i2c(p28, p27);
esokic 0:05aad811ea07 36 *
esokic 0:05aad811ea07 37 * int main() {
esokic 0:05aad811ea07 38 * int address = 0x62;
esokic 0:05aad811ea07 39 * char data[2];
esokic 0:05aad811ea07 40 * i2c.read(address, data, 2);
esokic 0:05aad811ea07 41 * }
esokic 0:05aad811ea07 42 * @endcode
esokic 0:05aad811ea07 43 */
esokic 0:05aad811ea07 44 class I2C {
esokic 0:05aad811ea07 45
esokic 0:05aad811ea07 46 public:
esokic 0:05aad811ea07 47 enum RxStatus {
esokic 0:05aad811ea07 48 NoData,
esokic 0:05aad811ea07 49 MasterGeneralCall,
esokic 0:05aad811ea07 50 MasterWrite,
esokic 0:05aad811ea07 51 MasterRead
esokic 0:05aad811ea07 52 };
esokic 0:05aad811ea07 53
esokic 0:05aad811ea07 54 enum Acknowledge {
esokic 0:05aad811ea07 55 NoACK = 0,
esokic 0:05aad811ea07 56 ACK = 1
esokic 0:05aad811ea07 57 };
esokic 0:05aad811ea07 58
esokic 0:05aad811ea07 59 /** Create an I2C Master interface, connected to the specified pins
esokic 0:05aad811ea07 60 *
esokic 0:05aad811ea07 61 * @param sda I2C data line pin
esokic 0:05aad811ea07 62 * @param scl I2C clock line pin
esokic 0:05aad811ea07 63 */
esokic 0:05aad811ea07 64 I2C(PinName sda, PinName scl);
esokic 0:05aad811ea07 65
esokic 0:05aad811ea07 66 /** Set the frequency of the I2C interface
esokic 0:05aad811ea07 67 *
esokic 0:05aad811ea07 68 * @param hz The bus frequency in hertz
esokic 0:05aad811ea07 69 */
esokic 0:05aad811ea07 70 void frequency(int hz);
esokic 0:05aad811ea07 71
esokic 0:05aad811ea07 72 /** Read from an I2C slave
esokic 0:05aad811ea07 73 *
esokic 0:05aad811ea07 74 * Performs a complete read transaction. The bottom bit of
esokic 0:05aad811ea07 75 * the address is forced to 1 to indicate a read.
esokic 0:05aad811ea07 76 *
esokic 0:05aad811ea07 77 * @param address 8-bit I2C slave address [ addr | 1 ]
esokic 0:05aad811ea07 78 * @param data Pointer to the byte-array to read data in to
esokic 0:05aad811ea07 79 * @param length Number of bytes to read
esokic 0:05aad811ea07 80 * @param repeated Repeated start, true - don't send stop at end
esokic 0:05aad811ea07 81 *
esokic 0:05aad811ea07 82 * @returns
esokic 0:05aad811ea07 83 * 0 on success (ack),
esokic 0:05aad811ea07 84 * non-0 on failure (nack)
esokic 0:05aad811ea07 85 */
esokic 0:05aad811ea07 86 int read(int address, char *data, int length, bool repeated = false);
esokic 0:05aad811ea07 87
esokic 0:05aad811ea07 88 /** Read a single byte from the I2C bus
esokic 0:05aad811ea07 89 *
esokic 0:05aad811ea07 90 * @param ack indicates if the byte is to be acknowledged (1 = acknowledge)
esokic 0:05aad811ea07 91 *
esokic 0:05aad811ea07 92 * @returns
esokic 0:05aad811ea07 93 * the byte read
esokic 0:05aad811ea07 94 */
esokic 0:05aad811ea07 95 int read(int ack);
esokic 0:05aad811ea07 96
esokic 0:05aad811ea07 97 /** Write to an I2C slave
esokic 0:05aad811ea07 98 *
esokic 0:05aad811ea07 99 * Performs a complete write transaction. The bottom bit of
esokic 0:05aad811ea07 100 * the address is forced to 0 to indicate a write.
esokic 0:05aad811ea07 101 *
esokic 0:05aad811ea07 102 * @param address 8-bit I2C slave address [ addr | 0 ]
esokic 0:05aad811ea07 103 * @param data Pointer to the byte-array data to send
esokic 0:05aad811ea07 104 * @param length Number of bytes to send
esokic 0:05aad811ea07 105 * @param repeated Repeated start, true - do not send stop at end
esokic 0:05aad811ea07 106 *
esokic 0:05aad811ea07 107 * @returns
esokic 0:05aad811ea07 108 * 0 on success (ack),
esokic 0:05aad811ea07 109 * non-0 on failure (nack)
esokic 0:05aad811ea07 110 */
esokic 0:05aad811ea07 111 int write(int address, const char *data, int length, bool repeated = false);
esokic 0:05aad811ea07 112
esokic 0:05aad811ea07 113 /** Write single byte out on the I2C bus
esokic 0:05aad811ea07 114 *
esokic 0:05aad811ea07 115 * @param data data to write out on bus
esokic 0:05aad811ea07 116 *
esokic 0:05aad811ea07 117 * @returns
esokic 0:05aad811ea07 118 * '1' if an ACK was received,
esokic 0:05aad811ea07 119 * '0' otherwise
esokic 0:05aad811ea07 120 */
esokic 0:05aad811ea07 121 int write(int data);
esokic 0:05aad811ea07 122
esokic 0:05aad811ea07 123 /** Creates a start condition on the I2C bus
esokic 0:05aad811ea07 124 */
esokic 0:05aad811ea07 125
esokic 0:05aad811ea07 126 void start(void);
esokic 0:05aad811ea07 127
esokic 0:05aad811ea07 128 /** Creates a stop condition on the I2C bus
esokic 0:05aad811ea07 129 */
esokic 0:05aad811ea07 130 void stop(void);
esokic 0:05aad811ea07 131
esokic 0:05aad811ea07 132 protected:
esokic 0:05aad811ea07 133 void aquire();
esokic 0:05aad811ea07 134
esokic 0:05aad811ea07 135 i2c_t _i2c;
esokic 0:05aad811ea07 136 static I2C *_owner;
esokic 0:05aad811ea07 137 int _hz;
esokic 0:05aad811ea07 138 };
esokic 0:05aad811ea07 139
esokic 0:05aad811ea07 140 } // namespace mbed
esokic 0:05aad811ea07 141
esokic 0:05aad811ea07 142 #endif
esokic 0:05aad811ea07 143
esokic 0:05aad811ea07 144 #endif