i2cslave: add i2cslave api and basic non functional implementation
authorBrendan Le Foll <brendan.le.foll@intel.com>
Fri, 11 Apr 2014 14:27:43 +0000 (15:27 +0100)
committerBrendan Le Foll <brendan.le.foll@intel.com>
Fri, 11 Apr 2014 14:27:43 +0000 (15:27 +0100)
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
api/i2cslave.h [new file with mode: 0644]
src/i2c/i2cslave.cxx [new file with mode: 0644]

diff --git a/api/i2cslave.h b/api/i2cslave.h
new file mode 100644 (file)
index 0000000..0b62a7e
--- /dev/null
@@ -0,0 +1,149 @@
+/* mbed Microcontroller Library\r
+ * Copyright (c) 2006-2013 ARM Limited\r
+ *\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ *     http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ */\r
+\r
+#pragma once\r
+\r
+#include <stdio.h>\r
+#include <fcntl.h>\r
+#include "smbus.hpp"\r
+\r
+namespace maa {\r
+\r
+/** An I2C Slave, used for communicating with an I2C Master device\r
+ *\r
+ * Example:\r
+ * @code\r
+ * // Simple I2C responder\r
+ * #include <mbed.h>\r
+ *\r
+ * I2CSlave slave(p9, p10);\r
+ *\r
+ * int main() {\r
+ *     char buf[10];\r
+ *     char msg[] = "Slave!";\r
+ *\r
+ *     slave.address(0xA0);\r
+ *     while (1) {\r
+ *         int i = slave.receive();\r
+ *         switch (i) {\r
+ *             case I2CSlave::ReadAddressed:\r
+ *                 slave.write(msg, strlen(msg) + 1); // Includes null char\r
+ *                 break;\r
+ *             case I2CSlave::WriteGeneral:\r
+ *                 slave.read(buf, 10);\r
+ *                 printf("Read G: %s\n", buf);\r
+ *                 break;\r
+ *             case I2CSlave::WriteAddressed:\r
+ *                 slave.read(buf, 10);\r
+ *                 printf("Read A: %s\n", buf);\r
+ *                 break;\r
+ *         }\r
+ *         for(int i = 0; i < 10; i++) buf[i] = 0;    // Clear buffer\r
+ *     }\r
+ * }\r
+ * @endcode\r
+ */\r
+class I2CSlave {\r
+\r
+public:\r
+    enum RxStatus {\r
+        NoData         = 0,\r
+        ReadAddressed  = 1,\r
+        WriteGeneral   = 2,\r
+        WriteAddressed = 3\r
+    };\r
+\r
+    /** Create an I2C Slave interface, connected to the specified pins.\r
+     *\r
+     *  @param sda I2C data line pin\r
+     *  @param scl I2C clock line pin\r
+     */\r
+    I2CSlave(unsigned int sda, unsigned int scl);\r
+\r
+    /** Set the frequency of the I2C interface\r
+     *\r
+     *  @param hz The bus frequency in hertz\r
+     */\r
+    void frequency(int hz);\r
+\r
+    /** Checks to see if this I2C Slave has been addressed.\r
+     *\r
+     *  @returns\r
+     *  A status indicating if the device has been addressed, and how\r
+     *  - NoData            - the slave has not been addressed\r
+     *  - ReadAddressed     - the master has requested a read from this slave\r
+     *  - WriteAddressed    - the master is writing to this slave\r
+     *  - WriteGeneral      - the master is writing to all slave\r
+     */\r
+    int receive(void);\r
+\r
+    /** Read from an I2C master.\r
+     *\r
+     *  @param data pointer to the byte array to read data in to\r
+     *  @param length maximum number of bytes to read\r
+     *\r
+     *  @returns\r
+     *       0 on success,\r
+     *   non-0 otherwise\r
+     */\r
+    int read(char *data, int length);\r
+\r
+    /** Read a single byte from an I2C master.\r
+     *\r
+     *  @returns\r
+     *    the byte read\r
+     */\r
+    int read(void);\r
+\r
+    /** Write to an I2C master.\r
+     *\r
+     *  @param data pointer to the byte array to be transmitted\r
+     *  @param length the number of bytes to transmite\r
+     *\r
+     *  @returns\r
+     *       0 on success,\r
+     *   non-0 otherwise\r
+     */\r
+    int write(const char *data, int length);\r
+\r
+    /** Write a single byte to an I2C master.\r
+     *\r
+     *  @data the byte to write\r
+     *\r
+     *  @returns\r
+     *    '1' if an ACK was received,\r
+     *    '0' otherwise\r
+     */\r
+    int write(int data);\r
+\r
+    /** Sets the I2C slave address.\r
+     *\r
+     *  @param address The address to set for the slave (ignoring the least\r
+     *  signifcant bit). If set to 0, the slave will only respond to the\r
+     *  general call address.\r
+     */\r
+    void address(int address);\r
+\r
+    /** Reset the I2C slave back into the known ready receiving state.\r
+     */\r
+    void stop(void);\r
+\r
+protected:\r
+    int _hz;\r
+    int i2c_handle;\r
+};\r
+\r
+}\r
diff --git a/src/i2c/i2cslave.cxx b/src/i2c/i2cslave.cxx
new file mode 100644 (file)
index 0000000..3c40f6a
--- /dev/null
@@ -0,0 +1,91 @@
+/*
+ * Copyright (C) Intel Corporation.
+ *
+ * Author: Brendan Le Foll
+ *                                                                                                                                                             
+ * Copyright © 2014 Intel Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include "i2cslave.h"
+
+using namespace maa;
+
+I2CSlave::I2CSlave(unsigned int sda, unsigned int scl)
+{
+    // Galileo only has one I2CSlave device which is always /dev/i2c-0
+    // reliability is a fickle friend!
+    if (i2c_handle = open("/dev/i2c-0", O_RDWR) < 1) {
+        fprintf(stderr, "Failed to open requested i2c port");
+    }
+}
+
+void
+I2CSlave::frequency(int hz)
+{
+    _hz = hz;
+}
+
+int
+I2CSlave::read(char *data, int length)
+{
+    return 0;
+}
+
+int
+I2CSlave::read(void)
+{
+    int byte;
+    if (byte = i2c_smbus_read_byte(i2c_handle) < 0) {
+        return -1;
+    }
+    return byte;
+}
+
+int
+I2CSlave::write(const char *data, int length)
+{
+    if (i2c_smbus_write_i2c_block_data(i2c_handle, data[0], length, (uint8_t*) data) < 0) {
+        fprintf(stderr, "Failed to write to I2CSlave slave\n");
+       return -1;
+    }
+    return 0;
+}
+
+int
+I2CSlave::write(int data)
+{
+    if (i2c_smbus_write_byte(i2c_handle, data) < 0) {
+        fprintf(stderr, "Failed to write to I2CSlave slave\n");
+       return -1;
+    }
+    return 0;
+}
+
+void
+I2CSlave::address(int address)
+{
+}
+
+void
+I2CSlave::stop()
+{
+}