1.. zephyr:board:: mimxrt1015_evk
2
3Overview
4********
5
6The i.MX RT1015 expands the i.MX RT crossover processor families by providing
7high-performance feature set in low-cost LQFP packages, further simplifying
8board design and layout for customers. The i.MX RT1015 runs on the Arm®
9Cortex®-M7 core at 500 MHz.
10
11Hardware
12********
13
14- MIMXRT1015DAF5A MCU
15
16- Memory
17
18  - 128 Mbit QSPI Flash
19
20- Connectivity
21
22  - Micro USB host and OTG connectors
23  - Arduino interface
24
25- Audio
26
27  - Audio Codec
28  - 4-pole audio headphone jack
29  - External speaker connection
30  - Microphone
31
32- Debug
33
34  - JTAG 10-pin connector
35  - OpenSDA with DAPLink
36
37For more information about the MIMXRT1015 SoC and MIMXRT1015-EVK board, see
38these references:
39
40- `i.MX RT1015 Website`_
41- `i.MX RT1015 Datasheet`_
42- `i.MX RT1015 Reference Manual`_
43- `MIMXRT1015-EVK Website`_
44- `MIMXRT1015-EVK Quick Reference Guide`_
45- `MIMXRT1015-EVK Design Files`_
46
47External Memory
48===============
49
50This platform has the following external memories:
51
52+--------------------+------------+-------------------------------------+
53| Device             | Controller | Status                              |
54+====================+============+=====================================+
55| AT25SF128A         | FLEXSPI    | Enabled via flash configurationn    |
56|                    |            | block, which sets up FLEXSPI at     |
57|                    |            | boot time.                          |
58+--------------------+------------+-------------------------------------+
59
60Supported Features
61==================
62
63The mimxrt1015_evk board configuration supports the hardware features listed
64below.  For additional features not yet supported, please also refer to the
65:zephyr:board:`mimxrt1064_evk` , which is the superset board in NXP's i.MX RT10xx family.
66NXP prioritizes enabling the superset board with NXP's Full Platform Support for
67Zephyr.  Therefore, the mimxrt1064_evk board may have additional features
68already supported, which can also be re-used on this mimxrt1015_evk board:
69
70+-----------+------------+-------------------------------------+
71| Interface | Controller | Driver/Component                    |
72+===========+============+=====================================+
73| NVIC      | on-chip    | nested vector interrupt controller  |
74+-----------+------------+-------------------------------------+
75| SYSTICK   | on-chip    | systick                             |
76+-----------+------------+-------------------------------------+
77| GPIO      | on-chip    | gpio                                |
78+-----------+------------+-------------------------------------+
79| I2C       | on-chip    | i2c                                 |
80+-----------+------------+-------------------------------------+
81| SPI       | on-chip    | spi                                 |
82+-----------+------------+-------------------------------------+
83| UART      | on-chip    | serial port-polling;                |
84|           |            | serial port-interrupt               |
85+-----------+------------+-------------------------------------+
86| USB       | on-chip    | USB device                          |
87+-----------+------------+-------------------------------------+
88| ADC       | on-chip    | ADC                                 |
89+-----------+------------+-------------------------------------+
90| GPT       | on-chip    | gpt                                 |
91+-----------+------------+-------------------------------------+
92| TRNG      | on-chip    | entropy                             |
93+-----------+------------+-------------------------------------+
94
95The default configuration can be found in
96:zephyr_file:`boards/nxp/mimxrt1015_evk/mimxrt1015_evk_defconfig`
97
98Other hardware features are not currently supported by the port.
99
100Connections and I/Os
101====================
102
103The MIMXRT1015 SoC has five pairs of pinmux/gpio controllers.
104
105+---------------+-----------------+---------------------------+
106| Name          | Function        | Usage                     |
107+===============+=================+===========================+
108| GPIO_AD_B0_05 | GPIO            | LED                       |
109+---------------+-----------------+---------------------------+
110| GPIO_EMC_09   | GPIO            | SW4                       |
111+---------------+-----------------+---------------------------+
112| GPIO_AD_B0_06 | LPUART1_TX      | UART Console              |
113+---------------+-----------------+---------------------------+
114| GPIO_AD_B0_07 | LPUART1_RX      | UART Console              |
115+---------------+-----------------+---------------------------+
116| GPIO_EMC_32   | LPUART4_TX      | UART Console              |
117+---------------+-----------------+---------------------------+
118| GPIO_EMC_33   | LPUART4_RX      | UART Console              |
119+---------------+-----------------+---------------------------+
120| GPIO_AD_B1_15 | LPI2C1_SDA      | I2C SDA                   |
121+---------------+-----------------+---------------------------+
122| GPIO_AD_B1_14 | LPI2C1_CLK      | I2C SCL                   |
123+---------------+-----------------+---------------------------+
124| GPIO_AD_B0_10 | LPSPI1_SCK      | SPI                       |
125+---------------+-----------------+---------------------------+
126| GPIO_AD_B0_11 | LPSPI1_PCS0     | SPI                       |
127+---------------+-----------------+---------------------------+
128| GPIO_AD_B0_12 | LPSPI1_SDO      | SPI                       |
129+---------------+-----------------+---------------------------+
130| GPIO_AD_B0_13 | LPSPI1_SDI      | SPI                       |
131+---------------+-----------------+---------------------------+
132| GPIO_AD_B0_14 | ADC             | ADC1 Channel 1            |
133+---------------+-----------------+---------------------------+
134| GPIO_AD_B1_13 | ADC             | ADC1 Channel 13           |
135+---------------+-----------------+---------------------------+
136
137System Clock
138============
139
140The MIMXRT1015 SoC is configured to use SysTick as the system clock source,
141running at 500MHz.
142
143When power management is enabled, the 32 KHz low frequency
144oscillator on the board will be used as a source for the GPT timer to
145generate a system clock. This clock enables lower power states, at the
146cost of reduced resolution
147
148Serial Port
149===========
150
151The MIMXRT1015 SoC has four UARTs. ``LPUART1`` is configured for the console,
152and the remaining are not used.
153
154Programming and Debugging
155*************************
156
157This board supports 3 debug host tools. Please install your preferred host
158tool, then follow the instructions in `Configuring a Debug Probe`_ to
159configure the board appropriately.
160
161* :ref:`linkserver-debug-host-tools` (Default, Supported by NXP)
162* :ref:`jlink-debug-host-tools` (Supported by NXP)
163* :ref:`pyocd-debug-host-tools` (Not supported by NXP)
164
165Once the host tool and board are configured, build and flash applications
166as usual (see :ref:`build_an_application` and :ref:`application_run` for more
167details).
168
169Configuring a Debug Probe
170=========================
171
172For the RT1015, J47/J48 are the SWD isolation jumpers, J42 is the DFU
173mode jumper, and J34 is the 10 pin JTAG/SWD header.
174
175.. include:: ../../common/rt1xxx-lpclink2-debug.rst
176   :start-after: rt1xxx-lpclink2-probes
177
178Configuring a Console
179=====================
180
181Regardless of your choice in debug probe, we will use the OpenSDA
182microcontroller as a usb-to-serial adapter for the serial console. Check that
183jumpers J45 and J46 are **on** (they are on by default when boards ship from
184the factory) to connect UART signals to the OpenSDA microcontroller.
185
186Connect a USB cable from your PC to J41.
187
188Use the following settings with your serial terminal of choice (minicom, putty,
189etc.):
190
191- Speed: 115200
192- Data: 8 bits
193- Parity: None
194- Stop bits: 1
195
196Flashing
197========
198
199Here is an example for the :zephyr:code-sample:`hello_world` application.
200
201.. zephyr-app-commands::
202    :zephyr-app: samples/hello_world
203    :board: mimxrt1015_evk
204    :goals: flash
205
206Open a serial terminal, reset the board (press the SW9 button), and you should
207see the following message in the terminal:
208
209.. code-block:: console
210
211    ***** Booting Zephyr OS v1.14.0-rc1-1297-g312d75f2459e *****
212    Hello World! mimxrt1015_evk
213
214
215.. _MIMXRT1015-EVK Website:
216   https://www.nxp.com/support/developer-resources/run-time-software/i.mx-developer-resources/i.mx-rt1015-evaluation-kit:MIMXRT1015-EVK
217
218.. _MIMXRT1015-EVK Quick Reference Guide:
219   https://www.nxp.com/webapp/Download?colCode=IMXRT1015QSG
220
221.. _MIMXRT1015-EVK Design Files:
222   https://www.nxp.com/webapp/Download?colCode=MIMXRT1015-EVK-REVB-DS
223
224.. _i.MX RT1015 Website:
225   https://www.nxp.com/products/processors-and-microcontrollers/arm-based-processors-and-mcus/i.mx-applications-processors/i.mx-rt-series/i.mx-rt1015-crossover-processor-with-arm-cortex-m7-core:i.MX-RT1015
226
227.. _i.MX RT1015 Datasheet:
228   https://www.nxp.com/docs/en/data-sheet/IMXRT1015CEC.pdf
229
230.. _i.MX RT1015 Reference Manual:
231   https://www.nxp.com/webapp/Download?colCode=IMXRT1015RM
232