esp32-s2_dfu/doxygen/getting_started.md

# Getting Started #

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Download](#download)
- [Add tinyusb to your project](#add-tinyusb-to-your-project)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Download

tinyusb uses github as online repository https://github.com/hathach/tinyusb since it is the best place for open source project. 

If you are using Linux, you already know how to what to do. But If Windows is your OS, I would suggest to install [git](http://git-scm.com/) and front-end gui such as [tortoisegit](http://code.google.com/p/tortoisegit) to begin with.

After downloading/cloning, the code base is composed of

Folder  | Description
-----   | -------------
boards  | Source files of supported boards
demos   | Source & project files for demonstration application
mcu     | Low level mcu core & peripheral drivers (e.g CMSIS )
tests   | Unit tests for the stack
tinyusb | All sources files for tinyusb stack itself.
vendor  | Source files from 3rd party such as freeRTOS, fatfs etc ...

*repo/demos* is the folder where all the application & project files are located. There are demos for both device and hosts. For each, there are different projects for each of supported RTOS. 

## Add tinyusb to your project

It is relatively simple to incorporate tinyusb to your (existing) project

1. Copy core folder **repo/tinyusb** to your project. Let's say it is *your_project/tinyusb*
2. Add all the .c in the core 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 such as TUSB_CFG_MCU are all defined properly in tusb_config.h.


\subpage md_boards_readme

\subpage md_doxygen_started_build_demo

\subpage md_doxygen_started_run_demo

\subpage md_doxygen_tools
remove RF1GHZNODE from board/readme.md dcd_lpc43xx.c - assign ENDPTPRIME with = instead of \|= - fix bug with control transfer the determination of complete transferred --> fix keyboard + msc causes fast blinking add osal_semaphore_reset(usbd_control_xfer_sem_hdl) when bus_reset 2014-04-04 07:22:33 +02:00			`# Getting Started #`
md again 2014-03-26 09:32:44 +01:00
testing toc 2014-03-28 11:05:01 +01:00			`<!-- START doctoc generated TOC please keep comment here to allow auto update -->`
			`<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->`
			`Table of Contents`

			`- [Download](#download)`
update doc 2014-04-14 19:10:01 +02:00			`- [Add tinyusb to your project](#add-tinyusb-to-your-project)`
testing toc 2014-03-28 11:05:01 +01:00
			`<!-- END doctoc generated TOC please keep comment here to allow auto update -->`

update doc 2014-04-14 19:10:01 +02:00			`## Download`
md again 2014-03-26 09:32:44 +01:00
			`tinyusb uses github as online repository https://github.com/hathach/tinyusb since it is the best place for open source project.`

			`If you are using Linux, you already know how to what to do. But If Windows is your OS, I would suggest to install [git](http://git-scm.com/) and front-end gui such as [tortoisegit](http://code.google.com/p/tortoisegit) to begin with.`

			`After downloading/cloning, the code base is composed of`

			`Folder \| Description`
			`----- \| -------------`
update doc 2014-04-14 19:10:01 +02:00			`boards \| Source files of supported boards`
			`demos \| Source & project files for demonstration application`
			`mcu \| Low level mcu core & peripheral drivers (e.g CMSIS )`
			`tests \| Unit tests for the stack`
			`tinyusb \| All sources files for tinyusb stack itself.`
			`vendor \| Source files from 3rd party such as freeRTOS, fatfs etc ...`
md again 2014-03-26 09:32:44 +01:00
remove image and docs folder update get_started.md 2014-03-27 16:27:42 +01:00			`repo/demos is the folder where all the application & project files are located. There are demos for both device and hosts. For each, there are different projects for each of supported RTOS.`
md again 2014-03-26 09:32:44 +01:00
update doc 2014-04-14 19:10:01 +02:00			`## Add tinyusb to your project`

			`It is relatively simple to incorporate tinyusb to your (existing) project`

added tools.md 2014-04-15 07:51:32 +02:00			`1. Copy core folder repo/tinyusb to your project. Let's say it is your_project/tinyusb`
update doc 2014-04-14 19:10:01 +02:00			`2. Add all the .c in the core 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 such as TUSB_CFG_MCU are all defined properly in tusb_config.h.`
md again 2014-03-26 09:32:44 +01:00


remove RF1GHZNODE from board/readme.md dcd_lpc43xx.c - assign ENDPTPRIME with = instead of \|= - fix bug with control transfer the determination of complete transferred --> fix keyboard + msc causes fast blinking add osal_semaphore_reset(usbd_control_xfer_sem_hdl) when bus_reset 2014-04-04 07:22:33 +02:00			`\subpage md_boards_readme`
update doc 2014-04-14 19:10:01 +02:00
merge EHCI_MAX_QHD/QTD and OHCI_MAX_QHD/QTD to HCD_MAX_ENDPOINT/XFER and scale with number of enabled classes. default config to support up to 5 device (hub + 4 others) 2014-04-13 10:39:57 +02:00			`\subpage md_doxygen_started_build_demo`
update doc 2014-04-14 19:10:01 +02:00
added tools.md 2014-04-15 07:51:32 +02:00			`\subpage md_doxygen_started_run_demo`

			`\subpage md_doxygen_tools`