Great renaming: use "series" instead of "family".

This is for greater consistency with the ST application notes, which
refer to migrating "across" series (e.g. F1 to F2), but compatibility
"within" a family (e.g. F1).

So:

- Move libmaple/stm32x/include/family to .../include/series/ and fix
  up includes appropriately.
- Refer to "family" headers as "series" headers in comments.
- Make similar "find and replace"-style changes to build system
  variable names and comments.
- Move support/ld/stm32/family to .../stm32/series.

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

11 files changed, 20 insertions, 20 deletions

diff --git a/libmaple/include/libmaple/flash.h b/libmaple/include/libmaple/flash.h
index 66d5b8e..97bfa26 100644
--- a/libmaple/include/libmaple/flash.h
+++ b/libmaple/include/libmaple/flash.h
@@ -47,10 +47,10 @@ extern "C"{
 #define FLASH_WAIT_STATE_6              0x6
 #define FLASH_WAIT_STATE_7              0x7
 
-/* The family header must define FLASH_SAFE_WAIT_STATES, the smallest
+/* The series header must define FLASH_SAFE_WAIT_STATES, the smallest
  * number of wait states that it is safe to use when the MCU clock is
  * at its fastest rate (not considering overclocking). */
-#include <family/flash.h>
+#include <series/flash.h>
 
 /*
  * Setup routines
diff --git a/libmaple/include/libmaple/gpio.h b/libmaple/include/libmaple/gpio.h
index e821ad4..609320f 100644
--- a/libmaple/include/libmaple/gpio.h
+++ b/libmaple/include/libmaple/gpio.h
@@ -37,11 +37,11 @@ extern "C"{
 #endif
 
 /*
- * Note: Family header must define:
- * - struct gpio_dev (and declare extern pointers to family-provided ones)
+ * Note: Series header must define:
+ * - struct gpio_dev (and declare extern pointers to series-provided ones)
  * - enum gpio_pin_mode (TODO think hard on this)
  */
-#include <family/gpio.h>
+#include <series/gpio.h>
 #include <libmaple/libmaple.h>
 
 /*
diff --git a/libmaple/include/libmaple/nvic.h b/libmaple/include/libmaple/nvic.h
index 23425df..1a1a4ed 100644
--- a/libmaple/include/libmaple/nvic.h
+++ b/libmaple/include/libmaple/nvic.h
@@ -74,18 +74,18 @@ typedef struct nvic_reg_map {
 #define NVIC_BASE                       ((struct nvic_reg_map*)0xE000E100)
 
 /*
- * Note: The family header must define enum nvic_irq_num, which gives
+ * Note: The series header must define enum nvic_irq_num, which gives
  * descriptive names to the interrupts and exceptions from NMI (-14)
- * to the largest interrupt available in the family, where the value
+ * to the largest interrupt available in the series, where the value
  * for nonnegative enumerators corresponds to its position in the
  * vector table.
  *
  * It also must define a static inline nvic_irq_disable_all(), which
- * writes 0xFFFFFFFF to all ICE registers available in the family. (We
- * place the include here to give the family header access to
+ * writes 0xFFFFFFFF to all ICE registers available in the series. (We
+ * place the include here to give the series header access to
  * NVIC_BASE, in order to let it do so).
  */
-#include <family/nvic.h>
+#include <series/nvic.h>
 
 void nvic_init(uint32 address, uint32 offset);
 void nvic_set_vector_table(uint32 address, uint32 offset);
diff --git a/libmaple/include/libmaple/rcc.h b/libmaple/include/libmaple/rcc.h
index a4b66e5..08f7c7e 100644
--- a/libmaple/include/libmaple/rcc.h
+++ b/libmaple/include/libmaple/rcc.h
@@ -37,9 +37,9 @@ extern "C"{
 #endif
 
 #include <libmaple/libmaple_types.h>
-#include <family/rcc.h>
+#include <series/rcc.h>
 
-/* Note: Beyond the usual (registers, etc.), it's up to the family
+/* Note: Beyond the usual (registers, etc.), it's up to the series
  * header to define the following types:
  *
  * - rcc_pllsrc: For each PLL source (passed to rcc_clk_init()).
@@ -49,7 +49,7 @@ extern "C"{
  * - rcc_clk_id: For each available peripheral. These are widely used
  *   as unique IDs (TODO extricate from RCC?). Peripherals which are
  *   common across families should use the same token for their
- *   rcc_clk_id in each family header.
+ *   rcc_clk_id in each series header.
  *
  * - rcc_clk_domain: For each clock domain (returned by rcc_dev_clk()).
  *
diff --git a/libmaple/include/libmaple/stm32.h b/libmaple/include/libmaple/stm32.h
index 5efb670..356a360 100644
--- a/libmaple/include/libmaple/stm32.h
+++ b/libmaple/include/libmaple/stm32.h
@@ -37,8 +37,8 @@ extern "C" {
 #endif
 
 /* Everything enclosed in the following __DOXYGEN_PREDEFINED_HACK
- * conditional block must be defined in the family header. */
-#include <family/stm32.h>
+ * conditional block must be defined in the series header. */
+#include <series/stm32.h>
 
 #ifdef __DOXYGEN_PREDEFINED_HACK
 
@@ -66,7 +66,7 @@ extern "C" {
 #define PCLK2
 
 /*
- * Family- and MCU-specific values.
+ * Series- and MCU-specific values.
  */
 
 /**
diff --git a/libmaple/rules.mk b/libmaple/rules.mk
index 3ca5b3a..f0776a7 100644
--- a/libmaple/rules.mk
+++ b/libmaple/rules.mk
@@ -4,7 +4,7 @@ dirstack_$(sp)  := $(d)
 d               := $(dir)
 BUILDDIRS       += $(BUILD_PATH)/$(d)
 
-LIBMAPLE_INCLUDES := -I$(LIBMAPLE_PATH)/include -I$(LIBMAPLE_MODULE_FAMILY)/include
+LIBMAPLE_INCLUDES := -I$(LIBMAPLE_PATH)/include -I$(LIBMAPLE_MODULE_SERIES)/include
 LIBMAPLE_PRIVATE_INCLUDES := -I$(LIBMAPLE_PATH)
 
 # Local flags
diff --git a/libmaple/stm32f1/include/family/flash.h b/libmaple/stm32f1/include/series/flash.h
index 918a434..efa608c 100644
--- a/libmaple/stm32f1/include/family/flash.h
+++ b/libmaple/stm32f1/include/series/flash.h
@@ -30,7 +30,7 @@
  *
  * Provides register map, base pointer, and register bit definitions
  * for the Flash controller on the STM32F1 line, along with
- * family-specific configuration values.
+ * series-specific configuration values.
  */
 
 #ifndef _LIBMAPLE_STM32F1_FLASH_H_
@@ -130,7 +130,7 @@ typedef struct flash_reg_map {
 #define FLASH_OBR_OPTERR                BIT(FLASH_OBR_OPTERR_BIT)
 
 /*
- * Family-specific configuration values.
+ * Series-specific configuration values.
  */
 
 #define FLASH_SAFE_WAIT_STATES          FLASH_WAIT_STATE_2
diff --git a/libmaple/stm32f1/include/family/gpio.h b/libmaple/stm32f1/include/series/gpio.h
index c10244d..c10244d 100644
--- a/libmaple/stm32f1/include/family/gpio.h
+++ b/libmaple/stm32f1/include/series/gpio.h
diff --git a/libmaple/stm32f1/include/family/nvic.h b/libmaple/stm32f1/include/series/nvic.h
index 69fd945..69fd945 100644
--- a/libmaple/stm32f1/include/family/nvic.h
+++ b/libmaple/stm32f1/include/series/nvic.h
diff --git a/libmaple/stm32f1/include/family/rcc.h b/libmaple/stm32f1/include/series/rcc.h
index 261dc5d..261dc5d 100644
--- a/libmaple/stm32f1/include/family/rcc.h
+++ b/libmaple/stm32f1/include/series/rcc.h
diff --git a/libmaple/stm32f1/include/family/stm32.h b/libmaple/stm32f1/include/series/stm32.h
index 0b77ca0..f0ca616 100644
--- a/libmaple/stm32f1/include/family/stm32.h
+++ b/libmaple/stm32f1/include/series/stm32.h
@@ -26,7 +26,7 @@
 
 /**
  * @file libmaple/stm32f1/stm32.h
- * @brief STM32F1 chip- and family-specific definitions.
+ * @brief STM32F1 chip- and series-specific definitions.
  */
 
 #ifndef _LIBMAPLE_STM32F1_H_