diff options
| author | hathach <[email protected]> | 2018-06-18 14:05:24 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2018-06-18 14:05:24 +0700 |
| commit | 424735d44041fc478b572f973d997829b402153d (patch) | |
| tree | bc9956eee5bba55cf2f46fe49b504a6278d5b8b9 /src/tusb_hal.h | |
| parent | b96e8c6cefd0128c99ab65fe7f2909449c85092b (diff) | |
rename subfolder source to src
Diffstat (limited to 'src/tusb_hal.h')
| -rw-r--r-- | src/tusb_hal.h | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/src/tusb_hal.h b/src/tusb_hal.h new file mode 100644 index 000000000..85a2a8709 --- /dev/null +++ b/src/tusb_hal.h @@ -0,0 +1,114 @@ +/**************************************************************************/
+/*!
+ @file hal.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_HAL_H_
+#define _TUSB_HAL_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+//--------------------------------------------------------------------+
+// INCLUDES
+//--------------------------------------------------------------------+
+#include "common/tusb_common.h"
+
+//--------------------------------------------------------------------+
+// HAL API
+//--------------------------------------------------------------------+
+/** \ingroup group_mcu
+ * \defgroup group_hal Hardware Abtract Layer (HAL)
+ * Hardware Abstraction Layer (HAL) is an abstraction layer, between the physical hardware and the tinyusb stack.
+ * Its function is to hide differences in hardware from most of MCUs, so that most of the stack code does not need to be changed to
+ * run on systems with a different MCU.
+ * HAL are sets of routines that emulate some platform-specific details, giving programs direct access to the hardware resources.
+ * @{ */
+
+/** \brief Initialize USB controller hardware
+ * \returns true if succeeded
+ * \note This function is invoked by \ref tusb_init as part of the initialization.
+ */
+bool tusb_hal_init(void);
+
+/** \brief Enable USB Interrupt on a specific USB Controller
+ * \param[in] rhport is a zero-based index to identify USB controller's ID
+ */
+void tusb_hal_int_enable(uint8_t rhport);
+
+/** \brief Disable USB Interrupt on a specific USB Controller
+ * \param[in] rhport is a zero-based index to identify USB controller's ID
+ */
+void tusb_hal_int_disable(uint8_t rhport);
+
+// Only required to implement if using No RTOS (osal_none)
+uint32_t tusb_hal_millis(void);
+
+
+// Enable all ports' interrupt
+static inline void tusb_hal_int_enable_all(void)
+{
+#ifdef CFG_TUSB_RHPORT0_MODE
+ tusb_hal_int_enable(0);
+#endif
+
+#ifdef CFG_TUSB_RHPORT0_MODE
+ tusb_hal_int_enable(1);
+#endif
+}
+
+// Disable all ports' interrupt
+static inline void tusb_hal_int_disable_all(void)
+{
+#ifdef CFG_TUSB_RHPORT0_MODE
+ tusb_hal_int_disable(0);
+#endif
+
+#ifdef CFG_TUSB_RHPORT0_MODE
+ tusb_hal_int_disable(1);
+#endif
+}
+
+
+
+#ifdef __cplusplus
+ }
+#endif
+
+#endif /* _TUSB_HAL_H_ */
+
+/** @} */
|