summaryrefslogtreecommitdiff
path: root/docs/getting_started.md
diff options
context:
space:
mode:
authorhathach <[email protected]>2018-12-13 13:49:09 +0700
committerhathach <[email protected]>2018-12-13 13:49:09 +0700
commitbc46dc6edf3ff4bb72fb36e74b8a7d3da447d2d4 (patch)
treefc8042f6113d6dc224543d00578759eb6a0c60f4 /docs/getting_started.md
parentb562fa741b5a8bb47d4e32c0a0f2600b72993b9a (diff)
osal clean up
remove OSAL_TASK_DEF, osal_task_create. Applicaton should create a task and call tinyusb_task(). This make API consistent with NO OS.
Diffstat (limited to 'docs/getting_started.md')
-rw-r--r--docs/getting_started.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/getting_started.md b/docs/getting_started.md
index 6d6091c03..268811ff4 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -37,7 +37,7 @@ It is relatively simple to incorporate tinyusb to your (existing) project
1. Copy or `git submodule` this repo into your project in a subfolder. Let's say it is *your_project/tinyusb*
2. Add all the .c in the src 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 CFG_TUSB_MCU, CFG_TUSB_OS, CFG_TUD_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 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.