提交: 89e20c71a7ad92c3c54913334edb33483a0330f4 - shared_foo (git)

テスト用のあれこれ共用フォルダ

Commit MetaInfo

• 修訂: 89e20c71a7ad92c3c54913334edb33483a0330f4 (tree)
• 時間: 2018-05-31 23:26:03
• 作者: takemasa <suikan@user...>
• Commiter: takemasa

Log Message

Edit doxygen comment. murasaki callbacks

Change Summary

• modified: stm32_development/murasaki/murasaki/murasaki_pg.hpp

差異

--- a/stm32_development/murasaki/murasaki/murasaki_pg.hpp
+++ b/stm32_development/murasaki/murasaki/murasaki_pg.hpp
@@ -325,6 +325,30 @@
  * But for the large system which has its own command line shell, this input-interruption is harmful.
  * For such the system, programmer want to call murasaki::Debugger::RePrint() member function, by certain customer command.
  *
+ * The ExecPlatform() function implements the actual algorithm of application.
+ *
+ * @code
+ * void ExecPlatform()
+ * {
+ *     // counter for the demonstration.
+ *     static int count = 0;
+ *
+ *     // Loop forever
+ *     while (true) {
+ *         // Toggle LED.
+ *         murasaki::platform.led->Toggle();
+ *
+ *         // print a message with counter value to the console.
+ *         murasaki::debugger->Printf("Hello %d \n\r", count);
+ *
+ *         // update the counter value.
+ *         count++;
+ *
+ *         // wait for a while
+ *         murasaki::Sleep(static_cast<murasaki::WaitMilliSeconds>(500));
+ *     }
+ * }
+ * @endcode
  */
 
 
@@ -333,6 +357,22 @@
  * \page murasaki_pg_interrupt Routing interrupts
  * \brief Routing the system interrupt to the Murasaki platform.
  * @details
+ * The \ref murasaki_platform.cpp has skeletons of HAL callbacks.
+ * These callbacks are pre-defined inside HAL as receptors of interrupt.
+ * These definitions inside HAL are "weak" bound. Then, these skeletons in murasaki_platform.cpp overrides the definition.
+ *
+ * In the Murasaki manner, the skeletons have to call the relevant callback member function of platform variables.
+ *
+ * \li void HAL_UART_TxCpltCallback(UART_HandleTypeDef * huart);
+ * \li void HAL_UART_RxCpltCallback(UART_HandleTypeDef * huart);
+ * \li void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart);
+ * \li void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef *hspi);
+ * \li void HAL_SPI_ErrorCallback(SPI_HandleTypeDef * hspi);
+ * \li void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef * hi2c);
+ * \li void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef * hi2c);
+ * \li void HAL_I2C_ErrorCallback(I2C_HandleTypeDef * hi2c);
+ * \li void HAL_GPIO_EXTI_Callback(uint16_t GPIO_P);
+ *
  */
 
 /**
@@ -344,3 +384,4 @@
 
 
 #endif /* MURASAKI_PG_HPP_ */
+