Vladimir Vana / mbed

pro vyuku PSS v Jecne

I2C.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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