rename TUSB_CFG_OS_TICKS_PER_SECOND to TUSB_CFG_TICKS_HZ

remove CFG_TICKS_PER_SECOND

boards/board.h

@@ -106,7 +106,6 @@
 //--------------------------------------------------------------------+
 // Common Configuration
 //--------------------------------------------------------------------+
-#define CFG_TICKS_PER_SECOND 1000
 #define CFG_UART_BAUDRATE    115200
 
 //--------------------------------------------------------------------+

boards/embedded_artists/ea4357/board_ea4357.c

@@ -70,7 +70,7 @@ void board_init(void)
   CGU_Init();
 
 #if TUSB_CFG_OS == TUSB_OS_NONE // TODO may move to main.c
-  SysTick_Config(CGU_GetPCLKFrequency(CGU_PERIPHERAL_M4CORE) / CFG_TICKS_PER_SECOND); // 1 msec tick timer
+  SysTick_Config(CGU_GetPCLKFrequency(CGU_PERIPHERAL_M4CORE) / TUSB_CFG_TICKS_HZ); // 1 msec tick timer
 #endif
 
   //------------- USB -------------//

boards/hitex/board_hitex4350.c

@@ -54,7 +54,7 @@
 void board_init(void)
 {
   CGU_Init();
-  SysTick_Config(CGU_GetPCLKFrequency(CGU_PERIPHERAL_M4CORE) / CFG_TICKS_PER_SECOND); // 1 msec tick timer
+  SysTick_Config(CGU_GetPCLKFrequency(CGU_PERIPHERAL_M4CORE) / TUSB_CFG_TICKS_HZ); // 1 msec tick timer
 
   //------------- USB Bus power HOST ONLY-------------//
   // Hitex VBUS0 is P2_3

boards/keil/board_mcb4300.c

@@ -73,7 +73,7 @@ const static struct {
 void board_init(void)
 {
   CGU_Init();
-  SysTick_Config(CGU_GetPCLKFrequency(CGU_PERIPHERAL_M4CORE) / CFG_TICKS_PER_SECOND); // 1 msec tick timer
+  SysTick_Config(CGU_GetPCLKFrequency(CGU_PERIPHERAL_M4CORE) / TUSB_CFG_TICKS_HZ); // 1 msec tick timer
 
   //------------- USB Bus power HOST ONLY-------------//
   // Keil VBUS0 is P6_3

boards/lpcxpresso/board_lpclink2.c

@@ -57,7 +57,7 @@ void board_init(void)
   CGU_Init();
 
 #if TUSB_CFG_OS == TUSB_OS_NONE // TODO may move to main.c
-  SysTick_Config(CGU_GetPCLKFrequency(CGU_PERIPHERAL_M4CORE) / CFG_TICKS_PER_SECOND); // 1 msec tick timer
+  SysTick_Config(CGU_GetPCLKFrequency(CGU_PERIPHERAL_M4CORE) / TUSB_CFG_TICKS_HZ); // 1 msec tick timer
 #endif
 
   //------------- USB -------------//

boards/lpcxpresso/board_lpcxpresso1347.c

@@ -69,7 +69,7 @@ void board_init(void)
   SystemInit();
 
 #if TUSB_CFG_OS == TUSB_OS_NONE // TODO may move to main.c
-  SysTick_Config(SystemCoreClock / CFG_TICKS_PER_SECOND); // 1 msec tick timer
+  SysTick_Config(SystemCoreClock / TUSB_CFG_TICKS_HZ); // 1 msec tick timer
 #endif
 
   GPIOInit();

boards/lpcxpresso/board_lpcxpresso1769.c

@@ -68,7 +68,7 @@ void board_init(void)
   SystemInit();
 
 #if TUSB_CFG_OS == TUSB_OS_NONE // TODO may move to main.c
-  SysTick_Config(SystemCoreClock / CFG_TICKS_PER_SECOND); // 1 msec tick timer
+  SysTick_Config(SystemCoreClock / TUSB_CFG_TICKS_HZ); // 1 msec tick timer
 #endif
 
   //------------- LED -------------//

boards/microbuilder/board_lpc4357usb.c

@@ -56,7 +56,7 @@ void board_init(void)
   CGU_Init();
 
   /* Setup the systick time for 1ms ticks */
-  SysTick_Config(CGU_GetPCLKFrequency(CGU_PERIPHERAL_M4CORE) / CFG_TICKS_PER_SECOND);
+  SysTick_Config(CGU_GetPCLKFrequency(CGU_PERIPHERAL_M4CORE) / TUSB_CFG_TICKS_HZ);
 
   /* Configure LED0 as GPIO */
   scu_pinmux(BOARD_LED0_PORT, BOARD_LED0_PIN, MD_PDN, BOARD_LED0_FUNCTION);

boards/microbuilder/board_rf1ghznode.c

@@ -59,7 +59,7 @@ void board_init(void)
   SystemInit();
 
 #if TUSB_CFG_OS == TUSB_OS_NONE // TODO may move to main.c
-  SysTick_Config(SystemCoreClock / CFG_TICKS_PER_SECOND); // 1 msec tick timer
+  SysTick_Config(SystemCoreClock / TUSB_CFG_TICKS_HZ); // 1 msec tick timer
 #endif
 
   GPIOInit();

boards/ngx/board_ngx4330.c

@@ -71,7 +71,7 @@ void board_init(void)
   CGU_Init();
 
 #if TUSB_CFG_OS == TUSB_OS_NONE // TODO may move to main.c
-  SysTick_Config( CGU_GetPCLKFrequency(CGU_PERIPHERAL_M4CORE)/CFG_TICKS_PER_SECOND );	/* 1 ms Timer */
+  SysTick_Config( CGU_GetPCLKFrequency(CGU_PERIPHERAL_M4CORE)/TUSB_CFG_TICKS_HZ );	/* 1 ms Timer */
 #endif
 
   //------------- USB Bus power HOST ONLY-------------//

demos/device/src/main.c

@@ -155,7 +155,7 @@ void print_greeting(void)
 --------------------------------------------------------------------\n\n"
   );
 
-  puts("This demo supports the following classes");
+  puts("This demo supports the following classes for DEVICE");
   if (TUSB_CFG_DEVICE_HID_MOUSE    ) puts("  - HID Mouse");
   if (TUSB_CFG_DEVICE_HID_KEYBOARD ) puts("  - HID Keyboard");
   if (TUSB_CFG_DEVICE_MSC          ) puts("  - Mass Storage");

demos/device/src/tusb_config.h

@@ -72,7 +72,7 @@
 
 //#define TUSB_CFG_OS                   TUSB_OS_NONE // be passed from IDE/command line for easy project switching
 //#define TUSB_CFG_OS_TASK_PRIO                      // be passed from IDE/command line for easy project switching
-#define TUSB_CFG_OS_TICKS_PER_SECOND  1000
+#define TUSB_CFG_TICKS_HZ             1000
 
 //--------------------------------------------------------------------+
 // USB RAM PLACEMENT

demos/host/src/main.c

@@ -152,7 +152,7 @@ void print_greeting(void)
 --------------------------------------------------------------------\n"
   );
 
-  puts("This demo supports the following classes");
+  puts("This demo supports the following classes for HOST");
   if (TUSB_CFG_HOST_HUB          ) puts("  - Hub (1 level only)");
   if (TUSB_CFG_HOST_HID_MOUSE    ) puts("  - HID Mouse");
   if (TUSB_CFG_HOST_HID_KEYBOARD ) puts("  - HID Keyboard");

demos/host/src/tusb_config.h

@@ -72,7 +72,7 @@
 //#define TUSB_CFG_OS                   TUSB_OS_NONE // defined using eclipse build
 //#define TUSB_CFG_OS_TASK_PRIO                      // defined using eclipse build
 
-#define TUSB_CFG_OS_TICKS_PER_SECOND  1000
+#define TUSB_CFG_TICKS_HZ             1000
 
 //--------------------------------------------------------------------+
 // USB RAM PLACEMENT

tinyusb/osal/osal_common.h

@@ -59,11 +59,10 @@ enum
   OSAL_TIMEOUT_WAIT_FOREVER = 0x0EEEEEEE
 };
 
-// TODO refractor/remove this function and/or TUSB_CFG_OS_TICKS_PER_SECOND if using an RTOS
 static inline uint32_t osal_tick_from_msec(uint32_t msec) ATTR_CONST ATTR_ALWAYS_INLINE;
 static inline uint32_t osal_tick_from_msec(uint32_t msec)
 {
-  return  (msec * TUSB_CFG_OS_TICKS_PER_SECOND)/1000;
+  return  (msec * TUSB_CFG_TICKS_HZ)/1000;
 }
 
 #ifdef __cplusplus

tinyusb/osal/osal_freeRTOS.h

@@ -91,7 +91,7 @@ static inline tusb_error_t osal_task_create(osal_task_t *task)
 static inline void osal_task_delay(uint32_t msec) ATTR_ALWAYS_INLINE;
 static inline void osal_task_delay(uint32_t msec)
 {
-  vTaskDelay( (TUSB_CFG_OS_TICKS_PER_SECOND * msec) / 1000 );
+  vTaskDelay( (TUSB_CFG_TICKS_HZ * msec) / 1000 );
 }
 
 //--------------------------------------------------------------------+

tinyusb/tusb.c

@@ -77,7 +77,6 @@ void tusb_isr(uint8_t controller_id)
 }
 
 #if TUSB_CFG_OS == TUSB_OS_NONE
-// periodically/continuously called in the main loop
 void tusb_task_runner(void)
 {
   #if MODE_HOST_SUPPORTED

tinyusb/tusb.h

@@ -93,12 +93,39 @@
 //--------------------------------------------------------------------+
 // APPLICATION API
 //--------------------------------------------------------------------+
+/** \defgroup application_setup Application Setup
+ *  @{ */
+
+/** \brief Initialize the usb stack
+ * \return Error Code of the \ref TUSB_ERROR enum
+ * \note   Function will initialize the stack according to configuration in the configure file (tusb_config.h)
+ */
 tusb_error_t tusb_init(void);
 
 #if TUSB_CFG_OS == TUSB_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 TUSB_CFG_OS == TUSB_OS_NONE). All the stack functions
+ *         & callback are invoked within this function, so it should be called periodically within the mainloop
+ *
+    @code
+    int main(void)
+    {
+      // some init code
+      tusb_init();
+      while(1) // the mainloop
+      {
+        tusb_task_runner();
+        // other code
+      }
+    }
+    @endcode
+ *
+ */
 void tusb_task_runner(void);
 #endif
 
+/** @} */
+
 #ifdef __cplusplus
  }
 #endif

tinyusb/tusb_option.h

@@ -121,14 +121,9 @@
  #error TUSB_CFG_ATTR_USBRAM is not defined, please help me know how to place data in accessible RAM for usb controller
 #endif
 
-#if TUSB_CFG_OS == TUSB_OS_NONE
+
-  #ifndef TUSB_CFG_OS_TICKS_PER_SECOND
+#if (TUSB_CFG_OS != TUSB_OS_NONE) && !defined (TUSB_CFG_OS_TASK_PRIO)
-    #error TUSB_CFG_OS_TICKS_PER_SECOND is required to use with OS_NONE
+  #error TUSB_CFG_OS_TASK_PRIO need to be defined (hint: use the highest if possible)
-  #endif
-#else
-  #ifndef TUSB_CFG_OS_TASK_PRIO
-    #error TUSB_CFG_OS_TASK_PRIO need to be defined (hint: use the highest if possible)
-  #endif
 #endif
 
 //#ifndef TUSB_CFG_CONFIGURATION_MAX