Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

I2CSlave.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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