Yihui Xiong / mbed-src-nrf51822

customized mbed library sources for nrf51822

Dependents:   Grove_Node Potentiometer BLE_Beacon I2C_Scanner

api/I2CSlave.h@0:700cadd8b708, 2014-11-04 (annotated)

Committer:
yihui
Date:
Tue Nov 04 07:38:53 2014 +0000
Revision:
0:700cadd8b708
customized mbed-src library for nrf51822

Who changed what in which revision?

UserRevisionLine numberNew contents of line
yihui 0:700cadd8b708 1 /* mbed Microcontroller Library
yihui 0:700cadd8b708 2 * Copyright (c) 2006-2013 ARM Limited
yihui 0:700cadd8b708 3 *
yihui 0:700cadd8b708 4 * Licensed under the Apache License, Version 2.0 (the "License");
yihui 0:700cadd8b708 5 * you may not use this file except in compliance with the License.
yihui 0:700cadd8b708 6 * You may obtain a copy of the License at
yihui 0:700cadd8b708 7 *
yihui 0:700cadd8b708 8 * http://www.apache.org/licenses/LICENSE-2.0
yihui 0:700cadd8b708 9 *
yihui 0:700cadd8b708 10 * Unless required by applicable law or agreed to in writing, software
yihui 0:700cadd8b708 11 * distributed under the License is distributed on an "AS IS" BASIS,
yihui 0:700cadd8b708 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
yihui 0:700cadd8b708 13 * See the License for the specific language governing permissions and
yihui 0:700cadd8b708 14 * limitations under the License.
yihui 0:700cadd8b708 15 */
yihui 0:700cadd8b708 16 #ifndef MBED_I2C_SLAVE_H
yihui 0:700cadd8b708 17 #define MBED_I2C_SLAVE_H
yihui 0:700cadd8b708 18
yihui 0:700cadd8b708 19 #include "platform.h"
yihui 0:700cadd8b708 20
yihui 0:700cadd8b708 21 #if DEVICE_I2CSLAVE
yihui 0:700cadd8b708 22
yihui 0:700cadd8b708 23 #include "i2c_api.h"
yihui 0:700cadd8b708 24
yihui 0:700cadd8b708 25 namespace mbed {
yihui 0:700cadd8b708 26
yihui 0:700cadd8b708 27 /** An I2C Slave, used for communicating with an I2C Master device
yihui 0:700cadd8b708 28 *
yihui 0:700cadd8b708 29 * Example:
yihui 0:700cadd8b708 30 * @code
yihui 0:700cadd8b708 31 * // Simple I2C responder
yihui 0:700cadd8b708 32 * #include <mbed.h>
yihui 0:700cadd8b708 33 *
yihui 0:700cadd8b708 34 * I2CSlave slave(p9, p10);
yihui 0:700cadd8b708 35 *
yihui 0:700cadd8b708 36 * int main() {
yihui 0:700cadd8b708 37 * char buf[10];
yihui 0:700cadd8b708 38 * char msg[] = "Slave!";
yihui 0:700cadd8b708 39 *
yihui 0:700cadd8b708 40 * slave.address(0xA0);
yihui 0:700cadd8b708 41 * while (1) {
yihui 0:700cadd8b708 42 * int i = slave.receive();
yihui 0:700cadd8b708 43 * switch (i) {
yihui 0:700cadd8b708 44 * case I2CSlave::ReadAddressed:
yihui 0:700cadd8b708 45 * slave.write(msg, strlen(msg) + 1); // Includes null char
yihui 0:700cadd8b708 46 * break;
yihui 0:700cadd8b708 47 * case I2CSlave::WriteGeneral:
yihui 0:700cadd8b708 48 * slave.read(buf, 10);
yihui 0:700cadd8b708 49 * printf("Read G: %s\n", buf);
yihui 0:700cadd8b708 50 * break;
yihui 0:700cadd8b708 51 * case I2CSlave::WriteAddressed:
yihui 0:700cadd8b708 52 * slave.read(buf, 10);
yihui 0:700cadd8b708 53 * printf("Read A: %s\n", buf);
yihui 0:700cadd8b708 54 * break;
yihui 0:700cadd8b708 55 * }
yihui 0:700cadd8b708 56 * for(int i = 0; i < 10; i++) buf[i] = 0; // Clear buffer
yihui 0:700cadd8b708 57 * }
yihui 0:700cadd8b708 58 * }
yihui 0:700cadd8b708 59 * @endcode
yihui 0:700cadd8b708 60 */
yihui 0:700cadd8b708 61 class I2CSlave {
yihui 0:700cadd8b708 62
yihui 0:700cadd8b708 63 public:
yihui 0:700cadd8b708 64 enum RxStatus {
yihui 0:700cadd8b708 65 NoData = 0,
yihui 0:700cadd8b708 66 ReadAddressed = 1,
yihui 0:700cadd8b708 67 WriteGeneral = 2,
yihui 0:700cadd8b708 68 WriteAddressed = 3
yihui 0:700cadd8b708 69 };
yihui 0:700cadd8b708 70
yihui 0:700cadd8b708 71 /** Create an I2C Slave interface, connected to the specified pins.
yihui 0:700cadd8b708 72 *
yihui 0:700cadd8b708 73 * @param sda I2C data line pin
yihui 0:700cadd8b708 74 * @param scl I2C clock line pin
yihui 0:700cadd8b708 75 */
yihui 0:700cadd8b708 76 I2CSlave(PinName sda, PinName scl);
yihui 0:700cadd8b708 77
yihui 0:700cadd8b708 78 /** Set the frequency of the I2C interface
yihui 0:700cadd8b708 79 *
yihui 0:700cadd8b708 80 * @param hz The bus frequency in hertz
yihui 0:700cadd8b708 81 */
yihui 0:700cadd8b708 82 void frequency(int hz);
yihui 0:700cadd8b708 83
yihui 0:700cadd8b708 84 /** Checks to see if this I2C Slave has been addressed.
yihui 0:700cadd8b708 85 *
yihui 0:700cadd8b708 86 * @returns
yihui 0:700cadd8b708 87 * A status indicating if the device has been addressed, and how
yihui 0:700cadd8b708 88 * - NoData - the slave has not been addressed
yihui 0:700cadd8b708 89 * - ReadAddressed - the master has requested a read from this slave
yihui 0:700cadd8b708 90 * - WriteAddressed - the master is writing to this slave
yihui 0:700cadd8b708 91 * - WriteGeneral - the master is writing to all slave
yihui 0:700cadd8b708 92 */
yihui 0:700cadd8b708 93 int receive(void);
yihui 0:700cadd8b708 94
yihui 0:700cadd8b708 95 /** Read from an I2C master.
yihui 0:700cadd8b708 96 *
yihui 0:700cadd8b708 97 * @param data pointer to the byte array to read data in to
yihui 0:700cadd8b708 98 * @param length maximum number of bytes to read
yihui 0:700cadd8b708 99 *
yihui 0:700cadd8b708 100 * @returns
yihui 0:700cadd8b708 101 * 0 on success,
yihui 0:700cadd8b708 102 * non-0 otherwise
yihui 0:700cadd8b708 103 */
yihui 0:700cadd8b708 104 int read(char *data, int length);
yihui 0:700cadd8b708 105
yihui 0:700cadd8b708 106 /** Read a single byte from an I2C master.
yihui 0:700cadd8b708 107 *
yihui 0:700cadd8b708 108 * @returns
yihui 0:700cadd8b708 109 * the byte read
yihui 0:700cadd8b708 110 */
yihui 0:700cadd8b708 111 int read(void);
yihui 0:700cadd8b708 112
yihui 0:700cadd8b708 113 /** Write to an I2C master.
yihui 0:700cadd8b708 114 *
yihui 0:700cadd8b708 115 * @param data pointer to the byte array to be transmitted
yihui 0:700cadd8b708 116 * @param length the number of bytes to transmite
yihui 0:700cadd8b708 117 *
yihui 0:700cadd8b708 118 * @returns
yihui 0:700cadd8b708 119 * 0 on success,
yihui 0:700cadd8b708 120 * non-0 otherwise
yihui 0:700cadd8b708 121 */
yihui 0:700cadd8b708 122 int write(const char *data, int length);
yihui 0:700cadd8b708 123
yihui 0:700cadd8b708 124 /** Write a single byte to an I2C master.
yihui 0:700cadd8b708 125 *
yihui 0:700cadd8b708 126 * @data the byte to write
yihui 0:700cadd8b708 127 *
yihui 0:700cadd8b708 128 * @returns
yihui 0:700cadd8b708 129 * '1' if an ACK was received,
yihui 0:700cadd8b708 130 * '0' otherwise
yihui 0:700cadd8b708 131 */
yihui 0:700cadd8b708 132 int write(int data);
yihui 0:700cadd8b708 133
yihui 0:700cadd8b708 134 /** Sets the I2C slave address.
yihui 0:700cadd8b708 135 *
yihui 0:700cadd8b708 136 * @param address The address to set for the slave (ignoring the least
yihui 0:700cadd8b708 137 * signifcant bit). If set to 0, the slave will only respond to the
yihui 0:700cadd8b708 138 * general call address.
yihui 0:700cadd8b708 139 */
yihui 0:700cadd8b708 140 void address(int address);
yihui 0:700cadd8b708 141
yihui 0:700cadd8b708 142 /** Reset the I2C slave back into the known ready receiving state.
yihui 0:700cadd8b708 143 */
yihui 0:700cadd8b708 144 void stop(void);
yihui 0:700cadd8b708 145
yihui 0:700cadd8b708 146 protected:
yihui 0:700cadd8b708 147 i2c_t _i2c;
yihui 0:700cadd8b708 148 };
yihui 0:700cadd8b708 149
yihui 0:700cadd8b708 150 } // namespace mbed
yihui 0:700cadd8b708 151
yihui 0:700cadd8b708 152 #endif
yihui 0:700cadd8b708 153
yihui 0:700cadd8b708 154 #endif