add overview.md and license.md and tinyUSB overview.png

2025-03-14 04:18:56 +00:00 · 2012-12-02 00:36:44 +07:00 · 2012-12-02 00:36:44 +07:00 · 8a1dee1b2e
commit 8a1dee1b2e
parent 879fb21f99
29 changed files with 60 additions and 30 deletions
--- a/demos/device/keyboard/descriptors.c
+++ b/demos/device/keyboard/descriptors.c
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack
 */

 #include "descriptors.h"
--- a/demos/device/keyboard/descriptors.h
+++ b/demos/device/keyboard/descriptors.h
@ -27,7 +27,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack
 */

 #ifndef _DESCRIPTORS_H_
--- a/doxygen.Doxyfile
+++ b/doxygen.Doxyfile
@ -360,12 +360,12 @@ LOOKUP_CACHE_SIZE = 0
 # Private class members and static file members will be hidden unless
 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

-EXTRACT_ALL = NO
+EXTRACT_ALL = YES

 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
 # will be included in the documentation.

-EXTRACT_PRIVATE = NO
+EXTRACT_PRIVATE = YES

 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
 # scope will be included in the documentation.
@ -375,7 +375,7 @@ EXTRACT_PACKAGE = NO
 # If the EXTRACT_STATIC tag is set to YES all static members of a file
 # will be included in the documentation.

-EXTRACT_STATIC = NO
+EXTRACT_STATIC = YES

 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
 # defined locally in source files will be included in the documentation.
@ -404,7 +404,7 @@ EXTRACT_ANON_NSPACES = NO
 # various overviews, but no documentation section is generated.
 # This option has no effect if EXTRACT_ALL is enabled.

-HIDE_UNDOC_MEMBERS = YES
+HIDE_UNDOC_MEMBERS = NO

 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
 # undocumented classes that are normally visible in the class hierarchy.
@ -661,7 +661,7 @@ WARN_LOGFILE =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.

-INPUT = tinyusb/class tinyusb/common tinyusb/host tinyusb/common/arch tinyusb/common/compiler tinyusb tinyusb\device 
+INPUT = tinyusb/class tinyusb/common tinyusb/host tinyusb/common/arch tinyusb/common/compiler tinyusb tinyusb\device overview.md license.md 

 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
--- a/license.md
+++ b/license.md
@ -0,0 +1,27 @@
+# License
+
+Software License Agreement (BSD License)<br>
+Copyright (c) 2012, hathach (tinyusb.net)<br>
+All rights reserved.<br>
+
+Redistribution and use in source and binary forms, with or without modification,<br>
+are permitted provided that the following conditions are met:<br>
+
+1. Redistributions of source code must retain the above copyright notice,<br>
+   this list of conditions and the following disclaimer.<br>
+2. Redistributions in binary form must reproduce the above copyright notice,<br>
+   this list of conditions and the following disclaimer in the documentation<br>
+   and/or other materials provided with the distribution.<br>
+3. The name of the author may not be used to endorse or promote products<br>
+   derived from this software without specific prior written permission.<br>
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED<br>
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF<br>
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT<br>
+SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,<br>
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT<br>
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS<br>
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN<br>
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING<br>
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY<br>
+OF SUCH DAMAGE.
--- a/license.txt
+++ b/license.txt
--- a/overview.md
+++ b/overview.md
@ -0,0 +1,3 @@
+# What is tinyUSB
+
+![tinyUSB diagram](overview.png)
--- a/tinyusb/class/cdc.c
+++ b/tinyusb/class/cdc.c
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 #include "cdc.h"
--- a/tinyusb/class/cdc.h
+++ b/tinyusb/class/cdc.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/class/hid.c
+++ b/tinyusb/class/hid.c
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 #include "hid.h"
--- a/tinyusb/class/hid.h
+++ b/tinyusb/class/hid.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/common/arch/arch.h
+++ b/tinyusb/common/arch/arch.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/common/arch/arch_lpc11xx.h
+++ b/tinyusb/common/arch/arch_lpc11xx.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/common/arch/arch_lpc134x.h
+++ b/tinyusb/common/arch/arch_lpc134x.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/common/arch/arch_lpc43xx.h
+++ b/tinyusb/common/arch/arch_lpc43xx.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/common/arch/arm_mx.h
+++ b/tinyusb/common/arch/arm_mx.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/common/common.h
+++ b/tinyusb/common/common.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/common/compiler/compiler.h
+++ b/tinyusb/common/compiler/compiler.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/common/compiler/compiler_gcc.h
+++ b/tinyusb/common/compiler/compiler_gcc.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/common/errors.c
+++ b/tinyusb/common/errors.c
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 char const* const TUSB_ErrorStr[] = {
--- a/tinyusb/common/errors.h
+++ b/tinyusb/common/errors.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/common/errors_def
+++ b/tinyusb/common/errors_def
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 ERROR_ENUM(tERROR_NONE)
--- a/tinyusb/common/fifo.c
+++ b/tinyusb/common/fifo.c
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 #include "fifo.h"
--- a/tinyusb/common/fifo.h
+++ b/tinyusb/common/fifo.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/device/dcd.c
+++ b/tinyusb/device/dcd.c
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 #include "dcd.h"
--- a/tinyusb/device/dcd.h
+++ b/tinyusb/device/dcd.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/host/hcd.c
+++ b/tinyusb/host/hcd.c
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 #include "hcd.h"
--- a/tinyusb/host/hcd.h
+++ b/tinyusb/host/hcd.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/tusb.h
+++ b/tinyusb/tusb.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file
--- a/tinyusb/tusb_cfg.h
+++ b/tinyusb/tusb_cfg.h
@ -32,7 +32,7 @@
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
- * This file is part of the tiny usb stack.
+ * This file is part of the tinyUSB stack.
 */

 /** \file