Switch to cmake build system
* use tinyprintf * ability to configure project via ccmake Signed-off-by: Amir Hammad <amir.hammad@hotmail.com>
This commit is contained in:
Amir Hammad
parent
28ccd32608
commit
ed70a1efa3
19 changed files with 1001 additions and 370 deletions
137
README.md
137
README.md
|
|
@ -1,83 +1,104 @@
|
|||
###General Information
|
||||
##General Information
|
||||
|
||||
[Link to the official repository](http://github.com/libusbhost/libusbhost)
|
||||
|
||||
**This library is in an active development.**
|
||||
**WARNING**: None of its features are considered stable !
|
||||
###Objectives
|
||||
|
||||
This library implement usb host driver allowing users use
|
||||
or write device drivers, which functionality
|
||||
is abstracted of low level implementation.
|
||||
|
||||
Main objectives are:
|
||||
- provide open-source(Lesser GPL3) usb host library for embedded devices
|
||||
- execution speed: This library doesn't use blocking sleep,
|
||||
- execution speed. This library doesn't use blocking sleep,
|
||||
making low overhead on runtime performance
|
||||
- uses static allocation for all its buffers,
|
||||
so no allocation and reallocation is affecting performance
|
||||
(possibility of memory fragmentation. execution time indeterminism),
|
||||
so no malloc(), realloc(), free().
|
||||
- written in C, with the support to use it with C++.
|
||||
- does not depend on any Operating System. Library libopencm3 is used for testing purposes and to get proper defines.
|
||||
So no runtime dependency is on this library.
|
||||
- use static allocation for all of its buffers.
|
||||
This means no allocation and reallocation is affecting performance
|
||||
(possibility of memory fragmentation. execution time indeterminism). No malloc(), realloc(), free()
|
||||
- do not depend on any operating system
|
||||
|
||||
### Supported hardware
|
||||
|
||||
- stm32f4discovery
|
||||
|
||||
Currently supported devices (yet tested) are:
|
||||
* stm32f407 (stm32f4 Discovery)
|
||||
### Supported device drivers
|
||||
|
||||
Native device drivers (mostly for demonstration purposes):
|
||||
- HUB
|
||||
- Gamepad - XBox compatible Controller
|
||||
- mouse (draft: only displays raw data)
|
||||
- USB MIDI devices (raw data + note on/off)
|
||||
|
||||
###Practical info
|
||||
## Steps to compile library and demo
|
||||
### Prerequisities
|
||||
Make sure the following prerequisities are installed to be able to compile this library
|
||||
- **git** for libopencm3 submodule fetch
|
||||
- **gcc-arm-none-eabi** toolchain for cross compilation
|
||||
- **cmake**
|
||||
- **ccmake** (optional)
|
||||
- **openocd** (optional)
|
||||
|
||||
!!! Do not forget to invoke "make clean" before new build when defines change(_TODO: remove this warning and fix the Makefile_)
|
||||
### Basic setup
|
||||
1. go to build directory located in the root of the project
|
||||
> cd build
|
||||
|
||||
2. compile demo and the library with the default options set
|
||||
> cmake .. && make
|
||||
|
||||
**How to initialize repository**
|
||||
Executable demo is placed into `build/demo.hex`.
|
||||
Library is placed into `build/src/libusbhost.a`.
|
||||
|
||||
> ./initRepo.sh
|
||||
### Advanced setup
|
||||
*cmake* initial cache variables
|
||||
<table>
|
||||
<tr>
|
||||
<th>Cache variable</th><th>Value</th><th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>USE_STM32F4_FS</td><td>TRUE</td><td>Enable STM32F4 Full Speed USB host peripheral</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>USE_STM32F4_HS</td><td>TRUE</td><td>Enable STM32F4 High Speed USB host peripheral</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>USE_USART_DEBUG</td><td>TRUE</td><td>Enable writing of the debug information to USART6</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>OOCD_INTERFACE</td><td>"stlink-v2"</td><td>Interface configuration file used by the openocd</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>OOCD_BOARD</td><td>"stm32f4discovery"</td><td>Board configuration file used by the openocd</td>
|
||||
</tr>
|
||||
</table>
|
||||
You can alter these by issuing the following commands in the build directory
|
||||
|
||||
fetch libopencm3 submodule and compile needed libraries
|
||||
- Graphical user interface
|
||||
> ccmake ..
|
||||
|
||||
**How to generate documentation**
|
||||
- Command line interface
|
||||
> cmake .. -D{VARIABLE}={VALUE}
|
||||
|
||||
> make doc
|
||||
### Flashing
|
||||
If the *openocd* is installed, `make flash` executed in the build directory
|
||||
flashes the `build/demo.hex` to the stm32f4discovery board.
|
||||
|
||||
**How to compile demo**
|
||||
### Reading debug output
|
||||
The following table represents the configuration of the debug output
|
||||
<table>
|
||||
<tr>
|
||||
<th>GPIO</th><td>GPIOC6</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>USART periphery</th><td>USART6</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>Function</th><td>UART TX</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>Baud rate</th><td>921600</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>Uart mode</th><td>8N1</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Edit usbh_config.h to configure the library (By default Full speed OTG periphery on stm32f4 is supported)
|
||||
## License
|
||||
|
||||
The libusbhost code is released under the terms of the GNU Lesser General
|
||||
Public License (LGPL), version 3 or later.
|
||||
|
||||
> ./compileDemo.sh
|
||||
|
||||
compiles demo, that can be flashed into stm32f4 Discovery platform and debug by USART
|
||||
|
||||
|
||||
**How to upload firmware (FLASH) to stm32f4 Discovery**
|
||||
|
||||
> sudo make flash
|
||||
|
||||
|
||||
**How to view debug data**
|
||||
|
||||
connect uart to USART6 pins on gpios: GPIOC6(TX - data), GPIOC7(RX - not used)
|
||||
configure uart baud on PC side to 921600 with 1 stop bit, no parity, 8bit data, no handshake
|
||||
|
||||
|
||||
**How to compile library only**
|
||||
|
||||
> make lib
|
||||
|
||||
**libusbhost.a** is built without usart debug support
|
||||
(check compileDemo.sh for hint on how to compile with debug)
|
||||
|
||||
|
||||
###Contact
|
||||
Amir Hammad - *amir.hammad@hotmail.com*
|
||||
|
||||
**Library is maintained there**
|
||||
> http://github.com/libusbhost/libusbhost
|
||||
|
||||
See COPYING.GPL3 and COPYING.LGPL3 for details.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue