Skip to content

Commit

Permalink
Edit Step-by-step porting guide.
Browse files Browse the repository at this point in the history
Added UART configuration.
  • Loading branch information
suikan4github committed Feb 20, 2019
1 parent 73a1638 commit 7abea4e
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions Inc/murasaki_5_spg.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,20 @@

/**
* @page spg Step-by-Step Porting Guide
* @brief This chapter go though the actual operation of the CubeMX and SW4STM32 to
* @brief This chapter goes though the actual operation of the CubeMX and SW4STM32 to
* create an empty application with Murasaki.
*
* @details
* To develop your own application, you should create the platform with Murasaki by yourself.
* In this chapter, we will see the procedure to create an sample application for the Nucleo F722ZE board.
*
* The related software versions are :
* @li CubeMX ver 5.0.1
* @li Sytem Workbench for STM32 ver 1.17.0.201812190825
*
* First of all, you have to create a new project by CubeMX for Nucleo F722ZE.
* This skips how to make that project.
*
* @li @subpage spg_1
* @li @subpage spg_2
* @li @subpage spg_3
Expand All @@ -23,10 +33,30 @@
* @brief UART is grouped as connectivity device.
*
* @details
* Once Nucleo F722ZE is created, let's start to modify it from the UART configuration.
* Nucleo F722ZE board utilizes the USART3 peripheral as UART3. And this UART3 port is
* connected with ST-Link board. So we can communicate with the application through the
* USB by terminal software.
*
* The Murasaki library support this communication by murasaki::Debugger class.
* To use the Debugger class, we have to configure the UART port correctly.
*
* To configure the UART, select the UART3 peripheral inside the Connectivity category of the
* Pinout & Configuration tab( Fig. 1). The default tab is the Parameter and Setting tab. In this tab, we will configure the
* Basic Parameters like Baud rate, word length, etc...
*
* @image html "Screenshot from 2019-02-18 08-42-34.png" "Fig.1 CubeMX UART panel"
* @image latex "Screenshot from 2019-02-18 08-42-34.png" "Fig.1 CubeMX UART panel"
*
* And then, we configure the DMA. The murasaki::uart class uses the DMA transfer for both
* TX and RX. To enable DMA, click the DMA Settings tab and add DMAs. The default state of the
* DMA configuration after clicking Add button is undetermine. Then, select TX and RX DMA channel(Fig. 2).
*
* @image html "Screenshot from 2019-02-18 08-42-34.png" "CubeMX"
* @image latex "Screenshot from 2019-02-18 08-42-34.png" "CubeMX"
* @image html "Screenshot from 2019-02-18 08-43-41.png" "Fig.2 UART DMA Settings tab"
* @image latex "Screenshot from 2019-02-18 08-43-41.png" "Fig.2 UART DMA Settings tab"
*
* @image html "Screenshot from 2019-02-18 08-44-04.png" "Fig.3 UART NVIC Settings tab"
* @image latex "Screenshot from 2019-02-18 08-44-04.png" "Fig.3 UART NIC Settings tab"
*/

/**
Expand Down

0 comments on commit 7abea4e

Please sign in to comment.