nuttx/boards/arm/s32k3xx/mr-canhubk3
Xiang Xiao 2c5f653bfd Remove the tail spaces from all files except Documentation
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2023-02-26 13:24:24 -08:00
..
configs
include
kernel
scripts Remove the tail spaces from all files except Documentation 2023-02-26 13:24:24 -08:00
src
Kconfig
README.txt

README
======

This directory holds the port to the NXP MR-CANHUBK3 board.

Contents
========

  o Status
  o Serial Console
  o LEDs and Buttons
  o Configurations

Status
======

  2021-09-28:  Configuration created (copy-paste from S32K344EVB).
    Remains untested, because hardware is not available yet.

  TODO:  Need to calibrate the delay loop.  The current value of
  CONFIG_BOARD_LOOPSPERMSEC is a bogus value retained from a copy-paste
  (see apps/examples/calib_udelay).

Serial Console
==============

  By default, the serial console will be provided on the DCD-LZ UART
  (available on the 7-pin DCD-LZ debug connector P6):

    DCD-LZ UART RX  PTA8  (LPUART2_RX)
    DCD-LZ UART TX  PTA9  (LPUART2_TX)

LEDs and Buttons
================

  LEDs
  ----
  The MR-CANHUBK3 has one RGB LED:

    RedLED    PTE14  (FXIO D7 / EMIOS0 CH19)
    GreenLED  PTA27  (FXIO D5 / EMIOS1 CH10 / EMIOS2 CH10)
    BlueLED   PTE12  (FXIO D8 / EMIOS1 CH5)

  An output of '0' illuminates the LED.

  If CONFIG_ARCH_LEDS is not defined, then the user can control the LEDs in
  any way.  The following definitions are used to access individual RGB
  components (see mr-canhubk3.h):

    GPIO_LED_R
    GPIO_LED_G
    GPIO_LED_B

  The RGB components could, alternatively, be controlled through PWM using
  the common RGB LED driver.

  If CONFIG_ARCH_LEDs is defined, then NuttX will control the LEDs on board
  the MR-CANHUBK3.  The following definitions describe how NuttX controls the
  LEDs:

    ==========================================+========+========+=========
                                                 RED     GREEN     BLUE
    ==========================================+========+========+=========

    LED_STARTED      NuttX has been started      OFF      OFF      OFF
    LED_HEAPALLOCATE Heap has been allocated     OFF      OFF      ON
    LED_IRQSENABLED  Interrupts enabled          OFF      OFF      ON
    LED_STACKCREATED Idle stack created          OFF      ON       OFF
    LED_INIRQ        In an interrupt                   (no change)
    LED_SIGNAL       In a signal handler               (no change)
    LED_ASSERTION    An assertion failed               (no change)
    LED_PANIC        The system has crashed      FLASH    OFF      OFF
    LED_IDLE         S32K344 in sleep mode             (no change)
    ==========================================+========+========+=========

  Buttons
  -------
  The MR-CANHUBK3 supports two buttons:

    SW1  PTD15  (EIRQ31)
    SW2  PTA25  (EIRQ5 / WKPU34)

Configurations
==============

  Common Information
  ------------------
  Each MR-CANHUBK3 configuration is maintained in a sub-directory and can be
  selected as follows:

    tools/configure.sh mr-canhubk3:<subdir>

  Where <subdir> is one of the sub-directories listed in the next paragraph.

    NOTES (common for all configurations):

    1. This configuration uses the mconf-based configuration tool.  To change
       this configuration using that tool, you should:

       a. Build and install the kconfig-mconf tool.  See nuttx/README.txt.
          Also see additional README.txt files in the NuttX tools repository.

       b. Execute 'make menuconfig' in nuttx/ in order to start the
          reconfiguration process.

    2. Unless otherwise stated, the serial console used is LPUART1 at
       115,200 8N1.  This corresponds to the OpenSDA VCOM port.

  Configuration Sub-directories
  -----------------------------

    nsh:
    ---
      Configures the NuttShell (nsh) located at apps/examples/nsh.  Support
      for builtin applications is enabled, but in the base configuration the
      only application selected is the "Hello, World!" example.