aboutsummaryrefslogtreecommitdiffstats
path: root/libmaple/usb.h
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-10-21 18:11:47 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-10-21 18:13:06 -0400
commit29ddb1e6bdd86284b7876b3cd1a4cb54c7eb1bd7 (patch)
tree228d1c8de8e8edf2ce94b31f4765bdb73d9a9490 /libmaple/usb.h
parenta9e628ac6fdd5ef1d775bc9e90c2475ef914b911 (diff)
downloadlibrambutan-29ddb1e6bdd86284b7876b3cd1a4cb54c7eb1bd7.tar.gz
librambutan-29ddb1e6bdd86284b7876b3cd1a4cb54c7eb1bd7.zip
usb.h: Move to libmaple/.
Apart from having an unstable API, usb.h is now a fairly good citizen of libmaple, so move it to live with the rest of the libmaple headers. Its device struct is still "struct usblib_dev". Leave that there; the asymmetry with the rest of the library is a good reminder that the API isn't really on equal footing with the rest of the library. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
Diffstat (limited to 'libmaple/usb.h')
-rw-r--r--libmaple/usb.h82
1 files changed, 82 insertions, 0 deletions
diff --git a/libmaple/usb.h b/libmaple/usb.h
new file mode 100644
index 0000000..94579ea
--- /dev/null
+++ b/libmaple/usb.h
@@ -0,0 +1,82 @@
+/******************************************************************************
+ * The MIT License
+ *
+ * Copyright (c) 2010 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.
+ *****************************************************************************/
+
+/*
+ * NOTE: This API is _unstable_ and will change drastically over time.
+ */
+
+#ifndef _USB_H_
+#define _USB_H_
+
+#include "libmaple_types.h"
+#include "rcc.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#ifndef USB_ISR_MSK
+/* Handle CTRM, WKUPM, SUSPM, ERRM, SOFM, ESOFM, RESETM */
+#define USB_ISR_MSK 0xBF00
+#endif
+
+typedef enum usb_dev_state {
+ USB_UNCONNECTED,
+ USB_ATTACHED,
+ USB_POWERED,
+ USB_SUSPENDED,
+ USB_ADDRESSED,
+ USB_CONFIGURED
+} usb_dev_state;
+
+/* Encapsulates global state formerly handled by usb_lib/ */
+typedef struct usblib_dev {
+ uint32 irq_mask;
+ void (**ep_int_in)(void);
+ void (**ep_int_out)(void);
+ usb_dev_state state;
+ rcc_clk_id clk_id;
+} usblib_dev;
+
+extern usblib_dev *USBLIB;
+
+void usb_init_usblib(usblib_dev *dev,
+ void (**ep_int_in)(void),
+ void (**ep_int_out)(void));
+
+static inline uint8 usb_is_connected(usblib_dev *dev) {
+ return dev->state != USB_UNCONNECTED;
+}
+
+static inline uint8 usb_is_configured(usblib_dev *dev) {
+ return dev->state == USB_CONFIGURED;
+}
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif