Joris Aerts / I2CX

Modified I2C api to work with NRF's dynamic pin asignment.

Dependents:   Seed_Barometer_Sensor_custom_I2C_lib

Note that the only changes are in the constructor. I tried extending the original I2C class, but could not find away to avoid the i2c_init from being called there.

I2CX.h@1:6e73259cca6e, 2014-10-22 (annotated)

Committer:
jaerts
Date:
Wed Oct 22 10:32:42 2014 +0000
Revision:
1:6e73259cca6e
Parent:
0:3d97d631d8dd
Child:
2:9d9fc94594e3
Updated example code

Who changed what in which revision?

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