Move i2c_dev and i2c_state into new i2c_common.h.

This is necessary to add series-specific infrastructure to clean up
some F1-isms in <libmaple/i2c.h>'s inline functions.

Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>

3 files changed, 84 insertions, 31 deletions

diff --git a/libmaple/include/libmaple/i2c.h b/libmaple/include/libmaple/i2c.h
index db5e6c8..d327c72 100644
--- a/libmaple/include/libmaple/i2c.h
+++ b/libmaple/include/libmaple/i2c.h
@@ -38,6 +38,8 @@ extern "C" {
 #endif
 
 #include <series/i2c.h>
+#include <libmaple/i2c_common.h>
+
 #include <libmaple/libmaple_types.h>
 #include <libmaple/rcc.h>
 #include <libmaple/nvic.h>
@@ -56,15 +58,6 @@ typedef struct i2c_reg_map {
     __io uint32 TRISE;          /**< TRISE (rise time) register */
 } i2c_reg_map;
 
-/** I2C device states */
-typedef enum i2c_state {
-    I2C_STATE_DISABLED          = 0, /**< Disabled */
-    I2C_STATE_IDLE              = 1, /**< Idle */
-    I2C_STATE_XFER_DONE         = 2, /**< Done with transfer */
-    I2C_STATE_BUSY              = 3, /**< Busy */
-    I2C_STATE_ERROR             = -1 /**< Error occurred */
-} i2c_state;
-
 /**
  * @brief I2C message type
  */
@@ -79,24 +72,6 @@ typedef struct i2c_msg {
     uint8 *data;                /**< Data */
 } i2c_msg;
 
-/**
- * @brief I2C device type.
- */
-typedef struct i2c_dev {
-    i2c_reg_map *regs;          /**< Register map */
-    i2c_msg *msg;               /**< Messages */
-    uint32 error_flags;         /**< Error flags, set on I2C error condition */
-    volatile uint32 timestamp;  /**< For internal use */
-    struct gpio_dev *gpio_port; /**< SDA, SCL pins' GPIO port */
-    uint16 msgs_left;           /**< Messages left */
-    uint8 sda_pin;              /**< SDA bit on gpio_port */
-    uint8 scl_pin;              /**< SCL bit on gpio_port */
-    rcc_clk_id clk_id;          /**< RCC clock information */
-    nvic_irq_num ev_nvic_line;  /**< Event IRQ number */
-    nvic_irq_num er_nvic_line;  /**< Error IRQ number */
-    volatile i2c_state state;   /**< Device state */
-} i2c_dev;
-
 /*
  * Register bit definitions
  */
diff --git a/libmaple/include/libmaple/i2c_common.h b/libmaple/include/libmaple/i2c_common.h
new file mode 100644
index 0000000..2f36f80
--- /dev/null
+++ b/libmaple/include/libmaple/i2c_common.h
@@ -0,0 +1,78 @@
+/******************************************************************************
+ * The MIT License
+ *
+ * Copyright (c) 2010 Perry Hung (from <libmaple/i2c.h>).
+ * Copyright (c) 2012 LeafLabs, LLC.
+ *
+ * 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.
+ *****************************************************************************/
+
+/**
+ * @file libmaple/include/libmaple/i2c_common.h
+ * @author Marti Bolivar <mbolivar@leaflabs.com>
+ * @brief This file is an implementation detail
+ *
+ * WARNING: CONTENTS UNSTABLE
+ *
+ * The existence of this file is an implementation detail.  Its
+ * contents are not stable, so never include it directly.  If you need
+ * something from here, #include <libmaple/i2c.h> instead.
+ */
+
+#ifndef _LIBMAPLE_I2C_COMMON_H_
+#define _LIBMAPLE_I2C_COMMON_H_
+
+#include <libmaple/libmaple_types.h>
+#include <libmaple/nvic.h>
+#include <libmaple/rcc.h>
+
+struct gpio_dev;
+struct i2c_reg_map;
+struct i2c_msg;
+
+/** I2C device states */
+typedef enum i2c_state {
+    I2C_STATE_DISABLED          = 0, /**< Disabled */
+    I2C_STATE_IDLE              = 1, /**< Idle */
+    I2C_STATE_XFER_DONE         = 2, /**< Done with transfer */
+    I2C_STATE_BUSY              = 3, /**< Busy */
+    I2C_STATE_ERROR             = -1 /**< Error occurred */
+} i2c_state;
+
+/**
+ * @brief I2C device type.
+ */
+typedef struct i2c_dev {
+    struct i2c_reg_map *regs;   /**< Register map */
+    struct i2c_msg *msg;        /**< Messages */
+    uint32 error_flags;         /**< Error flags, set on I2C error condition */
+    volatile uint32 timestamp;  /**< For internal use */
+    struct gpio_dev *gpio_port; /**< SDA, SCL pins' GPIO port */
+    uint16 msgs_left;           /**< Messages left */
+    uint8 sda_pin;              /**< SDA bit on gpio_port */
+    uint8 scl_pin;              /**< SCL bit on gpio_port */
+    rcc_clk_id clk_id;          /**< RCC clock information */
+    nvic_irq_num ev_nvic_line;  /**< Event IRQ number */
+    nvic_irq_num er_nvic_line;  /**< Error IRQ number */
+    volatile i2c_state state;   /**< Device state */
+} i2c_dev;
+
+#endif
diff --git a/libmaple/stm32f1/include/series/i2c.h b/libmaple/stm32f1/include/series/i2c.h
index 0e4b3ba..f9f1e43 100644
--- a/libmaple/stm32f1/include/series/i2c.h
+++ b/libmaple/stm32f1/include/series/i2c.h
@@ -33,6 +33,8 @@
 #ifndef _LIBMAPLE_STM32F1_I2C_H_
 #define _LIBMAPLE_STM32F1_I2C_H_
 
+#include <libmaple/i2c_common.h>
+
 /*
  * Register maps
  */
@@ -48,9 +50,7 @@ struct i2c_reg_map;
  * Devices
  */
 
-struct i2c_dev;
-
-extern struct i2c_dev* const I2C1;
-extern struct i2c_dev* const I2C2;
+extern i2c_dev* const I2C1;
+extern i2c_dev* const I2C2;
 
 #endif  /* _LIBMAPLE_STM32F1_I2C_H_ */