summaryrefslogtreecommitdiff
path: root/doxygen
diff options
context:
space:
mode:
authorhathach <[email protected]>2018-04-10 14:31:11 +0700
committerhathach <[email protected]>2018-04-10 14:31:11 +0700
commit3c2467196070eeedd4171e183db04fb815677246 (patch)
tree742e3f277776b025ee0f90ab63ef2f70a3b3d03a /doxygen
parent3473c71a6a7cb22cb45f368dba4edda49ed8f7af (diff)
mass rename TUSB_CFG to CFG_TUSB
Diffstat (limited to 'doxygen')
-rw-r--r--doxygen/configuration.txt48
-rw-r--r--doxygen/getting_started.md2
-rw-r--r--doxygen/started_demo.md2
3 files changed, 26 insertions, 26 deletions
diff --git a/doxygen/configuration.txt b/doxygen/configuration.txt
index c84eea76e..8f5887718 100644
--- a/doxygen/configuration.txt
+++ b/doxygen/configuration.txt
@@ -7,46 +7,46 @@
/// \brief tell the stack which mode (host/device/otg) the usb controller0 will be operated on. Possible value is
/// from \ref group_mode. Note the hardware usb controller must support the selected mode.
-#define TUSB_CFG_CONTROLLER_0_MODE
+#define CFG_TUSB_CONTROLLER_0_MODE
/** USB controller in MCU often has limited access to specific RAM section. The Stack will use this macro to place internal variables
- into the USB RAM section as follows. if your mcu's usb controller has no such limit, define TUSB_CFG_ATTR_USBRAM as empty macro.
+ into the USB RAM section as follows. if your mcu's usb controller has no such limit, define CFG_TUSB_ATTR_USBRAM as empty macro.
@code
- TUSB_CFG_ATTR_USBRAM uint8_t usb_xfer_buffer[10];
+ CFG_TUSB_ATTR_USBRAM uint8_t usb_xfer_buffer[10];
@endcode
*/
-#define TUSB_CFG_ATTR_USBRAM
+#define CFG_TUSB_ATTR_USBRAM
-#define TUSB_CFG_MCU ///< Select one of the supported MCU, the value must be from \ref group_mcu
-#define TUSB_CFG_OS ///< Select one of the supported RTOS, the value must be from \ref group_supported_os.
-#define TUSB_CFG_OS_TASK_PRIO ///< If \ref TUSB_CFG_OS is configured to use a real RTOS (other than TUSB_OS_NONE). This determines the priority of the usb stack task.
-#define TUSB_CFG_TICKS_HZ ///< The rate ticks in hert. This is used in conjunction with \ref tusb_tick_get to calculate timing.
+#define CFG_TUSB_MCU ///< Select one of the supported MCU, the value must be from \ref group_mcu
+#define CFG_TUSB_OS ///< Select one of the supported RTOS, the value must be from \ref group_supported_os.
+#define CFG_TUSB_OS_TASK_PRIO ///< If \ref CFG_TUSB_OS is configured to use a real RTOS (other than TUSB_OS_NONE). This determines the priority of the usb stack task.
+#define CFG_TUSB_TICKS_HZ ///< The rate ticks in hert. This is used in conjunction with \ref tusb_tick_get to calculate timing.
//--------------------------------------------------------------------+
// HOST CONFIGURATION
//--------------------------------------------------------------------+
-/** \defgroup TUSB_CFG_HOST Host Options
+/** \defgroup CFG_TUSB_HOST Host Options
* @{ */
/** \brief Maximum number of device host stack can manage
* \n If hub class is not enabled, set this equal to number of controllers in host mode
* \n If hub class is enabled, make sure hub is also counted */
-#define TUSB_CFG_HOST_DEVICE_MAX
+#define CFG_TUSB_HOST_DEVICE_MAX
/// \brief Buffer size used for getting device configuration descriptor. You may want to increase this from default (256)
/// to support lengthy composite device especially with Audio or Video class
-#define TUSB_CFG_HOST_ENUM_BUFFER_SIZE
+#define CFG_TUSB_HOST_ENUM_BUFFER_SIZE
/** \defgroup config_host_class Class Driver
* \brief For each Class Driver a value of 1 means enable, value of 0 mean disable
* @{ */
-#define TUSB_CFG_HOST_HUB ///< Enable Hub Class
-#define TUSB_CFG_HOST_HID_KEYBOARD ///< Enable HID Class for Keyboard
-#define TUSB_CFG_HOST_HID_MOUSE ///< Enable HID Class for Mouse
-#define TUSB_CFG_HOST_HID_GENERIC ///< Enable HID Class for Generic (not supported yet)
-#define TUSB_CFG_HOST_MSC ///< Enable Mass Storage Class (SCSI subclass only)
-#define TUSB_CFG_HOST_CDC ///< Enable Virtual Serial (Communication Device Class)
+#define CFG_TUSB_HOST_HUB ///< Enable Hub Class
+#define CFG_TUSB_HOST_HID_KEYBOARD ///< Enable HID Class for Keyboard
+#define CFG_TUSB_HOST_HID_MOUSE ///< Enable HID Class for Mouse
+#define CFG_TUSB_HOST_HID_GENERIC ///< Enable HID Class for Generic (not supported yet)
+#define CFG_TUSB_HOST_MSC ///< Enable Mass Storage Class (SCSI subclass only)
+#define CFG_TUSB_HOST_CDC ///< Enable Virtual Serial (Communication Device Class)
/** @} */
/** @} */ // group Host
@@ -54,10 +54,10 @@
//--------------------------------------------------------------------+
// DEVICE CONFIGURATION
//--------------------------------------------------------------------+
-/** \defgroup TUSB_CFG_DEVICE Device Options
+/** \defgroup CFG_TUSB_DEVICE Device Options
* @{ */
-#define TUSB_CFG_DEVICE_CONTROL_ENDOINT_SIZE ///< Max packet size of Cotnrol Endpoint, default is 64
+#define CFG_TUSB_DEVICE_CONTROL_ENDOINT_SIZE ///< Max packet size of Cotnrol Endpoint, default is 64
/// Application MUST define this variable and initialize its pointers's member to all required USB descriptors including
/// Device Descriptor, Configuration Descriptor, String Descriptors, HID Report Descriptors etc ...
@@ -66,11 +66,11 @@ tusbd_descriptor_pointer_t tusbd_descriptor_pointers;
/** \defgroup config_device_class Class Driver
* \brief For each Class Driver a value of 1 means enable, value of 0 mean disable
* @{ */
-#define TUSB_CFG_DEVICE_HID_KEYBOARD ///< Enable HID Class for Keyboard
-#define TUSB_CFG_DEVICE_HID_MOUSE ///< Enable HID Class for Mouse
-#define TUSB_CFG_DEVICE_HID_GENERIC ///< Enable HID Class for Generic (not supported yet)
-#define TUSB_CFG_DEVICE_MSC ///< Enable Mass Storage Class (SCSI subclass only)
-#define TUSB_CFG_DEVICE_CDC ///< Enable Virtual Serial (Communication Device Class)
+#define CFG_TUSB_DEVICE_HID_KEYBOARD ///< Enable HID Class for Keyboard
+#define CFG_TUSB_DEVICE_HID_MOUSE ///< Enable HID Class for Mouse
+#define CFG_TUSB_DEVICE_HID_GENERIC ///< Enable HID Class for Generic (not supported yet)
+#define CFG_TUSB_DEVICE_MSC ///< Enable Mass Storage Class (SCSI subclass only)
+#define CFG_TUSB_DEVICE_CDC ///< Enable Virtual Serial (Communication Device Class)
/** @} */
/** @} */ // group Device
diff --git a/doxygen/getting_started.md b/doxygen/getting_started.md
index d58634845..79bc8f01f 100644
--- a/doxygen/getting_started.md
+++ b/doxygen/getting_started.md
@@ -35,7 +35,7 @@ It is relatively simple to incorporate tinyusb to your (existing) project
1. Copy core folder **tinyusb** to your project. Let's say it is *your_project/tinyusb*
2. Add all the .c in the core folder to your project settings (uvproj, ewp, makefile)
3. Add *your_project/tinysb* to your include path. Also make sure your current include path also contains the configuration file tusb_config.h. Or you could simply put the tusb_config.h into the tinyusb folder as well.
-4. Make sure all required macros are all defined properly in tusb_config.h (configure file in demo application is sufficient, but you need to add a few more such as TUSB_CFG_MCU, TUSB_CFG_OS, TUSB_CFG_OS_TASK_PRIO since they are passed by IDE/compiler to maintain a unique configure for all demo projects).
+4. Make sure all required macros are all defined properly in tusb_config.h (configure file in demo application is sufficient, but you need to add a few more such as CFG_TUSB_MCU, CFG_TUSB_OS, CFG_TUSB_OS_TASK_PRIO since they are passed by IDE/compiler to maintain a unique configure for all demo projects).
5. If you use the device stack, make sure you have created/modified usb descriptors for your own need. Ultimately you need to fill out required pointers in tusbd_descriptor_pointers for that stack to work.
6. Add tusb_init() call to your reset initialization code.
7. Implement all enabled classes's callbacks.
diff --git a/doxygen/started_demo.md b/doxygen/started_demo.md
index 287c55731..7e82596f5 100644
--- a/doxygen/started_demo.md
+++ b/doxygen/started_demo.md
@@ -34,7 +34,7 @@ void led_blinking_task( void * p_task_para )
static uint32_t led_on_mask = 0;
// FreeRTOS API's vTaskDelay is used in place of osal_task_delay. Note it takes input parameter in tick
- vTaskDelay( (led_blink_interval_ms * TUSB_CFG_TICKS_HZ) / 1000);
+ vTaskDelay( (led_blink_interval_ms * CFG_TUSB_TICKS_HZ) / 1000);
board_leds(led_on_mask, 1 - led_on_mask);
led_on_mask = 1 - led_on_mask; // toggle