-/*\r
- * Originally from mbed Microcontroller Library\r
- * Copyright (c) 2006-2013 ARM Limited\r
- * Copyright (c) 2014 Intel Corporation\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
- int _addr;\r
-};\r
-\r
-}\r
+/*
+ * Originally from mbed Microcontroller Library
+ * Copyright (c) 2006-2013 ARM Limited
+ * Copyright (c) 2014 Intel Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <stdio.h>
+#include <fcntl.h>
+#include "smbus.hpp"
+#include "gpio.h"
+
+namespace maa {
+
+/** An I2C Slave, used for communicating with an I2C Master device
+ *
+ * Example:
+ * @code
+ * // Simple I2C responder
+ * #include <mbed.h>
+ *
+ * I2CSlave slave(p9, p10);
+ *
+ * int main() {
+ * char buf[10];
+ * char msg[] = "Slave!";
+ *
+ * slave.address(0xA0);
+ * while (1) {
+ * int i = slave.receive();
+ * switch (i) {
+ * case I2CSlave::ReadAddressed:
+ * slave.write(msg, strlen(msg) + 1); // Includes null char
+ * break;
+ * case I2CSlave::WriteGeneral:
+ * slave.read(buf, 10);
+ * printf("Read G: %s\n", buf);
+ * break;
+ * case I2CSlave::WriteAddressed:
+ * slave.read(buf, 10);
+ * printf("Read A: %s\n", buf);
+ * break;
+ * }
+ * for(int i = 0; i < 10; i++) buf[i] = 0; // Clear buffer
+ * }
+ * }
+ * @endcode
+ */
+class I2CSlave {
+
+public:
+ enum RxStatus {
+ NoData = 0,
+ ReadAddressed = 1,
+ WriteGeneral = 2,
+ WriteAddressed = 3
+ };
+
+ /** Create an I2C Slave interface, connected to the specified pins.
+ *
+ * @param sda I2C data line pin
+ * @param scl I2C clock line pin
+ */
+ I2CSlave(unsigned int sda, unsigned int scl);
+
+ /** Set the frequency of the I2C interface
+ *
+ * @param hz The bus frequency in hertz
+ */
+ void frequency(int hz);
+
+ /** Checks to see if this I2C Slave has been addressed.
+ *
+ * @returns
+ * A status indicating if the device has been addressed, and how
+ * - NoData - the slave has not been addressed
+ * - ReadAddressed - the master has requested a read from this slave
+ * - WriteAddressed - the master is writing to this slave
+ * - WriteGeneral - the master is writing to all slave
+ */
+ int receive(void);
+
+ /** Read from an I2C master.
+ *
+ * @param data pointer to the byte array to read data in to
+ * @param length maximum number of bytes to read
+ *
+ * @returns
+ * 0 on success,
+ * non-0 otherwise
+ */
+ int read(char *data, int length);
+
+ /** Read a single byte from an I2C master.
+ *
+ * @returns
+ * the byte read
+ */
+ int read(void);
+
+ /** Write to an I2C master.
+ *
+ * @param data pointer to the byte array to be transmitted
+ * @param length the number of bytes to transmite
+ *
+ * @returns
+ * 0 on success,
+ * non-0 otherwise
+ */
+ int write(const char *data, int length);
+
+ /** Write a single byte to an I2C master.
+ *
+ * @data the byte to write
+ *
+ * @returns
+ * '1' if an ACK was received,
+ * '0' otherwise
+ */
+ int write(int data);
+
+ /** Sets the I2C slave address.
+ *
+ * @param address The address to set for the slave (ignoring the least
+ * signifcant bit). If set to 0, the slave will only respond to the
+ * general call address.
+ */
+ void address(int address);
+
+ /** Reset the I2C slave back into the known ready receiving state.
+ */
+ void stop(void);
+
+protected:
+ int _hz;
+ int i2c_handle;
+ int _addr;
+ gpio_t gpio;
+};
+
+}
projects / contrib / mraa.git / commitdiff