Mike Pulice / ublox_C200Test

Integrating the ublox LISA C200 modem

Fork of SprintUSBModemHTTPClientTest by Donatien Garnier

mbed-src/api/I2C.h@5:3f93dd1d4cb3, 2013-09-26 (annotated)

Committer:
sam_grove
Date:
Thu Sep 26 00:44:20 2013 -0500
Revision:
5:3f93dd1d4cb3
Exported program and replaced contents of the repo with the source

to build and debug using keil mdk. Libs NOT upto date are lwip, lwip-sys

and socket. these have newer versions under mbed_official but were starting

from a know working point

Who changed what in which revision?

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