Skip to content

Commit 9b423e9

Browse files
Jan Kowalewskinashif
authored andcommitted
boards: arm: quick_feather: add platform documentation
Adds documentation about QuickFeather platform Signed-off-by: Jan Kowalewski <[email protected]>
1 parent 05f8dd9 commit 9b423e9

File tree

2 files changed

+124
-0
lines changed

2 files changed

+124
-0
lines changed
358 KB
Loading
Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
.. _quickfeather:
2+
3+
QuickFeather
4+
############
5+
6+
Overview
7+
********
8+
9+
The QuickFeather development board is a platform with an on-board QuickLogic
10+
EOS S3 Sensor Processing Platform.
11+
12+
13+
.. figure:: img/feather-board.png
14+
:width: 500px
15+
:align: center
16+
:alt: QuickFeather
17+
18+
QuickFeather (Credit: QuickLogic)
19+
20+
Hardware
21+
********
22+
23+
- QuickLogic EOS S3 MCU Platform
24+
- mCube MC3635 accelerometer
25+
- Infineon DPS310 pressure sensor
26+
- Infineon IM69D130 MEMS microphone
27+
- 16 Mbit of on-board flash memory
28+
- User button
29+
- RGB LED
30+
- Integrated battery charger
31+
32+
Detailed information about the board can be found in a `QuickFeather repository`_.
33+
34+
Supported Features
35+
==================
36+
37+
The QuickFeather configuration supports the following hardware
38+
features:
39+
40+
+-----------+------------+-------------------------------------+
41+
| Interface | Controller | Driver/Component |
42+
+===========+============+=====================================+
43+
| UART | on-chip | serial port |
44+
+-----------+------------+-------------------------------------+
45+
46+
The default configuration can be found in the Kconfig file
47+
:zephyr_file:`boards/arm/quick_feather/quick_feather_defconfig`.
48+
49+
Connections and IOs
50+
===================
51+
52+
Detailed information about pinouts is available in the `schematics document`_.
53+
54+
Programming and Debugging
55+
*************************
56+
57+
Flashing
58+
========
59+
60+
The QuickFeather platform by default boots from flash. Currently
61+
the Zephyr port only enables loading the program directly to SRAM using either
62+
OpenOCD and a SWD programmer or SEGGER JLink.
63+
64+
OpenOCD
65+
-------
66+
67+
In order to connect to the target a SWD programmer supported in
68+
OpenOCD is needed. To connect to the board run:
69+
70+
.. code-block:: console
71+
72+
openocd -f /path/to/swd-programmer.cfg -f tcl/board/quicklogic_quickfeather.cfg -c "init" -c "reset halt"
73+
74+
`The QuickFeather OpenOCD config`_ can be found in the OpenOCD mainline repository.
75+
76+
JLink
77+
-----
78+
79+
To connect to the QuickFeather board with JLink please follow instructions
80+
in the `QuickFeather User Guide`_.
81+
82+
Debugging
83+
=========
84+
85+
To debug the QuickFeather board please connect to the target with either
86+
OpenOCD or JLink and use GDB distributed in Zephyr's SDK in *arm-zephyr-eabi/bin*
87+
directory.
88+
89+
To load basic sample via GDB:
90+
91+
- Build the sample in an usual way:
92+
93+
.. zephyr-app-commands::
94+
:zephyr-app: samples/hello_world
95+
:board: quickfeather
96+
:goals: build
97+
98+
- Connect to the target using either OpenOCD or JLink
99+
- Connect via GDB and load an ELF file:
100+
101+
.. code-block:: console
102+
103+
/path/to/zephyr-sdk/arm-zephyr-eabi/bin/arm-zephyr-eabi-gdb
104+
target remote <port_number>
105+
file </path/to/zephyr.elf>
106+
load
107+
continue
108+
109+
References
110+
**********
111+
112+
.. target-notes::
113+
114+
.. _QuickFeather repository:
115+
https://github.com/QuickLogic-Corp/quick-feather-dev-board
116+
117+
.. _schematics document:
118+
https://github.com/QuickLogic-Corp/quick-feather-dev-board/blob/master/doc/quickfeather-board.pdf
119+
120+
.. _The QuickFeather OpenOCD config:
121+
https://sourceforge.net/p/openocd/code/ci/master/tree/tcl/board/quicklogic_quickfeather.cfg
122+
123+
.. _QuickFeather User Guide:
124+
https://github.com/QuickLogic-Corp/quick-feather-dev-board/blob/master/doc/QuickFeather_UserGuide.pdf

0 commit comments

Comments
 (0)