You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2021/04/13 14:19:44 UTC
[GitHub] [incubator-nuttx] michallenc opened a new pull request #3539: Documentation: added documentation for i.MX RT series and Teensy 4.x boards
michallenc opened a new pull request #3539:
URL: https://github.com/apache/incubator-nuttx/pull/3539
## Summary
This adds basic documentation (basic info + list of peripherals) for i. MX RT series (as discussed in #3462) and migrate Teensy 4.x documentation from boards/arm/imxrt/teensy-4.x to Documentation/ subfolder.
## Impact
Documentation only
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] michallenc commented on a change in pull request #3539: Documentation: added documentation for i.MX RT series and Teensy 4.x boards
Posted by GitBox <gi...@apache.org>.
michallenc commented on a change in pull request #3539:
URL: https://github.com/apache/incubator-nuttx/pull/3539#discussion_r612538502
##########
File path: Documentation/platforms/arm/imxrt/index.rst
##########
@@ -0,0 +1,191 @@
+=======
+i.MX RT
+=======
+
+The i.MX RT series of chips from NXP Semiconductors is based around an ARM Cortex-M7 core running
+at 500 MHz, 600 MHz or 1 GHz based on particular MCUs
+
+Suported MCUs
+=============
+
+The following list includes MCUs from i.MX RT series and indicates whether they are supported in NuttX
+
+====== ======= ============== =================
+MCU Support Core Frequency
+====== ======= ============== =================
+RT500 No Cortex-M33 200 MHz
+RT600 No Cortex-M33 300 MHz
+RT1010 No Cortex-M7 500 MHz
+RT1015 No Cortex-M7 500 MHz
+RT1020 Yes Cortex-M7 500 MHz
+RT1024 No Cortex-M7 500 MHz
+RT1050 Yes Cortex-M7 600 MHz
+RT1060 Yes Cortex-M7 600 MHz
+RT1064 Yes Cortex-M7 600 MHz
+RT1170 No Cortex-M7 + M4 1 GHz + 400 MHz
+====== ======= ============== =================
+
+Data and Instruction Cache
+==========================
+
+MCUs i.MX RT1010 and higher have separated caches for instructions and data. Data cache is initially
+set as write-through but can be changed to write-back via Kconfig. While write-back gives better
+performance than write-through, it is not supported for all peripherals in NuttX yet. Write-back data
+cache can not be selected while running Ethernet or serial port over USB.
+
+Peripheral Support
+==================
+
+The following list indicates peripherals supported in NuttX:
+
+========== =======
+Peripheral Support
+========== =======
+ACMP No
+ADC Yes
+CAN Yes
+CSI No
+DAC No
+eLCDIF Yes
+ENC Yes
+ENET Yes
+FlexIO No
+GPIO Yes
+I2S Yes
+PWM No
+SAI No
+SPDIF No
+SPI Yes
+UART Yes
+USB Yes
+========== =======
+
+ACMP
+----
+
+The circout for comparing two analog input voltages designed to operate across the full
+range of supply voltage (rail-to-rail operation).
+
+ADC
+---
+
+ADC driver with the successive approximation analog/digital convertor. The lower-half of
+this driver is initialize by calling :c:func:`imxrt_adcinitialize`.
+
+CAN
+---
+
+FlexCAN driver is supported in MCUs i.MX RT1020 and higher. i.MX RT106x have both classical
+CAN and also one CAN FD while i.MX RT1170 have 3 CAN FD peripherals. FlexCAN driver in imxrt
+works beyond SocketCAN driver layout. The lower-half of this driver is initialize by
+calling :c:func:`imxrt_cannitialize()`.
+
+There is an booting option that automatically provides initialization of network interface
+in the early stages of booting and therefore calling :c:func:`imxrt_cannitialize()` via
+board specific logic is not neccessary. This however works only when there is only one
+interface in the chip. For running more interfaces (like CAN and Ethernet), network late
+initialization must be turn on by CONFIG_NETDEV_LATEINIT and board specific logic must call
+lower-half part of drivers.
+
+CSI
+---
+
+CMOS Sensor interface which enables the chip to connect directly to external CMOS image sensors.
+
+DAC
+---
+
+Digital/analog convertor for external signal is only supported in i.MX RT1170 MCU. It is 12 bit
+lower power, general purpose DAC.
+
+eLCDIF
+------
+
+The enhanced Liquid Crystal Display interface (LCDIF) is a general purpose display controller.
+
+ENC
+---
+
+The enhanced quadrature encoder/decoder module supported in i.MX RT1015 and higher. The lower-half
+of this driver is initialize by calling :c:func:`imxrt_qeinitialize`.
+
+ENET
+----
+
+Ethernet driver supported in i.MX RT1020 and higher. The lower-half of this driver is initialize
+by calling :c:func:`imxrt_netnitialize`.
+
+There is an booting option that automatically provides initialization of network interface
+in the early stages of booting and therefore calling :c:func:`imxrt_cannitialize()` via
+board specific logic is not neccessary. This however works only when there is only one
+interface in the chip. For running more interfaces (like CAN and Ethernet), network late
+initialization must be turn on by CONFIG_NETDEV_LATEINIT and board specific logic must call
+lower-half part of drivers.
+
+FlexIO
+------
+
+A configurable module providing a range of functionality like emulation of a variety of
+serial/parallel communication protocols, flexible 16-bit timers or programmable logic blocks.
+This module is supported in i.MX RT1010 and higher.
+
+GPIO
+----
+
+Pins can be configured using ``imxrt_config_gpio()`` function. Writing to pins is
+done by ``imxrt_gpio_write()`` function and reading is done by ``imxrt_gpio_read()``.
Review comment:
Thanks. I forgot it there back then.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] xiaoxiang781216 merged pull request #3539: Documentation: added documentation for i.MX RT series and Teensy 4.x boards
Posted by GitBox <gi...@apache.org>.
xiaoxiang781216 merged pull request #3539:
URL: https://github.com/apache/incubator-nuttx/pull/3539
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] michallenc commented on pull request #3539: Documentation: added documentation for i.MX RT series and Teensy 4.x boards
Posted by GitBox <gi...@apache.org>.
michallenc commented on pull request #3539:
URL: https://github.com/apache/incubator-nuttx/pull/3539#issuecomment-818802047
> > @v01d $ mount -t vfat /dev/mmcsd0 /mnt seems to ignore that line completely, maybe change $ to #?
>
> Maybe a blank line is needed between the code-block and the content.
You´re right, that hepled. Thanks, all changes should be done.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on a change in pull request #3539: Documentation: added documentation for i.MX RT series and Teensy 4.x boards
Posted by GitBox <gi...@apache.org>.
v01d commented on a change in pull request #3539:
URL: https://github.com/apache/incubator-nuttx/pull/3539#discussion_r612500318
##########
File path: Documentation/platforms/arm/imxrt/index.rst
##########
@@ -0,0 +1,191 @@
+============
+i.MX RT
+============
+
+The i.MX RT series of chips from NXP Semiconductors is based around an ARM Cortex-M7 core running
+at 500 MHz, 600 MHz or 1 GHz based on particular MCUs
+
+Suported MCUs
+===================
Review comment:
The number underline characters needs to match the section name (same above)
##########
File path: Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst
##########
@@ -0,0 +1,141 @@
+==========
+Teensy-4.x
+==========
+
+The `Teensy 4.0 <https://www.pjrc.com/store/teensy40.html>`_ and `Teensy 4.1 <https://www.pjrc.com/store/teensy41.html>`_
+are development boards from PJRC. Both boards use i.MX RT1060 MCU, feature several I/Os pins and on-board LED.
+
+Features
+========
+
+- Processor
+ - MIMXRT1062DVL6A processor
+- Memory
+ - 1 MB RAM memory
+ - 2 MB Flash (Teensy 4.0)
+ - 8 MB Flash (Teensy 4.1)
+ - 1 SDIO (4 bit) native SD
+- Connectivity
+ - Micro USB host
+ - CAN transceivers
+ - UART, SPI, I2C
+ - PWM output pins
+ - 10/100 Mb Ethernet (Teensy 4.1 only)
+ - Digital audio in/out
+
+LEDs
+====
+
+There are two LED status indicators located on the Teensy-4.x board.
+The functions of these LEDs include:
+
+- RED LED (loading status)
+ - dim: ready
+ - bright: writing
+ - blink: no USB
+- USER LED (D3)
+
+Only a single LED, D3, is under software control.
+
+This LED is not used by the board port unless CONFIG_ARCH_LEDS is
+defined. In that case, the usage by the board port is defined in
+include/board.h and src/imxrt_autoleds.c. The LED is used to encode
+OS-related events as follows:
+
+=================== ======================= ======
+SYMBOL Meaning LED
+=================== ======================= ======
+LED_STARTED NuttX has been started OFF
+LED_HEAPALLOCATE Heap has been allocated OFF
+LED_IRQSENABLED Interrupts enabled OFF
+LED_STACKCREATED Idle stack created ON
+LED_INIRQ In an interrupt N/C
+LED_SIGNAL In a signal handler N/C
+LED_ASSERTION An assertion failed N/C
+LED_PANIC The system has crashed FLASH
+=================== ======================= ======
+
+Thus if the LED is statically on, NuttX has successfully booted and is,
+apparently, running normally. If the LED is flashing at approximately
+2Hz, then a fatal error has been detected and the system has halted.
+
+Configurations
+==============
+
+nsh-4.0:
+--------
+
+Configures the NuttShell (nsh) located at examples/nsh for Teensy 4.0.
+This NSH configuration is focused on low level, command-line driver testing.
+Built-in applications are supported, but none are enabled. NutShells then
+runs on USB console.
+
+nsh-4.1:
+--------
+
+Configures the NuttShell (nsh) located at examples/nsh for Teensy 4.1.
+This NSH configuration is focused on low level, command-line driver testing.
+Built-in applications are supported, but none are enabled. NutShells then
+runs USB console.
+
+can-4.1:
+--------
+
+This is an nsh configuration (see above) for Teensy-4.x with added support of
+CAN driver. All FlexCANs (CAN1, CAN2, CAN3) are chosen as default. FlexCAN3
+is FD capable. Please note that device driver name if counted from zero.
+That means for CAN1 -> can0, CAN2 -> can1 and CAN3 -> can2
+
+Bitrate and sample point can be also changed at System type peripheral selection,
+basic values are 1 MHz for bitrate and 0.80 for sample point. The FlexCAN driver
+for imxrt runs at 80 MHz clock frequency.
+
+The configuration also includes CAN utilities as candump and cansend.
+
+This configuration can be easily changed to work with Teensy 4.0 by
+selecting CONFIG_TEENSY_40=y.
+
+This configuration runs over LPUART1 (pins 24 and 25 on Teensy). Communication
+over USB console can be turn on, but it couses problems with FlexCAN.
+
+netnsh-4.1:
+-----------
+
+This configuration is similar to the nsh configuration except that is
+has networking enabled, both IPv4 and IPv6. This NSH configuration is
+focused on network-related testing.
+
+This configuration cannot be changed to Teensy 4.0 as this board does
+not have Ethernet capability.
+
+sd-4.1:
+-------
+
+This is an nsh configuration (see above) for Teensy-4.x with added support of
+connecting micro SD card.
+
+You can mount micro SD card by "mount -t vfat /dev/mmcsd0 /mnt"
Review comment:
```suggestion
You can mount micro SD card by:
.. code-block:: console
$ mount -t vfat /dev/mmcsd0 /mnt
```
##########
File path: Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst
##########
@@ -0,0 +1,141 @@
+==========
+Teensy-4.x
+==========
+
+The `Teensy 4.0 <https://www.pjrc.com/store/teensy40.html>`_ and `Teensy 4.1 <https://www.pjrc.com/store/teensy41.html>`_
+are development boards from PJRC. Both boards use i.MX RT1060 MCU, feature several I/Os pins and on-board LED.
+
+Features
+========
+
+- Processor
+ - MIMXRT1062DVL6A processor
+- Memory
+ - 1 MB RAM memory
+ - 2 MB Flash (Teensy 4.0)
+ - 8 MB Flash (Teensy 4.1)
+ - 1 SDIO (4 bit) native SD
+- Connectivity
+ - Micro USB host
+ - CAN transceivers
+ - UART, SPI, I2C
+ - PWM output pins
+ - 10/100 Mb Ethernet (Teensy 4.1 only)
+ - Digital audio in/out
+
+LEDs
+====
+
+There are two LED status indicators located on the Teensy-4.x board.
+The functions of these LEDs include:
+
+- RED LED (loading status)
+ - dim: ready
+ - bright: writing
+ - blink: no USB
+- USER LED (D3)
+
+Only a single LED, D3, is under software control.
+
+This LED is not used by the board port unless CONFIG_ARCH_LEDS is
+defined. In that case, the usage by the board port is defined in
+include/board.h and src/imxrt_autoleds.c. The LED is used to encode
+OS-related events as follows:
+
+=================== ======================= ======
+SYMBOL Meaning LED
+=================== ======================= ======
+LED_STARTED NuttX has been started OFF
+LED_HEAPALLOCATE Heap has been allocated OFF
+LED_IRQSENABLED Interrupts enabled OFF
+LED_STACKCREATED Idle stack created ON
+LED_INIRQ In an interrupt N/C
+LED_SIGNAL In a signal handler N/C
+LED_ASSERTION An assertion failed N/C
+LED_PANIC The system has crashed FLASH
+=================== ======================= ======
+
+Thus if the LED is statically on, NuttX has successfully booted and is,
+apparently, running normally. If the LED is flashing at approximately
+2Hz, then a fatal error has been detected and the system has halted.
+
+Configurations
+==============
+
+nsh-4.0:
+--------
+
+Configures the NuttShell (nsh) located at examples/nsh for Teensy 4.0.
+This NSH configuration is focused on low level, command-line driver testing.
+Built-in applications are supported, but none are enabled. NutShells then
+runs on USB console.
+
+nsh-4.1:
+--------
+
+Configures the NuttShell (nsh) located at examples/nsh for Teensy 4.1.
+This NSH configuration is focused on low level, command-line driver testing.
+Built-in applications are supported, but none are enabled. NutShells then
+runs USB console.
+
+can-4.1:
+--------
+
+This is an nsh configuration (see above) for Teensy-4.x with added support of
+CAN driver. All FlexCANs (CAN1, CAN2, CAN3) are chosen as default. FlexCAN3
+is FD capable. Please note that device driver name if counted from zero.
+That means for CAN1 -> can0, CAN2 -> can1 and CAN3 -> can2
+
+Bitrate and sample point can be also changed at System type peripheral selection,
+basic values are 1 MHz for bitrate and 0.80 for sample point. The FlexCAN driver
+for imxrt runs at 80 MHz clock frequency.
+
+The configuration also includes CAN utilities as candump and cansend.
+
+This configuration can be easily changed to work with Teensy 4.0 by
+selecting CONFIG_TEENSY_40=y.
Review comment:
```suggestion
selecting ``CONFIG_TEENSY_40=y``.
```
##########
File path: Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst
##########
@@ -0,0 +1,141 @@
+==========
+Teensy-4.x
+==========
+
+The `Teensy 4.0 <https://www.pjrc.com/store/teensy40.html>`_ and `Teensy 4.1 <https://www.pjrc.com/store/teensy41.html>`_
+are development boards from PJRC. Both boards use i.MX RT1060 MCU, feature several I/Os pins and on-board LED.
+
+Features
+========
+
+- Processor
+ - MIMXRT1062DVL6A processor
+- Memory
+ - 1 MB RAM memory
+ - 2 MB Flash (Teensy 4.0)
+ - 8 MB Flash (Teensy 4.1)
+ - 1 SDIO (4 bit) native SD
+- Connectivity
+ - Micro USB host
+ - CAN transceivers
+ - UART, SPI, I2C
+ - PWM output pins
+ - 10/100 Mb Ethernet (Teensy 4.1 only)
+ - Digital audio in/out
+
+LEDs
+====
+
+There are two LED status indicators located on the Teensy-4.x board.
+The functions of these LEDs include:
+
+- RED LED (loading status)
+ - dim: ready
+ - bright: writing
+ - blink: no USB
+- USER LED (D3)
+
+Only a single LED, D3, is under software control.
+
+This LED is not used by the board port unless CONFIG_ARCH_LEDS is
+defined. In that case, the usage by the board port is defined in
+include/board.h and src/imxrt_autoleds.c. The LED is used to encode
+OS-related events as follows:
+
+=================== ======================= ======
+SYMBOL Meaning LED
+=================== ======================= ======
+LED_STARTED NuttX has been started OFF
+LED_HEAPALLOCATE Heap has been allocated OFF
+LED_IRQSENABLED Interrupts enabled OFF
+LED_STACKCREATED Idle stack created ON
+LED_INIRQ In an interrupt N/C
+LED_SIGNAL In a signal handler N/C
+LED_ASSERTION An assertion failed N/C
+LED_PANIC The system has crashed FLASH
+=================== ======================= ======
+
+Thus if the LED is statically on, NuttX has successfully booted and is,
+apparently, running normally. If the LED is flashing at approximately
+2Hz, then a fatal error has been detected and the system has halted.
+
+Configurations
+==============
+
+nsh-4.0:
Review comment:
remove `:`
same thing on other subsections
##########
File path: Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst
##########
@@ -0,0 +1,141 @@
+==========
+Teensy-4.x
+==========
+
+The `Teensy 4.0 <https://www.pjrc.com/store/teensy40.html>`_ and `Teensy 4.1 <https://www.pjrc.com/store/teensy41.html>`_
+are development boards from PJRC. Both boards use i.MX RT1060 MCU, feature several I/Os pins and on-board LED.
+
+Features
+========
+
+- Processor
+ - MIMXRT1062DVL6A processor
+- Memory
+ - 1 MB RAM memory
+ - 2 MB Flash (Teensy 4.0)
+ - 8 MB Flash (Teensy 4.1)
+ - 1 SDIO (4 bit) native SD
+- Connectivity
+ - Micro USB host
+ - CAN transceivers
+ - UART, SPI, I2C
+ - PWM output pins
+ - 10/100 Mb Ethernet (Teensy 4.1 only)
+ - Digital audio in/out
+
+LEDs
+====
+
+There are two LED status indicators located on the Teensy-4.x board.
+The functions of these LEDs include:
+
+- RED LED (loading status)
+ - dim: ready
+ - bright: writing
+ - blink: no USB
+- USER LED (D3)
+
+Only a single LED, D3, is under software control.
+
+This LED is not used by the board port unless CONFIG_ARCH_LEDS is
+defined. In that case, the usage by the board port is defined in
+include/board.h and src/imxrt_autoleds.c. The LED is used to encode
+OS-related events as follows:
+
+=================== ======================= ======
+SYMBOL Meaning LED
+=================== ======================= ======
+LED_STARTED NuttX has been started OFF
+LED_HEAPALLOCATE Heap has been allocated OFF
+LED_IRQSENABLED Interrupts enabled OFF
+LED_STACKCREATED Idle stack created ON
+LED_INIRQ In an interrupt N/C
+LED_SIGNAL In a signal handler N/C
+LED_ASSERTION An assertion failed N/C
+LED_PANIC The system has crashed FLASH
+=================== ======================= ======
+
+Thus if the LED is statically on, NuttX has successfully booted and is,
+apparently, running normally. If the LED is flashing at approximately
+2Hz, then a fatal error has been detected and the system has halted.
+
+Configurations
+==============
+
+nsh-4.0:
+--------
+
+Configures the NuttShell (nsh) located at examples/nsh for Teensy 4.0.
+This NSH configuration is focused on low level, command-line driver testing.
+Built-in applications are supported, but none are enabled. NutShells then
+runs on USB console.
+
+nsh-4.1:
+--------
+
+Configures the NuttShell (nsh) located at examples/nsh for Teensy 4.1.
+This NSH configuration is focused on low level, command-line driver testing.
+Built-in applications are supported, but none are enabled. NutShells then
+runs USB console.
+
+can-4.1:
+--------
+
+This is an nsh configuration (see above) for Teensy-4.x with added support of
+CAN driver. All FlexCANs (CAN1, CAN2, CAN3) are chosen as default. FlexCAN3
+is FD capable. Please note that device driver name if counted from zero.
+That means for CAN1 -> can0, CAN2 -> can1 and CAN3 -> can2
+
+Bitrate and sample point can be also changed at System type peripheral selection,
+basic values are 1 MHz for bitrate and 0.80 for sample point. The FlexCAN driver
+for imxrt runs at 80 MHz clock frequency.
+
+The configuration also includes CAN utilities as candump and cansend.
+
+This configuration can be easily changed to work with Teensy 4.0 by
+selecting CONFIG_TEENSY_40=y.
+
+This configuration runs over LPUART1 (pins 24 and 25 on Teensy). Communication
+over USB console can be turn on, but it couses problems with FlexCAN.
+
+netnsh-4.1:
+-----------
+
+This configuration is similar to the nsh configuration except that is
+has networking enabled, both IPv4 and IPv6. This NSH configuration is
+focused on network-related testing.
+
+This configuration cannot be changed to Teensy 4.0 as this board does
+not have Ethernet capability.
+
+sd-4.1:
+-------
+
+This is an nsh configuration (see above) for Teensy-4.x with added support of
+connecting micro SD card.
+
+You can mount micro SD card by "mount -t vfat /dev/mmcsd0 /mnt"
+
+This configuration cannot be changed to Teensy 4.0 as this board does
+not have micro SD card slot.
+
+lcd-4.1
+-------
+
+This is an nsh configuration (see above) for Teensy-4.x with added support of
+connecting LCD TFT display with ST7789 controller. You can run framebuffer demo
+by starting "fb" in console. The LCD display is connected via SPI4.
+
+This configuration can be easily changed to work with Teensy 4.0 by
+selecting CONFIG_TEENSY_40=y.
+
+
+Flash
+=====
+
+Teensy 4.x boards does not have debugger therefore external firmware has to be used to load NuttX.
+`Teensy Loader <https://www.pjrc.com/teensy/loader_cli.html>`_ can be installed and then NuttX can be loaded by
+
+ teensy_loader_cli --mcu=TEENSY41 -v -w nuttx.hex
+
+For Teensy 4.0 board, switch --mcu=TEENSY41 to --mcu=TEENSY40.
Review comment:
```suggestion
.. code-block:: console
$ teensy_loader_cli --mcu=TEENSY41 -v -w nuttx.hex
For Teensy 4.0 board, switch ``--mcu=TEENSY41`` to ``--mcu=TEENSY40``.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] michallenc edited a comment on pull request #3539: Documentation: added documentation for i.MX RT series and Teensy 4.x boards
Posted by GitBox <gi...@apache.org>.
michallenc edited a comment on pull request #3539:
URL: https://github.com/apache/incubator-nuttx/pull/3539#issuecomment-818802047
> > @v01d $ mount -t vfat /dev/mmcsd0 /mnt seems to ignore that line completely, maybe change $ to #?
>
> Maybe a blank line is needed between the code-block and the content.
You´re right, that helped. Thanks, all changes should be done.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on a change in pull request #3539: Documentation: added documentation for i.MX RT series and Teensy 4.x boards
Posted by GitBox <gi...@apache.org>.
v01d commented on a change in pull request #3539:
URL: https://github.com/apache/incubator-nuttx/pull/3539#discussion_r612526345
##########
File path: Documentation/platforms/arm/imxrt/index.rst
##########
@@ -0,0 +1,191 @@
+=======
+i.MX RT
+=======
+
+The i.MX RT series of chips from NXP Semiconductors is based around an ARM Cortex-M7 core running
+at 500 MHz, 600 MHz or 1 GHz based on particular MCUs
+
+Suported MCUs
+=============
+
+The following list includes MCUs from i.MX RT series and indicates whether they are supported in NuttX
+
+====== ======= ============== =================
+MCU Support Core Frequency
+====== ======= ============== =================
+RT500 No Cortex-M33 200 MHz
+RT600 No Cortex-M33 300 MHz
+RT1010 No Cortex-M7 500 MHz
+RT1015 No Cortex-M7 500 MHz
+RT1020 Yes Cortex-M7 500 MHz
+RT1024 No Cortex-M7 500 MHz
+RT1050 Yes Cortex-M7 600 MHz
+RT1060 Yes Cortex-M7 600 MHz
+RT1064 Yes Cortex-M7 600 MHz
+RT1170 No Cortex-M7 + M4 1 GHz + 400 MHz
+====== ======= ============== =================
+
+Data and Instruction Cache
+==========================
+
+MCUs i.MX RT1010 and higher have separated caches for instructions and data. Data cache is initially
+set as write-through but can be changed to write-back via Kconfig. While write-back gives better
+performance than write-through, it is not supported for all peripherals in NuttX yet. Write-back data
+cache can not be selected while running Ethernet or serial port over USB.
+
+Peripheral Support
+==================
+
+The following list indicates peripherals supported in NuttX:
+
+========== =======
+Peripheral Support
+========== =======
+ACMP No
+ADC Yes
+CAN Yes
+CSI No
+DAC No
+eLCDIF Yes
+ENC Yes
+ENET Yes
+FlexIO No
+GPIO Yes
+I2S Yes
+PWM No
+SAI No
+SPDIF No
+SPI Yes
+UART Yes
+USB Yes
+========== =======
+
+ACMP
+----
+
+The circout for comparing two analog input voltages designed to operate across the full
+range of supply voltage (rail-to-rail operation).
+
+ADC
+---
+
+ADC driver with the successive approximation analog/digital convertor. The lower-half of
+this driver is initialize by calling :c:func:`imxrt_adcinitialize`.
+
+CAN
+---
+
+FlexCAN driver is supported in MCUs i.MX RT1020 and higher. i.MX RT106x have both classical
+CAN and also one CAN FD while i.MX RT1170 have 3 CAN FD peripherals. FlexCAN driver in imxrt
+works beyond SocketCAN driver layout. The lower-half of this driver is initialize by
+calling :c:func:`imxrt_cannitialize()`.
+
+There is an booting option that automatically provides initialization of network interface
+in the early stages of booting and therefore calling :c:func:`imxrt_cannitialize()` via
+board specific logic is not neccessary. This however works only when there is only one
+interface in the chip. For running more interfaces (like CAN and Ethernet), network late
+initialization must be turn on by CONFIG_NETDEV_LATEINIT and board specific logic must call
+lower-half part of drivers.
+
+CSI
+---
+
+CMOS Sensor interface which enables the chip to connect directly to external CMOS image sensors.
+
+DAC
+---
+
+Digital/analog convertor for external signal is only supported in i.MX RT1170 MCU. It is 12 bit
+lower power, general purpose DAC.
+
+eLCDIF
+------
+
+The enhanced Liquid Crystal Display interface (LCDIF) is a general purpose display controller.
+
+ENC
+---
+
+The enhanced quadrature encoder/decoder module supported in i.MX RT1015 and higher. The lower-half
+of this driver is initialize by calling :c:func:`imxrt_qeinitialize`.
+
+ENET
+----
+
+Ethernet driver supported in i.MX RT1020 and higher. The lower-half of this driver is initialize
+by calling :c:func:`imxrt_netnitialize`.
+
+There is an booting option that automatically provides initialization of network interface
+in the early stages of booting and therefore calling :c:func:`imxrt_cannitialize()` via
+board specific logic is not neccessary. This however works only when there is only one
+interface in the chip. For running more interfaces (like CAN and Ethernet), network late
+initialization must be turn on by CONFIG_NETDEV_LATEINIT and board specific logic must call
+lower-half part of drivers.
+
+FlexIO
+------
+
+A configurable module providing a range of functionality like emulation of a variety of
+serial/parallel communication protocols, flexible 16-bit timers or programmable logic blocks.
+This module is supported in i.MX RT1010 and higher.
+
+GPIO
+----
+
+Pins can be configured using ``imxrt_config_gpio()`` function. Writing to pins is
+done by ``imxrt_gpio_write()`` function and reading is done by ``imxrt_gpio_read()``.
Review comment:
Use :c:func:
Not really critical now but it is good to have when we eventully add proper documentation for all these functions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] michallenc commented on pull request #3539: Documentation: added documentation for i.MX RT series and Teensy 4.x boards
Posted by GitBox <gi...@apache.org>.
michallenc commented on pull request #3539:
URL: https://github.com/apache/incubator-nuttx/pull/3539#issuecomment-818797454
@v01d $ mount -t vfat /dev/mmcsd0 /mnt seems to ignore that line completely, maybe change $ to #?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] v01d commented on pull request #3539: Documentation: added documentation for i.MX RT series and Teensy 4.x boards
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #3539:
URL: https://github.com/apache/incubator-nuttx/pull/3539#issuecomment-818798756
> @v01d $ mount -t vfat /dev/mmcsd0 /mnt seems to ignore that line completely, maybe change $ to #?
Maybe a blank line is needed between the code-block and the content.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org