diff options
| author | hathach <[email protected]> | 2014-03-25 13:00:37 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2014-03-25 13:00:37 +0700 |
| commit | 15d0139bc5d17bb8cda5bf98c3ae5631b62f1e84 (patch) | |
| tree | 9703c2ccbfb20111720534fd1528ed8bc7875bba /tinyusb/hal/hal.h | |
| parent | 41610af72a7878ced819ac2d8044088c9a3f76cf (diff) | |
doxygen documenting
Diffstat (limited to 'tinyusb/hal/hal.h')
| -rw-r--r-- | tinyusb/hal/hal.h | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/tinyusb/hal/hal.h b/tinyusb/hal/hal.h index 8029685f0..650c16eca 100644 --- a/tinyusb/hal/hal.h +++ b/tinyusb/hal/hal.h @@ -39,15 +39,6 @@ #ifndef _TUSB_HAL_H_
#define _TUSB_HAL_H_
-/** \ingroup group_usbd
- * \ingroup group_usbh
- * \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.
- * @{ */
-
//--------------------------------------------------------------------+
// INCLUDES
//--------------------------------------------------------------------+
@@ -56,11 +47,19 @@ #include "common/tusb_errors.h"
#include "common/compiler/compiler.h"
+// callback from tusb.h
+extern void tusb_isr(uint8_t coreid);
+
//--------------------------------------------------------------------+
// HAL API
//--------------------------------------------------------------------+
-// callback from tusb.h
-extern void tusb_isr(uint8_t coreid);
+/** \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 \ref tusb_error_t type to indicate success or error condition.
|