cleanup: Remove device-specific stuff from include/usb.h

This moves the STM32-specific code out of the common header file
and into the chip directory where it belongs. Note that this
doesn't actually change the code for non-STM32 SoCs; that will
happen in a separate CL for clarity.

BUG=chrome-os-partner:40693
BRANCH=none
TEST=make buildall

Change-Id: Ifdf0086e86a1088fb011b9ac4d6c70ab8da47aec
Signed-off-by: Bill Richardson <wfrichar@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/273577
Reviewed-by: Randall Spangler <rspangler@chromium.org>

3 files changed, 172 insertions, 72 deletions

diff --git a/chip/g/usb_hw.h b/chip/g/usb_hw.h
new file mode 100644
index 0000000000..b44a33dcac
--- /dev/null
+++ b/chip/g/usb_hw.h
@@ -0,0 +1,85 @@
+/* Copyright 2015 The Chromium OS Authors. All rights reserved.
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#ifndef __CROS_EC_USB_HW_H
+#define __CROS_EC_USB_HW_H
+
+/*
+ * The STM32 has dedicated USB RAM visible on the APB1 bus (so all reads &
+ * writes are 16-bits wide). The endpoint tables and the data buffers live in
+ * this RAM.
+*/
+
+/* Primitive to access the words in USB RAM */
+typedef CONFIG_USB_RAM_ACCESS_TYPE usb_uint;
+/* Linker symbol for start of USB RAM */
+extern usb_uint __usb_ram_start[];
+
+/* Attribute to define a buffer variable in USB RAM */
+#define __usb_ram __attribute__((section(".usb_ram.data")))
+
+struct stm32_endpoint {
+	volatile usb_uint tx_addr;
+	volatile usb_uint tx_count;
+	volatile usb_uint rx_addr;
+	volatile usb_uint rx_count;
+};
+
+extern struct stm32_endpoint btable_ep[];
+
+/* Attribute to put the endpoint table in USB RAM */
+#define __usb_btable __attribute__((section(".usb_ram.btable")))
+
+/* Read from USB RAM into a usb_setup_packet struct */
+struct usb_setup_packet;
+void usb_read_setup_packet(usb_uint *buffer, struct usb_setup_packet *packet);
+
+/*
+ * Copy data to and from the USB dedicated RAM and take care of the weird
+ * addressing.  These functions correctly handle unaligned accesses to the USB
+ * memory.  They have the same prototype as memcpy, allowing them to be used
+ * in places that expect memcpy.  The void pointer used to represent a location
+ * in the USB dedicated RAM should be the offset in that address space, not the
+ * AHB address space.
+ *
+ * The USB packet RAM is attached to the processor via the AHB2APB bridge.  This
+ * bridge performs manipulations of read and write accesses as per the note in
+ * section 2.1 of RM0091.  The upshot is that custom memcpy-like routines need
+ * to be employed.
+ */
+void *memcpy_to_usbram(void *dest, const void *src, size_t n);
+void *memcpy_from_usbram(void *dest, const void *src, size_t n);
+
+/* Compute the address inside dedicate SRAM for the USB controller */
+#define usb_sram_addr(x) ((x - __usb_ram_start) * sizeof(uint16_t))
+
+/* Helpers for endpoint declaration */
+#define _EP_HANDLER2(num, suffix) CONCAT3(ep_, num, suffix)
+#define _EP_TX_HANDLER(num) _EP_HANDLER2(num, _tx)
+#define _EP_RX_HANDLER(num) _EP_HANDLER2(num, _rx)
+#define _EP_RESET_HANDLER(num) _EP_HANDLER2(num, _rst)
+
+#define USB_DECLARE_EP(num, tx_handler, rx_handler, rst_handler)  \
+	void _EP_TX_HANDLER(num)(void)				  \
+		__attribute__ ((alias(STRINGIFY(tx_handler))));	  \
+	void _EP_RX_HANDLER(num)(void)                            \
+		__attribute__ ((alias(STRINGIFY(rx_handler))));	  \
+	void _EP_RESET_HANDLER(num)(void)                         \
+		__attribute__ ((alias(STRINGIFY(rst_handler))));
+
+/* arrays with all endpoint callbacks */
+extern void (*usb_ep_tx[]) (void);
+extern void (*usb_ep_rx[]) (void);
+extern void (*usb_ep_reset[]) (void);
+/* array with interface-specific control request callbacks */
+extern int (*usb_iface_request[]) (usb_uint *ep0_buf_rx, usb_uint *ep0_buf_tx);
+
+#define _IFACE_HANDLER(num) CONCAT3(iface_, num, _request)
+#define USB_DECLARE_IFACE(num, handler)					\
+	int _IFACE_HANDLER(num)(usb_uint *ep0_buf_rx,			\
+			       usb_uint *epo_buf_tx)			\
+	__attribute__ ((alias(STRINGIFY(handler))));
+
+#endif	/* __CROS_EC_USB_HW_H */
diff --git a/chip/stm32/usb_hw.h b/chip/stm32/usb_hw.h
new file mode 100644
index 0000000000..b44a33dcac
--- /dev/null
+++ b/chip/stm32/usb_hw.h
@@ -0,0 +1,85 @@
+/* Copyright 2015 The Chromium OS Authors. All rights reserved.
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#ifndef __CROS_EC_USB_HW_H
+#define __CROS_EC_USB_HW_H
+
+/*
+ * The STM32 has dedicated USB RAM visible on the APB1 bus (so all reads &
+ * writes are 16-bits wide). The endpoint tables and the data buffers live in
+ * this RAM.
+*/
+
+/* Primitive to access the words in USB RAM */
+typedef CONFIG_USB_RAM_ACCESS_TYPE usb_uint;
+/* Linker symbol for start of USB RAM */
+extern usb_uint __usb_ram_start[];
+
+/* Attribute to define a buffer variable in USB RAM */
+#define __usb_ram __attribute__((section(".usb_ram.data")))
+
+struct stm32_endpoint {
+	volatile usb_uint tx_addr;
+	volatile usb_uint tx_count;
+	volatile usb_uint rx_addr;
+	volatile usb_uint rx_count;
+};
+
+extern struct stm32_endpoint btable_ep[];
+
+/* Attribute to put the endpoint table in USB RAM */
+#define __usb_btable __attribute__((section(".usb_ram.btable")))
+
+/* Read from USB RAM into a usb_setup_packet struct */
+struct usb_setup_packet;
+void usb_read_setup_packet(usb_uint *buffer, struct usb_setup_packet *packet);
+
+/*
+ * Copy data to and from the USB dedicated RAM and take care of the weird
+ * addressing.  These functions correctly handle unaligned accesses to the USB
+ * memory.  They have the same prototype as memcpy, allowing them to be used
+ * in places that expect memcpy.  The void pointer used to represent a location
+ * in the USB dedicated RAM should be the offset in that address space, not the
+ * AHB address space.
+ *
+ * The USB packet RAM is attached to the processor via the AHB2APB bridge.  This
+ * bridge performs manipulations of read and write accesses as per the note in
+ * section 2.1 of RM0091.  The upshot is that custom memcpy-like routines need
+ * to be employed.
+ */
+void *memcpy_to_usbram(void *dest, const void *src, size_t n);
+void *memcpy_from_usbram(void *dest, const void *src, size_t n);
+
+/* Compute the address inside dedicate SRAM for the USB controller */
+#define usb_sram_addr(x) ((x - __usb_ram_start) * sizeof(uint16_t))
+
+/* Helpers for endpoint declaration */
+#define _EP_HANDLER2(num, suffix) CONCAT3(ep_, num, suffix)
+#define _EP_TX_HANDLER(num) _EP_HANDLER2(num, _tx)
+#define _EP_RX_HANDLER(num) _EP_HANDLER2(num, _rx)
+#define _EP_RESET_HANDLER(num) _EP_HANDLER2(num, _rst)
+
+#define USB_DECLARE_EP(num, tx_handler, rx_handler, rst_handler)  \
+	void _EP_TX_HANDLER(num)(void)				  \
+		__attribute__ ((alias(STRINGIFY(tx_handler))));	  \
+	void _EP_RX_HANDLER(num)(void)                            \
+		__attribute__ ((alias(STRINGIFY(rx_handler))));	  \
+	void _EP_RESET_HANDLER(num)(void)                         \
+		__attribute__ ((alias(STRINGIFY(rst_handler))));
+
+/* arrays with all endpoint callbacks */
+extern void (*usb_ep_tx[]) (void);
+extern void (*usb_ep_rx[]) (void);
+extern void (*usb_ep_reset[]) (void);
+/* array with interface-specific control request callbacks */
+extern int (*usb_iface_request[]) (usb_uint *ep0_buf_rx, usb_uint *ep0_buf_tx);
+
+#define _IFACE_HANDLER(num) CONCAT3(iface_, num, _request)
+#define USB_DECLARE_IFACE(num, handler)					\
+	int _IFACE_HANDLER(num)(usb_uint *ep0_buf_rx,			\
+			       usb_uint *epo_buf_tx)			\
+	__attribute__ ((alias(STRINGIFY(handler))));
+
+#endif	/* __CROS_EC_USB_HW_H */
diff --git a/include/usb.h b/include/usb.h
index 4bffb611d1..1eb60ec18c 100644
--- a/include/usb.h
+++ b/include/usb.h
@@ -11,6 +11,7 @@
 #include <stddef.h> /* for wchar_t */
 
 #include "usb_api.h"
+#include "usb_hw.h"
 
 #define USB_MAX_PACKET_SIZE 64
 
@@ -226,61 +227,18 @@ struct usb_setup_packet {
 		WIDESTR(str) \
 	}
 
-
+/* Use these macros for declaring descriptors, to order them properly */
 #define USB_CONF_DESC(name) CONCAT2(usb_desc_, name) \
 	 __attribute__((section(".rodata.usb_desc_" STRINGIFY(name))))
-
-/* build descriptor names to order them properly */
 #define USB_IFACE_DESC(num) USB_CONF_DESC(CONCAT3(iface, num, _0iface))
 #define USB_EP_DESC(i, num) USB_CONF_DESC(CONCAT4(iface, i, _1ep, num))
 #define USB_CUSTOM_DESC(i, name) USB_CONF_DESC(CONCAT4(iface, i, _2, name))
 
-/* Helpers for managing the USB controller dedicated RAM */
-
-/* primitive to access the words in USB RAM */
-typedef CONFIG_USB_RAM_ACCESS_TYPE usb_uint;
-
 /* USB Linker data */
 extern const uint8_t __usb_desc[];
 extern const uint8_t __usb_desc_end[];
-extern usb_uint __usb_ram_start[];
-
 #define USB_DESC_SIZE (__usb_desc_end - __usb_desc)
 
-struct stm32_endpoint {
-	volatile usb_uint tx_addr;
-	volatile usb_uint tx_count;
-	volatile usb_uint rx_addr;
-	volatile usb_uint rx_count;
-};
-
-/* attribute to define a variable in USB RAM */
-#define __usb_ram __attribute__((section(".usb_ram.data")))
-
-extern struct stm32_endpoint btable_ep[];
-
-/* Read from USB RAM into a usb_setup_packet struct */
-void usb_read_setup_packet(usb_uint *buffer, struct usb_setup_packet *packet);
-
-/*
- * Copy data to and from the USB dedicated RAM and take care of the weird
- * addressing.  These functions correctly handle unaligned accesses to the USB
- * memory.  They have the same prototype as memcpy, allowing them to be used
- * in places that expect memcpy.  The void pointer used to represent a location
- * in the USB dedicated RAM should be the offset in that address space, not the
- * AHB address space.
- *
- * The USB packet RAM is attached to the processor via the AHB2APB bridge.  This
- * bridge performs manipulations of read and write accesses as per the note in
- * section 2.1 of RM0091.  The upshot is that custom memcpy like routines need
- * to be employed.
- */
-void *memcpy_to_usbram(void *dest, const void *src, size_t n);
-void *memcpy_from_usbram(void *dest, const void *src, size_t n);
-
-/* Compute the address inside dedicate SRAM for the USB controller */
-#define usb_sram_addr(x) ((x - __usb_ram_start) * sizeof(uint16_t))
-
 /* These descriptors defined in board code */
 extern const void * const usb_strings[];
 extern const uint8_t usb_string_desc[];
@@ -288,32 +246,4 @@ extern const uint8_t usb_string_desc[];
 extern const void * const usb_fw_version;
 extern const struct bos_context bos_ctx;
 
-/* Helpers for endpoint declaration */
-
-#define EP_HANDLER2(num, suffix) CONCAT3(ep_, num, suffix)
-#define EP_TX_HANDLER(num) EP_HANDLER2(num, _tx)
-#define EP_RX_HANDLER(num) EP_HANDLER2(num, _rx)
-#define EP_RESET_HANDLER(num) EP_HANDLER2(num, _rst)
-
-#define USB_DECLARE_EP(num, tx_handler, rx_handler, rst_handler) \
-	void EP_TX_HANDLER(num)(void)                            \
-		__attribute__ ((alias(STRINGIFY(tx_handler))));  \
-	void EP_RX_HANDLER(num)(void)                            \
-		__attribute__ ((alias(STRINGIFY(rx_handler))));  \
-	void EP_RESET_HANDLER(num)(void)                         \
-		__attribute__ ((alias(STRINGIFY(rst_handler))));
-
-/* arrays with all endpoint callbacks */
-extern void (*usb_ep_tx[]) (void);
-extern void (*usb_ep_rx[]) (void);
-extern void (*usb_ep_reset[]) (void);
-/* array with interface-specific control request callbacks */
-extern int (*usb_iface_request[]) (usb_uint *ep0_buf_rx, usb_uint *ep0_buf_tx);
-
-#define IFACE_HANDLER(num) CONCAT3(iface_, num, _request)
-#define USB_DECLARE_IFACE(num, handler)					\
-	int IFACE_HANDLER(num)(usb_uint *ep0_buf_rx,			\
-			       usb_uint *epo_buf_tx)			\
-	__attribute__ ((alias(STRINGIFY(handler))));
-
 #endif /* USB_H */