summaryrefslogtreecommitdiff
path: root/docs/getting_started.md
diff options
context:
space:
mode:
authorhathach <[email protected]>2020-04-01 20:56:46 +0700
committerhathach <[email protected]>2020-04-01 20:56:46 +0700
commitff9ceb65d2c5033e80aaa795b508cdff6356b14b (patch)
treec94b20fd114c1d0dea54a310935695309b31ae3a /docs/getting_started.md
parent19f977a27489fb54c3bf1e392826fa76bec49d5f (diff)
doc update
Diffstat (limited to 'docs/getting_started.md')
-rw-r--r--docs/getting_started.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/getting_started.md b/docs/getting_started.md
index 123a9d2ab..588c879f1 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -17,11 +17,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 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.
+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 boards).
+5. If you use the device stack, make sure you have created/modified usb descriptors for your own need. Ultimately you need to implement all **tud_descriptor_** callbacks 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 tud_task()/tuh_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. All of the callbacks and functionality are handled and invoke within the call of that task runner.
~~~{.c}
int main(void)