summaryrefslogtreecommitdiff
path: root/nuttx/configs/efm32-g8xx-stk/README.txt
blob: d84035e2b7e6fc2a1f6a40ceca91cd1a85907a56 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
README
======

  This README file discusses the port of NuttX to the Silicon Labs EFM32™ Gecko Starter Kit (EFM32-G8XX-STK). The Gecko Starter Kit features:

    • EFM32G890F128 MCU with 128 kB flash and 16 kB RAM
    •   32.768 kHz crystal
    •   32 MHz crystal
    • Advanced Energy Monitoring
    • Touch slider
    • 4x40 LCD
    • 4 User LEDs
    • 2 pushbutton switches
    • Reset button and a switch to disconnect the battery.
    • On-board SEGGER J-Link USB emulator
    •   ARM 20 pin JTAG/SWD standard Debug in/out connector

LEDs
====

  The EFM32 Gecko Start Kit has four yellow LEDs.  These LEDs are connected
  as follows:

  ------------------------------------- --------------------
  EFM32 PIN                             BOARD SIGNALS
  ------------------------------------- --------------------
  C0/USART1_TX#0/PCNT0_S0IN#2/ACMP0_CH0  MCU_PC0  UIF_LED0
  C1/USART1_RX#0/PCNT0_S1IN#2/ACMP0_CH1  MCU_PC1  UIF_LED1
  C2/USART2_TX#0/ACMP0_CH2               MCU_PC2  UIF_LED2
  C3/USART2_RX#0/ACMP0_CH3               MCU_PC3  UIF_LED3
  ------------------------------------- --------------------

  All LEDs are grounded and so are illuminated by outputting a high
  value to the LED.

  These LEDs are 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/efm32_autoleds.c.  The LEDs are used to
  encode OS-related events as follows:

    SYMBOL             Meaning                 LED1*  LED2   LED3   LED4
    ----------------- -----------------------  ------ -----  -----  ------
    LED_STARTED       NuttX has been started   ON     OFF    OFF    OFF
    LED_HEAPALLOCATE  Heap has been allocated  OFF    ON     OFF    OFF
    LED_IRQSENABLED   Interrupts enabled       ON     ON     OFF    OFF
    LED_STACKCREATED  Idle stack created       OFF    OFF    ON     OFF
    LED_INIRQ         In an interrupt**        ON     N/C    N/C    OFF
    LED_SIGNAL        In a signal handler***   N/C    ON     N/C    OFF
    LED_ASSERTION     An assertion failed      ON     ON     N/C    OFF
    LED_PANIC         The system has crashed   N/C    N/C    N/C    ON
    LED_IDLE          STM32 is is sleep mode   (Optional, not used)

  * If LED1, LED2, LED3 are statically on, then NuttX probably failed to boot
    and these LEDs will give you some indication of where the failure was
 ** The normal state is LED3 ON and LED1 faintly glowing.  This faint glow
    is because of timer interrupt that result in the LED being illuminated
    on a small proportion of the time.
*** LED2 may also flicker normally if signals are processed.

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

  Pin Availability
  ----------------
  The EFM32G890F128 support the following options for serial output.  NOTE
  (1) that not all of these pins are available for use as a serial console,
  however.  And (2) not all pins made available by the board.

    EFM32 PIN  GPIO NOTES/CONFLICTS/AVAILABILITY
    ------- -- ---- ----------------------------------------------
     US0_RX #0 PE11 LCD_PE11, LCD_SEG7
     US0_RX #1 PE6  LCD_PE6, LCD_COM2
     US0_RX #2 PC10 UIF_SLIDER2

     US0_TX #0 PE10 LCD_PE10, LCD_SEGG
     US0_TX #1 PE7  LCD_PE7, LCD_COM3
     US0_TX #2 PC11 UIF_SLIDER3
    ------- -- ----
     US1_RX #0 PC1  UIF_LED1
     US1_RX #1 PD1  Not connected on this board

     US1_TX #0 PC0  UIF_LED0
     US1_TX #1 PD0  Not connected on this board
    ------- -- ----
     US2_RX #0 PC3  UIF_LED3
     US2_RX #1 PB4  LCD_PB4, LCD_SEG21

     US2_TX #0 PC2  UIF_LED2
     US2_TX #1 PB3  LCD_PB3, LCD_SEG20
    ------- -- ----
      U0_RX #1 PE1  **AVAILABLE at TP130** (if BC_EN is low, see below)
      U0_RX #2 PA4  LCD_PA4, LCD_SEG17

      U0_TX #0 PF6  LCD_PF6, LCD_SEG24
      U0_TX #1 PE0  **AVAILABLE at TP129** (if BC_EN is low, see below)
      U0_TX #2 PA3  LCD_PA3, LCD_SEG16
      U0_TX #3 PC14 **AVAILABLE at TP117**
    ------- -- ----
    LEU0_RX #0 PD5  **AVAILABLE at TP123 and EXP port pin 14**
    LEU0_RX #1 PB14 CTRLMCU_SPI_MISO
    LEU0_RX #2 PE15 LCD_PE15, LCD_SEG11

    LEU0_TX #0 PD4  **AVAILABLE at TP122 and EXP port pin 12**
    LEU0_TX #1 PB13 CTRLMCU_SPI_SCK
    LEU0_TX #2 PE14 LCD_PE14, LCD_SEG10
    ------- -- ----
    LEU1_RX #0 PC7  DEBUG_MCU_SW_ENABLE
    LEU1_RX #1 PA6  DEBUG_TDI_IN

    LEU1_TX #0 PC6  DEBUG_DH_SW_ENABLE
    LEU1_TX #1 PA5  DEBUG_TMS_SWDIO_IN
    ------- -- ----

   Default Serial Console
   ----------------------
   UART0 is configured as the default serial console at 115200 8N1
   on pins PE0 and PE1.

   Communication through the Board Controller
   ------------------------------------------
   The control MCU acts as a board controller (BC). There is a UART
   connection between the EFM and the BC. The connection is made by
   setting the BC_EN line high. The EFM can then use the BSP to send
   commands to the BC. When BC_EN is low, BC_TX and BC_RX can be used
   by other applications.

Configurations
==============
  Each EFM32 Gecko Starter Kit configuration is maintained in a sub-director
  and can be selected as follow:

    cd tools
    ./configure.sh efm32-g8xx-stk/<subdir>
    cd -
    . ./setenv.sh

  If this is a Windows native build, then configure.bat should be used
  instead of configure.sh:

    configure.bat STM32F4Discovery\<subdir>

  Where <subdir> is one of the following:

  nsh:
  ---
    Configures the NuttShell (nsh) located at apps/examples/nsh.  The
    Configuration enables the serial interfaces on USARTx.  Support for
    builtin applications is enabled, but in the base configuration no
    builtin applications are selected (see NOTES below).

    NOTES:

    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
          and misc/tools/

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

    2. By default, this configuration uses the CodeSourcery toolchain
       for Windows and builds under Cygwin (or probably MSYS).  That
       can easily be reconfigured, of course.

       CONFIG_HOST_WINDOWS=y                   : Builds under Windows
       CONFIG_WINDOWS_CYGWIN=y                 : Using Cygwin
       CONFIG_ARMV7M_TOOLCHAIN_CODESOURCERYW=y : CodeSourcery for Windows