summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorhathach <[email protected]>2020-11-07 23:43:39 +0700
committerhathach <[email protected]>2020-11-07 23:43:39 +0700
commit23b6b66f4daa128c2bfce3559a71a737868e142a (patch)
treea164399d37ba27ae6bb921fdc7b1ba9d1fddaaa4 /docs
parenta708ab62540cf952048c97e6952bd95fdc823d90 (diff)
release 0.7.0 with changelog and doc update0.7.0
Diffstat (limited to 'docs')
-rw-r--r--docs/getting_started.md21
1 files changed, 11 insertions, 10 deletions
diff --git a/docs/getting_started.md b/docs/getting_started.md
index 8d22a3127..06dcbd136 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -4,14 +4,15 @@
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 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. All of the callbacks and functionality are handled and invoke within the call of that task runner.
+- Copy or `git submodule` this repo into your project in a subfolder. Let's say it is *your_project/tinyusb*
+- Add all the .c in the `tinyusb/src` folder to your project
+- Add *your_project/tinyusb/src* to your include path. Also make sure your current include path also contains the configuration file tusb_config.h.
+- 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).
+- 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 the stack to work.
+- Add tusb_init() call to your reset initialization code.
+- Call `tud_int_handler()` (device stack) and/or `tuh_int_handler()` in your USB IRQ Handler
+- Implement all enabled classes's callbacks.
+- 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)
@@ -23,8 +24,8 @@ int main(void)
{
your_application_code();
- tud_task(); // tinyusb device task
- tuh_task(); // tinyusb host task
+ tud_task(); // device task
+ tuh_task(); // host task
}
}
~~~