summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorhathach <[email protected]>2019-03-27 08:52:25 -0700
committerGitHub <[email protected]>2019-03-27 08:52:25 -0700
commit86c24b310509a368cc6a9dfbec43ce531e71d598 (patch)
tree81fec0b3724083a3515ef09e0b7d601ce01ec621 /docs
parent547cc045fa1d8862e7e00c1d7b4a0026531d0098 (diff)
parent38f7d281d44c69593f1de3885a292ee7c5c39355 (diff)
Merge pull request #49 from hathach/develop
clean up porting API
Diffstat (limited to 'docs')
-rw-r--r--docs/boards.md33
-rw-r--r--docs/porting.md10
2 files changed, 35 insertions, 8 deletions
diff --git a/docs/boards.md b/docs/boards.md
new file mode 100644
index 000000000..02edce91e
--- /dev/null
+++ b/docs/boards.md
@@ -0,0 +1,33 @@
+# Boards #
+
+## Supported Boards ##
+
+This code base already had supported for a handful of following boards
+
+### Nordic nRF5x ###
+
+- [nRF52840-DK (aka pca10056)](https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK)
+
+### NXP LPC ###
+
+- [LPCXpresso 11U68](https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc11u68:OM13058)
+- [LPCXpresso 1347](https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc1347:OM13045)
+- [LPCXpresso 1769](https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc1769:OM13000)
+- [Keil MCB1800 Evaluation Board](http://www.keil.com/mcb1800)
+- [Embedded Artists LPC4088 Quick Start board](https://www.embeddedartists.com/products/lpc4088-quickstart-board)
+- [Embedded Artists LPC4357 Developer Kit](http://www.embeddedartists.com/products/kits/lpc4357_kit.php)
+
+### MicroChip SAMD ###
+
+- [Adafruit Metro M0 Express](https://www.adafruit.com/product/3505)
+- [Adafruit Metro M4 Express](https://www.adafruit.com/product/3382)
+
+### ST STM32 ###
+
+- [STM32F4 Discovery](https://www.st.com/en/evaluation-tools/stm32f4discovery.html)
+
+## Add your own board ##
+
+If you don't possess any of supported board above. Don't worry you can easily implemented your own one by following this guide as long as the mcu is supported.
+
+**Guide to implement a new board is coming soon** ...
diff --git a/docs/porting.md b/docs/porting.md
index f5af82800..5f1df0d7a 100644
--- a/docs/porting.md
+++ b/docs/porting.md
@@ -53,12 +53,6 @@ The OS Abstraction Layer is responsible for providing basic data structures for
The code is almost entirely agnostic of MCU and lives in `src/osal`.
-#### tusb_hal_millis
-
-The OPT_OS_NONE option is the only option which requires an MCU specific function. It needs `tusb_hal_millis` to measure the passage of time. On ARM this is commonly done with SysTick. The function returns the elapsed number of milliseconds since startup.
-
-`tusb_hal_millis` is also provided in `hw/bsp/<board name>/board_<board name>.c` because it may vary with MCU use.
-
### Device API
After the USB device is setup, the USB device code works by processing events on the main thread (by calling `tud_task`). These events are queued by the USB interrupt handler. So, there are three parts to the device low-level API: device setup, endpoint setup and interrupt processing.
@@ -153,9 +147,9 @@ The arguments are:
* the result of the transfer. Failure isn't handled yet.
* `true` to note the call is from an interrupt handler.
-##### dcd_edpt_stall / dcd_edpt_stalled / dcd_edpt_clear_stall
+##### dcd_edpt_stall / dcd_edpt_clear_stall
-Stalling is one way an endpoint can indicate failure such as when an unsupported command is transmitted. The trio of `dcd_edpt_stall`, `dcd_edpt_stalled`, `dcd_edpt_clear_stall` help manage the stall state of all endpoints.
+Stalling is one way an endpoint can indicate failure such as when an unsupported command is transmitted. The pair of `dcd_edpt_stall`, `dcd_edpt_clear_stall` help manage the stall state of all endpoints.
## Woohoo!