Vladimir Vana / mbed

pro vyuku PSS v Jecne

I2CSlave.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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