summaryrefslogtreecommitdiff
path: root/src/tusb.h
diff options
context:
space:
mode:
authorhathach <[email protected]>2018-12-12 16:49:38 +0700
committerhathach <[email protected]>2018-12-12 16:49:38 +0700
commitaa17ec60d3abdc3179d4d496bc072ed633bb67ce (patch)
treecda3b554b289ab50f650aa0e7b30adb79e33be22 /src/tusb.h
parentc4a37237171855c0147699c263673c88f2fa6d5d (diff)
parent908931320e206e6ae6610cfc56b2a0950f252172 (diff)
Merge branch 'develop'
Diffstat (limited to 'src/tusb.h')
-rw-r--r--src/tusb.h141
1 files changed, 141 insertions, 0 deletions
diff --git a/src/tusb.h b/src/tusb.h
new file mode 100644
index 000000000..4d65c80e1
--- /dev/null
+++ b/src/tusb.h
@@ -0,0 +1,141 @@
+/**************************************************************************/
+/*!
+ @file tusb.h
+ @author hathach (tinyusb.org)
+
+ @section LICENSE
+
+ Software License Agreement (BSD License)
+
+ Copyright (c) 2013, hathach (tinyusb.org)
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+ 1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ 3. Neither the name of the copyright holders nor the
+ names of its contributors may be used to endorse or promote products
+ derived from this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
+ EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
+ DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION HOWEVER CAUSED AND
+ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ INCLUDING NEGLIGENCE OR OTHERWISE ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ This file is part of the tinyusb stack.
+*/
+/**************************************************************************/
+
+#ifndef _TUSB_H_
+#define _TUSB_H_
+
+#ifdef __cplusplus
+ extern "C" {
+#endif
+
+//--------------------------------------------------------------------+
+// INCLUDE
+//--------------------------------------------------------------------+
+#include "common/tusb_common.h"
+#include "tusb_hal.h"
+#include "osal/osal.h"
+#include "common/tusb_fifo.h"
+
+//------------- HOST -------------//
+#if TUSB_OPT_HOST_ENABLED
+ #include "host/usbh.h"
+
+ #if HOST_CLASS_HID
+ #include "class/hid/hid_host.h"
+ #endif
+
+ #if CFG_TUH_MSC
+ #include "class/msc/msc_host.h"
+ #endif
+
+ #if CFG_TUH_CDC
+ #include "class/cdc/cdc_host.h"
+ #endif
+
+ #if CFG_TUSB_HOST_CUSTOM_CLASS
+ #include "class/custom_host.h"
+ #endif
+
+#endif
+
+//------------- DEVICE -------------//
+#if TUSB_OPT_DEVICE_ENABLED
+ #include "device/usbd.h"
+
+ #if CFG_TUD_HID
+ #include "class/hid/hid_device.h"
+ #endif
+
+ #if CFG_TUD_CDC
+ #include "class/cdc/cdc_device.h"
+ #endif
+
+ #if CFG_TUD_MSC
+ #include "class/msc/msc_device.h"
+ #endif
+
+ #if CFG_TUD_CUSTOM_CLASS
+ #include "class/custom/custom_device.h"
+ #endif
+#endif
+
+
+//--------------------------------------------------------------------+
+// APPLICATION API
+//--------------------------------------------------------------------+
+/** \ingroup group_application_api
+ * @{ */
+
+// Initialize device/host stack according to tusb_config.h
+// return true if success
+bool tusb_init(void);
+
+#if CFG_TUSB_OS == OPT_OS_NONE
+/** \brief Run all tinyusb's internal tasks (e.g host task, device task).
+ * \note This function is only required when using no RTOS (\ref CFG_TUSB_OS == OPT_OS_NONE). All the stack functions
+ * & callback are invoked within this function. This should be called periodically within the mainloop
+ *
+ @code
+ int main(void)
+ {
+ your_init_code();
+ tusb_init();
+
+ // other config code
+
+ while(1) // the mainloop
+ {
+ your_application_code();
+
+ tusb_task(); // handle tinyusb event, task etc ...
+ }
+ }
+ @endcode
+ *
+ */
+void tusb_task(void);
+#endif
+
+/** @} */
+
+#ifdef __cplusplus
+ }
+#endif
+
+#endif /* _TUSB_H_ */
+