Milen Pavlov / XRange_mbed_src

Mbed SDK for XRange SX1272 LoRa module

Dependents:   XRangePingPong XRange-LoRaWAN-lmic-app lora-transceiver

SX1272 LoRa RF module

https://www.netblocks.eu/xrange-sx1272-lora-datasheet/

api/I2C.h@339:ac6f3fd999f3, 2016-01-07 (annotated)

Committer:
netblocks
Date:
Thu Jan 07 13:01:25 2016 +0000
Revision:
339:ac6f3fd999f3
Parent:
336:1e18a06a987b 
HSE_VALUE set for XTAL 16Mhz

Who changed what in which revision?

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