summaryrefslogtreecommitdiff
path: root/docs/getting_started.md
diff options
context:
space:
mode:
authorhathach <[email protected]>2018-12-13 15:28:04 +0700
committerGitHub <[email protected]>2018-12-13 15:28:04 +0700
commit27208ad2fdbd7af5080531eafd9a1a20515cedc1 (patch)
tree6869937edf3afe3182665c329343e6a55b99ba59 /docs/getting_started.md
parentb562fa741b5a8bb47d4e32c0a0f2600b72993b9a (diff)
parentedf885ca465e16d74833a4866951ca9aa7d4326c (diff)
Merge pull request #25 from hathach/devlocal
remove OSAL_TASK_DEF, osal_task_create
Diffstat (limited to 'docs/getting_started.md')
-rw-r--r--docs/getting_started.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/getting_started.md b/docs/getting_started.md
index 6d6091c03..723e6d862 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -37,11 +37,11 @@ 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.
-8. If you don't use any RTOSes at all, you need to continuously and/or periodically call tusb_task() function. Most of the callbacks and functionality are handled and invoke within the call of that task runner.
+8. If you don't use any RTOSes at all, you need to continuously and/or periodically call tud_task()/tuh_task() function. Most of the callbacks and functionality are handled and invoke within the call of that task runner.
~~~{.c}
int main(void)
@@ -53,7 +53,8 @@ int main(void)
{
your_application_code();
- tusb_task(); // handle tinyusb event, task etc ...
+ tud_task(); // tinyusb device task
+ tuh_task(); // tinyusb host task
}
}
~~~