@@ -18,7 +18,6 @@ It is suitable for mobile system applications.
1818
1919To find out more about ITE, visit our World Wide Web at:`ITE's website `_
2020
21-
2221Hardware
2322********
2423The IT8XXX2 series contains different chip types(ex, it81302, it83202),
@@ -60,39 +59,172 @@ currently supports the following hardware features:
6059 * - GPIO
6160 - on-chip
6261 - gpio
62+ * - ADC
63+ - on-chip
64+ - adc
65+ * - I2C
66+ - on-chip
67+ - i2c
68+ * - KSCAN
69+ - on-chip
70+ - kscan
6371
64- Programming and debugging
65- *************************
72+
73+ Other hardware features are not currently supported by Zephyr.
74+
75+ The default configuration can be found in the
76+ :zephyr_file: `boards/riscv/it8xxx2_evb/it8xxx2_evb_defconfig ` Kconfig file.
77+
78+ Programming and debugging on it83202
79+ ************************************
80+
81+ In order to upload the application to the device,
82+ you'll need our flash tool and Download board.
83+ You can get them at: `ITE's website `_.
84+
85+ Wiring
86+ =======
87+ #. Connect your Download Board to your host computer using the USB cable.
88+
89+ .. image :: ite_Downloadboard_setup.jpg
90+ :width: 600px
91+ :align: center
92+ :alt: ITE Download Board Connected
93+
94+ #. Connect your Download Board to J145 on the it8xxx2_evb board.
95+
96+ .. image :: it8xxx2_evb_setup.jpg
97+ :width: 600px
98+ :align: center
99+ :alt: ITE Download Board Connected
100+
101+ .. note :: Be careful during connection!
102+ Use separate wires to connect I2C pins with pins on the it8xxx2_evb board.
103+ Wiring connection is described in the table below.
104+
105+ +-------------+---------------+
106+ | J5 | it8xxx2_evb |
107+ | Connector | J145 Connector|
108+ +=============+===============+
109+ | 2 | 7 |
110+ +-------------+---------------+
111+ | 3 | 9 |
112+ +-------------+---------------+
113+ | 4 | 10 |
114+ +-------------+---------------+
115+
116+ #. Connect UART0 port of the it8xxx2_evb board
117+ to your host computer using the usb cable.
118+
119+ .. note :: Be careful during connection!
120+ Use separate wires to connect USB serial with pins on the it8xxx2_evb board.
121+ Wiring connection is described in the table below.
122+
123+ +-------------+---------------+
124+ | USB | it8xxx2_evb |
125+ | Connector | Connector |
126+ +=============+===============+
127+ | TX | UART0 5 |
128+ +-------------+---------------+
129+ | RX | UART0 7 |
130+ +-------------+---------------+
131+ | GND | J15 |
132+ +-------------+---------------+
133+
134+ #. Apply power to the board via a USB cable.
66135
67136Building
68137========
69138
70- Applications for the ``it8xxx2_evb `` board configuration can be built as usual
71- (see :`Zephyr Getting Started Guide `_):
139+ #. Build :ref: `hello_world ` application as you would normally do
140+ (see :`Zephyr Getting Started Guide `_):.
141+
142+ .. zephyr-app-commands ::
143+ :board: it8xxx2_evb
144+ :zephyr-app: samples/hello_world
145+ :goals: build
72146
73- .. zephyr-app-commands ::
74- :board: it8xxx2_evb
75- :goals: build
147+ #. The file :file: `zephyr.bin ` will be created by west.
76148
77149Flashing
78150========
79151
80- In order to upload the application to the device,
81- you'll need our winflash tool and download board.
82- You can get the winflash tool at here:` Download Link `_
83- Use the winflash.exe tool to program a zephyr application
152+ Windows
153+ --------
154+
155+ Use the winflash tool to program a zephyr application
84156to the it8xxx2 board flash.
85157
158+ #. Open winflash tool and make sure the order you open the switch is right.
159+ Fisrt, turn on the Download board switch.
160+ Second, turn on the it8xxx2_evb board switch.
161+ Then, configure your winflash tool like below.
162+
163+ .. figure :: WinFlashTool_P2.png
164+ :width: 600px
165+ :align: center
166+
167+ .. figure :: WinFlashTool_P4.png
168+ :width: 600px
169+ :align: center
170+
171+ #. Using winflash tool flash zephyr.bin into your ITE board.
172+ First, click ``Load `` button and select your zephyr.bin file.
173+ Second, click ``run `` to flash the iamge into board.
174+
175+ .. figure :: WinFlashTool_P3.png
176+ :width: 600px
177+ :align: center
178+
179+ #. At this point, you have flashed your image into ITE board and
180+ it will work if you turn on ITE board. You can use a terminal program
181+ to verify flashing worked correctly.
182+
183+ For example, open device manager to find the USB Serial Port(COM4) and use your
184+ terminal program to connect it(Speed: 115200).
185+
186+ .. figure :: WinFlashTool_P1.png
187+ :width: 600px
188+ :align: center
189+
190+ #. Turn on the it8xxx2_evb board switch, you should see ``"Hello World! it8xxx2_evb" ``
191+ sent by the board. If you don't see this message, press the Reset button and the
192+ message should appear.
193+
194+ Ubuntu
195+ --------
196+
197+ #. Run your favorite terminal program to listen for output.
198+ Under Linux the terminal should be :code: `/dev/ttyUSB0 `. Do not close it.
199+
200+ For example:
201+
202+ .. code-block :: console
203+
204+ $ minicom -D /dev/ttyUSB0 -b 115200
205+
206+ #. Open a second terminal window and use linux flash tool to flash your board.
207+ You can find more details about tool usage from its document.
208+
209+ #. Split first and second terminal windows to view both of them.
210+ You should see ``"Hello World! it8xxx2_evb" `` in the first terminal window.
211+ If you don't see this message, press the Reset button and the message should appear.
212+
86213Debugging
87214=========
88215
89216Supporting uart debug, currently.
90217
218+ Troubleshooting
219+ ===============
220+
221+ #. If the flash tool reports a failure, re-plug the 8390 Download board or
222+ power cycle the it8xxx2_evb board and try again.
223+
91224References
92225==========
93226
94227.. target-notes ::
95228
96229.. _ITE's website : http://www.ite.com.tw/en/product/view?mid=149
97230.. _Zephyr Getting Started Guide : https://docs.zephyrproject.org/latest/getting_started/index.html
98- .. _Download Link : http://www.ite.com.tw/en/product/view?mid=149
0 commit comments