Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/inc/drivers/MicroBitI2C.h@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MrBedfordVan 0:b9164b348919 1 /*
MrBedfordVan 0:b9164b348919 2 The MIT License (MIT)
MrBedfordVan 0:b9164b348919 3
MrBedfordVan 0:b9164b348919 4 Copyright (c) 2016 British Broadcasting Corporation.
MrBedfordVan 0:b9164b348919 5 This software is provided by Lancaster University by arrangement with the BBC.
MrBedfordVan 0:b9164b348919 6
MrBedfordVan 0:b9164b348919 7 Permission is hereby granted, free of charge, to any person obtaining a
MrBedfordVan 0:b9164b348919 8 copy of this software and associated documentation files (the "Software"),
MrBedfordVan 0:b9164b348919 9 to deal in the Software without restriction, including without limitation
MrBedfordVan 0:b9164b348919 10 the rights to use, copy, modify, merge, publish, distribute, sublicense,
MrBedfordVan 0:b9164b348919 11 and/or sell copies of the Software, and to permit persons to whom the
MrBedfordVan 0:b9164b348919 12 Software is furnished to do so, subject to the following conditions:
MrBedfordVan 0:b9164b348919 13
MrBedfordVan 0:b9164b348919 14 The above copyright notice and this permission notice shall be included in
MrBedfordVan 0:b9164b348919 15 all copies or substantial portions of the Software.
MrBedfordVan 0:b9164b348919 16
MrBedfordVan 0:b9164b348919 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
MrBedfordVan 0:b9164b348919 18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
MrBedfordVan 0:b9164b348919 19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
MrBedfordVan 0:b9164b348919 20 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
MrBedfordVan 0:b9164b348919 21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
MrBedfordVan 0:b9164b348919 22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
MrBedfordVan 0:b9164b348919 23 DEALINGS IN THE SOFTWARE.
MrBedfordVan 0:b9164b348919 24 */
MrBedfordVan 0:b9164b348919 25
MrBedfordVan 0:b9164b348919 26 #ifndef MICROBIT_I2C_H
MrBedfordVan 0:b9164b348919 27 #define MICROBIT_I2C_H
MrBedfordVan 0:b9164b348919 28
MrBedfordVan 0:b9164b348919 29 #include "mbed.h"
MrBedfordVan 0:b9164b348919 30 #include "MicroBitConfig.h"
MrBedfordVan 0:b9164b348919 31
MrBedfordVan 0:b9164b348919 32 #define MICROBIT_I2C_MAX_RETRIES 9
MrBedfordVan 0:b9164b348919 33
MrBedfordVan 0:b9164b348919 34 /**
MrBedfordVan 0:b9164b348919 35 * Class definition for MicroBitI2C.
MrBedfordVan 0:b9164b348919 36 *
MrBedfordVan 0:b9164b348919 37 * Presents a wrapped mbed call to capture failed I2C operations caused by a known silicon bug in the nrf51822.
MrBedfordVan 0:b9164b348919 38 * Attempts to automatically reset and restart the I2C hardware if this case is detected.
MrBedfordVan 0:b9164b348919 39 *
MrBedfordVan 0:b9164b348919 40 * For reference see PAN56 in:
MrBedfordVan 0:b9164b348919 41 *
MrBedfordVan 0:b9164b348919 42 * https://www.nordicsemi.com/eng/nordic/Products/nRF51822/PAN-nRF51822/24634
MrBedfordVan 0:b9164b348919 43 *
MrBedfordVan 0:b9164b348919 44 * v2.0 through to v2.4
MrBedfordVan 0:b9164b348919 45 */
MrBedfordVan 0:b9164b348919 46 class MicroBitI2C : public I2C
MrBedfordVan 0:b9164b348919 47 {
MrBedfordVan 0:b9164b348919 48 uint8_t retries;
MrBedfordVan 0:b9164b348919 49
MrBedfordVan 0:b9164b348919 50 public:
MrBedfordVan 0:b9164b348919 51
MrBedfordVan 0:b9164b348919 52 /**
MrBedfordVan 0:b9164b348919 53 * Constructor.
MrBedfordVan 0:b9164b348919 54 *
MrBedfordVan 0:b9164b348919 55 * Create an instance of MicroBitI2C for I2C communication.
MrBedfordVan 0:b9164b348919 56 *
MrBedfordVan 0:b9164b348919 57 * @param sda the Pin to be used for SDA
MrBedfordVan 0:b9164b348919 58 *
MrBedfordVan 0:b9164b348919 59 * @param scl the Pin to be used for SCL
MrBedfordVan 0:b9164b348919 60 *
MrBedfordVan 0:b9164b348919 61 * @code
MrBedfordVan 0:b9164b348919 62 * MicroBitI2C i2c(I2C_SDA0, I2C_SCL0);
MrBedfordVan 0:b9164b348919 63 * @endcode
MrBedfordVan 0:b9164b348919 64 *
MrBedfordVan 0:b9164b348919 65 * @note This class presents a wrapped mbed call to capture failed I2C operations caused by a known silicon bug in the nrf51822.
MrBedfordVan 0:b9164b348919 66 * Attempts to automatically reset and restart the I2C hardware if this case is detected.
MrBedfordVan 0:b9164b348919 67 * \par
MrBedfordVan 0:b9164b348919 68 * For reference see PAN56 in:
MrBedfordVan 0:b9164b348919 69 * \par
MrBedfordVan 0:b9164b348919 70 * https://www.nordicsemi.com/eng/nordic/Products/nRF51822/PAN-nRF51822/24634
MrBedfordVan 0:b9164b348919 71 * \par
MrBedfordVan 0:b9164b348919 72 * v2.0 through to v2.4
MrBedfordVan 0:b9164b348919 73 */
MrBedfordVan 0:b9164b348919 74 MicroBitI2C(PinName sda, PinName scl);
MrBedfordVan 0:b9164b348919 75
MrBedfordVan 0:b9164b348919 76 /**
MrBedfordVan 0:b9164b348919 77 * Performs a complete read transaction. The bottom bit of the address is forced to 1 to indicate a read.
MrBedfordVan 0:b9164b348919 78 *
MrBedfordVan 0:b9164b348919 79 * @param address 8-bit I2C slave address [ addr | 1 ]
MrBedfordVan 0:b9164b348919 80 *
MrBedfordVan 0:b9164b348919 81 * @param data A pointer to a byte buffer used for storing retrieved data.
MrBedfordVan 0:b9164b348919 82 *
MrBedfordVan 0:b9164b348919 83 * @param length Number of bytes to read.
MrBedfordVan 0:b9164b348919 84 *
MrBedfordVan 0:b9164b348919 85 * @param repeated if true, stop is not sent at the end. Defaults to false.
MrBedfordVan 0:b9164b348919 86 *
MrBedfordVan 0:b9164b348919 87 * @return MICROBIT_OK on success, MICROBIT_I2C_ERROR if an unresolved read failure is detected.
MrBedfordVan 0:b9164b348919 88 */
MrBedfordVan 0:b9164b348919 89 int read(int address, char *data, int length, bool repeated = false);
MrBedfordVan 0:b9164b348919 90
MrBedfordVan 0:b9164b348919 91 /**
MrBedfordVan 0:b9164b348919 92 * Performs a complete write transaction. The bottom bit of the address is forced to 0 to indicate a write.
MrBedfordVan 0:b9164b348919 93 *
MrBedfordVan 0:b9164b348919 94 * @param address 8-bit I2C slave address [ addr | 0 ]
MrBedfordVan 0:b9164b348919 95 *
MrBedfordVan 0:b9164b348919 96 * @param data A pointer to a byte buffer containing the data to write.
MrBedfordVan 0:b9164b348919 97 *
MrBedfordVan 0:b9164b348919 98 * @param length Number of bytes to write
MrBedfordVan 0:b9164b348919 99 *
MrBedfordVan 0:b9164b348919 100 * @param repeated if true, stop is not sent at the end. Defaults to false.
MrBedfordVan 0:b9164b348919 101 *
MrBedfordVan 0:b9164b348919 102 * @return MICROBIT_OK on success, MICROBIT_I2C_ERROR if an unresolved write failure is detected.
MrBedfordVan 0:b9164b348919 103 */
MrBedfordVan 0:b9164b348919 104 int write(int address, const char *data, int length, bool repeated = false);
MrBedfordVan 0:b9164b348919 105 };
MrBedfordVan 0:b9164b348919 106
MrBedfordVan 0:b9164b348919 107 #endif