不韋 呂 / F746_SD_BitmapViewer

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   SDFileSystem_Warning_Fixed F746_GUI

mbed_src_STM32F7/api/I2C.h@1:bb146d5fe9aa, 2018-10-23 (annotated)

Committer:
MikamiUitOpen
Date:
Tue Oct 23 11:51:47 2018 +0000
Revision:
1:bb146d5fe9aa
Parent:
0:f62ffd3644bf 
2

Who changed what in which revision?

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