BoardSupportPackageH747 < MecrispCube

%DASHBOARD{ section="dashboard_start" }%
%DASHBOARD{ section="banner"
 image="%PUBURLPATH%/MecrispCube/BoardSupportPackageH747/portenta-h7.jpg"
 title="Board Support Package for the Arduino Portenta H7 Development Board"
 titlestyle="color:#F00000;"
}%
%DASHBOARD{ section="box_start" title="Intro" width="485" height="200"}%
_DRAFT_

The board support package for the Arduino [[https://docs.arduino.cc/hardware/portenta-h7][Portenta H7]] Board is restricted to the Arduino MKR pin header and the onboard RGB LED. The !STM32H747 has much more capabilities then 15 digital I/O pins, 7 analog input pins, UART, SPI, and !I2C interfaces. But if you want to use the more advanced features you can use the !CubeMX to create source code for the internal peripherals. This project wants to show how to use the Cube Ecosystem for a Forth system (or vice versa) and can't implement all features and possibilities the !STM32H747 has. It is a good starting point for your project.
%DASHBOARD{ section="box_end" }%
%DASHBOARD{ section="box_start" title="Contents" width="460" height="200"}%
%TOC%
%DASHBOARD{ section="box_end" }%
%DASHBOARD{ section="box_start"  width="992" height="600" }%
---+ Overview

   * 512? !KiB RAM dictionary, 8 !MiB external DRAM ([[https://www.alliancememory.com/wp-content/uploads/pdf/dram/64M-AS4C4M16SA-CI_v3.0_March%202015.pdf][AS4C4M16SA]])
   * 1 !MiB Flash dictionary 
   * Forth as CMSIS-RTOS thread. CMSIS-RTOS API to use [[https://en.wikipedia.org/wiki/FreeRTOS][FreeRTOS]] from Forth. 
   * Buffered [[TerminalIO][terminal I/O]] (5 !KiB buffer for UART Rx). Interrupt driven and RTOS aware, =key= and =emit= block the calling thread. 
      * !USART1: D0 RX, D1 TX
      * !USART3: ST-LINK VCP
   * [[TerminalIO#USB_CDC_Serial_Communication_API][USB-CDC]] for serial communication via USB. Redirect console I/O like =cdc-emit=, =cdc-key= 
   * [[MicroSdBlocks][microSD and internal Flash mass storage]] for blocks and FAT filesystem. 
      * Internal Flash drive 0:, 16 !MiB (QSPI peripheral MX25L12833F?) or 128 !MiB (TC58CVG0S3HRAIG, 2 !KiB pages, 128 !KiB Blocks)
      * microSD drive 1: (optional e.g. on breakout board)
      * [[MicroSdBlocks#Filesystem_API][Filesystem API]]
      * [[MicroSdBlocks#UNIX_like_Shell_Commands][UNIX like Shell commands]]
   * LEDs: LED1 (green, PB0), LED2 (yellow, PE1), LED3 (red, PB14)
   * Switch: SW1, Push button (D7, PC13)
   * Digital and analog pins, Arduino MKT Header
      * Digital port pins: D0 to D14
      * Analog port pins: A0 to A6
      * PWM: 
         * TIM1: D3, D4, D5, D6
         * TIM3: D11, D12
         * TIM4: D0, D1, D9, D10
      * Input capture TIM2: A0 
      * Output compare TIM2: D13
      * EXTI: D11, D12, D13
   * SPI: D2 SCK, D3 MISO, D4 MOSI (e.g. for display, memory)
   * !I2C: D14 SDA, D15 SCL (external peripherals) 
   * [[EditorVi][vi Editor]] origin in !BusyBox tiny vi. Workflow development: =begin Edit EVALUATE while !SaveFile repeat= 
   * [[RealTimeClock][Real Time Clock]] (32 bit UNIX time stamp, valid times are from 1.1.2000 to 31.12.2099 because of the !STM32WB RTC peripheral) =time!=, =time@=, and =.time= (YYYY-MM-DDTHH:MM:SS ISO 8601). 
 
Defaults: 
   * Digital port pins D2 to D13 are inputs
   * D0 (UART_RX) is input with internal pull-up resistor, D1 (UART_TX) is output
   * D14 (SDA) and D15 (SCL) are open drain outputs with internal pull-up resistors

%DASHBOARD{ section="box_end" }%

%DASHBOARD{ section="box_start"  width="992" height="600" }%
---+ Board Support Words

<pre>
led1!        ( n -- )    sets LED1 (green)
led2!        ( n -- )    sets LED2 (yellow)
led3!        ( n -- )    sets LED3 (red)
led1@        ( -- n )    gets LED1 (green)
led2@        ( -- n )    gets LED2 (yellow)
led3@        ( -- n )    gets LED3 (red)

switch1?     ( -- n )    gets switch1 (button A), closed=TRUE
dport!       ( n -- )    sets the digital output port (D0=bit0 .. D15=bit15).
dport@       ( -- n )    gets the digital input/output port (D0=bit0 .. D15=bit15).
dpin!        ( n a -- )  sets the digital output port pin a (D0=0 .. D15=15, A0=16 .. A6=23)
dpin@        ( a -- n )  gets the digital input/output port pin a
dmod         ( u a -- )  sets the pin mode: 0 in, 1 in pull-up, 2 in pull-down, 3 out push pull, 4 out open drain, 
                                            5 out push pull PWM, 6 input capture, 7 output compare, 8 I2C, 9 USART, 10 analog

EXTImod      ( u a -- )  Sets for pin a (D11, D12, D13) the EXTI mode u: 0 rising, 1 falling, 2 both edges, 3 none
EXTIwait     ( u a -- )  Wait for EXTI interrupt on pin a (D11, D12, D13), timeout u in [ms]

pwmpin!      ( u a -- )  sets the digital output port pin a (D5=5, D6=6, D9=9, D10=10, D14=14, and D15=15) to a PWM value u (0..1000).
                           Default frequency is 1 kHz, TIMER3/TIMER4
pwmprescale  ( u --  )   Sets the PWM prescale for TIMER3/TIMER4. 42 kHz / prescale, default 42 -> PWM frequency 1 kHz

ICOCprescale ( u -- )    Sets the input capture / output compare prescale for TIMER2. default 42 -> 42 MHz / 42 = 1 MHz, timer resolution 1 us
ICOCperiod!  ( u -- )    Sets the input capture / output compare (TIMER2) period. default $FFFFFFFF (4'294'967'295). 
                         When the up counter reaches the period, the counter is set to 0. 
                         For prescale 32 the maximum time is about 1 h 11 m
ICOCcount!   ( -- u )    Sets the input capture / output compare counter for TIMER2
ICOCcount@   ( u -- )    Gets the input capture / output compare counter for TIMER2
ICOCstart    ( -- )      Starts the ICOC period
ICOCstop     ( -- )      Stops the ICOC period
OCmod        ( u a -- )  Sets for pin a (D0, D1) the Output Compare mode u: 0 frozen, 1 active level on match, 
                           2 inactive level on match, 3 toggle on match, 4 forced active, 5 forced inactive
    
OCstart      ( u a -- )  Starts the output compare mode for pin a with pulse u
OCstop       ( a -- )    Stops output compare for pin a
ICstart      ( u -- )    Starts input capture u: 0 rising edge, 1 falling edge, 2 both edges
ICstop       ( -- )      Stops input capture

waitperiod   ( -- )      wait for the end of the TIMER2 period
OCwait       ( a -- )    wait for the end of output capture on pin a
ICwait       ( u -- u )  wait for the end of input capture with timeout u, returns counter u

apin@        ( a -- u )  gets the analog input port pin (A0=0 .. A6=6). Returns a 12 bit value (0..4095) 
</pre>
%DASHBOARD{ section="box_end" }%

%DASHBOARD{ section="box_start"  width="992" height="520" }%
---+ Using the Digital Port Pins (Input and Output)

Set 8 port pins to push/pull output
<pre>
3 15 dmod   \ set D15 (SCL) to Output
3 5  dmod   \ set D5 to Output
3 6  dmod   \ set D6 to Output
3 9  dmod   \ set D9 to Output
3 10 dmod   \ set D10 to Output
3 11 dmod   \ set D11 to output
3 12 dmod   \ set D12 to output
3 13 dmod   \ set D13 to output
</pre>

remap D15, D5, ..  D13
<pre>
create port-map 15 , 5 , 6 , 9 , 10 , 11 , 12 , 13 ,

: pin ( n -- n )  \ gets the Dx pin number
  cells port-map + @
;
</pre>

 <table>
  <tr>
    <td>
<pre>
: left ( -- ) 
  7 0 do
    1 i pin dpin! 
    100 osDelay drop  
    0 i pin dpin!
  loop 
;
</pre>
    </td>
    <td>
<pre>
: right ( -- )
  8 1 do  
    1 8 i - pin dpin! 
    100 osDelay drop  
    0 8 i - pin dpin!
  loop 
;
</pre>
    </td>
    <td>
<pre>
: knigthrider ( -- )
  begin 
    left right 
    key? 
  until    \ key pressed
  0 0 dpin!
  key drop     \ eat key
;
</pre>
    </td>
  </tr>
</table> 

Use the port pins on the lower row:
<pre>
3 16 dmod   \ set A0 to Output
3 17 dmod   \ set A1 to Output
3 18 dmod   \ set A2 to Output
3 19 dmod   \ set A3 to Output
3 20 dmod   \ set A4 to Output
3 21 dmod   \ set A5 to output
3 2 dmod    \ set D2 (SCK) to output
3 4 dmod    \ set D4 (MOSI) to output
</pre>

remap D15, D5, ..  D13
<pre>
create port-map 16 , 17 , 18 , 19 , 20 , 21 , 2 , 4 ,
</pre>

%DASHBOARD{ section="box_end" }%

%DASHBOARD{ section="box_start"  width="992" height="650" }%
---+ Using the ADC (Analog Input Pins)

---++ Control the Neopixel

=apin@ ( a -- u )= returns the ADC value (12 bit, 0 .. 4095) from one of the analog pins A0 to A5 (0 .. 5). Here I use the A0 to control the neopixel blue led brightness.
<pre>
: neo-blue ( -- ) 
  begin
    0 apin@ 16 /  neopixel! 
    10 osDelay drop
  key? until 
  key drop
;
</pre>

---++ Control the Knightrider Pace

=apin@ ( a -- u )= returns the ADC value (12 bit, 0 .. 4095) from one of the analog pins A0 to A5 (0 .. 5). Here I use the A0 to control the delay.

 <table>
  <tr>
    <td>
<pre>
: left ( -- ) 
  7 0 do
    1 i pin dpin! 
    0 apin@ 10 / osDelay drop  \ delay depends on A0
    0 i pin dpin!
  loop 
;
</pre>
    </td>
    <td>
<pre>
: right ( -- )
  8 1 do  
    1 8 i - pin dpin! 
    0 apin@ 10 / osDelay drop  \ delay depends on A0
    0 8 i - pin dpin!
  loop 
;
</pre>
    </td>
  </tr>
</table> 



%DASHBOARD{ section="box_end" }%

%DASHBOARD{ section="box_start"  width="992" height="400" }%
---+ Using the PWM (Analog Output Pins)

Six port pins are supported so far. 
The 16 bit timers TIM3 (D5 and D6) and TIM4 (D9, D10, D14, and D15) are used for the timebase, time resolution is 1 us (42 MHz !SysClk divided by 42). The PWM scale is from 0 (0 % duty cycle) to 1000 (100 % duty cycle), this results in a PWM frequency of 1 kHz. If you need higher PWM frequencies, decrease the divider and/or the scale.

PWM port pins: D5 (!TIM3CH2), D6 (!TIM3CH1), D9 (!TIM4CH3), D10 (!TIM4CH4), D14 (!TIM4CH2), and D15 (!TIM4CH1).

Simple test program to set brightness of a LED on pin D6 with a potentiometer on A0. Default PWM frequency is 1 kHz (prescaler set to 42). You can set the prescale with the word =pwmprescale= from 42 kHz (value 1) down to 0.5 Hz (64000).
<pre>
5 6 dmod   \ set D6 to PWM

: pwm ( -- )
  begin 
    0 apin@  4 /  6 pwmpin!
    10 osDelay drop
    key? 
  until
  key drop
;
</pre>


---++ Control an RC Servo

https://en.wikipedia.org/wiki/Servo_(radio_control): 
The control signal is a digital PWM signal with a 50 Hz frame rate. Within each 20 ms timeframe, an active-high digital pulse controls the position. The pulse nominally ranges from 1.0 ms to 2.0 ms with 1.5 ms always being center of range. Pulse widths outside this range can be used for "overtravel" - moving the servo beyond its normal range. 

A servo pulse of 1.5 ms width will typically set the servo to its "neutral" position (typically half of the specified full range), a pulse of 1.0 ms will set it to 0°, and a pulse of 2.0 ms to 90° (for a 90° servo). The physical limits and timings of the servo hardware varies between brands and models, but a general servo's full angular motion will travel somewhere in the range of 90° – 180° and the neutral position (45° or 90°) is almost always at 1.5 ms. This is the "standard pulse servo mode" used by all hobby analog servos. 

The BSPs default PWM frequency is 1 kHz, 50 Hz is 20 times slower. The divider is therefore 42 * 20 = 840. 
|   0° | 1 ms   | 50  | 
|  45° | 1.5 ms | 75  | 
|  90° | 2 ms   | 100 | 
| 180° | 3 ms   | 150 | 
| 270  | 4 ms   | 200 | 

|   0° | 1 ms   | 50  | 
|  90° | 1.5 ms | 75  | 
| 180° | 2 ms   | 100 | 
| 270° | 2.5 ms | 150 | 
 


<pre>
840 pwmprescale 
5 5 dmod   \ set D5 to PWM

: servo ( -- ) 
  begin
    130 40 do
      i 5 pwmpin! 
      i neopixel! 
      i 40 = if 
        1000 \ give some more time to get back
      else
        200
      then 
      osDelay drop
    10 +loop
  key? until 
  key drop
;
</pre>



%DASHBOARD{ section="box_end" }%

%DASHBOARD{ section="box_start"  width="992" height="500" }%
---+ Using Input Capture and Output Compare

---++ Time Base

Default timer resolution is 1 us. The 32 bit TIMER2 is used as time base for Input Capture / Output Compare. For a 5 s period 5'000'000 cycles are needed. 
All channels (input capture / output compare) use the same time base.
<pre>
: period ( -- )
  5000000 ICOCperiod! \ 5 s period
  ICOCstart
  begin
     waitperiod
     cr .time
  key? until
  key drop 
;
</pre>


---++ Output Compare
Output compare TIM2: D0, D1

<pre>
7 0 dmod  \ output compare for D0
7 1 dmod  \ output compare for D1

: oc-toggle ( -- )
  5000000 ICOCperiod! \ 5 s period
  ICOCstart
  3 0 OCmod  1000000 0 OCstart \ toggle D0 after 1 s
  3 1 OCmod  2000000 1 OCstart \ toggle D1 after 2 s
  begin
     waitperiod
     cr .time
  key? until
  key drop 
;
</pre>

When you abort (hit any key) the program, the timer still runs and controls the port pins. To stop the port pins:
<pre>
0 OCstop  1 OCstop  
</pre>

Or change the prescale to make it faster or slower:
<pre>
1 ICOCprescale
</pre>


---++ Input Capture

This sample program measures the time between the edges on port A1. if no event occurs within 2 seconds, "timeout" is issued. Hit any key to abort program.
<pre>
: ic-test ( -- )
  6 17 dmod \ input capture on A1
  ICOCstart
  2 ICstart  \ both edges
  ICOCcount@ ( -- count )
  begin
    2000 \ 2 s timeout
    ICwait ( -- old-capture capture ) 
    cr
    dup 0= if
      ." timeout" drop
    else 
      dup rot ( -- capture capture old-capture )
      - 1000 / . ." ms"
    then
  key? until
  key drop
  drop
  ICstop
;

</pre>



%DASHBOARD{ section="box_end" }%

%DASHBOARD{ section="box_start"  width="992" height="400" }%
---+ Using EXTI line

D11, D12, and D13 can be used as an EXTI line. EXTIs are external interrupt lines, D13 uses EXTI1 (EXTI Line1 interrupt), D12 EXIT2, and D11 EXTI3. 

<pre>
: exti-test ( -- )
  2 11 EXTImod \ both edges on D11
  begin
    2000 11 EXTIwait \ wait for edge on D11 with 2 s timeout
    cr
    0= if
      11 dpin@ if
        ." rising edge"
      else
        ." falling edge"
      then 
    else
      ." timeout"
    then
  key? until
  key drop
;
</pre>


%DASHBOARD{ section="box_end" }%

%DASHBOARD{ section="box_start"  width="992" height="800" }%

---+ Pinouts

This Arduino Portenta H7 development board follows the Arduino MKR form factor, but enhanced with the Portenta family 80 pin high-density connector. 

The BSP supports only the MKR pins, the high-density connector is not supported yet.

https://docs.arduino.cc/hardware/portenta-h7

%IMAGE{"%PUBURLPATH%/MecrispCube/MecrispCubeH74x/portenta-h7-pinout.png" type="thumb" caption="Portenta H7 Pinout"}%

[[https://content.arduino.cc/assets/Arduino-PortentaH7-schematic-V1.0.pdf][Schematics]]

Full Pinout
https://docs.arduino.cc/static/2d38006e78d2abc588a80f12bb9c0c70/ABX00042-full-pinout.pdf

</pre>
The anlog pins can be used as digital pins too:
<pre>
A0 D15, A1 D16, A2 D17, A3 D18, A4 D19, A5 D20, A6 D21
</pre>

---++ RGB LED

| Red    | D6  | PA8        |
| Green  | D4  | PC7        |
| Blue   | D3? | PD7 (PG7?) |


---++ Digital Pins

---+++ D0 / PWM7 / PH15 / JA.9
   * PWM out on TIM4_CH2

---+++ D1 / PWM6 / PK1 / JA.10
   * PWM out on TIM4_CH1

---+++ D2 / PWM5 / PJ11 / JA.11
   * PWM out on 

---+++ D3 / PWM4 / PG7 / JA.12
   * PWM out on TIM1_CH3
   * RGB LED blue ??

---+++ D4 / PWM3 / PC7 / JA.13
   * PWM out on TIM1_CH4
   * RGB LED green

---+++ D5 / PWM2 / PC6 / JA.14
   * PWM out on TIM1_CH2

---+++ D6 / PWM1 / PA8 / JD.1
   * PWM out on TIM1_CH1
   * RGB LED red

---+++ D7 / CSS / PI0 / JD.2
   * SPI chip select, Hardware SPI1_CSS

---+++ D8 / MOSI (COPI) / PC3 / JD.3
   * SPI master out slave in, Hardware SPI1_MOSI
 
---+++ D9 / SCK / PI1 / JD.4
   * SPI clock, Hardware SPI1_SCK

---+++ D10 / MISO (CIPO) / PC2 / JD.5
   * SPI master in slave out, Hardware  SPI1_MISO

---+++ D11 / SDA / PH8 / JD.6
   * The I2C (Wire) data pin, Hardware I2C0_SDA

---+++ D12 / SCL / PH7 / JD.7
   * The I2C (Wire) clock pin, Hardware I2C0_SCL

---+++ D13 / UART_RX / PA10 / JD.8
   * Receive (input) pin for Serial1. Hardware USART1_RX

---+++ D14 / UART_TX / PA9 / JD.9
   * Transmit (output) pin for Serial1. Hardware USART1_TX

---+++ RESET / JD.10

---++ Analog Pins

---+++ AREF+ / / / JA.1
   * This pin is analog i

---+++ A0 / D15 / PA0_C / JA.2
   * This pin is analog input A0 (ADC1_IN15)
   * Input Capture on TIM2_CH4
   * Alternate uses: USART2_RX

---+++ A1 / D16 / PA1_C / JA.3
   * This pin is analog input  A1 (ADC1_IN10)

---+++ A2 / D17 / PC2_C / JA.4
   * This pin is analog input  A2 (ADC3_IN1)
   * PWM out on TIM1_CH3N

---+++ A3 / D18 / PC3_C / JA.5
   * This pin is analog input  A3 (ADC1_IN5)
   * PWM out on TIM3_CH2

---+++ A4 / D19 / PC2 / JA.6
   * This pin is analog input  A4 (ADC3_IN0)

---+++ A5 / D20 / PC3/ JA.7
   * This pin is analog input  A5 (ADC3_IN6)

---+++ A6 / D21 / PA4 / JA.8
   * This pin is analog input  A6 (ADC3_IN6)


---+ Breakout Board

https://docs.arduino.cc/hardware/portenta-breakout

Breakout Board Datasheet
https://docs.arduino.cc/static/ff6f3cc0c6b5d7484e45642d617a6c73/ASX00031-datasheet.pdf


---++ SD Card / SDIO Pins

---+++ SDIO_D0 / PC8 (internal) / CN8.2
---+++ SDIO_D1 / PC9 (internal) / CN8.4
---+++ SDIO_D2 / PC10 (internal) / CN8.6
---+++ SDIO_D3 / PC11 (internal) / CN8.8
---+++ SDIO_CLK / PC12 (internal) / CN8.10
---+++ SDIO_CMD / PD2 (internal) / CN8.12
---+++ SD_DETECT / PB12 (internal) / optional / CN7.7


---++ USB
---+++ USB_DP / PA12
---+++ USB_DM / PA11

---++ VCP UART

---+++ STLK_VCP_TX / PG14 / ST-LINK VCP Rx
   * USART3_TX

---+++ STLK_VCP_RX / PG9 / ST-LINK VCP Tx
   * USART3_RX


%DASHBOARD{ section="box_end" }%

%DASHBOARD{ section="dashboard_end" }%


-- %USERSIG{PeterSchmid - 2022-03-07}%

<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work by <a xmlns:cc="http://creativecommons.org/ns#" href="http://spyr.ch" property="cc:attributionName" rel="cc:attributionURL">Peter Schmid</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.


%COMMENT%
Attachments
Topic attachments
I	Attachment	History	Action	Size	Date	Who	Comment
jpg	portenta-h7.jpg	r1	manage	103.1 K	2022-06-20 - 10:29	PeterSchmid
This topic: MecrispCube > WebHome > MecrispCubeH74x > BoardSupportPackageH747
Topic revision: r15 - 2022-10-11 - PeterSchmid