summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJacob Potter <[email protected]>2021-01-03 15:12:02 -0700
committerJacob Potter <[email protected]>2021-01-03 15:12:02 -0700
commit57058e33fceecf16161c37f2d9796934b392a2ea (patch)
tree8c2cb3133128fc2aaaf7726ca87ffc2c028798ce /docs
parent226efdcec0d880feb4af3995129b85fae9b8ddb8 (diff)
parente79a7b91526dfb19bfa764f505c87740488849dc (diff)
Merge branch 'master' into ncm
Diffstat (limited to 'docs')
-rw-r--r--docs/boards.md4
-rw-r--r--docs/getting_started.md21
2 files changed, 15 insertions, 10 deletions
diff --git a/docs/boards.md b/docs/boards.md
index 59f6905ea..da8deb72a 100644
--- a/docs/boards.md
+++ b/docs/boards.md
@@ -68,6 +68,10 @@ This code base already had supported for a handful of following boards (sorted a
- [MIMX RT1064 Evaluation Kit](https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/mimxrt1064-evk-i.mx-rt1064-evaluation-kit:MIMXRT1064-EVK)
- [Teensy 4.0 Development Board](https://www.pjrc.com/store/teensy40.html)
+### NXP Kinetis
+
+- [FRDM-KL25Z](https://www.nxp.com/design/development-boards/freedom-development-boards/mcu-boards/freedom-development-platform-for-kinetis-kl14-kl15-kl24-kl25-mcus:FRDM-KL25Z)
+
### NXP LPC
- [ARM mbed LPC1768](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc1700-cortex-m3/arm-mbed-lpc1768-board:OM11043)
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
}
}
~~~